Schema
Order Status
Represents the status of an order.
merged identifies a source whose contents have been combined into another order. Its historical snapshot is retained and it is closed off.
From API version 27-10-2026, including requests without an X-API-VERSION header, merged sources return merged. Explicit older versions return cancelled while retaining merge links, events and timestamps.
Note that the pending_dispatch status will never be returned for orders access via the Merchant Console, OMS or POS service.
Overview
Allowed values
pending_dispatchpending_acceptanceassigning_driverscheduledin_kitchenpackingpending_collectionen_routecompletecancelledmergedUsed by
Raw YAML
Download source
title: Order Status
description: |-
Represents the status of an order.
`merged` identifies a source whose contents have been combined into another order. Its historical snapshot is retained and it is closed off.
From API version `27-10-2026`, including requests without an `X-API-VERSION` header, merged sources return `merged`. Explicit older versions return `cancelled` while retaining merge links, events and timestamps.
Note that the `pending_dispatch` status will never be returned for orders access via the Merchant Console, OMS or POS service.
x-tags:
- Foundation
enum:
- pending_dispatch
- pending_acceptance
- assigning_driver
- scheduled
- in_kitchen
- packing
- pending_collection
- en_route
- complete
- cancelled
- merged