API Reference - Global-e Docs

The Global-e REST API. Endpoints are grouped by area below — select one to open its full request and response schema, parameters, and examples. Shared objects reused across endpoints are listed at the end.

Shipping

Endpoint	Method & path
Get shipping documents (Merchant to Global-e)	`POST /Order/GetShippingDocuments`
Get shipping details (Merchant to Global-e)	`POST /ShippingDetails/GetShippingDetails`
Get shipping details extended (Merchant to Global-e)	`POST /ShippingDetails/GetShippingDetailsExtended`
Dispatch orders (Merchant to Global-e)	`POST /Order/DispatchOrders`
Dispatch consolidated shipment (Merchant to Global-e)	`POST /Order/DispatchConsolidatedShipment`
Get tracking events (Merchant to Global-e)	`POST /Shipment/GetTrackingEvents`
Void parcel (Merchant to Global-e)	`POST /Parcel/VoidParcel`
Submit bonded information (Merchant to Global-e)	`POST /api/merchant/parcels/bonded-information`
Upload shipment documents (Merchant to Global-e)	`POST /api/shipments/documents/upload`
Get shipment information (Merchant to Global-e)	`GET /api/shipments/{trackingNumber}`

Orders

Endpoint	Method & path
Create order (Merchant to Global-e)	`POST /checkout/CreateOrder`
Edit order (Merchant to Global-e)	`POST /api/orders/changes`
Quote order changes (Merchant to Global-e)	`POST /api/orders/changes/quote`
Update Order Dispatch	`POST /Order/UpdateOrderDispatch`
Update parcel status (Merchant to Global-e)	`POST /orders/{orderId}/parcels/{parcelCode}/statuses`
Update Order Status	`POST /Order/UpdateOrderStatus`
Create order refund (Merchant to Global-e)	`POST /Order/CreateOrderRefund`
Create order platform (Merchant to Global-e)	`POST /Checkout/CreateOrderPlatform`
Update Order Products (Merchant to Global-e)	`POST /Order/UpdateOrderProducts`
UpdateOrderDispatchV2	`POST /Order/UpdateOrderDispatchV2`
Create Additional Required Documents (Merchant to Global-e)	`POST /additional-required-documents`
Get refund details (Merchant to Global-e)	`GET /v1/orders/{orderId}/refunds`
Sending Bulk Emails (Merchant to Global-e)	`POST /emails`

Returns

Endpoint	Method & path
Get return shipping options (Merchant to Global-e)	`POST /Return/GetReturnShippingOptions`
Get return documents (Merchant to Global-e)	`POST /Return/GetReturnDocuments`
Update RMA (Merchant to Global-e)	`POST /Return/UpdateRMA`

Gift Cards

Endpoint	Method & path
Validate gift card	`POST /ValidateGiftCard`
Redeem gift card	`POST /RedeemGiftCard`
Refund gift card	`POST /RefundGiftCard`

Checkout

Endpoint	Method & path
SendCartV2 (Merchant to Global-e)	`POST /Checkout/SendCartV2`

Pricing

Endpoint	Method & path
Get catalog prices (Merchant to Global-e)	`POST /Browsing/GetCatalogPrices`
GetMerchantPriceDetails (Merchant to Global-e)	`GET /externalapi/GetMerchantPriceDetails`

Browsing & Catalog

Endpoint	Method & path
Active hub details (Merchant to Global-e)	`POST /Browsing/ActiveHubDetails`
App settings (Merchant to Global-e)	`POST /Browsing/AppSettings`
App version (Merchant to Global-e)	`POST /Browsing/AppVersion`
Countries (Merchant to Global-e)	`POST /Browsing/Countries`
Country coefficients (Merchant to Global-e)	`POST /Browsing/CountryCoefficients`
Currencies (Merchant to Global-e)	`POST /Browsing/Currencies`
Currency Rates (Merchant to Global-e)	`POST /Browsing/CurrencyRates`
Location by IP (Merchant to Global-e)	`POST /Browsing/LocationByIP`
Location default culture (Merchant to Global-e)	`POST /Browsing/LocationDefaultCulture`
Locations Default Cultures List (Merchant to Global-e)	`POST /Browsing/LocationsDefaultCulturesList`
Product Countries (Merchant to Global-e)	`POST /Browsing/ProductCountryS`
Recent Product Countries (Merchant to Global-e)	`POST /Browsing/RecentProductCountryS`
Regions (Merchant to Global-e)	`POST /Browsing/Regions`
Rounding rules (Merchant to Global-e)	`POST /Browsing/RoundingRules`
Save products list (Merchant to Global-e)	`POST /Browsing/SaveProductsList`
Save Products Bulk (Merchant to Global-e)	`POST /Bulk/SaveProductsBulk`
Shipping Options (Merchant to Global-e)	`POST /Browsing/ShippingOptions`
VAT Category Countries (Merchant to Global-e)	`POST /Browsing/VATCategoryCountryS`

Webhooks

Endpoint	Method & path
Send Order To Merchant (Global-e to Merchant)	`POST /order-update-create-url`
SendAdditionalRequiredDocumentsToMerchant (Global-e to Merchant)	`POST /send-additional-required-documents-url`
Notify order refund (Global-e to Merchant)	`POST /order-refund-url`
Update Order Shipping Info (Global-e to Merchant)	`POST /order-shipping-info-update-only-url`
Update Order Status (Global-e to Merchant)	`POST /order-status-update-url`
Update Parcel Dispatch	`POST /UpdateParcelDispatch`
Send RMA Info to Merchant (Global-e to Merchant)	`POST /rma-info-to-merchant-url`
Get Checkout Cart Info (Global-e to Merchant)	`GET /get-checkout-cart-info-url`
Perform Order Payment (Global-e to Merchant)	`POST /order-payment-only-url`
Validate Stock (Global-e to Merchant)	`POST /checkout-validate-cart-stock-url`
ValidateVoucher (Global-e to Merchant)	`POST /checkout-validate-cart-voucher-url`
Client apply loyalty vouchers (Global-e to Merchant)	`POST /ClientApplyLoyaltyVouchers`
RemoveRestrictedProducts (Global-e to Merchant)	`POST /remove-restricted-products-url`

Shared Objects

Schema definitions reused across several endpoints.