OrderWebhookData
The order's state when the event was queued. It never carries the delivery address, the customer or a staff member's name. New keys may be added; ignore the ones you do not know.
Type: object.
| Name | Type | Description |
|---|---|---|
attempts required | integer | How many dispatch attempts had failed for this order when the event was queued. It is not the number of tries: on order.dispatched the attempt that landed is not counted, so an order that landed on its first try reports 0. On order.parked it includes the failure that parked the order; an order the store's operator parked by hand counts only the failures before. The count is never reset, not even when the owner retries a parked order. |
dispatchError required | string | Why dispatch stopped (order.parked); empty on order.dispatched. |
dispatchState required | string | One of: dispatched, parked. |
externalOrderId required | string | Your own order id, as sent on POST /v1/orders. |
orderId required | string | The platform order id (GET /v1/orders/{orderId}). |
posOrderRef required | string | The store's own reference for the landed order, exactly as the store agent reported it. Normally OrderExchange CDAPI:<integration id>#<order number>: the order exchange key the order was posted under, with a number the agent derives from the platform order id. Only when the agent could already find the invoice as the order landed is it the POS invoice id instead. It is not a dependable invoice number: to read the invoice, follow invoice. Empty on order.parked. |
status required | string | |
fulfillment | OrderFulfillment | Where the order stands in the store, the same object the order reads carry: on the fulfillment events (order.picked, order.out_for_delivery, order.delivered, order.completed, order.canceled) only, absent on order.dispatched and order.parked. |
invoice | OrderInvoiceLink | The POS invoice the order became, the same link the order reads carry: on order.dispatched and the fulfillment events (unless your externalOrderId is outside the shape the invoice read by feed identity accepts), absent on order.parked. |
Other fields can appear later. Ignore the ones you do not know.