Order Status Updates (from Merchant)
UpdateOrderStatus
UpdateOrderStatus (Merchant to Global-e)
The UpdateOrderStatus
API lets you:
Cancel an order with a reason (and notify the customer accordingly)
Move an order to a processing status (used by Global‑e or specific cases not covered in this guide)
Based on this description, this guide focuses on cancelling orders prior to dispatch.
The following attributes are required in the system (OMS/ERP/MW) when executing the calls:
Global‑e order number (and not ecommerce platform or another system)
Status and reasons codes mapped on the Global‑e side (for example, for cancellation reasons)
Method/URL
POST https://{globale_api_domain}connect.globale.com/Order
Regarding the API domain, for more details about relevant environments, see Global-e Environments.
Example
POST https://connect.globale.com/Order/UpdateOrderStatus?orderStatus={"OrderId":"GE1235436GB","OrderStatus":{"OrderStatusCode":"cancelled","Name":"cancelled"},"OrderStatusReason":{"OrderStatusReasonCode":"1010","Name":"CustomerCancel"}}
Parameters
Request
Requests can contain more parameters than listed.
Parameters | Type | Description | Mandatory |
---|---|---|---|
| String | Unique Merchant Identifier and API token. Different for Test and Live environments. | |
| Object OrderStatusDetails | Details for order status, including:
|
Return
Name | Type | Description |
---|---|---|
ResponseInfo | Class Merchant.ResponseInfo | Indicates if the API call was successful or not and why. |
Examples
Request
{ "OrderId": "GE1235436GB", "OrderStatus": { "OrderStatusCode": "cancelled", "Name": "cancelled" }, "OrderStatusReason": { "OrderStatusReasonCode": "1010", "Name": "CustomerCancel" } }
Response
Success
{ "Success": "true", }
Failure
{ "Success": "false", "Message": "error message" "Description": "error description" }
Order Status Reasons
Important
Reasons (in addition to statuses) must be mapped in the Global‑e configuration so that appropriate notifications can be sent to the customer.
Possible cancellation reasons:
Cancellation because of out-of-stock
Cancellation at the customer’s request
Cancellation for technical reasons (default in case of no reason mapping declared)