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
3 structure changes including:
3 Modifications
Modified 3 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
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /channel/amendmentswebhook
  • Response
  • 200 response Added
POST /retailEventswebhook
  • Response
  • 200 response Added
Channel API
4 structure changes including:
3 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
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Added 3
GET /channel/orders/{channelOrderId}/substitute/{plu}webhook
POST /channel/amendmentswebhook
POST /retailEventswebhook
Channel API
3 structure changes including:
1 Breaking change
1 Addition
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
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Removed 1 Breaking
POST /updateStoreStatus
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /fulfillment/location/{orderId}
Channel API
10 structure changes including:
10 Additions
Added 10
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}
Channel API
25 structure changes including:
17 Breaking changes
7 Additions
1 Modification
17 Removals
Modified 1 Breaking
POST /oauth/token
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Removed 17 Breaking
POST 7.Courier Status Updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST 6.Order Status Updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST 5.Preparation time updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST 4.Busy Modewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST 3.Snooze/Unsnooze Productswebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST 2.Menu Updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST 1.Channel Registrationwebhook
  • 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 7
POST /channel/snoozewebhook
POST /channel/registerwebhook
POST /channel/prep_timewebhook
POST /channel/order_statuswebhook
POST /channel/courier_updatewebhook
POST /channel/busy_modewebhook
Bearer authauthentication method
Dispatch API
1 structure change including:
1 Modification
Modified 1 Breaking
POST /dispatch/create_jobwebhook
  • Response
  • 400 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • property Removed
Dispatch API
2 structure changes including:
2 Modifications
Modified 2 Breaking
POST /dispatch/create_jobwebhook
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • property Removed
POST /dispatch/updateJobwebhook
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • property Removed
Dispatch API
4 structure changes including:
4 Modifications
Modified 4 Breaking
POST /dispatch/cancel_jobwebhook
  • Body
  • application/json content type Modified
    • property Removed
POST /dispatch/create_jobwebhook
  • Body
  • application/json content type Modified
    • property Removed
POST /dispatch/updateJobwebhook
  • Body
  • application/json content type Modified
    • property Removed
POST /validate_jobwebhook
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type is now object
      • alternative Added
        • Can Deliver, Cannot Deliver properties Added
  • 201 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Body
  • application/json content type Added
Dispatch API
1 structure change including:
1 Modification
Modified 1 Breaking
POST /validate_jobwebhook
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • application/json content type Added
  • 422 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • application/json content type Added
Dispatch API
1 structure change including:
1 Modification
Modified 1 Breaking
POST /validate_jobwebhook
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • text/plain content type Added
  • 400 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201 response Added
Dispatch API
10 structure changes including:
1 Addition
9 Modifications
Modified 9
POST /fulfillment/cancel
  • Authentication
  • Bearer auth authentication method Added
POST /fulfillment/generic/events
  • Authentication
  • Bearer auth authentication method Added
POST /oauth/token
  • Authentication
  • Bearer auth authentication method Added
PUT /fulfillment/hetaUpdate/{dspname}/{locationId}
  • Authentication
  • Bearer auth authentication method Added
POST /dispatch/cancel_jobwebhook
  • Authentication
  • Bearer auth authentication method Added
POST /dispatch/create_jobwebhook
  • Authentication
  • Bearer auth authentication method Added
POST /dispatch/priceJobwebhook
  • Authentication
  • Bearer auth authentication method Added
POST /dispatch/updateJobwebhook
  • Authentication
  • Bearer auth authentication method Added
POST /validate_jobwebhook
  • Authentication
  • Bearer auth authentication method Added
Added 1
Bearer authauthentication method
Dispatch API
5 structure changes including:
5 Additions
Added 5
POST /dispatch/cancel_jobwebhook
POST /dispatch/create_jobwebhook
POST /dispatch/priceJobwebhook
POST /dispatch/updateJobwebhook
POST /validate_jobwebhook
Dispatch API
1 structure change including:
1 Addition
Added 1
POST /oauth/token
Dispatch API
8 structure changes including:
5 Breaking changes
1 Addition
2 Modifications
5 Removals
Modified 2 Breaking
POST /fulfillment/cancel
  • Response
  • 200 response Modified
    • application/json content type Added
  • 400 response Added
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /fulfillment/generic/events
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Removed 5 Breaking
Bearer authauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /oauth/token
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/cancelJobwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/createJobwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhook.com/validateJobwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
PUT /fulfillment/hetaUpdate/{dspname}/{locationId}
Commerce API
16 structure changes including:
1 Addition
15 Modifications
Modified 15
GET /commerce/{accountId}/baskets/{basketId}
  • Authentication
  • Bearer auth authentication method Added
GET /commerce/{accountId}/menus
  • Authentication
  • Bearer auth authentication method Added
GET /commerce/{accountId}/stores
  • Authentication
  • Bearer auth authentication method Added
GET /commerce/{accountId}/stores/{storeId}
  • Authentication
  • Bearer auth authentication method Added
GET /commerce/{accountId}/stores/{storeId}/menus
  • Authentication
  • Bearer auth authentication method Added
GET /commerce/{accountId}/v2/checkouts/{checkoutId}
  • Authentication
  • Bearer auth authentication method Added
PATCH /commerce/{accountId}/baskets/{basketId}/charges
  • Authentication
  • Bearer auth authentication method Added
PATCH /commerce/{accountId}/baskets/{basketId}/customer
  • Authentication
  • Bearer auth authentication method Added
PATCH /commerce/{accountId}/baskets/{basketId}/discounts
  • Authentication
  • Bearer auth authentication method Added
PATCH /commerce/{accountId}/baskets/{basketId}/fulfillment
  • Authentication
  • Bearer auth authentication method Added
PATCH /commerce/{accountId}/baskets/{basketId}/items
  • Authentication
  • Bearer auth authentication method Added
PATCH /commerce/{accountId}/baskets/{basketId}/payment
  • Authentication
  • Bearer auth authentication method Added
POST /commerce/{accountId}/baskets
  • Authentication
  • Bearer auth authentication method Added
POST /commerce/{accountId}/v2/checkouts
  • Authentication
  • Bearer auth authentication method Added
POST /oauth/token
  • Authentication
  • Bearer auth authentication method Added
Added 1
Bearer authauthentication method
Commerce API
16 structure changes including:
1 Breaking change
15 Modifications
1 Removal
Modified 15 Breaking
GET /commerce/{accountId}/baskets/{basketId}
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /commerce/{accountId}/menus
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /commerce/{accountId}/stores
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /commerce/{accountId}/stores/{storeId}
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /commerce/{accountId}/stores/{storeId}/menus
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /commerce/{accountId}/v2/checkouts/{checkoutId}
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PATCH /commerce/{accountId}/baskets/{basketId}/charges
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PATCH /commerce/{accountId}/baskets/{basketId}/customer
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PATCH /commerce/{accountId}/baskets/{basketId}/discounts
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PATCH /commerce/{accountId}/baskets/{basketId}/fulfillment
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PATCH /commerce/{accountId}/baskets/{basketId}/items
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PATCH /commerce/{accountId}/baskets/{basketId}/payment
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /commerce/{accountId}/baskets
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /commerce/{accountId}/v2/checkouts
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /oauth/token
  • Authentication
  • Bearer auth authentication method 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
POS API
1 structure change including:
1 Modification
Modified 1 Breaking
GET /accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • property Removed
  • Query
  • accountId query parameter Added
POS API
1 structure change including:
1 Modification
Modified 1 Breaking
POST /oauth/token
  • Body
  • application/json content type Modified
    • client_id, client_secret, audience, grant_type properties Added
  • 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
POS API
15 structure changes including:
15 Modifications
Modified 15 Breaking
GET /accounts
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /accounts/{accountId}/brands
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /allAllergens
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /allChannels
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /channelLinks
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /locations
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /productCategories
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /oauth/token
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /productAndCategories
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /updateBill/{locationId}
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /getFloors/webhook
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /getTables/webhook
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /productswebhook
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /orderwebhook
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /registerwebhook
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Store API
1 structure change including:
1 Breaking change
1 Removal
Removed 1 Breaking
GET /my-orders
  • Removing a resource is always breaking unless it was deprecated before
    Breaking