Documentation Portal

Address1

String

Address line 1.

N

Address2

String

Address line 2.

N

AddressBookId

String

Id of the current address from within the address book

N

AddressBookName

String

Name of the current address from within the address book

N

City

String

City name.

N

Company

String

Company name

N

CountryCode

String

2-char ISO country code

N

Email

String

E-mail address

N

Fax

String

Fax

N

FirstName

String

First name

N

FirstNameInLocalCulture

String

First name in local culture

N

IsBilling

Bool

Indicates that the current address can be used as a billing address

N

IsDefaultBilling

Bool

Indicates that the current address is the default billing address

N

IsDefaultShipping

Bool

Indicates that the current address is the default shipping address

N

IsShipping

Bool

Indicates that the current address can be used as a shipping address

N

LastName

String

Last name

N

LastNameInLocalCulture

String

Last name in local culture

N

MiddleName

String

Middle name

N

Phone1

String

Phone #1

N

Phone2

String

Phone #2

N

Salutation

String

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

N

StateCode

String

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

N

StateOrProvince

String

State or province name

N

UserIdNumber

String

User’s personal ID document number

N

UserIdNumberType

Class UserIdNumberType

User’s personal ID document type (e.g. Passport, ID card, etc.)

N

Zip

String

Zip or postal code

N

PaymentActionMethod

String

The method (SEN/POST/Redirect) that should be used for PaymentActionURL

PaymentActionParameters

Dictionary <string, string>

The parameters that should be provided with the PaymentActionURL

PaymentActionURL

String

The URL to the alternative payment gateway. The gateway will provide the GUI for the payment

ResponseURL

String

The response may be optionally called after completing an alternative payment to retrieve details about the newly created order

Value

String

Application setting value

ClientSettings

Dictionary <string, AppSetting>

Dictionary of client-side settings

ServerSettings

Dictionary <string, AppSetting>

Dictionary of server-side settings

Value

String

Version identifier of Global-e API

WebClientVersion

String

Version identifier of Global-e client-side (JS) code

AttributeCode

String

Custom attribute code denoting a Merchant-specific attribute such as size, color, etc. (to be mapped on the Global‑e side)

AttributeTypeCode

String

Code used to identify the attribute type on the Merchant’s site such as “size” for size, “color” for "colour", etc. (to be mapped on the Global‑e side)

Name

String

Attribute name

BrandCode

String

Brand code on the Merchant’s site (to be mapped on the Global‑e side)

Name

String

Brand name

CultureCode

String

ISO culture code. If specified, the textual properties will be returned in the requested culture’s language if available. Texts in English will be returned by default

N

InputDataCultureCode

String

ISO culture code. Denotes the culture for the products’ textual properties being saved (e.g. Description). If not specified, the Merchant’s default culture will be assumed by default

N

PreferedCultureCode

String

ISO culture code. Denotes the preferred culture for the checkout page. If not specified, the Merchant’s default culture will be used by default

N

currencyCode

String

3-char ISO currency code denoting the end customer’s currency. If not specified, the Merchant’s default currency will be assumed by default

N

originalCurrencyCode

String

3-char ISO currency code denoting the original currency on the Merchant’s site (before applying country coefficient and FX conversion). If not specified, the Merchant’s default currency will be assumed by default

N

FreeShippingCouponCode

String

Merchant’s free shipping CouponCode applied by the end customer

N

IsFreeShipping

Bool

Indicates if the Merchant offers free international shipping to the end customer.

TRUE - Free international shipping is offered.

FALSE - Free international shipping is not offered.

N

CartToken

String

Cart token for the cart generated on Global‑e side by SendCart method (further on to be passed by the Merchant’s site to Global‑e checkout widget or to API checkout methods)

LoyaltyCode

String

Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout

N

LoyaltyPointsEarned

Decimal

The number of loyalty points to be earned for this purchase by the end 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.

N

LoyaltyPointsSpent

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 (i.e. on the end user’s My Account page).

N

LoyaltyPointsTotal

Decimal

The total number of loyalty points currently available in the end customer’s user account on the Merchant’s site.

N

OTVoucherAmount

String

Amount of the one-time voucher in OTVoucherCurrencyCode currency

N

OTVoucherCode

Decimal

One-time voucher code for the cart (for applicable platforms)

N

OTVoucherCurrencyCode

Decimal

One-time voucher currency used for the amount

N

IncludeVAT

Decimal

The IncludeVAT value returned from the CountryCoefficients method

Mandatory for merchants supporting browsing integration

priceCoefficientRate

Decimal

The rate returned from the CountryCoefficients method

Mandatory for merchants supporting browsing integration

RoundingRuleId

Decimal

The RoundingRuleId value returned from the RoundingRules method

Mandatory for merchants supporting browsing integration

AddressDetails

List<AddressDetails>

All available addresses are taken from the registered customer address book

N

UserId

String

Internal User identifier on the Merchant’s site

N

DoNotChargeVAT

Bool

Indicates if the end customer must not be charged VAT.

TRUE - Set to TRUE for registered users who have validated their business entity’s VAT Registration Number with the merchant and are therefore VAT exempted. Customer is not charged VAT.

FALSE - Customer is charged VAT.

N

VatRegistrationNumber

String

VAT Registration Number of the end customer’s business entity validated with the merchant

N

LoyaltyVouchers

List<LoyaltyVoucher>

List of available loyalty vouchers for the registered customer

N

OTVoucher

Class CartOTVoucherData

One-time voucher information

N

CategoryCode

String

Category code on the Merchant site (to be mapped on the Global‑e side)

Name

String

Category name

ChallengeURL

String

The URL for the challenge request to the gateway

GatewayTyp

Enum PaymentSecureGatewayTypes

Specifies the gateway API type,

One of the following possible values of the PaymentSecureGatewayTypes enumeration denoting a type of payment gateway:

MD

String

Another parameter that to be sent with the ChallengeURL. That data will be returned by the gateway with the request to TermURL

PaReq

String

The payment request string is one of the parameters to be sent with the ChallengeURL

ResponseData

String

The data that should be passed with the request to ResponseURL

ResponseURL

String

The URL that should be called by the client with the POST request to finalize the SendOrder flow.

TermURL

String

Another parameter that to be sent with the ChallengeURL. This is the server-side URL that will be called on the response of the gateway to provide the 3DS authorization result

Address1

String

Address line 1

Y

Address2

String

Address line 2

N

City

String

City name

Y

CountryCode

String

2-char ISO country code

Y

StateCode

String

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

N

Zip

String

2-char ISO country code

Y

CardNumber

String

Card number

Y

CVVNumber

String

Card CVV number

Y

ExpirationDate

String

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

Y

OwnerName

String

Card owner’s full name

N

allowMailsFromMerchant

Bool

Indicates if the end customer’s consent to receive emails from merchants should be pre-selected in the Global‑e Checkout.

TRUE - Customer consents to receive emails.

FALSE - Customer does not consent to receive emails.

N

billingDetails

Class UserDetails

Billing details of a registered user (if available on the Merchant’s site). If the userDetails property mentioned below is specified, then billingDetails will be ignored.

N

clientIP

String

The end customer’s IP address

N

CountryCode

String

2-char ISO country code of the shipping country either pre-defined using geo-location or actively selected by the end customer. This may be different from shippingDetails.CountryCode denoting the registered user’s country.

N

cultureCode

String

ISO culture code. If specified, the textual properties will be returned in the requested culture’s language if available. Texts in English will be returned by default.

N

currencyCode

String

3-char ISO currency code denoting the end customer’s currency. If not specified, the Merchant’s default currency will be assumed by default.

N

discountList

List<Discounts>

List of JSON-serialized Discounts to be applied to the cart. Discounts of any type (“cart”, “shipping”, etc.) may be specified.

N

doNotChargeVAT

Bool

Indicates if the end customer must not be charged VAT. This is usually set to TRUE for registered users who have validated their business entity’s VAT Registration Number with the merchant and are therefore VAT exempted.

N

freeShippingCouponCode

nvarchar

Merchant’s free shipping coupon code applied by the end customer.

Max length: 50.

N

co

Decimal

Identifier of the Global‑e’s Local Hub previously returned by API. If not specified, the default Merchant’s Hub will be used instead.

N

IncludeVAT

Decimal

Optional for the merchants not supporting browsing integration. The value is returned from CountryCoefficients API.

N

isFreeShipping

Bool

Indicates if the Merchant offers free international shipping to the end customer.

N

loyaltyCode

String

The loyalty code specified by the end customer (or read from the end customer’s account) on the Merchant’s site.

N

LoyaltyPoints

Class LoyaltyPoints

LoyaltyPoints contains data about the registered user for applying loyalty points on the Checkout page.

N

loyaltyPointsEarned

Decimal

The number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site.

N

loyaltyPointsSpent

Decimal

The number of loyalty points to be spent for this purchase by the end customer on the Merchant’s site.

N

loyaltyPointsTotal

Decimal

The total number of loyalty points currently available in the end customer’s user account on the Merchant’s site.

N

merchantCartHash

nvarchar

A hash may be optionally generated by the merchant and returned to the merchant with an order API call. This hash may be used for additional cart and order validation purposes on the Merchant’s side. No max length.

N

MerchantOrderId

String

The merchant order id, if it is already known, at the point when the user is still in the cart page on the merchant’s store.

N

originalCurrencyCode

String

3-char ISO currency code denoting the original currency on the Merchant’s site (before applying country coefficient and FX conversion). If not specified, the Merchant’s default currency will be assumed by default.

N

otVoucherAmount

Decimal

Amount of the one-time voucher in otVoucherCurrencyCode currency.

N

otVoucherCode

String

One-time voucher code for the cart (for applicable platforms).

N

otVoucherCurrencyCode

String

One-time voucher currency used for the amount.

N

paymentInstallments

String

List of available payment instalment amounts.

For example: {2,4,6,8} – This indicates that we should allow instalmentsin 2, 4, 6 or 8 instalment options (to be selected by the customer).

N

prodectsList

List<Product>

List of Product objects (specified in the request body)

Y

rateData

String

Currency data is used by Global-e to verify the currency rate and to return the value received in the used currency rate.

Optional, irrelevant for GetCheckoutCartInfo API response

shippingDetails

Class UserDetails

Shipping details of a registered user (if available on the Merchant’s site). If the userDetails property is specified, then the shippingDetails will be ignored.

If countryCode is not specified, the shipping country must be specified in shippingDetails.CountryCode property.

If not specified neither in the countryCode argument nor in shippingDetails.CountryCode property, clientIP argument defined above becomes mandatory and will be used to determine the end user’s shipping country by Global‑e system.

N

shippingOptionsList

List<ShippingOption>

List of JSON-serialized Shipping Options available for local shipping of the order from the Merchant to Global‑e’s Local Hub previously returned by ActiveHubDetails API.

If the Global-e integration shipping API has been created and enabled for Global‑e on the Merchant’s site, Global‑e will prefer this Shipping Option when posting the order back to the Merchant’s site (using SendOrderToMerchant API). Therefore, all other shipping APIs available for local shipping may be omitted in shippingOptionsList.

N

urlParameters

List<KeyValuePair>

List of JSON-serialized Key:Value pairs denoting the values of the parameters specified in the respective Merchant’s REST API action URLs. For example, to instruct Global‑e to include “en-AU” locale in the SendOrderToMerchant call for this cart, urlParameters should include the following KeyValuePair: [{"Key":"locale", "Value":"en-AU"}]. In this example “locale” parameter should be configured for SendOrderToMerchant URL for this merchant on the Global‑e side.

N

userDetails

Class CartUserDetails

All available details of the user including all relevant addresses. If userDetails is not specified, then shippingDetails and billingDetails properties will be used instead. userDetails property can be used by merchants who support multiple shipping and/or multiple billing addresses in the user’s account.

N

vatRegistrationNumber

String

VAT Registration Number of the end customer’s business entity validated with the merchant.

N

webStoreCode

nvarchar

Code used on the merchant’s side to identify the web store where the current cart is originating. This code should be used when a multi-store setup is on the merchant’s site.

Max length: 100

N

webStoreInstanceCode

String

Code used on the merchant’s side to identify the web store instance where the current cart is originating from. This code should be used in case of multi-store domains set up on the merchant’s site.

N

CartToken

String

Unique identifier for the cart generated on the Global-e side. This identifier is required for additional checkout calls

CheckoutFields

List<CheckoutField>

Information required to populate and display the relevant address and customer fields on the checkout page. Each field displays information, validation information, and flags indicating which process requires a value in the field.

Countries

List<Country>

List of all the countries supported by the Merchant. Each country has a flag to show whether it is operated by Global-e.

IsAllCartRestricted

Bool

Indicates if the entire cart contains restricted products that cannot be shipped to the current shipping destination.

TRUE - Entire cart contains restricted products. The message shown to the customer varies according to the Merchant’s preferences.

FALSE - Cart is not all restricted.

When calling UpdateAddress, this field returns null.

PaymentMethods

List<CheckoutPaymentMethod>

List of payment methods that are available to the customer. Each payment method includes an icon representing the payment method that can be displayed on the checkout page and information indicating if the payment method involves a credit/debit card or an alternative payment option.

RestrictedProducts

List<Product>

List of products that cannot be shipped to the current shipping destination due to restriction. This list only returns the following properties for each product:

If this list contains restricted products, all other lists in the response are empty.

ShippingOptions

List<CheckoutShippingOption>

List of shipping options that are available to the customer. Each shipping option that supports pre-payment of duties and taxes also includes the calculated duties and taxes.

CardFields

Dictionary<String, String>

The gift card fields filled in the checkout

ValidationResult

Class ValidateGiftCardResponse

The gift card validation result

Icon

String

URL Full URL of the icon image for this payment method

IsCard

Bool

Indicates if this payment method denotes a card (rather than an alternative payment method).

TRUE - Payment performed with card.

FALSE - Payment performed by method other than card.

Name

String

Payment method name

PaymentMethodId

String

Unique identifier of the payment method in the Global-e system

DeliveryDaysFrom

Decimal

Minimum number of days for delivery to the end customer’s shipping country for this shipping option

N

DeliveryDaysTo

Decimal

Maximum number of delivery days to the end customer’s shipping country for this shipping option

N

ForceDDP

Decimal

One of the possible values of ForceDDPTypes enumeration denoting a type of DDP enforcement for this shipping option (applicable only if SupportsDDP is set to TRUE) as listed in the table below.

Price

Decimal

Shipping price in end customer currency for this cart

PriceBeforeDiscount

Decimal

Shipping price in end customer currency for this cart, before applying shipping discounts

ShippingMethodId

String

Unique identifier of the shipping method in the Global-e system

ShippingMethodTypeName

String

Shipping method type name

SupportsDDP

Bool

Indicates if taxes &amp; duties may be prepaid for this shipping option

CanPrePay

Bool

Indicates if taxes and duties have been successfully calculated for this cart and can be prepaid

TRUE - Taxes and duties can be prepaid.

FALSE - Taxes and duties cannot be prepaid.

ClearanceFeesValue

Decimal

Clearance fees value in the end customer’s currency for this cart

TaxesValue

Decimal

Taxes & duties value in the end customer’s currency for this cart

Code

String

City code (unique in the respective Region)

Name

String

City name

Code

String

2-char ISO country code

DefaultCurrencyCode

String

3-char ISO currency code

DefaultVATRateType

Class VATRateType

Default (most widely used) VAT rate type or class for this country.

N

IsOperatedByGlobalE

Bool

Flag to be used as a Mode indicator. Countries that are not operated by Global‑e can still be available for selection as a shipping destination on the Merchant site. However Global‑e functionality is disabled for such countries.

TRUE - Country is operated by Global-e.

FALSE - Country is not operated by Global-e.

IsStateMandatory

Bool

Indicates if State or province (region) is mandatory for addresses in this country.

TRUE - State is mandatory for address.

FALSE - State is not mandatory for address.

Name

String

Country name

SiteURL

String

URL of a country-specific site owned by the Merchant. Used to allow redirection to the Merchant’s country-specific domain for a selected country.

SupportsFixedPrices

Bool

Indicates if fixed product prices are allowed for this country. Product prices may be fixed only in the Default Currency for this Country.

TRUE - Prices can be fixed.

FALSE - Prices cannot be fixed.

N

UseCountryVAT

Bool

TRUE if VAT rate specific to this shipping country must be applied to the product prices. Otherwise, VAT rates defined for the products on the Merchant’s site must be used. This setting is used to support trade agreements between the countries such as EEA, when the end customer must pay VAT for the shipping country in certain cases.

N

CoefficientWithVATType

Decimal

Depending on VATRateType . This value is calculated as follows: 

CountryCode

String

2-char ISO country code

IncludeVAT

Decimal

This attribute is applicable only to the Country level (i.e. not applicable to the Product Class level). One of the possible values of IncludeVATOptions enumeration is designated to control the way VAT is handled in browsing on the Merchant’s site and in checkout on Global‑e. Following is a table with a list of IncludeVATOptions values and the expected results for the sample Product.

N

ProductClassCode

String

Product class code used by the Merchant to classify products for using different country coefficient rates per classes of products instead of the single country level default (when no rate is defined for a certain product class, the country level default rate should be used by the Merchant for the respective product).

Rate

Decimal

Country Coefficient rate decimal value. All the prices displayed to the end customer shipping to the country involved must be multiplied by this value.

CustomClearanceFee

Decimal

The final custom clearance fee for the order

Duties

Decimal

The final cost of duties for the order

ShippingPrice

Decimal

The final shipping price for the order

Taxes

Decimal

Taxes applicable for the order

CCAuthorizationToken

String

The custom clearance authorization token

CustomerPayments

Class CreateOrderFinalCustomerPayments

Provides details about the customer payment

ExternalOperationId

String

An external operation ID

IsTaxPrePaid

Bool

Identifies if taxes were prepaid.

OrderType

Class eSyncOrderType

The type of order. Includes the following fields:

Source

String

Order source

Code

String

ISO culture code

IsRTL

Bool

Identifies if language is a “right-to-left” language such as Hebrew and Arabic.

TRUE if “right-to-left” language

FALSE if not “right-to-left” language

LocalizedName

String

Culture name in the respective language, such as “עברית” for he-IL (Hebrew-Israel) culture

Name

String

Culture name

Code

String

3-char ISO currency code

MaxDecimalPlaces

Decimal

The number of decimal places indicating the fractional (“cents”) part of the price. For example, Bahraini Dinar “cents” has 3 decimal places, US Dollar has 2, and Japanese Yen has 0.

Name

String

Currency name

Symbol

String

Currency symbol (e.g. $ for USD)

CurrencySymbol

String

Currency symbol (e.g. $ for USD)

DisplayDecimalPlaces

Decimal

The number of decimal places indicating the fractional (“cents”) part of the price. For example, Bahraini Dinar “cents” has 3 decimal places, US Dollar has 2, and Japanese Yen has 0.

Rate

Decimal

Currency rate decimal value

RateData

String

Currency data used by Global‑e to verify the rate

SourceCurrencyCode

String

3-char ISO currency code.

TargetCurrencyCode

String

3-char ISO currency code

AttributeKey

String

Custom product attribute name that is used for product personalization by the end customer (e.g. engraving)

AttributeValue

String

Custom product attribute value that is used for product personalization by the end customer (e.g. engraving).

Address1

String

Address line 1.

Address2

String

Address line 2.

City

String

City name.

CountryCode

String

2-char ISO country code

PostalCode

String

Zip or postal code.

ProvinceCode

String

Province code.

CommercialInvoiceNumber

String

Commercial invoice number of the parcel if it exists on the parcel level, otherwise order commercial invoice number. Can be null if a commercial invoice does not exist for the order.

CurrencyCode

String

TotalValue 3-char ISO currency code

ParcelCode

String

Code used to identify the Parcel on the Merchant’s site

TotalValue

String

Value of all products in the parcel

CalculationMode

Decimal

One of the following possible values of CalculationModeOptions enumeration denoting the calculation mode of a discount to be implemented by GEM, see the CalculationMode Option Value Table below.

N

CouponCode

String

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

N

Description

String

Discount textual description

N

DiscountCode

String

Discount code used to identify the discount on the Merchant’s site. This property may be optionally specified in the SendCart method only, so that the same value could be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant method.

N

DiscountType

Decimal

One of the following possible enum values of DiscountTypeOptions enumeration denoting a type of discount. See the DiscountType Option Table below.

DiscountValue

Decimal

Discount value as displayed to the customer, after applying country coefficient, FX conversion and IncludeVAT handling.

LocalVATRate

Decimal

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 VATRate property denotes the VAT for the target country.

N

LoyaltyVoucherCode

String

Code used on the Merchant’s site to identify the Loyalty Voucher that this discount is based on

N

Name

String

Discount name

OriginalDiscountValue

Decimal

Discount value in original Merchant currency including the local VAT, before applying any price modifications. This property always denotes the discount value in the default Merchant’s country, regardless of UseCountryVAT for the end customer’s current country.

ProductCartItemId

String

Identifier of the product cart item related to this discount on the Merchant’s site. This property may be optionally specified in the SendCart method only so that the same value could be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant method.

N

VATRate

Decimal

The VAT rate applied to this discount

CouponCode

String

Merchant Coupon Code used for this discount (applicable to coupon-based discounts only).

Max length: 100 chars.

N

Description

String

Discount textual description.

Length: Unlimited.

N

DiscountType

Decimal

One of the following possible values of DiscountTypeOptions enumeration denoting a type of discount:

N

InternationalPrice

Decimal

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

N

Name

String

Discount name.

Length: Unlimited.

N

Price

Decimal

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

Y

VATRate

Decimal

The VAT rate applied to this discount

Y

CouponCode

String

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

N

Description

String

Discount textual description.

Length: unlimited.

N

DiscountCode

String

Discount code used to identify the discount on the Merchant’s site. This property may be optionally specified in the SendCart API only so that the same value can be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant API.

N

DiscountType

Decimal

For further details about discounts, see Discounts.

Name

Dtring

Discount name.

Length: unlimited.

Y

OriginalDiscountValue

Currency

Discount value in original Merchant currency including the local VAT, before applying any price modifications. This property always denotes the discount value in the default Merchant’s country, regardless of UseCountryVAT for the end customer’s current country.

Max length: 18,4.

Y

ProductCartItemId

String

Identifier of the product cart item related to this discount on the Merchant’s site. This property may be optionally specified in the SendCart API only so that the same value can be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant API.

Max length: 50 chars.

N

Duties

Decimal

Duties that are applied.

Other

Decimal

Other DT fees that are applied.

N

SalesTaxes

Decimal

Sales taxes that are applied.

DutiesValue

Decimal

Value of the duties according to the cart details including the respective shipping option price

TaxesValue

Decimal

Value of the taxes (VAT/sales tax/GST) according to the cart details including the respective shipping option price

Code

String

The error code

error

String

The error message

Description

String

The error description

CustomClearanceFee

Decimal

The customs clearance fee.

Duties

Decimal

The cost of duties.

ShippingPrice

Decimal

The shipping price.

Taxes

Decimal

The tax component of the customer payment.

Total

Decimal

The total customer payment.

HubCode

String

The Merchant hub code that indicates which hub the parcels or orders are being dispatched from. NOTE: hubCode should be mapped to a Global‑e hubId on the Global‑e side.

N

MerchantOrderIds

List<string>

The list of Merchant order ids to manifest

OrderIds

List<string>

The list of order IDs to manifest.

OuterBoxesAmount

Decimal

The number of outer boxes that are used through the manifest processing for DispatchConsolidateShipment.

N

BalanceInCustomerCurrency

Decimal

Total available amount in customer currency

BalanceInGiftCardCurrency

Decimal

Total available amount in gift card currency

BalanceUsedInCardCurrency

Decimal

Amount to redeem in gift card currency

BalanceUsedInCustomerCurrency

Decimal

Amount to redeem in gift user currency

CardFields

Dictionary<string, string>

Key value pairs of each field defined in the configuration

CardId

Decimal

id of the card in the DB table on the Global‑e side

CustomerCurrencyCode

String

User currency code (checkout currency)

ErrorCode

String

Code of the error

N

ErrorText

String

Error message

N

GiftCardCurrencyCode

String

Gift card currency code

IsRefundSuccess

Bool

The refund status.

TRUE - Refund was successfully applied to the gift card

FALSE - Refund failed or there is no refund on the card

RedeemTransactionId

String

The value that is set as a result of card redemption (should be provided by the platform)

RefundedBalanceInCustomerCurrency

Decimal

The amount of refunded money in customer currency

RefundedBalanceInGiftCardCurrency

Decimal

The amount of refunded money in gift card currency

Address1

String

Address line 1

Address2

String

Address line 2

City

String

City name

CountryCode

String

2-char ISO country code

CountryName

String

Country name

Email

String

E-mail address

Fax

String

Fax

HubId

Decimal

Hub identifier on Global‑e system

HubName

String

Name of the Hub

Phone1

String

Phone #1

Phone2

String

Phone #2

StateCode

String

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

StateOrProvice

String

State or province name

Zip

String

Zip or postal code

cartToken

String

Cart token for the cart generated on the Global‑e side.

CurrencyLocale

Class CurrencyLocale

Currency price display formatting information according to the received cultureCode.

merchantCartDiscounts

List<MerchantCartDiscountResponse>

List of discounts with calculated international prices.

merchantCartProduct

List<MerchantCartProductResponse>

List of products with calculated international prices.

CardNumberLastFourDigits

String

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

N

CurrencyCode

String

3-char ISO currency code.

Y

DutiesGuaranteed

Bool

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

Y

ExpirationDate

String

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

N

OrderTrackingNumber

String

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

Max length: 50 chars.

N

OrderTrackingUrl

String

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

Max length: 255 chars.

N

OrderWaybillNumber

String

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

N

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.

Y

PaymentAPIName

String

Name of the selected payment API.

Max length: 50 chars.

Y

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.

Y

ShippingAPIName

String

Name of the selected international shipping API.

Max length: 50 chars.

Y

TotalDutiesPrice

Decimal

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

Y

TotalPrice

Decimal

The total order price in the currency indicated in CurrencyCode.

Y

TotalShippingPrice

Decimal

Total shipping price in the currency denoted by CurrencyCode.

Y

TotalVATAmount

Decimal

Amount of VAT paid by the customer to Global-e

Y

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.

Y

TransactionTotalPrice

Decimal

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

Y

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.

N

ShippingAPIStatusName

String

Name of the shipping status.

Max length: 50 chars.

N

Key

String

Entity key (for example a URL parameter) used on the Merchant’s site (to be mapped on the Global‑e side)

Value

String

Entity value for the respective Key

CityCode

String

City code (unique in the respective Region)

CountryCode

String

2-char ISO country code

Culture

Class Culture

Culture definition for this location

RegionCode

String

Region code (unique in the respective Country)

Description

String

Loyalty Voucher’s textual description

N

DiscountValue

Decimal

Value of the discount based on the Loyalty Voucher. This value should be specified in the end customer’s currency, after applying country coefficient, FX conversion and IncludeVAT handling.

IsApplied

Bool

Indicates if the Loyalty Voucher is already applied by the end customer to the current cart

LocalVATRate

Decimal

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

N

Name

String

Loyalty Voucher’s name

OriginalDiscountValue

Decimal

The discount value to which the end customer is entitled if this Loyalty Voucher is applied to the cart. This value should be specified in the original Merchant currency including the local VAT, before applying any price modifications. This property always denotes the discount value in the default Merchant’s country, regardless of UseCountryVAT for the end customer’s current country.

VATRate

Decimal

The VAT rate applied to the discount based on this Loyalty Voucher

VoucherCode

String

Code used to identify the Loyalty Voucher on the Merchant’s site

MarketplaceId

Decimal

Marketplace ID.

MarketplaceOrderId

String

Marketplace order ID.

BrandCode

String

Brand code

Name

String

Brand name

CartHash

String

Cart hash originally specified in the merchantCartHash argument for the SendCart method preceding the current cart action.

N

CartId

String

Identifier of the cart on the Merchant’s site originally specified in the merchantCartToken argument for the SendCart method preceding the current cart action.

N

CartToken

String

Cart token for the cart generated on the Global‑e side by the SendCart method preceding the current cart action. This property is mandatory only for server-side calls.

N

LoyaltyVouchers

String

A JSON-serialized array of Loyalty Voucher codes to be applied to the cart. This list is mandatory only in the ClientApplyLoyaltyVouchers method.

N

MerchantGUID

String

Unique identifier of the Merchant on Global-e. This property is mandatory only for server-side calls.

N

UserId

String

Internal User identifier on the Merchant’s site originally specified in the shipping details.UserId argument for the SendCart method preceding the current cart action.

N

AttributeKey

String

Custom product attribute name that is used to describe the personalized product.

AttributeValue

String

Custom product attribute value that is used to describe the personalized product.

AuthToken

String

JWT AuthToken from the Merchant’s platform

GlobalECartToken

String

Global-e cart token

PreferredCultureCode

String

ISO culture code. Denotes the preferred culture for the checkout page. If not specified, the Merchant’s default culture will be used by default

SessionId

String

JWT SessionId from the Merchant’s platform

Subs

List<Merchant.CartValidationData>

Contains Sub carts validation data related to Mixed carts. This list is defined only in case the cart is Mixed.

CategoryCode

String

Merchant category code

Name

String

Merchant category name

Address1

String

Address line 1

N

Address2

String

Address line 2

N

AddressBookId

String

Id of the current address from within the address book

N

AddressBookName

String

Name of the current address from within the address book

N

City

String

City name

N

Company

String

Company name

N

CountryCode

String

2-char ISO country code

N

CountryName

String

Country name

N

Email

String

Email address

N

Fax

String

Fax

N

FirstName

String

First name

N

FirstNameInLocalCulture

String

First name in local culture

N

LastName

String

Last name

N

LastNameInLocalCulture

String

Last name in local culture

N

MiddleName

String

Middle name

N

Phone1

String

Phone #1

N

Phone2

String

Phone #2

N

Salutation

String

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

N

SaveAddress

Bool

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

N

StateCode

String

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

N

StateOrProvice

String

State or province name

N

Zip

String

Zip or postal code

N

CouponCode

String

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

N

Description

String

Discount textual description

N

DiscountCode

String

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.

N

DiscountSource

Enum

The enum DiscountSource has the following possible values:

Y

DiscountType

Decimal

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

InternationalPrice

Decimal

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.

N

LocalVATRate

Decimal

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.

N

LoyaltyVoucherCode

String

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.

N

Name

String

Discount name

Price

Decimal

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

ProductCartItemId

String

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.

N

VATRate

Decimal

The VAT rate applied to this discount

CouponCode

String

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

N

Description

String

Discount textual description

N

DiscountCode

String

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.

N

DiscountSource

Enum

The enum DiscountSource has the following possible values:

Y

DiscountType

Decimal

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

InternationalPrice

Decimal

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.

N

LocalVATRate

Decimal

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.

N

LoyaltyVoucherCode

String

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.

N

c

String

Discount name

Price

Decimal

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

ProductCartItemId

String

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.

N

VATRate

Decimal

The VAT rate applied to this discount

Address

Class Merchant.ImporterAddress

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

N

Company

String

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

N

CustomerTaxId

String

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

N

ImporterType

Decimal

Importer type, depending on the order type and destination: - 0: Private importer – standard B2C shipment - 1: Global‑e Importer – specific importer mentions required

VATRegistrationNumber

String

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)

N

CardNumberLastFourDigits

String

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

N

CashOnDeliveryFee

Decimal

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

N

ConsignmentFee

Decimal

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

N

CurrencyCode

String

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

CustomerDTBreakdown

Class DTBreakdown

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

N

DeliveryDaysFrom

Decimal

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

N

DeliveryDaysTo

Decimal

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

N

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

N

MerchantDTBreakdown

Class DTBreakdown

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

N

OrderTrackingNumber

String

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

N

OrderTrackingUrl

String

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

N

OrderWaybillNumber

String

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

N

ParcelsTracking

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

N

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.

N

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.

N

ShippingMethodStatusName

String

Name of the shipping status.

N

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.

N

TotalCCFPrice

Decimal

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

N

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.