Change Updates

Do not miss any Channel API changes, ever again

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

RSS

Changelog

Last update:
Compare
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
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
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
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
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
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
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
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
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
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
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
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
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}
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}
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
15 structure changes including:
7 Breaking changes
7 Additions
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 Busy Modewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST Channel Registrationwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST Courier Status Updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST Menu Updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST Order Status Updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST Preparation time updatewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST Snooze/Unsnooze Productswebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 7
POST 1.Channel Registrationwebhook
POST 2.Menu Updatewebhook
POST 3.Snooze/Unsnooze Productswebhook
POST 4.Busy Modewebhook
POST 5.Preparation time updatewebhook
POST 6.Order Status Updatewebhook
POST 7.Courier Status Updatewebhook
13 structure changes including:
6 Breaking changes
6 Additions
1 Modification
6 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 6 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/snoozewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 6
POST Busy Modewebhook
POST Courier Status Updatewebhook
POST Menu Updatewebhook
POST Order Status Updatewebhook
POST Preparation time updatewebhook
POST Snooze/Unsnooze Productswebhook
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
Removed 1 Breaking
POST /yourwebhook.com/registerwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
POST Channel Registrationwebhook
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
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