Order Status Updates (from Global‑e) - Global-e Docs

UpdateOrderStatus (Global-e to Merchant)

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)

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

Update Order Status (from Global-e) — reference & playground

The Merchant.Order request class, the ResponseInfo response class, request/response examples, and the interactive playground for POST to the merchant-hosted order-status-update endpoint.

Use Cases

Update the order status on the merchant’s site

Global‑e posts the full merchant order to the merchant-hosted endpoint. Only OrderId and StatusCode are mandatory; requests can contain more parameters than listed.

{
    "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
}

The full request and response classes, along with success and failure response examples, are rendered on the API Reference page.

⌘I