basket | | object |
basket.id | The identifier of the basket being checked out, returned from Create Basket | string |
order | | object |
order.channelOrderId | Your channel's unique ID for this order. Deliverect uses it to reference the order in webhooks and reporting, so it must not be reused. If not supplied, it will be auto-generated. | string |
order.channelOrderDisplayId | The short reference displayed on the POS, kitchen tickets, and receipts. Keep it concise and human-readable. | string |
order.by | The ordering surface or client that placed the order (e.g. "Mobile App", "Web App", "Kiosk"). Useful for reporting and support. | string |
order.courier | Controls delivery handling. Set "restaurant" to initiate integrated Deliverect Dispatch flows; any other string (e.g. "thirdparty") indicates a third-party courier not managed via Deliverect. | string |
order.validationId | UUID returned by the Dispatch Availability endpoint which helps to secure a courier and pre-validated delivery job quote | string |
order.includeCutlery | Confirm to store if cutlery is requested with the order | boolean |
note | A free-text, order-level note passed through at checkout (e.g. delivery or preparation instructions). | string |
payments | Array of one or more payment entries. The sum of all amount values must equal the basket total. | array |
payments[].type | Payment types: dpay |gift_card |third_party | enum |
payments[].externalId | Reference for the payment: if Deliverect Pay it would be the paymentId, for gift_card it'd be the transaction ID. | string |
payments[].isPrepaid | Whether the amount has already been collected. false means the amount is still due (e.g. cash on delivery). | boolean |
payments[].amount | The total amount paid should be sent as an integer with 2 decimal digits, for example, 1 dollar would be sent as 100. | integer |
payments[].instrumentType | For third_party payments only: the underlying instrument, e.g. cash, card, online. | string |
payments[].metadata | Additional data, required for gift_card payments. | object |
payments[].metadata.giftCardProviderProfileLinkId | For gift_card payments only: the identifier linking the gift card provider's profile/integration configuration used to process the payment. | string |
payments[].metadata.giftCardNumber | For gift_card payments only: the card number of the gift card being redeemed. | string |
payments[].metadata.giftCardVerificationCode | For gift_card payments only: the verification/security code of the gift card being redeemed. | string |
