Documentation Portal

CardNumberLastFourDigits

String

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

No

CashOnDeliveryFee

Decimal

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

No

ConsignmentFee

Decimal

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

No

CurrencyCode

String

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

CustomerDTBreakdown

Object DTBreakdown

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

No

DeliveryDaysFrom

Decimal

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

No

DeliveryDaysTo

Decimal

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

No

DiscountedShippingPrice

Decimal

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

DutiesGuaranteed

Bool

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

ExpirationDate

string

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

No

MerchantDTBreakdown

Object DTBreakdown

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

No

OrderTrackingNumber

String

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

No

OrderTrackingUrl

String

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

No

OrderWaybillNumber

String

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

No

ParcelsTracking

List of Merchant.ParcelTracking

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).

PaymentMethodCode

String

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.

PaymentMethodName

String

Name of the selected payment method.

RemoteAreaSurcharge

Decimal

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

No

SameDayDispatchCost

Decimal

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.

No

ShippingMethodCode

String

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.

ShippingMethodName

String

Name of the selected international shipping method.

ShippingMethodStatusCode

String

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.

No

ShippingMethodStatusName

String

Name of the shipping status.

No

ShippingMethodTypeCode

String

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.

ShippingMethodTypeName

String

Name of the selected international shipping method type.

ShippingVATRate

Decimal

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

SizeOverchargeValue

Decimal

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

No

TotalCCFPrice

Decimal

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

No

TotalDutiesPrice

Decimal

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

TotalPrice

Decimal

Total order price in the currency denoted by CurrencyCode.

TotalShippingPrice

Decimal

Total shipping price in the currency denoted by CurrencyCode.

TotalVATAmount

Decimal

Amount of VAT paid by the customer to Global‑e

TransactionCurrencyCode

String

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.

TransactionTotalPrice

Decimal

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

USSalesTax

Decimal

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