Skip to main content

Documentation Portal

CheckoutInfo

Parameter Name	Type	Description	Mandatory
`CartToken`	String	Unique identifier for the cart generated on the Global-e side. This identifier is required for additional checkout calls
`CheckoutFields`	List of `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 of `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`	Boolean	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 of `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 of `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 of `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.

CheckoutField

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

CheckoutPaymentMethod

Parameter Name	Type	Description	Mandatory
`Icon`	String	URL Full URL of the icon image for this payment method
`IsCard`	Boolean	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
`DeliveryDaysFrom`	Decimal	Minimum number of days for delivery to the end customer’s shipping country for this shipping option	No
`DeliveryDaysTo`	Decimal	Maximum number of delivery days to the end customer’s shipping country for this shipping option	No
`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`	Boolean	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.

Country

Parameter Name	Type	Description	Mandatory
`Code`	String	2-char ISO country code
`DefaultCurrencyCode`	String	3-char ISO currency code
`DefaultVATRateType`	Object `VATRateType`	Default (most widely used) VAT rate type or class for this country.	No
`IsOperatedByGlobalE`	Boolean	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`	Boolean	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`	Boolean	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.	No
`UseCountryVAT`	Boolean	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.	No

VATRateType

Parameter Name	Type	Description	Mandatory
`Name`	String	VAT rate type name	No
`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)

Product

Parameter Name	Type	Description	Mandatory
`Attributes`	List of `Attributes`	The product’s custom attributes (such as Color, Size, etc.)	No
`AttributesEnglish`	List of `Attributes`	The product’s custom attributes (such as Color, Size, etc.) in English	No
`BackOrderDate`	String	Estimated date for the backordered item to be in stock	No
`Brand`	Object `Brand`	The product’s brand	No
`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.	No
`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.	No
`Categories`	List of `Category`	The product’s categories	No
`DeliveryQuantity`	Decimal	The quantity actually set for delivery for the product (to be used in the Order methods described below, as needed)	No
`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.	No
`GiftMessage`	String	Optional “gift message” text defined by the end customer to be printed on the product.	No
`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.	No
`Height`	Decimal	The product’s height in the Merchant’s default unit of length measure (will be converted to CM).	No
`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.	No
`ImageHeight`	Decimal	The product’s image height in pixels	No
`ImageURL`	String	The product’s image URL	No
`ImageWidth`	Decimal	The product’s image width in pixels
`IsBackOrdered`	Boolean	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.	No
`IsBlockedForGlobalE`	Boolean	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	No
`IsBundle`	Boolean	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.	No
`IsFixedPrice`	Boolean	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.	No
`IsVirtual`	Boolean	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	No
`Keywords`	String	The product’s keywords	No
`Length`	Decimal	The product’s length in the Merchant’s default unit of length measure (will be converted to CM).	No
`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`.	No
`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`.	No
`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`	Object `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.	No
`MetaData`	Object `ProductMetaData`	Used to hold additional product data such as customer-defined product attributes.	No
`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.	No
`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.	No
`OrderedQuantity`	Decimal	Ordered quantity for the product (to be used in Checkout / Order methods described below, as needed)	No
`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.	No
`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.	No
`PriceCoefficientRate`	Decimal	Rate applicable to this Product’s`ProductClassCode` if returned from the `CountryCoefficients` method.	No
`ProductClassCode`	String	The product class code is used by the Merchant to classify products to use different country coefficient rates.	No
`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).	No
`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").	No
`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).	No
`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`.	No
`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”).	No
`URL`	String	The product’s information page URL	No
`VATCategory`	Object `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.	No
`VATRateType`	Object `VATRateType`	Product’s VAT rate type or class	No
`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.	No
`Width`	Decimal	The product’s width in the Merchant’s default unit of length measure (will be converted to CM).	No

Attributes

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

MetaData

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

Attributes

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

VATCategory

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

VATRateType

Parameter Name	Type	Description	Mandatory
`Name`	String	VAT rate type name	No
`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)

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