GetOrdersDetails API

Note

If using the GetOrdersDetails to produce shipping documentation, consider the following fields:

Information	Field
Exporter details (relevant EIN / EORI / VAT #)	`Merchant.Order.ExporterDetails`
Importer (relevant EIN / EORI / VAT #)	`Merchant.Order.ImporterDetails`
Shipper name/address	Must include a “Global‑e” mention as the exporter
Currency	`Merchant.Order.InternationalDetails.CurrencyCode`
Private import mention	Should include a “Private importer” mention
Incoterm (DAP/DDP)	`Merchant.Order.DutiesGuaranteed`
Products	`<List> Merchant.Order.Products`
-- COO	N/A – taken from Merchant systems
-- HS Code	N/A – taken from merchant systems
-- Price excluding D&T	`Merchant.Order.Products[i].InternationalDiscountedPriceForCustoms`
Shipping Cost	`Merchant.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, 5USD is added in lieu of declarative purposes – this can be disabled by the Global‑e team.
Destination Tax calculation rule	`Merchant.Order.TaxCalcalculationRule` Indicates if destination Duties & Taxes calculation is based on Products, Freight, and Duties Possible values are accordingly: FOB, CIF, CIFD
Total shipment declarative value for customs	`Merchant.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 (OrdersDetailsFilter filter)

Returns a list of order details.

Can function with a list of Global‑e order ids.

SAMPLE

BODY

{"OrderIds":["GE2794623GB", "GE2794622GB", "GE2794621GB"]}

URL

https://connect.bglobale.com/Order/GetOrdersDetails?merchantGUID=abcdabcd-abcd-abcd-abcd-abcdabcdabcd

ACCEPTS

OrdersDetailsFilter filter

Full post data list of Global‑e order IDs

RETURNS

List of MerchantOrder classes

Classes

The following classes are used by this API method.

ErrorInfo

Property	Type	Description
Code	String	Error code
Error	String	Error messages
Description	String	Error description

Merchant.OrderV2

Extends Merchant.Order (inherits all fields from Merchant.Order).

The List<Merchant.Product> contains Merchant.ProductV2 objects.

Property	Type	Description
DateCreated	DateTime String	Order creation date and time
CurrencyName	String	Customer currency name
Parcels	List	The list of parcels associated with the order

Merchant.Order

Property	Type	Description
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.
`OrderId`	String	Global‑e order unique identifier.
`MerchantOrderId`	String	Optional Order unique identifier on the Merchant’s site returned from a previous call to `SendOrderToMerchant`method for this order.
CartId	String	Optional Identifier of the cart on the Merchant’s site originally specified in `merchantCartToken` argument for the `SendCart` method for the cart converted to this order on Global‑e.
CartHash (optional)	String	Cart hash originally specified in `merchantCartHash` argument for `SendCart` method for the cart converted to this order on Global‑e.
StatusCode	String	Code denoting the order status on the Merchant site (to be mapped on the Global‑e side).
CurrencyCode	String	3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency.
PriceCoefficientRate	Decimal	`CountryCoefficient` rate is applied to the prices in this order.
RoundingRate	Decimal	The average conversion rate applied to the prices paid by the 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.
UserId (optional)	String	Internal User identifier on the Merchant’s site originally specified in `shippingDetails`. `UserId` argument for the `SendCart` method for the cart converted to this order on Global‑e.
ShippingMethodCode (optional)	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.
ClearCart	Bool	Indicates if the end customer’s cart must be cleared before this method finishes execution on the Merchant’s site.
AllowMailsFromMerchant	Bool	Indicates if the end customer has opted for Global‑e checkout to receive emails from the Merchant.
LoyaltyPointsSpent (optional)	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 (on the user’s My Account page).
LoyaltyPointsEarned (optional)	Decima	The number of loyalty points to be earned for this purchase by the 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.
LoyaltyCode (optional)	String	The loyalty code applicable to the Merchant’s site is entered by the customer in Global‑e checkout.
SameDayDispatch (optional)	Bool	Indicates if the customer has requested a “Same Day Dispatch” in the Global‑e checkout.
SameDayDispatchCost l (optional)	Decima	Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency.
DoNotChargeVAT (optional)	Bool	Indicates if the end customer has not 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.
IsFreeShipping (optional)	Bool	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.
FreeShippingCouponCode (optional)	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.
ShipToStoreCode (optional)	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).
CustomerComments (optional)	String	Comments text entered by the end customer in Global‑e checkout.
IsSplitOrder (optional)	Bool	Indicates if the order should be handled as split order (i.e. without consolidation).
OTVoucherCode (optional)	Bool	One-time voucher code used to place the order.
OTCurrencyCode (optional)	String	Currency of the one-time voucher code used to place the order.
OTVoucherAmount (optional)	Decimal	Amount taken off the voucher when applicable.
WebStoreCode (optional)	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.
Products	List	The list of products being purchased.
Discounts (optional)	List	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.
Markups (optional)	List	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 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.
Customer	Merchant.Customer	The paying customer’s preferences (Global-e acts as a paying customer).
PrimaryBilling	Merchant.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 customer details are indicated in the URL-encoded form. Therefore, if the `Customer.IsEndCustomerPrimary` is TRUE then all string attributes in `PrimaryBilling` are URL encoded.
PrimaryShipping	Merchant.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 customer’s details are indicated in URL encoded form. Therefore, if `Customer.IsEndCustomerPrimary` is TRUE then all string attributes in `PrimaryShipping` are URL encoded.
PaymentDetails	Merchant.PaymentDetails	The paying customer’s payment details.
SecondaryBilling	Merchant.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 customer’s details are indicated in URL encoded form. Therefore, if Customer.IsEndCustomerPrimary is FALSE then all string attributes in `SecondaryBilling` are URL encoded.
SecondaryShipping	Merchant.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 customer’s details are indicated in URL encoded form. Therefore, if Customer.IsEndCustomerPrimary is FALSE then all string attributes in `SecondaryShipping` are URL encoded.
InternationalDetails (optional)	Merchant.InternationalDetails	Details referring to the customer’s order placed on the Global‑e side. These details are applicable only to the Merchants dealing with international customers’ support themselves.
DiscountedShippingPrice	Decimal	The shipping price paid by the customer is converted to the merchant currency. Total Shipping price reducing Order Discounts (`InternationalDetails.DiscountedShippingPrice` price converted to the merchant currency).
PrePayOffered	Bool	Indicates if the prepayment option for duties and taxes was offered to the customer.
IsReplacementOrder	Bool	Indicates if the order is a replacement.
OriginalOrder (optional)	Merchant.OriginalOrder	Details referring to the original order if the current order is a replacement.
`DateCreated`	String	Optional, returned by `GetOrdersDetails` API only. Order creation date and time.
`CurrencyName`	String	Optional, returned by `GetOrdersDetails` API only. Customer currency name.
`Merchant.Parcel`	List Parcels	Optional, returned by `GetOrdersDetails` API only. The list of parcels created for the order.
`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.
`USSalesTax`	decimal	Sales tax value for USA in the Merchant currency. This value is included in `TotalDutiesAndTaxesPrice`.

Merchant.Product

string Sku

SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side).

decimal Price

Single product final sale price in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant.

decimal ListPrice

Single product List price in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant.

decimal VATRate

The VAT rate applied to this product

decimal PriceBeforeGlobalEDiscount - DEPRECATED

Single product price in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant, before applying any per-product Global‑e discounts (such as per-product Shipping discounts). If no Global‑e discount was applied, PriceBeforeGlobalEDiscount is equal to Price.

decimal LineItemPriceBeforeGlobalEDiscount (optional) - DEPRECATED

Line item (product in ordered quantity) price in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant, before applying any per-product Global‑e discounts (such as per-product Shipping discounts). If not specified, should be deemed equal to “PriceBeforeGlobalEDiscount * Quantity”. If specified, should take preference over PriceBeforeGlobalEDiscount.

decimal InternationalPrice (optional)

Single product final sale price in end customer currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable), and IncludeVAT handling.

decimal InternationalListPrice (optional)

Single product list price in end customer’s currency (specified in the InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable), and IncludeVAT handling.

decimal LineItemInternationalPrice (optional)

Line item (product in ordered quantity) price in end customer’s currency (specified in the InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable), and IncludeVAT handling. If not specified, should be deemed equal to “InternationalPrice * Quantity”. If specified, should take preference over InternationalPrice.

decimal RoundingRate

The conversion rate applied to this product price 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.

Int64 Quantity

Product quantity in the order that is currently being submitted to the Merchant.

string CartItemId (optional)

Identifier of the cart item on the Merchant’s site originally specified in the Product.CartItemId property of the respective product in the SendCart method for the cart converted to this order on Global‑e.

string ParentCartItemId (optional)

Identifier of the current item’s parent cart item on the Merchant’s site originally specified in the Product.ParentCartItemId property of the respective product in the SendCart method for the cart converted to this order on Global‑e.

string CartItemOptionId (optional)

Identifier of the child cart item “option” on the Merchant’s site originally specified in the Product.CartItemOptionId property of the respective product in the SendCart method for the cart converted to this order on Global‑e.

string HandlingCode (optional)

Code originally specified in Product.HandlingCode property of the respective product in the SendCart method for the cart converted to this order on Global‑e.

string GiftMessage (optional)

Text originally specified in the Product.GiftMessage property of the respective product in the SendCart method for the cart converted to this order on Global‑e.

bool IsBackOrdered (optional)

Boolean specifying if the product was ordered as a backed ordered item

string BackOrderDate (optional)

Estimated date for the backordered item to be in stock

decimal DiscountedPrice

The product value is in merchant currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value.

This value can be used as the pre-calculated value for the returned product’s refund.

decimal InternationalDiscountedPrice

The product value in customer currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value.

This value can be used as the pre-calculated value for the returned product’s refund.

Merchant.Brand Brand (optional)

Product’s brand

List<Merchant.Category> Categories (optional)

Product categories

List<Merchant.CartProductAttribute> Attributes (optional)

Custom attributes describe products that customers can personalize according to what the site offers.

Each Attribute holds a key to specify attribute name and Value properties.

string Name (optional, returned by GetOrdersDetails API only)

Name of the product

List<Merchant.ProductAttribute> ProductAttributes (optional, returned by GetOrdersDetails API only)

Product attributes

string GenericHSCode (optional)

Product’s HS code

decimal DiscountedPriceForCustoms

Product price in merchant currency reflects the price after Reverse D&T calculation.

decimal InternationalDiscountedPriceForCustoms

Product price in customer currency reflects the price after Reverse D&T calculation

DTBreakdown DTBreakdown (optional)

Optional. Contains the duties and taxes per item in merchant currency.

DTBreakdown InternationalDTBreakdown (optional)

Contains the duties and taxes per item in customer currency.

decimal CustomerVATRate

The customer VAT rate applied to this product

decimal InternationalDiscountedPriceInMerchantCurrency

Product Price in merchant currency

Merchant.Brand

string BrandCode

Brand code

string Name

Brand name

Merchant.Category

string CategoryCode

Category code

string Name

Category name

Merchant.ProductAttribute

string AttributeCode

Product custom attribute code originally specified in the respective Attribute in Attributes list in the SendCart method for the cart converted to this order on Global‑e.

string AttributeTypeCode

Product attribute type code originally specified in the respective Attribute in Attributes list in the SendCart method for the cart converted to this order on Global‑e.

Merchant.Discount

string Name

Discount name

decimal Price

Discount value in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant.

decimal VATRate

The VAT rate applied to this discount

decimal LocalVATRate (optional)

The VAT rate that would be applied to this discount if the order was placed by the local customer. This value must be specified if UseCountryVAT for the current Country is TRUE and therefore the VATRate property denotes the VAT for the target country.

decimal InternationalPrice (optional)

Discount value in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, and IncludeVAT handling.

string Name

Discount name

string Description (optional)

Discount textual description

string CouponCode (optional)

Merchant CouponCode used for this discount (applicable to coupon-based discounts only)

string ProductCartItemId (optional)

Identifier of the product cart item related to this discount on the Merchant’s site originally specified in the Discount.ProductCartItemId property of the respective discount in the SendCart method for the cart converted to this order on Global‑e.

string DiscountCode (optional)

Discount code originally specified in the Discount.DiscountCode property of the respective discount in SendCart method for the cart converted to this order on Global‑e.

string LoyaltyVoucherCode (optional)

Loyalty Voucher code originally specified in Discount.LoyaltyVoucherCode property of the respective discount in SendCart method for the cart converted to this order on Global‑e.

Int64 DiscountType

Discount type (“Cart”, “Shipping”, etc.), as defined in the DiscountTypeOptions enumeration described in the Discount class in this document.

optional values DiscountSource (required)

Values:

1	Merchant
2	FixedShippingPrice
3	PercentageCartPrice
4	HiddenForceDDP
5	Amend
6	RemoteAreaSurchargeSubsidy
7	LoyaltyPoints
8	PaymentCharge
9	ReplacementOrder

Merchant.Customer

bool SendConfirmation

Indicates if e-mail confirmation of the respective order’s status change needs to be sent to the paying customer (Global‑e acts as a paying customer).

bool IsEndCustomerPrimary

Indicates if end customer details are “swapped” with a paying (Global‑e) customer’s details when submitting the order to the Merchant. By default, IsEndCustomerPrimary is FALSE which means that the primary customer denotes the paying (Global‑e) customer and the secondary customer denotes the end customer who has placed the order with Global‑e checkout.

Merchant.CustomerDetails

string FirstName (optional)

First name

string LastName(optional)

Last name

string FirstNameInLocalCulture (optional)

First name in local culture

string LastNameInLocalCulture (optional)

Last name in local culture

string MiddleName (optional)

Middle name

string Salutation (optional)

Salutation or title (e.g. Dr., Mr., etc.)

string Phone1 (optional)

Phone #1

string Phone2 (optional)

Phone #2

string Fax (optional)

Fax

string Email (optional)

Email address

string Company (optional)

Company name

string Address1 (optional)

Address line 1

string Address2 (optional)

Address line 2

string City (optional)

City name

string StateOrProvice (optional)

State or province name

string StateCode (optional)

State or province ISO code such as AZ for Arizona (if applicable)

string Zip (optional)

Zip or postal code

string CountryCode (optional)

2-char ISO country code

string CountryName (optional)

Country name

string AddressBookId (optional)

Id of the current address from within the address book

string AddressBookName (optional)

Name of the current address from within the address book

bool SaveAddress (optional)

Indicates that the current address should be saved in the merchant platform

Merchant.PaymentDetails

string OwnerFirstName (optional if OwnerName is specified)

Card owner’s first name

string OwnerLastName (optional if OwnerName is specified)

Card owner’s last name

string OwnerName (optional)

Card owner’s full name (the Merchant may choose to consider either full name or first name with the last name, according to the existing payment method input validation requirements).

string CardNumber

Card number

string CVVNumber

Card CVV number

string PaymentMethodName

Payment method name

string PaymentMethodCode

Payment method code used to identify the payment method on the Merchant’s site (to be mapped on the Global‑e side).

string PaymentMethodTypeCode

Payment method type’s code used to identify the payment method type (such as Credit Card or Check) on the Merchant’s site (to be mapped on the Global‑e side).

string ExpirationDate

Card expiration date (in YYYY-MM-DD format)

string CountryName

Country name

string CountryCode

2-char ISO country code

string StateCode (optional)

State or province ISO code such as AZ for Arizona (if applicable)

string StateOrProvice (optional)

State or province name

string City (optional)

City name

string Zip (optional)

Zip or postal code

string Address1 (optional)

Address line 1

string Address2 (optional)

Address line 2

string Phone1 (optional)

Phone #1

string Phone2 (optional)

Phone #2

string Fax (optional)

Fax

string Email (optional)

E-mail address

Merchant.InternationalDetails

string CurrencyCode

3-char ISO code for the currency selected by the end customer for the order payment.

decimal TotalPrice

Total order price in the currency denoted by CurrencyCode.

string TransactionCurrencyCode

3-char ISO code for the currency actually used for the current order payment. TransactionCurrencyCode may differ from CurrencyCode if the currency selected by the end customer could not be used with the selected payment method.

decimal TransactionTotalPrice

Total order price actually paid by the end customer in the currency denoted by TransactionCurrencyCode.

decimal TotalShippingPrice

Total shipping price in the currency denoted by CurrencyCode.

decimal ConsignmentFee (optional)

The consignment fee is paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.

decimal SizeOverchargeValue (optional)

Oversized items charge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.

decimal RemoteAreaSurcharge (optional)

Remote area surcharge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.

decimal SameDayDispatchCost (optional)

Cost of the “Same Day Dispatch” option (if selected by the end customer on Global‑e checkout), in the currency denoted by CurrencyCode. This value is NOT included in TotalShippingPrice.

decimal TotalDutiesPrice

Total Duties & Taxes value including Customs Clearance Fees, in the currency denoted by CurrencyCode.

decimal USSalesTax

Sales tax value for the USA in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice.

decimal TotalCCFPrice(optional)

Total Customs Clearance Fees value in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice.

string ShippingMethodCode

Code denoting the selected international shipping method as defined on the Merchant’s site (to be mapped on the Global‑e side). If this international shipping method doesn’t exist on the Merchant’s site, the internal Global‑e shipping method code will be specified instead.

string ShippingMethodName

Name of the selected international shipping method.

string ShippingMethodTypeCode

Code denoting the selected international shipping method type as defined on the Merchant’s site (to be mapped on the Global‑e side). If this international shipping method type does not exist on the Merchant’s site, the internal Global‑e shipping method type code will be specified instead.

string ShippingMethodTypeName

Name of the selected international shipping method type.

Int64 DeliveryDaysFrom (optional)

The minimum number of days for delivery to the end customer for the selected shipping method.

Int64 DeliveryDaysTo (optional)

The maximum number of days for delivery to the end customer for the selected shipping method.

string PaymentMethodCode

Code denoting the selected payment method as defined on the Merchant’s site (to be mapped on the Global‑e side). If this payment method doesn’t exist on the Merchant’s site, the internal Global‑e payment method code will be specified instead.

string PaymentMethodName

Name of the selected payment method.

bool DutiesGuaranteed

Indicates if the end customer has selected the “guaranteed duties and taxes” option.

string OrderTrackingNumber (optional)

Tracking number used by the selected international shipping method for this order.

string OrderTrackingUrl (optional)

Full tracking URL including OrderTrackingNumber used by the selected international shipping method for this order.

string OrderWaybillNumber (optional)

Waybill number used by the selected international shipping method for this order.

string ShippingMethodStatusCode (optional)

Code denoting the selected shipping status as defined on the Merchant’s site (to be mapped on the Global‑e side). If this shipping status doesn’t exist on the Merchant’s site, the internal Global‑e shipping status code will be specified instead.

string ShippingMethodStatusName (optional)

Name of the shipping status.

decimal DiscountedShippingPrice

The price paid by the customer in local currency. Total Shipping price reducing Order Discounts International price.

List<Merchant.ParcelTracking> ParcelsTracking

List of Merchant.ParcelTracking objects, each object holds the parcel tracking number and full tracking URL for the relevant shipper (with the parcel tracking number).

string CardNumberLastFourDigits (optional)

The last 4 digits of the Card number (if applicable).

string ExpirationDate (optional)

Card expiration date in YYYY-MM-DD format (if applicable).

decimal CashOnDeliveryFee (optional)

The additional charge is paid by the end customer when the “Cash on Delivery” payment method has been selected.

decimal TotalVATAmount

Amount of VAT paid by the customer to Global‑e

DTBreakdown CustomerDTBreakdown (optional)

Contains the duties and taxes parts the customer paid for the order in the currency denoted by CurrencyCode.

DTBreakdown MerchantDTBreakdown (optional)

Contains the duties and taxes parts the merchant subsidized for the order in the currency denoted by CurrencyCode.

decimal ShippingVATRate

The shipping VAT rate for the customer. This rate is applied to the shipping cost.

Merchant.OriginalOrder

string OrderId

Global‑e order unique identifier for the original order.

string MerchantOrderId (optional)

OrderId returned from SendOrderToMerchant call for the original order.

string MerchantInternalOrderId (optional)

InternalOrderId returned from SendOrderToMerchant call for the original order.

Merchant.OrderTracking

string ShippingMethodCode

Code denoting the selected international shipping method as defined on the Merchant’s site (to be mapped on the Global‑e side). If this international shipping method does not exist on the Merchant’s site, the internal Global‑e shipping method code will be specified instead.

string ShippingMethodName

Name of the selected international shipping method.

string ShippingMethodStatusCode

Code denoting the selected shipping status as defined on the Merchant’s site (to be mapped on the Global‑e side). If this shipping status does not exist on the Merchant’s site, the internal Global‑e shipping status code will be specified instead.

string ShippingMethodStatusName

Name of the shipping status.

string ShipmentStatusUpdateTime

Date and time of the shipment status update. The date is in the UTC time zone specified in RFC 2822 format (i.e. Fri, 8 Aug 2014 17:13:07 +0000).

string ShipmentLocation

Last known location of the shipment.

Merchant.ParcelTracking

string ParcelTrackingNumber

The tracking number is used by the selected international shipping method for this parcel.

string ParcelTrackingUrl

Full tracking URL including ParcelTrackingNumber used by the selected international shipping method for this parcel.

string ParcelCode

Parcel code.

Merchant.Parcel

string Code

Parcel code.

Int64 ParcelStatusId

Parcel status id.

string StatusName

Parcel status name.

string TrackingUrl

Direct tracking URL.

List<Merchant.ParcelProduct> Products (optional)

List of products included in the parcel.

Merchant.ParcelProduct

string Sku

Product SKU.

string CartItemId

Cart item id of the product.

Int64 Quantity

Product quantity included in the parcel.

Merchant.ImporterDetails

string Name

First and Last name

string Address1 (optional)

Address line 1

string Address2 (optional)

Address line 2

string City (optional)

City name

string StateOrProvince (optional)

State or province name

string StateCode (optional)

State or province ISO code such as AZ for Arizona (if applicable)

string Zip (optional)

Zip or postal code

string CountryCode (optional)

2-char ISO country code

string Country (optional)

Country name

Merchant.ExporterDetails

string VATRegistrationNumber (optional)

Global‑e Exporter entity registration VAT number

string EORINumber (optional)

Global‑e Exporter entity registration EORI number

string IOSSNumber (optional)

Global‑e Exporter entity IOSS number (for shipments to the EU)

Merchant.ImporterAddress

string Company (optional)

Either the Customer Company name, if provided in the cart/checkout, or the Global‑e importer entity name for the relevant markets (eg. Switzerland)

string VATRegistrationNumber (optional)

Either. the Customer VAT Registration Number, if provided in the cart/checkout, or the Global‑e importer entity registration number for relevant markets (eg. Switzerland)

string CustomerTaxId (optional)

The Customer tax number is provided at checkout, as required for clearance into certain markets (e.g. Brazil, Turkey).

int ImporterType

Importer type, depending on the order type and destination:

- 0: Private importer – standard B2C shipment

- 1: Global‑e Importer – specific importer mentions required

Merchant.ImporterAddress Address (optional)

Full address of the importer as the Private/Business Importer (customer) or the Global‑e Importer entity, if relevant.

[Example Merchant.Order object

[
    {
        
        "DateCreated": "2021-06-22T19:21:55",
        
        "CurrencyName": "Norwegian Krone",
        "Parcels": [],
        "AllowMailsFromMerchant": false,
        
        "AllowDirectCommunicationFromMerchant": false,
        "TnCConsent": null,
        
        "ClearCart": true,
        "UserId": null,
        "CurrencyCode": "GBP",
        "Products": [
            {
                
                "Attributes": [
                    {
                        
                        "AttributeKey": "Size",
                        "AttributeValue": "29"
                        
                    },
                    {
                        
                        "AttributeKey": "Color",
                        "AttributeValue": "Blue"
                        
                    }
                    
                ],
                
                "Name": "Echo Fit Compression Short",
                "ProductAttributes": [
                    {
                        
                        "AttributeCode": "Size",
                        "Name": "29",
                        
                        "AttributeTypeCode": "size"
                        
                    },
                    {
                        
                        "AttributeCode": "Color",
                        "Name": "Blue",
                        "AttributeTypeCode": "color"
                        
                    }
                    
                ],
                
                "Sku": "WSH07-29-Blue",
                "Price": 29.4200,
                
                "PriceBeforeRoundingRate": 29.4200,
                
                "PriceBeforeGlobalEDiscount": 29.4200,
                
                "Quantity": 1,
                
                "VATRate": 21.000000,
                
                "CustomerVATRate": 0.0,
                
                "InternationalPrice": 299.0000,
                
                "InternationalDiscountedPriceInMerchantCurrency": 25.03,
                
                "CartItemId": "1057",
                "ParentCartItemId": null,
                "CartItemOptionId": null,
                "HandlingCode": "",
                
                "GiftMessage": "",
                
                "RoundingRate": 0.098394648829431438127090301,
                
                "IsBackOrdered": false,
                "BackOrderDate": null,
                "DiscountedPrice": 29.42,
                
                "InternationalDiscountedPrice": 299.0000,
                "ProductCodeSecondary": null,
                
                "Brand": null,
                "Categories": null,
                "ListPrice": 29.80,
                
                "InternationalListPrice": 299.00,
                
                "GenericHSCode": "620442",
                
                "DiscountedPriceForCustoms": 18.18,
                
                "InternationalDiscountedPriceForCustoms": 217.14,
                "IsGiftCard": false,
                
                "IsFixedPrice": false
                
            },
            {
                
                "Attributes": [
                    {
                        
                        "AttributeKey": "Size",
                        "AttributeValue": "29"
                        
                    },
                    {
                        
                        "AttributeKey": "Color",
                        "AttributeValue": "Black"
                        
                    }
                    
                ],
                
                "Name": "Echo Fit Compression Short",
                "ProductAttributes": [
                    {
                        
                        "AttributeCode": "Size",
                        "Name": "29",
                        
                        "AttributeTypeCode": "size"
                        
                    },
                    {
                        
                        "AttributeCode": "Color",
                        
                        "Name": "Black",
                        "AttributeTypeCode": "color"
                        
                    }
                    
                ],
                
                "Sku": "WSH07-29-Black",
                "Price": 29.4200,
                
                "PriceBeforeRoundingRate": 29.4200,
                
                "PriceBeforeGlobalEDiscount": 29.4200,
                
                "Quantity": 1,
                
                "VATRate": 21.000000,
                
                "CustomerVATRate": 0.0,
                
                "InternationalPrice": 299.0000,
                
                "InternationalDiscountedPriceInMerchantCurrency": 25.03,
                
                "CartItemId": "1059",
                "ParentCartItemId": null,
                "CartItemOptionId": null,
                "HandlingCode": "",
                
                "GiftMessage": "",
                
                "RoundingRate": 0.098394648829431438127090301,
                
                "IsBackOrdered": false,
                "BackOrderDate": null,
                "DiscountedPrice": 29.42,
                
                "InternationalDiscountedPrice": 299.0000,
                "ProductCodeSecondary": null,
                
                "Brand": null,
                "Categories": null,
                "ListPrice": 29.80,
                
                "InternationalListPrice": 299.00,
                
                "GenericHSCode": "620442",
                
                "DiscountedPriceForCustoms": 18.18,
                
                "InternationalDiscountedPriceForCustoms": 217.14,
                "IsGiftCard": false,
                
                "IsFixedPrice": false
                
            }
            
        ],
        
        "Customer": {
            
            "EmailAddress": "ema ([email protected])[email protected]"(ema.hub @ norsk - global.com),
            "IsEndCustomerPrimary": true,
            "SendConfirmation": false
            
        },
        
        "PrimaryShipping": {
            "FirstName": "a",
            
            "LastName": "Norse",
            "MiddleName": null,
            "Salutation": null,
            
            "Company": "",
            
            "Address1": "Thomas+Heftyes+Gate+8",
            "Address2": "",
            
            "City": "Oslo",
            "StateCode": null,
            "StateOrProvince": null,
            "Zip": "0264",
            
            "Email": "benoitglobale%40gmail.com",
            "Phone1": "0000000000",
            
            "Phone2": "",
            
            "Fax": "",
            
            "CountryCode": "NO",
            "CountryCode3": "NOR",
            "CountryName": "Norway",
            "AddressBookId": "",
            "AddressBookName": "",
            "SaveAddress": false
            
        },
        
        "SecondaryShipping": {
            "FirstName": "GlobalE",
            "LastName": "GE-UK@EMA-Norsk",
            "MiddleName": null,
            "Salutation": null,
            "Company": "",
            
            "Address1": "Building 436, Argosy Road",
            "Address2": "East Midlands Airport",
            "City": "Derby",
            
            "StateCode": "NN",
            "StateOrProvince": null,
            "Zip": "DE74 2SA",
            
            "Email": "ema.hub@nors ([email protected])k-global.com ([email protected])",
            "Phone1": "01332 818723",
            
            "Phone2": null,
            "Fax": null,
            "CountryCode": "GB",
            "CountryCode3": "GBR",
            
            "CountryName": "United Kingdom",
            "AddressBookId": null,
            "AddressBookName": null,
            "SaveAddress": false
            
        },
        
        "ShippingMethodCode": "globale_standard",
        "Discounts": [
            {
                
                "Name": "Hidden DDP",
                
                "Description": "Discount generated to discount the DDP",
                "Price": 13.7000,
                
                "DiscountType": 4,
                
                "VATRate": 0.000000,
                
                "LocalVATRate": 20.000000,
                
                "CouponCode": null,
                "InternationalPrice": 163.7200,
                "DiscountCode": "",
                "ProductCartItemId": null,
                "LoyaltyVoucherCode": null
                
            }
            
        ],
        
        "Markups": [],
        "LoyaltyPointsSpent": 0.00,
        
        "LoyaltyPointsEarned": 0.00,
        "SameDayDispatch": false,
        "SameDayDispatchCost": 0.0000,
        "DoNotChargeVAT": false,
        "CustomerComments": "",
        "IsFreeShipping": false,
        "FreeShippingCouponCode": "",
        "ShipToStoreCode": null,
        "RoundingRate": 0.098395,
        "UrlParameters": null,
        
        "OriginalMerchantTotalProductsDiscountedPrice": 48.0000,
        "LoyaltyCode": null,
        
        "OTVoucherCode": null,
        "OTVoucherAmount": null,
        "OTVoucherCurrencyCode": null,
        "IsSplitOrder": false,
        "PrePayOffered": false,
        "InitialCheckoutCultureCode": "en-GB",
        "CultureCode": "en-GB",
        
        "HubId": 9,
        "IsReplacementOrder": false,
        "OriginalOrder": null,
        "ReservationRequestId": null,
        
        "IsSuppressPersonalInformation": false,
        "TotalDutiesAndTaxesPrice": 13.70,
        
        "USSalesTax": 0.0,
        
        "CCFPrice": 0.0,
        
        "ExporterDetails": {
            "VATRegistrationNumber": "177 9006 80",
            "EORINumber": "GB177900680000",
            
            "IOSSNumber": null
            
        },
        
        "ImporterDetails": {
            "Company": "",
            
            "VATRegistrationNumber": "",
            "CustomerTaxId": null,
            "ImporterType": 0,
            "Address": {
                
                "Name": "aNorse",
                
                "Address1": "Thomas Heftyes Gate 8",
                "Address2": null,
                
                "City": "Oslo",
                "StateCode": null,
                "StateOrProvince": null,
                "Zip": "0264",
                
                "CountryCode": "NO",
                "Country": "Norway"
                
            }
            
        },
        
        "OrderPaymentMethods": [
            {
                
                "PaymentMethodId": 4,
                "PaymentMethodName": "PayPal",
                "IsGiftCard": false,
                "GiftCardFields": null,
                
                "PaidAmountInCustomerCurrency": 818.6500,
                
                "PaidAmountInMerchantCurrency": 66.561441871842850568731315078
                
            }
            
        ],
        
        "OrderDocuments": [
            {
                
                "URL": "https://connect2.bglobale.com/Document/CustomerReceiptInvoice?doc umentParam=iI9FwInOzaNSAGbwFqpq9fk9h5rPztV4mOl0n0zpjANzhF1B4vyc6S0jKAoM8i36TYkWb9pqyg3v5p 3nuU67HEVxYN7syga9o0X35Jo%2fuGLixEK3SZASyGGeN%2f2GRGp96fgyZ9HaSjMOYHmY%2fS4b0Y8qjMxlCUbpY dXOaDk2yR%2bqkShiQppeFFcnUAKHsgOj99glFZY%2fAGsskCQ0moPTDQ%3d%3d",
                
                "DocumentTypeCode": "8",
                
                "DocumentTypeName": "CustomerReceiptInvoice",
                "DocumentExtension": "pdf",
                
                "ErrorMessage": null
                
            }
            
        ],
        
        "PaymentDetails": null,
        "PrimaryBilling": {
            
            "FirstName": null,
            "LastName": null,
            "MiddleName": null,
            
            "Salutation": null,
            "Company": null,
            "Address1": null,
            "Address2": null,
            "City": null,
            "StateCode": null,
            "StateOrProvince": null,
            "Zip": null,
            
            "Email": null,
            "Phone1": null,
            "Phone2": null,
            "Fax": null,
            "CountryCode": null,
            "CountryCode3": null,
            "CountryName": null,
            "AddressBookId": null,
            
            "AddressBookName": null,
            "SaveAddress": false
            
        },
        
        "SecondaryBilling": {
            "FirstName": null,
            "LastName": null,
            "MiddleName": null,
            "Salutation": null,
            "Company": null,
            "Address1": null,
            "Address2": null,
            "City": null,
            "StateCode": null,
            "StateOrProvince": null,
            "Zip": null,
            
            "Email": null,
            "Phone1": null,
            "Phone2": null,
            "Fax": null,
            "CountryCode": null,
            "CountryCode3": null,
            "CountryName": null,
            "AddressBookId": null,
            
            "AddressBookName": null,
            "SaveAddress": false
            
        },
        
        "OrderId": "GE10022220518GB",
        
        "StatusCode": "N/A",
        
        "MerchantGUID": "58f2fe53-4f78-4532-923a-41c4db6183e2",
        
        "CartId": "593",
        
        "MerchantOrderId": null,
        "PriceCoefficientRate": 1.000000,
        
        "CartHash": "ccefa725562c42639c2d4cf98b1c4819",
        "WebStoreCode": "en_gb",
        "WebStoreInstanceCode": "m2qa02.bglobale.de",
        "DiscountedShippingPrice": 17.94,
        "InternationalDetails": {
            
            "CurrencyCode": "NOK",
            "TotalPrice": 818.65,
            "TransactionCurrencyCode": "NOK",
            "TransactionTotalPrice": 818.6500,
            
            "TotalShippingPrice": 220.6500,
            
            "SameDayDispatchCost": 0.0000,
            
            "TotalCCFPrice": 0.0000,
            
            "TotalDutiesPrice": 0.000000000,
            
            "USSalesTax": 0.0,
            
            "ShippingMethodCode": "827",
            "ShippingMethodName": "DHL Express Worldwide",
            "PaymentMethodCode": "4",
            "PaymentMethodName": "PayPal",
            "CardNumberLastFourDigits": null,
            "ExpirationDate": null,
            
            "DutiesGuaranteed": false,
            "OrderTrackingNumber": null,
            
            "OrderTrackingUrl": "https%3a%2f%2fwww2.bglobale.com%2fOrder%2fTrack%2fmZ7R%3 fOrderId%3dGE10022220518GB%26ShippingEmail%3dbenoitglobale%40gmail.com",
            
            "OrderWaybillNumber": null,
            "ShippingMethodTypeCode": "Express",
            "ShippingMethodTypeName": "Express Courier (Air)",
            "DeliveryDaysFrom": 2,
            
            "DeliveryDaysTo": 2,
            
            "ConsignmentFee": 0.0000,
            
            "SizeOverchargeValue": 0.0000,
            
            "RemoteAreaSurcharge": 0.0000,
            
            "DiscountedShippingPrice": 220.6500,
            
            "CashOnDeliveryFee": 0.0,
            "ParcelsTracking": [],
            "TotalVATAmount": 0.00,
            
            "ShippingVATRate": 0.0000,
            "ShippingMethodStatusCode": "Undefined",
            "ShippingMethodStatusName": "undefined",
            "ShipmentStatusUpdateTime": null,
            "ShipmentLocation": null
           },
       },
        "GiftCards": null,
        "DeclarativeShippingPriceInCustomerCurrency": 5.00,
        "TotalValueForCustoms": 65.35,
        "TaxCalculationRule": "CIF"
        }
]

Documentation Portal

GetOrdersDetails API

Note

Prerequisites

GetOrdersDetails (OrdersDetailsFilter filter)

Classes

ErrorInfo

Merchant.OrderV2

Merchant.Order

Merchant.Product

Merchant.Brand

Merchant.Category

Merchant.ProductAttribute

Merchant.Discount

Merchant.Customer

Merchant.CustomerDetails

Merchant.PaymentDetails

Merchant.InternationalDetails

Merchant.OriginalOrder

Merchant.OrderTracking

Merchant.ParcelTracking

Merchant.Parcel

Merchant.ParcelProduct

Merchant.ImporterDetails

Merchant.ExporterDetails

Merchant.ImporterAddress

[Example Merchant.Order object