Change Updates

Do not miss any Mahjoz API changes, ever again

Subscribe to the Mahjoz API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
24 structure changes including:
15 Breaking changes
9 Additions
15 Removals
Removed 15 Breaking
PUT /payment-methods/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /customers/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /payment-methods
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /customers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /providers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /products/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /products
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /payment-methods
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /orders
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /get-availability
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /customers/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /customers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /categories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /branches
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /customers/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 9
POST /tags
POST /pos/orders
POST /pos/checkout-calculate
GET /tags
GET /services/{serviceId}/staff
GET /metadata/{teamId}
GET /items
GET /customers/find
DELETE /tags/{tagId}
1.0.0
35 structure changes including:
19 Breaking changes
4 Additions
12 Modifications
19 Removals
Modified 12 Breaking
PUT /customers/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • property Added
  • Header
  • Accept header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200, 404, 400, 401 responses Added
  • Authentication
  • Api key auth authentication method Added
POST /payment-methods
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • property Added
  • Header
  • X-Api-Key, Accept headers Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Accept query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 201, 400, 401 responses Added
  • Authentication
  • Api key auth authentication method Added
DELETE /customers/{id}
  • Header
  • Accept header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 204, 404, 401 responses Added
  • Authentication
  • Api key auth authentication method Added
GET /branches
  • Header
  • X-Api-Key, Accept headers Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Accept query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200, 401 responses Added
  • Authentication
  • Api key auth authentication method Added
GET /categories
  • Header
  • Accept header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200, 401 responses Added
  • Authentication
  • Api key auth authentication method Added
GET /customers
  • Header
  • Accept header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200, 401 responses Added
  • Authentication
  • Api key auth authentication method Added
GET /customers/{id}
  • Header
  • Accept header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200, 404, 401 responses Added
  • Authentication
  • Api key auth authentication method Added
GET /get-availability
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • property Added
  • Header
  • Accept header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200, 400, 401 responses Added
  • Authentication
  • Api key auth authentication method Added
GET /orders
  • Header
  • Accept header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200, 401 responses Added
  • Authentication
  • Api key auth authentication method Added
GET /payment-methods
  • Header
  • X-Api-Key, Accept headers Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Accept query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200, 401 responses Added
  • Authentication
  • Api key auth authentication method Added
GET /products
  • Header
  • Accept header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200, 401 responses Added
  • Authentication
  • Api key auth authentication method Added
GET /providers
  • Header
  • X-Api-Key, Accept headers Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Accept query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200, 401 responses Added
  • Authentication
  • Api key auth authentication method Added
Removed 19 Breaking
POST /
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /products/0a1ad6ee-981b-451e-b0f2-9858353c1373
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/providers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/products/0a1ad6ee-981b-451e-b0f2-9858353c1373
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/products
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/payment-methods
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/customers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/payment-methods
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/payment-methods/b02e0e7a-aa8a-4066-8d50-bcbff88efe93
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /payment-methods/b02e0e7a-aa8a-4066-8d50-bcbff88efe93
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/orders
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/get-availability
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/customers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/categories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/branches
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 4
PUT /payment-methods/{id}
POST /customers
GET /products/{id}
Api key authauthentication method
1.0.2
31 structure changes including:
20 Additions
11 Modifications
Modified 11 Breaking
PUT /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
  • Header
  • X-Api-Key header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/customers
  • Header
  • X-Api-Key header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/providers
  • Query
  • Content-Type query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/products/0a1ad6ee-981b-451e-b0f2-9858353c1373
  • Header
  • X-Api-Key header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/products
  • Header
  • X-Api-Key header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/orders
  • Header
  • X-Api-Key header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
  • Header
  • X-Api-Key header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/customers
  • Header
  • X-Api-Key header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200 response Added
GET /api/categories
  • Header
  • X-Api-Key header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/branches
  • Query
  • Content-Type query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
  • Header
  • X-Api-Key header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Added 20
PUT /payment-methods/b02e0e7a-aa8a-4066-8d50-bcbff88efe93
PUT /customers/{id}
PUT /customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
PUT /api/payment-methods/b02e0e7a-aa8a-4066-8d50-bcbff88efe93
POST /payment-methods
POST /api/payment-methods
POST /
GET /providers
GET /products/0a1ad6ee-981b-451e-b0f2-9858353c1373
GET /products
GET /payment-methods
GET /orders
GET /get-availability
GET /customers/{id}
GET /customers
GET /categories
GET /branches
GET /api/payment-methods
GET /api/get-availability
DELETE /customers/{id}
17 structure changes including:
6 Breaking changes
4 Additions
7 Modifications
6 Removals
Modified 7 Breaking
GET /api/branches
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Header
  • X-Api-Key, Accept headers Added
  • Query
  • Content-Type, Accept query parameters Added
GET /api/categories
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Header
  • X-Api-Key, Accept headers Added
  • Query
  • Content-Type, Accept query parameters Added
GET /api/customers
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Header
  • X-Api-Key, Accept headers Added
  • Query
  • Content-Type, Accept query parameters Added
GET /api/orders
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Header
  • X-Api-Key, Accept headers Added
  • Query
  • Content-Type, Accept query parameters Added
GET /api/products
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Header
  • X-Api-Key, Accept headers Added
  • Query
  • Content-Type, Accept query parameters Added
GET /api/providers
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Header
  • X-Api-Key, Accept headers Added
  • Query
  • Content-Type, Accept query parameters Added
POST /api/customers
  • Body
  • application/json content type Modified
    • Content type is no longer required
  • Response
  • 201 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Header
  • X-Api-Key, Accept headers Added
  • Query
  • Content-Type, Accept query parameters Added
Removed 6 Breaking
PUT /api/products/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/customers/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/products/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/get-availability
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/customers/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/customers/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 4
PUT /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
GET /api/products/0a1ad6ee-981b-451e-b0f2-9858353c1373
GET /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
DELETE /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
17 structure changes including:
4 Breaking changes
6 Additions
7 Modifications
4 Removals
Modified 7 Breaking
POST /api/customers
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
  • Header
  • X-Api-Key, Accept headers Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 201 response Added
GET /api/providers
  • Header
  • X-Api-Key, Accept headers Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200 response Added
GET /api/branches
  • Header
  • X-Api-Key, Accept headers Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200 response Added
GET /api/categories
  • Header
  • X-Api-Key, Accept headers Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200 response Added
GET /api/customers
  • Header
  • X-Api-Key, Accept headers Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200 response Added
GET /api/orders
  • Header
  • X-Api-Key, Accept headers Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200 response Added
GET /api/products
  • Header
  • X-Api-Key, Accept headers Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • Content-Type, Accept query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200 response Added
Removed 4 Breaking
PUT /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/products/0a1ad6ee-981b-451e-b0f2-9858353c1373
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 6
PUT /api/products/{id}
PUT /api/customers/{id}
GET /api/products/{id}
GET /api/get-availability
GET /api/customers/{id}
DELETE /api/customers/{id}
12 structure changes including:
1 Breaking change
10 Additions
1 Modification
1 Removal
Modified 1 Breaking
GET /api/customers
  • Header
  • X-Api-Key header Modified
    • Header is no longer required
    • Type went from string to integer
      Breaking
  • Accept header Added
  • Query
  • per_page, cursor query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Content-Type, Accept query parameters Added
  • Response
  • 200, 401, 403, 429 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Authentication
  • Api key auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Removed 1 Breaking
Api key authauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 10
DELETE /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
GET /api/branches
GET /api/categories
GET /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
GET /api/orders
GET /api/products
GET /api/products/0a1ad6ee-981b-451e-b0f2-9858353c1373
GET /api/providers
POST /api/customers
PUT /api/customers/924b9b2e-4c4c-4f87-a28d-2a089e60f09f
4 structure changes including:
2 Breaking changes
1 Modification
3 Removals
Modified 1 Breaking
GET /api/customers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Removing polymorphism is always breaking
            Breaking
        • first_name, last_name, phone, address properties Modified
          • Type went from string | null to string
            Breaking
        • email property Modified
          • Type went from string(email) | null to string(email)
            Breaking
      • meta property Modified
        • current_page, from, last_page, links, path, per_page, to, total properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • next_cursor, prev_cursor properties Added
      • links property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • 401, 403, 429 responses Added
  • Query
  • page query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Authentication
  • O auth2 client credentials authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Header
  • X-Api-Key header Added
Removed 3 Breaking
O auth2 client credentialsauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /customers
POST /api/v1/token-generate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking