Skip to main content

​
Overview

Returns a list of order details. Can function with a list of Global-e order ids.

​
Producing shipping documentation

If using the GetOrdersDetails to produce shipping documentation, consider the following fields:
InformationField
Exporter details (relevant EIN / EORI / VAT #)Merchant.Order.ExporterDetails
Importer (relevant EIN / EORI / VAT #)Merchant.Order.ImporterDetails
Shipper name/addressMust include a “Global-e” mention as the exporter
CurrencyMerchant.Order.InternationalDetails.CurrencyCode
Private import mentionShould include a “Private importer” mention
Incoterm (DAP/DDP)Merchant.Order.DutiesGuaranteed
ProductsMerchant.Order.Products (list)
  – COON/A – taken from Merchant systems
  – HS CodeN/A – taken from merchant systems
  – Price excluding D&TMerchant.Order.Products[i].InternationalDiscountedPriceForCustoms
Shipping CostMerchant.Order.InternationalDetails.DeclarativeShippingPriceInCustomerCurrency. If the value is 0 (free shipping), we recommend using a non-zero low value (may attract duties and taxes). By default, if the customer benefits from Free Shipping, 5 USD is added instead for declarative purposes – this can be disabled by the Global-e team.
Destination Tax calculation ruleMerchant.Order.TaxCalculationRule indicates if destination Duties & Tax calculation is based on Products, Freight, and Duties. Possible values are accordingly: FOB, CIF, CIFD.
Total shipment declarative value for customsMerchant.Order.TotalValueForCustoms. Calculated according to the two sub-points above to include Products, Freight, and Duties.

​
Prerequisites

The Merchant OMS or WhMS should have knowledge of the following information and allow, either directly or through an escalation process, to:
  • Have the full list of items in the order
  • Enable selection of items to be dispatched
  • if applicable, enable the cancellation of line items
  • if applicable, enable the declaration of items as back-ordered
After performing the effective pick&pack and required actions in the OMS/WhMS, the following integration can be used to process the orders prior to dispatch. Schedule The report should be sent once the pick and pack in the Merchant warehouse has been completed for the day and before the orders arrive at the Global-e hub or before the orders are prepared for international shipping by merchants fulfilling from their own warehouse.

GetOrdersDetails — full request & response

Parameters, all response classes (Merchant.OrderV2, Merchant.Product, Merchant.InternationalDetails, and more), examples, and the interactive playground for POST /Order/GetOrdersDetails.

​
Use Cases

​
Retrieve details for a list of orders

Send the Global-e order ids whose details you want to retrieve in the OrderIds array. The response returns one Merchant.OrderV2 object per order.
The full response object (an array of Merchant.OrderV2 classes) and a complete sample payload are rendered on the API Reference page.