Update Order Status
The UpdateOrderStatus API lets you cancel an order with a reason (and notify the customer accordingly) or move an order to a processing status (used by Global‑e or specific cases not covered in this guide). This guide focuses on cancelling orders prior to dispatch.
Query Parameters
The request payload, as a URL-encoded, JSON-serialized OrderStatusDetails object — passed in the query string, not as a request body. Only OrderId is required. See the integration guide for the object's fields.
"{\"OrderId\":\"GE1235436GB\",\"OrderStatus\":{\"OrderStatusCode\":\"cancelled\",\"Name\":\"cancelled\"},\"OrderStatusReason\":{\"OrderStatusReasonCode\":\"1010\",\"Name\":\"CustomerCancel\"}}"
Response
Success or failure. Check the Success field to distinguish. On failure, Message and Description carry the error text.
Indicates if the API call was successful or not, and why.
Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.
Optional response message. In case of an error, this property indicates the error message text.
Optional response description. In case of an error, this property indicates the error message description.
Error code to be returned when an error occurs.
Order unique identifier on the Merchant's site.
Order identifier on the Merchant's site used for display and reporting purposes only. Unlike the InternalOrderId, this identifier is not necessarily unique over time, as the Merchant's site may potentially reuse it (for example after deleting the old order having the same OrderId).
The total payment amount in PaymentCurrency charged for the order (if payment was processed in the respective API method call).
3-char ISO currency code for the order (if payment was processed in the respective API method call).
Code denoting the order status on the Merchant's site (to be mapped on the Global‑e side).

