POST https://webhook.example.com

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

application/json

Body

  • orderId string Required
  • status string Required
  • timeStamp string Required
  • receiptId string
  • reason string
  • channelOrderId string
  • location string Required
  • channelLink string Required

Responses

  • 200 application/json

    Ok

  • 400 application/json

    Bad Request

POST /channel/order_status
Request examples
{
  "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"
}