Skip to main content
When you sign up with Global-e, a Merchant account is created in the Global-e system, and your Global-e merchant credentials are sent to you:
  • Global‑e Merchant ID: The ID of your Global‑e account.
  • Global‑e Merchant GUID: A unique identifier of your Global‑e account. Note that Global‑e sends you a different GUID for each applicable Global-e environment.
  • Global-e provides you with the CSS and JavaScript ‘includes’ to add to your sandbox site.
  • Make sure you have shared with Global‑e the system features you want to be supported, including the list of countries and special features such as Fixed Prices, and multiple sites.
#Description
Step 1Prepare a sandbox storefront (close to production) for integration purposes, and share the URL with your Global-e Project Manager.
Step 2Customise your shopper’s experience:1.Add the Global‑e CSS and JavaScript ‘includes’ on all the pages in your sandbox site. See The Global-e Module JavaScript and The Global-e Module CSS.2.Customise the following to match your brand: Welcome Pop-Up, Country Switcher, Checkout Page, and Marketing Banner.3.Tag your storefront prices with data-ge-price as documented here.4.Tag calculated prices on your cart page as documented here.5.Tag your checkout button and the international Checkout container as documented here.6.Tag any elements that should be hidden or shown for international countries as required.1.Add the Global‑e CSS and JavaScript ‘includes’ on all the pages in your sandbox site. See The Global-e Module JavaScript and The Global-e Module CSS.2.Customise the following to match your brand: Welcome Pop-Up, Country Switcher, Checkout Page, and Marketing Banner.3.Tag your storefront prices with data-ge-price as documented here.4.Tag calculated prices on your cart page as documented here.5.Tag your checkout button and the international Checkout container as documented here.6.Tag any elements that should be hidden or shown for international countries as required.
1.Add the Global‑e CSS and JavaScript ‘includes’ on all the pages in your sandbox site. See The Global-e Module JavaScript and The Global-e Module CSS.
2.Customise the following to match your brand: Welcome Pop-Up, Country Switcher, Checkout Page, and Marketing Banner.
3.Tag your storefront prices with data-ge-price as documented here.
4.Tag calculated prices on your cart page as documented here.
5.Tag your checkout button and the international Checkout container as documented here.
6.Tag any elements that should be hidden or shown for international countries as required.
Step 3Add a cart token for Global-e to retrieve the shopper’s cart via the GetCheckoutCartInfo API you developed. This step must be completed before implementing GetCheckoutCartInfo (in Step 5 below).‌Implement a cookie, local or session storage variable, or an HTML DOM attribute, to contain a token that uniquely identifies the cart in your system. (Ex.GlobalECartId)Provide the identifier details: cookie name, storage location, DOM element name, and other relevant information.Note: For security reasons, the cart token must represent an encrypted, hashed, or otherwise obfuscated value that cannot be easily guessed. For example, simple auto-incrementing sequential numbers may not be used for cart tokens. Using a GUID is acceptable.Global‑e enables Global‑e countries, price conversion, Global‑e checkout, and the other features you have requested to support.
Step 4Prepare the international checkout:1.Create a page for the international checkout, for example /pages/international-checkout.Consider creating a dedicated page for international checkout, although you can use the same one as for domestic checkout.2.On the new page, insert a DIV container element designated for the international checkout IFRAME.Add the attribute data-ge-checkout to the container DIV.3.Assign the attribute ge-checkout-button to all checkout buttons.4.Provide the URL of your international checkout page to the Global-e Integration Team.1.Create a page for the international checkout, for example /pages/international-checkout.Consider creating a dedicated page for international checkout, although you can use the same one as for domestic checkout.2.On the new page, insert a DIV container element designated for the international checkout IFRAME.Add the attribute data-ge-checkout to the container DIV.3.Assign the attribute ge-checkout-button to all checkout buttons.4.Provide the URL of your international checkout page to the Global-e Integration Team.
1.Create a page for the international checkout, for example /pages/international-checkout.Consider creating a dedicated page for international checkout, although you can use the same one as for domestic checkout.
2.On the new page, insert a DIV container element designated for the international checkout IFRAME.Add the attribute data-ge-checkout to the container DIV.
3.Assign the attribute ge-checkout-button to all checkout buttons.
4.Provide the URL of your international checkout page to the Global-e Integration Team.
Step 5Implement the following mandatory API (merchant) methods.When implementing APIs, make sure to use the correct Global-e GUID in your API request for each environment.GetCheckoutCartInfoImportant: Implement this API first for the Global‑e checkout.This API is required to pass the cart contents to Global-e; it is called from a Global‑e server with the cart token provided in a cookie or HTML DOM from the client session for accurate price total calculation.Note: The API must only return in-stock products. For special stock validation handling on the merchant’s side (e.g., calls to an external system), Global‑e can specify an additional URL argument.SendOrderToMerchantThis API is required to create the customer order in your system, clear the user’s basket, and optionally reserve the inventory.PerformOrderPaymentThis API is required to mark the order as confirmed as part of the fulfilment process in your system.UpdateOrderStatusThis API is required to support Global-e-initiated order cancellation. It can also be used to report and synchronize other order status updates from Global‑e with your system. For more information, see ???.Share your endpoint URLs with Global-e.To implement additional non-essential APIs, see Global-e API Reference and ???.GetCheckoutCartInfoImportant: Implement this API first for the Global‑e checkout.This API is required to pass the cart contents to Global-e; it is called from a Global‑e server with the cart token provided in a cookie or HTML DOM from the client session for accurate price total calculation.Note: The API must only return in-stock products. For special stock validation handling on the merchant’s side (e.g., calls to an external system), Global‑e can specify an additional URL argument.SendOrderToMerchantThis API is required to create the customer order in your system, clear the user’s basket, and optionally reserve the inventory.PerformOrderPaymentThis API is required to mark the order as confirmed as part of the fulfilment process in your system.UpdateOrderStatusThis API is required to support Global-e-initiated order cancellation. It can also be used to report and synchronize other order status updates from Global‑e with your system. For more information, see ???.
GetCheckoutCartInfoImportant: Implement this API first for the Global‑e checkout.This API is required to pass the cart contents to Global-e; it is called from a Global‑e server with the cart token provided in a cookie or HTML DOM from the client session for accurate price total calculation.Note: The API must only return in-stock products. For special stock validation handling on the merchant’s side (e.g., calls to an external system), Global‑e can specify an additional URL argument.
SendOrderToMerchantThis API is required to create the customer order in your system, clear the user’s basket, and optionally reserve the inventory.
PerformOrderPaymentThis API is required to mark the order as confirmed as part of the fulfilment process in your system.
UpdateOrderStatusThis API is required to support Global-e-initiated order cancellation. It can also be used to report and synchronize other order status updates from Global‑e with your system. For more information, see ???.
Step 6Clear the cart after a successful international transaction. See, Clearing the Cart.
Step 7Implement client-side checkout and transaction analytics, see Global‑e and Marketing Pixels.
Step 8On your storefront, update your account order history pages to show the correct Global-e international prices using the order information in the SendOrderToMerchant (Global-e to Merchant)request.
Step 9Prepare and Upload as a CSV file to the Global-e server via SFTP.Continuously upload deltas.
Step 10Fulfillment and Dispatch Process.Use the Global‑e Merchant Portal for international order management and fulfillment, and other essential eCommerce operations.

​
Integration Features

FeatureDescription
Country and Currency SwitcherSelect over 200 countries with default or free currencies (can be replaced by custom implementations).
Currency ConversionView prices in local currency with up-to-date conversion rates, country coefficients, rounding rules, and currency symbols.
Duty and Tax CalculationsSelect country and continent-specific duty and tax calculations.
Shipping Options EngineSelect country-specific shipping options from standard to express with a tailored pricing policy.
Local Payment MethodsSelect from the most popular payment methods for each country.
PromotionsManage promotions for the Global-e operated countries.
Customer ServiceManage Global-e Orders through the Customer Services Tool.

​
Integration Overview

The Bespoke Global-e Module integrates with your storefront, checkout, and order components.
  • Storefront: A code snippet (include) is placed in your website’s header.
  • Checkout: Triggers the Global‑e international order process by utilizing Global‑e’s dedicated checkout facility.
  • Order placement: Places an order into your e-commerce platform and provides you with customer data.

​
Architecture Overview

​
High-Level Flow

​
End-to-end Flows

​
Customer Journey (Technical)

​
End-to-End Conversion Tracking Continuity

​
Checkout Overview

International users check out using Global‑e’s secure and customizable IFRAME-based checkout facility, embedded in a container page. To facilitate the cart content transfer from the merchant’s storefront to Global-e’s checkout:
  • Implement the Return Cart Contents action on your Merchant’s storefront, as shown in the following workflow chart:
    Once implemented, this action is handled by the Global‑e system when the user reaches the Global‑e checkout container page. It includes the creation of a serialised representation of the cart content, and implements the security mechanism used to transfer this data to Global‑e.
  • Make sure your Merchant’s web application can identify the user’s cart by its unique token outside the user session. This cart token is then specified in the GetCheckoutCartInfo (Global-e to Merchant)API method (implemented on the merchant’s site). The Global‑e server calls this API to read the user’s cart contents. To ensure the total price calculation accuracy throughout your Merchant’s storefront, Global-e Module can call the GetCheckoutCartInfo method from the client side during the user’s session. However, for security reasons, client calls are never used to transfer the user’s cart to the Global‑e checkout. Likewise, for security reasons, client calls should not include the MerchantGUID attribute that is otherwise included in server-to-server API calls.

​
Integrate the Global‑e Checkout with your Storefront

The Global‑e checkout integration method is not dependent on the structure and characteristics of the web store’s cart page, thus combining security with integration robustness. The following workflow chart illustrates the required checkout integration activities:
  1. Global‑e loads the checkout container page.
  2. On your storefront, get the cart contents by calling the Return Cart Contents.
  3. Global-e manages the cart content:
    1. Creates the cart on the Global‑e side.
    2. Loads the checkout iframe.