Change Updates

Do not miss any Deliverect APIs Hub changes, ever again

Subscribe to the Deliverect APIs Hub changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Channel API
2 structure changes including:
1 Breaking change
1 Modification
1 Removal
Modified 1 Breaking
POST /{channelName}/order/{channelLinkId}
  • Path went from /{channelName}/order/{channelLinkId}/ to /{channelName}/order/{channelLinkId} (same operationId)
  • Body
  • application/json content type Modified
    • channelLinkId, status, cancellationReason properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • courier, payment, payment.amount, payment.type, taxes.totaL, items, items.plu, items.name, items.price, items.quantity, decimalDigits, deliveryIsAsap properties Added
  • Response
  • default response Modified
    • application/json content type Modified
      • Type went from object to string
        Breaking
      • channelOrderId, channelOrderDisplayId, channelLinkId, status, cancellationReason properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
Removed 1 Breaking
Bearer authauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Commerce API
1 structure change including:
1 Modification
Modified 1
POST /oauth/token
  • Body
  • application/json content type Modified
    • client_id, client_secret, audience, grant_type properties Added
Upsell API
Loyalty API
Giftcard API
CRM API
Coupons API
Channel API
3 structure changes including:
3 Modifications
Modified 3 Breaking
POST /oauth/token
  • Body
  • application/json content type Modified
    • client_id, client_secret, audience, grant_type properties Added
POST /updateStoreStatus
  • Path
  • channelName, channelLinkId path parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /{channelName}/order/{channelLinkId}
  • Path went from /{channelName}/order/{channelLinkId}/ to /{channelName}/order/{channelLinkId} (same operationId)
  • Body
  • application/json content type Modified
    • channelLinkId, status, cancellationReason properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • courier, payment, payment.amount, payment.type, taxes.totaL, items, items.plu, items.name, items.price, items.quantity, decimalDigits, deliveryIsAsap properties Added
  • Response
  • default response Modified
    • application/json content type Modified
      • Type went from object to string
        Breaking
      • channelOrderId, channelOrderDisplayId, channelLinkId, status, cancellationReason properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
KDS API
3 structure changes including:
3 Breaking changes
3 Removals
Removed 3 Breaking
GET /yourwebhook.com/orderswebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /yourwebhook.com/productswebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/registerwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Channel API
29 structure changes including:
11 Breaking changes
17 Additions
1 Modification
11 Removals
Modified 1 Breaking
POST /oauth/token
  • Response
  • 200 response Modified
    • application/json content type Added
  • Header
  • accept, content-type headers Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Removed 11 Breaking
POST /registerwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /orderwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /orderStatus/{orderId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /catalog/accounts/{accountId}/itemsUploadUrl
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /catalog/accounts/{accountId}/inventoryUploadUrl
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /locations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /channelLinks
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /allChannels
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /allAllergens
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /accounts/{accountId}/brands
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /accounts
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 17
POST /yourwebhook.com/snoozewebhook
POST /yourwebhook.com/registerwebhook
POST /yourwebhook.com/prep_timewebhook
POST /yourwebhook.com/order_statuswebhook
POST /yourwebhook.com/menu_updatewebhook
POST /yourwebhook.com/courier_updatewebhook
POST /yourwebhook.com/busy_modewebhook
POST /{channelName}/updateStoreStatus/{channelLinkId}
POST /{channelName}/updateRating
POST /{channelName}/order/{channelLinkId}/
POST /{channelName}/order/{channelLinkId}
POST /{channelName}/menuStatus/{_id}
POST /{channelName}/courierUpdate/{channelLinkId}
POST /updateStoreStatus
POST /fulfillment/validate
GET /tables/{locationId}
GET /allAllegens
Channel API
9 structure changes including:
2 Breaking changes
7 Additions
2 Removals
Removed 2 Breaking
POST /catalog/accounts/{accountId}/inventoryUploadUrl
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /catalog/accounts/{accountId}/itemsUploadUrl
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 7
GET /productCategories
POST /productAndCategories
POST /updateBill/{locationId}
POST /updatePreparationTime
GET /getFloors/webhook
GET /getTables/webhook
GET /productswebhook
Channel API
29 structure changes including:
17 Breaking changes
11 Additions
1 Modification
17 Removals
Modified 1 Breaking
POST /oauth/token
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Header
  • accept, content-type headers Added
Removed 17 Breaking
POST /yourwebhook.com/snoozewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/registerwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/prep_timewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/order_statuswebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/menu_updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/courier_updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/busy_modewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/updateStoreStatus/{channelLinkId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/updateRating
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/order/{channelLinkId}/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/order/{channelLinkId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/menuStatus/{_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/courierUpdate/{channelLinkId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /updateStoreStatus
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /fulfillment/validate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /tables/{locationId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /allAllegens
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 11
POST /registerwebhook
POST /orderwebhook
POST /orderStatus/{orderId}
POST /catalog/accounts/{accountId}/itemsUploadUrl
POST /catalog/accounts/{accountId}/inventoryUploadUrl
GET /locations
GET /channelLinks
GET /allChannels
GET /allAllergens
GET /accounts/{accountId}/brands
GET /accounts
Channel API
34 structure changes including:
16 Breaking changes
17 Additions
1 Modification
16 Removals
Modified 1 Breaking
POST /oauth/token
  • Response
  • 200 response Modified
    • application/json content type Added
  • Header
  • accept, content-type headers Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Removed 16 Breaking
GET /accounts
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /accounts/{accountId}/brands
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /allAllergens
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /allChannels
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /channelLinks
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /locations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /productCategories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /orderStatus/{orderId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /productAndCategories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /updateBill/{locationId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /updatePreparationTime
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /getFloors/webhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /getTables/webhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /productswebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /orderwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /registerwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 17
GET /allAllegens
GET /tables/{locationId}
POST /fulfillment/validate
POST /updateStoreStatus
POST /{channelName}/courierUpdate/{channelLinkId}
POST /{channelName}/menuStatus/{_id}
POST /{channelName}/order/{channelLinkId}
POST /{channelName}/order/{channelLinkId}/
POST /{channelName}/updateRating
POST /{channelName}/updateStoreStatus/{channelLinkId}
POST /yourwebhook.com/busy_modewebhook
POST /yourwebhook.com/courier_updatewebhook
POST /yourwebhook.com/menu_updatewebhook
POST /yourwebhook.com/order_statuswebhook
POST /yourwebhook.com/prep_timewebhook
POST /yourwebhook.com/registerwebhook
POST /yourwebhook.com/snoozewebhook
Channel API
34 structure changes including:
17 Breaking changes
16 Additions
1 Modification
17 Removals
Modified 1 Breaking
POST /oauth/token
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Header
  • accept, content-type headers Added
Removed 17 Breaking
GET /allAllegens
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /tables/{locationId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /fulfillment/validate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /updateStoreStatus
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/courierUpdate/{channelLinkId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/menuStatus/{_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/order/{channelLinkId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/order/{channelLinkId}/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/updateRating
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/updateStoreStatus/{channelLinkId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/busy_modewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/courier_updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/menu_updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/order_statuswebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/prep_timewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/registerwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/snoozewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 16
GET /accounts
GET /accounts/{accountId}/brands
GET /allAllergens
GET /allChannels
GET /channelLinks
GET /locations
GET /productCategories
POST /orderStatus/{orderId}
POST /productAndCategories
POST /updateBill/{locationId}
POST /updatePreparationTime
GET /getFloors/webhook
GET /getTables/webhook
GET /productswebhook
POST /orderwebhook
POST /registerwebhook
Channel API
29 structure changes including:
17 Breaking changes
11 Additions
1 Modification
17 Removals
Modified 1 Breaking
POST /oauth/token
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Header
  • accept, content-type headers Added
Removed 17 Breaking
POST /yourwebhook.com/snoozewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/registerwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/prep_timewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/order_statuswebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/menu_updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/courier_updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/busy_modewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/updateStoreStatus/{channelLinkId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/updateRating
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/order/{channelLinkId}/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/order/{channelLinkId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/menuStatus/{_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /{channelName}/courierUpdate/{channelLinkId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /updateStoreStatus
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /fulfillment/validate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /tables/{locationId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /allAllegens
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 11
POST /registerwebhook
POST /orderwebhook
POST /orderStatus/{orderId}
POST /catalog/accounts/{accountId}/itemsUploadUrl
POST /catalog/accounts/{accountId}/inventoryUploadUrl
GET /locations
GET /channelLinks
GET /allChannels
GET /allAllergens
GET /accounts/{accountId}/brands
GET /accounts
Channel API
8 structure changes including:
7 Additions
1 Modification
Modified 1 Breaking
POST /{channelName}/order/{channelLinkId}
  • Path went from /{channelName}/order/{channelLinkId}/ to /{channelName}/order/{channelLinkId} (same operationId)
  • Body
  • application/json content type Modified
    • channelLinkId, status, cancellationReason properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • courier, payment, payment.amount, payment.type, taxes.totaL, items, items.plu, items.name, items.price, items.quantity, decimalDigits, deliveryIsAsap properties Added
  • Response
  • default response Modified
    • application/json content type Modified
      • Type went from object to string
        Breaking
      • channelOrderId, channelOrderDisplayId, channelLinkId, status, cancellationReason properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
Added 7
POST /yourwebhook.com/busy_modewebhook
POST /yourwebhook.com/courier_updatewebhook
POST /yourwebhook.com/menu_updatewebhook
POST /yourwebhook.com/order_statuswebhook
POST /yourwebhook.com/prep_timewebhook
POST /yourwebhook.com/registerwebhook
POST /yourwebhook.com/snoozewebhook
Channel API
8 structure changes including:
7 Breaking changes
1 Modification
7 Removals
Modified 1 Breaking
POST /{channelName}/order/{channelLinkId}
  • Path went from /{channelName}/order/{channelLinkId}/ to /{channelName}/order/{channelLinkId} (same operationId)
  • Body
  • application/json content type Modified
    • channelLinkId, status, cancellationReason properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • courier, payment, payment.amount, payment.type, taxes.totaL, items, items.plu, items.name, items.price, items.quantity, decimalDigits, deliveryIsAsap properties Added
  • Response
  • default response Modified
    • application/json content type Modified
      • Type went from object to string
        Breaking
      • channelOrderId, channelOrderDisplayId, channelLinkId, status, cancellationReason properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
Removed 7 Breaking
POST /yourwebhook.com/busy_modewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/courier_updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/menu_updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/order_statuswebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/prep_timewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/registerwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/snoozewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Retail POS API
2 structure changes including:
2 Additions
Added 2
POST /catalog/accounts/{accountId}/inventoryUploadUrl
POST /catalog/accounts/{accountId}/itemsUploadUrl
Dispatch API
Channel API