The following classes are used by the API methods defined further in this document.

AdditionalRequiredDocuments

Parameter Name	Type	Description	Mandatory (Y/N)
`DocumentTypeCode`	Decimal	Document type code, one of the following: CommercialInvoice = 1 PackingList = 2 ShipperManifest = 3 Label = 4 VATInvoice = 5 DangerousGoodDeclarationLink = 6 GELabel = 7 CustomerReceiptInvoice = 8 ArchibeLabel = 9 DeliveryAdvice = 10 EAD = 11
`DocumentTypeName`	String	Document type name. For example: AWB, CommercialInvoiceAndPackingList, Manifest. Max length: 50 chars.	Y

Parameter Name

Type

Description

Mandatory (Y/N)

DocumentTypeCode

Decimal

Document type code, one of the following:

CommercialInvoice = 1
PackingList = 2
ShipperManifest = 3
Label = 4
VATInvoice = 5
DangerousGoodDeclarationLink = 6
GELabel = 7
CustomerReceiptInvoice = 8
ArchibeLabel = 9
DeliveryAdvice = 10
EAD = 11

DocumentTypeName

String

Document type name. For example: AWB, CommercialInvoiceAndPackingList, Manifest.

Max length: 50 chars.

AddressDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`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

AlternativePaymentRedirectInfo

Parameter Name	Type	Description
`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

AppSetting

Parameter Name	Type	Description	Mandatory (Y/N)
`Value`	String	Application setting value

AppSettings

Parameter Name	Type	Description	Mandatory (Y/N)
`ClientSettings`	Dictionary <string, AppSetting>	Dictionary of client-side settings
`ServerSettings`	Dictionary <string, AppSetting>	Dictionary of server-side settings

AppVersion

Parameter Name	Type	Description	Mandatory (Y/N)
`Value`	String	Version identifier of Global-e API
`WebClientVersion`	String	Version identifier of Global-e client-side (JS) code

Attribute

Parameter Name	Type	Description
`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

billingDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`Address1`	String	Address line 1. Length: Unlimited.	N
`Address2`	String	Address line 2. Length: Unlimited.	N
`City`	String	City name. Max length: 500 chars.	N
`CountryCode`	String	2-char ISO country code	N
`CountryName`	String	Country name. Max length: 255 chars.	N
`Email`	String	E-mail address. Max length: 500 chars.	N
`Fax`	String	Fax number. Max length: 250 chars.	N
`FirstName`	String	Customer’s first name. Max length: 40 chars. No length validation. The rest will be truncated.	N
`LastName`	String	Customer’s last name. Max length: 40 chars. No length validation. The rest will be truncated.	N
`MiddleName`	String	Middle name. Max length:40 chars. No length validation. The rest will be truncated.	N
`Phone1`	String	Phone #1. Max length: 250 chars.	N
`Phone2`	String	Phone #2. Max length: 250 chars.	N
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars.	N
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)	N
`StateOrProvince`	String	State or province name. Max length: 500 chars.	N
`UserIdNumber`	String	User’s personal ID document number	N
`UserIdNumberType`	Class UserIdNumberType	User’s personal ID document type. Includes the following fields: `UserIdNumberTypeCode` `Name`	N
`UserId`	String	Internal User identifier on the Merchant site	N
`Zip`	String	Zip or postal code. Max length: 250 chars.	N

Brand

Parameter Name	Type	Description	Mandatory (Y/N)
`BrandCode`	String	Brand code on the Merchant’s site (to be mapped on the Global‑e side)
`Name`	String	Brand name

CartCultureData

Parameter Name	Type	Description	Mandatory (Y/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
`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

CartCurrencyData

Parameter Name	Type	Description	Mandatory (Y/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

CartFreeShippingData

Parameter Name	Name	Name	Mandatory (Y/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

Parameter Name

Name

Mandatory (Y/N)

FreeShippingCouponCode

String

Merchant’s free shipping CouponCode applied by the end customer

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.

CartInfo

Parameter Name	Type	Description	Mandatory (Y/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)

CartLoyaltyData

Parameter Name	Type	Description	Mandatory (Y/N)
`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

CartOTVoucherData

Parameter Name	Type	Description	Mandatory (Y/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

CartPriceModificationData

Parameter Name	Type	Description	Mandatory (Y/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

CartUserDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`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

CartVATRegistrationData

Parameter Name	Type	Description	Mandatory
`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

Parameter Name

Type

Description

Mandatory

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.

VatRegistrationNumber

String

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

CartVoucherData

Parameter Name	Type	Description	Mandatory (Y/N)
`LoyaltyVouchers`	List<LoyaltyVoucher>	List of available loyalty vouchers for the registered customer	N
`OTVoucher`	Class CartOTVoucherData	One-time voucher information	N

Parameter Name	Type	Description	Mandatory (Y/N)
`CategoryCode`	String	Category code on the Merchant site (to be mapped on the Global‑e side)
`Name`	String	Category name

Challenge3DSInfo

Parameter Name	Type	Description
`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: OptimalAPI =4 AdyenAPI = 2, CouponPaymentGateway = 7 SplitItGateway = 8 FirstDataAPI = 9, SafeChargeAPI = 10 WorldPayAPI = 11 WalletGateway = 12 DLocalAPI = 14
`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

CheckoutAddress

Parameter Name	Type	Description	Mandatory (Y/N)
`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

CheckoutCardDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`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

CheckoutCartInfo

Parameter Name	Type	Description	Mandatory (Y/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

CheckoutField

Parameter Name	Type	Description
`DefaultValue`	String	In some cases, some fields should be prefilled with default values (for example, Hong Kong city in the Hong Kong country).
`DescriptionInCulture`	String	Additional textual information about the field (to be used as a watermark, tooltip, and more).
`IsRequiredForOrder`	Bool	Indicates if field is mandatory before completing or paying an order. TRUE - Field is mandatory before completing/paying order. FALSE - Field is not mandatory.
`IsRequiredForShipping`	Bool	Indicates if this field is mandatory for final shipping prices (due to remote area surcharge, which requires additional information and not just the country). This setting applies to City and ZipCode or if the Merchant chooses not to subsidize the remote area surcharge. TRUE - Field is mandatory for shipping price calculations. FALSE - Field is not mandatory.
`IsRequiredForTaxes`	Bool	Indicates if this field is mandatory for tax calculation. After all field settings are TRUE and have values, the `UpdateAddress` method returns the tax information. Depending on the shipping country, this setting can be TRUE for State, City, Address1, Address2, ZipCode (for example, the US sales tax uses the street name to calculate the actual tax cost). TRUE - Field is mandatory for tax calculations. FALSE - Field is not mandatory.
`MaxLength`	Decimal	The maximum number of characters allowed for a textual field (string). If it is not textual, this field is null.
`Name`	String	Name of the checkout field in English.
`NameInCulture`	String	Name of the checkout field in the checkout culture.
`Regex`	String	For textual fields, if applicable, a regex indicating the required field validation (preferably on the client side).
`Type`	String	Type of the field (string, numeric, list).

CheckoutInfo

Parameter Name	Type	Description
`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: ProductCode (SKU) CartItemId (unique identifier on the Merchant side) 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.

CheckoutInfoGiftCard

Parameter Name	Type	Description	Mandatory (Y/N)
`CardFields`	Dictionary<String, String>	The gift card fields filled in the checkout
`ValidationResult`	Class ValidateGiftCardResponse	The gift card validation result

CheckoutPaymentMethod

Parameter Name	Type	Description
`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

CheckoutShippingOption

Parameter Name	Type	Description	Mandatory (Y/N)
`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 & duties may be prepaid for this shipping option

ForceDDP

Contains one of the following possible values of the ForceDDPTypes enumeration:

ForceDDPType Option Value	Name	Description
0	Do Not Force DDP	Pre-payment of taxes & duties must NOT be forced.
1	Force DDP	Pre-payment of taxes & duties must be forced. The cost should be paid by the end customer.
2	Hidden Force DDP	Pre-payment of taxes & duties must be forced. The cost should be subsidized by the Merchant.

CheckoutTaxInfo

Parameter Name	Type	Description
`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

Parameter Name

Type

Description

Mandatory (Y/N)

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

City

Parameter Name	Type	Description	Mandatory (Y/N)
`Code`	String	City code (unique in the respective Region)
`Name`	String	City name

Country

Parameter Name	Type	Description	Mandatory (Y/N)
`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

CountryCoefficient

Parameter Name	Type	Description	Mandatory (Y/N)
`CoefficientWithVATType`	Decimal	Depending on VATRateType . This value is calculated as follows: `“HideVAT “`“HideVAT “→ `CoefficientWithVATType` = Country coefficient `VATType` = `“PocketVAT”` → `CoefficientWithVATType` = Country coefficient * Origin Country (Merchant Country) VAT rate `VATType` = `“ForceVAT “` → `CoefficientWithVATType` = Country coefficient * Destination country VAT rate If Merchant Account Settings `“DisableVATAdjustmentForShopifyCoefficient“` = True → `CoefficientWithVATType` = Country Coefficient
`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.

TypIncludeVAT

The 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 the list of IncludeVATOptions values and the expected results for the sample Product.

In the table below we are considering a product with the original cost in the UK = 100 GBP before VAT to be shipped to Germany (with country coefficient Rate=1 and user selected currency=GBP, for simplicity).

For this sample product UK VAT=20%, DE Duties Total=17%:

IncludeVAT Option Value	Description	Price In Browsing	Price In Checkout	Price Paid To Merchant (incl. VAT)	Checkout Duties Total	Checkout Total
0	Hide VAT (default)	100	100	120	17	117
2	Show VAT	120	100	120	17	117
4	“Pocket” VAT (increase the original price by the value of the respective product’s VAT)	120	120	144	20.4 (17%)	140.4
6	Force VAT (used to support trade agreements between the countries such as EEA, when the end customer must pay VAT; for simplicity assuming `UseCountryVAT`=false)	120	120	120	0	120
8	Force & Hide VAT (used to support trade agreements between the countries such as EEA, when end customer must pay VAT but VAT is not shown in browsing; for simplicity assuming `UseCountryVAT`=false)	100	120	120	0	120

CreateOrderFinalCustomerPayments

Parameter Name	Type	Description
`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

CreateSyncOrderData

Parameter Name	Type	Description
`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. TRUE - taxes were prepaid FALSE - taxes were not prepaid
`OrderType`	Class eSyncOrderType	The type of order. Includes the following fields: None = 0 Raffle = 1 FlashSale = 2 Collection = 3
`Source`	String	Order source

Culture

Parameter Name	Type	Description
`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

Currency

Parameter Name	Type	Description
`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)

CurrencyLocale

Parameter Name	Type	Description	Mandatory (Y/N)
`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.

CurrencyRate

Parameter Name	Type	Description
`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

CustomerDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`Address1`	String	Address line 1. Unlimited length.	N
`Address2`	String	Address line 2. Unlimited length.	N
`AddressBookId`	String	Id of the current address from within the address book. Max length:255 chars.	N
`AddressBookName`	String	Name of the current address from within the address book. Max length:255 chars.	N
`City`	String	City name. Max length: 500 chars.	N
`CityRegion`	String	State or province name. Max length:255 chars.	N
`CollectionPointId`	String	The collection point ID.	N
`Company`	String	Company name. Max length: 250 chars.	N
`CountryCode`	String	2-char ISO country code	N
`CountryCode3`	String	2-char ISO country code	N
`CountryName`	String	Country name. Max length: 255 chars.	N
`Email`	String	Email address. Max length: 500 chars.	N
`Fax`	String	Fax number. Max length: 250 chars.	N
`FirstName`	String	First name. Max length:40 chars. No length validation. The rest will be truncated.	N
`FirstNameInLocalCulture`	String	First name in local culture, for example, Kana Japanese dialect. Max length:40 chars.	N
`LastName`	String	Last name. Max length:40 chars. No length validation. The rest will be truncated.	N
`LastNameInLocalCulture`	String	Last name in local culture. Max length:40 chars.	N
`MiddleName`	String	Middle name. Max length:40 chars. No length validation. The rest will be truncated.	N
`Phone1`	String	Phone #1. Max length: 250 chars.	N
`Phone2`	String	Phone #2. Max length: 250 chars.	N
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars.	N
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable). 2 chars.	N
`Zip`	String	Zip or postal code. Max length: 250 chars.	N

CustomProductAttribute

Parameter Name	Type	Description	Mandatory (Y/N)
`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).

DeliveryAddress

Parameter Name	Type	Description
`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.

DeliveryAdviceInformation

Parameter Name	Type	Description
`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

Discount

Parameter Name	Type	Description	Mandatory (Y/N)
`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

DiscountType Options

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

DiscountType Option Value	Name	Description
1	Cart discount	Discount related to volume, amount, coupon or another promotion value.
2	Shipping discount	Discount aimed to sponsor international shipping.
3	Loyalty points discount	Discount applied against the Merchant’s loyalty points to be spent for this purchase.
4	Duties discount	Discount aimed to sponsor taxes & duties pre-paid by the end customer in Global‑e checkout.
5	Checkout Loyalty Points Discount	Discount applied against the Merchant’s loyalty points in Global‑e checkout.
6	Payment Charge	Discount aimed to sponsor “Cash on Delivery” fee.

CalculationMode Options

One of the following possible values of CalculationModeOptions enumeration denoting the calculation mode of a discount to be implemented by GEM:

CalculationMode Option Value	Name	Description
1 (default)	Percentage discount	The discount value specified in `OriginalDiscountValue` should be used to calculate the `DiscountValue` as a percentage of the full product price (specified in `Product.OriginalSalePrice` for line item level discounts) or the cart price (sum of all `Product.OriginalSalePrice` values) for cart level discounts. Note: The discount value provided is not a percentage. It represents the discount amount in your domestic currency. The ratio of the discount amount to the domestic price is calculated in the shopper's currency. This same ratio is then applied and deducted in the shopper's currency.
2	Fixed in original currency	The discount value specified in `OriginalDiscountValue` denotes the fixed value in the merchant’s currency. When calculating the discount’s `DiscountValue`, only the respective FX rate should be applied to `OriginalDiscountValue`. No other price modifications (such as country coefficient) should be performed.
3	Fixed in customer currency	The discount value specified in `DiscountValue` denotes the fixed value nominated in end customer currency that should not be affected by any price modifications (such as country coefficient).

CalculationMode Option Value

Name

Description

1 (default)

Percentage discount

The discount value specified in OriginalDiscountValue should be used to calculate the DiscountValue as a percentage of the full product price (specified in Product.OriginalSalePrice for line item level discounts) or the cart price (sum of all Product.OriginalSalePrice values) for cart level discounts.

Note: The discount value provided is not a percentage. It represents the discount amount in your domestic currency. The ratio of the discount amount to the domestic price is calculated in the shopper's currency. This same ratio is then applied and deducted in the shopper's currency.

Fixed in original currency

The discount value specified in OriginalDiscountValue denotes the fixed value in the merchant’s currency. When calculating the discount’s DiscountValue, only the respective FX rate should be applied to OriginalDiscountValue. No other price modifications (such as country coefficient) should be performed.

Fixed in customer currency

The discount value specified in DiscountValue denotes the fixed value nominated in end customer currency that should not be affected by any price modifications (such as country coefficient).

Discounts

Parameter Name	Type	Description	Mandatory (Y/N)
`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: Cart discount Shipping discount Loyalty points discount Duties discount Checkout Loyalty points discount Payment charge	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

discountsList

Parameter Name	Type	Description	Mandatory (Y/N)
`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

DTBreakdown

Parameter Name	Type	Description	Mandatory (Y/N)
`Duties`	Decimal	Duties that are applied.
`Other`	Decimal	Other DT fees that are applied.	N
`SalesTaxes`	Decimal	Sales taxes that are applied.

DutiesAndTaxesResponse

Parameter Name	Type	Description	Mandatory (Y/N)
`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

ErrorInfo

Parameter Name	Type	Description
`Code`	String	The error code
`error`	String	The error message
`Description`	String	The error description

eSyncOrderType

The type of order. Includes the following:

None = 0
Raffle = 1
FlashSale = 2
Collection = 3

FinalCustomerPayments

Parameter Name	Type	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.

GetOrdersManifestRequest

Parameter Name	Type	Description	Mandatory (Y/N)
`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

GiftCardData

The GiftCardData model is used for most calls where multiple cards are passed. See Base Gift Card Model.

Parameter Name	Type	Description	Mandatory (Y/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

HubDetails

Parameter Name	Type	Description
`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

InitCheckoutResponse

Parameter Name	Type	Description
`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.

InternationalDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`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

KeyValuePair

Parameter Name	Type	Description	Mandatory (Y/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

LocationCulture

Parameter Name	Type	Description
`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`)

LoyaltyVoucher

Parameter Name	Type	Description	Mandatory (Y/N)
`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

MarketplaceData

Parameter Name	Type	Description	Mandatory (Y/N)
`MarketplaceId`	Decimal	Marketplace ID.
`MarketplaceOrderId`	String	Marketplace order ID.

Merchant.Brand

Parameter Name	Type	Description	Mandatory (Y/N)
`BrandCode`	String	Brand code
`Name`	String	Brand name

Merchant.CartAction

Parameter Name	Type	Description	Mandatory (Y/N)
`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

Merchant.CartProductAttribute

Parameter Name	Type	Description	Mandatory (Y/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.

Merchant.CartValidationData [Inherits all fields from Merchant.OrderV2 - 3.123]

Parameter Name	Type	Description
`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.

Merchant.CartVoucherValidation

Parameter Name	Type	Description	Mandatory (Y/N)
`CartHash`	String	Cart hash originally specified in `merchantCartHash` argument for `SendCart` method for the cart converted to this order on Global‑e.
`CartId`	String	Identifier of the cart on the Merchant’s site originally specified in `merchantCartToken` argument for `SendCart` method for the cart converted to this order on Global‑e.
`CartToken`	String	The value returned from the previous call to `SendCart` for the same client (must be stored in the client session or persistent cookie on the Merchant’s side). This parameter is used to support cart updates.
`CountryCode`	String	2-char ISO country code
`CurrencyCode`	String	3-char ISO currency code.
`Discounts`	List<Merchant.DiscountVoucherValidation>	Cart discounts for voucher validation.
`FreeShippingCouponCode`	String	The Merchant free shipping coupon code applied by the end customer.
`IsFreeShipping`	Bool	Indicates if the Merchant offers free international shipping to the end customer.
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.
`Products`	List<Merchant.ProductVoucherValidation>	Cart products for voucher validation.
`UserId`	String	Internal User identifier on the Merchant’s site in case it was specified in the `SendCart` call.	N
`VoucherCode`	String	The voucher code specified on the Merchant site.
`VoucherType`	Decimal	Enumeration of `VoucherTypes`: 1 - `DiscountVoucher`
`WebStoreCode`	String	Code used on the Merchant’s side to identify the web store where the current cart is originating from. This code should be used in case of a multi-store setup on the Merchant’s site.
`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.

Merchant.Category

Parameter Name	Type	Description	Mandatory (Y/N)
`CategoryCode`	String	Merchant category code
`Name`	String	Merchant category name

Merchant.Customer

Parameter Name

Type

Description

Mandatory (Y/N)

IsEndCustomerPrimary

Bool

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.

TRUE - The primary customer is the same as the end customer who has placed the order

FALSE - 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

SendConfirmation

Bool

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

Merchant.CustomerDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`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

Merchant.Discount

Parameter Name	Type	Description	Mandatory (Y/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: 1 = Merchant 2 = FixedShippingPrice 3 = PercentageCartPrice 4 = HiddenForceDDP 5 = Amend 6 = RemoteAreaSurchargeSubsidy 7 = LoyaltyPoints 8 = PaymentCharge 9 = ReplacementOrder	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

Merchant.DiscountVoucherValidation

Parameter Name	Type	Description	Mandatory (Y/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: 1 = Merchant 2 = FixedShippingPrice 3 = PercentageCartPrice 4 = HiddenForceDDP 5 = Amend 6 = RemoteAreaSurchargeSubsidy 7 = LoyaltyPoints 8 = PaymentCharge 9 = ReplacementOrder	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

Merchant.ExporterDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`EORINumber`	String	Global‑e Exporter entity registration EORI number	N
`IOSSNumber`	String	Global‑e Exporter entity IOSS number (for shipments to the EU)	N
`VATRegistrationNumber`	String	Global‑e Exporter entity registration VAT number	N

Merchant.ImporterDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`Address1`	String	Address line 1	N
`Address2`	String	Address line 2	N
`City`	String	City name	N
`Country`	String	Country name	N
`CountryCode`	String	2-char ISO country code	N
`Name`	String	First and Last name
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)	N
`StateOrProvince`	String	State or province name	N
`Zip`	String	Zip or postal code	N

Merchant.ImporterAddress

Parameter Name	Type	Description	Mandatory (Y/N)
`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

Merchant.InternationalDetails

Parameter Name	Type	Description	Mandatory (Y/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.

Merchant.Order

Parameter Name	Type	Description	Mandatory (Y/N)
`AdditionalRequiredDocuments`	List<orderDocoment>	The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment.
`AllowMailsFromMerchant`	Bool	Indicates if the end customer has opted on the Global‑e checkout page to receive emails from the Merchant. TRUE - Customer opted to receive emails FALSE - Customer did not opt to receive emails
`CartHash`	String	Cart hash originally specified in the `merchantCartHash` argument for the `SendCart` method for the cart converted to this order on Global‑e.	N
`CartId`	String	Identifier of the cart on the Merchant’s site originally specified in `merchantCartToken` argument for `SendCart` method for the cart converted to this order on Global‑e.	N
`CashOnDeliveryFee`	Decimal	Cash On Delivery fee amount in Merchant’s currency.
CCFPrice	Decimal	Customs Clearance Fees (CCF), in the Merchant currency.
`ClearCart`	Bool	Indicates if the end customer’s cart must be cleared before this method finishes execution on the Merchant’s site. TRUE - The end customer’s cart must be cleared FALSE - The end customer's cart does not have to be cleare
`CurrencyCode`	String	3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency.
`CurrencyName`	String	Customer currency name. Returned by `GetOrdersDetails` API only	N
`Customer`	Class Merchant.Customer	The paying customer’s preferences (Global-e acts as a paying customer).
`CustomerComments`	String	Holds the gift message. In the offline order flow, holds the product comment.
`CustomerComments`	String	Comments text entered by the end customer in Global‑e checkout.	N
`CustomerDTBreakdown`	Class DTBreakdown	Contains the duties and tax parts the customer paid for the order.	N
`DateCreated`	String	Order creation date and time. Returned by `GetOrdersDetails` API only.	N
`DiscountedShippingPrice`	Decimal	The shipping price paid by the customer converted to the Merchant’s currency. Total Shipping price reducing Order Discounts (`InternationalDetails.DiscountedShippingPrice` price converted to the Merchant currency).
`Discounts`	List<Merchant.Discount>	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.	N
`DoNotChargeVAT`	Bool	Indicates if the end customer hasn’t 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. TRUE - VAT is not charged TRUE - VAT is charged	N
`ExporterDetails.DestinationRegistrationNumber`	Decimal	The Tax reference number of the GE Entity at the destination country. Should only be provided when the order is tax-collected. Otherwise, the field should be Null. The value should be Null if the order destination is for an EU country.
`ExporterDetails.LocalRegistrationClearance`	Bool	Indicates whether the Merchant can use the destination Registration number. TRUE - Merchant can use destination Registration number (`ExporterDetails.DestinationRegistrationNumber`) FALSE - Merchant cannot use destination Registration number .
`FreeShippingCouponCode`	String	Merchant’s free shipping `CouponCode` 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.	N
`InternationalDetails`	Class Merchant.InternationalDetails	Details referring to the end customer’s order placed on the Global‑e side. These details apply only to the Merchants dealing with international customers’ support themselves.	N
`IsB2B`	Bool	Indicates if the order has a Company name and VAT registration number. TRUE - Order contains a company name and VAT registration number FALSE - Order does not contain a company name and VAT registration number
`IsFreeShipping`	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. TRUE - Shipping is free. FALSE - Shipping is not free.	N
`IsMoto`	Bool	Indicates if the the customer is a customer support agent and an “Offline order” took place TRUE - The customer is a customer support agent and an “Offline order” took place FALSE - The customer is a regular customer
`IsReplacementOrder`	Bool	Indicates if the order is a replacement. TRUE - The order is a replacement FALSE - The order is not a replacement
`IsSplitOrder`	Bool	Indicates if the order should be handled as a split order (i.e. without consolidation). TRUE - Order will be split FALSE - Order is not to be split	N
`IsTaxExemption`	Bool	Indicates if the order has a tax exemption. TRUE - Order has a tax exemption FALSE - Order does not have a tax exemption
`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
`Markups`	List<Merchant.Discount>	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 end 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.	N
`MerchantDTBreakdown`	Class DTBreakdown	Contains the duties and tax parts that the Merchant subsidized for the order.	N
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.
`MerchantOrderId`	String	Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order.	N
`ModifiedProduct`	String	Holds the product’s SKU
`OrderCreationSource`	Decimal	One of the values of `OrderCreationSource` enumeration denoting a type of discount shown in the OrderCreationSource Table.
`OrderDocuments`	List<OrderDocument>	Always contains a single document - it can be either a VAT Invoice or a Customer Receipt, depends if it is within the EU or not.
`OrderId`	String	Global‑e order unique identifier.
`OrderPaymentMethods`	List<OrderPaymentMethod>	List of payment methods the customer use (Credit card, Gift Cards)
`OrderStatusReason`	Class OrderStatusReason	Reason for the order status, why it was cancelled.
`OriginalOrder`	Class Merchant.OriginalOrder	Details that refer to the original order if the current order is a replacement.	N
`OTCurrencyCode`	String	Currency of the one-time voucher code used to place the order.	N
`OTVoucherAmount`	Decimal	The amount taken off the voucher when applicable.	N
`OTVoucherCode`	String	One-time voucher code used to place the order	N
`Parcels`	List<Merchant.Parcel>	The list of parcels created for the order. Returned by `GetOrdersDetails` API only.	N
`PaymentDetails`	Class Merchant.PaymentDetails	The paying customer’s payment details.
`PrePayOffered`	Bool	Indicates if the prepayment option for duties and taxes was offered to the customer. TRUE - Prepayment option offered. FALSE - Prepayment option not offered.
`PriceCoefficientRate`	Decimal	`CountryCoefficient` rate applied to the prices in this order.
`PrimaryBilling`	Class Merchant.CustomerDetails	The primary customer’s billing details. If `IsEndCustomerPrimary` is set to TRUE, then the primary customer is the payer and his details are indicated in the URL-encoded form.
`PrimaryShipping`	Class Merchant.CustomerDetails	Primary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is TRUE, this field contains the end customers' shipping details. this field contains the Global-e hub's shipping address in the URL-encoded form.
`Products`	List<Merchant.Product>	The list of products being purchased.
`RoundingRate`	Decimal	The average conversion rate applied to the prices 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.
`SameDayDispatch`	Bool	Indicates if the end customer has requested “Same Day Dispatch” on Global‑e checkout. TRUE - Customer requested "Same Day Dispatch" FALSE - Customer did not request "Same Day Dispatch"	N
`SameDayDispatchCost`	Decimal	Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency.	N
`SecondaryBilling`	Class Merchant.CustomerDetails	Secondary customer’s billing details. If `Customer.IsEndCustomerPrimary` is FALSE, this contains attributes of the end customer’s details indicated in the URL-encoded form.
`SecondaryShipping`	Class Merchant.CustomerDetails	Secondary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is FALSE, this field contains the end customers' shipping details.
`ShippingMethodCode`	String	Code denoting the local shipping method selected from the list of available shipping options provided in the `shippingOptionsList` argument for the `SendCart` method for the cart converted to this order on Global‑e.	N
`ShipToStoreCode`	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).	N
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).
`Subs`	List<Merchant.Order>	Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed.
`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.
`TotalDutiesPaidByCustomerPrice`	Decimal	The total amount of duties paid by the customer in the Merchant’s currency.
`UserId`	String	Internal User identifier on the Merchant’s site originally specified in the `shippingDetails`.`UserId`argument for `SendCart` method for the cart converted to this order on Global‑e.	N
`USSalesTax`	Decimal	Sales tax value for USA in the Merchant currency. This value is included in `TotalDutiesAndTaxesPrice`.
`WebStoreCode`	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.	N

OrderCreationSource

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

OrderCreationSource Value	Name	Description
0	GECheckout	The default value for orders created in a normal flow via Global‑e Checkout
1	Marketplace	The value for orders that are created at a marketplace and sent to Global-e via your brand

Merchant.OrderRefund

Parameter Name	Type	Description	Mandatory (Y/N)
`Components`	List<Merchant.RefundComponent>	The list of `RefundComponent` objects for this order refund.	N
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.
`MerchantOrderId`	String	Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order.	N
`MerchantRMANumber`	String	The Merchant’s Returned Merchandize Authorization Number	N
`OrderId`	String	Global‑e order unique identifier.
`OriginalTotalRefundAmount`	Decimal	The refund amount in the original Merchant currency including the local Merchant’s VAT (currency is specified in `CurrencyCode` property of the respective `Merchant.Order`).
`Products`	List<Merchant.RefundProduct>	List of `RefundProduct` objects for this order refund.	N
`RefundComments`	String	Comments for the order refund	N
`RefundReason`	Class Merchant.OrderRefundReason	Reason for the order refund	N
`RMANumber`	String	The RMA number taken from the related Return.	N
`ServiceGestureAmount`	Decimal	The “Service gesture” amount in the customer’s currency is included in the `TotalRefundAmount`. “Service gesture” denotes any additional refund granted to the user, on top of the refund related to other components.	N
`TotalRefundAmount`	Decimal	The total refund amount in the end customer’s currency used for this order’s payment (currency is specified in InternationalDetails.`CurrencyCode`property for the respective `Merchant.Order`).
`WebStoreCode`	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.	N

Merchant.OrderRefundReason

Parameter Name	Type	Description	Mandatory (Y/N)
`Name`	String	Order refund reason name.
`OrderRefundReasonCode`	string	Code denoting the order refund reason on the Merchant’s site (to be mapped on the Global‑e side). If not mapped, Global‑e internal code will be specified instead.

Merchant.OrderTracking

Parameter Name	Type	Description
`ShipmentLocation`	String	Last known location of the shipment.
`ShipmentStatusUpdateTime`	String	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).
`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 does not 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 does not exist on the Merchant’s site, the internal Global‑e shipping status code will be specified instead.
`ShippingMethodStatusName`	String	Name of the shipping status.

Merchant.OrderV2 [inherits all fields from Merchant.Order - 3.64]

Parameter Name	Type	Description
`CurrencyName`	String	Name of the currency of the order
`DateCreated`	DateTime	Creation date
`Parcels`	List<Parcel>	List of the parcels associated with the order

Merchant.OriginalOrder

Parameter Name	Type	Description	Mandatory (Y/N)
`MerchantInternalOrderId`	String	`InternalOrderId` returned from `SendOrderToMerchant` call for the original order.	N
`MerchantOrderId`	String	`OrderId` returned from `SendOrderToMerchant` call for the original order.	N
`OrderId`	String	Global‑e order unique identifier for the original order.

Merchant.Parcel

Parameter Name	Type	Description
`Code`	String	Parcel code.
`ParcelStatusId`	Decimal	Parcel status id.
`StatusName`	String	Parcel status name.
`TrackingUrl`	String	Direct tracking URL.
`Products`	List<Merchant.ParcelProduct>	List of products included in the parcel.

Merchant.ParcelProduct

Parameter Name	Type	Description
`CartItemId`	String	Cart item id of the product.
`Quantity`	Decimal	Product quantity included in the parcel.
`Sku`	String	Product SKU.

Merchant.ParcelTracking

Parameter Name	Type	Description
`ParcelCode`	String	Parcel code.
`ParcelTrackingNumber`	String	The tracking number is used by the selected international shipping method for this parcel.
`ParcelTrackingUrl`	String	Full tracking URL including `ParcelTrackingNumber` used by the selected international shipping method for this parcel.

Merchant.PaymentDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`Address1`	String	Address line 1	N
`Address2`	String	Address line 2	N
`CardNumber`	String	Card number
`City`	String	City name	N
`CountryCode`	String	2-char ISO country code
`CountryName`	String	Country name
`CVVNumber`	String	Card CVV number
`Email`	String	E-mail address	N
`ExpirationDate`	String	Card expiration date (in YYYY-MM-DD format)
`Fax`	String	Fax	N
`OwnerFirstName`	String	Card owner’s first name	Optional if `OwnerName` is specified
`OwnerLastName`	String	Card owner’s last name	Optional if `OwnerName` is specified
`OwnerName`	String	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).	N
`PaymentMethodCode`	String	Payment method code used to identify the payment method on the Merchant’s site (to be mapped on the Global‑e side).
`PaymentMethodName`	String	Payment method name
`PaymentMethodTypeCode`	String	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).
`Phone1`	String	Phone #1	N
`Phone2`	String	Phone #2	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

Merchant.Product

Parameter Name	Type	Description	Mandatory (Y/N)
`Attributes`	List<Merchant.CartProductAttribute>	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.	N
`BackOrderDate`	String	Estimated date for the backordered item to be in stock	N
`Brand`	Class Merchant.Brand	Product’s brand	N
`CartItemId`	String	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.	N
`CartItemOptionId`	String	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.	N
`Categories`	List<Merchant.Category>	Product categories	N
`CustomerVATRate`	Decimal	The customer VAT rate applied to this product
`DiscountedPrice`	Decimal	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.
`DiscountedPriceForCustoms`	Decimal	Product price in Merchant currency reflects the price after Reverse D&T calculation.
`DTBreakdown`	Class DTBreakdown	Contains the duties and taxes per item in Merchant currency.	N
`GenericHSCode`	String	Product’s HS code	N
`GiftMessage`	String	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.	N
`HandlingCode`	String	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.	N
`InternationalDiscountedPrice`	Decimal	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.
`InternationalDiscountedPriceForCustoms`	Decimal	Product price in customer currency reflects the price after Reverse D&T calculation
`InternationalDiscountedPriceInMerchantCurrency`	Decimal	Product Price in Merchant currency
`InternationalDTBreakdown`	Class DTBreakdown	Contains the duties and taxes per item in customer currency.	N
`InternationalListPrice`	Decimal	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.	N
`InternationalPrice`	Decimal	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.	N
`IsBackOrdered`	Bool	Identifies if the product was ordered as a backed ordered item TRUE - Product is back-ordered. FALSE - Product is not back-ordered.	N
`LineItemInternationalPrice`	Decimal	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.	N
`LineItemPriceBeforeGlobalEDiscount` - DEPRECATED	Decimal	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`.	N
`ListPrice`	Decimal	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.
`Name`	String	Name of the product. Returned by `GetOrdersDetails` API only	N
`ParentCartItemId`	String	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.	N
P`r`ice	Decimal	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.
`PriceBeforeGlobalEDiscount` - DEPRECATED	Decimal	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.	N
`ProductAttributes`	List<Merchant.ProductAttribute>	Product attributes. Returned by `GetOrdersDetails` API only	N
`Quantity`	Decimal	Product quantity in the order that is currently being submitted to the Merchant.
`RoundingRate`	Decimal	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.
`Sku`	String	SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side).
`VATRate`	Decimal	The VAT rate applied to this product

Merchant.ProductAttribute

Parameter Name	Type	Description	Mandatory (Y/N)
`AttributeKey`	String	Customized product attribute name, used to describe the personalized product.
`AttributeValue`	String	Customized product attribute, used to describe the personalized product.

Merchant.ProductVoucherValidation

Parameter Name	Type	Description
`CartItemId`	String	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.
`CartItemOptionId`	String	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.
`Categories` - DEPRECATED	List<String>	List of categories mapped for current cart product.
`HandlingCode`	String	Code applicable to the product on the Merchant’s site. This code may be optionally used by the Merchant to trigger a certain business logic when this product is included in the order posted back to the Merchant’s site with the `SendOrderToMerchant` method.
`ParentCartItemId`	String	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.
`Price`	Decimal	Product price.
`Quantity`	Decimal	Product ordered quantity.
`Sku`	String	SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side).
`VATRate`	Decimal	The VAT rate applied to this product.

Merchant.RefundComponent

Parameter Name	Type	Description
`Amount`	Decimal	The refund amount in customer currency.
`ComponentType`	String	Products, Shipping, Duties, `PrepaidReturn` or `ServiceGesture`.
`IsChargedToMerchant`	Bool	Indicates if the component is charged to the Merchant or to Global-e. TRUE - Component is charged to the Merchant (default) FALSE - Component is charged to Global‑e If the same component is split between charged to the Merchant and charged to Global‑e, it should appear twice, each time with a different value in `IsChargedToMerchant`. Exception: A component `PrepaidReturn` – it should always be `IsChargedToMerchant` = TRUE.
`OriginalAmount`	Decimal	The refund amount in Merchant currency.

Merchant.RefundProduct

Parameter Name	Type	Description	Mandatory (Y/N)
`CartItemID`	String	Identifier of the line item on the Merchant’s site. This property is mandatory and should be equal to the respective Product’s `CartItemId` originally specified in the `SendCart` method for the order being refundedSendCartV2	Y
`OriginalRefundAmount`	Decimal	The refund amount in the original Merchant currency including the local Merchant’s VAT for this product line item, before applying any price modifications (i.e. part of or the full value paid by Global-e to the Merchant, as was specified in `Merchant.Product.Price` for the respective order.
`ProductCode`	String	Product SKU or Product Variant ID according to merchant configuration. Can be used as a Product Identifier instead of `CartItemId`. If there are multiple products with the same identifier, we choose one of them arbitrarily.	N
`RefundAmount`	Decimal	The refund amount for this product line item in customer currency used for the payment of this order
`RefundComments`	String	Comments for this product’s refund	N
`RefundQuantity`	Decimal	Product quantity (i.e. a part of the originally ordered quantity) that the refund refers to
`RefundReason`	Class Merchant.OrderRefundReason	Reason for this product’s refund	N
`Sku`	String	This field is obsolete. Use `ProductCode` instead.	N

Merchant.RemoveRestrictedProductsRequest

Parameter Name	Type	Description
`CartId`	String	Identifier of the cart on the Merchant’s site originally specified in `merchantCartToken` argument for SendCart method for the cart converted to this order on Global‑e.
`CartToken`	String	The value returned from the previous call to `SendCart` for the same client (must be stored in the client session or persistent cookie on the Merchant’s side). This parameter is used to support cart updates.
`CountryCode`	String	2-char ISO country code
`CurrencyCode`	String	3-char ISO currency code.
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.
`RemovedProductCodes`	List<String>	List of SKU codes for products removal from the cart.
`UserId`	String	Internal User identifier on the Merchant’s site in case it was specified in the `SendCart`call.
`WebStoreCode`	String	Code used on the Merchant’s side to identify the web store where the current cart is originating from. This code should be used in case of a multi-store setup on the Merchant’s site.
`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.

Merchant.RemoveRestrictedProductsResponse

Parameter Name

Type

Description

Mandatory (Y/N)

ErrorCode

String

Code of the error if it happened

ErrorMessage

String

Description of the error if it happened

IsSuccess

Bool

Indicates if the result is success.

TRUE - Restricted product removal successful.

FALSE - Restricted product removal not successful.

Merchant.ResponseInfo

Parameter Name	Type	Description	Mandatory (Y/N)
`Description`	String	Optional response description. In case of an error, this property indicates the error message description.	N
`ErrorCode`	String	Error code to be returned when an error occurs.	N
`InternalOrderId`	String	Order unique identifier on the Merchant’s site	Optional if there was an error, a failure, or if the action is not related to a specific order
`Message`	String	Optional response message. In case of an error, this property indicates the error message text.	N
`OrderId`	String	Order identifier on the Merchant’s site used for display and reporting purposes only. Unlike the `InternalOrderId`, this identifier is not necessarily unique over time, as the Merchant’s site may potentially reuse it (for example after deleting the old order having the same `OrderId`).	N
`PaymentAmount`	String	The total payment amount in `PaymentCurrency` charged for the order (if payment was processed in the respective API method call).	N
`PaymentCurrencyCode`	String	3-char ISO currency code for the order (if payment was processed in the respective API method call).	N
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).	Optional if there was an error or failure
`Success`	Bool	Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.

Merchant.StockValidationResponse

Parameter Name	Type	Description	Mandatory (Y/N)
`AmendedProducts`	List<Merchant.StockValidationRowResponse>	The list of products that don’t have full stock availability for the `Product.Quantity` specified in the respective `ValidateStock` API request.	N
`CustomResources`	Dictionary<string, string>	Dictionary with custom resources for error and oos popup. Keys for the dictionary: `TitleTextResourceId`, `BodyTextResourceId`, `ButtonTextResourceId`, `RedirectUrl`.	N
`Error`	String	The error message returned from the Merchant	N
`ReservationRequestId`	String	The stock reservation code returned from the Merchant if the stock has been actually reserved as a result of the `ValidateStock` API call.	N
`TextResourcesPlaceholders`	Dictionary<String, String>	Dictionary with placeholders which need to be replaced in text resources for error and oos popup which was passed in `CustomResources` (except `RedirectUrl` key).	N

Merchant.StockValidationRowResponse

Parameter Name	Type	Description	Mandatory (Y/N)
`CartItemId`	String	Identifier of the cart item on the Merchant’s site originally specified in the `Product.CartItemId` property of the respective product in the cart
`QuantityInStock`	String	Available product quantity

Merchant.TrackingDetails

Parameter Name	Type	Description
`ShipperName`	String	The shipping method name
`TrackingNumber`	String	The tracking number as the shipper has specified
`TrackingURL`	String	Full tracking URL including the `TrackingNumber` used by the selected international shipping method

Merchant.VoucherValidationResponse

Parameter Name	Type	Description
`CartToken`	String	`CartToken` returned from the new `SendCart` / `SendCartV2` API call, executed after the voucher has been applied to the respective user’s basket
`IsVoucherValid`	Bool	Indicates if the voucher is valid. TRUE - Voucher is valid. FALSE - Voucher is not valid.
`ValidationFaliureMessage`	String	Error message in case voucher is not valid
`VoucherRestrictions`	List<Merchant.VoucherValidationRestriction>	List of validation restrictions applied to vouchers
`VoucherType`	Decimal	Enumeration of `VoucherTypes`: 1 - DiscountVoucher

Merchant.VoucherValidationRestriction

Parameter Name

Type

Description

Mandatory (Y/N)

RestrictionEntityCode

String

Country code value.

VoucherValidationRestrictionType

Decimal

Enumeration of the voucher value restriction type:

0 - Country

MerchantCartDiscountResponse

Parameter Name	Type	Description	Mandatory (Y/N)
`CartItemId`	String	Identifier of the cart item on the Merchant’s site originally specified in `Product.CartItemId` property of the respective product in the `GetCheckoutCartInfo` API method response for the current cart.
`ListPrice`	Decimal	Product list price in end customer currency (before any discounts), after applying country coefficient, FX conversion, rounding rule (if applicable) and `IncludeVAT` handling.

MerchantCartProductResponse

Parameter Name	Type	Description	Mandatory (Y/N)
`CartItemId`	String	Identifier of the cart item on the Merchant’s site originally specified in `Product.CartItemId` property of the respective product in the `GetCheckoutCartInfo` API method response for the current cart.	N
`ListPrice`	Decimal	Product list price in end customer currency (before any discounts), after applying country coefficient, FX conversion, rounding rule (if applicable) and `IncludeVAT` handling.
`ProductCode`	String	SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side).
`SalePrice`	Decimal	Product sale price in end customer currency, after applying country coefficient, FX conversion, rounding rule (if applicable) and `IncludeVAT` handling.

MerchantReturn

Parameter Name	Type	Description
`CreatedBy`	String	Who created the return
`MerchantGUID`	String	Merchant’s unique ID
`MerchantOrderId`	String	Merchant Order Id
`OrderId`	String	Order Id
`ReturnedProducts`	List<MerchantReturnProduct>	Products returned
`ReturnTrackingNumber`	String	Return tracking number
`RMANumber`	String	Return Merchandise Authorization number
`ShipperName`	String	Name of shipper
`TrackingURL`	String	Tracking URL

MerchantReturnProduct

Parameter Name	Type	Description
`CartItemId`	String	The ID of the cart item
`MerchantReturnReasonCode`	String	Merchant code for return reason
`MerchantReturnReasonName`	String	Merchant name for return reason
`Name`	String	Name of product
`ReturnQuantity`	String	Return quantity
`ReturnReasonName`	String	Reason for return
`SKU`	String	Stock keeping unit

OrderCreationSource

Source where order was created. Can be one of the following:

GECheckout = 0
Marketplace = 1
ExternalApp = 2
ShopifyAPI = 3

OrderDocument

Parameter Name	Type	Description	Mandatory (Y/N)
`CreationDateTime`	DateTime	The date and time the document was created.	N
`DocumentData`	String	Base64 encoded byte array representing the document file content.
`DocumentExtension`	String	Document extension (PDF, ZPL, EPL).
`DocumentReference`	String	The reference provided by the government authorities to this document (such as MRN or ITN number).	N
`DocumentTypeCode`	String	Document type code, this value can be: CommercialInvoice = 1 PackingList = 2 ShipperManifest = 3 Label = 4 VATInvoice = 5 DangerousGoodDeclarationLink = 6 GELabel = 7 CustomerReceiptInvoice = 8 ArchibeLabel = 9 DeliveryAdvice = 10 EAD = 11
`DocumentTypeName`	String	Document type name, e.g. `AWB`, `CommercialInvoiceAndPackingList` or `Manifest`.
`ErrorMessage`	String	Description of the error for this entity (order/parcel) if it happened.	N
`ParcelCode`	String	The parcel code related to the document.	N
`ShippingServiceName`	String	The name of the shipping service for this document (relevant for `DispatchOrders` and `DispatchConsolidatedShipment`).	N
`URL`	String	URL of the document.

OrderDocumentsResponse

Parameter Name	Type	Description	Mandatory (Y/N)
`DeliveryAdviceInformation`	List<DeliveryAdviceInformation>	List of `DeliveryAdviceInformation` objects that hold the information required for the “Delivery Advice” document.	N
`Documents`	List<OrderDocument>	List of `OrderDocument` objects that hold the shipping documents. This property is included only in the `GetShippingDocuments` method response.	N
`ErrorText`	String	Description of the error to get documents	N
`IsSuccess`	Bool	Indicates if API call was successful or not. TRUE- API call was successful FALSE – API call was not successful
`ParcelsTracking`	List<Merchant.ParcelTracking>	List of the `Merchant.ParcelTracking` objects, each object holds the parcel tracking number and full tracking URL for the relevant shipper (with the parcel tracking number).	N
`ShipperManifests`	List<OrderDocument>	List of `OrderDocument` objects that hold shipper manifest documents. This property is included only in the `DispatchOrders` method response.	N
`TrackingDetails`	Class Merchant.TrackingDetails	Order tracking information.	N

OrderManifestDetails

Parameter Name

Type

Description

Mandatory (Y/N)

MerchantOrderId

String

Unique order identifier on the Merchant’s site

NOTE Either OrderID or MerchantOrderID should be specified

Mandatory if the OrderID property was not specified

MerchantOrderId

String

Unique Global‑e order identifier

NOTE Either OrderID or MerchantOrderID should be specified

Mandatory if the MerchantOrderID property was not specified.

OrderPaymentMethod

Parameter Name	Type	Description
`GiftCardFields`	String	Gift card fields
`IsGiftCard`	Bool	Indicates if the order payment method is a gift card. TRUE if using a gift card for payment FALSE if not using a gift card
`PaidAmountInCustomerCurrency`	Decimal	Amount that paid in customer’s currency
`PaidAmountInMerchantCurrency`	Decimal	Amount paid in Merchant’s currency
`PaymentMethodId`	Decimal	The ID for the payment method
`PaymentMethodName`	String	Name of the payment method

OrderRefundDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`CustomerAmountPrepaidRefund`	Decimal	The return shipping cost. Populated by the Merchant.
`CustomerPrepaidRefundAmount`	Decimal	Represents a prepaid fee that the customer is required to pay in case of refunds. This fee is deducted from the total refund amount due to the customer. The value of this field is specified in the currency of the customer.	N
`DutiesAmount`	Decimal	The “`Duties`” amount in the customer's currency included in the `TotalRefundAmount`. “`Duties`” denotes the funds that should be refunded due to Duties, Taxes and CCF costs.	N
`FullRefund`	Bool	The flag indicates that the full refund of the order should be performed. TRUE provide full refund FALSE do not provide full refund	N
`OrderId`	String	Global‑e order unique identifier (previously submitted to the Merchant’s `SendOrderToMerchant` method when the order had been created with Global‑e checkout) or Order unique identifier on the Merchant’s site.
`OriginalAmountPrepaidRefund`	Decimal	The return shipping cost in the customer’s currency.
`OriginalCustomerPrepaidRefundAmount`	Decimal	Represents a prepaid fee that the customer is required to pay in case of refunds. This field is populated in the original currency of the Merchant. The prepaid fee is converted to the currency of the customer and then deducted from the total refund amount due to the customer. Currency conversion rates are calculated based on the Spot rate on the day of the order creation. Use this field only when `CustomerPrepaidRefundAmount` is not provided. Make sure that only one of these fields is populated at a time to avoid double deductions.	N
`OriginalTotalRefundAmount`	Decimal	The refund amount in the original Merchant currency including the local Merchant VAT.	N
`ProductsDutiesRefund`	Bool	The flag indicates that the refund for the products should also include the associated duties and taxes. If `ProductsDutiesRefund` is specified, all refund totals will be auto-calculated, and therefore specifying `DutiesAmount`, `TotalRefundAmount` or `OriginalTotalRefundAmount` will return an error in this case. TRUE - Refund includes taxes. FALSE - Refund will not include taxes.	N
`RefundComments`	String	Merchant's comments for the order refund	N
`RefundReason`	Class OrderRefundReason	Reason for the order refund	N
`ServiceGestureAmount`	Decimal	“Service gesture” amount in the customer’s currency included in `TotalRefundAmount`. “Service gesture” denotes any additional refund granted to the user, on top of the refund related to other components.	N
`ShippingAmount`	Decimal	The “`Shipping`” amount in the customer’s currency included in `TotalRefundAmount`. “`Shipping`” denotes the funds that should be refunded due to shipping costs.	N
`ShippingRefund`	Bool	The flag indicates that the full shipping cost should be refunded. Either the `ShippingRefund` flag or `ShippingAmount` can be provided at the same time If a part of the shipping cost was already refunded – only the remaining available part will be refunded. TRUE - Shipping cost is refunded. FALSE - Shipping cost is not refunded.	N
`TotalRefundAmount`	Decimal	The total refund amount in the end customer’s currency and used for this order’s payment. If this attribute is not specified, `OriginalTotalRefundAmount` along with the sum of `OriginalRefundAmount` values in the `refundProductsList` specified in the respective `CreateOrderRefund`, will be used to calculate the `TotalRefundAmount`.	N

OrderRefundReason

Parameter Name	Type	Description	Mandatory (Y/N)
`Name`	String	Order refund reason name
`OrderRefundReasonCode`	String	Code denoting the order refund reason on the Merchant’s site (to be mapped on the Global‑e side)

OrderReplacementData

Parameter Name	Type	Description	Mandatory (Y/N)
`OriginalOrderId`	String	The original Order Id
`ReplacedProducts`	List< ReplacedProduct>	A list of replaced products

OrdersDetailsFilter

Parameter Name	Type	Description	Mandatory (Y/N)
`OrderIds`	List<String>	List of order ids to manifest

OrderStatus

Parameter Name	Type	Description	Mandatory (Y/N)
`Name`	String	Order status name
`OrderStatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side)

OrderStatusDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`ConfirmationNumber`	String	Merchant's Order confirmation number	N
`DeliveryReferenceNumber`	String	Merchant’s internal Delivery Reference Number for this order	N
`OrderComments`	String	Merchant's comments for the order	N
`OrderId`	String	Global‑e order unique identifier (previously submitted to the Merchant’s `SendOrderToMerchant` method defined below in this document when the order had been created with the Global‑e checkout)
`OrderStatus`	Class OrderStatus	The order status
`OrderStatusReason`	Class OrderStatusReason	Reason for the order status	N
`TrackingNumber`	String	Reference number valid for the tracking service used by the Merchant for this order	N
`TrackingServiceName`	String	Name of the tracking service used by the Merchant for this order	N
`TrackingServiceSite`	String	URL of the tracking service site used by the Merchant for this order	N
`TrackingURL`	String	Full tracking URL on the tracking service site used by the Merchant (if specified overrides all other “Tracking…” properties)	N

OrderStatusReason

Parameter Name	Type	Description	Mandatory (Y/N)
`Name`	String	Order status reason name
`OrderStatusReasonCode`	String	Code denoting the order status reason on the Merchant’s site (to be mapped on the Global‑e side)

Parcel

Parameter Name	Type	Description	Mandatory (Y/N)
`Height`	Decimal	Parcel height in centimeters/inches as measured by the Merchant.	N
`Length`	Decimal	Parcel length in centimeters/inches as measured by the Merchant.	N
`ParcelCode`	String	Code used to identify the Parcel on the Merchant’s site
`Products`	List<Product>	List of products contained in the parcel (for each Product object the following fields are relevant when used in the Parcel class: `ProductCode`, `CartItemId`, `DeliveryQuantity`). The products list is applicable only when including the list of products in each parcel is mandatory (such as in the `UpdateParcelDispatch` method).	N
`TrackingDetails`	Class TrackingDetails	Tracking information about the order/parcel.	N
`Weight`	Decimal	Parcel weight in grams as measured by the Merchant.	N
`Width`	Decimal	Parcel width in grams as measured by the Merchant.	N

ParcelError extends ErrorBase<T>

Parameter Name	Type	Description	Mandatory (Y/N)
`InnerErrorText`	String	Specifies inner error text in a case when third-party errors have occurred
`ParcelCode`	String	Parcel Code provided in the VoidParcelRequest

ParcelStatus

Parameter Name	Type	Description	Mandatory (Y/N)
`merchantParcelStatusCode`	String	The status code of the parcel, on the merchant side	Y
`merchantParcelStatusReason`	String	NOT IN USE – Reserved for future use	N

PaymentDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`Address1`	String	Address line 1. Length: Unlimited.	N
`Address2`	String	Address line 2. Length: Unlimited.	N
`CardNumber`	Varbinary	Card number	Y
`City`	String	City name. Max length: 500 chars.	N
`CountryCode`	String	2-char ISO country code	Y
`CountryName`	String	Country name. Max length: 255 chars.	Y
`CVVNumber`	Varbinary	Card CVV number	Y
`Email`	String	E-mail address. Max length: 500 chars.	N
`ExpirationDate`	String	Card expiration date (in YYYY-MM-DD format)	Y
`Fax`	String	Fax number. Max length: 250 chars.	N
`OwnerFirstName`	String	Card owner’s first name. Max length:40 chars. No length validation. The rest will be truncated.
`OwnerLastName`	String	Card owner’s last name. Max length:40 chars. No length validation. The rest will be truncated.
`OwnerName`	String	Card owner’s full name (the Merchant considers either full name or first name with the last name, according to the existing payment API input validation requirements).	N
`PaymentAPICode`	String	The payment API code is used to identify the payment API on the Merchant’s site (to be mapped on the Global-e side). Max length: 50 chars.	Y
`PaymentAPIName`	String	Payment API name. Max length: 50 chars.	Y
`PaymentAPITypeCode`	String	Payment API type’s code is used to identify the payment API type (such as Credit Card or Check) on the Merchant’s site (to be mapped on the Global-e side).	Y
`Phone1`	String	Phone #1. Max length: 250 chars.	N
`Phone2`	String	Phone #2. Max length: 250 chars.	N
`StateOrProvince`	String	State or province name. Max length: 500 chars.	N
`Zip`	String	Zip or postal code. Max length: 250 chars.	N

PaymentSecureGatewayTypes

The secure payment gateway type. Has the following possible values:

AdyenAPI = 2
OptimalAPI = 4
CouponPaymentGateway = 7
SplitItGateway = 8
FirstDataAPI = 9
SafeChargeAPI = 10
WorldPayAPI = 11
WalletGateway = 12
DLocalAPI = 14

PreEnroll3DSInfo

Parameter Name	Type	Description
`APICallAttemptsInterval`	Decimal	Attempts interval to call the `ScriptURL`.
`Bin`	String	A parameter that is to be sent with the `ScriptURL`.
`GatewayType`	Enum PaymentSecureGatewayTypes	Specifies the gateway API type
`JWT`	String	Another parameter that to be sent with the `ScriptURL`.
`MaxAPICallAttempts`	Decimal	Maximum attempts to call the `ScriptURL`.
`OrderId`	String	The Global-e order identifier.
`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.
`ScriptDomain`	String	The domain of the payment gateway. For security, you can verify the sender's identity using the `postMessage` origin property when processing the response from the gateway.
`ScriptURL`	String	The URL to the `PreEnrollment` procedure on the gateway.

PriceItemInfo

Parameter Name	Type	Description	Mandatory (Y/N)
`Price`	Decimal	Price of the item
`PriceItemId`	String	Unique identifier for the price item in the list (e.g. shipping option)

PrimaryBilling

Parameter Name	Type	Description	Mandatory (Y/N)
`Address1`	String	Address line 1. Unlimited length.	N
`Address2`	String	Address line 2. Unlimited length.	N
`City`	String	City name. Max length: 500 chars.	N
`CollectionPointId`	String	The collection point ID
`Company`	String	Company name. Max length: 250 chars.	N
`CountryCode`	String	2-char ISO country code	N
`CountryName`	String	Country name. Max length: 255 chars.	N
`Email`	String	Email address. Max length: 500 chars.	N
`Fax`	String	Fax number. Max length: 250 chars.	N
`FirstName`	String	First name. Max length:40 chars. No length validation. The rest will be truncated.	N
`LastName`	String	Last name. Max length:40 chars. No length validation. The rest will be truncated.	N
`MiddleName`	String	Middle name. Max length:40 chars. No length validation. The rest will be truncated.	N
`Phone1`	String	Phone #1. Max length: 250 chars.	N
`Phone2`	String	Phone #2. Max length: 250 chars.	N
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars.	N
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable). 2 chars.	N
`StateOrProvince`	String	State or province name. Max length: 500 chars.	N
`Zip`	String	Zip or postal code. Max length: 250 chars.	N

PrimaryShipping

Parameter Name	Type	Description	Mandatory (Y/N)
`Address1`	String	Address line 1. Unlimited length.	N
`Address2`	String	Address line 2. Unlimited length.	N
`City`	String	City name. Max length: 500 chars.	N
`CollectionPointId`	String	Collection point ID	N
`Company`	String	Company name. Max length: 250 chars.	N
`CountryCode`	String	2-char ISO country code	N
`CountryName`	String	Country name. Max length: 255 chars.	N
`Email`	String	Email address. Max length: 500 chars.	N
`Fax`	String	Fax number. Max length: 250 chars.	N
`FirstName`	String	First name. Max length:40 chars. No length validation. The rest will be truncated.	N
`LastName`	String	Last name. Max length:40 chars. No length validation. The rest will be truncated.	N
`MiddleName`	String	Middle name. Max length:40 chars. No length validation. The rest will be truncated.	N
`Phone1`	String	Phone #1. Max length: 250 chars.	N
`Phone2`	String	Phone #2. Max length: 250 chars.	N
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars.	N
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable). 2chars.	N
`StateOrProvince`	String	State or province name. Max length: 500 chars.	N
`Zip`	String	Zip or postal code. Max length: 250 chars.	N

Product

Parameter Name	Type	Description	Mandatory (Y/N)
`Attributes`	List<Attribute>	The product’s custom attributes (such as Color, Size, etc.)	N
`AttributesEnglish`	List<Attribute>	The product’s custom attributes (such as Color, Size, etc.) in English	N
`BackOrderDate`	String	Estimated date for the backordered item to be in stock	N
`Brand`	Class Brand	The product’s brand	N
`CartItemId`	String	Identifier of the cart item on the Merchant’s site. This property may be optionally specified in the `SendCart` method only so that the same value can be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method.	N
`CartItemOptionId`	String	Identifier of the child cart item “option” on the Merchant’s site. This value must be specified if the current cart item is related to a parent item (`CartItemId` must not be specified for this item because this attribute applies only to the “parent” item itself). For example, this item might indicate a package for the parent item in the same cart. This property may be optionally specified in the `SendCart` method only so that the same value can be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method.	N
`Categories`	List<Category>	The product’s categories	N
`DeliveryQuantity`	Decimal	The quantity actually set for delivery for the product (to be used in the Order methods described below, as needed)	N
`Description`	String	Description of the Product
`DescriptionEnglish`	String	Description of the Product in English
`GenericHSCode`	String	The product’s generic HS Code (not country-specific). If specified this property may assist in mapping the product for duties and taxes calculation purposes.	N
`GiftMessage`	String	Optional “gift message” text defined by the end customer to be printed on the product.	N
`HandlingCode`	String	Code applicable to the product on the Merchant’s site. This code may be optionally used by the Merchant to trigger a certain business logic when this product is included in the order posted back to the Merchant’s site with the `SendOrderToMerchant` method.	N
`Height`	Decimal	The product’s height in the Merchant’s default unit of length measure (will be converted to CM).	N
`HubCode`	String	The Merchant hub code indicates from which hub the product was sent. Note that the HubCode should be mapped to a Global-e hubId on the Global-e side.	N
`ImageHeight`	Decimal	The product’s image height in pixels	N
`ImageURL`	String	The product’s image URL	N
`ImageWidth`	Decimal	The product’s image width in pixels
`IsBackOrdered`	Bool	Boolean specifying if the product was ordered as a backed ordered item. TRUE - The item is back ordered FALSE - The item is not back ordered. Default FALSE.	N
`IsBlockedForGlobalE`	Bool	Indicates if product is available for international shipping. TRUE - The product is not available for international shipping FALSE - The product is available for international shipping	N
`IsBundle`	Bool	Indicates if the product represents a set of products. TRUE - The product represents a set of other products. If a bundled product has non-zero prices specified (i.e. `OriginalListPrice`, `ListPrice`, etc.), then all the contained products must have zero prices, and vice versa, to avoid double charging for the same products. FALSE - The product does not represent a set of other products.	N
`IsFixedPrice`	Bool	Indicates if the product’s price is fixed by the Merchant, in the default currency for the country. TRUE - The product’s price is fixed. In this case, all price modifications are disabled for this product. Setting fixed prices is only allowed for the Countries where the `SupportsFixedPrices` flag is set to TRUE. FALSE - The product's price is not fixed.	N
`IsVirtual`	Bool	Indicates if the product represents a virtual product that does not have weight or volume and doesn’t affect shipping calculation in Global‑e checkout TRUE - The product represents a virtual product FALSE - The product does not represent a virtual product	N
`Keywords`	String	The product’s keywords	N
`Length`	Decimal	The product’s length in the Merchant’s default unit of length measure (will be converted to CM).	N
`LineItemOriginalSalePrice`	Decimal	Line item (product in ordered quantity) sale price in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the price in the default Merchant’s country, regardless of `UseCountryVAT` for the end customer’s current country. If not specified, will be deemed equal to “`OriginalSalePrice* OrderedQuantity`”. If specified, will take preference over `OriginalSalePrice`.	N
`LineItemSalePrice`	Decimal	Line item (product in ordered quantity) sale price as displayed to the customer, after applying country coefficient, FX conversion and `IncludeVAT` handling, before rounding rules have been applied. If not specified, will be deemed equal to “`SalePrice * OrderedQuantity`”. If specified, will take preference over `SalePrice`.	N
`ListPrice`	Decimal	Product list price (before discounts) as displayed to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable) and `IncludeVAT` handling.	Optional in `SendCart`, `SaveProductsBulk`
`LocalVATRateType`	Class VATRateType	VAT rate type or class that would be applied to this product 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 `VATRateType` property actually denotes the VAT for the target country.	N
`MetaData`	Class ProductMetaData	Used to hold additional product data such as customer-defined product attributes.	N
`Name`	String	Name of the Product
`NameEnglish`	String	Name of the Product in English
`NetVolume`	Decimal	The product’s net volume in the Merchant’s default unit of volume measure (will be converted to cubic CM). If specified, this property indicates the net volume of the product, excluding any packaging.	N
`NetWeight`	Decimal	The product’s net weight in the Merchant’s default unit of weight measure (will be converted to grams). If specified, this property indicates the net weight of the product, excluding any packaging.	N
`OrderedQuantity`	Decimal	Ordered quantity for the product (to be used in Checkout / Order methods described below, as needed)	N
`OriginalListPrice`	Decimal	Product list price (before any discounts) in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the product’s price in the default Merchant’s country, regardless of `UseCountryVAT` for the end customer’s current country.	Optional in `SendCart`, `SaveProductsBulk`
`OriginalSalePrice`	Decimal	Product sale price in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the product’s price in the default Merchant’s country, regardless of `UseCountryVAT` for the end customer’s current country.	Optional in SaveProductsList, `SaveProductsBulk`
`OriginCountryCode`	String	2-char ISO country code of the product’s country of Origin. The Merchant’s country will be assumed if not specified.	N
`ParentCartItemId`	String	Identifier of the current item’s parent cart item on the Merchant’s site. This value must be specified if the current cart item is related to a parent item (`CartItemId` must not be specified for this item because this attribute applies only to the “parent” item itself). For example, this item might indicate a custom option (such as a product package) for the parent item in the same cart. This property may be optionally specified in the `SendCart` method only so that the same value can be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method.	N
`PriceCoefficientRate`	Decimal	Rate applicable to this Product’s`ProductClassCode` if returned from the `CountryCoefficients` method.	N
`ProductClassCode`	String	The product class code is used by the Merchant to classify products to use different country coefficient rates.	N
`ProductCode`	String	SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side)
`ProductCodeSecondary`	String	Secondary code that may be used to refer to the product on the Merchant’s site. This code may be used in addition to the `ProductCode` and is not guaranteed to be unique (may be reused for other products as long as the old product is not available on the Merchant’s site any more).	N
`ProductGroupCode`	String	Product’s group code on the Merchant’s site (to be mapped on the Global‑e side). Usually, this value is a part of the product SKU code denoting a group of similar products (such as "the same product in different s").	N
`ProductGroupCodeSecondary`	String	Secondary code that may refer to the group of products on the Merchant’s site. This code may be used in addition to the `ProductGroupCode` and is not guaranteed to be unique (may be reused for other groups as long as the old group is not available on the Merchant’s site anymore).	N
`SalePrice`	Decimal	Product sale price as displayed to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable) and `IncludeVAT` handling.	Optional in SaveProductsList, `SaveProductsBulk`, GetCheckoutCartInfo
`SalePriceBeforeRounding`	Decimal	Product sale price as displayed to the customer, after applying country coefficient, FX conversion and `IncludeVAT` handling, before rounding rules have been applied. If not specified, will be deemed equal to `SalePrice`.	N
`SalePriceReason`	String	Reason for the sale price. This property may optionally contain the text definition of the promo that has resulted in the price deduction for this product (such as “10% discount on all shoes”).	N
`URL`	String	The product’s information page URL	N
`VATCategory`	Class VATCategory	The product’s VAT category. A product may be assigned to a single VAT category on the Merchant’s site. If available, the respective product’s HS Code should be used as the VAT category for a product.	N
`VATRateType`	Class VATRateType	Product’s VAT rate type or class	N
`Volume`	Decimal	The product’s volume in the Merchant’s default unit of volume measure (will be converted to cubic CM).	Optional, can be used as an alternative for specifying all Height, Width and Length dimensions
`Weight`	Decimal	The product’s weight is in the Merchant’s default unit of weight measure (will be converted to grams). The Merchant’s default product weight will be used if not specified.	N
`Width`	Decimal	The product’s width in the Merchant’s default unit of length measure (will be converted to CM).	N

ProductCountry

Parameter Name	Type	Description	Mandatory (Y/N)
`CountryCode`	String	2-char ISO code of the shipping country
`ForbiddanceMessage`	String	Textual definition of the forbiddance (will be empty if `IsForbidden` is FALSE)
`IsForbidden`	Bool	Indicates if Global-e supports shipping the product to this country. TRUE - Global-e does not support shipping the product to this country. Adding this product to the cart must be disabled completely. FALSE - The product can be shipped to this country.
`IsRestricted`	Bool	Indicates if this product has import restrictions for this shipping country. TRUE - Product has import restrictions for this shipping country. If at least one restricted product is included in the Cart, the end customer will not be able to place the order with Global-e until the product is either removed from the Cart or a shipping country with no restrictions for this product is selected. FALSE - Product does not have import restrictions.
`IsVerified`	Bool	Indicates if product restrictions and other data contained in this object have been verified by Global‑e (i.e. some algorithmic approximations may be used by the system until manually resolved by Global‑e personnel). TRUE - Product restrictions/data have been verified. FALSE - Restrictions not verified.
`ProductCode`	String	SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side)
`RestrictionMessage`	String	Textual definition of the restriction (will be empty if `IsRestricted` is FALSE)
`TTL`	Decimal	Time-to-live interval (in seconds) before this object must be refreshed from the Global-e server. This property overwrites the “max-age” header returned by any method call which returns the `ProductCountry` object.
`UploadedViaCatalog`	Bool	Indicates whether the product was uploaded via catalogue or not. TRUE - Product was uploaded via catalogue. FALSE - Product was not uploaded via catalogue.
`VATRateType`	Class VATRateType	Product’s VAT rate type or class to be used for this product in this shipping country. If not specified, the respective VATCategoryCountry’s `VATRateType` or Country’s `DefaultVATRateType` must be used if applicable according to the UseCountryVAT value for this country. Otherwise, the VAT rate defined for this product on the Merchant’s site must be used.	N

ProductMetaData

Parameter Name	Type	Description	Mandatory (Y/N)
`Attributes`	List<CustomProductAttribute>	Customer-defined product attributes that allow the personalisation of the product if supported by the merchant’s site (e.g. engraving)	N

Products

Parameter Name	Type	Description	Mandatory (Y/N)
`Attributes`	Class Attributes	The attributes of the product. Includes the following fields: AttributeCode Name AttributeTypeCode
`BillingDetails`	Class BillingDetails	Provides billing details for the products.
`Brand`	Class Brand	The product’s brand. Includes the following fields: BrandCode – string – Up to 50 chars Name – string – Up to 100 chars.	N
`CartItemId`	String	identifier of the cart item 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
`CartItemOptionId`	String	Identifier of the child cart item “option” on the Merchant’s site. This value must be specified if the current cart item is related to a parent item (CartItemId must not be specified for this item because this attribute applies only to the “parent” item itself). For example, this item might indicate a package for the parent item in the same cart. 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
`Categories`	Class Category	The category of the product. Includes the following: CategoryCode – sting – Up to 50 chars. Name
`DeliveryQuantity`	Decimal	The quantity set for delivery for the product (to be used in the Order APIs described below, as needed).	N
`Description`	String	Description of the Product. Length: Unlimited.	Y
`DiscountsList`	Class DiscountsList	List of possible discounts for products.
`GenericHSCode`	String	The product’s generic HS Code (not country-specific). If specified this property may assist in mapping the product for duties and tax calculation purposes. Max length: 50 chars.	N
`Height`	Decimal	The product’s height in the Merchant’s default unit of length measure (will be converted to CM).	N
`ImageHeight`	Decimal	The product’s image height in pixels	N
`ImageURL`	String	The product’s image URL A JPG formatted image. Max length: 255 chars.	N
`ImageWidth`	Decimal	The product’s image width in pixels	N
`IsBlockedForGlobalE`	Bool	Indicates if product is available/blocked for international shipping. TRUE - Product is blocked for international shipping. FALSE - Product is available for international shipping.	N
`IsFixedPrice`	Bool	Indicates if the product’s price is fixed by the Merchant. TRUE - Product’s price is fixed by the Merchant, in the default currency for the country. In this case, all price modifications are disabled for this product. Setting fixed prices is only allowed for the Countries where the `SupportsFixedPrices` flag is set to TRUE. FALSE - Product price is not fixed.	N
`Keywords`	String	The product’s keywords. Length: Unlimited.	N
`Length`	Decimal	The product’s length in the Merchant’s default unit of length measure (will be converted to CM).	N
`ListPrice`	Decimal	Product list price (before discounts) as displayed to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable), and `IncludeVAT` handling.	N
`LocalVATRateType`	Class VATRateType	If `UseCountryVAT` for the current Country is TRUE, the `VATRateType` denotes the VAT for the target country. This value must be specified if the order was placed by a local customer. Includes the following fields: `VATRateTypeCode` Rate	N
`Name`	String	Name of the Product. Min length: 1 char. No length limit.	Y
`OrderedQuantity`	Decimal	Ordered quantity for the product (to be used in Checkout / Order APIs described below, as needed)	N
`OriginalListPrice`	Decimal	Product list price (before any discounts) in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the product’s price in the default Merchant’s country, regardless of `UseCountryVAT` value for the end customer’s current country.	N
`OriginalSalePrice`	Decimal	Product sale price in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the product’s price in the default Merchant’s country, regardless of `UseCountryVAT` value for the end customer’s current country.	N
`OriginCountryCode`	String	2-char ISO country code of the product’s country of Origin. The Merchant’s country will be assumed if not specified.	N
`ParentCartItemId`	String	Identifier of the current item’s parent cart item on the Merchant’s site. This value must be specified if the current cart item is related to a parent item (CartItemId must not be specified for this item because this attribute applies only to the “parent” item itself). For example, this item might indicate a custom option (such as a product package) for the parent item in the same cart. 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
`ProductCode`	String	SKU code used to identify the product on the Merchant site (to be mapped on the Global-e side). Max length: 100 chars.	Y
`ProductGroupCode`	String	The product’s group code is on the merchant’s site (to be mapped on the global-e side). Usually, this value is a part of the product SKU code denoting a group of similar products (such as "the same product in different colors"). Max length: 300 chars.	N
`SalePriceBeforeRounding`	Decimal	Product sale price as displayed to the customer, after applying country coefficient, FX conversion, and IncludeVAT handling, before rounding rules have been applied. If not specified, will be deemed equal to SalePrice.	N
`SalePrice`	Decimal	Product sale price as displayed to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable), and IncludeVAT.	N
`ShippingDetails`	Class Shipping Details	Shipping details for the product.
`URL`	String	The product’s information page URL. Max length: 255 chars.	N
`UseCountryVAT`	Bool	Identifies if the `LocalVATRateType` must be specified. TRUE - Must specify `LocalVATRateType` FALSE - Do not need to set `LocalVATRateType`
`Volume`	Decimal	The product’s volume in the Merchant’s default unit of volume measure (will be converted to cubic CM).	N
`Weight`	Decimal	The product’s weight is in the Merchant’s default unit of weight measure (will be converted to grams). The merchant’s default product weight will be used if not specified	N
`Width`	Decimal	The product’s width is measured in the merchant’s default unit of length (will be converted to CM).	N
`VATRateType`	String	Product’s VAT rate type or class. Max length: 100 chars.	N

RedeemGiftCardRequest

Parameter Name	Type	Description
`Cards`	List<GiftCardData>	List with gift cards data objects
`MerchantCartToken`	String	Identifier of the cart on the Merchant’s site originally specified in the `merchantCartToken` argument for the respective `SendCart` call
`MerchantGUID`	String	Unique Merchant identifier
`OrderId`	String	Global‑e Order ID
`ShippingCountryCode`	String	Code of country selected on checkout

RedeemGiftCardResponse

Parameter Name	Type	Description
`Cards`	List<GiftCardData>	List with gift cards data objects data
`ErrorCode`	String	Code of the error
`ErrorText`	String	Error message

RefundGiftCardRequest

Parameter Name	Type	Description
`Cards`	List<GiftCardData>	List with gift cards data objects
`ConversionRate`	Decimal	Rate of conversion from gift card currency to customer currency
`MerchantGUID`	String	Merchant unique identifier
`OrderId`	String	Global‑e Order ID
`TotalToRefundInCustomerCurrency`	Decimal	The total value to refund for all gift cards in customer currency
`TotalToRefundInGiftCardCurrency`	Decimal	The total value to refund for all gift cards in gift card currency

RefundGiftCardRequest

Parameter Name	Type	Description
`Cards`	List<GiftCardData>	List with gift cards data objects
`ConversionRate`	Decimal	Rate of conversion from gift card currency to customer currency
`MerchantGUID`	String	Merchant unique identifier
`OrderId`	String	Global‑e Order ID
`TotalToRefundInCustomerCurrency`	Decimal	The total value to refund for all gift cards in customer currency
`TotalToRefundInGiftCardCurrency`	Decimal	The total value to refund for all gift cards in gift card currency

RefundGiftCardResponse

Parameter Name	Type	Description
`Cards`	List<GiftCardData>	List with gift cards data objects data
`ErrorCode`	String	Code of the error
`ErrorText`	String	Error message
`IsRefunded`	Bool	Indicates if the amounts of redeemed cards was successfully returned TRUE - Successfully refunded. FALSE - Refund not successful.

RefundProduct

Parameter Name	Type	Description	Mandatory (Y/N)
`CartItemId`	String	Identifier of the line item on the Merchant’s site. This property is mandatory and should be equal to the respective Product’s `CartItemId` originally specified in the `SendCart` method for the order being refunded.
`OriginalRefundAmount`	Decimal	The refund amount in the original Merchant’s currency including the local Merchant’s VAT for this product line item, before applying any price modifications (i.e. part of or the full value paid by Global-e to the Merchant, as was specified in `Merchant.Product.Price` for the respective order).	N
`ProductCode`	String	Product SKU or Product Variant ID according to Merchant configuration. Can be used as Product Identifier instead of `CartItemId`. In case there are multiple products with the same identifier we will choose one of them arbitrarily.	N
`RefundAmount`	Decimal	The refund amount for this product line item in customer currency and used for this order payment. If this attribute is not specified, `OriginalRefundAmount` multiplied by `RoundingRate` for this product line item should be used to calculate `TotalRefundAmount` for this order’s refund.	N
`RefundComments`	String	Merchant's comments for this product’s refund	N
`RefundQuantity`	Decimal	Product quantity (i.e. a part of the originally ordered quantity) that the refund refers to.	N
`RefundReason`	Class OrderRefundReason	Reason for this product’s refund	N
`Sku`	String	The field is obsolete, please use `ProductCode` instead.	N

Region

Parameter Name	Type	Description
`Code`	String	Region code for this state or province (unique in the respective Country)
`CountryCode`	String	2-char ISO country code to which this region belongs
`Name`	String	Region name

ReplacedProduct

Parameter Name	Type	Description	Mandatory (Y/N)
`CartItemId`	String	Cart item ID
`Quantity`	Decimal	Item quantity

ResponseInfo

Parameter Name

Type

Description

Mandatory (Y/N)

Success

Bool

Indicates if the call was successful. Success property value may be only TRUE. Otherwise, ErrorInfo will be returned instead.

TRUE - Call was successful

FALSE - Call failed

For more information see ErrorInfo.ErrorInfo

Reason

String

Text that optionally describes the reason for Success status.

RoundingException

Parameter Name	Type	Description	Mandatory (Y/N)
`ExceptionValue`	Decimal	A decimal value to avoid rounding for. Rounding exceptions always behave like “Relative Decimal”

RoundingRange

Parameter Name	Type	Description
`From`	Decimal	A decimal value of the range start, exclusive of the `From` value itself. If a range must start from 0 inclusive, the `From` value must be set to a negative number.
`LowerTarget`	Decimal	A decimal value used to calculate the target rounded value, for the numbers less than the `Threshold`, according to the defined `Range` behavior. If the `LowerTarget` value violates the `MaxDecimalPlaces` setting for the respective currency, it must be truncated as described in the “Important Notices” below.
`RangeBehavior`	Decimal	One of the possible values of `RangeBehaviors` enumeration defined below which is designed to control the way rounding range is handled. The range behavior is applied to `Threshold`, `LowerTarget`, `UpperTarget` and `Exceptions` in the `RoundingExceptions` list.
`RoundingExceptions`	List<RoundingException>	List of decimal values used to calculate the exceptions for rounding, i.e. values not to apply rounding for. `RangeBehaviors` enumeration: see Table 1 and Table 2.
`TargetBehaviorHelperValue`	Decimal	A decimal value required for the “nearest target” and “relative whole target” behavior.
`Threshold`	Decimal	A decimal value used to split the range so that the values less than the threshold would be rounded to the Lower target, and values greater than or equal to the threshold would be rounded to the Upper target. For the "Absolute target," the threshold range is an absolute value. Other Ranges are Relative values. See the absolute target in Rounding Range for more information. RoundingRange
`To`	Decimal	A decimal value of the range end, inclusive.
`UpperTarget`	Decimal	A decimal value used to calculate the target rounded value, for the numbers greater than or equal to the Threshold, according to the defined Range behavior. If the `UpperTarget` value violates the `MaxDecimalPlaces` setting for the respective currency, it must be truncated as described in the “Important Notices” below.

Table 1: RoundingException

List of decimal values used to calculate the exceptions for rounding, i.e. values not to apply rounding for.

RangeBehaviors enumeration:

RangeBehavior Option Value	Name	Description
1	Absolute target	In this behavior all the values within the specified range (`LowerTarget, UpperTarget, Threshold and RoundingExceptions`) denote the values themselves as is, without the need for any additional math operations. Getting rounding result (R) for the source number (S) must be implemented as follows: If (S = Exceptionn) then R = Exceptionn If (S < Threshold) then R = LowerTarget If (S >= Threshold) then R = UpperTarget
2	Relative Decimal target	In this behavior all the values within the specified range (`LowerTarget, UpperTarget, Threshold and RoundingExceptions`) represent floating point numbers between 0 (inclusive) and 1 (inclusive), used to calculate the respective absolute values, relative to the calculation base (B) as follows: For source number (S): B = whole part of S LowerTarget (absolute): LA = B – 1 + LowerTarget UpperTarget (absolute): UA = B + UpperTarget Threshold (absolute): TA = B + Threshold Exceptionn (absolute): EAn = B + Exceptionn If (S = EAn) then Result (R) = EAn If (S < TA) then R = LA If (S >= TA) then R = UA
3	Relative Whole target	In this behavior LL the values within the specified range (`LowerTarget, UpperTarget, Threshold and RoundingExceptions`) represent non-negative whole numbers, while `TargetBehaviorHelperValue (V)` is used to determine the calculation base (B). V must be a power of 10 (10, 100, 1000, etc.) and denotes the order of magnitude for the range “split” by the Threshold. For example, if Threshold = 9 we need to know if this is 9 out of 10 or 9 out of 100. Getting rounding result (R) for the source number (S) must be implemented as follows: For source number (S): B = S rounded down to the closest multiple of V For example if (S = 56789 and V = 1000) then B = 56000 LowerTarget (absolute): LA = B – V + LowerTarget UpperTarget (absolute): UA = B + UpperTarget Threshold (absolute): TA = B + Threshold Exceptionn (absolute): EAn = B + Exceptionn If (S = EAn) then Result (R) = EAn If (S < TA) then R = LA If (S >= TA) then R = UA
4	Nearest target	In this behavior, `LowerTarget` and `UpperTarget` represent non-negative floating-point numbers, while TargetBehaviorHelperValue (V) is used to determine the calculation base (B). V must be a whole divisor of any power of 10 (5, 10, 25, 50, 100, 250, 500, 1000, etc.). The threshold must be any floating-point number between 0 (inclusive) and V (exclusive). Getting rounding result (R) for the source number (S) must be implemented as follows: For source number (S): B = S rounded down to the closest multiple of V For example, if (S = 123 and V = 5) then B = 120 LowerTarget (absolute): LA = B – 1 + LowerTarget UpperTarget (absolute): UA = B – 1 + V + UpperTarget Threshold (absolute): TA = B + Threshold Exceptionn (absolute): EAn = B + Exceptionn If (S = EAn) then Result (R) = EAn If (S < TA) then R = LA If (S >= TA) then R = UA

Important:

If the result of rounding is a negative number, it must be set to zero, for any rounding behavior defined in the table above.

If either LowerTarget or UpperTarget value violates MaxDecimalPlaces setting for the respective currency, this value must be truncated accordingly. For example, if UpperTarget is set to 0.999 for USD, it must be truncated to 0.99 before using in any further calculations.

Table 2: Rounding Rules Samples

The following samples indicate how rounding X to Y (X → Y) is implemented using the respective settings.

	0.25 → 0 3 → 0 1.5 → 1.5 2 → 2	22.47 → 21.95 22.48 → 22.99 22.50 → 22.50 33.75 → 33.75	2047 → 1995 2048 → 2100	122.26 → 124.99 122.25 → 119.99 127.26 → 129.99 121.50 → 121.50 127.50 → 127.50 123 → 123 128 → 128	2047 → 1999 2048 → 2100
From	0	1	1000	100	1000
To	3	250	10000	1000	10000
Threshold	3.01	0.48	48	2.26	48
LowerTarget	0	0.95	95	0.99	0
UpperTarget	0	0.99	100	0.99	1
RangeBehavior	1 Absolute	2 Relative Decimal	3 Relative Whole	4 Nearest	4 Nearest
TargetBehaviorHelperValue			100	5	100
RoundingExceptions	1.5	0.50		1.50
	2	0.75		2.50
				3

RoundingRule

Parameter Name	Type	Description
`CountryCode`	String	2-char ISO country code
`CurrencyCode`	String	3-char ISO currency code
`RoundingRanges`	List<RoundingRange>	List of decimal ranges and their respective rounding behavior. See RoundingRange.
`RoundingRuleId`	Decimal	Rule identifier denoting the respective Rounding Rule on the Global‑e side. This value must be further specified when calling `SaveProductsList` and `SendCart` methods

SecondaryBilling

Parameter Name	Type	>Description	Mandatory (Y/N)
`Address1`	String	Address line 1. Unlimited length.	N
`Address2`	String	Address line 2. Unlimited length.	N
`City`	String	City name. Max length: 500 chars.	N
`CollectionPointId`	String	The collection point ID.
`Company`	String	Company name. Max length: 250 chars.	N
`CountryCode`	String	2-char ISO country code	N
`CountryName`	String	Country name. Max length: 255 chars.	N
`Email`	String	Email address. Max length: 500 chars.	N
`Fax`	String	Fax number. Max length: 250 chars.	N
`FirstName`	String	First name. Max length:40 chars. No length validation. The rest will be truncated.	N
`LastName`	String	Last name. Max length:40 chars. No length validation. The rest will be truncated.	N
`MiddleName`	String	Middle name. Max length:40 chars. No length validation. The rest will be truncated.	N
`Phone1`	String	Phone #1. Max length: 250 chars.	N
`Phone2`	String	Phone #2. Max length: 250 chars.	N
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars.	N
`StateOrProvince`	String	State or province name. Max length: 500 chars.	N
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable). 2 chars.	N
`Zip`	String	Zip or postal code. Max length: 250 chars.	N

SecondaryShipping

Parameter Name	Type	Description	Mandatory (Y/N)
`Address1`	String	Address line 1. Unlimited length.	N
`Address2`	String	Address line 2. Unlimited length.	N
`City`	String	City name. Max length: 500 chars.	N
`CollectionPointId`	String		N
Company	String	Company name. Max length: 250 chars.	N
CountryCode	String	2-char ISO country code	N
CountryName	String	Country name. Max length: 255 chars.	N
`Email`	String	Email address. Max length: 500 chars.	N
`Fax`	String	Fax number. Max length: 250 chars.	N
`FirstName`	String	First name. Max length:40 chars. No length validation. The rest will be truncated.	N
`LastName`	String	Last name. Max length:40 chars. No length validation. The rest will be truncated.	N
`MiddleName`	String	Middle name. Max length:40 chars. No length validation.	N
`Phone1`	String	Phone #1. Max length: 250 chars.	N
`Phone2`	String	Phone #2. Max length: 250 chars.	N
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars.	N
`StateOrProvince`	String	State or province name. Max length: 500 chars.	N
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable). 2 chars.	N
`Zip`	String	Zip or postal code. Max length: 250 chars.	N

SendAdditionalRequiredDocumentsToMerchantRequest

Parameter Name	Type	Description
AdditionalRequiredDocuments	List <OrderDocument>	Additional documents which are required to ship the order
CountryCode	string	2-char ISO country code
CountryCode	string	Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order
OrderId	string	Global‑e’s order id

SendCartData

Parameter Name	Type	Description	Mandatory (Y/N)
`AllowMailsFromMerchant`	Bool	Indicates if the end customer’s consent to receive emails from Merchants should be pre-selected in Global‑e checkout. TRUE - Preselect consent to receive emails. FALSE - Do not preselect consent.	N
`CartCurrencyData`	Class CartCurrencyData	Details about the cart currency
`CartId`	String	A string that represents the Merchant order id if it is known already at the point when the user is still in the cart page on the Merchant’s store.	N
`CartPriceModificationData`	Class CartPriceModificationData	Data regarding cart price modifications
`CartToken`	String	The value returned from the previous call to `SendCart` for the same client (must be stored in the client session or persistent cookie on the Merchant’s side). This parameter is used to support cart updates.
`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 the `shippingDetails.CountryCode` property denoting the registered user’s country defined below.
`Culture`	Class Culture	Cart culture data	N
`Discounts`	List<Discount>	List of Discounts to be applied to the cart. Discounts of any type (“cart”, “shipping”, etc.) may be specified.
`FreeShipping`	Class CartFreeShippingDataCartFreeShippingData	Holds information required carts that were awarded free international shipping according to the Merchant platform (as opposed to the flat shipping pricing system on the global-e system).
`HubId`	Decimal	Identifier of the Global‑e’s Local Hub previously returned by the `ActiveHubDetails` method. If not specified, the default Merchant’s Hub will be used instead.
`IsMoto`	Bool	Indicates whether the person placing the order is a customer support agent or a regular customer. TRUE – The customer is a customer support agent and an “Offline order” takes place, FALSE - (default value) – The customer is a regular customer.	N
`LocalShippingOptions`	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 the `ActiveHubDetails` method. If the “globaleintegration_standard” shipping method 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 the `SendOrderToMerchant` API method). Therefore, all other shipping methods available for local shipping may be omitted in `LocalShippingOptions`.
`LoyaltyData`	Class CartLoyaltyDataCartLoyaltyData	Holds information for Merchant-side loyalty points to be applied.
`LoyaltyPoints`	Class LoyaltyPointsLoyaltyPoints	Holds information on the registered user to apply loyalty points on the checkout page.	N
`MerchantCartHash`	String	Hash optionally generated by the Merchant, to be returned to the Merchant with the order API call. This hash may be used for additional cart and order validation purposes on the Merchant’s side.
`MerchantCartToken`	String	Cart or session identifier used for the cart on the Merchant’s site, to be returned to the Merchant with the order API call.
`MerchantInternalOrderId`	String	Unique identifier of Merchant internal order ID.
`MerchantOrderId`	String	Unique identifier of Merchant order ID.
`PaymentInstallments`	List<Decimal>	List of available payment instalment amounts.
`PriceModification`	Class	Cart price modification data	Optional for Merchants not supporting browsing integration
`Products`	List<Product>	List of Product objects.
`rateData`	String	Currency data used by Global‑e to verify the currency rate. Return the value received in the used currency rate.
`UrlParameters`	String	List of JSON-serialized `KeyValuePairs` that denote parameter values to be specified in the respective Merchant’s RESTFul API action URLs. For example, to instruct Global‑e to include the “`en-AU`” locale in the SendOrderToMerchant call for this cart, `urlParameters` should include: `KeyValuePair: [{"Key":"locale", "Value":"en-AU"}]`. In this example “locale” parameter should be configured for the SendOrderToMerchant URL for this Merchant on the Global‑e side.
`UserDetails`	Class CartUserDetailsCartUserDetails	All available details of the user including all relevant addresses.
`VATRegistration`	Class CartVATRegistrationDataCartVATRegistrationData	Holds information required for VAT exemption within the EU.
`VoucherData`	Class CartVoucherDataCartVoucherData	Holds information for Merchant-side vouchers to be applied (includes loyalty vouchers and one-time vouchers).
`WebStoreCode`	String	Code used on the Merchant’s side to identify the web store where the current cart is originating from. This code should be used in case of a multi-store setup on the Merchant’s site.	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

SendFinalCartData extends SendCartData

Parameter Name	Type	Description
`BillingDetails`	Class UserDetails	Billing details entered by the customer in the checkout form
`CheckoutUrl`	String	Checkout URL; it redirects you to the checkout or confirmation page (different URL for each Merchant)
`CustomerPayments`	Class FinalCustomerPayments	The values of total duties, total taxes, total additional fees (like Custom Clearance Fee), shipping price, and total that was shown to the customer on the checkout page
`GiftCards`	List<Merchant.CheckoutInfoGiftCard>	The collection of `GiftCards` that were applied to the cart
`IsSameDayDispatchSelected`	Bool	Indicates if the user selected an option to dispatch the order on the same day TRUE - Selected to dispatch order on the same day FALSE - Did not select to dispatch order on the same day
`IsTaxPrePaid`	Bool	Indicates if the end customer has selected or has been forced to prepay duties & taxes TRUE - Selected to prepay taxes FALSE - Did not select to prepay taxes
`MarketplaceData`	Class MarketplaceData	Marketplace information received by the API
`OrderCreationSource`	Class OrderCreationSource	Source for the order creation process
`OrderData`	Class CreateSyncOrderData	Information about the order
`OrderReplacementData`	Class OrderReplacementData	Order replacement information received by the API
`ShippingDetails`	Class UserDetails	Shipping details entered by the customer in the checkout form. If `CountryCode` is included, it is ignored (a new `InitCheckout` call is required if the shipping country is changed)
`ShippingMethodId`	String	The ID of the shipping option selected by the customer

SendOrderRequestInfo

Parameter Name	Type	Description
`AcceptHeader`	String	The format of the data the application can accept to display on the WebPage. Use “text/html”.
`BillingDetails`	Class UserDetails	Billing details entered by the customer in the checkout form.
`CardDetails`	Class CheckoutCardDetails	Payment card details specified on the Merchant checkout page (for PCI-compliant Merchants).
`CartToken`	String	Cart token returned by the InitCheckout call.
`ClientIP`	String	Client's IP. m.
`DoAddressVerification`	Bool	Indicates whether to perform the address verification. This is optional; if not provided then the address verification is done by default. TRUE - Perform address verification. FALSE - Do not perform address verification
`IsSameDispatchSelected`	Bool	Indicates if the user selected an option to dispatch the order in the same day. TRUE - Same day dispatch selected. FALSE - Same day dispatch not selected.
`IsTaxPrePaid`	Bool	Indicates if the end customer has selected or has been forced to prepay duties & taxes.
`MerchantCallBackURL`	String	Callback URL provided by the Merchant when using an alternative payment method. In this case, a redirect flow is required, for example, to PayPal. Merchants can use different URLs depending on their needs. For instance, a Merchant can have a callback URL for mobile devices and another for desktop browsers. If the `merchantCallBackUR`L is not specified when using an alternative payment method, the `SendOrder` call returns a validation error.
`PaymentMethodId`	Decimal	Global-e identifier of the payment method selected in the Merchant’s checkout. This identifier is mandatory for alternative payment methods. If not specified, the system assumes that the payment was made with a credit/debit card, and the card brand is identified on the Global-e side, according to the card number.
`ShippingDetails`	Class UserDetails	Shipping details entered by the customer in the checkout form. If `CountryCode` is included, it is ignored (a new InitCheckout call is required if the shipping country is changed).
`ShippingMethodId`	Decimal	ID of the shipping option selected by the customer.
`UserAgent`	String	The value that identifies the user’s application used for the checkout. For example, “MyShopApplication (android)”.

SendOrderResponseInfo

Parameter Name	Type	Description	Mandatory (Y/N)
`Order`	Class Merchant.Order	Pending payment Global‑e order that was created following the `SendOrder` request
`PaymentActionURL`	String	URL where the end customer should be redirected to complete the purchase with the selected alternative (non-card) payment method, or card payment action URL in Global-e secured environment for card payment methods

ShippingDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`Address1`	String	Address line 1. Unlimited length.	N
`Address2`	String	Address line 2. Unlimited length.	N
`City`	String	City name. Max length: 500 chars.	N
`CountryCode`	String	2-char ISO country code	N
`CountryName`	String	Country name. Max length: 255 chars.	N
`Email`	String	E-mail address. Max length: 500 chars.	N
`Fax`	String	Fax number. Max length: 250 chars.	N
`FirstName`	String	First name. Max length: 40 chars. No length validation. The rest will be truncated.	N
`LastName`	String	Last name. Max length:40 chars. No length validation. The rest will be truncated.	N
`MiddleName`	String	Middle name. Max length:40 chars. No length validation. The rest will be truncated.	N
`Phone1`	String	Phone #1. Max length: 250 chars.	N
`Phone2`	String	Phone #2. Max length: 250 chars.	N
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars.	N
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable). 2 chars.	N
`StateOrProvince`	String	State or province name. Max length: 500 chars.	N
`UserId`	Decimal	Internal User identifier on the Merchant site	N
`UserIdNumber`	String	User’s personal ID document number	N
`UserIdNumberType`	String	User’s personal ID document type (e.g. Passport, ID card, etc.)	N
`Zip`	String	Zip or postal code. Max length: 250 chars.	N

ShippingOption

Parameter Name	Type	Description
`Carrier`	String	Carrier’s short name
`CarrierName`	String	Carrier’s full name
`CarrierTitle`	String	Carrier’s title
`Code`	String	Shipping method code used to identify the shipping option on the Merchant’s site (to be mapped on the Global‑e side)
`Method`	String	Shipping method name
`MethodTitle`	String	Shipping method title
`MethodDescription`	String	Shipping method description
`Price`	Decimal	Shipping price in Merchant’s original currency defined in the `originalCurrencyCode` argument of the respective method call (i.e. `SendCart`)

ShippingOptionPricesResponse

Parameter Name	Type	Description	Mandatory (Y/N)
`ShippingPrices`	List<PriceItemInfo>	List of shipping options with calculated international prices

ShippingOptionResponse

Parameter Name	Type	Description	Mandatory (Y/N)
`DutiesAndTaxes`	Class DutiesAndTaxesResponse	Full duties and taxes information according to the specific shipping option price
`ShippingOptionId`	String	The ID of the shipping option

TrackingDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`TrackingNumber`	String	The tracking number as the shipper has specified

UpdateOrderDispatchException

Parameter Name	Type	Description	Mandatory (Y/N)
`CartItemId`	String	Identifier of the cart item 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. Either `CartItemId` or `ProductCode` should be specified.	Mandatory only if the `ProductCode` property was not specified.
`ExceptionType`	Decimal	One of the following possible values of the `ExceptionTypes` enumeration: 1 - Out Of Stock: Out-of-stock items will not be fulfilled 2 - Backorder Preorder Customized Item: Backorder/preorder/customized items will be fulfilled. 3 - Cancellation by request: Cancelled by customer request will not be fulfilled.
`ExpectedFulfilmentDate`	Date	Expected date for backordered/preordered/customized item to be fulfilled (in YYYY-MM-DD format).	N
`ProductCode`	String	Product unique identifier on the Merchant’s site. Either `CartItemId` or `ProductCode` should be specified.	Mandatory only if the `CartItemId` property was not specified.
`Quantity`	Decimal	Product quantity that the exception refers to.	Mandatory only for Exception Type 3.

UpdateOrderProductsRequest

Parameter Name	Type	Description
`MetaDataUpdateType`	String	The type of metadata update. Must be set to Merge.
`OrderId`	String	Global-e unique identifier or Merchant unique identifier of the order that requires updating.
`Products`	List `<Product>`	The list of products that require updating.

UpdateOrderResponse

Parameter Name	Type	Description	Mandatory (Y/N)
`DutiesAndTaxes`	Class DutiesAndTaxesResponse	Full duties and taxes information according to the cart details including the respective shipping option price

UpdateParcelDispatchRequest

Parameter Name	Type	Description	Mandatory (Y/N)
`OrderId`	String	Global‑e order unique identifier (previously submitted to the Merchant’s `SendOrderToMerchant` method when the order had been created with Global‑e checkout)
`Products`	List<OrderProduct>	List of parcels for this order’s shipment to the Global‑e hub

UpdateRMANumber

Parameter Name	Type	Description
`MerchantOrderId`	String	The Merchant order ID.
`MerchantRMANumber`	String	The Merchant return merchandise authorization number.
`OrderId`	String	The order ID.
`RMANumber`	String	The return merchandise authorization number.

UserDetails

Parameter Name	Type	Description	Mandatory (Y/N)
`Address1`	String	Address line 1	N
`Address2`	String	Address line 2	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	E-mail address	N
`Fax`	String	Fax	N
`FirstName`	String	First name	N
`FirstNameInLocalCulture`	String	First name in local culture Ex: Kana Japanese dialect	N
`LastName`	String	Last name	N
`LastNameInLocalCulture`	String	Last name in local culture Ex: Kana Japanese dialect	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
`StateOrProvice`	String	State or province name	N
`UserId`	String	Internal User identifier on the Merchant site	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

UserIdNumberType

Parameter Name	Type	Description	Mandatory (Y/N)
`Name`	String	Identification document type name
`UserIdNumberTypeCode`	String	Code denoting a user identification document type (e.g. Passport, ID card, etc.) on the Merchant’s site (to be mapped on the Global‑e side)

ValidateGiftCardRequest

Parameter Name	Type	Description
`CardFields`	Dictionary<String, String>	Key value pairs of each field defined in the configuration
`MerchantCartToken`	String	Identifier of the cart on the Merchant’s site originally specified in the `merchantCartToken` argument for the respective `SendCart` call
`MerchantGUID`	String	Merchant unique identifier
`ShippingCountryCode`	String	Code of country selected on checkout

ValidateGiftCardResponse

Parameter Name	Type	Description
`Balance`	Decimal	The available amount of money on a gift card
`CurrencyCode`	String	Code of card currency
`ErrorCode`	String	Code of the error
`ErrorText`	String	Error message
`IsGlobalEGiftCard`	Bool	Identifies if the gift card was bought from Global‑e. TRUE - Gift card was purchased from Global-e. FALSE - Gift card was not purchased from Global-e.
`IsValid`	Bool	The flag which approves that user entered the correct card data. TRUE - Card data is valid. FALSE - Card data is not valid.

VATCategory

Parameter Name	Type	Description	Mandatory (Y/N)
`Name`	String	VAT Category name
`VATCategoryCode`	String	Code used to identify the VAT category on the Merchant’s site (to be mapped on the Global‑e side)

VATCategoryCountry

Parameter Name	Type	Description	Mandatory (Y/N)
`CountryCode`	String	2-char ISO code of the shipping country
`VATCategoryCode`	String	Code used to identify the VAT category on the Merchant’s site (to be mapped on the Global‑e side)
`VATRateType`	Class VATRateType	Product VAT rate type or class to be used for the products related to this VAT Category in this shipping country, unless defined on `ProductCountry` level for the respective product. If `VATRateType` is not defined either on `ProductCountry` or on `VATCategoryCountry` levels, the respective country’s `DefaultVATRateType` must be used if applicable, according to the `UseCountryVAT` value for this country. Otherwise, the VAT rate defined for the respective products on the merchant’s site must be used	N

VATRateType

Parameter Name	Type	Description	Mandatory (Y/N)
`Name`	String	VAT rate type name	N
`Rate`	Decimal	VAT rate decimal value
`VATRateTypeCode`	String	VAT rate type (or class) code on the Merchant’s site (to be mapped on the Global-e side)

VerifyAddressResponseInfo

Parameter Name

Type

Description

Mandatory (Y/N)

IsAddressValid

Bool

Indicates if the address is valid. If the address is not valid, the order will not be accepted.

TRUE - Address is valid.

FALSE - Address is not valid.

SuggestedAddresses

List<CheckoutAddress>

List of optional address corrections to provide to the customer

VoidParcelRequest

Parameter Name	Type	Description	Mandatory (Y/N)
`DeliveryReferenceNumber`	String	Merchant’s internal Delivery Reference Number for this order. Either the `OrderID`, the `MerchantOrderID` or `DeliveryReferenceNumber` should be specified	Mandatory if `MerchantOrderID` and `OrderID` properties were not specified
`MerchantOrderId`	String	Order unique identifier on the Merchant’s site. Either the `OrderID`, the `MerchantOrderID` or `DeliveryReferenceNumber` should be specified	Mandatory if `OrderID` and `DeliveryReferenceNumber` properties were not specified
`OrderId`	String	Global‑e order unique identifier. Either the `OrderID`, the `MerchantOrderID` or `DeliveryReferenceNumber` should be specified	Mandatory if `MerchantOrderID` and `DeliveryReferenceNumber` properties were not specified
`ParcelCode`	String	The code used to identify the Parcel in an order on the Merchant’s site

VoidParselResponse

Parameter Name

Type

Description

Mandatory (Y/N)

IsSuccess

Bool

Indicates if the parcel was voided successfully.

TRUE - Parcel was voided successfully.

FALSE Parcel was not voided successfully.

List<ParcelError, class>

A list of the specified errors that occur while the request proceeds

WebStoreCodes

Parameter Name	Type	Description	Mandatory (Y/N)
`WebStoreCode`	String	The code of the merchant web store
`WebStoreInstanceCode`	String	The code of the instance of the web store

Would you like to provide feedback? Just click here to suggest edits.

Documentation Portal

AdditionalRequiredDocuments

AddressDetails

AlternativePaymentRedirectInfo

AppSetting

AppSettings

AppVersion

Attribute

billingDetails

Brand

CartCultureData

CartCurrencyData

CartFreeShippingData

CartInfo

CartLoyaltyData

CartOTVoucherData

CartPriceModificationData

CartUserDetails

CartVATRegistrationData

CartVoucherData

Category

Challenge3DSInfo

CheckoutAddress

CheckoutCardDetails

CheckoutCartInfo

CheckoutField

CheckoutInfo

CheckoutInfoGiftCard

CheckoutPaymentMethod

CheckoutShippingOption

CheckoutTaxInfo

City

Country

CountryCoefficient

CreateOrderFinalCustomerPayments

CreateSyncOrderData

Culture

Currency

CurrencyLocale

CurrencyRate

CustomerDetails

CustomProductAttribute

DeliveryAddress

DeliveryAdviceInformation

Discount

Discounts

discountsList

DTBreakdown

DutiesAndTaxesResponse

ErrorInfo

eSyncOrderType

FinalCustomerPayments

GetOrdersManifestRequest

GiftCardData

HubDetails

InitCheckoutResponse

InternationalDetails

KeyValuePair

LocationCulture

LoyaltyVoucher

MarketplaceData

Merchant.Brand

Merchant.CartAction

Merchant.CartProductAttribute

Merchant.CartValidationData [Inherits all fields from Merchant.OrderV2 - 3.123]

Merchant.CartVoucherValidation

Merchant.Category

Merchant.Customer

Merchant.CustomerDetails

Merchant.Discount

Merchant.DiscountVoucherValidation

Merchant.ExporterDetails

Merchant.ImporterDetails

Merchant.ImporterAddress

Merchant.InternationalDetails

Merchant.Order

Merchant.OrderRefund

Merchant.OrderRefundReason

Merchant.OrderTracking

Merchant.OrderV2 [inherits all fields from Merchant.Order - 3.64]