Order Status Updates (from Merchant)

UpdateOrderStatus

Merchant to Global‑e (Outbound)

This section details the steps required to perform updates from the merchant systems to Global-e (outbound)

Integration Overview

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)

UpdateOrderStatus Implementation

Method/URL

POST https://connect.globale.com/Order/UpdateOrderStatus?orderStatus={"OrderId":"GE1235436GB","OrderStatus":{"OrderStatusCode":"cancelled","Name":"cancelled"},"OrderStatusReason":{"OrderStatusReasonCode":"1010","Name":"CustomerCancel"}}

Request Parameters

Parameters	Type	Description
`MerchantGUID`	-String	Unique Merchant Identifier and API token Different for Test and Live environments
`OrderStatusDetails`	-Object	Details for order status, including: Order ID: Global‑e Order ID OrderStatus, including: OrderStatusCode (String): Status code mapped on the Global‑e side Name (String): Status name mapped on the Global‑e side OrderStatusReason, including: OrderStatusReasonCode (String): Reason code mapped on the Global‑e side (optional) Name (String): Reason name mapped on the Global‑e side (optional)

Examples

Request Example

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

Response Example

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)

UpdateOrderStatus

This API updates the order status on the Merchant’s site. Only order.OrderId and order.StatusCode members are mandatory for this method.

Method/URL

POST https://www.merchant-site-domain.com/order-status-update-url

Request Parameters

Name	Type	Description	Mandatory
`AllowMailsFromMerchant`	Boolean	Indicates if the end customer has opted to receive emails from the Merchant in the Global‑e checkout.	No
`CartHash`	String	Cart hash originally specified in merchantCartHash argument for SendCart method for the cart converted to this order on Global‑e.	No
`CartId`	String	Identifier of the cart on the Merchant’s site originally specified in merchantCartToken argument for SendCart method for the cart converted to this order on Global‑e.	No
`CCFPrice`	Decimal	Customs Clearance Fees (CCF), in the merchant currency.	No
`ClearCart`	Boolean	Indicates if the end customer’s cart must be cleared before this method finishes execution on the Merchant’s site.	No
`CurrencyCode`	String	3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency.	No
`Customer`	Customer	The paying customer’s preferences (Global-e acts as a paying customer).	No
`CustomerComments`	String	Comments text entered by the end customer in Global‑e checkout.	No
`CustomerDTBreakdown`	DTBreakdown	Contains the duties and taxes parts the customer paid for the order.	No
`DiscountedShippingPrice`	Decimal	The shipping price paid by the customer converted to the merchant’s currency. Total Shipping price reducing Order Discounts (InternationalDetails.DiscountedShippingPrice price converted to the merchant currency).	No
`Discounts`	Discount[]	The list of discounts being applied to the order, according to the original list of discounts received in SendCart for this order, and to the Merchant shipping configuration on Global‑e.	No
`DoNotChargeVAT`	Boolean	Indicates if the end customer hasn’t been charged VAT in Global‑e checkout, as specified in the doNotChargeVAT argument for the SendCart method for the cart converted to this order on Global‑e.	No
`FreeShippingCouponCode`	String	Merchant’s free shipping coupon code applied by the end customer, as specified in the FreeShippingCouponCode argument for the SendCart method for the cart converted to this order on Global‑e.	No
`InternationalDetails`	InternationalDetails	Details referring to the end customer’s order placed on the Global‑e side. These details are applicable only to the Merchants dealing with international customers’ support themselves.	No
`IsFreeShipping`	Boolean	Indicates if the Merchant offers free international shipping to the end customer, as specified in the IsFreeShipping argument for the SendCart method for the cart converted to this order on Global‑e.	No
`IsReplacementOrder`	Boolean	Indicates if the order is a replacement.	No
`IsSplitOrder`	Boolean	Indicates if the order should be handled as split order (i.e. without consolidation)	No
`LoyaltyCode`	String	Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout.	No
`LoyaltyPointsEarned`	Decimal	The number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site, as specified in the loyaltyPointsEarned argument for the SendCart method for the cart converted to this order on Global-e.	No
`LoyaltyPointsSpent`	Decimal	The number of loyalty points spent for this purchase. The existing loyalty points handling procedure must be applied to the end customer’s user account. Therefore, the “Loyalty points” type discount must not be applied to the order directly but can be used for display purposes elsewhere in the system (i.e. on the end user’s My Account page).	No
`Markups`	Discounts[]	The list of markups being applied to the order, according to the Merchant shipping configuration on Global‑e. Effectively Markup is a “negative Discount”. The main use case for Markups is when the end customer is charged in Global‑e checkout, a flat shipping rate, which is higher than the shipping rate, calculated for the respective order. In this case, Global‑e pays the difference to the merchant in the form of Markups applied to the order. Unlike Discounts, Markups may be only passed to the Merchant’s back-end ERP system for reconciliation purposes, and may not be displayed to the end customer.	No
`MerchantDTBreakdown`	DTBreakdown	Contains the duties and taxes parts the merchant subsidized for the order.	No
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.	Yes
`MerchantOrderId`	String	Order unique identifier on the Merchant’s site	No
`OrderCreationSource`	Int64	Possible values: 0 or 1 0 – GECheckout 1 - Marketplace	No
`OrderDocuments`	OrderDocument[]	Always contains a single document - it can be either a VAT Invoice or a Customer Receipt, depends if it is within the EU or not.	No
`OrderId`	String	Global‑e order unique identifier.	Yes
`OrderPaymentMethods`	OrderPaymentMethod[]	List of payment methods the customer use (Credit card, Gift Cards)	No
`OriginalOrder`	OriginalOrder	Details referring to the original order if the current order is a replacement.	No
`OTCurrencyCode`	String	Currency of the one-time voucher code used to place the order	No
`OTVoucherAmount`	Decimal	The amount taken off the voucher when applicable	No
`OTVoucherCode`	String	One-time voucher code used to place the order	No
`PaymentDetails`	PaymentDetails	The paying customer’s payment details.	Yes
`PrePayOffered`	Boolean	Indicates if the prepayment option for duties and taxes was offered to the customer	No
`PriceCoefficientRate`	Decimal	CountryCoefficient rate is applied to the prices in this order.	No
`PrimaryBilling`	CustomerDetails	Primary customer’s billing details. Primary customer denotes the paying (Global‑e) customer unless Customer.IsEndCustomerPrimary is not set to TRUE. Note that all string attributes of the end customer’s details are indicated in the URL-encoded form. Therefore, if the Customer.IsEndCustomerPrimary is TRUE then all string attributes in PrimaryBilling are URL encoded.	No
`Products`	Product[]	The list of products being purchased	No
`PrimaryShipping`	CustomerDetails	Primary customer’s shipping details. Primary customer denotes the paying (Global‑e) customer unless Customer.IsEndCustomerPrimary is not set to TRUE. Note that all string attributes of the end customer’s details are indicated in the URL-encoded form. Therefore, if the Customer.IsEndCustomerPrimary is TRUE then all string attributes in PrimaryShipping are URL encoded.	No
`RoundingRate`	Decimal	The average conversion rate applied to the prices paid by the end customer, when calculating the prices paid by Global‑e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors.	No
`SameDayDispatch`	Boolean	Indicates if the end customer has requested “Same Day Dispatch” on Global‑e checkout.	No
`SameDayDispatchCost`	Decimal	Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency.	No
`SecondaryBilling`	CustomerDetails	Secondary customer’s billing details. Secondary customer denotes the end customer who has placed the order with Global‑e checkout unless Customer.IsEndCustomerPrimary is not set to TRUE. Note that all string attributes of the end customer’s details are indicated in the URL-encoded form. Therefore, if the Customer.IsEndCustomerPrimary is FALSE then all string attributes in SecondaryBilling are URL encoded.	No
`SecondaryShipping`	CustomerDetails	Secondary customer’s shipping details. Secondary customer denotes the end customer who has placed the order with Global‑e checkout unless Customer.IsEndCustomerPrimary is not set to TRUE. Note that all string attributes of the end customer’s details are indicated in the URL-encoded form. Therefore, if Customer.IsEndCustomerPrimary is FALSE then all string attributes in SecondaryShipping are URL encoded.	No
`ShippingMethodCode`	String	Code denoting the local shipping method selected from the list of available shipping options provided in shippingOptionsList argument for SendCart method for the cart converted to this order on Global‑e.	No
`ShipToStoreCode`	String	Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on the Global‑e side).	No
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).	Yes
`TotalDutiesAndTaxesPrice`	Decimal	Total Duties & Taxes value including Customs Clearance Fees, in the merchant currency. This amount is the total amount, regardless of whether the customer or the merchant paid it.	No
`TotalDutiesPaidByCustomerPrice`	Decimal	The total amount of duties paid by the customer in the merchant’s currency.	No
`UserId`	String	Internal User identifier on the Merchant’s site originally specified in shippingDetails.UserId argument for SendCart method for the cart converted to this order on Global‑e.	No
`USSalesTax`	Decimal	Sales tax value for USA in the merchant currency. This value is included in TotalDutiesAndTaxesPrice.	No
`WebStoreCode`	String	Code used on the merchant’s side to identify the web store, as specified in the WebStoreCode argument for the SendCart method for the cart converted to this order on Global‑e.	No

Response Parameters

ResponseInfo

Name	Type	Description	Mandatory
`Description`	String	Optional response description. In case of an error, this property indicates the error message description.	No
`ErrorCode`	String	Error code to be returned when an error occurs.	No
`InternalOrderId`	String	Order unique identifier on the Merchant’s site	No* (Optional in case of error, failure or if the action is not related to a specific order)
`Message`	String	Optional response message. In case of an error, this property indicates the error message text.	No
`OrderId`	String	Order identifier on the Merchant’s site used for display and reporting purposes only. Unlike 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).	No
`PaymentAmount`	String	The total payment amount in PaymentCurrency charged for the order (if payment was processed in the respective API method call).	No
`PaymentCurrencyCode`	String	3-char ISO currency code for the order (if payment was processed in the respective API method call).	No
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).	No* (Optional in case of error or failure)
`Success`	Boolean	Indicates if the call has succeeded. FALSE denotes an error or failure.	No

Examples

Request Example

{
    
    "OrderId": "GE10047946955SG",
    "StatusCode": "CANCELLED",
    "MerchantGUID": "0511db1d-cdc6",
    "CartId": "52c615003faea0995",
    "MerchantOrderId": "00024345",
    "MerchantInternalOrderId": "00024345",
    "PriceCoefficientRate": 1.000000,
    "CartHash": "ICEzF5/PznED/VyE=",
    "WebStoreCode": "shop",
    "WebStoreInstanceCode": "www.qa.shop.asia",
    "DiscountedShippingPrice": 7.12,
    "InternationalDetails": {
        "CurrencyCode": "SGD",
        "TotalPrice": 29.90,
        "TransactionCurrencyCode": "SGD",
        "TransactionTotalPrice": 29.9000,
        "TotalShippingPrice": 4.1600,
        "SameDayDispatchCost": 0.0000,
        "TotalCCFPrice": 0.0000,
        "TotalDutiesPrice": 0.000000000,
        "USSalesTax": 0.0,
        "ShippingMethodCode": "STANDARD_APAC",
        "ShippingMethodName": "Ship-GlobalE",
        "PaymentMethodCode": "1",
        "PaymentMethodName": "Visa",
        "CardNumberLastFourDigits": "1111",
        "ExpirationDate": "2030-3-31",
        "DutiesGuaranteed": false,
        "OrderTrackingNumber": null,
        "OrderTrackingUrl": "https%3a%2f%2fwww2.bglobale.com%2fOrder%2fTrack%2fmZVW%3fOrderId%3dGE10047946955SG%",
        "OrderWaybillNumber": null,
        "ShippingMethodTypeCode": "Standard",
        "ShippingMethodTypeName": "Standard Courier",
        "DeliveryDaysFrom": 2,
        "DeliveryDaysTo": 3,
        "ConsignmentFee": 0.0000,
        "SizeOverchargeValue": 0.0000,
        "RemoteAreaSurcharge": 0.0000,
        "DiscountedShippingPrice": 10.0000,
        "CashOnDeliveryFee": 0.0,
        "ParcelsTracking": [
        ],
        "TotalVATAmount": 1.95,
        "ShippingVATRate": 7.0000,
        "ShippingMethodStatusCode": "Undefined",
        "ShippingMethodStatusName": "undefined",
        "ShipmentStatusUpdateTime": null,
        "ShipmentLocation": null
    },
    "GiftCards": null,
    "DeclarativeShippingPriceInCustomerCurrency": null,
    "TotalValueForCustoms": null,
    "TaxCalculationRule": null
}

Response Example

Success example

{
    "action": "Globale-OrderUpdateStatus",
    "queryString": "",
    "locale": "en_SG",
    "InternalOrderId": "00024345",
    "OrderId": "00024345",
    "Success": true,
    "ErrorCode": null,
    "Message": null,
    "Description": null
}

Failure example

{
    " Success ": "false ",
    "Message": "error message",
    "Description": "error description"
}

Documentation Portal

Order Status Updates (from Merchant)

UpdateOrderStatus

Merchant to Global‑e (Outbound)

Integration Overview

UpdateOrderStatus Implementation

Important

UpdateOrderStatus

Search results