Skip to main content
POST
cURL
Part of the Order Status Updates (from Merchant) integration guide — see it for when and how to use this endpoint.

Query Parameters

orderStatus
string
required

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.

Example:

"{\"OrderId\":\"GE1235436GB\",\"OrderStatus\":{\"OrderStatusCode\":\"cancelled\",\"Name\":\"cancelled\"},\"OrderStatusReason\":{\"OrderStatusReasonCode\":\"1010\",\"Name\":\"CustomerCancel\"}}"

Response

200 - application/json

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.

Success
boolean

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

Message
string

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

Description
string

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

ErrorCode
string

Error code to be returned when an error occurs.

InternalOrderId
string

Order unique identifier on the Merchant's site.

OrderId
string

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).

PaymentAmount
string

The total payment amount in PaymentCurrency charged for the order (if payment was processed in the respective API method call).

PaymentCurrencyCode
string

3-char ISO currency code for the order (if payment was processed in the respective API method call).

StatusCode
string

Code denoting the order status on the Merchant's site (to be mapped on the Global‑e side).