Send order progress and lifecycle updates to Gett. Orders use two fields:
state— High-level lifecycle:open,completed,cancelledstatus— Granular progress withinopen:confirmed→preparing→ready→inTransit
Send status for progress updates within an active order. Send state to close an order (completed or cancelled). The pending status is set automatically by Gett when the order is created — you do not need to send it.
An order can be cancelled from any status by sending state: "cancelled" with a cancelReason.
Update Order Status
Send order status updates to Gett as orders progress through your system. Orders use two fields:
status— Progress within an active order:confirmed→preparing→ready→inTransitstate— Lifecycle transitions: set tocompletedorcancelledto close the order
Progress updates: Send status as the order moves through stages. Include estimatedReadyAt for better consumer experience.
Closing an order: Send state: "completed" when fulfilled, or state: "cancelled" with a cancelReason when cancelled.
The pending status is set automatically by Gett when the order is created — do not send it.
path Parameters
orderIdThe Gett Order ID
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Update Order Status › Request Body
stateSet to 'completed' or 'cancelled' to close the order
statusProgress update within the open state
estimatedReadyAtcancelReasonRequired if state is cancelled
Update Order Status › Responses
Status update received