Fetch an order
Read one of your orders back by your own id.
Statuses beyond the common ones: 404 the store is not on your channel, or no order with that platformOrderId exists there yet (it may still be queued).
Safe to retry: this operation is read-only and idempotent.
Request
- storeCodestring
Required. The store's
codefromfetchStores. - platformOrderIdstring
Required. The
platformOrderIdyou sent oncreateOrder.
{
"storeCode": "<storeCode>",
"platformOrderId": "00000000-0000-0000-0000-000000000000"
}Responses
Headers
- x-mealco-tx-idstringoptional
The correlation id for this call, returned on a response from an operation. Quote it when you report a problem so that we can trace the request. You may send your own x-mealco-tx-id on the request and it is used as the id. It is optional in the schema because a request with a malformed JSON body is rejected before an id is assigned.
- orderOrder
The order.
idis Sous Chef's id for it;platformOrderIdis yours. An object wrapper so later versions can add sibling fields additively.
{
"order": {
"id": "00000000-0000-0000-0000-000000000000",
"platformOrderId": "00000000-0000-0000-0000-000000000000",
"status": "new",
"deliveryStatus": "ASSIGNED",
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z",
"estimatedReadyAt": "2026-01-01T00:00:00Z",
"rejectReason": "<rejectReason>",
"rejectReasonCode": "itemOutOfStock",
"store": {
"id": "00000000-0000-0000-0000-000000000000",
"externalId": "00000000-0000-0000-0000-000000000000",
"location": "<location>",
"brand": "<brand>",
"platform": "<platform>"
},
"cancellation": {
"by": "<by>",
"reason": "<reason>",
"reasonCode": "itemOutOfStock",
"at": "2026-01-01T00:00:00Z"
},
"details": {
"externalId": "00000000-0000-0000-0000-000000000000",
"externalReadableOrderNum": "<externalReadableOrderNum>",
"placedAt": "2026-01-01T00:00:00Z",
"estimatedPickupAt": "2026-01-01T00:00:00Z",
"isPickup": true,
"isMerchantDelivery": true,
"subtotal": 50,
"tax": 50,
"tip": 50,
"deliveryFee": 50,
"total": 50,
"items": [
{}
],
"promotions": [
{}
]
}
}
}About Orders
Send orders to the restaurants on your channel, move them along, and read them back.
Stores are addressed by their code from fetchStores. A code that is unknown, retired or not on your channel answers 404, indistinguishably. Orders are addressed by YOUR id, platformOrderId: it is the idempotency key, and it must be unique across every order you send. Sous Chef's own id for the order arrives as id on every order.* webhook and on fetchOrder.
200 on a write means we accepted the call for processing, not that the order has reached the kitchen. An order for a store that is paused or outside its hours comes back as an order.rejected webhook. Every other order goes to the kitchen: fetchOrder returns it, and its progress arrives as order.status.updated when it becomes ready and then finished. Every write is idempotent, so retry on 500 / 503 freely.