Skip to main content
POST
Update Order Status (from Global-e)
Part of the Order Status Updates (from Global‑e) integration guide — see it for when and how to use this endpoint.

Body

application/json

Provides full details for the merchant order. Only OrderId and StatusCode are mandatory; requests can contain more parameters than listed.

OrderId
string
required

Global‑e order unique identifier.

StatusCode
string
required

Code denoting the order status. Only OrderId and StatusCode are mandatory for this method.

MerchantGUID
string

Merchant's unique identifier (present in the worked example).

CartId
string
MerchantOrderId
string
MerchantInternalOrderId
string
PriceCoefficientRate
number
CartHash
string
WebStoreCode
string
WebStoreInstanceCode
string
DiscountedShippingPrice
number
InternationalDetails
InternationalDetails · object

International order details. Inferred entirely from the worked example (no field table on the page); types inferred from the example values. See review §2.

GiftCards
any[] | null

Null in the worked example; element shape not documented.

DeclarativeShippingPriceInCustomerCurrency
number | null
TotalValueForCustoms
number | null
TaxCalculationRule
string | null

Response

200 - application/json

Success or failure. Check the Success field to distinguish. On failure, Message and Description carry the error text.

Provides details regarding the API call response.

action
string

The action name (present in the worked success example).

queryString
string

Query string echoed back (present in the worked success example).

locale
string

Locale of the order (present in the worked success example).

InternalOrderId
string

Order unique identifier on the Merchant's site.

OrderId
string

Order identifier on the Merchant's site.

Success
boolean

Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.

ErrorCode
string | null

Error code to be returned when an error occurs.

Message
string | null

Optional response message. In case of an error, this property indicates the error message text.

Description
string | null

Optional response description. In case of an error, this property indicates the error message description.