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
3 structure changes including:
3 Modifications
Modified 3
GET /channel/orders/{channelOrderId}/substitute/{plu}webhook
  • Webhook is now Retail
POST /channel/amendmentswebhook
  • Webhook is now Retail
POST /retailEventswebhook
  • Webhook is now Retail
Channel API
1 structure change including:
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, validationId, orderType, pickupTime, deliveryTime, placedTime, payment, ageCheck, taxes, items, deliveryAddress, deliveryIsAsap, deliveryCost, deliveryCostTax, serviceCharge, serviceChargeTax, tip, driverTip, bagFee 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
Channel API
1 structure change including:
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, validationId, orderType, pickupTime, deliveryTime, placedTime, payment, ageCheck, taxes, items, deliveryAddress, deliveryIsAsap, deliveryCost, deliveryCostTax, serviceCharge, serviceChargeTax, tip, driverTip, bagFee 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
Channel API
1 structure change including:
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, validationId, orderType, pickupTime, deliveryTime, placedTime, payment, ageCheck, taxes, items, deliveryAddress, 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
Channel API
1 structure change including:
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, validationId, orderType, pickupTime, deliveryTime, placedTime, payment, ageCheck, taxes, items, items.plu, items.name, items.price, items.quantity, deliveryAddress, 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
Channel API
1 structure change including:
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, validationId, orderType, pickupTime, deliveryTime, placedTime, payment, ageCheck, taxes, items, items.plu, items.name, items.price, items.quantity, deliveryAddress, 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
Coupons API
2 structure changes including:
2 Modifications
Modified 2
GET /coupons/channel/{channelLinkId}/coupons
  • Operation is now Beta
POST /coupons/channel/{channelLinkId}/coupons/{couponCode}/validate
  • Operation is now Beta
  • Operation is no longer Technical preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • description property Modified
        • Property is now Deprecated
        • Property is no longer Experimental
Channel API
1 structure change including:
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, validationId, orderType, pickupTime, deliveryTime, placedTime, 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
Coupons API
1 structure change including:
1 Modification
Modified 1
POST /coupons/channel/{channelLinkId}/coupons/{couponCode}/validate
  • Operation is now Technical preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • description property Modified
        • Property is now Experimental
        • Property is now state_color
Coupons API
1 structure change including:
1 Modification
Modified 1
POST /coupons/channel/{channelLinkId}/coupons/{couponCode}/validate
  • Operation is now Technical preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • description property Modified
        • Property is now Experimental
        • Property is now state_color
Channel API
1 structure change including:
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, validationId, orderType, pickupTime, deliveryTime, placedTime, 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
Channel API
1 structure change including:
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, validationId, orderType, pickupTime, deliveryTime, placedTime, 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
Channel API
1 structure change including:
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, validationId, orderType, pickupTime, deliveryTime, placedTime, 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
KDS API
1 structure change including:
1 Addition
Added 1
POST /kds/kds_orders_notificationwebhook
KDS API
1 structure change including:
1 Breaking change
1 Removal
Removed 1 Breaking
POST /kds/kds_orders_notificationwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Retail POS API
12 structure changes including:
12 Modifications
Modified 12 Breaking
GET /accounts
  • Authentication
  • Bearer auth authentication method Added
GET /accounts/{accountId}/brands
  • Authentication
  • Bearer auth authentication method Added
GET /allAllergens
  • Authentication
  • Bearer auth authentication method Added
GET /allChannels
  • Authentication
  • Bearer auth authentication method Added
GET /channelLinks
  • Authentication
  • Bearer auth authentication method Added
GET /locations
  • Authentication
  • Bearer auth authentication method Added
POST /catalog/accounts/{accountId}/inventoryUploadUrl
  • Authentication
  • Bearer auth authentication method Added
POST /catalog/accounts/{accountId}/itemsUploadUrl
  • Authentication
  • Bearer auth authentication method Added
POST /oauth/token
  • Authentication
  • Bearer auth authentication method Added
POST /orderStatus/{orderId}
  • 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 Added
POST /registerwebhook
  • Authentication
  • Bearer auth authentication method Added
POS API
17 structure changes including:
17 Modifications
Modified 17 Breaking
GET /accounts
  • Authentication
  • Bearer auth authentication method Added
GET /accounts/{accountId}/brands
  • Authentication
  • Bearer auth authentication method Added
GET /allAllergens
  • Authentication
  • Bearer auth authentication method Added
GET /allChannels
  • Authentication
  • Bearer auth authentication method Added
GET /channelLinks
  • Authentication
  • Bearer auth authentication method Added
GET /locations
  • Authentication
  • Bearer auth authentication method Added
GET /productCategories
  • Authentication
  • Bearer auth authentication method Added
POST /oauth/token
  • Authentication
  • Bearer auth authentication method Added
POST /orderStatus/{orderId}
  • 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 Added
POST /updateBill/{locationId}
  • Authentication
  • Bearer auth authentication method Added
POST /updatePreparationTime
  • 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 Added
GET /getTables/webhook
  • Authentication
  • Bearer auth authentication method Added
GET /productswebhook
  • Authentication
  • Bearer auth authentication method Added
POST /orderwebhook
  • Authentication
  • Bearer auth authentication method Added
POST /registerwebhook
  • Authentication
  • Bearer auth authentication method Added
Loyalty API
17 structure changes including:
1 Addition
16 Modifications
Modified 16
POST /validateprogramwebhook
  • Authentication
  • Bearer auth authentication method Added
POST /loyalty/registrationwebhook
  • Authentication
  • Bearer auth authentication method Added
POST /loyalty/orderwebhook
  • Authentication
  • Bearer auth authentication method Added
POST /loyalty/cancelOrderwebhook
  • Authentication
  • Bearer auth authentication method Added
POST /loyalty-programswebhook
  • Authentication
  • Bearer auth authentication method Added
POST /auth/tokenwebhook
  • Authentication
  • Bearer auth authentication method Added
GET /loyalty/tierswebhook
  • Authentication
  • Bearer auth authentication method Added
GET /loyalty/get/walletwebhook
  • Authentication
  • Bearer auth authentication method Added
GET /loyalty/customerwebhook
  • Authentication
  • Bearer auth authentication method Added
POST /oauth/token
  • Authentication
  • Bearer auth authentication method Added
POST /loyalty/{channelLinkId}/programs/retrieve
  • Authentication
  • Bearer auth authentication method Added
POST /loyalty/{channelLinkId}/customer
  • Authentication
  • Bearer auth authentication method Added
POST /loyalty/{channelLinkId}/compensationCards/validate
  • Authentication
  • Bearer auth authentication method Added
GET /loyalty/{channelLinkId}/tiers
  • Authentication
  • Bearer auth authentication method Added
GET /loyalty/{channelLinkId}/customer/wallet
  • Authentication
  • Bearer auth authentication method Added
GET /loyalty/{channelLinkId}/configuration
  • Authentication
  • Bearer auth authentication method Added
Added 1
Bearer authauthentication method
Commerce API
25 structure changes including:
1 Addition
24 Modifications
Modified 24
POST /retailEventswebhook
  • Authentication
  • Bearer auth authentication method Added
POST /channel/snoozewebhook
  • Authentication
  • Bearer auth authentication method Added
POST /channel/registerwebhook
  • Authentication
  • Bearer auth authentication method Added
POST /channel/prep_timewebhook
  • Authentication
  • Bearer auth authentication method Added
POST /channel/order_statuswebhook
  • Authentication
  • Bearer auth authentication method Added
POST /channel/courier_updatewebhook
  • Authentication
  • Bearer auth authentication method Added
POST /channel/busy_modewebhook
  • Authentication
  • Bearer auth authentication method Added
POST /channel/amendmentswebhook
  • Authentication
  • Bearer auth authentication method Added
GET /channel/orders/{channelOrderId}/substitute/{plu}webhook
  • Authentication
  • Bearer auth authentication method Added
POST /oauth/token
  • Authentication
  • Bearer auth authentication method Added
POST /commerce/{accountId}/v2/checkouts
  • Authentication
  • Bearer auth authentication method Added
POST /commerce/{accountId}/baskets
  • Authentication
  • Bearer auth authentication method Added
PATCH /commerce/{accountId}/baskets/{basketId}/payment
  • Authentication
  • Bearer auth authentication method Added
PATCH /commerce/{accountId}/baskets/{basketId}/items
  • Authentication
  • Bearer auth authentication method Added
PATCH /commerce/{accountId}/baskets/{basketId}/fulfillment
  • Authentication
  • Bearer auth authentication method Added
PATCH /commerce/{accountId}/baskets/{basketId}/discounts
  • Authentication
  • Bearer auth authentication method Added
PATCH /commerce/{accountId}/baskets/{basketId}/customer
  • Authentication
  • Bearer auth authentication method Added
PATCH /commerce/{accountId}/baskets/{basketId}/charges
  • Authentication
  • Bearer auth authentication method Added
GET /commerce/{accountId}/v2/checkouts/{checkoutId}
  • Authentication
  • Bearer auth authentication method Added
GET /commerce/{accountId}/stores/{storeId}/menus
  • Authentication
  • Bearer auth authentication method Added
GET /commerce/{accountId}/stores/{storeId}
  • Authentication
  • Bearer auth authentication method Added
GET /commerce/{accountId}/stores
  • Authentication
  • Bearer auth authentication method Added
GET /commerce/{accountId}/menus
  • Authentication
  • Bearer auth authentication method Added
GET /commerce/{accountId}/baskets/{basketId}
  • Authentication
  • Bearer auth authentication method Added
Added 1
Bearer authauthentication method
Commerce API
25 structure changes including:
1 Breaking change
24 Modifications
1 Removal
Modified 24 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
GET /channel/orders/{channelOrderId}/substitute/{plu}webhook
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /channel/amendmentswebhook
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /channel/busy_modewebhook
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /channel/courier_updatewebhook
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /channel/order_statuswebhook
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /channel/prep_timewebhook
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /channel/registerwebhook
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /channel/snoozewebhook
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /retailEventswebhook
  • 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