Skip to main content
The Global‑e Checkout Analytics feature, integrated within the Global‑e Client SDK, empowers merchants to track and analyze customer activity, providing valuable insights. By leveraging the Client SDK, websites can seamlessly integrate front-end user experience (UX) features and analytics, enabling data collection and integration with diverse analytics frameworks and tracking solutions. This document offers guidance to teams responsible for implementing analytics and trackers specifically for checkout events. In this section:

Client Analytics

Base Global‑e Script

Depending on your Global-e integration type, the Global-e SDK may be included all your storefront pages automatically. Please check with your Global-e CSM if you are unsure.
You can host the SDKJavaScript file locally or be served from the Global-e servers. If you would like to host the file on your servers, you can download the script from the following location by replacing the appropriate parameters:
To load our base script, you should use a self-invoking function: (<window>, <document>, <sDomain> + <clientJsURL>, “script”, “gle”, <scriptVersion>, <merchantId>) Production Example:
Code Sample
Script Parameters
ParameterDescription
sDomainProduction: https://web.global-e.comIntegration: https://www.bglobale.comStaging: https://www2.bglobale.com
windowThe JavaScript window object
documentThe JavaScript document object
clientJsURLLocal file path or direct to Global‑e servers/merchant/clientsdk/<merchantId>?v=<scriptVersion>
ScriptVersionThe version of Global-e server API.Currently 2.1.4.
merchantIdThe current Merchant ID
This script loads the Global-e client script asynchronously. The Global‑e client script uses an asynchronous approach so that you can start calling actions immediately; these actions are executed once the script is fully loaded.
This list is subject to modifications and limitations that may affect the availability of payment methods on the checkout page.

Order Transaction Analytics

The Global‑e Checkout Analytics feature enables the Merchant to obtain and track customer activity and use this information for analytics. This feature is part of the Global‑e Client SDK. This document focuses on the implementation of the Global-e Client SDK Order Transaction Analytics event; it targets teams in charge of implementing analytics, trackers, and other front-end implementations related to checkout events. The Global‑e Client JavaScript SDK implements the front-end UX features, (for example, Country and Currency switching) and integration (analytics) features on your website. Merchants can use the Client SDK to gather data and integrate the checkout information with any analytics framework, such as Google Analytics, or with any pixel type or tracker solution. The following figure provides an overview of the Global‑e Client SDK subscription flow. The following figure provides an overview of the Global‑e Client SDK subscription flow.
The building blocks of the Checkout Analytics subscription flow are as follows:
  1. The Merchant subscribes to the Global-e SDK Events (callback).
  2. When specific actions are performed by the customer on the Merchant’s website, the Global-e Client SDK sends a trigger, and the event returns the relevant information in JSON format.
To implement analytics, use the Global-e Client SDK OnCheckoutStepLoaded event functionality, as detailed in this document. The following figure provides an overview of the Global‑e Checkout analytics flow.
The building blocks of the Global‑e Checkout analytics subscription flow are as follows:
  1. Subscribe to the Global‑e OnCheckoutStepLoaded callback, as described in Subscribing to OnCheckoutStepLoaded.
  2. After subscription, when the Global‑e OnCheckoutStepLoaded is triggered based on checkout activities (LOAD or CONFIRMATION), the Global‑e Checkout iFrame sends you back checkout and order information in JSON format.
  3. Map the checkout data returned by the OnCheckoutStepLoaded to your existing analytics implementation so that you can create conversion reports in your analytics dashboard.
    Ad-blockers and payment redirects can affect analytics reporting.
The responsibilities between Global-e and the Merchant shall be shared as follows:
  • Global‑e shall provide and maintain the Global‑e Order Transaction object, as specified by Global‑e. In addition, Global‑e shall provide the support required to assist the Merchant with their implementation efforts.
  • The Merchant shall implement the subscription, data layer mapping, and Quality Assurance testing.
Make sure to exclude web.global-e.com and webservices.global-e.com as referrals (as per https://support.google.com/analytics/answer/2795830?hl=en)

OnCheckoutStepLoaded

This section describes how to subscribe to the OnCheckoutStepLoaded callback, the functionality of the callback and the Transaction Analytics object, and how to implement this feature for analytics. OnCheckoutStepLoaded is triggered twice:
  • Checkout Page****LOAD step: The LOADED step is called when the customer visits the checkout page or changes the destination country. Upon trigger, the Global‑e Client sends the OnCheckoutStepLoaded event together with a subset of the Order Transaction Analytics data, enabling the merchant to get product and cart information.
  • Checkout CONFIRMATION****step: When the checkout completes (Checkout Confirmation), the Global-e Client sends the OnCheckoutStepLoaded event again, together with the Order Transaction Analytics data. The Order Transaction Analytics contains product, and payment information, as well as transaction information between the customer and Global-e and reconciliation transaction information between Global-e and the merchant.
Global‑e provides pre-built subscriptions for the platforms it supports. Subscription implementation may vary according to the platform. Refer to the relevant platform documentation for platform-specific instructions. To subscribe to OnCheckoutStepLoaded:
  1. You can use one of the following subscription options:
    • If not already included, incorporate the OnCheckoutStepLoaded subscription snippet directly into your Checkout page (only).
    • Load the subscription from an external resource via tag manager (for example, Google Tag Manager).
  2. Implement your required triggers and data layer around the checkout process.
The subscription to the OnCheckoutStepLoaded callback is illustrated in the following snippet.

OnCheckoutStepLoaded Callback

This section describes the OnCheckoutStepLoaded callback, the data, and how the data is passed. The OnCheckoutStepLoaded is called twice, once for the initial checkout page load and the second time for the checkout confirmation page.
The following table details the OnCheckoutStepLoaded callback properties.
PropertyDescription
gle/glegemThe Global‑e SDK instance to subscribe to, gle or glegem, depending on the Platform.
OnClientEventThe name of the callback
function(source, data){..}Your implementation of the OnClientEvent callback function.
The callback function is called twice, once when the checkout starts and once when the checkout ends.
When the checkout starts, 'data.StepId' is set to 'data.Steps.LOADED'.The checkout load object is sent when the checkout page is loaded, that is, when 'data.StepId=LOADED'.
When the checkout ends, 'data.StepId' is set to 'data.Steps.CONFIRMATION'.The transaction analytics object is sent when the checkout process is complete, that is, when ‘StepId = CONFIRMATION'.
dataThe data parameter contains the object that holds the event data. The data structure elements are detailed below.

data

Where:
PropertyTypeDescription
Stepsobject (enum)Checkout step and confirmation stepValues: {{"LOADED":0,"CONFIRMATION":4}
LOADEDIntegerThe checkout page (step) has loaded.Global‑e checkout loaded code.See Data structure and examples.
CONFIRMATIONIntegerThe confirmation page (step) is displayed immediately after the payment has been authorised.Global‑e confirmation code.See Data structure and examples.
StepIdIntegerThe Global‑e stepId corresponding to the relevant step in the checkout:LOADED:0:``CONFIRMATION":4
detailsObjectThis field can contain:
A checkout load object with cart information (LOAD step).
A Global‑e order transaction object (CONFIRMATION step)
The Global‑e Order Transaction Analytics Object contains all the order properties and ecommerce transactions, as detailed in the following sections.

LOADED Step (StepId: 0)

When the LOADED step is triggered, the data property includes the following Checkout Load Object populated with cart data. The information included in the Loaded Step is a subset of the Confirmation step. Therefore, fields related to the order have an empty value.
If the page is reloaded following a change of country, this object may also include Checkout information, such as customer billing and shipping details, as in the Transaction object (confirmation step).
See:

CONFIRMATION Step (StepId: 4)

When the CONFIRMATION step is triggered, the data property contains the following JSON object:
Where:
PropertyTypeDescription
IsSuccessBoolIf true, the payment (IsPayment) has been authorised.If the data returns success, the Client SDK sends the order with the order information and the URL of the order (window.location = "http://www.yourconfirmationpage.com")
OrderIDStringThe Global‑e Order ID.Example: GE103411992GB
AuthCodeIntegerThe Global‑e payment authorisation code. Example: 5
See: Order Transaction Analytics Object section and subsections for the complete list of properties and descriptions. Examples for an Analytics implementation example and various order scenarios.

Order Transaction Analytics Object Overview

The "OnCheckoutStepLoaded data.details" parameter contains the Order Transaction Analytics Object with a breakdown of general ordering information and transactions.

Structure

The Order Transaction Analytics data object consists of a list of data properties set up as groups and components, generally structured as detailed below. Order Transaction Analytics Object Data Structure

Data Groups

The Order Transaction Analytics data groups consist of ecommerce transactions containing information such as order details, prices, and discounts, listed in merchant and customer currencies. Each time a customer places an order, there are two separate Global‑e transactions:
  • A transaction between Global‑e and the merchant
  • A transaction between Global‑e and the customer
Transactions between the different parties are set up as data groups, as follows:
VAT does not apply to the US. The VAT value is 0 for all non-EU merchants.
  • Merchant transaction: This group contains the prices and discounts in the merchant currency for the transaction between the merchant and Global‑e. It also includes the formulas for shipping cost estimations. These prices include VAT (between Global‑e and the merchant), if applicable. All values other than the shipping values, match the reconciliation reports.
  • **Merchant transaction excluding local VAT:**This group contains all prices and discounts between the merchant and Global‑e. Prices are listed in the merchant’s currency, excluding the VAT between Global‑e and the merchant, if applicable.
  • Customer transaction: This group contains all prices and discounts listed in the customer’s currency, reflecting the price paid and seen by the customer on the checkout page.
  • Customer transaction in merchant currency: This group contains the price paid and seen by the customer on the checkout page converted to merchant currency. The conversion is based on the spot exchange rate.

Components

Object properties are grouped as components, as follows:
  • Order information: This component includes all order level details properties. See Order Prices and Transactions
  • Product information: This component includes all product-level information that does not include prices. See Product Information
  • Payment methods: This component lists the method used to make the payment, such as with a standard credit or debit card or with an alternative method (such as PayPal, for example). See Payment Methods
  • Discounts: This component lists the discount values applied to the order (cart or product level), according to the original list of discounts received in the cart information for this order, and to the Merchant shipping configuration on Global‑e. See Discount Information

Data Details Properties

This section details the Transaction Object’s data, including order properties, product properties, order payment methods, and discount information.

Order Properties

PropertyTypeDescription
OrderIDStringGlobal‑e order unique identifierExample: GE538738292GB
ReplacementOrderBoolIndicates whether the order is a replacement.
CustomerCurrencyCodeString3-char ISO currency code denoting the customer’s currency.Example: EUR
MerchantCurrencyCodeString3-char ISO currency code denoting the original (merchant) currency on the merchant’s side.Example: GBP
IsEUBoolWhether the destination country is in the EU.
CustomerDetails-See CustomerDetails section.
HubCountryCodeStringTwo-letter country code of the hub from which the order is dispatched to the customer.Example: GB
RegionStringCustomer state or region (if available).
SiteURLStringMerchant website or store URL.
DutiesGuaranteedStringIndicates if the customer has selected the “guaranteed duties and taxes” option.
ShippingMethodNameStringThe name of the carrier, as was defined by Global-e for the specific merchant.Example: DHL, Spring Parcel Over 2Kg
ShippingMethodTypeStringThe type of carrier, as selected by the customer on the checkout page.Example: Standard, Express
DeliveryDaysRangeFromDecimalThe minimum number of days to delivery, as displayed on the Checkout page.
DeliveryDaysRangeToDecimalThe maximum number of days to delivery, as displayed on the Checkout page.
cultureCodeStringCulture code (language). If specified, the textual properties will be returned in the requested culture’s language if available. Texts in English will be returned by default
InitialCheckoutCultureCodeStringCulture code determined during the initial checkout load
CheckoutStepStringThe checkout step (LOAD or CONFIRMATION)
CountryCodeStringOrder destination country code 2-char ISO.Example: GB

Customer Details

‘CustomerDetails’ is disabled by default. Make sure to request that Global‑e enables it.

MerchantUserId

PropertyTypeDescription
MerchantUserIdStringThe registered user ID as it figures on the merchant’s websiteValue for guests: “null”

ShippingAddress

PropertyTypeDescription
ShippingFirstNameStringThe first name of the customer’s shipping address
ShippingLastNameStringThe last name of the customer’s shipping address
ShippingAddress1StringThe first line of the customer’s shipping address
ShippingAddress2StringThe second line of the customer’s shipping address
ShippingCityStringThe customer’s shipping city
ShippingCountryNameStringThe customer’s shipping country name
ShippingCountryCodeStringThe customers shipping country code ISO-2
ShippingStateStringThe customer’s shipping state name (if applicable)
ShippingStateCodeStringThe customer’s shipping state code ANSI (if applicable)
ShippingCompanyStringThe customer’s shipping company name
ShippingZipCodeStringThe customer’s shipping zip code
ShippingPhoneNumberStringThe customer’s shipping phone number

BillingAddress

PropertyTypeDescription
BillingFirstNameStringThe first name of the customer’s billing address
BillingLastNameStringThe last name of the customer’s billing address
BillingAddress1StringThe first line of the customer’s billing address
BillingAddress2StringThe second line of the customer’s billing address
BillingCityStringThe customer’s billing city
BillingCountryNameStringThe customer’s billing country name
BillingCountryCodeStringThe customer’s billing country code ISO-2
BillingStateStringThe customer’s billing state name (if applicable)
BillingStateCodeStringThe customer’s billing state code ANSI (if applicable)
BillingCompanyStringThe customer’s billing company name
BillingZipCodeStringThe customer’s billing zip code
BillingPhoneNumberStringThe customer’s billing phone number
BillingEmailStringThe customer’s billing email address

Order Prices and Transactions

This section details order-level Merchant and customer transaction properties.

MerchantTransaction

This section details the order transactions between the merchant and Global-e. Global‑e reconciles with the merchant in the merchant transaction currency, as denoted in the MerchantCurrencyCode property.
PropertyTypeDescription
EstimatedTotalPriceDecimalEstimated total order price after deducting the shipping and duties discounts.
TotalProductsPriceDecimalThe total price of the products (only) before discounts
TotalDiscountedProductsPriceDecimalThe total price of the products after product discounts
EstimatedShippingCostDecimalThe estimated shipping cost to be subsidized by the merchant
ShippingVATRateDecimalShipping service fee VAT rate, if applicable
DutiesAndTaxesDecimalDuties subsidy discount
ProductTotalVATDecimalThe VAT paid by Global-e to the merchant on the products, if applicable.
TotalVATDecimalThe total VAT sum to be paid by Global-e to the Merchant on the order, if applicable.
RemoteAreaSurchargeFeeDecimalMerchant Remote Area Surcharge SubsidyThis value is included in TotalShippingPrice.If this fee is not subsidised by merchants, this value is null.(RemoteAreaSurchargeFee=0).

MerchantTransactionExcludingLocalVAT

This section details the order transactions between the merchant and Global-e excluding VAT. Global‑e reconciles with the merchant in the merchant transaction currency, as denoted in the MerchantCurrencyCode property.
PropertyTypeDescription
EstimatedTotalPriceExcludingVATDecimalEstimated total order price after deducting the discounts
TotalProductsPriceExcludingVATDecimalTotal products price before discounts (products only)
TotalDiscountedProductsPriceExcludingVATDecimalTotal products price after discounts
EstimatedShippingCostExcludingVATDecimalThe estimated shipping cost to be subsidised by the merchant
CustomerShippingPriceExcludingVATDecimalThe shipping price paid by the customer
DutiesAndTaxesExcludingVATDecimalDuties subsidy discount taken by the Merchant
RemoteAreaSurchargeFeeExcludingVATDecimalMerchant Remote Area Surcharge SubsidyThis value is included in TotalShippingPrice.If this fee is not subsidised by merchants, this value is null (RemoteAreaSurchargeFee=0).

CustomerTransaction

This section details the order transactions between the customer and Global-e in the currency used to place the order (the customer transaction currency), as denoted in the CustomerCurrencyCode property.
PropertyTypeDescription
CustomerTotalPriceDecimalThe total price paid for the order by the customer
CustomerTotalProductsPriceDecimalThe total price paid by the customer for the products (only)
CustomerTotalDiscountedProductPriceDecimalThe total price of the products after deducting cart and product discounts paid by the customer
CustomerShippingPriceDecimalThe total shipping price after the discount is paid by the customer.The shipping price, including all shipping fees levied on the customer, such as the DangerousGoodsFee.
CustomerDutiesAndTaxesDecimalThe duties paid by the customer, including import duties, taxes, and customs clearance fees [CCF]). (Only relevant to international transactions outside the EU).
CustomerTotalVATDecimalThe total VAT included in the products or shipping sum paid by the customer (EU to EU transactions), if applicable.
CustomerShippingVATRateDecimalShipping VAT rate, if applicable.
CustomerUSSalesTaxDecimalUS sales tax paid by the customer (US customers only, as applicable)

Fees

The following table lists the fees paid by the customer.
PropertyTypeDescription
CustomerCCFDecimalCustoms clearance fee, if not included in the shipping cost
CustomerCODFeeDecimalCash on delivery fee
CustomerDangerousGoodsFeeDecimalDangerous goods fee
CustomerSizeOverchargeFeeDecimalSize overcharge fee
CustomerRemoteAreaSurchargeFeeDecimalRemote area surcharge fee, if not subsidized by the merchant

CustomerTransactionsInMerchantCurrency

This section details the order transactions between the customer and Global-e in the currency used to place the order (the customer transaction currency), as denoted in the CustomerCurrencyCode property. Global‑e converts this amount to Merchant base currency, as denoted in the MerchantCurrencyCode property. Prices are converted by spot exchange rate.
PropertyTypeDescription
CustomerTotalPriceInMerchantCurrencyDecimalThe total price paid for the order by the customer
CustomerTotalProductsPriceInMerchantCurrencyDecimalThe total price paid by the customer for the products (only)
CustomerTotalDiscountedProductsPriceInMerchantCurrencyDecimalThe total price of the products after deducting cart and product discounts paid by the customer
CustomerShippingPriceInMerchantCurrencyDecimalThe total shipping price, after discount, paid by the customerThe shipping price includes all shipping fees levied on the customer, such as CustomerRemoteAreaSurchargeFeeInMerchantCurrency.
CustomerVATInMerchantCurrencyDecimalThe total VAT sum paid by the customer
CustomerShippingVATRateDecimalShipping VAT rate
CustomerDutiesAndTaxesInMerchantCurrencyDecimalThe duties paid by the customer. This includes import duties, taxes, and customs clearance fees [CCF]). (Only relevant to international transactions outside the EU).
CustomerUSSalesTaxInMerchantCurrencyDecimalUS sales tax paid by the customer in Merchant currency

Fees

The following table details the fees paid by the customer converted to merchant currency.
PropertyTypeDescription
CustomerCCFInMerchantCurrencyDecimalCustomer Custom Clearance Fee to be paid by the customer, if not included in the shipping cost
CustomerCODFeeInMerchantCurrencyDecimalCash-on-Delivery fee to be paid by the customer
CustomerDangerousGoodsFeeInMerchantCurrencyDecimalDangerous goods fee to be paid by the customer
CustomerSizeOverchargeFeeInMerchantCurrencyDecimalSize overcharge fee to be paid by the customer in the Merchant currency
CustomerRemoteAreaSurchargeFeeInMerchantCurrencyDecimalRemote area surcharge fee, if not subsidized by the Merchant

Product Information

PropertyTypeDescription
ProductNameStringThe name of the product2 Pack Regular Fit Checked Easy Iron Shirts
ProductURLStringURL of the product
CategoriesSee Categories.
BrandSee Brand
SKUStringProduct SKU
ProductGroupCodeStringProduct Group Code
SecondaryProductCodeStringSecondary Product Code
QuantityStringQuantity of units
CartItemIdTypeCart Item ID
ProductCouponCodesList of stringsProduct coupon codeIf there are multiple coupons, the list of product coupon codes
ParentCartItemIDStringParent Cart Item ID for product bundles
CartItemOptionIdStringOption Cart Item ID
metadataSee Metadata

Brand

The following table lists brand names and codes received from the cart information.
PropertyTypeDescription
codeStringProduct brand code
nameStringProduct brand name

Categories

The list of all category names received.
Product categories must be mapped on the Global‑e side or passed by default. Ask Global‑e to perform the mapping.
PropertyTypeDescription
codeStringProduct category code
nameStringProduct category name

Metadata

Metadata consists of product attributes that can vary for the same SKU; for example, customization such as engraving text.
PropertyTypeDescription
AttributeKeyStringAttribute key
AttributeValueStringAttribute value

Product Attributes

Attributes consist of information that does not vary for the same SKU; for example, the colour or size (in most cases), in a parent or child catalogue structure with variants.
PropertyTypeDescription
AttributeCodeStringAttribute Code
AttributeNameStringAttribute Name - Custom product attribute name that is used to describe the personalised product
AttributeTypeCodeStringAttribute Type Code - Custom product attribute value used to describe the personalised product

Product Prices

This section details the product prices, discounts, VAT (if applicable), and shipping cost estimations, for the transaction between the Merchant and Global-e in the Merchant base currency. All values except for the shipping values, match the base reports.
PropertyTypeDescription
ListPriceDecimalProduct list price (before any discounts).This property always denotes the product price in the default Merchant country, regardless of UseCountryVAT for the end customer’s current country.The list price is sent in the Cart API.
SalePriceDecimalProduct sale price, before applying any price modifications.This property always denotes the product price in the default merchant country, regardless of UseCountryVAT for the end customer’s current country.
TotalPriceDecimalThe total price of all units
VATRateDecimalThe VAT rate for the product, if applicable
DiscountedPriceDecimalThe price after discount
This section details the product prices excluding VAT, discounts, and shipping cost estimations, for the transaction between the Merchant and Global-e in the merchant base currency. All values except for the shipping values, match the reconciliation reports.
PropertyTypeDescription
ListPriceExcludingVATDecimalProduct list price (before discounts), before applying any price modifications.This property always denotes the product price in the default Merchant country, regardless of UseCountryVAT for the end customer’s current country.The list price is sent in the Cart API.
SalePriceExcludingVATDecimalThe price of the sale
TotalPriceExcludingVATDecimalTotal price of all units
DiscountedPriceExcludingVATDecimalDiscounted price
In the following customer transactions, all prices are in customer currency, according to the values visible on the checkout page.
PropertyTypeDescription
CustomerListPriceDecimalProduct list price
CustomerSalePriceDecimalProduct selling price
CustomerTotalPriceDecimalTotal price of all units
CustomerVATRateDecimalVAT rate (if applicable)
CustomerDiscountedPriceDecimalThe discounted price paid by the customer
In the following customer transactions, all prices are in merchant currency. Prices are converted by exchange spot rate.
PropertyTypeDescription
CustomerListPriceInMerchantCurrencyDecimalProduct list price converted to merchant currency
CustomerSalePriceInMerchantCurrencyDecimalProduct sale price as visible to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable), and IncludeVAT handling.
CustomerTotalPriceInMerchantCurrencyDecimalTotal price of all the units included in the order converted to merchant currency
CustomerDiscountedPriceInMerchantCurrencyDecimalThe reduced price (after discounts) of the product in merchant currency.

Payment Methods

The means with which the customer made the payment (credit card, PayPal, other). Global‑e recommends using the new and enhanced OrderPaymentMethods instead of the PaymentMethods listed below (maintained for backward compatibility).
PropertyTypeDescription
PaymentMethodNameStringThe name of the payment methodExample:Standard method: credit card (Visa)Alternative method: PayPal
PaymentMethodCodeStringPayment Method Code
PaymentMethodTypeCodeNumericPayment Method Type ID associated with the payment method type:0 = Undefined1 = Credit Card2 = Local Alternative3 = Global Alternative4 = Coupon5 = Credit Card Instalments
PaymentMethodTypeNameStringPayment Method Type Name:Undefined, Credit Card, Local Alternative, Global Alternative, Coupon, Credit Card Instalments

Discount Information

General Discount Information

PropertyTypeDescription
DescriptionStringThe discount description
DiscountCodeStringThe discount code
DiscountTypeIdInteger longThe cart discount type. Discount related to the amount, coupon, or another promotion value. The Discount Type Option Values table describes one of the following possible values of DiscountTypeOptions enumeration denoting a type of discount. See Discounts - Discount Type Option Values.
DiscountTypeNameStringDiscount type name, such as shipping discount, cart discount, product discount, and more.
CouponCodeStringThe coupon code
ProductCartItemIdStringCart Item Id. The connection between the discount and product by cartItemId in product - this is null if the discount does not refer to a specific product but was cart level (distributed between products)

Discount

PropertyTypeDescription
OriginalDiscountValueDecimalDiscount value in the Merchant base 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 customer’s current country.
VATRateDecimalThe VAT rate applied to this discount (if applicable)
LocalVATRateDecimal (optional)The VAT rate applied to this discount if the order is placed by the customer. This value must be specified if UseCountryVAT for the current Country is TRUE and therefore, the VATRate property actually denotes the VAT for the target country.
DiscountValueDecimalDiscount value as displayed to the customer, after applying country coefficient, FX conversion, and IncludeVAT handling
NameStringDiscount name
DescriptionString (optional)Discount textual description
CouponCodeString (optional)Merchant’s coupon code used for this discount (applicable to coupon-based discounts only)
ProductCartItemIdString (optional)Identifier of the product cart item related to this discount on the Merchant’s site. This property may be optionally specified in the Cart API only so that the same value could be posted back when creating the order on the Merchant’s site with SendOrderToMerchant API.
DiscountCodeString (optional)Discount code used to identify the discount on the Merchant’s site. This property may be optionally specified in the Cart API only so that the same value could be posted back when creating the order on the Merchant’s site with SendOrderToMerchant API.
LoyaltyVoucherCodeString (optional)Code used on the Merchant’s site to identify the loyalty voucher on which this discount is based.
DiscountTypeInt64The DiscountType Option Value table describes one of the following possible values of DiscountTypeOptions enumeration denoting a type of discount.

DiscountType Option Value

DiscountType ValueNameDescription
1Cart discountDiscount related to volume, amount, coupon, or another promotion value
2Shipping discountDiscount aimed at subsidizing international shipping
3Loyalty points discountDiscount applied against the Merchant’s loyalty points to be spent for this purchase
4Duties discountDiscount aimed at sponsoring taxes & duties pre-paid by the customer in Global‑e checkout
5Checkout loyalty points discountDiscount applied against the Merchant’s loyalty points in Global‑e checkout
6Payment chargeDiscount aimed at subsidizing the “Cash on Delivery” fee
PropertyTypeDescription
PriceDecimalDiscount Value
vatRateIntegerThe merchant Local VAT rate
PropertyTypeDescription
PriceExcludingVATDecimalDiscount Value
PropertyTypeDescription
CustomerPriceDecimalDiscount Value
CustomerVATRateIntegerVAT Amount

Customer Transactions in Merchant Currency

PropertyTypeDescription
customerPriceInMerchantCurrencyDecimalThe price of the customer discount in customer currency
customerVATRateIntegerVAT amount

OrderPaymentMethods

OrderPaymentMethods provide comprehensive information about the payment methods used by the customer to pay for the order; it includes a breakdown of the amount paid as well as a gift card indication, when applicable.
MethodTypeDescription
OrderPaymentMethodsArrayA list of payment methods used to place the order.
Each payment method contains the following elements.
PropertyTypeDescription
PaymentMethodIdIntegerThe ID of the payment method in the Global‑e system.
PaymentMethodNameStringThe name of the payment method.
IsGiftCardBooleanUsed by the merchant to identify the gift card payment method.
GiftCardFieldsStringKey-values pairs from the gift card merchant app setting (in the Global‑e system).Null for regular payments (without gift cards).GiftCardFields can be used to retrieve the gift card identifier.
PaidAmountInCustomertCurrencyDecimalThe amount paid in customer currency.
PaidIAmountnMerchantCurrencyDecimalThe amount paid in merchant currency, using spot conversion.
PaymentMethodTypeCodeNumericPayment Method Type ID associated with the payment method type:0 = Undefined1 = Credit Card2 = Local Alternative3 = Global Alternative4 = Coupon5 = Credit Card Instalments
PaymentMethodTypeNameStringPayment Method Type Name:Undefined, Credit Card, Local Alternative, Global Alternative, Coupon, Credit Card Instalments

Global‑e Properties

PropertyTypeDescription
URLStringURL (Store URL)
CustomURLStringTechnical field for Global‑e use; to be disregarded in the merchant implementation.
MerchantIdStringMerchant ID, as registered in the Global‑e system
TitleStringThe title of the transaction
HostNameStringThe name of the server hosting merchant website
CustomHostNameStringTechnical field for Global‑e use; to be disregarded in the merchant implementation.
PageTypeNumberTechnical field for Global‑e use; to be disregarded in the merchant implementation.
CartTokenStringCart token for the cart generated on the Global‑e side by the Cart API method preceding the current cart action. This property is mandatory only for server-side calls.
UrlRefererStringThe URL of the previous web page from which a link was followed.
DoLogBooleanReceives and logs plain messages and sends them to other logging methods.

Properties Distribution per Transaction

The following table provides the distribution of properties for each transaction. ORDER Properties Distribution
PropertyMerchant TransactionsMerchant Transactions Excluding Local VATCustomer TransactionsCustomer Transactions in Merchant Currency
EstimatedTotalPrice
TotalProductsPrice
TotalDiscountedProductsPrice
EstimatedShippingCost
CustomerShippingPrice
ShippingVATRate
DutiesAndTaxes
TotalVAT
RemoteAreaSurchargeFee
CCF
CODFee
DangerousGoodsFee
SizeOverchargeFee
PRODUCT Properties Distribution
PropertyMerchant TransactionsMerchant Transactions Excluding Local VATCustomer TransactionsCustomer Transactions in Merchant Currency
ListPrice
SalePrice
DiscountedPrice
TotalPrice
Markdown
DISCOUNTS Properties Distribution
PropertyMerchant TransactionsMerchant Transactions Excluding Local VATCustomer TransactionsCustomer Transactions in Merchant Currency
Price
VATRate

Examples

This section provides implementation examples.

Checkout LOAD Step

Key points:
  • The Checkout Load step is called when the customer visits the checkout page and when switching the country.
  • The information included in the Checkout Load Step is a subset of the Confirmation step.

Analytics Implementation and Mapping to Analytics

This section details some basic methods you can use to include the Global-e analytics subscription in your code. Load the following as a dedicated logic directly in DOM as JavaScript content: subscription, complete data layer mapping, and event execution. Example: Frontend DOM
Use a tag manager such as GTM to load the subscription, data mapping, and events, as a dedicated logic. You can also perform this as inline data mapping and tag-based triggers, depending on current practices. Example: GTM Tag Manager

GB Orders

GB Order Sent to the US with Sales Tax and Duties and Taxes Paid Separately at Checkout (Optional DDP)

Key points :
  • The VAT is applied on the Merchant transaction between Global-e and the brand.
  • Duties paid as part of the product price are featured as such and described under a subsidy discount object.
  • The applicable US sales tax is featured in a dedicated field.

GB Order Sent to Australia with Duties and Taxes Included in the Product Price (Hidden Force DDP)

Key points:
  • The VAT is applied on the Merchant transaction between Global-e and the brand.
  • Duties & taxes paid as part of product price are featured as such and described under a subsidy discount object.

US Orders

US Order Sent to the EU with Duties and Taxes Included in the Product Prices (as Hidden Force DDP)

Key points:
  • There is no local tax that is applicable to the transaction between Global-e and the brand.
  • Duties & taxes paid as part of product price are featured as such and described under a subsidy discount object.
  • There is no VAT applicable to the customer or the brand (local taxes are handled under Duties & Taxes)

US Order Sent to any Country as Optional DDP

Key points:
  • There is no local tax that is applicable to the transaction between Global-e and the brand.
  • Duties & taxes paid separately by the customer on the checkout page are featured as a transaction amount for the customer transaction but not between Global‑e and the brand.
  • There is no VAT applicable to the customer or the brand (local taxes are handled under Duties & Taxes).

EU Order with Customer VAT and Merchant VAT

Key points:
  • Merchant and Customer VAT rates can differ if they are applied: between Global‑e and the brand - or - between Global‑e and the customer (EU distance selling VAT rules)
  • As a result, VAT-inclusive product prices also differ.
  • No duties applicable

Global‑e and Marketing Pixels

With the Global-e solution installed, your store has now two types of checkouts, the standard checkout for your local customers and the Global-e checkout for your international customers.
This document provides you, the merchant, with the basic instructions required to implement tracking events on your website. MEASURING PLATFORM EVENTS To measure marketing platform events on the Global-e checkout, you must add the pixels or tags of the relevant marketing platforms to the pages containing Global-e checkout, as described in this document RELATED DOCUMENTATION For detailed technical documentation, see Global‑e Order Transaction Support for Analytics

Adding Pixels to the Global‑e Checkout

Global‑e provides a JavaScript callback function (“OnCheckoutStepLoaded”) that holds the checkout and order information in a data object. You can use this callback to trigger events both when the Global‑e checkout is loaded or complete. To embed pixels in the Global-e checkout:
  1. Edit the OnCheckoutStepLoaded callback function by adding the relevant pixel snippets to the callback function.1. Edit the OnCheckoutStepLoaded Callback Function
  2. Place the final OnCheckoutStepLoaded callback function on your site.2. Place the Final OnCheckoutStepLoad Callback on your Site
  3. Edit the OnCheckoutStepLoaded Callback Function The following code snippet presents the subscription to the OnCheckoutStepLoaded callback function. Note that this code currently does not contain any pixels. data.Steps.LOADED****loaded, while the data.Steps.CONFIRMATION case is executed when the Global‑e checkout has been completed.
    We recommend deferring the Global-e scripts until after the entire document has been parsed. Hopefully, this will allow any analytics code to load onto the page before the Global-e analytics scripts load. If the above recommendations do not improve the situation, we recommend you add your analytics code to the source of the checkout page, assuming there are no reasons preventing that from happening. Converted price analytics You may need to capture converted prices in analytics that run on your product page and other pages before checkout. To do this, there is an event that triggers after the prices on the page are converted. You can subscribe to this event, and after it triggers, you can execute your analytics, so you are able to retrieve the converted prices.
    As mentioned, the callback returns a data object in JSON format that contains information about the checkout, such as item prices and quantities, order total, and currency. Use the variables in the JSON data object to configure your pixel. See Data Object Confirmation Step (JSON) for an example. Use the relevant data object variables to add pixels to the LOADED step, the CONFIRMATION step, or both. The following examples show how this is edited or amended for each marketing platform.
    PlatformEventExample
    Google Tag Manager (Data Layer)Purchase EventGoogle Tag Manager (Purchase Data Layer)
    Google Ads (gtag)Conversion Eventgtag - Conversion Event
    TikTokPlaceAnOrder EventTikTok - PlaceAnOrDer Event
  4. Place the Final OnCheckoutStepLoad Callback on your Site To implement the final OnCheckoutStepLoad callback on your site: OnCheckoutStepLoadedonline store, in the head element. Note that the callback function is only initiated when the Global‑e checkout is loaded or complete, even though the function is implemented on every page of your site.

Common Data Object Variables

The following table lists the most common data object variables used in marketing platforms events:
Variable DefinitionVariable JSON Path
Global‑e Order Iddata.details.OrderID
The merchant currency: The Store currencydata.details.MerchantCurrencyCode
Order products total (in merchant currency)data.details.OrderPrices.MerchantTransaction.TotalProductsPrice
Single product sale price (in base Store currency)data.details.ProductInformation[i].ProductPrices.MerchantTransaction.SalePrice
Single product quantitydata.details.ProductInformation[i].Quantity
Single product SKUdata.details.ProductInformation[i].SKU
See Global‑e Order Transaction Support for Analytics for the complete list of variables.

Google Tag Manager (Purchase Data Layer)

gtag - Conversion Event

TikTok - PlaceAnOrDer Event

Data Object Confirmation Step (JSON)

The following example illustrates the data object confirmation step in JSON format.

Converted price analytics

You may need to capture converted prices in analytics that run on your product page and other pages before checkout. To do this, there is an event that triggers after the prices on the page are converted. You can subscribe to this event, and after it triggers, you can execute your analytics, so you can retrieve the converted prices.