Storefront Configuration

This page describes the following elements:

Global-e Module Javascript

Below is a suggested way of loading the Bespoke JavaScript library asynchronously on your site: Integration Environment

<script id="globaleScript">
(function () {
var s = document.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = '//intgepi.bglobale.com/includes/js/{merchant id}';
document.getElementsByTagName('head')[0].appendChild(s);
})();
</script>

Production Environment

<script id="globaleScript">
(function () {
var s = document.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = '//gepi.global-e.com/includes/js/{merchant id}';
document.getElementsByTagName('head')[0].appendChild(s);
})();
</script>

The above snippets will ensure that the Bespoke JavaScript module will load asynchronously and not block your current page rendering.

Replace {merchant id} at the end of the URL with the merchant ID provided to you by Global-e.

The Global-e Module CSS

You must place the Bespoke CSS on your site’s header. The following example is the Bespoke CSS you must use in your Integration environment:

<link id="GEPIStyles" rel="stylesheet" href="//intgepi.bglobale.com/includes/css/{merchant id}" />

The following example is the Bespoke CSS you must use in your Production environment:

<link id="GEPIStyles" rel="stylesheet" href="//gepi.global-e.com/includes/css/{merchant id}" />

Replace {merchant id} at the end of the URL with the merchant ID that Global-e gave you.

Mandatory Developments

The following table shows the mandatory developments:

Feature	Description
Pricelist	You must be able to retrieve the country from the Global-e Module cookie to use the relevant pricelist on the front-end
My account currency conversion	The following parameters are required to correctly convert currencies in the My Account or My Orders sections: Customer ID: dedicated cookie Global-e order ID: in the Document Object Model (DOM) of the relevant pages in the section
Client analytics	See the GEM client snippet.
Google Shopping feed	See the Marketing Feeds and Tax/Shipping Rates.
Cookies	Global-e uses cookies in API requests between your client, our servers, and Centra. These cookies help identify the active cart and customer so that data stays consistent across the checkout flow: `token` – Identifies the shopping cart. It allows you to retrieve cart details on the client side (for showing prices on the cart page) and on the server side (when sending the cart to checkout). `Customer_id` – Identifies the logged-in customer. It is used on the My Account page to fetch their past orders and to display prices based on the international rates they paid. Bothcookies should match the cart and customer identifiers stored in Centra. You can store them as one combined cookie or as two separate cookies, depending on your implementation. The cookie must follow this structure so Global-e can extract the token and customer_id: `ge_frontend_data = {“token”:”asfd444ggv44677870jhv”,”customer_id”:”123456”}` Requirements: The cookie must be classified as Essential. The cookie must not be set as httpOnly (Global-e’s client-side scripts need to read it).

Browsing

This section describes Centra’s browsing elements.

Global-e Browsing Elements

Global-e supports the following browsing elements:

Welcome pop-up
Country switcher
Free shipping banner

For more information, see Site Customization.

Global-e Storefront Attributes

The Global-e storefront attributes are described on the Storefront Attributes page.

Calculating Prices

Global-e supports calculating both dynamic prices and fixed prices. Dynamic price calculations are based on pricelists created by merchants using Centra’s back-office. You must use this set of configurations to properly support price conversions:

All Global-e markets must be assigned to a pricelist. Global-e automatically assigns Centra’s default pricelist for unassigned markets.
All pricelists used for Global-e markets must be set in your base currency.

Fixed price calculations are supported per country and is based on Centra’s native pricelist creation. You must follow these rules when setting their fixed prices:

Each country’s fixed prices must be set with its respective currency as configured by Global-e.
The geolocation must be set according to the country’s fixed prices.
All fixed prices must be set on the country’s catalog.

Products

Product Restrictions

As with other Global-e Module (GEM) integrations, we support merchants restricting purchases of checkout items to specific countries based on regulations or commercial restrictions. We support restrictions at the Checkout level. For more information on product restrictions, see. Restricted Products

Pre-Ordering Items

You can sell pre-order items if needed, and can enable them by selecting the stock section checkbox for the required item. Merchants must pass the pre-order attribute indication for the relevant products. Note the following:

We do not validate stock in the order stock validation phase for items identified as pre-order.
Items identified as pre-order must be marked in Centra as PreOrder. Items not marked as PreOrder will be a Failed Transfer to Merchant (FTM). Merchants must mark pre-order items in both Global-e and Centra.

Product Attributes

Global-e supports the following product attributes:

Product name
HS code
Country of origin
Weight
Brand
Description

We do not support custom fields.

Cart

Sending Language to Checkout

Global-e supports sending language to Checkout with GEM capabilities. For more information, see Global-e Checkout Language.

Clearing Your Cart

Global-e supports clearing your cart with GEM capabilities. For more information, see Clearing your Cart.

Applying Discounts

Centra supports several discount types that may include multiple rules and dependencies. You can specify these conditions while creating both vouchers and campaigns.

Calculating Cart Prices

The GetCheckoutCartInfo API retrieves cart information for international checkout processing. This API:

Is triggered when the cart page loads or when a checkout attempt is made
Only returns products that are in stock
Requires proper cart token validation
Is part of Global-e’s extensions (custom integration only)

This method is called from a Global-e server with the cart token rendered in a cookie or HTML.DOM. The client’s session calculates the price totals. The GetCheckoutCartInfo API returns all cart contents, including customer information for logged-in customers This API only returns products that are in stock. If special handling is required for stock validation on your side, for products in the basket (for example, calls to an external system), Global-e can specify an additional URL for this method, to indicate that stock validation is specifically required. If the cart data is unavailable, the checkout will not open and an error message will appear in the browser development console. The GetCheckoutCartInfo API is only triggered upon the cart page loading, or when a checkout attempt is made.

This API is part of Global-e’s extensions and plug-ins. Merchants do not need to implement this API unless a custom integration in required.

Displays totals on the basket page
Opens the checkout process
Validates order (SendOrderToMerchant)
Client-side: Session and Cart token (present in the request URL parameters)
Additional methods available with POST only:
- OrderID - In the request payload
- Merchant GUID - In request payload (required)

None. The GetCheckoutCartInfo API is only triggered upon the cart page loading, or when a checkout attempt is made. If the GetCheckoutCartInfo request fails to execute on the cart page, the international cart totals will not be calculated or displayed there. If the GetCheckoutCartInfo request fails on the checkout, the checkout will not open. Method/URL Client-side: GET

GET https://www.merchant-site-domain.com/get-checkout-cart-info-url
POST https://www.merchant-site-domain.com/get-checkout-cart-info-url

Parameters

Request Requests can contain more parameters than listed.

Name	Type	Description	Mandatory
`countryCode`	String	2-char ISO code for the country to which shipped	No
`currencyCode`	String	3-char currency code for the country to which shipped	No
`merchantCartToken`	String	Identifier used for the cart by the Merchant’s site	No

Response Returns all cart contents, including customer information for logged-in customers.

Some values are encoded and require the merchant to decode them, for example URLs, addresses, emails, and phone numbers.

Name	Type	Description
`CheckoutCartInfo`	Object `CheckoutCartInfo`	Retrieves cart information

CheckoutCartInfo

Parameter Name	Type	Description	Mandatory	GEM Only
`allowMailsFromMerchant`	Boolean	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.	No	Yes
`billingDetails`	Object `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.	No
`clientIP`	String	The end customer’s IP address	No
`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.	No
`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.	No
`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.	No
`discountList`	List of `Discounts`	List of JSON-serialized Discounts to be applied to the cart. Discounts of any type (“cart”, “shipping”, etc.) may be specified.	No
`doNotChargeVAT`	Boolean	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.	No
`freeShippingCouponCode`	nvarchar	Merchant’s free shipping coupon code applied by the end customer.Max length: 50.	No
`hubID`	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.	No
`IncludeVAT`	Decimal	Optional for the merchants not supporting browsing integration. The value is returned from CountryCoefficients API.	No
`isFreeShipping`	Boolean	Indicates if the Merchant offers free international shipping to the end customer.	No
`loyaltyCode`	String	The loyalty code specified by the end customer (or read from the end customer’s account) on the Merchant’s site.	No
`LoyaltyPoints`	Object `LoyaltyPoints`	LoyaltyPoints contains data about the registered user for applying loyalty points on the Checkout page.	No
`loyaltyPointsEarned`	Decimal	The number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site.	No
`loyaltyPointsSpent`	Decimal	The number of loyalty points to be spent for this purchase by the end customer on the Merchant’s site.	No
`loyaltyPointsTotal`	Decimal	The total number of loyalty points currently available in the end customer’s user account on the Merchant’s site.	No
`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.	No
`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.	No	Yes
`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.	No
`otVoucherAmount`	Decimal	Amount of the one-time voucher in `otVoucherCurrencyCode` currency.	No
`otVoucherCode`	String	One-time voucher code for the cart (for applicable platforms).	No
`otVoucherCurrencyCode`	String	One-time voucher currency used for the amount.	No
`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).	No
`productsList`	List of `Product`	List of Product objects (specified in the request body)	Yes
`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 GetCheckoutCartInfoAPI response
`shippingDetails`	Object `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.	No
`shippingOptionsList`	List of `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`.	No
`urlParameters`	List of `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 SendOrderToMerchantcall 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.	No
`userDetails`	Object `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.	No
`vatRegistrationNumber`	String	VAT Registration Number of the end customer’s business entity validated with the merchant.	No	Yes
`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	No
`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.	No	Yes

CartUserDetails

Parameter Name	Type	Description	Mandatory
`AddressDetails`	List of `AddressDetails`	All available addresses are taken from the registered customer address book	No
`UserId`	String	Internal User identifier on the Merchant’s site	No

AddressDetails

Parameter Name	Type	Description	Mandatory	GEM Only
`Address1`	String	Address line 1.	No	Yes
`Address2`	String	Address line 2.	No	Yes
`AddressBookId`	String	Id of the current address from within the address book	No
`AddressBookName`	String	Name of the current address from within the address book	No
`City`	String	City name.	No	Yes
`Company`	String	Company name	No	Yes
`CountryCode`	String	2-char ISO country code	No	Yes
`Email`	String	E-mail address	No
`Fax`	String	Fax	No
`FirstName`	String	First name	No
`FirstNameInLocalCulture`	String	First name in local culture	No
`IsBilling`	Boolean	Indicates that the current address can be used as a billing address	No
`IsDefaultBilling`	Boolean	Indicates that the current address is the default billing address	No
`IsDefaultShipping`	Boolean	Indicates that the current address is the default shipping address	No
`IsShipping`	Boolean	Indicates that the current address can be used as a shipping address	No
`LastName`	String	Last name	No
`LastNameInLocalCulture`	String	Last name in local culture	No
`MiddleName`	String	Middle name	No
`Phone1`	String	Phone #1	No
`Phone2`	String	Phone #2	No
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.).	No
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)	No	Yes
`StateOrProvince`	String	State or province name	No
`UserIdNumber`	String	User’s personal ID document number	No
`UserIdNumberType`	Object `UserIdNumberType`	User’s personal ID document type (e.g. Passport, ID card, etc.)	No
`Zip`	String	Zip or postal code	No	Yes

UserIdNumberType

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

Discounts

Parameter Name	Type	Description	Mandatory
`CouponCode`	String	Merchant Coupon Code used for this discount (applicable to coupon-based discounts only).Max length: 100 chars.	No
`Description`	String	Discount textual description.Length: Unlimited.	No
`DiscountType`	Integer	One of the following possible values of `DiscountTypeOptions`enumeration denoting a type of discount: Cart discount - 1 Shipping discount - 2 Loyalty points discount - 3 Duties discount - 4 Checkout Loyalty points discount - 5 Payment charge - 6	No
`DiscountValue`	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.	No
`Name`	String	Discount name.Length: Unlimited.	No
`OriginalDiscountValue`	Decimal	Discount value in the currency defined in the `CurrencyCode`; property of the `Merchant.Order`; object for the order being submitted to the Merchant.	Yes
`VATRate`	Decimal	The VAT rate applied to this discount	No (Required for merchants whose base country has VAT. If not specified, will default to 0.)
`ProductCartItemId`	String	For product level discount, match the unique CartItemId line identifier of the respective product in the productList. For cart level discounts, leave this field blank or null.	No
`CalculationMode`	Integer	The mode of calculation: 1 - value in base currency while maintaining ratio to domestic discount 2 - fixed amount in base currency 3 - fixed amount in shopper currency (used for fixed price markets only)	Yes

KeyValuePair

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

LoyaltyPoints

Parameter Name	Type	Description	Mandatory
`LoyaltyPointsMaxSpend`	Decimal	The limit loyalty points that the user can use in this order – if not exists the `LoyaltyPointsTotal` is taken.	No
`LoyaltyPointsOriginalValueForEarn`	Decimal	Value of one loyalty point for earn, in Merchant currency – optional if `LoyaltyPointsOriginalForEarn` exists.	No
`LoyaltyPointsOriginalValueForSpend`	Decimal	Value of one loyalty point for spending, in Merchant currency – optional if `LoyaltyPointsValueForSpend` exists.	No
`LoyaltyPointsTotal`	Decimal	The total loyalty points the user has on account at the Merchant’s site	No
`LoyaltyPointsValueForEarn`	Decimal	Value of one loyalty point for earn, in customer currency – optional if `LoyaltyPointsOriginalValueForEarn` exists.	No
`LoyaltyPointsValueForSpend`	Decimal	Value of one loyalty point for spending, in customer currency – optional if `LoyaltyPointsOriginalValueForSpend` exists.	No

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 orderedFALSE - 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 shippingFALSE - 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 checkoutTRUE - The product represents a virtual productFALSE - 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
`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

Brand

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

Parameter Name	Type	Description	Mandatory
`CategoryCode`	String	Category code on the Merchant site (to be mapped on the Global‑e side)
`Name`	String	Category 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
`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)

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

UserDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1	No
`Address2`	String	Address line 2	No
`City`	String	City name	No
`Company`	String	Company name	No
`CountryCode`	String	2-char ISO country code	No
`CountryName`	String	Country name	No
`Email`	String	E-mail address	No
`Fax`	String	Fax	No
`FirstName`	String	First name	No
`FirstNameInLocalCulture`	String	First name in local culture Ex: Kana Japanese dialect	No
`LastName`	String	Last name	No
`LastNameInLocalCulture`	String	Last name in local culture Ex: Kana Japanese dialect	No
`MiddleName`	String	Middle name	No
`Phone1`	String	Phone #1	No
`Phone2`	String	Phone #2	No
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.)	No
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)	No
`StateOrProvice`	String	State or province name	No
`UserId`	String	Internal User identifier on the Merchant site	No
`UserIdNumber`	String	User’s personal ID document number	No
`UserIdNumberType`	Object `UserIdNumberType`	User’s personal ID document type (e.g. Passport, ID card, etc.)	No
`Zip`	String	Zip or postal code	No

UserIdNumberType

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

Examples

Response contains CheckoutCartInfo class

{
    "productsList": [{
            "ProductCode": "9632261340000",
            "ProductGroupCode": "9632261_c340000",
            "CartItemId": "6601",
            "ParentCartItemId": "",
            "CartItemOptionId": "",
            "Name": "name of product",
            "Description": "product description",
            "Keywords": "product keywords",
            "URL ": "product page url",
            "GenericHSCode ": "",
            "OriginCountryCode": "CHN",
            "Weight": 0.0,
            "Height": 0,
            "Width": 0,
            "Length": 0,
            "Volume": 0,
            "ImageURL": "",
            "ImageHeight": 533,
            "ImageWidth": 414,
            "IsFixedPrice": "true",
            "ListPrice": null,
            "OriginalListPrice": 20.0000,
            "SalePrice": 0.0,
            "SalePriceBeforeRounding": 0.0,
            "OriginalSalePrice": 20.0000,
            "OrderedQuantity": 2,
            "DeliveryQuantity": 2,
            "IsBlockedForGlobalE": false,
            "VATRateType": "",
            "LocalVATRateType": "",
            "Brand": {
                "BrandCode": "7",
                "Name": "Brand2"
            },
            "Categories": null,
            "Attributes": [{
                    "AttributeCode": "26",
                    "Name": "26",
                    "AttributeTypeCode": "size"
                }, {
                    "AttributeCode": "Geranium Red/Cut Out",
                    "Name": "Geranium Red/Cut Out",
                    "AttributeTypeCode": "color"
                }
            ],
        }
    ],
    "shippingDetails": {
        "UserId": "",
        "UserIdNumber": "",
        "UserIdNumberType": {
            "UserIdNumberTypeCode": null,
            "Name": "Shipping"
        },
        "FirstName": "",
        "LastName": "",
        "MiddleName": "",
        "Salutation": "",
        "Phone1": "",
        "Phone2": "",
        "Fax": "",
        "Email": "",
        "Address1": "",
        "Address2": "",
        "City": "",
        "StateOrProvince": "",
        "StateCode": "",
        "Zip": "",
        "CountryCode": "",
        "CountryName": ""
    },
    "billingDetails": {
        "UserId": "",
        "UserIdNumber": "",
        "UserIdNumberType": {
            "UserIdNumberTypeCode": null,
            "Name": "Billing"
        },
        "FirstName": "",
        "LastName": "",
        "MiddleName": "",
        "Salutation": "",
        "Phone1": "",
        "Phone2": "",
        "Fax": "",
        "Email": "",
        "Address1": "",
        "Address2": "",
        "City": "",
        "StateOrProvince": "",
        "StateCode": "",
        "Zip": "",
        "CountryCode": "",
        "CountryName": ""
    },
    "discountsList": [{
            "OriginalDiscountValue": 10.0000,
            "DiscountType": "percentage",
            "Name": "discount name",
            "Description": "",
            "DiscountCode": null,
            "ProductCartItemId": 6601,
            "CouponCode": null
        }
    ]
}

{
    "productsList": [{
            "CartItemId": "676106",
            "ProductCode": "676106",
            "ProductGroupCode": "CS16577",
            "Name": "+Warmers",
            "Description": "Product List Description",
            "IsFixedPrice": false,
            "IsBlockedForGlobalE": false,
            "OrderedQuantity": 1,
            "URL": "https://www.mystore.co.uk/product/[myproduct]",
            "Volume": 0.12,
            "Weight": 0.08,
            "LocalVATRateType": {
                "VATRateTypeCode": "NORMAL",
                "Rate": 0
            },
            "OriginalSalePrice": 29.17,
            "Categories": [{
                    "CategoryCode": 161,
                    "Name": "Cycle Clothing > Armwarmers"
                }, {
                    "CategoryCode": "WORLDWIDE",
                    "Name": "WORLDWIDE"
                }
            ],
            "Attributes": [{
                    "AttributeTypeCode": "colour_or_flavour",
                    "AttributeCode": 2,
                    "Name": "Black"
                }, {
                    "AttributeTypeCode": "size",
                    "AttributeCode": 869,
                    "Name": "M"
                }
            ],
            "OriginalListPrice": 35,
            "ImageURL": "https://www.mystore.co.uk/product-media/[myproductimpage.jpg]",
            "ImageHeight": 145,
            "ImageWidth": 145,
            "Brand": {
                "BrandCode": 38,
                "Name": "Castelli"
            },
            "SalePrice": 0,
            "ListPrice": 0,
            "ProductClassCode": "expensive_warmers"
        }, {
            "CartItemId": "678197",
            "ProductCode": "678197",
            "ProductGroupCode": "7MESH-1507",
            "Name": "Resistance Jacket",
            "Description": "With its ...... short or long sleeve.",
            "IsFixedPrice": false,
            "IsBlockedForGlobalE": false,
            "OrderedQuantity": 1,
            "URL": "https:\/\/www.mysite.co.uk\/item\/7Mesh\/Jacket\/EAM",
            "Volume": 1,
            "Weight": 0.115,
            "LocalVATRateType": {
                "VATRateTypeCode": "NORMAL",
                "Rate": 20
            },
            "OriginalSalePrice": 150,
            "Categories": [{
                    "CategoryCode": 151,
                    "Name": "Cycle Clothing > Jacket Wind"
                }, {
                    "CategoryCode": "WORLDWIDE",
                    "Name": "WORLDWIDE"
                }
            ],
            "Attributes": [{
                    "AttributeTypeCode": "colour_or_flavour",
                    "AttributeCode": 3,
                    "Name": "Blue"
                }, {
                    "AttributeTypeCode": "size",
                    "AttributeCode": 367,
                    "Name": "M"
                }
            ],
            "OriginalListPrice": 180,
            "ImageURL": "https:\/\/dbyvw4efi.cloudfront.net\Jacket-blue.jpg",
            "ImageHeight": 145,
            "ImageWidth": 145,
            "Brand": {
                "BrandCode": 705,
                "Name": "7Mesh"
            },
            "SalePrice": 0,
            "ListPrice": 0
        }
    ],
    "discountsList": [{
            "OriginalDiscountValue": 3.398,
            "DiscountType": null,
            "Name": "GLOBALE20",
            "Description": null,
            "DiscountCode": "GLOBALE20",
            "ProductCartItemId": null,
            "CouponCode": "GLOBALE20",
            "CalculationMode": 1,
            "DiscountValue": 0
        }
    ],
    "billingDetails": {
        "UserId": "1144404",
        "Email": "john.doe@global-e.com",
        "Salutation": "",
        "FirstName": "john",
        "LastName": "doe",
        "Address1": "basel 25",
        "Address2": "",
        "City": "petah tikva",
        "StateOrProvince": "",
        "Zip": "11223344",
        "CountryCode": "ISR",
        "CountryName": "Israel",
        "Phone1": "0000000000",
        "Phone2": ""
    },
    "shippingDetails": {
        "UserId": "1144404",
        "Email": "john.doe@global-e.com",
        "Salutation": "",
        "FirstName": "john",
        "LastName": "winer",
        "Address1": "basel 25",
        "Address2": "",
        "City": "petah tikva",
        "StateOrProvince": "",
        "Zip": "11223344",
        "CountryCode": "ISR",
        "CountryName": "Israel",
        "Phone1": "0000000000",
        "Phone2": ""
    }
}

{
    "productsList": [{
            "CartItemId": "676106",
            "ProductCode": "676106",
            "ProductGroupCode": "CS16577",
            "Name": "N+ Warmers",
            "Description": "The Warmers .... and water resistance.",
            "IsFixedPrice": true,
            "IsBlockedForGlobalE": false,
            "OrderedQuantity": 1,
            "URL": "https:\/\/www.mysite.co.uk\/Warmers\/HOG",
            "Volume": 0.12,
            "Weight": 0.08,
            "LocalVATRateType": {
                "VATRateTypeCode": "NORMAL",
                "Rate": 20
            },
            "OriginalSalePrice": 0,
            "VATRateType": {
                "VATRateTypeCode": "vat10.5",
                "Rate": 10.5
            },
            "Categories": [{
                    "CategoryCode": 161,
                    "Name": "Cycle Clothing > Warmers"
                }, {
                    "CategoryCode": "WORLDWIDE",
                    "Name": "WORLDWIDE"
                }
            ],
            "Attributes": [{
                    "AttributeTypeCode": "colour_or_flavour",
                    "AttributeCode": 2,
                    "Name": "Black"
                }, {
                    "AttributeTypeCode": "size",
                    "AttributeCode": 869,
                    "Name": "M"
                }
            ],
            "OriginalListPrice": 0,
            "ImageURL": "https:\/\/offpi.cloudfront.net\/Warmer.jpg",
            "ImageHeight": 145,
            "ImageWidth": 145,
            "Brand": {
                "BrandCode": 38,
                "Name": "BandNamei"
            },
            "SalePrice": 120,
            "ListPrice": 120,
            "ProductClassCode": "expensive_warmers"
        }, {
            "CartItemId": "678197",
            "ProductCode": "678197",
            "ProductGroupCode": "7MESH-1507",
            "Name": "Resistance Jacket",
            "Description": "With its .... your short or long sleeves.",
            "IsFixedPrice": true,
            "IsBlockedForGlobalE": false,
            "OrderedQuantity": 1,
            "URL": "https:\/\/www.mysite.co.uk\/Jacket\/JAM",
            "Volume": 1,
            "Weight": 0.115,
            "LocalVATRateType": {
                "VATRateTypeCode": "NORMAL",
                "Rate": 20
            },
            "OriginalSalePrice": 0,
            "Categories": [{
                    "CategoryCode": 151,
                    "Name": "Cycle Clothing > Jacket Wind"
                }, {
                    "CategoryCode": "WORLDWIDE",
                    "Name": "WORLDWIDE"
                }
            ],
            "Attributes": [{
                    "AttributeTypeCode": "colour_or_flavour",
                    "AttributeCode": 3,
                    "Name": "Blue"
                }, {
                    "AttributeTypeCode": "size",
                    "AttributeCode": 367,
                    "Name": "M"
                }
            ],
            "OriginalListPrice": 0,
            "ImageURL": "https:\/\/offpi.cloudfront.net\/Jacket-blue.jpg",
            "ImageHeight": 145,
            "ImageWidth": 145,
            "Brand": {
                "BrandCode": 705,
                "Name": "Mesh"
            },
            "SalePrice": 180,
            "ListPrice": 150
        }
    ],
    "discountsList": [{
            "OriginalDiscountValue": 0,
            "DiscountType": null,
            "Name": "GLOBALE20",
            "Description": null,
            "DiscountCode": "GLOBALE20",
            "ProductCartItemId": null,
            "CouponCode": "GLOBALE20",
            "CalculationMode": 3,
            "DiscountValue": 50
        }
    ],
    "billingDetails": {
        "UserId": "1144404",
        "Email": "john.doe@global-e.com",
        "Salutation": "",
        "FirstName": "john",
        "LastName": "doe",
        "Address1": "basel 25",
        "Address2": "",
        "City": "petah tikva",
        "StateOrProvince": "",
        "Zip": "11223344",
        "CountryCode": "ISR",
        "CountryName": "Israel",
        "Phone1": "0000000000",
        "Phone2": ""
    },
    "shippingDetails": {
        "UserId": "1144404",
        "Email": "john.doe@global-e.com",
        "Salutation": "",
        "FirstName": "john",
        "LastName": "doe",
        "Address1": "basel 25",
        "Address2": "",
        "City": "petah tikva",
        "StateOrProvince": "",
        "Zip": "11223344",
        "CountryCode": "ISR",
        "CountryName": "Israel",
        "Phone1": "0000000000",
        "Phone2": ""
    }
}

{
    "productsList": [{
            "CartItemId": "676106",
            "ProductCode": "676106",
            "ProductGroupCode": "CS16577",
            "Name": "N+ Warmers",
            "Description": "The <a href=\"https:\/\/www.mysite.co.uk\/brand\/... and water resistance.",
            "IsFixedPrice": true,
            "IsBlockedForGlobalE": false,
            "OrderedQuantity": 1,
            "URL": "https:\/\/www.mysite.co.uk\/item\/Warmers\/HOG",
            "Volume": 0.12,
            "Weight": 0.08,
            "LocalVATRateType": {
                "VATRateTypeCode": "NORMAL",
                "Rate": 21
            },
            "OriginalSalePrice": 0,
            "Categories": [{
                    "CategoryCode": 161,
                    "Name": "Cycle Clothing > Warmers"
                }, {
                    "CategoryCode": "WORLDWIDE",
                    "Name": "WORLDWIDE"
                }
            ],
            "Attributes": [{
                    "AttributeTypeCode": "colour_or_flavour",
                    "AttributeCode": 2,
                    "Name": "Black"
                }, {
                    "AttributeTypeCode": "size",
                    "AttributeCode": 869,
                    "Name": "M"
                }
            ],
            "MetaData": {
                "Attributes": [{
                        "AttributeKey": "Name",
                        "AttributeValue": "Alex"
                    }
                ]
            },
            "OriginalListPrice": 0,
            "ImageURL": "https:\/\/offpi.cloudfront.net\/Warmer.jpg",
            "ImageHeight": 145,
            "ImageWidth": 145,
            "Brand": {
                "BrandCode": 38,
                "Name": "BrandName"
            },
            "SalePrice": 50,
            "ListPrice": 123,
            "ProductClassCode": "expensive_warmers"
        }, {
            "CartItemId": "678197",
            "ProductCode": "678197",
            "ProductGroupCode": "7MESH-1507",
            "Name": "Resistance Jacket",
            "Description": "With its ... your short or long sleeve.",
            "IsFixedPrice": false,
            "IsBlockedForGlobalE": false,
            "OrderedQuantity": 1,
            "URL": "https:\/\/www.mysite.co.uk\/Jacket\/JAM",
            "Volume": 1,
            "Weight": 0.115,
            "LocalVATRateType": {
                "VATRateTypeCode": "NORMAL",
                "Rate": 20
            },
            "OriginalSalePrice": 150,
            "Categories": [{
                    "CategoryCode": 151,
                    "Name": "Cycle Clothing > Jacket"
                }, {
                    "CategoryCode": "WORLDWIDE",
                    "Name": "WORLDWIDE"
                }
            ],
            "Attributes": [{
                    "AttributeTypeCode": "colour_or_flavour",
                    "AttributeCode": 3,
                    "Name": "Blue"
                }, {
                    "AttributeTypeCode": "size",
                    "AttributeCode": 367,
                    "Name": "M"
                }
            ],
            "OriginalListPrice": 180,
            "ImageURL": "https:\/\/offpi.cloudfront.net\/Jacket-blue.jpg",
            "ImageHeight": 145,
            "ImageWidth": 145,
            "Brand": {
                "BrandCode": 705,
                "Name": "Mesh"
            },
            "SalePrice": 0,
            "ListPrice": 0
        }
    ],
    "discountsList": [{
            "OriginalDiscountValue": 0,
            "DiscountType": null,
            "Name": "GLOBALE20",
            "Description": null,
            "DiscountCode": "GLOBALE20",
            "ProductCartItemId": "676106",
            "CouponCode": "GLOBALE20",
            "CalculationMode": 3,
            "DiscountValue": 3.398
        }
    ],
    "userDetails": {
        "UserId": "1144404",
        "AddressDetails": [{
                "Email": "john.doe@global-e.com",
                "Salutation": "",
                "FirstName": "john",
                "LastName": "doe",
                "Address1": "basel 25",
                "Address2": "",
                "City": "petah tikva",
                "StateOrProvince": "",
                "Zip": "11223344",
                "CountryCode": "IL",
                "CountryName": "Israel",
                "Phone1": "0000000000",
                "Phone2": "",
                "IsShipping": true,
                "IsBilling": false,
                "IsDefaultShipping": true,
                "IsDefaultBilling": false,
                "AddressBookId": 111
            }, {
                "Email": "john.doe@global-e.com",
                "Salutation": "",
                "FirstName": "john",
                "LastName": "doe",
                "Address1": "basel 25",
                "Address2": "",
                "City": "petah tikva",
                "StateOrProvince": "",
                "Zip": "11223344",
                "CountryCode": "IL",
                "CountryName": "Israel",
                "Phone1": "0000000000",
                "Phone2": "",
                "IsShipping": false,
                "IsBilling": true,
                "IsDefaultShipping": false,
                "IsDefaultBilling": true,
                "AddressBookId": 222
            }, {
                "Email": "john.doe@global-e.com",
                "Salutation": "",
                "FirstName": "john",
                "LastName": "doe3",
                "Address1": "basel 253",
                "Address2": "",
                "City": "petah tikva",
                "StateOrProvince": "",
                "Zip": "11223344",
                "CountryCode": "IL",
                "CountryName": "Israel",
                "Phone1": "0000000000",
                "Phone2": "",
                "IsShipping": true,
                "IsBilling": true,
                "IsDefaultShipping": false,
                "IsDefaultBilling": false,
                "AddressBookId": 333
            }
        ]
    },
    "allowMailsFromMerchant": true
}

Checkout

Stock Validation

When you place an order in Checkout, the Global-e plug-in runs a stock validation based on Centra’s stock to see if the item is available. This process does not occur for pre-order items.

Discounts

The supported discount types described in Applying Discounts apply to the Checkout capabilities as well. Only voucher code discounts are available, and consumers use these codes during Checkout, and discounts are applied when the checkout is complete.