OrderDetails
What was ordered and what it cost. See Order.details.
Every amount is an integer in the currency's minor unit (cents). Each field is absent when the platform did not send it, or when what was stored is not a whole number of cents or a readable time, so older orders and orders from a direct channel can carry fewer.
The guest's identity, the delivery address, the courier and free-text notes are not part of this object.
Fields
- externalIdstring
The platform's own order id — in practice the same value as
platformOrderId. - externalReadableOrderNumstring
The short order number the customer and the courier see.
- placedAtstring<date-time>
When the customer placed the order, ISO-8601 UTC.
- estimatedPickupAtstring<date-time>
When the order is due to be picked up, ISO-8601 UTC. A scheduled order carries its scheduled time.
- isPickupboolean
truewhen the customer collects the order;falsefor delivery. - isMerchantDeliveryboolean
truewhen the restaurant delivers the order itself rather than a platform courier. - subtotalinteger
The items' total before tax, tip and fees, in cents.
- taxinteger
Tax, in cents.
- tipinteger
The tip, in cents.
- deliveryFeeinteger
The delivery fee, in cents.
- totalinteger
The order total, in cents, as the platform reported it.
- itemsOrderItem[]
The ordered items, each with its modifiers.
- promotionsOrderPromotion[]
The promotions applied to the order. Empty or absent when none applied.