Checkout Methods

Note

These methods are implemented by the Global-e extensions and plug-ins and do not need to be implemented by the brand.

SendCartV2

The method sends the end customer’s cart contents from the Merchant’s site to Global-e and returns a unique Cart Token to be further passed by the Merchant’s site to the Global-e checkout widget or to API checkout methods.

Method/URL

POST https://connect.bglobale.com/Checkout/SendCartV2

Parameters

Request

Name	Type	Description	Mandatory (Y/N)
`SendCartData`	Object `SendCartData`	Details about the end customer’s cart contents from the Merchant’s site. Includes user details, product details, discount details, conversion information, vouchers, and any other information required for cart creation	Y

Object SendCartData

Parameter Name	Type	Description	Mandatory
`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.	No
`CartCurrencyData`	Object `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.	No
`CartPriceModificationData`	Object `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.	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 the `shippingDetails.CountryCode` property denoting the registered user’s country defined below.
`Culture`	Object `Culture`	Cart culture data	No
`DeliveryType`	String	Indicates type of delivery.
`Discounts`	List of `Discount`	List of Discounts to be applied to the cart. Discounts of any type (“cart”, “shipping”, etc.) may be specified.
`FreeShipping`	Object `CartFreeShippingData`	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).
`HubCountryCode`	String	The 2-character ISO country code representing the country to which this hub belongs.
`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.	No
`LocalShippingOptions`	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 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`	Object `CartLoyaltyData`	Holds information for Merchant-side loyalty points to be applied.
`LoyaltyPoints`	Object `LoyaltyPoints`	Holds information on the registered user to apply loyalty points on the checkout page.	No
`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.
`MerchantPriceForDuties`	String	The amended Merchant's price for duties. Can be used to declare a value for a free item for customs purposes. Note: Either `MerchantPriceForDuties` or `OriginalMerchantPriceForDuties` or both can be provided. Used by SendCartV2 API.
`Name`	String	Name of the Product. Min length: 1 char. No length limit.
`OriginalMerchantPriceForDuties`	String	The original Merchant's price for duties. Can be used to declare a value for a free item for customs purposes. Note: Either `MerchantPriceForDuties` or `OriginalMerchantPriceForDuties` or both can be provided. Used by SendCartV2 API.
`PaymentInstallments`	List of Decimal	List of available payment instalment amounts.
`PriceModification`	Class	Cart price modification data	Optional for Merchants not supporting browsing integration
`Products`	List of `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.
`ShipToStoreCode`	String	Indicates the ship-to-shop code.
`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`	Object `CartUserDetails`	All available details of the user including all relevant addresses.
`VATRegistration`	Object `CartVATRegistrationData`	Holds information required for VAT exemption within the EU.
`VoucherData`	Object `CartVoucherData`	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.	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

Object CartCurrencyData

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

Object CartFreeShippingData

Parameter Name	Name	Name	Mandatory
`FreeShippingCouponCode`	String	Merchant’s free shipping `CouponCode` applied by the end customer	No
`IsFreeShipping`	Boolean	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.	No

Parameter Name

Name

Mandatory

FreeShippingCouponCode

String

Merchant’s free shipping CouponCode applied by the end customer

IsFreeShipping

Boolean

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.

Object CartLoyaltyData

Parameter Name	Type	Description	Mandatory
`LoyaltyCode`	String	Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout	No
`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.	No
`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).	No
`LoyaltyPointsTotal`	Decimal	The total number of loyalty points currently available in the end customer’s user account on the Merchant’s site.	No

Object CartPriceModificationData

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

Object 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

Object AddressDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1.	No
`Address2`	String	Address line 2.	No
`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
`Company`	String	Company name	No
`CountryCode`	String	2-char ISO country code	No
`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
`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

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

Object CartVATRegistrationData

Parameter Name	Type	Description	Mandatory
`DoNotChargeVAT`	Boolean	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.	No
`VatRegistrationNumber`	String	VAT Registration Number of the end customer’s business entity validated with the merchant	No

Parameter Name

Type

Description

Mandatory

DoNotChargeVAT

Boolean

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

Object CartVoucherData

Parameter Name	Type	Description	Mandatory
`LoyaltyVouchers`	List of `LoyaltyVoucher`	List of available loyalty vouchers for the registered customer	No
`OTVoucher`	Object `CartOTVoucherData`	One-time voucher information	No

Object CartOTVoucherData

Parameter Name	Type	Description	Mandatory
`OTVoucherAmount`	String	Amount of the one-time voucher in `OTVoucherCurrencyCode` currency	No
`OTVoucherCode`	Decimal	One-time voucher code for the cart (for applicable platforms)	No
`OTVoucherCurrencyCode`	Decimal	One-time voucher currency used for the amount	No

Object LoyaltyVoucher

Parameter Name	Type	Description	Mandatory
`Description`	String	Loyalty Voucher’s textual description	No
`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`	Boolean	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.	No
`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

Object Culture

Parameter Name	Type	Description
`Code`	String	ISO culture code
`IsRTL`	Boolean	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

Object Discount

Parameter Name	Type	Description	Mandatory
`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.	No
`CouponCode`	String	Merchant Coupon Code used for this discount (applicable to coupon-based discounts only)	No
`Description`	String	Discount textual description	No
`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.	No
`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.	No
`LoyaltyVoucherCode`	String	Code used on the Merchant’s site to identify the Loyalty Voucher that this discount is based on	No
`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.	No
`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).

Object 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

Object 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

Object 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

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

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

Object 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

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

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

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

Response Parameters

Name	Type	Description
`cartInfo`	Object `CartInfo`	Contains details about the end customer's cart.

Object CartInfo

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

Examples

Request

{
    "CountryCode": "AU",
    "ClientIP": "128.128.128.128",
    "Currency": {
        "OriginalCurrencyCode": "GBP",
        "CurrencyCode": "AUD"
    },
    "PriceModification": {
        "RoundingRuleId": 103,
        "PriceCoefficientRate": 1,
        "IncludeVAT": null
    },
    "Culture": {
        "PreferedCultureCode": null,
        "InputDataCultureCode": null,
        "CultureCode": "en-GB"
    },
    "LocalShippingOptions": [{
            "Carrier": "globaleintegration_standard",
            "CarrierTitle": "globaleintegration_standard",
            "CarrierName": "globaleintegration_standard",
            "Code": "globaleintegration_standard",
            "Method": "globaleintegration_standard",
            "MethodTitle": "globaleintegration_standard",
            "MethodDescription": "globaleintegration_standard",
            "Price": 0,
            "IsPreferred": true
        }
    ],
    "MerchantCartToken":"3049549",
    "MerchantOrderId":"45345454",
    "PlatformURLs":{
         "SiteURL": "http://test.com/my_url.html",
         "RedirectToCartURL": "http://test.com/callback_URL.html"
         "PaymentCallbackURL": "http://test.com/paymentCallback_URL.html"
     },
    "Products": [{
            "ProductCode": "XE08801",
            "ProductGroupCode": null,
            "Name": "Socks",
            "URL": "https://www.test.com/products/08801",
            "Description": "Naturally Close 5 Pack White Value Trainer Liner Socks",
            "ImageURL": "https://www.test.com/products/08801.jpg",
            "SalePrice": "8.95",
            "OriginalSalePrice": "5",
            "SalePriceBeforeRounding": "8.905175000000000000",
            "LocalVATRateType": {
                "VATRateTypeCode": "merchantVATRateType_20",
                "Name": "merchantVATRateType_20",
                "Rate": 20,
                "InternalVATRateTypeId": 0
            },
            "OrderedQuantity": 1,
            "CartItemId": "111",
            "ImageURL":"https://test.test.com/1.jpg",
            "IsBackOrdered":false,
            "IsFixedPrice":true,
            "ListPrice":58.2,     
            "Attributes": [{
                    "AttributeCode": "color",
                    "Name": "WHITE",
                    "AttributeTypeCode": "color"
                }, {
                    "AttributeCode": "size",
                    "Name": "ONE SIZE",
                    "AttributeTypeCode": "size"
                }
               ],
            "MetaData":{
               "Attributes": [{
                   "AttributeKey":"earliestDeliveryDate",
                   "AttributeValue":"1717763520" 
                }, {
                   "AttributeKey":"earliestShipDate"
                   "AttributeValue":"1716985920"                }
               ]}
        }
        }
    ],
    "CartToken": null,
    "MerchantCartToken": "21531332-b15f-4640-ad5e-60887271a89a",
    "UserDetails": {
        "UserId": 12345,
        "AddressDetails": [{
                "UserId": 12345,
                "FirstName": "Test",
                "LastName": "Test-e",
                "Phone1": "01234567",
                "Email": "[email protected]",
                "Address1": "2-4 Test St",
                "City": "Alexandria",
                "Zip": "2015",
                "CountryCode": "AU",
                "IsShipping": true,
                "IsBilling": true,
                "IsDefaultShipping": true,
                "IsDefaultBilling": true
            }
        ]
    },
    "Discounts": [],
    "VATRegistration": {
        "VatRegistrationNumber": null,
        "DoNotChargeVAT": false
    },
    "rateData": "bkep2SfLA8VXnA3+mU1e16u5InvGPYAmwm7RpmXveyU=","IsMoto":1}

="
}

Documentation Portal

Checkout Methods

Note

SendCartV2

Parameters

Object SendCartData

Object CartCurrencyData

Object CartFreeShippingData

Object CartLoyaltyData

Object CartPriceModificationData

Object CartUserDetails

Object AddressDetails

Object UserIdNumberType

Object CartVATRegistrationData

Object CartVoucherData

Object CartOTVoucherData

Object LoyaltyVoucher

Object Culture

Object Discount

Object LoyaltyPoints

Object Product

Object Attributes

Object Brand

Object Category

Object MetaData

Object Attributes

Object VATCategory

Object VATRateType

Object ShippingOption

Object CartInfo

Examples

Search results