OrderAccepted
Type: object.
| Name | Type | Description |
|---|---|---|
dispatchState required | string | Where the order is on its way to the store's POS: pending_pos_adapter (accepted and queued, not in the POS yet), dispatched (it landed in the POS), parked (it could not be sent or the POS refused it; the order.parked webhook says why), or simulated (a test key's order: validated, never sent to the store, and final). |
externalOrderId required | string | |
orderId required | string | CompuDime's id for the order. A test key's simulated order has an id that starts with test_; a live order's id never does. |
requestId required | string | |
status required | string | accepted for every order the API took, a live key's and a test key's alike; dispatchState says where it went. |
billing | BillingMeta | |
createdAt | string (date-time) | |
fulfillment | OrderFulfillment | Where the order stands in the store (picking, out for delivery, delivered, and so on), once the order landed and the store answered. Absent before that. It is the last field; fields=fulfillment selects it. The order reads are flat-priced: selecting it changes no charge. On the 202 answer only a replay of an order the store already answered for carries it. |
invoice | OrderInvoiceLink | The POS invoice the order became, named by the feed identity the store stamped on it, once the store reported the order landed (dispatchState dispatched). Absent before that. fields=invoice selects it. On the 202 answer only a replay of an order that already landed carries it. |
orderMethod | string | The method the order was created with (delivery when it was created with a shipTo and no orderMethod). Absent when the order named none: the store's default delivery method applies when it reaches the POS. One of: pickup, delivery. |
shipTo | OrderShipTo | The delivery address the order was created with, normalized (trimmed, state upper-cased, phone as 10 digits). Absent when the order carries none. |
storeDiscount | OrderStoreDiscount | The customer's discount the store took off the lines it priced (register rule), once the order is dispatched. Absent before that and whenever none applied (the cash account, a customer without a discount, the order_screen rule, or no line priced by the store). It follows storePrices; fields=storeDiscount selects it. Flat-priced like storePrices. On the 202 answer only a replay of an order that already landed carries it. |
storePrices | array of OrderStorePrice | What the store charged for each line the order sent without a unitPrice, in line order, once the order is dispatched (dispatchState dispatched). Absent before that, and absent when every line carried its own unitPrice (such an order reads exactly as before). It follows invoice; fields=storePrices selects it. The order reads are flat-priced: selecting it changes no charge. On the 202 answer only a replay of an order that already landed carries it. |
updatedAt | string (date-time) |
Other fields can appear later. Ignore the ones you do not know.