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:
Commerce API
6 structure changes including:
6 Modifications
Modified 6
POST /channel/busy_modewebhook
  • Body
  • application/json content type Modified
    • Busy Mode Update property Added
POST /channel/courier_updatewebhook
  • Body
  • application/json content type Modified
    • Courier Update property Added
POST /channel/order_statuswebhook
  • Body
  • application/json content type Modified
    • Order Update Status property Added
POST /channel/prep_timewebhook
  • Body
  • application/json content type Modified
    • Preparation Time Update property Added
POST /channel/registerwebhook
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type is now object
      • Channel Registration property Added
POST /channel/snoozewebhook
  • Body
  • application/json content type Modified
    • Snooze/Unsnooze Products property Added
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
GET /allAllegens
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /allAllergens
Commerce API
9 structure changes including:
9 Additions
Added 9
GET /channel/orders/{channelOrderId}/substitute/{plu}webhook
POST /channel/amendmentswebhook
POST /channel/busy_modewebhook
POST /channel/courier_updatewebhook
POST /channel/order_statuswebhook
POST /channel/prep_timewebhook
POST /channel/registerwebhook
POST /channel/snoozewebhook
POST /retailEventswebhook
Loyalty API
8 structure changes including:
8 Additions
Added 8
GET /loyalty/customerwebhook
GET /loyalty/get/walletwebhook
GET /loyalty/tierswebhook
POST /auth/tokenwebhook
POST /loyalty-programswebhook
POST /loyalty/cancelOrderwebhook
POST /loyalty/orderwebhook
POST /validateprogramwebhook
Loyalty API
1 structure change including:
1 Addition
Added 1
POST /loyalty/registrationwebhook
Loyalty API
7 structure changes including:
7 Additions
Added 7
GET /loyalty/{channelLinkId}/configuration
GET /loyalty/{channelLinkId}/customer/wallet
GET /loyalty/{channelLinkId}/tiers
POST //loyalty/{channelLinkId}/programs/validate
POST /loyalty/{channelLinkId}/compensationCards/validate
POST /loyalty/{channelLinkId}/customer
POST /loyalty/{channelLinkId}/programs/retrieve
Loyalty API
11 structure changes including:
10 Breaking changes
1 Addition
10 Removals
Removed 10 Breaking
Sec0authentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /loyalty/{channelLinkId}/configuration
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /loyalty/{channelLinkId}/customer
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /loyalty/{channelLinkId}/customer/wallet
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /loyalty/{channelLinkId}/sso
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /loyalty/{channelLinkId}/tiers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST //loyalty/{channelLinkId}/programs/validate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /loyalty/{channelLinkId}/compensationCards/validate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /loyalty/{channelLinkId}/customer
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /loyalty/{channelLinkId}/programs/retrieve
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
POST /oauth/token
Retail POS API
12 structure changes including:
1 Breaking change
1 Addition
10 Modifications
1 Removal
Modified 10 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
POST /catalog/accounts/{accountId}/inventoryUploadUrl
  • 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 /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
Removed 1 Breaking
POST /catalog/accounts/{accountId}/itemsUploadUrl
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
POST /catalog/accounts/{accountId}/itemsUploadUrl
Dispatch API
20 structure changes including:
11 Breaking changes
8 Additions
1 Modification
11 Removals
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
  • Authentication
  • Bearer auth authentication method Added
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 8
POST /validate_jobwebhook
POST /dispatch/updateJobwebhook
POST /dispatch/priceJobwebhook
POST /dispatch/create_jobwebhook
POST /dispatch/cancel_jobwebhook
PUT /fulfillment/hetaUpdate/{dspname}/{locationId}
POST /fulfillment/generic/events
POST /fulfillment/cancel
Dispatch API
20 structure changes including:
8 Breaking changes
11 Additions
1 Modification
8 Removals
Modified 1 Breaking
POST /oauth/token
  • Body
  • application/json content type Modified
    • client_id, client_secret, audience, grant_type properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type 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
  • Header
  • accept, content-type headers Added
Removed 8 Breaking
POST /validate_jobwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /dispatch/updateJobwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /dispatch/priceJobwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /dispatch/create_jobwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /dispatch/cancel_jobwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /fulfillment/hetaUpdate/{dspname}/{locationId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /fulfillment/generic/events
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /fulfillment/cancel
  • 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
Reporting API
7 structure changes including:
4 Breaking changes
3 Additions
4 Removals
Removed 4 Breaking
Bearer authauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhookurl/courierUpdate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhookurl/order
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /yourwebhookurl/orderStatus
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 3
POST /courierUpdateStatus
POST /new_order
POST /orderStatus
Giftcard API
1 structure change including:
1 Modification
Modified 1
POST /validateGiftCard
  • Body
  • application/json content type Added
Giftcard API
8 structure changes including:
4 Breaking changes
4 Additions
4 Removals
Removed 4 Breaking
POST /redeem
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /registerProfile-1
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /reverse
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /validateGiftCard
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 4
POST /redeem
POST /registerProfile
POST /reverse
POST /validateGiftCard
CRM API
14 structure changes including:
11 Breaking changes
3 Additions
11 Removals
Removed 11 Breaking
Get customersauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /crm/admin/{accountId}/customers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /crm/admin/{accountId}/customers/{crmCustomerId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /crm/admin/{accountId}/customers/{crmCustomerId}/orders
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /crm/channel/{channelLinkId}/customers/{crmProfileId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /crm/admin/{accountId}/customers/lookup
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /crm/admin/{accountId}/customers/orders
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /crm/admin/{accountId}/customers/orders/lookup
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /crm/channel/{channelLinkId}/customers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /crm/channel/{channelLinkId}/customers/lookup
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /deliverect/testOrder/{channelLinkId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 3
GET /crm/channel/{channelLinkId}/customers/{crmProfileId}
POST /crm/channel/{channelLinkId}/customers
POST /crm/channel/{channelLinkId}/customers/lookup
Coupons API
6 structure changes including:
2 Breaking changes
3 Additions
1 Modification
2 Removals
Modified 1
POST /oauth/token
  • Authentication
  • Bearer auth authentication method Added
Removed 2 Breaking
GET /coupons/admin/{{accountId}}/coupons
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /coupons/{{channelLinkId}}/coupons
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 3
Bearer authauthentication method
GET /coupons/channel/{channelLinkId}/coupons
POST /coupons/channel/{channelLinkId}/coupons/{couponCode}/validate
Upsell API
3 structure changes including:
1 Addition
2 Modifications
Modified 2
POST /oauth/token
  • Authentication
  • Bearer auth authentication method Added
POST /upsell/channel/{channelLinkId}
  • Authentication
  • Bearer auth authentication method Added
Added 1
Bearer authauthentication method
KDS API
1 structure change including:
1 Addition
Added 1
POST kds/order_status_updatewebhook
KDS API
2 structure changes including:
2 Modifications
Modified 2
POST /kds/orderStatus/{orderId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type is now object
      • property Added
POST /kds/register_kdswebhook
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type is now object
      • property Added
KDS API
2 structure changes including:
2 Additions
Added 2
POST /kds/kds_orders_notificationwebhook
POST kds/product_updatewebhook
KDS API
5 structure changes including:
4 Breaking changes
1 Addition
4 Removals
Removed 4 Breaking
GET /allAllergens/
  • 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 /products/snoozeByPlus
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/snoozeByTags
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
POST /kds/register_kdswebhook