basket.id | The identifier of the basket being checked out, returned from Create Basket | string |
channelOrderId | The unique reference for the order on the commerce channel (if not supplied, will be auto-generated) | string |
channelOrderDisplayId | A shorter, human-readable order reference shown to staff and customers (e.g. on receipts and POS screens). | string |
by | To identify the origin of the order, e.g. "Mobile App", "Web App", "Kiosk". | string |
courier | Indicates who is responsible for delivery fulfillment. To initiate Deliverect integrated Dispatch flows, specify "restaurant" any other string indicates a third-party courier not managed via Deliverect will be used. | string |
validationId | UUID returned by the Dispatch Availability endpoint which helps to secure a courier and pre-validated delivery job quote | string |
payments | Array of one or more payment entries. The sum of all amount values must equal the basket total. | Array |
type | Payment types: dpay |gift_card |third_party | enum |
externalId | Reference for the payment: if Deliverect Pay it would be the paymentId, for gift_card it'd be the transaction ID. | string |
isPrepaid | Whether the amount has already been collected. false means the amount is still due (e.g. cash on delivery). | boolean |
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 |
instrumentType | For third_party payments only: the underlying instrument, e.g. cash, card, online. | string |
metadata | Additional data, required for gift_card payments | array |
