Documentation Portal

CardNumberLastFourDigits

String

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

No

CurrencyCode

String

3-char ISO currency code.

Yes

DutiesGuaranteed

Boolean

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

Yes

ExpirationDate

String

The card expiration date, in YYYY-MM-DD format (if applicable).

No

OrderTrackingNumber

String

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

Max length: 50 chars.

No

OrderTrackingUrl

String

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

Max length: 255 chars.

No

OrderWaybillNumber

String

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

No

OrderWaybillUrl

String

The Waybill URL used by the selected international shipping API for this order.

Max length: 255 chars.

PaymentAPICode

String

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

Max length: 50 chars.

Yes

PaymentAPIName

String

Name of the selected payment API.

Max length: 50 chars.

Yes

PaymentTransactionGUID

String

Unique identifier for payment transaction.

Yes

PaymentTransactionReference

String

Reference identifier for payment transaction.

Yes

ShippingAPICode

String

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

Max length: 50 chars.

Yes

ShippingAPIName

String

Name of the selected international shipping API.

Max length: 50 chars.

Yes

TotalDutiesPrice

Decimal

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

Yes

TotalPrice

Decimal

The total order price in the currency indicated in CurrencyCode.

Yes

TotalShippingPrice

Decimal

Total shipping price in the currency denoted by CurrencyCode.

Yes

TotalVATAmount

Decimal

Amount of VAT paid by the customer to Global-e

Yes

TransactionCurrencyCode

String

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

Yes

TransactionTotalPrice

Decimal

The total order price paid by the end--customer in the currency denoted by TransactionCurrencyCode.

Yes

ShippingAPIStatusCode

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.

Max length: 100 chars.

No

ShippingAPIStatusName

String

Name of the shipping status.

Max length: 50 chars.

No