API Documentation

Order Status Update

post https://yourwebhook.com/order_status

Summary

Whenever a POS updates the status of an order, we will deliver a webhook event to your specified endpoint.

Each integrated POS will provide statuses in accordance with their own workflows, meaning the specific statuses received can vary, yet any order with status between 20 (Accepted) and 95 (Auto-finalized) confirms a successfully accepted order.

Statuses higher than 95, indicate that something went wrong with the order.

⚠️ If you receive a status that is not documented below, it can safely be ignored, an unknown status should not impact normal order processing workflow

▶ See All Order Statuses

Canceled Orders

An ordering platform can process cancellations via the /order endpoint (see Cancel Order ) cancellations can also be initiated from the POS.

When a POS cancels an order, a status 110 is sent as per example below. This information should be related to the end-consumer in whichever manner possible i.e. email notification of an unsuccessful order.

{
    "orderId": "61********************b4",
    "status": 20,
    "timeStamp": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
    "receiptId": "",
    "reason": "",
    "channelOrderId": "TEST******4206",
    "location": "61********************b4",
    "channelLink": "61********************c3"
}

{
    "orderId": "61********************b4",
    "status": 110,
    "timeStamp": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
    "receiptId": "",
    "reason": "Item out of stock",
    "channelOrderId": "TEST******4206",
    "location": "61********************b4",
    "channelLink": "61********************c3"
}

{
    "orderId": "61********************b4",
    "status": 120,
    "timeStamp": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
    "receiptId": "",
    "reason": "",
    "channelOrderId": "TEST******4206",
    "location": "61********************b4",
    "channelLink": "61********************c3"
}

Each incoming status update should be confirmed with an HTTP status 200.

{
  "result": "OK"
}
Language