# Global-e Docs > This file is very large and may be truncated. For an index of this content, please refer to https://docs.global-e.com/llms.txt instead. # Merchants Source: https://docs.global-e.com/0--merchants ## Overview The **Merchants** section describes the following: * [Product Management](/product-management) * [Shipping Management](/shipping-management) * [Site Customization](/site-customization-storefront) * [Flash Sale Mode](/flash-sales) # Introduction Source: https://docs.global-e.com/1--introduction As the chosen partner of hundreds of global brands and retailers worldwide, Global-e is the leading provider of cutting-edge cross-border e-commerce solutions. Our comprehensive technology-based solutions make global brand expansion effective and risk-free for online merchants. By connecting people with brands worldwide, Global-e creates a boundless e-commerce world in which selling globally is as simple as selling locally. The Global-e Extension for WooCommerce allows you to start boosting your international sales within days. By implementing our smart cross-border solution and giving shoppers a truly localized experience, Global-e merchants see an immediate and continuous increase in conversion rates and international revenues. ## This Document This document provides instructions on how to set up the Global-e Extension for WooCommerce and describes the key functionality available after setup. It is intended for personnel responsible for installing and configuring the extension and assumes familiarity with WordPress, WooCommerce, and general web administration concepts. ## Prerequisites The setup process requires the following: * A user account on your server with permissions to run CLI commands. * A WordPress administrator account. * An active Global-e merchant account. # Extracting the Initial Catalog Source: https://docs.global-e.com/1b--extracting-the-initial-catalog Centra has unique product identifiers that Global-e uses to manage operations. Because some of these identifiers do not exist in Centra's native catalog export, merchants must extract the catalog on their own using the Python method. The Python method is used to retrieve the required catalog information. Note that the initial catalog upload cannot be completed correctly without providing this information. The following shows the Python extraction method: ``` from time import sleep import requests import csv # Define the URL for the Centra Checkout API api_url = "https://temp.centraqa.com/graphql" api_token = "123456789abc" # Replace with your actual API token # Define the headers for the API request headers = { "Authorization": f"Bearer {api_token}", "Content-Type": "application/json" } count_index = 1 # Define the CSV file name csv_file = "centra_catalog5.csv" # Define the CSV headers csv_headers = ["Product Unique Identifier", "SKU", "Display Name", "Product Description", "Country of Origin"] # Write data to the CSV file with open(csv_file, mode='w', newline='', encoding='utf-8') as file: writer = csv.writer(file) writer.writerow(csv_headers) while True: # Define the query with variables query = """ query productList( $status: [ProductStatus!]! $page: Int! ) { products( where: { status: $status } sort: [updatedAt_DESC] limit: 30 page: $page ) { id countryOfOrigin { code } displays(where: { storeId: 1 }) { name description displayItems { id productVariant { productSizes { id SKU } } } } } } """ variables = {"status": "ACTIVE", "page": count_index} response = requests.post(api_url, json={"query": query, "variables": variables}, headers=headers) response_data = response.json() print(response_data) for product in response_data['data']['products']: for display in product['displays']: for display_item in display['displayItems']: for product_sizes in display_item['productVariant']['productSizes']: if product['displays']: product_id = product_sizes['id'] sku = product_sizes['SKU'] display_name = display['name'] description = display['description'] country_of_origin = 'N/A' if product['countryOfOrigin']: country_of_origin = product['countryOfOrigin']['code'] writer.writerow([product_id, sku, display_name, description, country_of_origin]) sleep(1) print("page: " + str(count_index)) count_index = count_index + 1 ``` # Overview Source: https://docs.global-e.com/2--overview ## Capabilities Together with your merchant account configuration in the Global-e system, the Global-e Extension for WooCommerce provides the following capabilities: * **Browsing and buying in local currencies**: Shoppers can browse and purchase in their local currency. More than 160 currencies are supported. * **Local pricing**: Prices are rounded and formatted according to local conventions and adjusted per country. * **Local and alternative payment methods**: Shoppers can pay using their preferred local payment methods; over 75 are supported. * **Duty and tax calculation**: Shoppers can view and prepay all duties and taxes at checkout to avoid unexpected costs upon delivery. * **Multiple shipping options**: Shoppers can choose from a range of international shipping methods at competitive rates. * **Convenient returns portal**: Transparent and simple returns process, including a pre-paid returns option. * **Localized welcome and checkout**: A complete localized shopping experience, including a translated checkout process, available in 26 languages. > [!NOTE] > > At this stage, the Global-e extension does not support customer-related discount settings (such as allowed emails or usage limits per user). ## Global-e Extension for WooCommerce - Main Functionality The Global-e extension provides the following functionality in WooCommerce: * **Shopper’s Geo Location**: When a shopper accesses the store, the Global-e extension detects the shopper’s location (IP address) and uses it to predefine the relevant country’s currency settings. * **Shipping switcher**: Shoppers can change the order delivery country by clicking the flag at the top of the page and selecting a different shipping destination. * **International checkout page**: The international checkout page, powered by Global-e, opens in an iFrame on the merchant’s site. It is translated into 26 languages and offers more than 75 local payment methods in over 160 currencies, along with the ability to pre-pay duties and taxes for the relevant shipping methods. See [Checking Out, Creating, and Viewing Orders](/checking-out-creating-and-viewing-orders) for more information. * **Global-e cookie**: The Global-e Module cookie collects basic user information used to identify the shopper, the culture, the cart, and the relevant store instance. [Viewing the Global-e Cookie Information in the Browser](/viewing-the-global-e-cookie-information-in-the-browser) for more information. * **Price conversion by Global-e**: Global-e converts the value of the merchant’s product prices into the shopper’s local currency. This conversion includes, when applicable, VAT calculation, rounding rules, and other regional adjustments. * **Fixed prices**: Global-e supports fixed prices in WooCommerce for merchants who wish to align online pricing with local store pricing. This requires configuring the site to support fixed prices. See [Configuring Your Site to Support Fixed Prices](/configuring-your-site-to-support-fixed-prices). > [!NOTE] > > At this stage, the Global-e’s extension does not support customer-related discount settings (such as Allowed emails or Usage limit per User). # Installing the Global-e Extension for WooCommerce Source: https://docs.global-e.com/3--installing-the-global-e-extension-for-woocommerce ## Prerequisites The extension setup requires: * A user on your server with permissions to run CLI commands. * A WordPress administrator account * A Global‑e merchant account ## Overview Global‑e provides you with a zipped file for installing the WooCommerce extension. Make sure you have your Merchant information available to perform this installation. You can install the Global-e WooCommerce extension using one of the following methods: * [Extracting the zip file to the server](/3--installing-the-global-e-extension-for-woocommerce#extracting-the-zip-file-to-the-server) * [Uploading the File as a Plugin](/3--installing-the-global-e-extension-for-woocommerce#uploading-the-file-as-a-plugin) * [Installing the Plugin from the WordPress Marketplace](/3--installing-the-global-e-extension-for-woocommerce#installing-the-plugin-from-the-wordpress-marketplace) ### Extracting the Zip File to the Server > [!NOTE] > > You can deactivate and reactivate the extension after installation if required. See Step 3 below. 1. Extract the Global‑e WooCommerce extension's zip file onto the server where WordPress is installed. 2. Copy: global-e-cross-border-for-woocommerce/ to To: `<` `wp` `_root` `>/` `wp-content` `/` `plugins` `/` The Global‑e plugin is now installed under `WooCommerce > Plugins > Installed Plugins >` and the Global‑e *includes* are activated. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-ab0a7641-ca3a-11a1-d8a4-a315a44b085c.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=04a31d396e3b3f2fa551666b1289be10) 3. (Optional) Navigate to WooCommerce > Plugins > Installed Plugins. 4. In the Global-e Cross-Border for WooCommerce section, do one of the following: * Click **Deactivate** to disable the plugin *Global--e CSS and JavaScript includes* in WooCommerce. * Click **Activate** to install the plugin *Global--e CSS and JavaScript includes* in WooCommerce. ### Uploading the File as a Plugin #### To upload the file as a plugin 1. Log in to WooCommerce administration. 2. Navigate to **Plugins**. 3. Select **Add New Plugin**. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7b210ae3-acb5-4bf3-ffa2-63a21ed21f97.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=6451c04fb87f5e1d1660b7d318851502) 4. Click **Upload Plugin**. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-0de172f5-f9b1-3974-0f58-6a3510870ecb.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=457a0fc63f40f452a68800cab63794d6) 5. Click **Choose File** and select **WooCommerce zip file**. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e13e7048-ea61-5e9b-cb24-934c83218053.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=384aa5480d89b6e20b0c927e448a8d17) 6. Click **Install Now**. ### Installing the Plugin from the WordPress Marketplace #### To install the plugin from the Wordpress Marketplace 1. Log in to Wordpress admin. 2. Navigate to Plugins > Add New Plugin and search for Global-e Cross-Border Integration for WooCommerce. 3. Locate the Global-e Cross-Border integration for WooCommerce app and click Install Now. > [!NOTE] > > If you are using an older version of WooCommerce Global-e PRO Integration plugin, disable it before installing the new version. The new version (Global-e Cross-Border integration for WooCommerce) adopts the existing settings. ### Upgrading The Global-e Plugin When a new version of the **Global-e Plugin for WordPress** is released in the Marketplace, a notification appears in **Plugins**. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-bbadee5e-1703-30c0-b95c-e9e94d7f958b.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=38a3878c5a3e624d723bb2281c850c84) #### To upgrade the Global-e Plugin 1. Click **Plugins**. 2. Locate the **Global-e Cross-Border for WooCommerce** app and click **Update Now**.The newest version of the app is downloaded. # Configuring the Global-e Settings Source: https://docs.global-e.com/4--configuring-the-global-e-settings ## Plugin Configuration Page You can use one of the following plug configuration methods: * [Configuring Global-e Cross Border Settings via the WooCommerce Settings Menu](/4--configuring-the-global-e-settings#configuring-global-e-cross-border-settings-via-the-woocommerce-settings-menu) * [Customizing Fields within the Global-e API Settings Section](/4--configuring-the-global-e-settings#customizing-fields-within-the-global-e-api-settings-section) ### Configuring Global-e Cross Border Settings via the WooCommerce Settings Menu #### To configure Global-e Cross Border Settings via the WooCommerce Settings menu 1. Navigate to *Woocommerce > Settings*. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a986c777-4793-afc9-bc67-70244367fccb.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=80eefbaa52b2159ef750dfffa242cdbc) 2. Click the *Integration* tab. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9f30a79c-fe63-bf9a-af27-e886519ae1aa.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=1c57029f46c0a5175f97001bacbdede0) 3. In the *GlobalE Pro Integration* section, configure the fields as needed: ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-4b6fc7da-851b-7355-c5d0-5db263055485.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=a5f08a8f6f12886397d2f5b6fe964750) The following table describes the parameters in the Global-E API Settings section: | Parameters | Description and Settings | | - | - | | Enable JS/CSS Include | ON/OFF switcher of the Global-e extension.Values: yes (default), no.If set to "no", the system does not include the Global-e CSS and JavaScript.If set to "yes", the Global-e script appears on your website. However, this script only becomes functional after the extension has been activated by Global-e. While waiting for activation, you can view the solution by adding the following query string to the site's URL: `?showpro=true`. | | Merchant ID | Merchant Account ID in the Global-e system (provided by Global-e as part of the merchant's onboarding process). | | Merchant GUID | Private key of the Merchant Account ID in Global-e (provided by Global-e as part of the merchant's onboarding process). | | API Path | Path to the Global-e API. QA environment: //glite.bglobale.com/ Staging environment: //stglite.bglobale.com/ Production environment: //gex.global-e.com/ | The following table describes the parameters in the Products section: | Parameter | Description | | - | - | | Extra Product Attributes | You can create product attributes using the standard WooCommerce functionality. By default, the Global-e extension gets and supports the Size and Color attributes. These attributes are displayed in the Global-e checkout screen, transactional emails, and the Merchant Portal View Orders interface, next to the related products. If you create additional attributes in WooCommerce, these must also be configured in the extension's Configuration screen. In the Extra Product Attributes field, add the attribute slugs as comma-separated values. | ### Customizing Fields within the Global-e API Settings Section #### To customize fields within the Global-e API Settings Section 1. Navigate to *Plugins > Installed Plugins*. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b47d4e97-83c3-e93e-bbdd-7ac83c84c7df.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=53a7ba74bde6101406d2ca1b17b90cd4) 2. In the Global-e Cross-Border for WooCommerce section, click Settings. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-81a2635c-ff45-21f2-394f-468eb7f5a6af.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=a183bf0d97b02b48809337bd8d6460f8) ## Global-E API Settings | Setting | Default | Description | | - | - | - | | Enable JS/CSS include | Off | Allows you to enable/disable external Global-e JavaScript and CSS includes. For headless integration, the setting should be disabled. | | Merchant ID | | The merchant Identifier which allows you to identify JavaScript and CSS includes. | | Merchant GUID | | The API key that is used for communication to and from Global-e. | | API path | [//stglite.bglobale.com/](https://stglite.bglobale.com/) | Defines the Global-e Module URL. Possible Values: Integration Environment: [//intgepi.bglobale.com/](https://intgepi.bglobale.com/) Staging Environment: [//stgepi.bglobale.com/](https://stgepi.bglobale.com/) Production Environment: [//gepi.global-e.com/](https://gepi.global-e.com/) | | API Base URL | [https://connect.bglobale.com/](https://connect.bglobale.com/) | Determines the Global-e environment with which to communicate. Possible values: Integration Environment: [https://connect.bglobale.com/](https://connect.bglobale.com/) Production Environment: [https://api.global-e.com/](https://api.global-e.com/) | | Include mode | PRO | Defines the Global-e Module variation. Possible values: PRO GEM | | Global-e data cookie name | GlobalE_Data | Defines the cookie name. The cookie is set by the plugin and is used by the Global-e Module. | ### Products Configure these settings to synchronize specific product attributes with Global-e. | Setting | Default | Description | | - | - | - | | Extra product attributes | | Slugs of custom attributes with copa separator (like: "attr1,attr2,attr3") | | Product attributes map | | Product attributes map. Json. Attributes slug => Attribute sign. (example: \{"attribute_pa_size":"size"} ) | | Brand Attribute | | The technical name of a product custom field used as an extra product brand attribute. | | Product class code attribute | | Product class code attribute | | Country of origin attribute | | The technical name of a product custom field used as an extra product country of origin attribute. | | Description Attribute | | The technical name of a product custom field used as an extra product description attribute. | | HS Code Attribute | | The technical name of a product custom field used as an extra product HS Code attribute. | | Weight Attribute | | The technical name of a product custom field used as an extra product weight attribute. | | Enable save product list | Ticked | Enables/disables saving product data on the Global‑e system. | ### Order | Setting | Default | Description | | - | - | - | | Unique Product identifier | SKU | Defines which product attribute is considered a unique identifier. Possible values: SKU Product ID / Variation ID | | Skip Cart Validation | False | Enables/disables cart validation on order create notifications. | | Use Shipping Method Mapping | Plugin map | Defines how the shipping method is mapped. Possible values: Plugin map - shipping method name “globale" will be used. Default - shipping method name will be used in the format: “Global-e :" plus `ShippingMethodName`. Globale map - shipping method name will be used in the format: `ShippingMethodCode`. | | Save country name as | Country name | Defines how the country of address is saved in Woocommerce. Possible values: Country name - full country name, like the United Kingdom. Country ISO code - country ISO code, like the UK. | | Add extra metadata to order items | | Extra meta, that should be added to order items .Json. MetaKey => MetaValue.(example: \{"internationalOrder":"YES"} ) | | Reconciliation VAT | Standard flow | Define how reconciliation VAT is processed. Possible values: Standard flow - product prices contain reconciliation VAT. Deduct - reconciliation VAT is deducted from product prices. | | Restock refunded products | Ticked | If checked - the system will restock products on order refund. | | Enable logger | Ticked | Enables/disables module logging. | | Add shipping cost to totals | Unticked | If checked - the system will add the shipping cost to the product's total cost. | | Allow order currency from request. | Unticked | If checked - allows a setting order currency different from a store based on the order creation request value. | ### Checkout / Order | Setting | Default | Description | | - | - | - | | JS Code on Checkout Page | var glegem = glegem \|\| function() \{ (window\["glegem"].q = window\["glegem"].q \|\| \[]).push(arguments) }; glegem("OnCheckoutStepLoaded", function(data) \{ console.log('OnCheckoutStepLoaded') switch (data.StepId) \{ case data.Steps.LOADED: console.log('OnCheckoutStepLoaded:LOADED') break; case data.Steps.CONFIRMATION: console.log('OnCheckoutStepLoaded:CONFIRMATION') if (data.IsSuccess && !data.IsPageReload) \{ console.log('OnCheckoutStepLoaded:IsSuccess') // send some statistic } break; } }); | JavaScript code that should run on the checkout page.For more specific example snippets, see [Client Analytics](/client-analytics). | | Remove coupons from cart when switching countries | Unticked | Remove coupons from cart when switching from domestic country to any other one. | | Store Code | | This is a store code. It is used by Global-e to distinguish sales channels on own domains and/or subfolders. | ## Discounts The Global-e plugin for Woocommerce supports three types of discounts: * Native Woocommerce discounts. See the [Native guide](https://woocommerce.com/document/coupon-management/). * Discounts provided by third-party module, [Discount Rules for WooCommerce](https://wordpress.org/plugins/woo-discount-rules/). * Discounts provided by third-party module, [Advanced Coupons](https://wordpress.org/plugins/advanced-coupons-for-woocommerce-free/). ## Clear Cart **Clear Cart:** This AJAX endpoint clears the cart after order confirmation. \[POST] [https://example.com/global-e/?wc-api=pro-cart-clear](https://example.com/global-e/?wc-api=pro-cart-clear) # Abandoned Carts Source: https://docs.global-e.com/abandoned-carts This section details the steps required to trigger abandoned cart emails and other abandoned cart processes. Note that Global-e must enable this feature for you. Contact your Client Success Manager to have this feature enabled. **To initiate abandoned cart emails and other abandoned cart processes:** 1. Implement the [OnCheckoutStepLoaded](/client-analytics#oncheckoutsteploaded) listener. (See [OnCheckoutStepLoaded](/client-analytics#oncheckoutsteploaded)) ``` glegem("OnCheckoutStepLoaded", function (data) { switch (data.StepId) { case data.Steps.LOADED: break; case data.Steps.CONFIRMATION: if (data.IsSuccess) { // Analytics tags can be added here } break; } }); ``` 2. Capture and store the customer’s e-mail address. Implementing this using our [Analytics](/analytics) features. ``` glegem("OnClientEvent", function (source, data) { switch (source) { case GEMerchantUtils.ClientEvents.INPUT_BLUR: if (typeof data.name != 'undefined') { if (data.name == 'CheckoutData.Email') { console.log('email changed' + data.value); } } break; } }); ``` 3. Implement the `CONFIRMATION` event case in your analytics code to remove the stored customer email since this indicates this particular cart was converted. ``` glegem("OnCheckoutStepLoaded", function (data) { switch (data.StepId) { case data.Steps.CONFIRMATION: if (data.IsSuccess) { // Mark checkout as completed/not abandoned } ``` 4. After 5 to 15 minutes, you can trigger abandoned cart email notifications or other relevant processes using the captured email address, as it signifies an incomplete checkout. ## Klaviyo If you are using Klaviyo: 1. Make sure to report that the checkout has started. Implement this by using the `data.Steps.LOADED`. (See [OnCheckoutStepLoaded Callback](/client-analytics#oncheckoutsteploaded-callback)) 2. Retrieve data about the products in the cart or trigger your existing Klavyio data layer implementation. 3. When the customer enters the email address on the Global-e checkout page, handle this event and report to Klaviyo. 4. Make sure to report the completed checkout to Klaviyo to prevent the cart from being marked as abandoned. Implement this by using the `data.Steps.CONFIRMATION` case. (See [OnCheckoutStepLoaded Callback](/client-analytics#oncheckoutsteploaded-callback)) # Accessibility Source: https://docs.global-e.com/accessibility Global‑e supports accessibility for visually impaired customers. An accessibility widget and website monitoring are available on the checkout page, for a better browsing experience. The widget complies with the regulatory requirements and WCAG2.2AA. ## Accessibility Widget The widget is displayed on the checkout page and assists visually impaired customers in easily configuring the page display for a better browsing experience. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-87a58fce-8522-af6c-b2e6-dc68b615afd1.jpg?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=77e6a74e1bc515e6c82c6c66c076e513) The widget includes the following features: * Font size * Adjustment for visual impairments * Adjustment for colour blindness * Typical view * Normalize font * Accessibility statement At the top-left of the page is a large letter **A**. Click on the **A** to access the widget. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cddac52f-bfff-7641-98f1-2d1b119a3c1e.jpg?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=773ffb67d038b60377fb3665b809e293) The widget menu opens. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2dc7228d-1410-6977-5f25-c8bc628b1aa3.jpg?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=f7574d999fc6ca4b12fdcc876bf4b2a4) ## Font Size The font size can be adjusted using the settings at the top of the widget. To increase the font size click **A+** and to decrease the font size click **A-**. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f50bbab8-2504-3194-1e88-ffac9ec73d3d.jpg?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=61a4fa013ebc17f0b6b16befefb5ee12) ## Adjustment for Visual Impairment Enabling the setting converts the checkout page colours to high contrast colours (yellow over black). > [!NOTE] > > The checkout page is hosted in an iFrame. Therefore, the checkout reflects this adjustment but the page’s header is not affected. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1bb5c460-fc4d-b355-4200-a9f0bac6feaa.jpg?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=b538d32e3124717a6584f26408ff50f8) ## Adjustment for Colour Blindness Enabling the settings for colour blindness converts the checkout page's colours to black and white. The input fields have a dark frame to facilitate view and access. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b34a0304-7d11-5494-f447-37569ff3f1d1.jpg?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=d9f6fc9c6d0439f7ea1c893b7b11338e) ## Typical View This feature returns the display to the original settings. ## Normalize Font This feature lets you display the Checkout Page in a more readable font for visually impaired users. ## Accessibility Statement This opens the Accessibility Statement, explaining how the website accessibility works. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2f86123a-c177-48a7-7d52-89a886ddbf49.jpg?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=cad6dbce89363cda1fa5c4394e45c408) ## Widget Language The widget’s language can be changed by clicking any of the four languages at the bottom. The widget supports the following languages: * Arabic * English * Hebrew * Russian ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7c775548-ef1b-2344-24c7-093ffdbc40f4.jpg?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=79ab7ca3e5849fba1a5f7dba901a6112) # Accessing Restricted Products Source: https://docs.global-e.com/accessing-restricted-products This page describes how to access **Restricted Products**. ## To access Restricted Products 1. Navigate to *Merchants > Product Management > Product Restrictions* from the top menu. 2. From the **Merchant** menu, select a merchant. The restricted product **identifier** or **name** screen is displayed: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-877a372d-34b5-8e20-5a7c-74a9d2e3b2c0.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=0a33ccf1ee5b81d32c382557ba84761e) 3. Search for your restricted product(s): * **Search Product or SKU** - type part or all of the product name or SKU number. * **Restriction Types**: * Not Restricted * Commercial * Regulatory * Dangerous Goods * **Countries**: * Click **Select All** to select all countries in the list * Make individual selections * **Date range calendar** - select a date range 4. Click **Search**. The results are displayed. 5. Continue with [Restricting Individual Products](/product-management#restricting-individual-products). # Accessing Your Policy Rules Source: https://docs.global-e.com/accessing-your-policy-rules Because Global-e configures automation per policy rule, you can combine manual and automatic processing across different scenarios. ## To access a policy rule 1. In the left menu, navigate to *Settings > Return Policy*. 2. The **Settings – Return Panel** is displayed. 3. On the right side of the screen, click **Expand all**. 4. Click the **pencil icon** located to the right of the policy rule you want to update. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e7c1c912-23af-6050-8173-b3d7a12a8c79.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=37db1ea83fac811e4b12437af9732b09) 5. The selected policy rule’s details are displayed. 6. Expand the **RMA Handling Process** section. Do one or more of the following: * Configure Auto-Approval * Configure Auto-Refund * Set Auto-Mark as Done * Set Mark as Done after Partial Validation * Enable item validation * Validate items * Verify and monitor your automation results # Add-on, Extensions, and Custom Functionality Source: https://docs.global-e.com/add-on-extensions-and-custom-functionality ## Global‑e Add-on Architecture ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9249be33-be01-5c2c-a573-bf4a2b1fddcc.svg?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=e3be01c2ef444e600b726768a58baea9) **Orange: Global‑e** Global‑e handles: * The currency conversion * The checkout for Global‑e managed countries * Order notifications for orders managed by Global‑e Global‑e manages the following main website components: * The welcome popup * The country selector * The checkout iframe **Checkout:** During the checkout, the Global‑e add-on posts the following to the Global‑e system via the `SendCartV2` API. The customer is redirected to a checkout page `checkoutDisplay.jsp`, in which Global‑e injects HTML via an iframe. **Green: Custom Global‑e add-on functionality:** * `Globaleaddon` is used for front-end changes. * `globalecore` and `globalefacades` are used to communicate with the Global‑e API. * `globaleendpoint` is used to receive order update notifications. * `globalepromotions` is used for custom Global‑e promotions. * `globalebackoffice` is used for Backoffice modifications. > [!NOTE] > > Important spring beans are aliased or overwritten by the Global‑e logic. This includes the `calculationService` and `europe1.manager`. ## Modules Architecture * Server-side browsing localisation * International Checkout from cart data * Orders in SAP Hybris were created following the native SAP Hybris creation flow with additional Global‑e Data Attributes * Fraud validation / order cancellation * Order updates (e.g. refund notifications) ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c64bb2f1-6898-55f5-9d77-a3ea6a231fba.svg?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=0a788573c6a18e033037e1f6e3d21f6b) ### globaleaddon The `globaleaddon` adds the Global‑e Country Selector and the Managed Checkout capability to the SAP Hybris Accelerator-based Storefront. The `globaleaddon` includes: * If you have a multi-site environment, you can control each website to which you want to add the Global‑e capability. * The `GlobaleSwitcherComponent` adds a widget to allow the customer to select their preferred currency and shipping country. The CSS of this component can either be stored and managed by Global‑e or stored and managed by SAP Hybris. * To enable the Global-e CSS, check the configuration “Use Global-e Default CSS". * The Global‑e checkout page includes a Global‑e iframe. The OOTB SAP Hybris Accelerator checkout flow definition is overridden by the `globaleaddon-web-spring.xml`. The global-e checkout flow is only applicable to Global‑e managed countries. * `GlobaleCookieToSessionFilter` updates the SCC session with Global‑e specific values, such as the session currency, country, culture, and activities of the customer. The cookie: `GlobalE_Data` is updated by the `GlobaleCookieToSessionFilter` filter when the customer comes to the site for the first time and has not yet selected their currency or shipping country. This is based on the location taken from the customer IP via an API call to Global‑e. ### globalecore `globalecore` places REST API calls to the Global‑e API. `globalecore` uses custom-built caching to speed up the retrieval of the Global‑e data sets from the database. ### Client The Global‑e implementation uses the `Spring RestTemplate` to communicate with the Global‑e API. The `RestTemplate` is the central Spring class for client-side HTTP access. Conceptually, it is like the `JdbcTemplate, JmsTemplate`, and the various other templates found within the Spring Framework. This means, for instance, that the `RestTemplate` is thread-safe once constructed, and that you can use callbacks to customize its operations. ### API Connection Timeouts By default, the Global‑e Add-on includes a configuration for API connection timeouts. Each timeout represents the maximum time to wait for a Global‑e API response. If there is no response by the expiration time, the call fails. Here are some examples of key values that you can see in your `local. Properties`: * `globale.api.call.timeout=2000` * `globale.api.connect.timeout=1000` * `globale.api.call.max.connections.host=100` * `globale.api.call.max.total.connections=200` ### Fixed Product Prices Fixed prices are used to define a Recommended Retail Price (RRP) per country in the local currency. Fixed prices do not change regardless of Global‑e coefficients, rounding rules, or FX rates. The fixed price selection process can be configured: **(1)** By country and currency – or – **(2)** By currency and it is active for all countries that support this feature. To enable or disable fixed prices based on country, use the Global-e API. **To activate the fallback mechanism (2),** Add the property **'globale.fixed.price.fallback.to.currency.match.enabled=true**'. The fixed price algorithm determines if a `PriceRow` contains a fixed price for the country and currency **(1)**: 1. If Global‑e has enabled the session country to allow fixed prices. 2. **AND** the type of `PriceRow` is a `GlobalePriceRow,` 3. **AND** the `PriceRow`'s `fixedPriceEnabled` equals true, 4. **AND** the `PriceRow`'s currency equals the Global‑e session's currency, 5. **THEN** the Price service selects `PriceRow` with country equals Global-e (session) `countryAlgorithm` to determine if a `PriceRow` contains a fixed price for currency **(2)**: 6. **WHEN** there is no price identified by **(1),** 7. **AND** Global‑e has enabled the session country to allow fixed prices, 8. **AND** the type of `PriceRow` is a `GlobalePriceRow`, 9. **AND** the `PriceRow`'s `fixedPriceEnabled` equals true, 10. **AND** the `PriceRow`'s currency equals Global‑e (session) currency, 11. **THEN** the Price service selects the `PriceRow` that has no defined country. ### Solr The Global‑e Add-on extends the ProductPriceValueProvider and alias with the Global‑e price value provider: GlobaleProductPriceValueProvider. The price value provider sets the session parameters to ensure that the Global-e add-on has the correct session parameters for price conversion when it creates the price information. * `GlobalESessionCountryISOCode`: taken from the `cmsSite defaultShipToCountry`. * `GlobalESessionCultureCode`: set to an empty string. * `GlobalESessionCurrencyISOCode`: not set, but `DefaultGlobaleSessionParametersService` falls back to `i18nService.getCurrentCurrency()` which is set in `ProductPriceValueProvider` taken from `IndexConfig` currencies. * `GlobalESessionSolr`: true * `catalogVersionService.setSessionCatalogVersion` to the base site’s default catalogue and version. ### globaleendpoint Global‑e sends notifications to the `globaleendpoint` module. Currently, four notifications are sent via JSON and marshalledmarshalled by the Jackson JSON Processor. POJOs corresponding to Global‑e API classes are annotated with Jackson Core (Data-Binding) annotations to facilitate proper mapping. ### globalefacades The `globalefacades`module provides simplified interfaces to the service layers. Overridden Facades include: * `DefaultCustomerFacade` is overridden by `DefaultGlobaleCustomerFacade`. If Global‑e is enabled and the Country is managed by Global‑e, this facade updates the session currency and user. * `SessionOverrideCheckoutFlowFacade` is overridden by `GlobaleCheckoutFlowFacade`. The Express checkout is never enabled for a customer whose county is enabled by Global‑e. * Custom Global‑e-specific converters and populators can also be found in `globalefacades-spring.xml`. ### globalepromotions The `globalepromotions` extension provides support for the SAP Hybris promotion engine. This extension adds the following conditions: * Global‑e-managed country condition as boolean (choose to activate the promotion if either the customer has selected a Global‑e-managed country or has selected a country that is NOT Global‑e-managed). * Qualifying country promotion with options: “IN”, “NOT IN”. The customer will qualify for the promotion if the session country is either IN or NOT IN a set of countries specified in the condition. In addition, Global‑e has overridden and replaced the OOTB SAP Hybris currency conversion logic with the Global‑e conversion rates taken from the Global‑e API. This is relevant to any action applying percentage or absolute value discounts. **Example:** * If you configure a promotion rule with an order threshold condition in Global‑e supported currency, e.g. 10 GBP, * **AND** if a customer has another cart currency, for example, CHF, with a cart total value of 15 CHF, * SAP Hybris converts GBP to CHF and evaluates the condition. In this case, if we assume Global‑e API provides 1.285 as a conversion coefficient, the condition threshold will be converted as 10 GBP = 12.85 CHF, which is under the cart value of 15 CHF, and the promotion is applied. **How it works:** * When SAP Hybris translates a promotion into a Drools rule, Global-e substitutes the static price value with ConvertablePriceValue. The ConvertablePriceValue converts and returns prices in runtime based on the Global-e conversion rules. * Global‑e also overrides the key price and discount-related RAO Actions: `GlobaleRuleOrderEntryFixedDiscountRAOAction` * `GlobaleRuleOrderEntryFixedPriceRAOAction` * `GlobaleRuleOrderFixedDiscountRAOAction` * `GlobaleRulePartnerOrderEntryFixedDiscountRAOAction` * `GlobaleRulePartnerOrderEntryFixedPriceRAOAction` * `GlobaleRuleTargetBundlePriceRAOAction` See[Known Limitations](/merchandising#known-limitations) for information about processes that may trigger an unexpected behaviour (during conversion). ### globalebackoffice `globalebackoffice` is for Backoffice changes which you can configure in: `globalebackoffice-backoffice-config.xml`. The Global‑e add-on also overrides the CurrencyTypeRenderer with the GlobaleCurrencyTypeRenderer to support sub-types of Order Entry. ## Cache ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-06c81380-06ed-e74d-672a-d576a6fb8dab.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=878af212dbb827fdf15aace80e6d9cc8) Caching is used to avoid overloading the Global‑e APIs with too many duplicate requests. Global‑e sends back data with cache-specific information in the headers of their responses and requires that you (the merchant) build a cache into your systems when connecting to the Global‑e APIs. ### Request Flow When a request is made to the integration service, the following steps take place: 1. Based on the call parameters, the cache is searched for matching data. 2. If matching data is found: 1. The data’s last update time is compared with the current time to create a stale period. 2. If this stale period is shorter than the cache expiry period, the cached data is returned with the status `UPTODATE`. 3. If this stale period is the same as or longer than the cache expiry period: 1. A request is made to the Global‑e API. 2. If the request is successful: * The resulting data is used to update the cache. * The resulting data is returned with the status `UPTODATE`. 3. If the request is not successful, the OLD data is returned with the status STALE. 3. If matching data is NOT found: 1. A request is made to the Global‑e API. 2. If the request is successful: * The resulting data is used to update the cache. * The resulting data is returned with the status UPTODATE. 3. If the request is not successful: * An exception is thrown: `GlobaleIntegrationServiceException`. Global‑e provides flow diagrams and details about which endpoints/objects to cache. A snippet of front-end activities is provided as an example below. Example of the recommended Global‑e cache behaviour flow: ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c35804e3-5bce-58d7-7f1a-a9c1ef17bcd6.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=93aa57b5cb49e5e39677bfdb393e22b5) ### Global‑e Headers All API method calls may optionally return the following headers: * Cache-Control: public * max-age=x These headers indicate the recommended client-side caching interval for the data returned by the respective call unless otherwise stated in a specific class or method definition. There is functionality to parse those headers into a usable object. ### Cache Persistence Global‑e relies on the SAP Hybris persistence for caching API data. Global‑e creates new cache types in SAP Hybris with the common ancestor `GlobaleBaseCache` to store the cache. Cache age is controlled by Global‑e. ### Data Structure and Database Indexes ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2b012f88-2ad0-41b6-ff5b-5ff284f136a6.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=548c6ee11d96f668966d729ef8eae280) ## Technical Flows ### Checkout Flow (Technical) ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-680dd770-5a4c-bfeb-f33c-284a650e7687.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=0bacb81d649ef6c263a70d0b85cb3b0f) During the customer checkout with Global‑e-enabled countries, the customer is redirected to the Global‑e iframe to complete their order. Once Global‑e completes the checkout process with the customer, Global‑e creates an order and notifies SCC via the module `globaleendpoint`. This order includes delivery details for the local Global‑e hub, along with the customer’s billing address and payment information. The JSON file is parsed and converted to a `MerchantOrder`, which is then unmarshalled again and saved as a string of JSON. To avoid information loss, if there are missing mappings in the `MerchantOrder` object, the Global-e add-on makes sure to log any requests in full coming into the web module `globaleendpoint` using the filter: `globaleRequestLogger`. 1. If Global‑e is enabled and the session country is managed by Global‑e, the customer is redirected to the Global‑e checkout (otherwise to typical checkout): * SAP Hybris creates a snapshot of the checkout cart. * SAP Hybris redirects the customer to the Global‑e checkout page. 2. When the customer submits an order, Global-e creates an internal order. * If the customer has a default shipping and billing address, the addresses are exported with the "`SendCart`" request. * If the customer aborts the checkout process, the customer is redirected back to the cart page. 3. Global‑e receives the cart data and handles the payment. If the fraud check passes successfully, Global‑e notifies SAP Hybris (`OrderPlacementController.sendOrderToMerchant`), and a merchant order is created. * The order notification includes delivery details for the local Global-e hub, along with the customer’s billing address and payment information. * The SAP Hybris order status is updated to `GLOBALE_MANAGED`. * To avoid information loss, if there are missing mappings in the `MerchantOrder` object, the Global-e add-on logs any requests coming into the web module `globaleendpoint` using the filter `globaleRequestLogger`. 4. Global‑e manages the order fulfilment lifecycle (see the `OrderPlacementController`). * Global‑e updates the order status and registers the status history: `globaleOrderStatusHistory` * The current order status is reflected in the custom attribute: GlobaleOrder.currentOrderStatus * Global‑e can remove the session customer cart on order create/update, based on the `Merchant.Order`'s `ClearCart` flag. 5. Global‑e fires the following events that are integrated into the order’s lifecycle: * `SendOrderToMerchantEvent` * `PerformOrderPaymentEvent` * `UpdateOrderShippingInfoEvent` * `UpdateOrderStatusEvent` ### Global‑e Price Calculation Flow (Technical) ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2ccab1dd-fa1f-2d98-9cf2-dac99543bb23.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=e9b8f154d2c7305dc16e5bad40a888e3) The Global‑e flow shows that the custom price factory takes control of creating price information. This allows the product data object to be populated with price rows that are converted and rounded to display on the front end. The recalculation of a cart forces the price information to go through the same process (price rows converted and rounded). Tax information is managed by Global-e. The Global‑e cache takes precedence over making a Global‑e API call. Below is a list of the cache entities managed by the Global‑e add-on: * GlobaleRoundingRulesCache * GlobaleCountryCoefficientsCache * GlobaleLocationDefaultCultureCache * GlobaleCurrenciesCache * GlobaleCurrencyRatesCache * GlobaleLocationByIpCache * GlobaleCountriesCache * GlobaleGenericSettingsCache * GlobaleProductCountryCache Rounding rules, country coefficients, and currency rates are used when converting prices. ### Typical Price Calculation Flow (Technical) ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b8577550-30e3-86c5-4bdc-bd9fd69e1b0c.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=82c53ffda86a4414ac5202da264d59da) Non-Global‑e flow is OOTB behaviour apart from one aspect, in the case SCC tries to use its currency conversion logic. This happens in the following circumstances: 1. The country is not managed by Global‑e. 2. The customer selects a currency for which the product does not have a price row. 3. SCC cannot find a price row and tries to apply the OOTB conversion logic. In the above example, we will fall back to the standard Global‑e conversion flow over the OOTB SCC conversion logic. ### User Country and Currency Preference Flow (Technical) ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9a7712cc-e06f-d69c-4298-9a797ce3f612.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=1e9dbcbde864710f21cd3277b16c5bee) Global‑e always displays: * The country and currency selector, even if it does not manage the country. * A “first-time” popup for the customer, if Global‑e cannot find an existing cookie. Cookies are managed by Global‑e by injecting JavaScript. For this feature to work, the customer must have cookies enabled when browsing the site. Global‑e injects JavaScript and CSS into the website to provide functionality such as the welcome popup, country switcher, checkout form, and more. In the backend, the GlobaleCookieToSessionFilter custom filter sets up the session based on the customer's chosen country and currency. This is taken directly from the Global‑e cookie: GlobalE_Data. If the country and currency or currency cannot be found, Global‑e uses the customer’s location by IP and converts the IP into a country, currency, and culture. If the Global‑e add-on cannot find the location of the IP (e.g., when testing locally), the country, currency, and culture session parameters are set to the default value: * GlobalESessionCountryISOCode = the current site’s default ship-to-country * Global Session Currency ISO Code = the current base store’s default currency * GlobalESessionCultureCode = not set (not mandatory) ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e0ec47cc-b0fb-1c4a-e3f0-9e5cac17f646.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=f1bba4a255fa1b475ccc3a987ef51b4e) When a customer uses the popup to change their country and currency: * The Global‑e cookie is updated with the new country or currency. * The custom GlobaleCookieToSessionFilter updates the SCC session parameters that are used when calculating price conversions. # Adding a New User Source: https://docs.global-e.com/adding-a-new-user Owner and Admin users have the ability to add new users. ## To add a new user 1. Click the email address in the top right corner of the dashboard. 2. From the **Account** dropdown menu, select **STORE ACCOUNT**. 3. Click **ADD USER**. 4. Fill in the required user information, such as name and email address. 5. Select the **Role** for the user. 6. Select the **RMA Creation Permissions** setting to be applied for this user. 7. Click the save icon to save the changes. An email invitation is sent to the new user(s). # Adding a New User Source: https://docs.global-e.com/adding-a-new-user-703408 Owner and Admin users have the ability to add new users. ## To add a new user 1. Click the email address in the top right corner of the dashboard. 2. From the **Account** dropdown menu, select **STORE ACCOUNT**. 3. Click **ADD USER**. 4. Fill in the required user information, such as name and email address. 5. Select the **Role** for the user. 6. Select the **RMA Creation Permissions** setting to be applied for this user. 7. Click the save icon to save the changes. An email invitation is sent to the new user(s). # Additional Integration Features Source: https://docs.global-e.com/additional-integration-features-281111 For deploying storefront modifications [click here](/storefront-modifications-liquid-storefronts). ## Marketing Feeds (Liquid Storefronts) This section has moved. See [Shopping / Marketing Feeds (Liquid Storefronts)](/shopping---marketing-feeds). ## MID Support U.S. Customs requires the **Manufacturer's Identification (MID)** code for certain shipments to the United States. ### What is Manufacturer’s Identification? Manufacturer's Identification (MID) includes details of the manufacturer of the goods which is required in some cases by the US customs. MID includes the full business name and postal address of the manufacturing supplier as well as a specific code based on the manufacturer's name and country. ### What do you Need MID For? * Any order shipped to the USA, no matter the value, that includes at least one product manufactured in China/Hong Kong. * Any shipment to the USA with a declarative value to customs higher than \$2,500 (regardless of the Country of Origin of the products). ### Configuration You must configure the following fields: * **MIDCode**: A unique identifier generated from the manufacturer's name and location. * **MIDAddress**: The full postal address of the manufacturing supplier. * **MIDName**: The complete business name of the manufacturing supplier. ### Generating a MID Code The Global-e Crossborder app gets the MID information from the **Product Metafields** in the **Products** section. If the required data is not already available in your system or cannot be obtained from your manufacturer(s), you can generate the MID Code by following the steps below. ### To generate a MID code: 1. Collect Supplier Information: Ensure your manufacturing supplier has provided their complete business name and postal address. This information is essential for defining the MID code. 2. Generate the MID code: 1. Identify the two-letter ISO country code for the supplier’s country (e.g., GB for the United Kingdom, NL for the Netherlands, DE for Germany). 2. Use the first three letters of the supplier's first and second names (if applicable). 3. Extract the highest numerical digits (up to four) from the address line. 4. Use the first three letters of the supplier’s city name. The following is an example: **Supplier**: Ozrock, 92 Alice Springs Road, Melbourne, Victoria, Australia, 3001 **MIDCode:** AUOZR92MEL ### Configuring the MID Address and MID Name No special formatting is required for the MID Address and MID Name fields. These fields should be filled exactly as provided by the supplier's data, as shown in the following example: **MIDAddress**: 92 Alice Springs Road, Melbourne, Victoria, Australia, 3001 **MIDName**: Ozrock ### Adding MID to Shopify For Global-e to provide the MID information to the carrier and display it on the commercial invoice, this data must be available in Shopify and transferred to Global-e using the following configuration. ### To add MID to Shopify 1. Create the relevant Shopify metafields: 1. In Shopify, navigate to **Settings** > **Custom Data** > **Products** > **Add definition**. For more information see the [Shopify Metafield Guide](https://help.shopify.com/en/manual/metafields). > [!NOTE] > > If the manufacturer of your goods can vary between variants of the same product, the metafields should be created as **variant metafields** in Shopify, rather than as **product metafields**. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-68e02da3-99fe-17a0-a128-30a4719e2da1.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=f7a67ed346caf6019acf959022bf5cd4) 2. Add the following three metafield definitions: > [!WARNING] > > Make sure to add these definitions exactly as they appear here. Modifying names, namespaces/keys, or content types can cause errors. | Name | Namespace and key | Content type | | - | - | - | | MIDCode | `mid_info.midcode` | Single line text | | MIDName | `mid_info.midname` | Single line text | | MIDAddress | `mid_info.midaddress` | Single line text | 2. Update each product/variant’s metafields with specific MID data. * These can either be edited in bulk, or added to each product/variant individually. * If you have various manufacturers with different IDs, the metafields should be set individually for each product/variant so they reflect the manufacturer they originate from. # Address Autocomplete Source: https://docs.global-e.com/address-autocomplete The Address Autocomplete functionality simplifies and speeds up the checkout process. As a shopper begins typing in their address, the system automatically provides suggestions, allowing them to select the correct address. This ensures all address fields are filled out accurately and efficiently. By enhancing accuracy, the Address Autocomplete feature supports more precise deliveries while aligning with industry best practices. ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/uuid-03c646fc-5535-5c6d-1e82-09187ec05a75.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=5a0e569e4f16a5646abff21ec889a856) Address autocomplete can be used in **Address Line 1** or the **Zip code** field. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c0432c15-e694-58c4-f81e-d683750e7e24.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=06cd129e6e4ab0ded7f4ce863e3ce95b) > [!NOTE] > > Input is supported in English and for special characters. ## Autocomplete Customizations The following customizations can be added upon request for customers whose address fields are not covered by standard billing and mailing forms. * Address line 1: * Route and street number * Neighborhood * Address line 2: * subarea * City/district/canton/province # Address Form Experience Source: https://docs.global-e.com/address-form-experience The Checkout page address form is designed with shoppers in mind, offering multiple input methods, robust validations, and localized support to ensure a seamless and accurate checkout experience. Whether entering an address manually, using autocomplete, or selecting from saved addresses, shoppers are guided every step of the way. ## Filling in the Address Form When shoppers reach the address form in the checkout page, they are presented with a dynamic and intuitive experience designed to simplify the entry of billing and shipping addresses. **Options for Entering an Address** * **Manual Input**: Shoppers can manually type their address into the form fields. Field hints and validations guide users to input accurate and formatted data. * **Autocomplete** (Available in US and AU): Shoppers can begin typing their address, and autocomplete suggestions powered by Google Autocomplete appear below the field. Selecting an option automatically populates the remaining address fields, reducing errors and speeding up the process. * **Saved Addresses for Registered Users**: If the shopper is a registered user, previously saved addresses are displayed in a dropdown menu. Selecting a saved address autofills the form. * **Browser Autofill**: If enabled in the shopper's browser, saved address data can autofill the fields directly. ## Language Support Shoppers can enter their address in local languages (by configuration). While the input is accepted in local characters, currently, it is not translated into other languages. Format validations ensure compatibility with regional requirements. ## Customizing the Address Form The address form and field names can be customized, however some fields are mandatory for all address forms. For more information see [Address Field Formats and Error Handling](/address-validation#address-field-formats-and-error-handling). ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8ee13854-e0bb-33fc-ffbd-0c29978530ee.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=ebb5f872234744131ae582bac589b467) ## Field Hints Hints can be added to the address and billing fields to guide customers by displaying the required input format. ![](https://mintcdn.com/globale-enterprise/cYihTxDRUR1El6Rb/images/f908e014-2891-4b0f-894a-775d59b6b0ca-9796c7.png?fit=max\&auto=format\&n=cYihTxDRUR1El6Rb\&q=85\&s=b79b3cbb182bc4005b5fff612aeb31f8) ## Supported Characters The following requirement defines a list of characters that the checkout supports: * Basic regex: "**(^\[, A-Z, a-z,0-9,""'\s@&%$#\*._\-\s\\/]*$)**" * Special Characters for non-English languages (accents). If a field should allow a different set of characters, the characters can be specified in the requirement. ## Error Handling **Real-Time Feedback** Shoppers receive immediate error notifications for incorrect or incomplete fields. Errors are highlighted in red, with an "X" symbol and explanatory text. **Correction Guidance** Clear instructions are provided to resolve issues, such as "Please enter a valid postal code for your region." # Address Management for Registered Users Source: https://docs.global-e.com/address-management-for-registered-users For registered customers, the system supports receiving a list of saved addresses directly from the merchant, provided the merchant has the MAS setting enabled. **How it works** Saved addresses provided by the merchant are validated to ensure their accuracy and usability. Once validated, they are mapped within the system for seamless integration during checkout. **Address Display** * **Multiple Valid Addresses:** When more than one valid address is available, a dropdown menu is presented at checkout, allowing customers to select their preferred address. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1d57c943-0ed3-b629-cdb0-61fd186866bf.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=9b8b62101e854395cc795b2aaa5aa8d7) * **Single Valid Address**: If only one valid address is available, the dropdown is not displayed. Instead, the address is shown in "preview mode," indicating it is ready for use in order creation. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5cb9d675-a589-caba-e68a-ec378e4c1bdc.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=d6a70afb9bf51604279261f29704ea89) **Invalid or Incomplete Address** If the saved address fails validation, the system displays an address form pre-filled with available components and highlights validation errors for correction. ## Registered Users Registered users can view and select from previously saved addresses. Dropdown menu displays the address name or key details for easy identification. Browser autofill is supported for faster input. Address fields automatically populate if the browser detects stored data. # Address Field Validations Source: https://docs.global-e.com/address-validation ## Address Field Validations ### Validating the Checkout Page Address Fields The address information submitted on the Checkout Page is important to ensure the order is shipped to the right destination. Validations are also performed on the field level. ### Address Field Formats and Error Handling The address form contains address fields with the following formats and error notifications. | Field | Format | Error notifications | | - | - | - | | Address Line1 | *Maximum length is 35 characters.* *If the shipping method is one of the following:*   – *Express*   – *ExpressCourierWithoutSameDay*   – *Standard\*\*A PO Box won’t be accepted as an address without a delivery address.* When unsupported characters are identified, the field is marked and a notification is displayed. Allows letters, numbers, and specific special characters. Additional format validation may be configured per country. | When the 36th character is attempted a notification is displayed:You’ve reached the maximum limit for Address Line 1 field. Please use Address Line 2 if you need more space”![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-dcf0385d-0a8d-3b34-e6e2-f6893d7954aa.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=550b1c2297820f8c2e9b2562ff59a7a2)The following notification displays:**Title**: PO box address is not allowed on this shipping method**Content**: Dear Customer, The courier service you have selected requires a signature upon delivery. We are therefore unable to accept orders to a PO box address. To continue, please provide an alternative shipping address | | Address Line 2 | *Maximum length is 35 characters.\*\*Additional characters are not accepted.* *If the shipping method is one of the following:*   – *Express*   – *ExpressCourierWithoutSameDay*   – *Standard\*\*A PO Box won’t be accepted as an address without a delivery address.* When Unsupported characters are identified the field is marked and notification displays. Allows letters, numbers, and specific special characters. Additional format validation may be configured per country. | The following notification displays when a PO Box is added as an address to the shipping methods mentioned:**Title**: PO box address is not allowed on this shipping method Content:**Dear Customer**, The courier service you have selected requires a signature upon delivery. We are therefore unable to accept orders to a PO box address. To continue, please provide an alternative shipping address | | City/Suburb | *Maximum length is 35 characters*. Offers dropdown suggestions and dynamic city-region pairing for select countries. Allows letters and hyphens.When unsupported characters are identified, the field is marked and a notification is displayed. Additional format validation may be configured per country. | When unsupported characters are identified, the field is marked in red and the checkout can not be completed until it is fixed. | | Country | Changing the default country requires that the customer fills out a delivery address that is different from the billing address. Country-specific address formatting and restricted country lists for some merchants. | | | County/Province/State | A dropdown menu for some regions that includes counties, states, or provinces.For more details please see the [Counties, States, and Provinces](/countries-supported#counties--states--and-provinces) section. | | | Email | For registered users, pre-filled and locked if email already provided. *The following information defines what a valid email address is, based on:* [https://en.wikipedia.org/wiki/Email_address](https://en.wikipedia.org/wiki/Email_address) *Valid email addresses must comply with the following:* *Uppercase and lowercase Latin letters (A–Z,\*\*a–z) (ASCII: 65–90, 97–122)\*\*Digits 0 to 9 (ASCII: 48–57)* \*These special characters:\*\*# - \_ \~ ! \$ & ' + \| \{} = “ / @\*\*Character. (dot, period, full stop), ASCII 46, provided that it is not the first or last character, and provided that it does not appear consecutively (e.g. [John..Doe@example.com](mailto:John..Doe@example.com) is not allowed).\**Special Characters for non-English languages (accents).* | When an incorrect character is submitted, the field is marked in red, and an “X” is displayed on the right side.![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-58990c99-6ef4-4534-b4df-6f2f8dc0a869.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=75b49da824b3ee3d5a563e30b870fa3b)On mouseover, an “Email not Valid” tooltip is displayed![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-56022386-34ea-3055-dff2-7ef6269b0fde.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=7445e17ed92e7030551d144a3063aafa) | | First Name | Maximum length is 40 Characters Cannot contain special characters or numbers. When unsupported characters are identified, the field is marked, and a notification is displayed. For more information about Special Characters, please see the [Supported Characters](/address-form-experience#supported-characters) section. | When unsupported characters are identified the field is marked in red and the checkout can not be completed until it is fixed. | | Last Name | Maximum length is 40 Characters Cannot contain special characters or numbers. When unsupported characters are identified, the field is marked and a notification is displayed. For more information about Special Characters, please see the [Supported Characters](/address-form-experience#supported-characters) section. | When unsupported characters are identified the field is marked in red and the checkout can not be completed until it is fixed. | | Phone | *Following characters are allowed: Numbers, “+”, “-“, “/”, “(“ and “)”* *Maximum length is 15 characters* When unsupported characters are identified, the field is marked and a notification is displayed. Drop-down menu of country prefixes can be enabled for applicable countries. Additional format validation may be configured per country. For more details please see the Phone Field Validations per Country section | | | Zip/Postcode | *Maximum length is 10 Characters* When unsupported characters are identified, the field is marked and a notification is displayed. *There is a configuration per country whether this field is mandatory or not* Additional format validation may be configured per country. For more details please see the [Zip/Postcode Field Validations per Country](/address-validation#zip-postcode-field-validations-per-country) section | When no input is available, a mouseover displays a tooltip:"Billing Zip/Postcode is required"![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9ccb168a-f54f-2683-8e71-71b76ada0eba.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=cfb4925abf56f8f54e4c93746e2f2ac9)When unsupported characters are identified the field is marked in red and the checkout can not be completed until it is fixed. | ### Phone Validation Flow in Checkout #### Why We Introduced This Change Shoppers often enter phone numbers in inconsistent ways—missing country codes, typing leading zeros, or using invalid formats. This leads to: * Failed deliveries or shipping delays. * Checkout errors that block order completion. To solve this, we’ve launched a new phone validation flow (for merchants who use the dropdown phone field). It ensures all shopper phone numbers are collected, validated, and stored in a consistent, global format. #### What’s New for Merchants * **Structured validation:** Phone numbers are automatically checked and formatted to international E.164 standards on the server side. * **Real-time feedback:** Shoppers still receive clear guidance while typing, but validation that previously failed on the client side now succeeds after being corrected on the backend. * **Data accuracy:** Stored numbers are always valid, deliverable, and standardized. * **Configuration:** You can enable validation globally or per-country. #### Shopper Experience in Checkout **Before (old flow):** Shopper types 09876543211 → checkout rejects the number immediately on the client side. **Now (new flow):** * Shopper types 09876543211 (UK) → shopper sees no blocking error; system auto-removes the leading zero on the server side and saves as +449876543211. * Shopper types invalid characters (98765abc321) → shopper receives a clear error message with guidance to fix the input. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-38a2cad4-fd6a-a27b-8f49-4bfddb4a2981.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=0372623268fab47de3de2b636a1b7019) #### Configuration and Enablement This feature applies only if you use the dropdown phone field in checkout. If you’d like to enable this feature, contact your Global-e representative. Global-e can turn on the new validation for all countries or only for selected markets. Until it is turned on, the current validation logic remains. If you need your own validation rules, Global-e can also set them up so that they override the global validation. #### Examples of Allowed Inputs The following table shows examples of allowed inputs: | Shopper Input | Selected Country | Saved Output | Accepted? | | - | - | - | - | | 9876543211 | USA | +19876543211 | Yes | | 02081234567 | UK | +442081234567 | Yes | | 20812 34567 | UK | +442081234567 | Yes | | 08034567890 | Japan | +818034567890 | Yes | The following figure shows the error message that occurs when you leave a mandatory field blank or enter an invalid number. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c022e071-17f2-f876-df67-aadd3d76140f.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=28ddd6c89ead38c1dcd1507b4607fe87) The following figure shows how correct information looks. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d93911be-1ef1-2f50-e53d-24a8c8c8a3ec.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=e3c70fb79a01fc5c63c9e16e7771d10a) #### Shopper Error Messages If a shopper enters an invalid number, the following error message is displayed. “Invalid phone number format. Expected phone country: \{Country Name}. Please adjust your number accordingly.” #### Benefits for Merchants * 📦 Fewer failed shipments due to invalid numbers. * 💬 Clear shopper guidance reduces support tickets. * 📊 Clean, standardized phone data across your orders. * 🚀 Proven impact on conversion rates by removing friction. **New UI Experience:** * Easy country search by name or code. * Restricts input to digits only for cleaner validation. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9da83dbb-2583-9e6e-4edf-9ae296120c05.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=8cd98e59acbe0e8444e3040ff8126c56) ### Zip/Postcode Field Validations per Country In addition to the general field validations, a zip field format validation is configured for specific countries. Specific validations can be set per Merchant. | Country | Field | Validation | Additional Info | | - | - | - | - | | Albania | Post Code | 4 digits | | | Algeria | Post Code | 5 digits | | | Andorra | Post Code | 2 Capital letters and 3 digits (AB123) | | | Angola | Post Code | | Field Optional | | Antigua and Barbuda | Post Code | | Field Optional | | Argentina | Post Code | 4 digits | | | Armenia | Post Code | 4 digits | | | Aruba | Post Code | | Field Optional | | Austria | Post Code | 4 digits | | | Australia | Post Code | 4 digits | | | Azerbaijan | Post Code | 4 digits | | | Bahamas | Post Code | | Field Optional | | Bahrain | Post Code | | Field Disabled. Sending "00000" | | Belarus | Post Code | 6 digits | | | Belize | Post Code | | Field Optional | | Belgium | Post Code | 4 digits | | | Benin | Post Code | | Field Optional | | Bolivia | Post Code | | Field Optional | | Bonaire, Saint Eustatius and Saba | Post Code | | Field Optional | | Botswana | Post Code | | Field Optional | | Bouvet Island | Post Code | | Field Optional | | Bulgaria | Post Code | 4 digits | | | Burkina Faso | Post Code | | Field Optional | | Burundi | Post Code | | Field Optional | | Central African Republic | Post Code | | Field Optional | | Cambodia | Post Code | 6 digits | | | Cameroon | Post Code | | Field Optional | | Canada | Post Code | 5 or 6 digits | In one of the following formats: A1A 1A1 or A1A 1A | | Chad | Post Code | | Field Optional | | Chile | Post Code | 7 digits | | | China | Post Code | 6 digits | | | Colombia | Post Code | 6 digits | | | Comoros | Post Code | | Field Optional | | Congo | Post Code | | Field Optional | | Congo, Democratic Republic | Post Code | | Field Required | | Cook Islands | Post Code | | Field Optional | | Costa Rica | Post Code | 5 digits | | | Cote D'Ivoire (Ivory Coast) | Post Code | | Field Optional | | Croatia | Post Code | 5 digits | | | Curacao | Post Code | | Field Optional | | Cyprus | Postal Code | 4 digits | | | Czech Republic | Post Code | 5 digits | | | Denmark | Post Code | 4 digits | | | Djibouti | Post Code | | Field Optional | | Dominica | Post Code | | Field Optional | | East Timor | Post Code | | Field Optional | | Ecuador | Post Code | 6 digits | | | Egypt | Post Code | 5 digits | | | Equatorial Guinea | Post Code | | Field Optional | | Eritrea | Post Code | | Field Optional | | Estonia | Post Code | 5 digits | | | Fiji | Post Code | | Field Optional | | Finland | Post Code | 5 digits | | | France | Post Code | 5 digits | | | French Southern Territories | Post Code | | Field Optional | | Gabon | Post Code | | Field Optional | | Gambia | Post Code | | Field Optional | | Germany | Post Code | 5 digits | | | Ghana | Post Code | | Field Required | | Greece | Post Code | 5 digits | In the format XXX XX or XXXXX | | Grenada | Post Code | | Field Optional | | Guatemala | Post Code | 5 digits | | | Guinea | Post Code | | Field Required | | Guyana | Post Code | | Field Optional | | Hong Kong | Post Code | | Field Disabled | | Hungary | Post Code | 4 digits | | | Iceland | Post Code | 3 digits | | | India | Post Code | 6 digits | | | Indonesia | Post Code | 5, 6 digits | | | Ireland | Post Code | 7 digits or 7 characters (Eircode) | | | Israel | Post Code | 7 digits | | | Italy | Post Code | 5 digits | | | Jamaica | Post Code | | Field Optional | | Japan | Post Code | 7 digits (XXXXXXX or (XXX-XXXX) | | | Kazakhstan | Post Code | 6 digits | | | Kiribati | Post Code | | Field Optional | | Korea (North) | Post Code | | Field Optional | | Kuwait | Post Code | 5 digits | | | Liberia | Post Code | | Field Optional | | Libya | Post Code | | Field Optional | | Luxembourg | Post Code | 4 digits | | | Macau | Post Code | | Field Disabled. Sending "999087" | | Malawi | Post Code | | Field Optional | | Malaysia | Post Code | 5 digits | Field Optional | | Mali | Post Code | | Field Optional | | Mauritania | Post Code | | Field Optional | | Mauritius | Post Code | | Field Required | | Mexico | Post Code | 5 digits | | | Moldova | Post Code | 4 digits | | | Monaco | Post Code | | Field Disabled. Sending "98000" | | Mongolia | Post Code | 5 digits | | | Montenegro | Post Code | 5 digits | | | Montserrat | Post Code | | Field Required | | Morocco | Post Code | 5 digits | | | Namibia | Post Code | | Field Required | | Nauru | Post Code | | Field Required | | Nigeria | Post Code | 6 digits | | | New Zealand | Post Code | 4 digits | | | Netherlands | Post Code | 4 digits and 2 letters (1235 AB) | | | Netherlands Antilles | Post Code | | Field Optional | | Niue | Post Code | | Field Required | | Northern Macedonia | Post Code | 4 digits | | | Norway | Post Code | 4 digits | | | Oman | Post Code | 3 digits | | | Panama | Post Code | | Field Required | | Philippines | Postal Code | 4 digits | | | Poland | Post Code | 5 digits (XX-XXX) | | | Portugal | Post Code | 7 digits (XXX-XXXX) | | | Qatar | Post Code | | Field Disabled. Sending "00000" | | Reunion | Post Code | 5 digits | | | Romania | Post Code | 6 digits | | | Russia | Post Code | 6 digits | | | Rwanda | Post Code | | Field Required | | Saint Kitts and Nevis | Post Code | | Field Required | | Saint Lucia | Post Code | | Field Required | | Sao Tome and Principe | Post Code | | Field Optional | | Saudi Arabia | Post Code | | Field Disabled. Sending "00000" | | Senegal | Post Code | 5 digits | | | Serbia | Post Code | 5 digits | | | Seychelles | Post Code | | Field Optional | | Sierra Leone | Post Code | | Field Optional | | Singapore | Post Code | 6 digits | | | Sint Maarten | Post Code | | Field Optional | | Slovenia | Post Code | 4 digits | | | Solomon Islands | Post Code | | Field Optional | | Somalia | Post Code | | Field Optional | | South Africa | Post Code | 4 digits | | | South Korea | Post Code | 5 digits no dash | | | South Cudan | Post Code | | Field Optional | | Spain | Post Code | 5 digits | | | Sri Lanka | Post Code | 4 digits | | | Suriname | Post Code | | Field Optional | | Syria | Post Code | | Field Optional | | Sweden | Post Code | 5 digits | | | Tanzania | Post Code | | Field Required | | Thailand | Post Code | 5 digit | | | Togo | Post Code | | Field Optional | | Tokelau | Post Code | | Field Optional | | Tonga | Post Code | | Field Optional | | Trinidad and Tobago | Post Code | | Field Optional | | Tunisia | Post Code | 4, 5 digits | | | Turkey | Post Code | 5 digits | | | Tuvalu | Post Code | | Field Optional | | Uganda | Post Code | | Field Required | | Ukraine | Post Code | 5 digits | | | United Arab Emirates | Post Code | | Field Disabled. Sending "00000" | | United Kingdom | Post Code | Length is 5 to 8 characters. Format begins with 1-2 uppercase letters followed by 1-2 digits, optionally a single letter, a space (optional), then ends with 1 digit and 2 uppercase letters. Supports valid formats like SW1A 1AA, W1A 0AX, etc | | | United States | Post Code | 5 or 9 (XXXXX-XXXX) digits | In the format XXXXX or XXXXX-XXXX | | United States Minor Outlying Islands | Post Code | | Field Optional | | Uzbekistan | Post Code | 6 digits (XXX XXX or XXXXXX) | In the format XXXXXX or XXX XXX | | Vanuatu | Post Code | | Field Optional | | Venezuela | Post Code | 4 digits | | | Yemen | Post Code | | Field Optional | | Zimbabwe | Post Code | | Field Optional | # Advanced Checkout Events Source: https://docs.global-e.com/advanced-checkout-events ## Advanced Checkout Events **Global‑e Checkout Analytics** enables merchants to track and analyze detailed checkout-related activities by integrating with their analytics platforms. Merchants can listen to **Advanced Checkout Events** in their code and trigger custom events based on customer interactions. Unlike standard checkout events, which only capture key milestones like **checkout started** and **purchase confirmation**, **Advanced Checkout Events** provide a deeper level of tracking. These events allow merchants to monitor additional actions within the checkout flow, such as form interactions, selection changes, error messages, and engagement with on-page elements. By leveraging these events, merchants gain richer insights into shopper behavior, helping them optimize the checkout experience and reduce friction. ## Business Events Business Events help merchants identify trends, optimize checkout flows, and troubleshoot issues that may prevent successful order completion. ### ADD_NEW_SHIPPING_ADDRESS > [accordion] Show details > > This event is triggered when a customer chooses to provide a shipping address that is different from the billing address during the checkout process. It signals the start of entering a new shipping address and reflects the customer's decision to separate shipping and billing details. > > **This event does not include any data or payload.** > > **Examples** > > ``` > POST {globale domain}/Return/GetReturnDocuments > > ``` ### BILLING_ADDRESS_COMPLETED > [accordion] Show details > > This event is triggered when a user completes and successfully validates all required billing address fields during the checkout process. It ensures that the billing information is fully entered and meets the necessary validation criteria. > > Examples of mandatory fields: > > * `First Name`: The first name of the person being billed (e.g., "John"). > * `Last Name`: The last name of the person being billed (e.g., "Doe"). > * `Address`: The full street address (e.g., "123 Main St, Apartment 4B"). > * `Phone Number`: A valid contact number (e.g., "+1-123-456-7890"). > > **This event does not include any data or payload.** > > **Examples** > > ``` > // Subscribe to the BILLING_ADDRESS_COMPLETED event > var glegem = glegem || function() { > ((window["glegem"] = window["glegem"] || {q:[]}).q = window["glegem"].q || []).push(arguments); > }; > glegem("OnClientEvent", function (source) { > if (source === GEMerchantUtils.ClientEvents.BILLING_ADDRESS_COMPLETED) { > console.log("Event: BILLING_ADDRESS_COMPLETED"); // No additional data provided > } > }); > ``` ### CHECKOUT_FAILURE > [accordion] Show details > > This event is triggered when an issue occurs during the checkout process, ranging from minor errors to critical blockages that prevent the customer from completing their purchase. Examples include product restrictions for a specific country, payment validation failures, or exceeding allowable weight limits for shipping. > > * `failureCode`: Indicates the type of issue that occurred during the checkout process. Possible values include: > > * `RestrictedProducts`: Products in the cart are restricted in the selected shipping country. > * `UpdateShippingCountryFailed`: The shipping country could not be updated successfully. > * `NoShippingOptions`: No shipping options are available for the selected address. > * `DutyThresholdOverFormalClearance`: The order exceeds the duty threshold requiring formal clearance. > * `PaymentDeclined`: The payment method was declined. > * `TechnicalError`: A technical error occurred during the checkout process. > * `SessionExpired`: The checkout session expired before completion. > * `NoPrepayForceDDP`: Prepayment of duties and taxes is not available for the order. > * `CartValidation`: The cart failed validation checks. > * `CouponAmountTooLow`: The applied coupon amount is below the required minimum value. > * `reasonCode`: Provides additional details about the specific failure, if available. This property may be null in some cases. > > **Examples** > > ``` > // Subscribe to the CHECKOUT_FAILURE event > var glegem = glegem || function() { > ((window["glegem"] = window["glegem"] || {q:[]}).q = window["glegem"].q || []).push(arguments); > }; > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.CHECKOUT_FAILURE) { > console.log("Event: CHECKOUT_FAILURE"); > // Handle the 'failureCode' property > if (data.failureCode) { > console.log(`Failure Code: ${data.failureCode}`); > switch (data.failureCode) { > case "RestrictedProducts": > console.log("Reason: Products are restricted in the selected shipping country."); > break; > case "UpdateShippingCountryFailed": > console.log("Reason: Failed to update the shipping country."); > break; > case "NoShippingOptions": > console.log("Reason: No shipping options are available for the selected address."); > break; > case "DutyThresholdOverFormalClearance": > console.log("Reason: Order exceeds the duty threshold requiring formal clearance."); > break; > case "PaymentDeclined": > console.log("Reason: Payment was declined."); > break; > case "TechnicalError": > console.log("Reason: A technical error occurred during checkout."); > break; > case "SessionExpired": > console.log("Reason: The checkout session expired."); > break; > case "NoPrepayForceDDP": > console.log("Reason: Prepayment of duties and taxes is not available for this order."); > break; > case "CartValidation": > console.log("Reason: The cart failed validation checks."); > break; > case "CouponAmountTooLow": > console.log("Reason: Applied coupon amount is below the required minimum."); > break; > default: > console.log("Reason: Unknown failure code."); > } > } > // Handle the 'reasonCode' property, if available > if (data.reasonCode) { > console.log(`Reason Code: ${data.reasonCode}`); > } else { > console.log("No additional reason code provided."); > } > } > }); > > ``` ### PAYMENTMETHOD_CHANGED > [accordion] Show details > > This event is triggered when a customer selects or changes their payment method during checkout. For credit cards, the event is fired as soon as the card type (e.g., Visa, Mastercard) is recognized while the customer is typing their card details. For alternative payment methods, such as PayPal, the event is triggered when the customer selects or switches to a different payment option. > > The `PAYMENTMETHOD_CHANGED` event provides information about the payment method selected by the customer: > > * `id`: Specifies the unique identifier of the selected payment method. > * `name`: Specifies the name of the selected payment method. Examples: > > * `PayPal`: When the customer selects `PayPal`as the payment method. > * `Visa`: When the customer selects `Visa`as the payment method. > * `ApplePay`: When the customer selects `ApplePay`as the payment method. > > **Examples** > > ``` > // Subscribe to the PAYMENTMETHOD_CHANGED event > var glegem = glegem || function() { > ((window["glegem"] = window["glegem"] || {q:[]}).q = window["glegem"].q || []).push(arguments); > }; > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.PAYMENTMETHOD_CHANGED) { > console.log("Event: PAYMENTMETHOD_CHANGED"); > // Print the payment method name and ID > if (data.id && data.name) { > console.log(`Payment Method Selected: ${data.name} (ID: ${data.id})`); > } > } > }); > ``` > > **Implementation Tips and Best Practices** > > The `PAYMENTMETHOD_CHANGED`event does not capture clicks on express payment methods, such as Apple Pay or Google Pay. These methods often bypass the standard payment selection process, and their interactions may need to be tracked separately through DOM events or platform-specific integrations. ### SHIPPING_ADDRESS_COMPLETED > [accordion] Show details > > This event is triggered when a user completes and successfully validates all required shipping address fields during the checkout process. It indicates that the shipping information is fully entered, verified, and ready for the next step. The event accounts for different scenarios, including when the shipping address matches the billing address or when alternative options are selected. > > Examples of mandatory fields: > > * `First Name`: The first name of the recipient (e.g., "Jane"). > * `Last Name`: The last name of the recipient (e.g., "Smith"). > * `Address`: The full shipping address (e.g., "456 Elm St, Suite 5"). > * `Phone Number`: A valid contact number for delivery (e.g., "+1-987-654-3210"). > > The event also provides information about the type of shipping address selected by the shopper: > > * `ShippingAddressType`: Specifies the type of shipping address. Possible values: > > * `SameAsBilling`: When the shipping and billing addresses are the same, and the billing details are completed. > * `Alternative`: When the shopper chooses a shipping address different from the billing address. > * `Store`: When the shopper selects a store pickup option and confirms the store. (Optional feature) > * `CollectionPoint`: When the shopper selects and confirms a collection point. (Optional feature) > > **Examples** > > ``` > // Subscribe to the SHIPPING_ADDRESS_COMPLETED event > var glegem = glegem || function() { > ((window["glegem"] = window["glegem"] || {q:[]}).q = window["glegem"].q || []).push(arguments); > }; > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.SHIPPING_ADDRESS_COMPLETED) { > console.log("Event: SHIPPING_ADDRESS_COMPLETED"); > // Handle the specific ShippingAddressType values > if (data.ShippingAddressType === "SameAsBilling") { > console.log("Shipping Address Type: Same as Billing Address"); > } else if (data.ShippingAddressType === "Alternative") { > console.log("Shipping Address Type: Alternative Address Selected"); > } else if (data.ShippingAddressType === "Store") { > console.log("Shipping Address Type: Store Pickup Selected"); > } else if (data.ShippingAddressType === "CollectionPoint") { > console.log("Shipping Address Type: Collection Point Selected"); > } > } > });// Subscribe to the BILLING_ADDRESS_COMPLETED event > var glegem = glegem || function() { > ((window["glegem"] = window["glegem"] || {q:[]}).q = window["glegem"].q || []).push(arguments); > }; > glegem("OnClientEvent", function (source) { > if (source === GEMerchantUtils.ClientEvents.BILLING_ADDRESS_COMPLETED) { > console.log("Event: BILLING_ADDRESS_COMPLETED"); // No additional data provided > } > }); > ``` > > **Implementation Tips and Best Practices** > > * This event is usually mapped to `add_shipping_info` in Google Analytics 4 (GA4) or equivalent events in other analytics platforms. It represents a key milestone in the checkout process, indicating that the user has provided their shipping information. > * In the Global-e checkout, the order of forms can vary based on the setup. The billing form might appear before the shipping form. When the billing address is completed, it will also trigger the `SHIPPING_ADDRESS_COMPLETED`event with `SameAsBilling`as the default, since billing and shipping are marked as the same by default. If the shopper chooses a different shipping address, the `SHIPPING_ADDRESS_COMPLETED`event will fire again, this time with `Alternative`as the value for `ShippingAddressType`. ### SHIPPINGMETHOD_SELECTION > [accordion] Show details > > This event is triggered when a customer selects a shipping method during the checkout process. It indicates that the customer has chosen their preferred shipping option. > > The `SHIPPINGMETHOD_SELECTION` event provides detailed information about the selected shipping method. > > * `id`: Specifies the element ID of the selected shipping option. Example: `def-ship-opt-2-10000388.opt` > > * `opt-2`: Indicates the user selected the second shipping option. > * `10000388`: Represents the unique identifier for the selected shipping method. > * `price`: Specifies the cost of the selected shipping method, including the currency symbol. Example: `$ 7.00`. > > These properties enable precise tracking of the shipping method chosen by the customer, allowing businesses to analyze preferences and calculate costs effectively. > > **Examples** > > ``` > // Subscribe to the SHIPPINGMETHOD_SELECTION event > var glegem = glegem || function() { > ((window["glegem"] = window["glegem"] || {q:[]}).q = window["glegem"].q || []).push(arguments); > }; > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.SHIPPINGMETHOD_SELECTION) { > console.log("Event: SHIPPINGMETHOD_SELECTION"); > // Access and log the 'id' property > if (data.id) { > console.log("Selected Shipping Option ID:", data.id); > // Extract and log the option number and shipping method ID > const optionMatch = data.id.match(/opt-(\d+)/); > const methodIdMatch = data.id.match(/(\d+)$/); > if (optionMatch) { > console.log("Selected Option Number:", optionMatch[1]); > } > if (methodIdMatch) { > console.log("Shipping Method ID:", methodIdMatch[1]); > } > } > // Access and log the 'price' property > if (data.price) { > console.log("Shipping Price:", data.price); > } > } > }); > > ``` ### STORE_SELECTION > [accordion] Show details > > This event is triggered when a shopper selects a store collection option during the checkout process. It signals that the customer has chosen to pick up their order from a designated store location instead of opting for delivery. > > **This event does not include any data or payload.** > > **Examples** > > ``` > // Subscribe to the STORE_SELECTION event > var glegem = glegem || function() { > ((window["glegem"] = window["glegem"] || {q:[]}).q = window["glegem"].q || []).push(arguments); > }; > glegem("OnClientEvent", function (source) { > if (source === GEMerchantUtils.ClientEvents.STORE_SELECTION) { > console.log("Event: STORE_SELECTION"); // No additional data provided > } > }); > ``` > > **Implementation Tips and Best Practices** > > The **store collection feature** is an optional capability and is not available for all merchants by default. Merchants need to enable this feature explicitly for it to be offered as a shipping option. ### TAX_OPTION_SELECTED > [accordion] Show details > > This event is triggered when the customer selects their preferred option for paying duties and taxes during the checkout process. It occurs when the customer chooses between: > > * **Paying duties and taxes at checkout**: The customer opts to prepay duties and taxes as part of their order total. > * **Paying duties and taxes upon delivery**: The customer decides to pay duties and taxes directly to the carrier or customs upon receiving the shipment. > > The `TAX_OPTION_SELECTED`event provides information about the customer's choice for handling duties and taxes during checkout: > > * `id`: Specifies the selected tax payment option. > > * Possible values: > > * `IncludeInOrder`: Indicates the customer has chosen to prepay duties and taxes as part of their order total. > * `ManualPay`: A valid contact number (e.g., "+1-123-456-7890"). > * Examples: > > * `IncludeInOrder`: The customer chooses to pay duties and taxes during checkout. > * `ManualPay`: The customer opts to pay duties and taxes when the shipment is delivered. > > **Examples** > > ``` > // Subscribe to the TAX_OPTION_SELECTED event > var glegem = glegem || function() { > ((window["glegem"] = window["glegem"] || {q:[]}).q = window["glegem"].q || []).push(arguments); > }; > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.TAX_OPTION_SELECTED) { > console.log("Event: TAX_OPTION_SELECTED"); > // Handle the 'id' property > if (data.id === "IncludeInOrder") { > console.log("Tax Option: Include in Order - Duties and taxes will be paid at checkout."); > } else if (data.id === "ManualPay") { > console.log("Tax Option: Manual Pay - Duties and taxes will be paid upon delivery."); > } > } > }); > ``` > > **Implementation Tips and Best Practices** > > There are scenarios where this event may not be triggered. For example, if the shopper proceeds with the default option (paying duties and taxes within the checkout) without making any changes, the event won't fire. Additionally, in cases where the country's duties and taxes configuration is set to "Hidden Force DDP," meaning that duties and taxes are already included in the product prices, this event will not be triggered. Similarly, if the total value of the checkout falls below the country's tax threshold, or if the country does not impose duties and taxes at all, the event will not occur. These situations ensure the event is only sent when a manual selection of tax payment options is required and applied by the shopper. ### EXPRESS_PAYMENT_SELECTED > [accordion] Show details > > This event is triggered when a shopper selects an express payment method during the checkout process, such as Apple Pay or Google Pay. > > The event includes the following data: > > * `id`: Specifies the Global-e internal payment method ID of the selected express payment method. Example: `135`. > * `name`: Specifies the name of the express payment method. Example: `ApplePay Express`. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.EXPRESS_PAYMENT_SELECTED) { > console.log("Express payment selected:", data.id, data.name); > } > }); > ``` ### LANGUAGE_CHANGED > [accordion] Show details > > This event is triggered when a shopper changes the language during checkout. > > The event includes the following data: > > * `FromLanguage`: Specifies the previous language, as a culture code — e.g. `en-US`. > * `ToLanguage`: Specifies the newly selected language, as a culture code — e.g. `fr-FR`. > * `ShippingCountry`: Specifies the shipping country, as an ISO2 country code. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.LANGUAGE_CHANGED) { > console.log("Language changed from", data.FromLanguage, "to", data.ToLanguage); > } > }); > ``` ### ADD_NEW_BILLING_ADDRESS > [accordion] Show details > > This event is triggered when the shopper chooses to enter a billing address that differs from the shipping address. It signals the start of the separate billing address entry process. > > **This event does not include any data or payload.** > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.ADD_NEW_BILLING_ADDRESS) { > // Shopper started entering a billing address separate from shipping. > console.log("Add new billing address"); > } > }); > ``` ### STORE_LOCATION_SELECTED > [accordion] Show details > > This event is triggered when the shopper selects and confirms a specific store as the delivery location in the ship-to-store flow. It occurs after the Store Selection event, once an individual store has been selected. > > The event includes the following data: > > * `storeData`: Specifies the selected store details as a JSON-stringified object. Use `JSON.parse()` to convert it into a JavaScript object. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.STORE_LOCATION_SELECTED) { > const store = JSON.parse(data.storeData); > console.log("Selected store:", store); > console.log("Cart token:", data.cartToken); > } > }); > ``` ### COLLECTION_POINT_SELECTED > [accordion] Show details > > This event is triggered when the shopper selects and confirms a collection point as the delivery location, choosing to collect the order from a designated location. > > The event includes the following data: > > * `collectionPointData`: Specifies the selected collection point details as a JSON-stringified object. Use `JSON.parse()` to convert it into a JavaScript object. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.COLLECTION_POINT_SELECTED) { > const collectionPoint = JSON.parse(data.collectionPointData); > console.log("Selected collection point:", collectionPoint); > console.log("Cart token:", data.cartToken); > } > }); > ``` ### PAYMENT_DISCOUNT_DISPLAY > [accordion] Show details > > This event is triggered when the checkout is initialized and a payment-method discount is available for display to the shopper. > > The event includes the following data: > > * `PaymentDiscountCouponData`: Specifies the details of the available payment-method discount. It contains: > > * `CouponName` — Specifies the name of the payment-method discount coupon. > * `PaymentMethodId` — Specifies the payment method ID to which the discount applies. > * `PaymentMethodName` — Specifies the name of the payment method to which the discount applies. > * `BINs` — Specifies the eligible card BIN ranges for the discount. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.PAYMENT_DISCOUNT_DISPLAY) { > console.log("Payment discount available:", data.PaymentDiscountCouponData.CouponName); > } > }); > ``` ### PAYMENT_DISCOUNT_MISMATCH > [accordion] Show details > > This event is triggered when the card BIN entered by the shopper does not match the BINs eligible for the payment-method discount. As a result, the discount is not applied. > > The event includes the following data: > > * `PaymentDiscountCouponData`: Specifies the details of the mismatch. It contains: > > * `Reason` — Specifies why the entered card BIN did not match the discount’s eligible BINs. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.PAYMENT_DISCOUNT_MISMATCH) { > console.log("Discount did not match:", data.PaymentDiscountCouponData.Reason); > } > }); > ``` ### COMPLETE_WITH_DISCOUNT > [accordion] Show details > > This event is triggered when the shopper clicks “Pay” while an eligible payment-method discount is active, indicating that the order is being completed with the discount applied. > > The event includes the following data: > > * `PaymentDiscountCouponData`: Details of the applied discount. Contains: > > * `Coupon` — Specifies the payment-method discount coupon being applied. > * `PaymentMethodId` — Specifies the payment method ID to which the discount applies. > * `PaymentMethodName` — Specifies the name of the payment method to which the discount applies. > * `BIN` — Specifies the matched card BIN. > * `BINs` — Specifies the eligible card BIN ranges for the discount. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.COMPLETE_WITH_DISCOUNT) { > console.log("Completing with discount:", data.PaymentDiscountCouponData.Coupon); > } > }); > ``` ### ON_CLIENT_ERROR > [accordion] Show details > > This event is triggered when a client-side JavaScript error occurs during the checkout. > > The event includes the following data: > > * `message`: Specifies the error message. > * `url`: Specifies the URL where the error occurred. > * `lineNumber`: Specifies the line number where the error occurred. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.ON_CLIENT_ERROR) { > console.log("Client error:", data.message, "at", data.url, data.lineNumber); > } > }); > ``` ### ON_SERVER_ERROR > [accordion] Show details > > This event is triggered when a server-side error occurs during checkout. > > The event includes the following data: > > * `process`: Specifies the process in which the error occurred. > * `error`: Specifies the error details. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.ON_SERVER_ERROR) { > console.log("Server error in", data.process, ":", data.error); > } > }); > ``` ### WINDOW_SHOWN > [accordion] Show details > > This event is triggered when a popup or modal window is displayed, such as the Address Verification popup. > > The event includes the following data: > > * `id`: Specifies the identifier of the popup — e.g. `AddressVerificationPopup`. > * `tag`: Specifies the popup tag — e.g. `POPUP`. > * `text`: Specifies the display text associated with the event — e.g. `Address Verification Popup is shown`. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.WINDOW_SHOWN) { > console.log("Window shown:", data.id); > } > }); > ``` ### LOYALTY_CREDIT_BALANCE_INPUT_MANUALLY_CHANGED > [accordion] Show details > > This event is triggered when a shopper manually edits the loyalty-credit amount input field — for example typing or adjusting the credit value they want to use. > > The `LOYALTY_CREDIT_BALANCE_INPUT_MANUALLY_CHANGED` event provides the following data: > > * `id`: Specifies the identifier of the loyalty-credit input. > * `name`: Specifies the name of the loyalty-credit input. > * `amount`: Specifies the entered credit amount. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.LOYALTY_CREDIT_BALANCE_INPUT_MANUALLY_CHANGED) { > console.log("Loyalty credit input changed to", data.amount); > } > }); > ``` ### LOYALTY_CREDIT_BALANCE_CHANGED > [accordion] Show details > > This event is triggered when a shopper amends the loyalty-credit balance — the amend balance action in the loyalty credit widget. > > The `LOYALTY_CREDIT_BALANCE_CHANGED` event provides the following data: > > * `id`: Specifies the identifier of the loyalty-credit input. > * `name`: Specifies the name of the loyalty-credit input. > * `amount`: Specifies the entered credit amount. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.LOYALTY_CREDIT_BALANCE_CHANGED) { > console.log("Loyalty balance amended:", data.amount); > } > }); > ``` ### LOYALTY_CREDIT_BALANCE_APPLIED > [accordion] Show details > > This event is triggered when a shopper applies loyalty credit to the order — the apply action in the loyalty credit widget. > > The `LOYALTY_CREDIT_BALANCE_APPLIED` event provides the following data: > > * `id`: Specifies the identifier of the loyalty-credit element. > * `name`: Specifies the name of the loyalty-credit element. > * `amount`: Specifies the applied credit amount. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.LOYALTY_CREDIT_BALANCE_APPLIED) { > console.log("Loyalty credit applied:", data.amount); > } > }); > ``` ### DUTIES_AND_TAXES_CALCULATED > [accordion] Show details > > This event is triggered when duties and taxes (or sales tax / local taxes) are calculated and become visible on the checkout, and their amount is greater than zero. It is not triggered when no duties and taxes are displayed, when the amount is 0, or in ForceDDP / hidden duties-and-taxes scenarios. > > The `DUTIES_AND_TAXES_CALCULATED` event provides the following data: > > * `type`: Specifies the type of taxes calculated — e.g. `International Duties and Taxes` or `Sales Tax`. > * `amount`: Specifies the amount of taxes calculated for the checkout — e.g. `42.3`. > * `currency`: Specifies the currency in which the shopper sees the duties and taxes — e.g. `USD`. > * `optional_to_pay`: Specifies whether the shopper can pay the duties and taxes later, or must pay them within the checkout — `true` or `false`. > * `country`: Specifies the shipping country, as an ISO2 country code — e.g. `US`. > > **Examples** > > ``` > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.DUTIES_AND_TAXES_CALCULATED) { > console.log("Duties and taxes calculated:", data.type, data.amount, data.currency); > console.log("Optional to pay:", data.optional_to_pay, "Country:", data.country); > } > }); > ``` ## Data Object Model Events Data Object Model (DOM) Events track direct customer interactions with elements on the checkout page. These events help Merchants to optimize the user experience, reduce friction in forms, and increase checkout completion rates. ### BUTTON_CLICKED > [accordion] Show details > > This event is triggered when a customer clicks a button during the checkout. It captures details about the button interaction, including its purpose and outcome. For Pay or Apply Coupon buttons, it provides additional data on payment or coupon code validation results. > > The BUTTON_CLICKED event provides details about the button that was interacted with: > > * `id`: The unique identifier of the button element. Example: "`PayButton`". > * `tag`: The HTML tag name of the button. Example: "`BUTTON`". > * `text`: The visible text displayed on the button. Example: "`Pay and place order`". > * `action`: A description of the button’s function. Example: "`Pay`". > * `success`: Indicates whether the action was successful (`true`) or failed (`false`). Example: `false`(the payment attempt failed due to validation errors). > * `error`: If success is false, this field provides details about the failure reason. Example: "`CheckoutFormValidationFailed`" (the checkout form contains missing or invalid fields). > * `errorFields`: If applicable, lists the specific form fields that caused the validation failure. Example: "`CheckoutData_BillingFirstName`,`CheckoutData_BillingLastName`,`CheckoutData_BillingAddress1`,`BillingCity`,`BillingCountyID`,`BillingZIP`,`CheckoutData_BillingPhone`". > > **Examples** > > ``` > // Subscribe to the BUTTON_CLICKED event > var glegem = glegem || function() { > ((window["glegem"] = window["glegem"] || {q:[]}).q = window["glegem"].q || []).push(arguments); > }; > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.BUTTON_CLICKED) { > console.log("Event: BUTTON_CLICKED"); > // Log button details > console.log(`Button ID: ${data.id}`); > console.log(`Text: ${data.text}`); > console.log(`Action: ${data.action}`); > // Handle standard payment button > if (data.action === "Pay") { > if (data.success) { > console.log("Payment Successful."); > } else { > console.log("Payment Failed."); > console.log(`Error: ${data.error}`); > if (data.errorFields) { > console.log("Validation Errors in Fields:", data.errorFields); > } > } > } > // Handle express payment methods > if (data.action === "Express Payment button clicked") { > console.log(`Express Payment Method Selected: ${data.name}`); > } > } > }); > ``` > > **Implementation Tips and Best Practices** > > The `BUTTON_CLICKED`event tracks when a customer initiates a payment by clicking the `Pay`button. However, this event does not capture interactions with express payment methods, such as Apple Pay or PayPal Express, which may bypass the standard checkout flow. > > For express payment methods, the event can trigger with an **action** value is "`Express Payment button clicked`". If tracking express payments is necessary, consider implementing additional event listeners specifically for these buttons to ensure full coverage of all payment methods. ### CHECKBOX_CHANGE > [accordion] Show details > > This event is triggered when a customer interacts with a checkbox within the checkout. It captures when a checkbox is clicked and whether it is checked or unchecked. This event is useful for tracking user preferences, such as opting in for promotional emails or agreeing to terms and conditions. > > The event provides details about the checkbox that was interacted with: > > * `id`: The unique identifier of the checkbox element. Example: "`CheckoutData_OffersFromMerchant`". > * `name`: The name attribute of the checkbox element. Example: "`CheckoutData.OffersFromMerchant`". > * `checked`: Indicates whether the checkbox is selected (`true`) or deselected (`false`). Example: `true`(the customer opted in to receive offers from the merchant). > > Note: The example above refers to a checkbox where the customer can opt in to receive promotional offers from the merchant. > > **Examples** > > ``` > // Subscribe to the CHECKBOX_CHANGE event > var glegem = glegem || function() { > ((window["glegem"] = window["glegem"] || {q:[]}).q = window["glegem"].q || []).push(arguments); > }; > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.CHECKBOX_CHANGE) { > console.log("Event: CHECKBOX_CHANGE"); > // Log checkbox details > console.log(`Checkbox ID: ${data.id}`); > console.log(`Checkbox Name: ${data.name}`); > console.log(`Checked: ${data.checked}`); > // Specific handling for merchant offers checkbox > if (data.id === "CheckoutData_OffersFromMerchant" || data.name === "CheckoutData.OffersFromMerchant") { > if (data.checked) { > console.log("User opted in to receive offers from the merchant."); > } else { > console.log("User opted out of receiving offers from the merchant."); > } > } > } > }); > ``` > > **Implementation Tips and Best Practices** > > The `CHECKBOX_CHANGE`event can be used with Klaviyo or similar tools to track marketing opt-in preferences. If you're using the `INPUT_BLUR` event for customer identification, make sure to capture the checkbox status before sending data to the platform. This ensures that marketing emails are only sent to users who have explicitly opted in. Refer to the `INPUT_BLUR`event for tracking email input fields. ### COMBO_CHANGED > [accordion] Show details > > This event is triggered when a customer selects or changes a value in a dropdown (select list) during checkout. It helps track user interactions with selectable options, such as choosing a country, state, county, etc. > > The event provides details about the element that was interacted with: > > * `id`: The unique identifier of the select list or radio button element. Example: "`BillingCountyID`". > * `name`: The name attribute of the element. Example: "`CheckoutData.BillingCountyID`". > * `text`: The visible text of the selected option. Example: "`Clare`". > * `value`: The underlying value associated with the selected option. Example: "`5`". > > **Examples** > > ``` > // Subscribe to the COMBO_CHANGED event > var glegem = glegem || function() { > ((window["glegem"] = window["glegem"] || {q:[]}).q = window["glegem"].q || []).push(arguments); > }; > glegem("OnClientEvent", function (source, data) { > if (source === GEMerchantUtils.ClientEvents.COMBO_CHANGED) { > console.log("Event: COMBO_CHANGED"); > // Log dropdown or radio button details > console.log(`Element ID: ${data.id}`); > console.log(`Element Name: ${data.name}`); > console.log(`Selected Text: ${data.text}`); > console.log(`Selected Value: ${data.value}`); > } > }); > ``` > > **Implementation Tips and Best Practices** > > The `BUTTON_CLICKED`event tracks when a customer initiates a payment by clicking the `Pay`button. However, this event does not capture interactions with express payment methods, such as Apple Pay or PayPal Express, which may bypass the standard checkout flow. > > For express payment methods, the event can trigger with an **action** value is "`Express Payment button clicked`". If tracking express payments is necessary, consider implementing additional event listeners specifically for these buttons to ensure full coverage of all payment methods.. ### INPUT_BLUR > [accordion] Show details > > This event is triggered when a customer moves out of (or "unfocuses") a text input field after entering or interacting with it. It helps track how users engage with form fields during checkout, providing insights into input behavior and potential friction points. > > The event includes details about the input field the customer was interacting with: > > * `id`: The unique identifier of the input field. Example: "`CheckoutData_Email`". > * `name`: The name attribute of the input field. Example: "`CheckoutData.Email`". > * `value`: The text entered by the customer before leaving the field. Example: "`example@global-e.com`". > > Note: The example above refers to the billing email address field in the checkout form. > > **Examples** > > ``` > // Subscribe to the STORE_SELECTION event > var glegem = glegem || function() { > ((window["glegem"] = window["glegem"] || {q:[]}).q = window["glegem"].q || []).push(arguments); > }; > glegem("OnClientEvent", function (source) { > if (source === GEMerchantUtils.ClientEvents.STORE_SELECTION) { > console.log("Event: STORE_SELECTION"); // No additional data provided > } > }); > ``` > > **Implementation Tips and Best Practices** > > This `INPUT_BLUR`event can be used with Klaviyo or similar tools to trigger an identification action. However, ensure that you capture the marketing opt-in checkbox value before sending data to the platform to prevent sending emails without the user's consent. Refer to `CHECKBOX_CHANGE` event. ## Examples of Use in DOM Events The following examples show how to use DOM Events to detect common checkout actions. ### add_payment_info > [accordion] Show details > > **Trigger:** This event is triggered when a shopper completes the required payment information, for example, after returning from PayPal or completing the required credit card fields. > > **Example** > > ``` > glegem("OnClientEvent", function (source, data) { > switch (source) { > case GEMerchantUtils.ClientEvents.INPUT_BLUR: > if (data && (data.id === "cardNum" || data.id === "cvdNumber")) { > /*your code*/ > } > break; > case GEMerchantUtils.ClientEvents.COMBO_CHANGED: > if (data && (data.id === "cardExpiryMonth" || data.id === "cardExpiryYear")) { > /*your code*/ > } > break; > } > }); > ``` ### place_order > [accordion] Show details > > **Trigger:** This event is triggered when a shopper clicks the “Pay Securely Now” button and attempts to place an order. > > **Example** > > ``` > glegem("OnClientEvent", function (source, data) { > switch (source) { > case GEMerchantUtils.ClientEvents.BUTTON_CLICKED: > if (data.action === "Pay") { > /*your code*/ > } > break; > } > }); > ``` ### add_giftcard > [accordion] Show details > > **Trigger:** This event is triggered when a shopper enables the option to use a gift card. > > **Example** > > ``` > glegem("OnClientEvent", function (source, data) { > switch (source) { > case GEMerchantUtils.ClientEvents.CHECKBOX_CHANGE: > if (data && data.checked === true && data.id === "pay-with-gift-card-toggle") { > /*your code*/ > } > break; > } > }); > ``` ### giftcard_apply > [accordion] Show details > > **Trigger:** This event is triggered each time a shopper applies a gift card to the order. > > **Example** > > ``` > glegem("OnClientEvent", function (source, data) { > switch (source) { > case GEMerchantUtils.ClientEvents.BUTTON_CLICKED: > if (data.id === "ApplyGiftCard") { > /*your code*/ > } > break; > } > }); > ``` ### giftcard_check_balance > [accordion] Show details > > **Trigger:** This event is triggered when a shopper enters the gift card details and clicks the “Check Available Balance” button. > > **Example** > > ``` > glegem("OnClientEvent", function (source, data) { > switch (source) { > case GEMerchantUtils.ClientEvents.BUTTON_CLICKED: > if (data.id === "ValidateGiftCard") { > /*your code*/ > } > break; > } > }); > ``` ### select_payment > [accordion] Show details > > **Trigger:** This event is triggered when a shopper selects an express checkout or payment method, such as PayPal Quick Checkout or PayPal, or begins entering their credit card details. > > **Example** > > ``` > glegem("OnClientEvent", function (source, data) { > switch (source) { > case GEMerchantUtils.ClientEvents.BUTTON_CLICKED: > if (data.id === "paypal-button") { > /*your code*/ > } > break; > } > }); > ``` ### add_rewards > [accordion] Show details > > **Trigger:** This event is triggered when a shopper selects the toggle to use their rewards balance. > > **Example** > > ``` > glegem("OnClientEvent", function (source, data) { > switch (source) { > case GEMerchantUtils.ClientEvents.CHECKBOX_CHANGE: > if (data && data.checked === true && data.id === "pay-with-rewards-toggle") { > /*your code*/ > } > break; > } > }); > ``` ### rewards_apply > [accordion] Show details > > **Trigger:** This event is triggered when a shopper has applied their rewards balance. > > **Example** > > ``` > glegem("OnClientEvent", function (source, data) { > switch (source) { > case GEMerchantUtils.ClientEvents.BUTTON_CLICKED: > if (data.id === "ApplyLoyaltyCreditGiftCard") { > /*your code*/ > } > break; > } > }); > ``` ### rewards_amend_balance > [accordion] Show details > > **Trigger:** This event is triggered when a shopper changes the amount of rewards to apply. > > **Example** > > ``` > glegem("OnClientEvent", function (source, data) { > switch (source) { > case GEMerchantUtils.ClientEvents.BUTTON_CLICKED: > if (data && (data.id === "loyalty-minus-btn" || data.id === "loyalty-plus-btn")) { > /*your code*/ > } > break; > } > }); > ``` # Allowing Customer Returns Outside Policy Source: https://docs.global-e.com/allowing-customer-returns-outside-policy If you want customers to create RMAs through the Returns Portal for items that are normally out of policy, you can use a workaround based on a dedicated policy rule and Shopify order tags. ## How This Works 1. Create a policy rule specifically for out-of-policy scenarios. 2. Configure the policy rule to apply only to orders that contain a specific Shopify tag, such as **out-of-policy**. 3. In Shopify, add the out-of-policy tag to an order whenever this type of exception occurs. ## Example Scenario 1. Your return policy allows returns only within **30 days** of purchase. 2. A customer attempts to create a return after **32 days**, but cannot do so because the order is out of policy. 3. The customer contacts you for assistance. 4. Instead of creating the RMA internally from the Dashboard, you add an order tag (for example, out-of-policy) to the order. 5. The customer returns to the Returns Portal and successfully creates the RMA. This approach allows you to handle exception cases efficiently while maintaining control over your standard return policy. # Allowing Customer Returns Outside Policy Source: https://docs.global-e.com/allowing-customer-returns-outside-policy-702682 If you want customers to create RMAs through the Returns Portal for items that are normally out of policy, you can use a workaround based on a dedicated policy rule and Shopify order tags. ## How This Works 1. Create a policy rule specifically for out-of-policy scenarios. 2. Configure the policy rule to apply only to orders that contain a specific Shopify tag, such as **out-of-policy**. 3. In Shopify, add the out-of-policy tag to an order whenever this type of exception occurs. ## Example Scenario 1. Your return policy allows returns only within **30 days** of purchase. 2. A customer attempts to create a return after **32 days**, but cannot do so because the order is out of policy. 3. The customer contacts you for assistance. 4. Instead of creating the RMA internally from the Dashboard, you add an order tag (for example, out-of-policy) to the order. 5. The customer returns to the Returns Portal and successfully creates the RMA. This approach allows you to handle exception cases efficiently while maintaining control over your standard return policy. # Amazon Pay Express Source: https://docs.global-e.com/amazon-pay-express ## Introduction Amazon Pay Express streamlines the checkout process, allowing shoppers to complete their purchases quickly and securely using their Amazon Pay account. ## How it Works When shoppers click the Amazon Pay Express button on the checkout page, they are redirected to the Amazon Pay wallet widget. Here, they confirm or update their shipping address and payment method. Once they select Continue to checkout, they will return to the checkout page with all their information filled out – shipping and billing information, contact details, payment method, and price breakdown including shipping and taxes. Here they can complete the checkout and have their order confirmed. ## The Customer Journey **The User Flow** | 1. On the checkout page, select Amazon Pay from the Express Checkout options. | 2. Confirm or update the shipping address and payment method in your Amazon account, and select Continue to checkout. | 3. Review your shipping and billing details, payment method and price breakdown including shipping. | 4.Select Pay with Amazon Pay. | 5. That’s it! Your order is confirmed. | | - | - | - | - | - | | ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-4893f595-2158-0920-2acd-4f32ce5057a4.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=f5377baf406809fa895d3145ca3c32b5) | ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-f8ed659a-768d-2917-1edb-87db2e308abe.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=3caded67a0665b4ad17e6458689a49a8) | ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5c1e4a64-35d9-5263-b210-7f6f2e4677a7.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=1276f2c11c15f5ba5344dd41c5163238) | ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d06589b9-73ca-d88d-ebbe-690fb9da6096.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=c60deca754a2e4b5166e69b93ae2e13b) | ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a4d0c1fe-4a90-df42-9ab5-44a9298de581.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=65139e8f5d051ad25ef27b3f3888b5b5) | ## Supported Regions Amazon Pay Express is currently available in the following countries: * Australia * Belgium * Luxembourg * United Kingdom * United States # Analytics Source: https://docs.global-e.com/analytics The **Analytics** platform is a self-service platform used for showing and analysing different metrics related to business aspects. This page describes the following: * [Accessing the Analytics feature](/analytics#accessing-the-analytics-feature) * [General Functionality](/general-functionality) ## Accessing the Analytics Feature ### To access the Analytics feature 1. Navigate to **Analytics** from the top menu. 2. *Optional* - Select a merchant from the **Select Merchant** menu.The merchant dropdown menu is not displayed for users with one merchant. # Android Installation Source: https://docs.global-e.com/android-installation To integrate the AAR library add these dependencies in your app/build.gradle: * **implementation "com.squareup.retrofit2:retrofit:2.9.0"** * **implementation "com.squareup.retrofit2:converter-gson:2.9.0"** * **implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.3"** * **implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.4.3"** > [!WARNING] > > Remember to add Global-e as your project dependency. Import \*aar via Android Studio File-New-New Module... Import .JAR/.AAR Package Alternatively, you can connect to the library using the following procedure: 1. Change the project's display type from Android to Project. 2. Copy the AAR file to the libs directory of the app module. 3. Open the project structure (File-Project Structure ... or keyboard shortcut Ctrl + Alt + Shift + S) 4. Navigate to Dependencies. 5. Click + (Add Dependency) 6. Select the JAR / AAR Dependency item. 7. Add the path to the library file (libs/your_file_name.aar) in the first step. Leave the second step unchanged (implementation by default). 8. Click **OK.** 9. Apply changes. 10. Make a Rebuild project. > [!NOTE] > > Remember to add Internet permission to the Manifest file, as the library uses the Internet. # API Authentication Source: https://docs.global-e.com/api-authentication Global-e offers two types of security methods for communication from the Merchant / Platform to Global-e using API calls. The selected key is passed in the API header. * **JSON Web Token (JWT) Authentication** - Unique key generated to the Merchant, based on username and password provided by Global-e (preferred method). * **Merchant GUID** - Unique key provided to the Merchant, by Global-e. Use the API `UserName` header and the `Authorization` header, including the token retrieved via the `GetAuthenticationToken` API using merchant-specific credentials (provided by Global‑e). ## JWT Authentication The JSON Web Token (JWT) authentication method is used by merchants authenticating their APIs sent to Global-e APIs. It is possible to configure JWT authentication for a specific API, while other APIs will use merchant GUID authentication. ### To Create the JWT Token **Prerequisites** The following setup should be done before applying to a JWT token: 1. Global-e adds a user for the merchant in Global-e DB. The name of the user is identified by Global-e. 2. Global-e confirms with the merchant the name created. 3. The Merchant generates a key using Postman / Swagger (not in the Production environment) using the Authentication Service - *CreateUpdateUser* API. 4. The Merchant implements the *GetToken* API  to renew the token. If expired - Global-e API returns an error. **Note:** Make sure to use the Global-e API environment such as *connect.bglobale.com*, or *api.global-e.com*. **Create the Token** The following steps should be implemented by the merchant / Platform for every API call to GE CORE: 1. Send user name + password to “/Authentication/GetAuthenticationToken” API. The username and password are provided to the merchant by GE. 2. Receive JWT token. The JWT token can be cached and reused by the merchant until it expires (15 minutes is the default TTL). 3. Add the returned JWT token to the HTTP header in every API call. **Note**: The returned token and the username are sent as part of the API request, in the HTTP request header. ### GetAuthenticationToken API Use the GetAuthenticationToken API to obtain a JSON web token (JWT). Send a username and password that are obtained by Global-e and receive a JWT token. The returned token and the username are sent as part of the API request, in the HTTP request header. **Method/URL** ``` POST https://{globale_sever}/Authentication/GetAuthenticationToken ``` Call the `GetAuthenticationToken` API as in the following URL: [https://\{server_name}/Authentication/GetAuthenticationToken](https://connect.bglobale.com/Authentication/GetAuthenticationToken) | Parameter | Type | Description | Mandatory | | - | - | - | - | | `Reason` | String | Text that optionally describes the reason for Success status | | | `Success` | Boolean | Indicates if the API call was successful. Success property value may be only TRUE. Otherwise, an ErrorInfo is returned. | | | `Token` | String | JWT encoded token. | | | `TTLInMinutes` | Int | The Token expiry time in minutes. | | **Examples** **Request** ``` { "userName": "yuvalta", "password": "password" } ``` **Success Response** ``` { “Success”: true, “Token”: "", “TTLInMinutes”: 15 } ``` **Fail Response** ``` { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "traceId": "|f1c6be73-42d43d27971c276a.", "errors": { "Password": [ "Password length can't be less than 8 or greater than 50 characters." ] } } ``` > [!NOTE] > > By default, the token expires within 15 minutes unless you specify that the token should be valid for longer. ### Using the JWT Key in the Header Once the token has been generated, call the API of choice using the relevant credentials in the header. **Example** `key= ”Authorization” | value = "my_jwt_token" Key= ”UserName”| value = "userName"` **Example of JWT in Header** ``` curl -X POST https://[globale domain]/[API] \ -H "Authorization: Bearer my_jwt_token" \ -H "UserName: userName" \ -H "Content-Type: application/json" ``` ### Interaction Diagram The diagram below shows the interaction between the Merchant code, the Global‑e API code, and the authentication service. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-6a9c3162-b30b-6300-7c3d-5bfd2f4b0ff0.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=0da4bef4d805e562448fff021e4825a3) ## MerchantGUID Authentication To implement API calls with Global-e the `merchantGUID` provided by Global-e must be included in the call, to ensure successful authentication. For the authentication, make sure to include your Merchant GUID as part of each call body parameters or as part of the header, so that Global-e can verify your identity. Make sure to use the appropriate merchantGUID, depending on the Global‑e integration environment used for development or production purposes. See [Global-e Environments](/shipping-with-non-global-e-carriers#global-e-environments). For each endpoint, perform the following steps: * Add the MerchantGUID in the request header as illustrated below. Make sure to use the appropriate merchantGUID, depending on the Global‑e integration environment used, development or production. * Make sure to implement the API on the server side (rather than calling it from the client side). Alternatively, implement it outside of the frontend layer to avoid exposing the merchant GUID publicly. **MerchantGUID Implementation** The MerchantGUID indicated in the API should be specified in the API Header. **Note**: Never add the merchantGUID as a path parameter in the URL. **MerchantGUID as part of the header** Add your MerchantGUID as part of the header as in the following example: ``` curl --location 'https://[globale domain]/[API]' \ --header 'MerchantGUID: ' \ --header 'Content-Type: application/json' \ --data-raw '{"key1":"value1", "key2":"value2"}' ``` **Example** ``` curl -X GET https://[globale domain]/[API] \ -H "Authorization: Bearer jwt_token_here" \ -H "Content-Type: application/json" \ -d '{ "ProviderCode": "Loop", "OrderId": "GE314856569TS", "Email": "globale@gmail.com", "MerchantRMANumber": "RM132", "ShippingCost": 10.0, "CurrencyCode": "USD", "ReturnShippingTypeId": 2, "ReturnShippingMethodId": null, "ReturnedProducts": [ { "ProductCode": "DKB500680.M8", "ProductSecondaryCode": "", "CartItemId": null, "ReturnQuantity": 1, "MerchantReturnReasonCode": "", "MerchantReturnReasonDescription": "Return Reason from GRD request for product 1" }, { "ProductCode": "B7ECS.C8", "ProductSecondaryCode": "", "CartItemId": 1, "ReturnQuantity": 1, "MerchantReturnReasonCode": "TTT", "MerchantReturnReasonDescription": "Return Reason from GRD request for product 2" } ] }' ``` ## Rotating Your Merchant GUID Your Merchant GUID is the credential that identifies your store to Global-e, so it should be treated as a secret and replaced periodically, just as you would rotate any other API credential. Follow the instructions for your platform below to rotate your Merchant GUID: * [Shopify Native](/rotate-merchant-guid-shopify-native) * [WooCommerce](/rotate-merchant-guid-woocommerce) * [Magento 2 (M2L)](/rotate-merchant-guid-magento2-lite) * [ShopWare](/rotate-merchant-guid-shopware) * [BigCommerce](/rotate-merchant-guid-bigcommerce) * [SFCC](/rotate-merchant-guid-sfcc) * Centra — coming soon. ## IP Whitelisting As part of strengthening the security of the integration between your systems and Global-e, we recommend whitelisting the IP addresses that access our APIs, so that only traffic from your approved infrastructure can access your Global-e account. As part of your integration, please provide the full list of public IP addresses (or CIDR ranges) that you use to connect to Global-e. The required list may include every system and application with an interface to Global-e: * Production servers and any backend calling Global-e APIs * OMS, ERP or middleware that syncs orders, catalog, product feeds or returns * Warehouse, 3PL or WMS systems that handle shipping activities * Integration partners or agencies acting on your behalf * Staging or test environments, marked as such When your IP addresses change in the future, please notify us before the change. > [!WARNING] > > Any system that is not whitelisted may be prevented from accessing Global-e systems and performing expected operations. # API Integration Guides Source: https://docs.global-e.com/api-integration-guides Global‑e's API Integration Guides complement the Global‑e API Reference by providing detailed documentation to help developers smoothly integrate Global‑e APIs into their systems. Typically, these guides cover authentication methods, API endpoints, request methods and response formats, parameters, examples, and best practices. This page describes the following: **Global-e Environments** * [Global-e Environments](/global-e-environments-cross-platform) * [Authentication](/authentication) **Orders** * [Checkout Cart Information (Global-e to Merchant)](/checkout-cart-info--from-global-e-) * [Replacement Orders](/createorder) * [Dispatch Notifications (Merchant to Global-e)](/dispatch-notifications-via-api) * [Dispatch Notifications (Global-e to Merchant)](/dispatch-notifications--from-global-e-) * [Export Documents](/export-documents) * [Fixed Prices Upload](https://globaleonline-my.sharepoint.com/document/enterprise/275060#UUID-fb82875e-9b91-8d05-bdb0-4342e8c1431f) * [Gift Cards](/gift-cards-sfcc) * [Order Status Updates (Merchant to Global-e)](/order-status-updates--m-to-ge-) * [Order Status Updates (Global-e to Merchant)](/order-status-updates--ge-to-m-) **Refunds** * [Refunds](/refunds-via-api) * [Refunds Notifications (Global-e to Merchant)](/refunds-notifications--from-global-e-) * [Returns](/returns-via-api) * [RMA Notifications (Global-e to Merchant)](/rma-notifications--from-global-e-) * [Generating Shipping Documents](/shipping-documents-api) **Shipping** * [Estimated Shipping Rates](/shipping-options-api) * [Cancelling Declared Parcels](/shipping---void-parcel) * [SSO Integration](/sso-integration-merchant-portal) * [International Prices](/international-prices) # Active hub details (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/active-hub-details api-reference/specs/activehubdetails.yaml POST /Browsing/ActiveHubDetails Returns the shipping and other details of Global-e's Local Hub to where the merchant ships orders. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. The `hubId` property of the `HubDetails` object is returned by this method and must be further provided as an argument to the `SendCart` method. # App settings (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/app-settings api-reference/specs/appsettings.yaml POST /Browsing/AppSettings Returns the client and server-side settings to be used by the Merchant. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns the lists of client and server-side settings to be used by the Merchant. The original JSON string is returned in the AppSettings.ClientSettings property must be passed back to Global‑e client SDK as received. The sample string may look like this: `{"AllowTracking":{"value":"true"},"Opacity":{"value":"0.8"}}` . # App version (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/app-version api-reference/specs/appversion.yaml POST /Browsing/AppVersion Returns the current versions of the Global-e API and client-side (JS) code. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns identifiers of the current versions of Global‑e API and of the client-side code that may be referenced by the Merchant’s site to render Global‑e-specific screens such as the Welcome Pop-up and Country Switcher. # Calculate billing summary (Subscription Manager to Global-e) Source: https://docs.global-e.com/api-reference/calculate-billing-summary api-reference/specs/billingsummarycalculate.yaml POST /subscriptions/billing-summary/calculate Subscription Manager calls Global-e to calculate the recurring billing summary - the selected shipping option (physical / hybrid subscriptions) and duties and taxes > [!NOTE] > > Part of the [Subscription Connector](/subscription-connector) integration guide — see it for when and how to use this endpoint. # Client apply loyalty vouchers (Global-e to Merchant) Source: https://docs.global-e.com/api-reference/client-apply-loyalty-vouchers api-reference/specs/clientapplyloyaltyvouchers.yaml POST /ClientApplyLoyaltyVouchers Validates the Loyalty Vouchers selected by the user and applies them to the current user's cart if all vouchers in the list are valid and applicable. > [!NOTE] > > This API is part of Global-e's extensions and plug-ins. Merchants do not need to implement this API unless a custom integration is required. Use this method to validate the Loyalty Vouchers selected by the user from the list that has been provided in the `loyaltyVouchersList` argument of the `SendCart` API call for the current user's checkout page. This method can only be executed from within the context of the current user's client session. Validates Loyalty Vouchers and applies them to the current user's cart if all the vouchers in the list are valid and applicable. * If at least one Loyalty Voucher in the list is invalid, `Merchant.ResponseInfo.Success` is set to `FALSE`. * If all Loyalty Vouchers are valid, the Merchant's server should re-calculate the cart pricing and execute before returning a response, the `SendCart` API call with the `CartToken` argument value returned from the previous call to `SendCart` for the current user. # Countries (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/countries api-reference/specs/countries.yaml POST /Browsing/Countries Returns the list of supported countries, flagging for each whether it is operated by Global-e or by the Merchant. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns the list of supported countries including the indication for each country if it is being operated by Global‑e or by the Merchant. If the Merchant’s site already includes its own list of countries, this list must be replaced with the list returned by this method. # Country coefficients (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/country-coefficients api-reference/specs/countrycoefficients.yaml POST /Browsing/CountryCoefficients Returns the pricing adjustment settings (country coefficients) agreed between Global-e and the Merchant, per shipping country. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns the list of pricing adjustment settings agreed between Global‑e and the Merchant, for the end customers shipping to the country (if `countryCode` is specified), or to all the supported countries (if `countryCode` is not specified). The list includes both country-level records (where `ProductClassCode` is empty) and product class-level records (where `IncludeVAT` is empty but `ProductClassCode` is not empty). > [accordion] IncludeVATOptions enumeration — VAT handling & worked example > > The IncludeVATOptions enumeration is designated to control the way VAT is handled in browsing on the Merchant’s site and in checkout on Global‑e. Following is the list of IncludeVATOptions values and the expected results for the sample Product. In the table below we are considering a product with the original cost in the UK = 100 GBP before VAT to be shipped to Germany (with country coefficient Rate=1 and user selected currency=GBP, for simplicity). For this sample product UK VAT=20%, DE Duties Total=17%: > > | IncludeVAT Option Value | Description | Price In Browsing | Price In Checkout | Price Paid To Merchant (incl. VAT) | Checkout Duties Total | Checkout Total | > | - | - | - | - | - | - | - | > | 0 | Hide VAT (default) | 100 | 100 | 120 | 17 | 117 | > | 2 | Show VAT | 120 | 100 | 120 | 17 | 117 | > | 4 | “Pocket” VAT (increase the original price by the value of the respective product’s VAT) | 120 | 120 | 144 | 20.4 (17%) | 140.4 | > | 6 | Force VAT (used to support trade agreements between the countries such as EEA, when the end customer must pay VAT; for simplicity assuming UseCountryVAT =false) | 120 | 120 | 120 | 0 | 120 | > | 8 | Force & Hide VAT (used to support trade agreements between the countries such as EEA, when end customer must pay VAT but VAT is not shown in browsing; for simplicity assuming UseCountryVAT =false) | 100 | 120 | 120 | 0 | 120 | # Create Additional Required Documents (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/create-additional-required-documents api-reference/specs/createadditionalrequireddocuments.yaml POST /additional-required-documents Initiates the process of requesting additional required shipping documents, such as the German Customs EAD document. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. # Create order (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/create-order api-reference/specs/createorder.yaml POST /checkout/CreateOrder The CreateOrder API is used to create a replacement order in Global-e. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [Replacement Orders](/createorder) integration guide — see it for when and how to use this endpoint. # Create order platform (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/create-order-platform api-reference/specs/createorderplatform.yaml POST /Checkout/CreateOrderPlatform This API starts the process of creating an order in the Global-e system. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. `OrderCreationSource` is an important attribute in the Class `SendFinalCartData` and the value of `OrderCreationSource` can be called in different ways in the order creation process. # Create order refund (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/create-order-refund api-reference/specs/createorderrefund.yaml POST /Order/CreateOrderRefund Issues a refund for the specified order, optionally including a product list and/or components (service gesture, shipping, Duties & Taxes). > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [Refunds](/refunds-via-api) integration guide — see it for when and how to use this endpoint. # Create recurring payment (Subscription Manager to Global-e) Source: https://docs.global-e.com/api-reference/create-recurring-payment api-reference/specs/recurringpayments.yaml POST /subscriptions/recurringPayments Subscription Manager trigger Global-e to perform a recurring payment > [!NOTE] > > Part of the [Subscription Connector](/subscription-connector) integration guide — see it for when and how to use this endpoint. > [!NOTE] > > The status of the payment arrives through [Recurring payment notifications](/api-reference/recurring-payment-notifications). # Currencies (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/currencies api-reference/specs/currencies.yaml POST /Browsing/Currencies Returns the list of currencies supported by the merchant. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns the list of supported currencies # Currency Rates (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/currency-rates api-reference/specs/currencyrates.yaml POST /Browsing/CurrencyRates Returns updated currency rates between a source and target currency, or all supported currencies. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns the list of updated rates between the source and the target currency (if `targetCurrencyCode` is specified) or all the supported currencies (if `targetCurrencyCode` is not specified). # Dispatch consolidated shipment (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/dispatch-consolidated-shipment api-reference/specs/dispatchconsolidatedshipment.yaml POST /Order/DispatchConsolidatedShipment Dispatches multiple orders that ship together as a single consolidated shipment. Global-e generates the shared manifest and AWB and returns the shipping documents. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Use this method to dispatch a group of orders as a single consolidated shipment, with one shared manifest and AWB. ## Error codes This method returns the same error codes as DispatchOrders. See [DispatchOrders error codes](/shipping-documents-api#dispatchorders-error-codes). # Dispatch orders (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/dispatch-orders api-reference/specs/dispatchorders.yaml POST /Order/DispatchOrders The DispatchOrders API provides the necessary carrier manifest, encoded as a base64 byte array, and a printing URL for all orders with printed labels since the last DispatchOrders call. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [Generating Shipping Documents](/shipping-documents-api) integration guide — see it for when and how to use this endpoint. # Edit order (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/edit-order api-reference/specs/editorder.yaml POST /api/orders/changes Apply changes to an existing Global-e order by adding, exchanging, or removing products. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Applies to all platforms except **Shopify**. See the [Editing Orders](/edit-order) integration guide for prerequisites, constraints, and examples. # Quote order changes (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/edit-order-quote api-reference/specs/editorder.yaml POST /api/orders/changes/quote Preview the updated order content and prices for a change without applying it. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Returns the updated order **without** changing it. Call [Edit order](/api-reference/edit-order) with the same request to apply the change. See the [Editing Orders](/edit-order) integration guide for details. # Get catalog prices (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/get-catalog-prices api-reference/specs/getcatalogprices.yaml POST /Browsing/GetCatalogPrices Returns the most updated international prices of a merchant's products across the territories operated by Global-e, for the requested countries and products. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [International Prices](/international-prices) integration guide — see it for when and how to use this endpoint. # Get Checkout Cart Info (Global-e to Merchant) Source: https://docs.global-e.com/api-reference/get-checkout-cart-info api-reference/specs/getcheckoutcartinfo.yaml GET /get-checkout-cart-info-url The GetCheckoutCartInfo API retrieves cart information for international checkout processing. > [!NOTE] > > Part of the [Checkout Cart Information (Global-e to Merchant)](/checkout-cart-info--from-global-e-) integration guide — see it for when and how to use this endpoint. # Get free shipping banner data (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/get-free-shipping-banner-data api-reference/specs/freeshippingbannerdata.yaml GET /banners/data/free-shipping Retrieves the free shipping banner configuration and localized message for a specific country, culture, and currency combination. The merchant is resolved from the authentication context (merchant GUID). > [!NOTE] > > Part of the [Free Shipping Banner Data](/free-shipping-banner-data-api) integration guide — see it for when and how to use this endpoint. # Get free shipping banner data, anonymous (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/get-free-shipping-banner-data-anonymous api-reference/specs/freeshippingbannerdata.yaml GET /banners/data/{merchantId}/free-shipping Retrieves the same free shipping banner data with no authentication. The merchant is supplied as `merchantId` in the URL path. Intended for integrations that cannot hold a merchant GUID securely (for example Shopify themes and other storefront integrations). The endpoint returns only the banner text and threshold already displayed publicly on the storefront; no confidential data is exposed. > [!NOTE] > > Part of the [Free Shipping Banner Data](/free-shipping-banner-data-api) integration guide — see it for when and how to use this endpoint. # GetMerchantPriceDetails (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/get-merchant-price-details api-reference/specs/getmerchantpricedetails.yaml GET /externalapi/GetMerchantPriceDetails Obtain the parameters required to calculate international product prices in a destination country's currency. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [International Prices](/international-prices) integration guide — see it for when and how to use this endpoint. # Get refund details (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/get-refund-details api-reference/specs/getrefunddetails.yaml GET /v1/orders/{orderId}/refunds This API provides information about refunds associated with an order. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. The information includes all the refund details and the refundable amount for each product in the order. The API returns: * `MerchantOrderRefund` * Credit note URL # Get return documents (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/get-return-documents api-reference/specs/getreturndocuments.yaml POST /Return/GetReturnDocuments Generates a Global-e RMA and returns the required return documents (label, return note, commercial invoice) with tracking details. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [Returns](/returns-via-api) integration guide — see it for when and how to use this endpoint. # Get return shipping options (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/get-return-shipping-options api-reference/specs/getreturnshippingoptions.yaml POST /Return/GetReturnShippingOptions Returns the available return shipping methods and costs for an order, plus the return destination address. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [Returns](/returns-via-api) integration guide — see it for when and how to use this endpoint. # Get shipment information (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/get-shipment-information api-reference/specs/getshipmentinformation.yaml GET /api/shipments/{trackingNumber} Retrieve the product, weight, classification and customs-value data Global-e holds for a shipment, plus its export-declaration header, so you can prepare a customs export declaration. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > This API is enabled per merchant account by Global-e. If it is not enabled for your account, the request returns `403 Forbidden`. > [!NOTE] > > **Typical integration sequence.** These APIs may be used together when an export declaration or bonded reporting is required, but they are **independent endpoints** — none is a prerequisite for another. > > 1. [Get shipping documents](/api-reference/get-shipping-documents) — obtain the label and tracking number > 2. [Submit bonded information](/api-reference/submit-bonded-information) — report bonded vs free-circulation status per product *(when bonded reporting is required)* > 3. **Get shipment information** — retrieve product, pricing and declaration header data *(when you need the data Global-e holds)* > 4. Create the export document — your side, not a Global-e API > 5. [Upload shipment documents](/api-reference/upload-shipment-documents) — upload the document and its reference to Global-e *(when a document must be attached)* > 6. [Dispatch orders](/api-reference/dispatch-orders) — End of Day > > Only steps 1 and 6 are universal. Steps 2 to 5 depend on the shipment type, the destination and your configuration. Where they apply, complete steps 2 and 5 **before End of Day / Dispatch orders**. > [!NOTE] > > An export declaration is required only when the shipment leaves the EU customs territory **and** either contains bonded goods or contains free-circulation goods with a total value of €1,000 or more. When no declaration is required, steps 3 to 5 do not apply. > [!NOTE] > > Bonded vs free-circulation status is submitted separately, through [Submit bonded information](/api-reference/submit-bonded-information). This API does not return bonded status. > [!WARNING] > > The response contains commercial values — customs values and commercial-invoice totals. It is returned with `Cache-Control: no-store`. Do not cache or store it beyond the immediate purpose of preparing the declaration. > [!NOTE] > > Global-e never returns partial declaration data. If a value the declaration requires is not yet available, the call returns `409` with no `exportDeclaration` section. This is a permanent gap rather than a not-yet-ready state, so contact Global-e instead of retrying. # Get shipping details (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/get-shipping-details api-reference/specs/getshippingdetails.yaml POST /ShippingDetails/GetShippingDetails Retrieves the cheapest estimated shipping cost and the free-shipping threshold range per destination, for a cart, mini cart, or product page. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [Estimated Shipping Rates](/shipping-options-api) integration guide — see it for when and how to use this endpoint. # Get shipping details extended (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/get-shipping-details-extended api-reference/specs/getshippingdetailsextended.yaml POST /ShippingDetails/GetShippingDetailsExtended Returns all flat shipping-rate thresholds for all shipping services related to a product, per destination country. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [Estimated Shipping Rates](/shipping-options-api) integration guide — see it for when and how to use this endpoint. # Get shipping documents (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/get-shipping-documents api-reference/specs/getshippingdocuments.yaml POST /Order/GetShippingDocuments From the orders indicated as fulfilled, the Global-e API will return the required shipping documentation as a base64 encoded byte array and URL for printing > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [Generating Shipping Documents](/shipping-documents-api) integration guide — see it for when and how to use this endpoint. # Get subscription and payment reference details (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/get-subscription-and-payment-reference-details api-reference/specs/getsubscriptionandpaymentreferencedetails.yaml GET /Payments/Subscriptions/{merchantGuid} The merchant calls Global-e to return the current masked payment method and billing address per subscription ID, for display in the merchant portal. The response is a batch: one result per requested ID, each either with Data or with an Error. > [!WARNING] > > **Server-to-server only.** The call to Global-e Web must be made server-to-server and never from the client side. The `merchantGuid` route parameter is a secret key that identifies the merchant and must not be exposed in browser-side code, client requests, or anywhere it could be intercepted. Keep it on the backend and issue this request from your server. > [!NOTE] > > Part of the [Subscription Connector](/subscription-connector) integration guide — see it for when and how to use this endpoint. # Get tracking events (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/get-tracking-events api-reference/specs/gettrackingevents.yaml POST /Shipment/GetTrackingEvents Receive status events on the delivery status of an order — a list of Global-e order IDs and/or tracking numbers (all the same direction), returning their tracking events. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. The Get Tracking Events API lets you receive status events on the delivery status of an order — a list of either forward shipments after checkout completion (`outbound`) or returns (`inbound`), up to 100 per call — and returns their status. Having tracking events for return shipments also lets refunds be triggered automatically upon confirmation of returned-item receipt (or any other tracking event). > [!NOTE] > > **Prerequisite — one direction per request.** A request may include a list of Global-e order IDs, a list of tracking numbers, or both — but all the same type: `inbound` or `outbound`. Inbound and outbound cannot be mixed; to request both, issue two separate requests. > [accordion] Global-e Tracking Events — GlobaleEventCode reference (codes 1–63) > > The full list of tracking events reported by Global-e (`GlobaleEventCode` → `GlobaleEventDescription`), returned in the `TrackingEvents` array of each successful result: > > | Code | Description | > | - | - | > | 1 | The parcel has been created but is waiting to be manifested (i.e. despatched) | > | 2 | The parcel has been manifested (i.e. despatched) | > | 3 | The carrier has yet to receive the parcel into their network | > | 4 | The carrier has acknowledged receipt of the parcel into their network | > | 5 | The carrier has acknowledged receipt of the parcel into their network but did not receive the required electronic manifest (pre advice file) | > | 6 | A collection request has been acknowledged by the carrier | > | 7 | The carrier has successfully collected a parcel from a customer | > | 8 | The carrier has failed to collect a parcel from a customer | > | 9 | The parcel has been misrouted by the carrier due to incorrect routing on the label | > | 10 | The parcel has been misrouted by the carrier due to incorrect routing on the label | > | 11 | The parcel has been advised as lost within the carriers network | > | 12 | The parcel has been delayed due to factors beyond the carriers control (i.e. inclement weather) | > | 13 | The parcel is with Customs (NR: This does not necessarily mean that the parcel has been refused entry into the destination country) | > | 14 | The parcel has been damaged | > | 15 | The parcel is in transit (NB: This could either be en route to a country hubs delivery depot) | > | 16 | The parcel has been Left at the local post office for collection | > | 17 | The parcel is with a 3rd party sub-contractor and a tracking event has occurred (refer to "Confirmation' field for further information if provided | > | 18 | The parcel has left the delivery depot for the recipients address | > | 19 | The parcel has been received by a sub-contractor 3rd party | > | 20 | The carrier has a query concerning the recipients address (i.e. Unable to locate,. incorrect post code etc.) | > | 21 | The carrier has left a calling card for the customer as they were unable to deliver the parcel | > | 22 | The carrier has delivered part of the consignment advised (e.g. Parcel 1 parcel of a 2 parcel consignment has been delivered) | > | 23 | The parcel is available to collect from the carriers premises | > | 24 | The parcel is being held at the delivery depot | > | 25 | The recipient no longer resides at the delivery address | > | 26 | The recipient refused to take delivery of the parcel | > | 27 | The parcel is to be returned to the sender | > | 28 | The carrier was unable to deliver the parcel (No reason specified) | > | 29 | The parcel has been successfully delivered | > | 30 | The carrier has provided some information concerning the parcel | > | 31 | An event has occurred after the parcel has been delivered / lost or RTS (i.e. acknowledgement of a claim) | > | 32 | Special delivery instructions to app.? | > | 33 | The delivery / collection has requested to be cancelled | > | 34 | The carrier has received an electronic pre advice (manifest) for this parcel | > | 35 | The parcel has been at a status that does not set an actual or default end date and as such has been 'closed" after a certain period of time dependent on the environment it belongs to | > | 36 | The parcel was miss sorted by the carrier and sent to the incorrect -deliver? dept. | > | 37 | The recipient has arranged a delivery with the carrier | > | 38 | The carrier attempted to deliver the parcel but was unable to access the recipients address to deliver or leave a calling card (i.e. Closed office building, gated development etc) | > | 39 | The payment for cash on delivery could not be collected | > | 40 | The recipient's identification failed | > | 41 | The payment could not be processed due to an invalid method of payment by recipient. | > | 42 | The payment for cash on delivery of parcel has been collected by the carrier | > | 43 | The parcel has been cleared for delivery | > | 44 | The parcel has been re boxed / re packed | > | 45 | The parcel has been requested to be disposed | > | 46 | The declared weight of the parcel does not match the actual weight of the parcel. | > | 47 | The parcel has been held by destination Customs | > | 48 | The parcel has been held by origin Customs | > | 49 | The parcel has been delivered to a neighbour's address | > | 50 | The parcel has been delivered to a safe place suggested by the recipient | > | 51 | The customer has collected the parcel from the store | > | 52 | The parcel is received at store and is ready for collection by recipient | > | 53 | The parcel is ready for collection at the store and it has not been collected after a period of time | > | 54 | The parcel has been delivered to a locker or collection point and is ready to be collected by the recipient. | > | 55 | The parcel has been delivered to the recipient's preferred point instead of collecting from depot or re-delivery or return | > | 56 | The package has been held by the carrier whilst collecting recipient details for clearance | > | 57 | The parcel has been re-labelled | > | 58 | The parcel attributes lie outside of service capability, i.e. weight/size/remote area issues | > | 59 | An SMS has been transmitted to the recipient to inform that the parcel is out for delivery today | > | 60 | An email has been transmitted to the recipient to inform that the parcel is out for delivery today | > | 61 | The carrier attempted delivering the parcel but could not deliver | > | 62 | The package/s arrived to the destination country | > | 63 | A choice that the customer has made for delivery to a safe place (the delivery not happened yet) | > [accordion] Error codes (E01–E11) > > Returned per item in the `FailedTrackingNumbers` list. `{0}` is replaced with the relevant value (order ID, tracking number, or limit). > > | Code | Message | > | - | - | > | E01 | The shipment (`{0}`) is not trackable with this shipper | > | E02 | The order (`{0}`) is not trackable with this shipper | > | E03 | The provided tracking number (`{0}`) was not found | > | E04 | The provided order ID (`{0}`) was not found | > | E05 | The order (`{0}`) is not associated to the merchant | > | E06 | The tracking number (`{0}`) is not associated to the merchant | > | E07 | The order (`{0}`) doesn't have a tracking number | > | E08 | The tracking event type parameter is invalid | > | E10 | The number of input values (Tracking Number and Order IDs) exceeded the (`{0}`) limit | > | E11 | At least one Order ID or Tracking Number should be specified | # Location by IP (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/location-by-ip api-reference/specs/locationbyip.yaml POST /Browsing/LocationByIP Returns the shopper's geo-location by IP address, falling back to the merchant's default location when the IP cannot be resolved. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns the user’s geo-location by IP address. The merchant’s default location is returned if an IP address cannot be found (for example if a private network IP address has been specified). The merchant-side caching policy defined by this method should be applied to the whole IP range returned for the IP address specified. # Location default culture (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/location-default-culture api-reference/specs/locationdefaultculture.yaml POST /Browsing/LocationDefaultCulture Returns the default culture for the specified location (city, region, country). > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns the default Culture for the user’s location specified. # Locations Default Cultures List (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/locations-default-cultures-list api-reference/specs/locationsdefaultcultureslist.yaml POST /Browsing/LocationsDefaultCulturesList Returns the list of locations and their respective default Cultures. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. This method may be used as an alternative for calling `LocationDefaultCulture` for every user’s geo-location returned by the `LocationByIp` method. If `LocationsDefaultCulturesList` returns no `LocationCulture` item matching Country, Region, and City determined by `LocationByIp` , the fallback is to use the `LocationCulture` item with matching Country, matching Region, and empty value for City. If there is no `LocationCulture` with the matching Country and Region as well, the fallback is to use the `LocationCulture` item with a matching Country, empty value for Region, and empty value for City. # Notify order refund (Global-e to Merchant) Source: https://docs.global-e.com/api-reference/notify-order-refund api-reference/specs/notifyorderrefund.yaml POST /order-refund-url The NotifyOrderRefund API notifies the merchant about Global-e initiated refund issued to the end customer. > [!NOTE] > > Part of the [Refunds Notifications (Global-e to Merchant)](/refunds-notifications--from-global-e-) integration guide — see it for when and how to use this endpoint. > [!WARNING] > > Some values in the payload are encoded and must be decoded by the merchant — for example URLs, addresses, emails, and phone numbers. # Attributes Source: https://docs.global-e.com/api-reference/objects/attributes The Attributes shared object definition, reused across multiple Global-e API endpoints. > [!NOTE] > > `Attributes` is a **shared, cross-endpoint object definition**. An individual endpoint uses only the subset its own request or response references — always check that endpoint's reference page for the fields it actually accepts or returns. | Field | Type | Required | 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 | # BillingDetails Source: https://docs.global-e.com/api-reference/objects/billing-details The BillingDetails shared object definition, reused across multiple Global-e API endpoints. > [!NOTE] > > `BillingDetails` is a **shared, cross-endpoint object definition**. An individual endpoint uses only the subset its own request or response references — always check that endpoint's reference page for the fields it actually accepts or returns. | Field | Type | Required | Description | | - | - | - | - | | `Address1` | String | — | Address line 1. Length: Unlimited. | | `Address2` | String | — | Address line 2. Length: Unlimited. | | `City` | String | — | City name. Max length: 500 chars. | | `CountryCode` | String | — | 2-char ISO country code | | `CountryName` | String | — | Country name. Max length: 255 chars. | | `Email` | String | — | E-mail address. Max length: 500 chars. | | `Fax` | String | — | Fax number. Max length: 250 chars. | | `FirstName` | String | — | Customer’s first name. Max length: 40 chars. No length validation. The rest will be truncated. | | `LastName` | String | — | Customer’s last name. Max length: 40 chars. No length validation. The rest will be truncated. | | `MiddleName` | String | — | Middle name. Max length:40 chars. No length validation. The rest will be truncated. | | `Phone1` | String | — | Phone #1. Max length: 250 chars. | | `Phone2` | String | — | Phone #2. Max length: 250 chars. | | `Salutation` | String | — | Salutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars. | | `StateCode` | String | — | State or province ISO code such as AZ for Arizona (if applicable) | | `StateOrProvince` | String | — | State or province name. Max length: 500 chars. | | `UserIdNumber` | String | — | User’s personal ID document number | | `UserIdNumberType` | object ([UserIdNumberType](/api-reference/objects/user-id-number-type)) | — | User’s personal ID document type. Includes the following fields: UserIdNumberTypeCode • Name | | `UserId` | String | — | Internal User identifier on the Merchant site | | `Zip` | String | — | Zip or postal code. Max length: 250 chars. | # Brand Source: https://docs.global-e.com/api-reference/objects/brand The Brand shared object definition, reused across multiple Global-e API endpoints. > [!NOTE] > > `Brand` is a **shared, cross-endpoint object definition**. An individual endpoint uses only the subset its own request or response references — always check that endpoint's reference page for the fields it actually accepts or returns. | Field | Type | Required | Description | | - | - | - | - | | `BrandCode` | String | — | Brand code on the Merchant’s site (to be mapped on the Global‑e side) | | `Name` | String | — | Brand name | # Category Source: https://docs.global-e.com/api-reference/objects/category The Category shared object definition, reused across multiple Global-e API endpoints. > [!NOTE] > > `Category` is a **shared, cross-endpoint object definition**. An individual endpoint uses only the subset its own request or response references — always check that endpoint's reference page for the fields it actually accepts or returns. | Field | Type | Required | Description | | - | - | - | - | | `CategoryCode` | String | — | Category code on the Merchant site (to be mapped on the Global‑e side) | | `Name` | String | — | Category name | # DiscountsList Source: https://docs.global-e.com/api-reference/objects/discounts-list The DiscountsList shared object definition, reused across multiple Global-e API endpoints. > [!NOTE] > > `DiscountsList` is a **shared, cross-endpoint object definition**. An individual endpoint uses only the subset its own request or response references — always check that endpoint's reference page for the fields it actually accepts or returns. | Field | Type | Required | Description | | - | - | - | - | | `CouponCode` | String | — | Merchant CouponCode used for this discount (applicable to coupon-based discounts only) | | `Description` | String | — | Discount textual description. Length: unlimited. | | `DiscountCode` | String | — | Discount code used to identify the discount on the Merchant’s site. This property may be optionally specified in the SendCart API only so that the same value can be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant API. | | `DiscountType` | Decimal | — | One of the following possible values of DiscountTypeOptions enumeration denoting a type of discount: Cart discount • Shipping discount • Loyalty points discount • Duties discount • Checkout Loyalty points discount • Payment charge | | `Name` | String | Yes | Discount name. Length: unlimited. | | `OriginalDiscountValue` | Currency | Yes | 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. Max length: 18,4. | | `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 API only so that the same value can be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant API. Max length: 50 chars. | # Parcel Source: https://docs.global-e.com/api-reference/objects/parcel The Parcel shared object definition, reused across multiple Global-e API endpoints. > [!NOTE] > > `Parcel` is a **shared, cross-endpoint object definition**. An individual endpoint uses only the subset its own request or response references — always check that endpoint's reference page for the fields it actually accepts or returns. | Field | Type | Required | Description | | - | - | - | - | | `Height` | Decimal | — | Parcel height in centimeters/inches as measured by the Merchant. | | `Length` | Decimal | — | Parcel length in centimeters/inches as measured by the Merchant. | | `ParcelCode` | String | — | Code used to identify the Parcel on the Merchant’s site | | `Products` | List of Product | — | List of products contained in the parcel (for each Product object the following fields are relevant when used in the Parcel class: ProductCode, CartItemId, DeliveryQuantity). The products list is applicable only when including the list of products in each parcel is mandatory (such as in the UpdateParcelDispatch method). | | `TrackingDetails` | Object TrackingDetails | — | Tracking information about the order/parcel. | | `Weight` | Decimal | — | Parcel weight in grams as measured by the Merchant. | | `Width` | Decimal | — | Parcel width in grams as measured by the Merchant. | # ShippingDetails Source: https://docs.global-e.com/api-reference/objects/shipping-details The ShippingDetails shared object definition, reused across multiple Global-e API endpoints. > [!NOTE] > > `ShippingDetails` is a **shared, cross-endpoint object definition**. An individual endpoint uses only the subset its own request or response references — always check that endpoint's reference page for the fields it actually accepts or returns. | Field | Type | Required | Description | | - | - | - | - | | `Address1` | String | — | Address line 1. Unlimited length. | | `Address2` | String | — | Address line 2. Unlimited length. | | `City` | String | — | City name. Max length: 500 chars. | | `CountryCode` | String | — | 2-char ISO country code | | `CountryName` | String | — | Country name. Max length: 255 chars. | | `Email` | String | — | E-mail address. Max length: 500 chars. | | `Fax` | String | — | Fax number. Max length: 250 chars. | | `FirstName` | String | — | First name. Max length: 40 chars. No length validation. The rest will be truncated. | | `LastName` | String | — | Last name. Max length:40 chars. No length validation. The rest will be truncated. | | `MiddleName` | String | — | Middle name. Max length:40 chars. No length validation. The rest will be truncated. | | `Phone1` | String | — | Phone #1. Max length: 250 chars. | | `Phone2` | String | — | Phone #2. Max length: 250 chars. | | `Salutation` | String | — | Salutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars. | | `StateCode` | String | — | State or province ISO code such as AZ for Arizona (if applicable). 2 chars. | | `StateOrProvince` | String | — | State or province name. Max length: 500 chars. | | `UserId` | Decimal | — | Internal User identifier on the Merchant site | | `UserIdNumber` | String | — | User’s personal ID document number | | `UserIdNumberType` | String | — | User’s personal ID document type (e.g. Passport, ID card, etc.) | | `Zip` | String | — | Zip or postal code. Max length: 250 chars. | # UserIdNumberType Source: https://docs.global-e.com/api-reference/objects/user-id-number-type The UserIdNumberType shared object definition, reused across multiple Global-e API endpoints. > [!NOTE] > > `UserIdNumberType` is a **shared, cross-endpoint object definition**. An individual endpoint uses only the subset its own request or response references — always check that endpoint's reference page for the fields it actually accepts or returns. | Field | Type | Required | Description | | - | - | - | - | | `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) | # VATRateType Source: https://docs.global-e.com/api-reference/objects/vat-rate-type The VATRateType shared object definition, reused across multiple Global-e API endpoints. > [!NOTE] > > `VATRateType` is a **shared, cross-endpoint object definition**. An individual endpoint uses only the subset its own request or response references — always check that endpoint's reference page for the fields it actually accepts or returns. | Field | Type | Required | Description | | - | - | - | - | | `Name` | String | — | VAT rate type name | | `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) | # API Reference Source: https://docs.global-e.com/api-reference/overview The Global-e REST API, grouped by area. Select an endpoint for its full request/response schema, parameters, and examples. The Global-e REST API. Endpoints are grouped by area below — select one to open its full request and response schema, parameters, and examples. Shared objects reused across endpoints are listed at the end. ## Shipping | Endpoint | Method & path | | - | - | | [Get shipping documents (Merchant to Global-e)](/api-reference/get-shipping-documents) | `POST /Order/GetShippingDocuments` | | [Get shipping details (Merchant to Global-e)](/api-reference/get-shipping-details) | `POST /ShippingDetails/GetShippingDetails` | | [Get shipping details extended (Merchant to Global-e)](/api-reference/get-shipping-details-extended) | `POST /ShippingDetails/GetShippingDetailsExtended` | | [Get free shipping banner data (Merchant to Global-e)](/api-reference/get-free-shipping-banner-data) | `GET /banners/data/free-shipping` | | [Get free shipping banner data, anonymous (Merchant to Global-e)](/api-reference/get-free-shipping-banner-data-anonymous) | `GET /banners/data/{merchantId}/free-shipping` | | [Dispatch orders (Merchant to Global-e)](/api-reference/dispatch-orders) | `POST /Order/DispatchOrders` | | [Dispatch consolidated shipment (Merchant to Global-e)](/api-reference/dispatch-consolidated-shipment) | `POST /Order/DispatchConsolidatedShipment` | | [Get tracking events (Merchant to Global-e)](/api-reference/get-tracking-events) | `POST /Shipment/GetTrackingEvents` | | [Void parcel (Merchant to Global-e)](/api-reference/void-parcel) | `POST /Parcel/VoidParcel` | | [Submit bonded information (Merchant to Global-e)](/api-reference/submit-bonded-information) | `POST /api/merchant/parcels/bonded-information` | | [Upload shipment documents (Merchant to Global-e)](/api-reference/upload-shipment-documents) | `POST /api/shipments/documents/upload` | | [Get shipment information (Merchant to Global-e)](/api-reference/get-shipment-information) | `GET /api/shipments/{trackingNumber}` | ## Orders | Endpoint | Method & path | | - | - | | [Create order (Merchant to Global-e)](/api-reference/create-order) | `POST /checkout/CreateOrder` | | [Edit order (Merchant to Global-e)](/api-reference/edit-order) | `POST /api/orders/changes` | | [Quote order changes (Merchant to Global-e)](/api-reference/edit-order-quote) | `POST /api/orders/changes/quote` | | [Update Order Dispatch](/api-reference/update-order-dispatch) | `POST /Order/UpdateOrderDispatch` | | [Update parcel status (Merchant to Global-e)](/api-reference/update-parcel-status) | `POST /orders/{orderId}/parcels/{parcelCode}/statuses` | | [Update Order Status](/api-reference/update-order-status) | `POST /Order/UpdateOrderStatus` | | [Create order refund (Merchant to Global-e)](/api-reference/create-order-refund) | `POST /Order/CreateOrderRefund` | | [Create order platform (Merchant to Global-e)](/api-reference/create-order-platform) | `POST /Checkout/CreateOrderPlatform` | | [Update Order Products (Merchant to Global-e)](/api-reference/update-order-products) | `POST /Order/UpdateOrderProducts` | | [UpdateOrderDispatchV2](/api-reference/update-order-dispatch-v2) | `POST /Order/UpdateOrderDispatchV2` | | [Create Additional Required Documents (Merchant to Global-e)](/api-reference/create-additional-required-documents) | `POST /additional-required-documents` | | [Get refund details (Merchant to Global-e)](/api-reference/get-refund-details) | `GET /v1/orders/{orderId}/refunds` | | [Sending Bulk Emails (Merchant to Global-e)](/api-reference/send-bulk-emails) | `POST /emails` | | [Send Order To Merchant (Global-e to Merchant)](/api-reference/send-order-to-merchant) | `POST /order-update-create-url` | | [Send additional required documents to merchant (Global-e to Merchant)](/api-reference/send-additional-required-documents-to-merchant) | `POST /send-additional-required-documents-url` | | [Notify order refund (Global-e to Merchant)](/api-reference/notify-order-refund) | `POST /order-refund-url` | | [Update Order Shipping Info (Global-e to Merchant)](/api-reference/update-order-shipping-info) | `POST /order-shipping-info-update-only-url` | | [Update Order Status (Global-e to Merchant)](/api-reference/update-order-status-from-globale) | `POST /order-status-update-url` | | [Send RMA Info to Merchant (Global-e to Merchant)](/api-reference/send-rma-info-merchant) | `POST /rma-info-to-merchant-url` | | [Perform Order Payment (Global-e to Merchant)](/api-reference/perform-order-payment) | `POST /order-payment-only-url` | ## Returns | Endpoint | Method & path | | - | - | | [Get return shipping options (Merchant to Global-e)](/api-reference/get-return-shipping-options) | `POST /Return/GetReturnShippingOptions` | | [Get return documents (Merchant to Global-e)](/api-reference/get-return-documents) | `POST /Return/GetReturnDocuments` | | [Update RMA (Merchant to Global-e)](/api-reference/update-rma) | `POST /Return/UpdateRMA` | ## Gift Cards | Endpoint | Method & path | | - | - | | [Validate gift card](/api-reference/validate-gift-card) | `POST /ValidateGiftCard` | | [Redeem gift card](/api-reference/redeem-gift-card) | `POST /RedeemGiftCard` | | [Refund gift card](/api-reference/refund-gift-card) | `POST /RefundGiftCard` | ## Checkout | Endpoint | Method & path | | - | - | | [SendCartV2 (Merchant to Global-e)](/api-reference/send-cart-v2) | `POST /Checkout/SendCartV2` | ## Pricing | Endpoint | Method & path | | - | - | | [Get catalog prices (Merchant to Global-e)](/api-reference/get-catalog-prices) | `POST /Browsing/GetCatalogPrices` | | [GetMerchantPriceDetails (Merchant to Global-e)](/api-reference/get-merchant-price-details) | `GET /externalapi/GetMerchantPriceDetails` | ## Browsing & Catalog | Endpoint | Method & path | | - | - | | [Active hub details (Merchant to Global-e)](/api-reference/active-hub-details) | `POST /Browsing/ActiveHubDetails` | | [App settings (Merchant to Global-e)](/api-reference/app-settings) | `POST /Browsing/AppSettings` | | [App version (Merchant to Global-e)](/api-reference/app-version) | `POST /Browsing/AppVersion` | | [Countries (Merchant to Global-e)](/api-reference/countries) | `POST /Browsing/Countries` | | [Country coefficients (Merchant to Global-e)](/api-reference/country-coefficients) | `POST /Browsing/CountryCoefficients` | | [Currencies (Merchant to Global-e)](/api-reference/currencies) | `POST /Browsing/Currencies` | | [Currency Rates (Merchant to Global-e)](/api-reference/currency-rates) | `POST /Browsing/CurrencyRates` | | [Location by IP (Merchant to Global-e)](/api-reference/location-by-ip) | `POST /Browsing/LocationByIP` | | [Location default culture (Merchant to Global-e)](/api-reference/location-default-culture) | `POST /Browsing/LocationDefaultCulture` | | [Locations Default Cultures List (Merchant to Global-e)](/api-reference/locations-default-cultures-list) | `POST /Browsing/LocationsDefaultCulturesList` | | [Product Countries (Merchant to Global-e)](/api-reference/product-countries) | `POST /Browsing/ProductCountryS` | | [Recent Product Countries (Merchant to Global-e)](/api-reference/recent-product-countries) | `POST /Browsing/RecentProductCountryS` | | [Regions (Merchant to Global-e)](/api-reference/regions) | `POST /Browsing/Regions` | | [Rounding rules (Merchant to Global-e)](/api-reference/rounding-rules) | `POST /Browsing/RoundingRules` | | [Save products list (Merchant to Global-e)](/api-reference/save-products-list) | `POST /Browsing/SaveProductsList` | | [Save Products Bulk (Merchant to Global-e)](/api-reference/save-products-bulk) | `POST /Bulk/SaveProductsBulk` | | [Shipping Options (Merchant to Global-e)](/api-reference/shipping-options) | `POST /Browsing/ShippingOptions` | | [VAT Category Countries (Merchant to Global-e)](/api-reference/vat-category-countries) | `POST /Browsing/VATCategoryCountryS` | ## Subscriptions | Endpoint | Method & path | | - | - | | [Get subscription and payment reference details (Merchant to Global-e)](/api-reference/get-subscription-and-payment-reference-details) | `GET /Payments/Subscriptions/{merchantGuid}` | | [Subscription notifications (Subscription Manager to Global-e)](/api-reference/subscription-notifications) | `POST /subscriptions/notifications` | | [Calculate billing summary (Subscription Manager to Global-e)](/api-reference/calculate-billing-summary) | `POST /subscriptions/billing-summary/calculate` | | [Create recurring payment (Subscription Manager to Global-e)](/api-reference/create-recurring-payment) | `POST /subscriptions/recurringPayments` | | [Update a subscription (Subscription Manager to Global-e)](/api-reference/update-subscription) | `PATCH /subscriptions/{subscriptionId}` | | [Recurring payment notifications (Global-e to Subscription Manager)](/api-reference/recurring-payment-notifications) | `POST /subscriptions/recurringPayments/notifications` | ## Checkout & Cart | Endpoint | Method & path | | - | - | | [Get Checkout Cart Info (Global-e to Merchant)](/api-reference/get-checkout-cart-info) | `GET /get-checkout-cart-info-url` | | [Validate Stock (Global-e to Merchant)](/api-reference/validate-stock) | `POST /checkout-validate-cart-stock-url` | | [ValidateVoucher (Global-e to Merchant)](/api-reference/validate-voucher) | `POST /checkout-validate-cart-voucher-url` | | [Client apply loyalty vouchers (Global-e to Merchant)](/api-reference/client-apply-loyalty-vouchers) | `POST /ClientApplyLoyaltyVouchers` | | [RemoveRestrictedProducts (Global-e to Merchant)](/api-reference/remove-restricted-products) | `POST /remove-restricted-products-url` | ## Fulfillment | Endpoint | Method & path | | - | - | | [Update Parcel Dispatch](/api-reference/update-parcel-dispatch) | `POST /UpdateParcelDispatch` | ## Shared Objects Schema definitions reused across several endpoints. * [Attributes](/api-reference/objects/attributes) * [BillingDetails](/api-reference/objects/billing-details) * [Brand](/api-reference/objects/brand) * [Category](/api-reference/objects/category) * [DiscountsList](/api-reference/objects/discounts-list) * [Parcel](/api-reference/objects/parcel) * [ShippingDetails](/api-reference/objects/shipping-details) * [UserIdNumberType](/api-reference/objects/user-id-number-type) * [VATRateType](/api-reference/objects/vat-rate-type) # Perform Order Payment (Global-e to Merchant) Source: https://docs.global-e.com/api-reference/perform-order-payment api-reference/specs/performorderpayment.yaml POST /order-payment-only-url Global-e posts order payment details to a merchant-hosted endpoint via the PerformOrderPayment API. > [!NOTE] > > This API is part of Global-e's extensions and plug-ins. Merchants do not need to implement this API unless a custom integration is required. Global-e calls this endpoint on the merchant's site once its verification process is complete, to confirm the order created by [Send Order To Merchant](/api-reference/send-order-to-merchant) and indicate that the order can be pushed to fulfilment. > [card] [Orders - Placement, History](/orders---placement-history) > > Step 2 of the order placement flow — when Global-e calls this endpoint, retry and timeout behaviour, and the full sequence from order creation to fulfilment. > [!WARNING] > > Some values in the payload are encoded and must be decoded by the merchant — for example URLs, addresses, emails, and phone numbers. # Product Countries (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/product-countries api-reference/specs/productcountries.yaml POST /Browsing/ProductCountryS Returns the list of ProductCountry objects for the specified products, with per-country shipping, restriction, and VAT details. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns the list of ProductCountry objects for the list of products specified. # Recent Product Countries (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/recent-product-countries api-reference/specs/recentproductcountries.yaml POST /Browsing/RecentProductCountryS Returns ProductCountry objects (country exceptions, restrictions, and VAT rates) changed since a given request id. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns the list of ProductCountry objects requested by the Merchant since requestId is specified. This method may be used by the Merchants to load to their local “cache” ProductCountries storage, product “country exceptions” (product/country combinations that have commercial or regulatory country-specific restrictions, as well as any non-standard VAT rates that should be applied to the respective products in the respective EU countries). For the first call to RecentProductCountryS , requestId=0 must be specified. If any ProductCountry object record returned by RecentProductCountryS API is not "restricted", not "forbidden", and VATRateType 's rate is equal to the respective country’s default VATRateType 's rate, this indicates that this ProductCountry is “reverted” to “default” (no restrictions and default country VAT rate). In such a case, this ProductCountry should not be created in the local "cache" ProductCountries storage. If this ProductCountry already exists in the local "cache" storage, then it has to be deleted from there. Note that the IsForbidden flag actually denotes global restriction that is applied to ALL countries for the respective product. So if IsForbidden is set, it will be set for all countries, although in Global‑e core it’s actually a Product level flag (rather than ProductCountry level). # Recurring payment notifications (Global-e to Subscription Manager) Source: https://docs.global-e.com/api-reference/recurring-payment-notifications api-reference/specs/recurringpaymentnotifications.yaml POST /subscriptions/recurringPayments/notifications Global-e informs Subscription Manager about recurring payments's updates. > [!NOTE] > > Part of the [Subscription Connector](/subscription-connector) integration guide — see it for when and how to use this endpoint. > [!WARNING] > > This is the one contract in the Subscriptions set that **you implement and Global-e calls**. The server is the Subscription Manager, not Global-e. # Redeem gift card Source: https://docs.global-e.com/api-reference/redeem-gift-card api-reference/specs/giftcards.yaml POST /RedeemGiftCard Use the Redeem Gift Card API call to send the remaining card balance to the Platform, and the Platform updates the information accordingly. > [!NOTE] > > Part of the [Gift Cards](/gift-cards-281937) integration guide — see it for when and how to use this endpoint. # Refund gift card Source: https://docs.global-e.com/api-reference/refund-gift-card api-reference/specs/giftcards.yaml POST /RefundGiftCard Use the Refund Gift Card API to send a request to return the used gift card balance in cases where an order is canceled or a new refund is created. > [!NOTE] > > Part of the [Gift Cards](/gift-cards-281937) integration guide — see it for when and how to use this endpoint. # Regions (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/regions api-reference/specs/regions.yaml POST /Browsing/Regions Returns the list of regions (states or provinces), optionally filtered by country. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns the list of regions (states or provinces) optionally filtered by Country. The list might include only the regions for the countries where specifying a region in address is mandatory ( IsStateMandatory = true). # RemoveRestrictedProducts (Global-e to Merchant) Source: https://docs.global-e.com/api-reference/remove-restricted-products api-reference/specs/removerestrictedproducts.yaml POST /remove-restricted-products-url This API removes restricted products from the merchant cart; it notifies merchants that restricted products were removed from the cart, then merchants must also update the cart on the merchant side. > [!NOTE] > > This API is part of Global-e's extensions and plug-ins. Merchants do not need to implement this API unless a custom integration is required. # Rounding rules (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/rounding-rules api-reference/specs/roundingrules.yaml POST /Browsing/RoundingRules Returns the list of rounding rules for a merchant, optionally filtered by currency and country. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns the list of rounding rules, optionally filtered by currency and country The `RangeBehavior` on each `RoundingRange` selects one of the behaviors below. Expand for the calculation logic, the important notices, and worked samples. > [accordion] RangeBehaviors enumeration — calculation logic > > **1 — Absolute target.** In this behavior all the values within the specified range (`LowerTarget`, `UpperTarget`, `Threshold` and `RoundingExceptions`) denote the values themselves as is, without the need for any additional math operations. Getting rounding result (R) for the source number (S) must be implemented as follows: > > ``` > If (S = Exceptionn) then R = Exceptionn > If (S < Threshold) then R = LowerTarget > If (S >= Threshold) then R = UpperTarget > ``` > > **2 — Relative Decimal target.** In this behavior all the values within the specified range (`LowerTarget`, `UpperTarget`, `Threshold` and `RoundingExceptions`) represent floating point numbers between 0 (inclusive) and 1 (inclusive), used to calculate the respective absolute values, relative to the calculation base (B) as follows: > > ``` > For source number (S): B = whole part of S > LowerTarget (absolute): LA = B – 1 + LowerTarget > UpperTarget (absolute): UA = B + UpperTarget > Threshold (absolute): TA = B + Threshold > Exceptionn (absolute): EAn = B + Exceptionn > If (S = EAn) then Result (R) = EAn > If (S < TA) then R = LA > If (S >= TA) then R = UA > ``` > > **3 — Relative Whole target.** In this behavior ALL the values within the specified range (`LowerTarget`, `UpperTarget`, `Threshold` and `RoundingExceptions`) represent non-negative whole numbers, while `TargetBehaviorHelperValue` (V) is used to determine the calculation base (B). V must be a power of 10 (10, 100, 1000, etc.) and denotes the order of magnitude for the range "split" by the Threshold. For example, if Threshold = 9 we need to know if this is 9 out of 10 or 9 out of 100. Getting rounding result (R) for the source number (S) must be implemented as follows: > > ``` > For source number (S): B = S rounded down to the closest multiple of V > For example if (S = 56789 and V = 1000) then B = 56000 > LowerTarget (absolute): LA = B – V + LowerTarget > UpperTarget (absolute): UA = B + UpperTarget > Threshold (absolute): TA = B + Threshold > Exceptionn (absolute): EAn = B + Exceptionn > If (S = EAn) then Result (R) = EAn > If (S < TA) then R = LA > If (S >= TA) then R = UA > ``` > > **4 — Nearest target.** In this behavior, `LowerTarget` and `UpperTarget` represent non-negative floating-point numbers, while `TargetBehaviorHelperValue` (V) is used to determine the calculation base (B). V must be a whole divisor of any power of 10 (5, 10, 25, 50, 100, 250, 500, 1000, etc.). The threshold must be any floating-point number between 0 (inclusive) and V (exclusive). Getting rounding result (R) for the source number (S) must be implemented as follows: > > ``` > For source number (S): B = S rounded down to the closest multiple of V > For example, if (S = 123 and V = 5) then B = 120 > LowerTarget (absolute): LA = B – 1 + LowerTarget > UpperTarget (absolute): UA = B – 1 + V + UpperTarget > Threshold (absolute): TA = B + Threshold > Exceptionn (absolute): EAn = B + Exceptionn > If (S = EAn) then Result (R) = EAn > If (S < TA) then R = LA > If (S >= TA) then R = UA > ``` > [accordion] Important notices > > * If the result of rounding is a negative number, it must be set to zero, for any rounding behavior defined in the table above. > * If either `LowerTarget` or `UpperTarget` value violates MaxDecimalPlaces setting for the respective currency, this value must be truncated accordingly. For example, if `UpperTarget` is set to 0.999 for USD, it must be truncated to 0.99 before using in any further calculations. > [accordion] Rounding rules samples > > The following samples indicate how rounding X to Y (X → Y) is implemented using the respective settings. Each numbered column is one settings scenario together with its sample results (re-extracted from the source table, preserving column alignment). > > | Setting | 1 | 2 | 3 | 4 | 5 | > | - | - | - | - | - | - | > | Sample results (X → Y) | 0.25 → 0 3 → 0 1.5 → 1.5 2 → 2 | 22.47 → 21.95 22.48 → 22.99 22.50 → 22.50 33.75 → 33.75 | 2047 → 1995 2048 → 2100 | 122.26 → 124.99 122.25 → 119.99 127.26 → 129.99 121.50 → 121.50 127.50 → 127.50 123 → 123 128 → 128 | 2047 → 1999 2048 → 2100 | > | From | 0 | 1 | 1000 | 100 | 1000 | > | To | 3 | 250 | 10000 | 1000 | 10000 | > | Threshold | 3.01 | 0.48 | 48 | 2.26 | 48 | > | LowerTarget | 0 | 0.95 | 95 | 0.99 | 0 | > | UpperTarget | 0 | 0.99 | 100 | 0.99 | 1 | > | RangeBehavior | 1 Absolute | 2 Relative Decimal | 3 Relative Whole | 4 Nearest | 4 Nearest | > | TargetBehaviorHelperValue | | | 100 | 5 | 100 | > | RoundingExceptions | 1.5, 2 | 0.50, 0.75 | | 1.50, 2.50, 3 | | # Save Products Bulk (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/save-products-bulk api-reference/specs/saveproductsbulk.yaml POST /Bulk/SaveProductsBulk Saves product data on the Global-e system, called from a Merchant's ERP before publishing, for early duties and taxes calculation. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Saves the product data on the Global‑e system. This method is designated to be called from a Merchant’s back-end ERP system before the products are published on the Merchant’s website, to provide the data for duties and taxes calculation as soon as possible. Therefore, no end customer-specific information is expected to be provided (unlike in the SaveProductsList method mentioned in the Browsing section of this document). # Save products list (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/save-products-list api-reference/specs/saveproductslist.yaml POST /Browsing/SaveProductsList Saves product data on the Global-e system and returns the matching ProductCountry objects for the specified products. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Saves product data on the Global‑e system and returns the list of matching ProductCountry objects for the list of products specified. The caller is responsible for calling this method for every product not found (or invalidated) in the local cache on the Merchant side. Calling this method as soon as possible will allow Global‑e to map the products to their respective customs category and will therefore allow guaranteed landed cost offering for these products. Therefore, this method should be called when creating or updating the products on the Merchant’s back end as well. # Send additional required documents to merchant (Global-e to Merchant) Source: https://docs.global-e.com/api-reference/send-additional-required-documents-to-merchant api-reference/specs/sendadditionalrequireddocumentstomerchant.yaml POST /send-additional-required-documents-url Posts the required shipping documents of the order to the Merchant’s site. > [!NOTE] > > Part of the [Export Documents](/export-documents) integration guide — see it for when and how to use this endpoint. # Sending Bulk Emails (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/send-bulk-emails api-reference/specs/sendbulkemails.yaml POST /emails Send CS (bulk) emails to multiple addressees in a single API call by providing order IDs, an email type, and optional placeholders. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [Sending Bulk Emails](/sending-bulk-emails) integration guide — see it for when and how to use this endpoint. # SendCartV2 (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/send-cart-v2 api-reference/specs/sendcartv2.yaml POST /Checkout/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. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. # Send Order To Merchant (Global-e to Merchant) Source: https://docs.global-e.com/api-reference/send-order-to-merchant api-reference/specs/sendordertomerchant.yaml POST /order-update-create-url Global-e posts a new order (or updates an existing order) to a merchant-hosted endpoint via the SendOrderToMerchant API. > [!NOTE] > > Step 1 of the [Orders - Placement, History](/orders---placement-history) integration guide — see it for when and how to use this endpoint. This API posts the new order — or updates an existing order — on the merchant's site. When implementing a Global-e extension or plug-in, this method creates the customer order in the merchant's system, clears the user's basket, and optionally reserves the inventory. If `PaymentDetails` are provided, it also performs the payment and returns the currency and amount actually charged in the `ResponseInfo`. > [!NOTE] > > This API is part of Global-e's extensions and plug-ins. Merchants do not need to implement it unless a custom integration is required. > [!NOTE] > > If additional shipping documents are required for merchants that are shipping the order themselves, this is indicated in `AdditionalRequiredDocuments`. In that case, delay fulfilment until the documents are ready and provided in the [SendAdditionalRequiredDocumentsToMerchant](/api-reference/send-additional-required-documents-to-merchant) webhook. > [!WARNING] > > Some values in the payload are encoded and must be decoded by the merchant — for example URLs, addresses, emails, and phone numbers. ## Security Requirements * Merchant GUID — In request payload (required) * Custom header (optional) * IP whitelist (optional) * HTTP Basic Authentication (optional) * JWT (optional) ## Retry Logic There is no retry upon a merchant failure response or timeout. The timeout period is 5 minutes but can be adjusted if necessary. Merchant failure responses or timeouts will trigger an alert to the Global-e NOC team for manual review. Requests that fail to initiate from Global-e side will trigger a retry once a minute for up to 3 attempts, after which an alert will trigger for manual review. # Send RMA Info to Merchant (Global-e to Merchant) Source: https://docs.global-e.com/api-reference/send-rma-info-merchant api-reference/specs/sendrmainfomerchant.yaml POST /rma-info-to-merchant-url Global-e posts a MerchantReturn object (including the RMA number) to a merchant-hosted endpoint via the SendRMAInfoMerchant API. > [!NOTE] > > Part of the [RMA Notifications (Global-e to Merchant)](/rma-notifications--from-global-e-) integration guide — see it for when and how to use this endpoint. # Shipping Options (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/shipping-options api-reference/specs/shippingoptions.yaml POST /Browsing/ShippingOptions Returns all available shipping options for a cart, specified by cartToken or by full checkoutCartInfo details. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns all available shipping options for the cart information specified either by `cartToken` or by including all the relevant `checkoutCartInfo` details. # Submit bonded information (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/submit-bonded-information api-reference/specs/submitbondedinformation.yaml POST /api/merchant/parcels/bonded-information Report, per product, how many units in an already-created parcel are bonded and how many are in free circulation, before the End-of-Day dispatch call. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > This API is enabled per merchant account by Global-e. If it is not enabled for your account, the request returns `403 Forbidden` with no response body. > [!NOTE] > > **Typical integration sequence.** These APIs may be used together when an export declaration or bonded reporting is required, but they are **independent endpoints** — none is a prerequisite for another. > > 1. [Get shipping documents](/api-reference/get-shipping-documents) — obtain the label and tracking number > 2. **Submit bonded information** — report bonded vs free-circulation status per product *(when bonded reporting is required)* > 3. [Get shipment information](/api-reference/get-shipment-information) — retrieve product, pricing and declaration header data *(when you need the data Global-e holds)* > 4. Create the export document — your side, not a Global-e API > 5. [Upload shipment documents](/api-reference/upload-shipment-documents) — upload the document and its reference to Global-e *(when a document must be attached)* > 6. [Dispatch orders](/api-reference/dispatch-orders) — End of Day > > Only steps 1 and 6 are universal. Steps 2 to 5 depend on the shipment type, the destination and your configuration. Where they apply, complete steps 2 and 5 **before End of Day / Dispatch orders**. > [!NOTE] > > If bonded information is not submitted before End of Day, Global-e applies a default bonded status per item based on the parcel's fulfilment origin and destination. Values submitted through this API always override the default. # Subscription notifications (Subscription Manager to Global-e) Source: https://docs.global-e.com/api-reference/subscription-notifications api-reference/specs/subscriptionnotifications.yaml POST /subscriptions/notifications Subscription Manager informs Global-e about subscription's updates. > [!NOTE] > > Part of the [Subscription Connector](/subscription-connector) integration guide — see it for when and how to use this endpoint. # Update Order Dispatch Source: https://docs.global-e.com/api-reference/update-order-dispatch api-reference/specs/updateorderdispatch.yaml POST /Order/UpdateOrderDispatch This section describes the manifest shipping requirements sent by Merchants to Global‑e via API. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [Dispatch Notifications](/dispatch-notifications-via-api) integration guide — see it for when and how to use this endpoint. # UpdateOrderDispatchV2 Source: https://docs.global-e.com/api-reference/update-order-dispatch-v2 api-reference/specs/updateorderdispatchv2.yaml POST /Order/UpdateOrderDispatchV2 Updates the order status and Delivery Quantities for the products, as well as the Merchant's internal Delivery Reference Number, if applicable. You can also add tracking information on each parcel or on the entire order. Optionally, you can include the list of Parcels with Products for this order shipment to the Global-e hub, exceptions to report on out-of-stock items, and items that will be shipped later on. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [Dispatch Notifications](/dispatch-notifications-via-api) integration guide — see it for when and how to use this endpoint. # Update Order Products (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/update-order-products api-reference/specs/updateorderproducts.yaml POST /Order/UpdateOrderProducts The UpdateOrderProducts API lets you update the order product's metadata and country of origin after the order has been created. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. ## Error Codes When providing an invalid or non-existent value, the Global-e returns an "ErrorInfo" with an appropriate error message. | Code | Error Message | Description | | - | - | - | | D001 | `Orderid %OrderId% not found.` | The provided order ID does not exist | | D002 | `CartItemId %CartItemId% not found` | The provided cart item ID does not exist in this order | | D003 | `ProductCode %ProductCode% not found` | The provided product code does not exist in this order | | D004 | `OriginCountryCode %OriginCountryCode% is invalid` | The provided origin country code does not exist in the system | | D005 | `ProductMetaData %key% cannot have an empty value` | The provided value for product meta-data is empty or null | # Update Order Shipping Info (Global-e to Merchant) Source: https://docs.global-e.com/api-reference/update-order-shipping-info api-reference/specs/updateordershippinginfo.yaml POST /order-shipping-info-update-only-url Updates the order's international shipping information on the Merchant site. Only order.OrderId and order.InternationalDetails members are mandatory for this method. # Update Order Status Source: https://docs.global-e.com/api-reference/update-order-status api-reference/specs/updateorderstatus.yaml POST /Order/UpdateOrderStatus The UpdateOrderStatus API lets you cancel an order with a reason (and notify the customer accordingly) or move an order to a processing status (used by Global‑e or specific cases not covered in this guide). This guide focuses on cancelling orders prior to dispatch. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [Order Status Updates (Merchant to Global-e)](/order-status-updates--m-to-ge-) integration guide — see it for when and how to use this endpoint. # Update Order Status (Global-e to Merchant) Source: https://docs.global-e.com/api-reference/update-order-status-from-globale api-reference/specs/updateorderstatusfromglobale.yaml POST /order-status-update-url Global-e posts the order status to a merchant-hosted endpoint via the UpdateOrderStatus API. > [!NOTE] > > Part of the [Order Status Updates (Global-e to Merchant)](/order-status-updates--ge-to-m-) integration guide — see it for when and how to use this endpoint. # Update Parcel Dispatch Source: https://docs.global-e.com/api-reference/update-parcel-dispatch api-reference/specs/updateparceldispatch.yaml POST /UpdateParcelDispatch The Update Parcel Dispatch API pushes to the merchant Global-e updated Parcel Dispatch Information. > [!NOTE] > > Part of the [Dispatch Notifications (Global-e to Merchant)](/dispatch-notifications--from-global-e-) integration guide — see it for when and how to use this endpoint. # Update parcel status (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/update-parcel-status api-reference/specs/updateparcelstatus.yaml POST /orders/{orderId}/parcels/{parcelCode}/statuses Notify Global-e of a parcel's status change. The notification is handled asynchronously until the new parcel status is successfully updated. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. The update status request is issued by the merchant to notify of a parcel's status change. The notification is received by Global-e and handled **asynchronously** until the new parcel status is successfully updated. In case of a failure to update, the merchant will not be asked to retry. > [!NOTE] > > If the status update to the new status requested by the merchant is not allowed, or if the parcel has not yet been created, manual intervention by Global-e will be required. ## Prerequisites When using this call for the Buy-Online-Pick-In-Store (BOPIS) procedure, the `UpdateParcelStatus` call is initiated by the merchant following the issue of the `UpdateOrderDispatchV2` call. ## Error codes The following error code may be returned in the response. | # | Code | Error Message | Description | | - | - | - | - | | 1 | B001 | Order ID not found | The Order ID provided by the merchant does not exist. | # Update RMA (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/update-rma api-reference/specs/updaterma.yaml POST /Return/UpdateRMA Set or update the merchant's own RMA number (MerchantRMANumber) for a return and send the RMA email to the customer. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Call the UpdateRMA API to set or update the `MerchantRMANumber` and send an email to the customer. ## Overview Use the **UpdateRMA** endpoint to set or update the **Return Merchandise Authorization (RMA)** number on an existing return, then trigger the RMA confirmation email to the shopper. Send the merchant's own return authorization number in the `MerchantRMANumber` field and Global-e stores it against the order. Identify the return by `OrderId` or `MerchantOrderId`, and optionally include Global-e's own `RMANumber`. This is the API behind the **UpdateRMA** step of the SFCC `GlobaleOrderNotifications` job, letting merchants push a return authorization number from their returns or OMS platform back to Global-e for customer-facing return communications. # Update a subscription (Subscription Manager to Global-e) Source: https://docs.global-e.com/api-reference/update-subscription api-reference/specs/updatesubscription.yaml PATCH /subscriptions/{subscriptionId} Subscription Manager calls Global-e to patch an existing subscription. Only the fields present in the request body are updated. Currently the only patchable field is the shipping address; its country cannot be changed (same country only). > [!NOTE] > > Part of the [Subscription Connector](/subscription-connector) integration guide — see it for when and how to use this endpoint. # Upload shipment documents (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/upload-shipment-documents api-reference/specs/uploadshipmentdocuments.yaml POST /api/shipments/documents/upload Attach a customs document — the EAD and its MRN reference — to a shipment Global-e has already created, before the parcel is dispatched. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > This API is enabled per merchant account by Global-e. If it is not enabled for your account, the request returns `403 Forbidden` with no response body. > [!NOTE] > > **Typical integration sequence.** These APIs may be used together when an export declaration or bonded reporting is required, but they are **independent endpoints** — none is a prerequisite for another. > > 1. [Get shipping documents](/api-reference/get-shipping-documents) — obtain the label and tracking number > 2. [Submit bonded information](/api-reference/submit-bonded-information) — report bonded vs free-circulation status per product *(when bonded reporting is required)* > 3. [Get shipment information](/api-reference/get-shipment-information) — retrieve product, pricing and declaration header data *(when you need the data Global-e holds)* > 4. Create the export document — your side, not a Global-e API > 5. **Upload shipment documents** — upload the document and its reference to Global-e *(when a document must be attached)* > 6. [Dispatch orders](/api-reference/dispatch-orders) — End of Day > > Only steps 1 and 6 are universal. Steps 2 to 5 depend on the shipment type, the destination and your configuration. Where they apply, complete steps 2 and 5 **before End of Day / Dispatch orders**. > [!NOTE] > > An export declaration is required only when the shipment leaves the EU customs territory **and** either contains bonded goods or contains free-circulation goods with a total value of €1,000 or more. When no declaration is required, steps 3 to 5 do not apply. > [!WARNING] > > A successful response means Global-e has stored the document against the shipment. Global-e forwards the document and its reference to the carrier asynchronously afterwards, so a success response is not a confirmation that the carrier has accepted it. # Validate gift card Source: https://docs.global-e.com/api-reference/validate-gift-card api-reference/specs/giftcards.yaml POST /ValidateGiftCard Use the Validate Gift Card API call to send gift card data to the platform. In return, the Platform sends the card amount and approves that the card is valid. > [!NOTE] > > Part of the [Gift Cards](/gift-cards-281937) integration guide — see it for when and how to use this endpoint. # Validate Stock (Global-e to Merchant) Source: https://docs.global-e.com/api-reference/validate-stock api-reference/specs/validatestock.yaml POST /checkout-validate-cart-stock-url The Merchant Cart Validation checks basic cart validity and validates the product's stock availability. > [!NOTE] > > This API is part of Global-e's extensions and plug-ins. Merchants do not need to implement this API unless a custom integration is required. If a product line cart item listed in `order.Products` does not have full stock availability for the specified quantity, this cart item is included in the `AmendedProducts` array with an indication of the quantity actually available. If all items are in stock, the `AmendedProducts` array is empty. If required, the `ValidateStock` API is called when the shopper is in the Global‑e checkout. If the `AmendedProducts` array is not empty, the list of out-of-stock products is displayed to the shopper. > [!NOTE] > > In the Global-e Module integration method, the `GetCheckoutCartInfo` API may be reused for stock validation purposes. # ValidateVoucher (Global-e to Merchant) Source: https://docs.global-e.com/api-reference/validate-voucher api-reference/specs/validatevoucher.yaml POST /checkout-validate-cart-voucher-url This API returns new CartToken in the CartToken attribute. The API call is used to help validate vouchers/coupons used on the Checkout page. > [!NOTE] > > This API is part of Global-e's extensions and plug-ins. Merchants do not need to implement this API unless a custom integration is required. This API returns new `CartToken` in the `CartToken` attribute. The API call is used to help validate vouchers/coupons used on the Checkout page. If the voucher is valid, the merchant's platform is responsible for applying this voucher to the shopper's basket and executing a new SendCart / SendCartV2 API call to Global‑e, with an indication of the newly generated discount for this voucher or coupon. The new `CartToken` returned from this call is returned in the `CartToken` attribute. # VAT Category Countries (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/vat-category-countries api-reference/specs/vatcategorycountries.yaml POST /Browsing/VATCategoryCountryS Returns the list of VATCategoryCountry objects for a set of specified VAT categories. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. Returns the list of VATCategoryCountry objects for the list of VAT categories specified. # Void parcel (Merchant to Global-e) Source: https://docs.global-e.com/api-reference/void-parcel api-reference/specs/voidparcel.yaml POST /Parcel/VoidParcel The Void Parcel API lets you take out a declared parcel if you do not intend to send it or if it needs to be updated due to changed shipment requirements. > [!WARNING] > > Make sure your integration follows the latest [authentication](/api-authentication) and [IP whitelisting](/api-authentication#ip-whitelisting) guidelines. > [!NOTE] > > Part of the [Cancelling Declared Parcels](/shipping---void-parcel) integration guide — see it for when and how to use this endpoint. # Apple Pay Express Source: https://docs.global-e.com/apple-pay-express ## Introduction Apple Pay Express streamlines the checkout process, allowing shoppers to pay and complete their purchases quickly and securely. ## How it Works When shoppers click the Apple Pay Express button on the checkout page, they are redirected to the Apple Pay wallet widget. Here, they confirm or update their billing and shipping addresses, and contact details, and view the total amount, including shipping and taxes. **Note**: There are limitations in using this payment method: * **Shipping Options:** "Pick from store"/ “Store Collection” is not supported. * **Additional Requirements:** If additional consent or ID information is required on the Checkout page, Apple Pay Express will not be available as this data cannot be collected from the wallet widget. ## The Customer Journey **The User Flow** | 1. Select Apple Pay Express from Checkout page. | 2. Confirm Apple Pay. | 3. Enter / Select your payment method and shipping address. | 4. That’s it! Your order is confirmed. | | - | - | - | - | | ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c7a4d813-371b-741e-b3ed-56cd3304e67c.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=41987905db297390d32280ed28765d02) | ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a9672203-a6b2-2bca-a39e-0fbc8389c02a.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=9d6fe8d16cb1c2804c909c33e1a7d1c7) | ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-75b9b999-75da-a4ac-1be9-994081eeba2a.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=73c8b89b86cb7812969bc7b2732ccda6) | ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a0c6daa4-19db-99df-c0bf-2a96987e172b.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=366e6d72a02b11da9d206bc247555d9e) | ## Supported Regions The **Apple Pay Express** payment method is supported in the following countries: > [card] > > * Armenia > * Australia > * Austria > * Azerbaijan > * Belarus > * Belgium > * Bulgaria > * Canada > * Croatia > * Cyprus > * Czech Republic > * Denmark > * Estonia > * Faroe Islands > * Finland > * France > * Georgia > [card] > > * Germany > * Greece > * Greenland > * Hungary > * Iceland > * Ireland > * Isle of Man > * Italy > * Kazakhstan > * Latvia > * Liechtenstein > * Lithuania > * Luxembourg > * Malta > * Moldova > * Monaco > * Montenegro > [card] > > * Netherlands > * New Zealand > * Norway > * Poland > * Portugal > * Romania > * Sam Marino > * Serbia > * Slovakia > * Slovenia > * Spain > * Sweden > * Switzerland > * Ukraine > * United Kingdom > * United States > * Vatican City > [!NOTE] > > Apple Pay Express is available only in countries with Latin alphabet characters. # AUS Merchants with Non-Global-e Carriers Source: https://docs.global-e.com/aus-merchants-with-non-global-e-carriers > [card] > > ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ec273f9d-6924-c7f0-5703-76d4e892ca90.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=b01b12034c82ddd84c7fd7011eb072c0) > [card] When an international customer visits your site, Global‑e converts the price of your product to the customer's currency. At checkout, the customer is presented with the financial details of the transaction: * The price of the product minus discounts * Shipping * Duties and taxes After verifying the validity of the transaction, Global‑e collects the payment and the order is packed and shipped. * If you are shipping the products directly from your hub then the final title transfer takes place in the origin country, making this a domestic B2B sale. * If you are shipping from a Global-e hub, the final title transfer occurs when the goods arrive at the domestic Global-e hub. Global‑ then converts the amount of the sale back to your currency and refunds you the amount of the sale, deducting relevant fees and subsidies. If you are using your own carriers then the shipping fee, plus duties and taxes (if paid for by the carrier), are included in the refund. ## Duties and Taxes Process Below is an example of the financial process that takes place when a customer purchases from a Merchant in Australia. **Australian Merchant – Global-e Australia** Deduct Australian GST * Product price in AUD = $110 ($100 + 10% GST) - exported from Australia * Shipping charged to customer: \$5 ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-4473beb2-3a4b-d0c2-2cdd-1ebdcfe5c5e3.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=82055d29b9d28b511e684b7a38b80be3) Net product sale for Merchant: \$100 Net after shipping subsidy: \$95 ## Billing Period and Payment Terms The reconciliation process typically takes place on a weekly basis and results in a comprehensive report of all Merchant sales for the week. Based on the report, Global-e pays the Merchant the sum of all products sold internationally during that week plus any relevant shipping, duties, and taxes, minus the agreed service fee. Global-e's standard payment terms state that 100% of the net proceeds are paid weekly, up to two business days after the weekly reporting day. Global-e's standard payment terms: * 90% of the net proceeds are paid weekly, up to two business days from receipt of the invoice. * 10% of net proceeds are paid monthly, up to seven days from the end of the month. ## Invoicing When the Reconciliation Report is generated, Global-e also provides Merchants with two invoices: * A self-billing invoice for sales-less refunds. * An invoice for Global-e’s services, fees, and any shipping subsidies. To view the invoice navigate to the Global-e Merchant Portal > Merchants > Reports > Reconciliation Reports. **Global-e’s Invoice for Services and Fee** ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-6eb8609b-10a5-43c0-4b28-8fbc3a2a5a2e.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=b751b260820947466caba43dead20bbb) **Merchant’s Invoice for Net Sales** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-479d6d79-9a55-ff32-4b22-e6ef72ff5b9a.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=3bd5a35dfc6d880e4118e50b0e41c368) ## Global‑e Purchase Examples The following two purchase examples offer a detailed look at the price conversion process. There are two types of price conversions: * **Dynamic pricing** - Global-e converts the customer currency on the website for the Merchant. * **Fixed pricing** - The Merchant gives Global-e the customer's price in the customer's currency and that information is fed into the website. **Australian Merchant – Japanese Customer** Example of dynamic pricing ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c9135e1c-905b-d5fe-717e-eb5acbae5f20.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=3f5d180a45bc40c079d74aa6e9fffb70) **Australian Merchant – UK Customer** Example of dynamic pricing ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-27e4c128-ac72-4813-dcf6-3f509e1a4df3.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=34f93dc92f43498ee3478186cbb5dc80) **Australian Merchant – US Customer** Example of fixed pricing ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-63fd1387-db7d-396c-2739-a0c9358d8757.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=98d45e3f39a68f889a3ecdfac75942d2) ## Reconciliation Report Example- AUS Merchants with Non-Global-e Carriers Below is a sample Reconciliation Report with a breakdown of the services and fees for that week. For a list of all the report fields and their definitions, see [Reconciliation Report](/reconciliation-report-overview). For a video describing the Reconciliation Report, see [Video Overviews: Financial Flow & Weekly Reconciliation Report](/video-overviews-financial-flow-au). | | Amount GST | GST | Amount Inc GST | | | - | - | - | - | - | | Sales Total | \$23528.85 | \$2352.89 | \$25881.74 | [Sales Example](/aus-merchants-with-non-global-e-carriers#sales-total) | | Refunds Total | (\$2106.68) | (\$210.67) | (\$2317.35) | [Refunds Example](/aus-merchants-with-non-global-e-carriers#refunds-total) | | **Amount to Invoice** | **\$21422.17** | **\$2142.22** | **\$23564.39** | | | Service Fee | \$1724.12 | \$172.41 | \$1896.53 | 7.0% of Sales Total | | Service Fee Adjustment | \$0.00 | £0.00 | \$0.00 | | | Shipping Subsidies | (\$729.95) | (\$73.00) | (\$802.95) | [Shipping Example](/aus-merchants-with-non-global-e-carriers#shipping-subsidies) | | Taxes Subsidization | (\$371.49) | \$0.00 | (\$371.49) | | | Handling Fee | \$0.00 | \$0.00 | \$0.00 | | | Returns | \$14.97 | \$1.50 | \$16.47 | [Returns Example](/aus-merchants-with-non-global-e-carriers#returns) | | **Services and Fees** | **\$607.71** | **\$97.91** | **\$705.62** | | ### Sales Total **Order Level** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8055631c-6784-9694-1a46-6b4b5deb1277.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=e58d8b152c0d96f013517d7b2eee241d) *Sales Total on the Order Level* **Product Level** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-45681d01-bd95-88f8-8a91-a4015eb83f8a.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=1be61bd8b24d7f88a06be1b3d18e8169) *Sales total on the Product Level* ### Refunds Total ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8e3f4862-8bdd-de90-b8c3-889781e2033e.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=5b25f3000ba3d6255d9acd2807bf922e) Lists all the refunds that were issued through Global‑e during the relevant period ### Shipping Subsidies Shipping prices are based on the actual weight that we received from the shipper or measured at our hub. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4d2681d9-bced-ae9f-66d1-9de10cf606f7.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=acc2911aab96eacdd5a41be998d8ad6d) *shipping costs are reconciled based on the date of the shipment* ### Returns ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-dbd30617-2b13-e2e3-3364-73e6835dc0f1.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=2915affa7d985a178cb7a69643851f1a) *Includes the details of each returned parcel* ## Video Overviews: Financial Flow & Weekly Reconciliation Report ### Financial Flow An overview of the financial flow and reconciliation process [Embedded media](https://www.youtube.com/embed/MM5OiAxXTe4) ### Weekly Reconciliation Report A walk-through of the weekly reconciliation report [Embedded media](https://www.youtube.com/embed/bLmOavYc_Eo?si=GAwso9l3GSur_FcD) # Authenticating Notifications Source: https://docs.global-e.com/authenticating-notifications Global-e sends notifications to merchants or platforms, upon completion of asynchronous operations, detected errors, and other cases. To secure the notifications issued by Global-e to merchants and ensure that only the addressee receiving can read them, Global-e uses the JWT authorization method. Each API call from Global-e to the merchant URL will also include the authorization token in the header. Global-e provides the merchants with a public key. Private and public keys are used to encrypt and decrypt the data. The private key is kept on the Global-e side, and the public key is shared with the Platform side to receive the notifications. The same public key is used for all merchants. **Merchants authenticating Global-e calls with JWT (Global-e > Merchant calls)** 1. Global-e provides a public key to the merchant. See below. 2. The global-e integration engineer enables the MAS `JWTAuthEnabled`parameter to be TRUE for all endpoints. 3. The merchant sets authentication by issuing API calls using the authenticating token provided as input and encrypted format. **Global-e Public Keys** Global-e provides two public keys for merchants: One for the test environment and one for production. All merchants use the same public keys. The following are the public keys: * Public key in test environments - used for STAGING, QA, and QA-INT environment ``` -----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAujqbO2V/DFfpdcvDV6vP iRc6UE4wPHGa85OiELnNnmXVQmncE+NJsTugRqDWpxmQU7wrMRP0cQ2SHRWCx7Qq lW1Mcp/t/t6aktb06fCh3K7X9zMpwwjNHOaeim6vTDdhbx+orVU57lK2AE7NHjiD pNfF7ovojCtdHZwDdP0ExOxl5zCPF86s8u7Y1rci7W5iULwkSGmdu/Bz5k5YKgOA hUY+OzWny21Ue9CyTNOgiDfJEbmWM+z5YZOQdII9oDYJ9xd3u46Lfujp8QK3IUxB NgsAoVtOyVL10l5JjEjgK1L1TXXFlFuoeN+NAGNKmmBlCZfinTBGnpluGaSFkk8+ ZwIDAQAB  -----END PUBLIC KEY-----  ``` * Production Public Key ``` -----BEGIN PUBLIC KEY-----  MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvC4ttxBBCcR4v3uxR7QQ 3BsUU09GJZPg9SEQrB/DGoEdKcMNY2v1QUE0VKsqMk+YYRd7cS2WrENN8RPlQyye gudZGk39WgeZC2lEP76aT/pMwDpPCdXAhwEyd5p73aM/EZYkdIhdCVMf1YbGHWBh NbIRb0ZVOrN1Wvmitnuzej7ZNbMwuA3OMB4piYq2vPynhrJ9v4AdFjFaKLQp72Ql YSuL+5YxSuqVr1xHo9FODGxAu5rz3h/1imDW61aF1lskIy54HFnvsu1hEFeOYcZP cfDU4cFLCnfQy0YJMsy6bugMJ3e7pddh+2B1JysvGhHvWzL2FkTDVfA5bMpPMSay 1QIDAQAB -----END PUBLIC KEY-------  ``` > [!NOTE] > > This authentication is currently supported only for SFCC. # Authenticating the Checkout Page Source: https://docs.global-e.com/authenticating-the-checkout-page The authentication will be done on the platform side and a token will be sent via `SendCart` when the checkout loads. Upon confirmation on the checkout page, the merchant/platform sends Global-e the purchase data, in `SendCart`, for further processing. The merchant sends his JWT token for Global-e to validate the message. Two parameters are added to the calls: * AuthToken * SessionId The parameter contains the session token received from the authentication against the merchant’s platform. **Examples** Add the parameters to the API body parameters of the SendCart object: **SendCart** ``` { "CartToken": null, "SessionId": "123456", "AuthToken": "34sdfdg43erfg43234fwsedfsdf423" "ClientIP": "2a02:c7f:b57e:8400:51f:5fa6:3151:95a7", "CountryCode": "GB", "Culture": { "CultureCode": "en-GB", "InputDataCultureCode": null, "PreferedCultureCode": null }, "Currency": { "CurrencyCode": "GBP", "OriginalCurrencyCode": "USD" }, "Discounts": [], "FreeShipping": null, "HubId": null, "LocalShippingOptions": [{ ``` **Request** ``` { "MerchantGUID":"", "ShippingCountryCode":"GB", "CardFields":{ "CardId":"64E3E449D5GD8G29" }, "MerchantCartToken":"11492df0a8bfe29f5a748c4a1db80cff", "CustomerId":null, "CustomerEmail":"test@gmail.com", "WebStoreCode":"Official Ripndip - Apparel, Accessories, Skate, & Lord Nermal ", "WebStoreInstanceCode":"GlobalEDefaultStoreInstance", "CartToken":"9d14ef15-d463-4480-82c2-806d1ec7b559" “AuthToken”:”34sdfdg43erfg43234fwsedfsdf423”, “SessionId”:”12345”, } ``` **Response** ``` { "IsValid":true, "Balance":"42.21", "CurrencyCode":"USD", "IsGlobalEGiftCard":false, "ErrorCode":null, "Message":"Success", "Description":null, "Success":true, "ErrorText":null } ``` > [!NOTE] > > This authentication is currently supported only for SFCC. # Authentication Source: https://docs.global-e.com/authentication When initiating calls to the Global-e APIs, ensure that each API request is authenticated using the appropriate authentication method supported by Global-e, as documented in this section. **In this section:** * [API Authentication](/api-authentication) * [Authenticating Notifications](/authenticating-notifications) * [Authenticating the Checkout Page](/authenticating-the-checkout-page) # B2B Checkout Source: https://docs.global-e.com/b2b-checkout Global-e supports excluding merchants' B2B customers’ purchases in Global-e operated countries, by routing them to Shopify Payment. These orders are not handled by Global-e. This feature must be enabled, if necessary, by the Global-e team. Please reach out to your Customer Success Manager to set it up if necessary. > [!NOTE] > > The merchant must define Shipping rates for B2B customers, for Global-e operated countries. If no rates are defined, no shipping options will be displayed, and the checkout process will not be completed. ## Prerequisites To support B2B customers in Global-e operated countries, the merchant should set the following in Shopify Backoffice: 1. Verify that your store is configured for Shopify B2B customer support. Define the Shipping option rate, under the Global-e zone. 1. In **Shopify Backoffice > Shipping and Delivery > General Shipping Rates**. 2. Select **Global-e Shipping Rates**. 3. Add Shipping Rates: 1. Under Global-e Zone, on the Shipping Options page, click on **Add rate**. 2. Add your B2B shipping rate in the following steps: 1. Click **Use flat rate**. 2. Change **Shipping Rate** to **custom**. 3. Define the Rate name. 4. Define the Price. 5. Click **Done**. * The defined rate will be listed under the Global-e Zone. ## The Process When a customer purchases on a Shopify Plus plan, in a Global-e-operated country, the system verifies whether it is a B2B customer. If it is defined as B2B, all Global-e experience is removed (logo, disclaimer, etc.), and the Checkout page displays only two fields: * **Delivery method:** Only the B2B shipping rate configured in Shopify under the Global-e zone is available, with its rates. * **Payment method:** Only payment methods offered by Shopify are listed. > [!WARNING] > > The Global-e **logo** and the **disclaimer** are removed from the Checkout page. # Bank Transfer Source: https://docs.global-e.com/bank-transfer Bank Transfer is an offline payment method that allows customers to pay for online orders by transferring funds directly from their bank account. ## Automatic Order Cancellation Timeframe * Shopify merchants – 6 days * Global-e Embedded merchants – 7 days ## Supported Countries * Andorra * United Arab Emirates * American Samoa * Austria * Australia * Aland Islands * Belgium * Bulgaria * Bahrain * Brunei Darussalam * Bouvet Island * Belarus * Canada * Cocos (Keeling) Islands * Cook Islands * Christmas Island * Cyprus * Czech Republic * Denmark * Ecuador * Estonia * Western Sahara * Spain * Germany * Micronesia * Faroe Islands * France * France, Metropolitan * French Guiana * Guernsey * Gibraltar * Greenland * Guadeloupe * Greece * South Georgia and South Sandwich Islands * Israel * Italy * Hong Kong * Heard and McDonald Islands * Croatia * Ireland (Republic of) * Isle of Man * British Indian Ocean Territory * Jersey * Jordan * Japan * Kenya * Kiribati * Kuwait * Kazakhstan * Liechtenstein * Lithuania * Luxembourg * Latvia * Morocco * Monaco * Montenegro * Marshall Islands * Northern Mariana Islands * Martinique * Mauritania * Malta * Mauritius * Mexico * Malaysia * Romania * Russia * Norfolk Island * Nigeria * Netherlands * Norway * Nauru * Niue * New Zealand * Oman * Panama * Peru * Poland * St. Pierre and Miquelon * Pitcairn * Puerto Rico * Portugal * Palau * Qatar * Reunion * Switzerland * Saudi Arabia * Sweden * Singapore * Slovenia * Svalbard & Jan Mayen Islands * Slovak Republic * San Marino * El Salvador * Turks and Caicos Islands * United Kingdom * French Southern Territories * Thailand * Tokelau * Tunisia * East Timor * Turkey * Tuvalu * US Minor Outlying Islands * United States * Vatican City State (Holy See) * British Virgin Islands * Virgin Islands (U.S.) * Mayotte * South Africa * Zambia * Finland * Guam * St Martin * St Barthelemy * Bonaire, Saint Eustatius and Saba ## Customer Flow 1. After completing their personal details on the checkout page, the customer selects Bank Transfer as the payment method. ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/4372fd9f-5fd7-492b-8b61-42b696ca141f-4f3feb.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=5b96bfaeaa2ab374ffcc8858c6a36349) 2. The customer is redirected to the order confirmation page, which displays the bank transfer account details required to complete the payment (for both Global-e Embedded and Shopify integrations). The customer is also informed that they will shortly receive an email with the same details. 3. The customer receives an email containing the bank transfer details, including: * SWIFT / BIC * IBAN * Beneficiary name * Transfer amount and payment reference 4. The company's Finance team performs daily monitoring of completed bank transfers. Once the transfer is confirmed, the team advances the order status. * The order will remain in **Pending Payment** status until the customer completes the payment. If the payment is not completed within the allowed time frame, the order will be cancelled automatically. * Once the customer successfully completes the payment, the order status will be updated. The examples below show the order confirmation page with bank account details for Global-e Embedded and Shopify integrations, and the Shopify confirmation email. ### Global-e embedded — confirmation page ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/641cb937-fc44-4c9d-8be3-956ebebad76a-ad565c.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=8298e5db3d77d4b36260d2b6fb15c427) ### Shopify — confirmation page ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/26c11260-68ef-4ece-a4ef-2b4eb8f5ed58-49ee67.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=47e918d3194c495736cc1b92748f56ee) ### Shopify — confirmation email ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/f49c8067-5f57-469d-a59e-cfd02d678a2d-3267a8.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=6c15c242a60419e4aabcbaa1276e33ab) # Base Global‑e Script Source: https://docs.global-e.com/base-global-e-script > [!WARNING] > > 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: ``` https:///merchant/clientsdk/?v= ``` To load our base script, you should use a self-invoking function: (\, \, \ + \, "script", "gle", \, \) **Production Example:** ``` (window, document, "https://web.global-e.com" + "/merchant/clientsdk/124125?v=2.1.5", "script", "gle", "2.1.5", 124125) ``` **Code Sample** ``` ``` **Script Parameters** | Parameter | Description | | - | - | | `sDomain` | Production: [https://web.global-e.com](https://web.global-e.com) Integration: [https://www.bglobale.com](https://www.bglobale.com) Staging: [https://www2.bglobale.com](https://www2.bglobale.com) | | `window` | The JavaScript window object | | `document` | The JavaScript document object | | `clientJsURL` | Local file path or direct to Global‑e servers`/merchant/clientsdk/?v=` | | `ScriptVersion` | The version of Global-e server API. Currently 2.1.5. | | `merchantId` | The 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. > [!NOTE] > > This list is subject to modifications and limitations that may affect the availability of payment methods on the checkout page. # Bespoke Global-e Module Source: https://docs.global-e.com/bespoke-global-e-module Global‑e provides online merchants with a complete end-to-end localization solution, enabling users from more than 200 countries to view prices in their local currency, pre-pay taxes and duties, select from a multitude of shipping options, and checkout using their preferred payment method. For the merchant, Global‑e transforms all cross-border transactions into risk-free domestic ones, thereby enabling the merchant to serve its global clientele using its existing domestic Translation: fulfilment capabilities and business processes. Global‑e provides its solutions in a “white-label” form, through the merchant’s existing customer-facing storefront. The solution is based on a lightweight code snippet that is placed on the merchant’s webstore. This script identifies international customers (based on their IP address) and Translation: localises the webstore on the fly with Global-e’s offerings, e.g. over 60 supported currencies for browsing and checkout, an auto-generated themed country and currency switcher, a themed and customizable “welcome popup,” and more. For countries selected by the merchant to be operated via Global‑e’s scalable cloud-based solution, the Global-e Module overwrites the pricing displayed throughout the webstore according to a set of rules mandated by Global‑e’s services and merchant-specific configurations, including currency exchange rates, country coefficients and, for EU-based merchants, also VAT handling (including EU distance selling compliance and handling of products having reduced/zero local VAT). The list of serviced countries, pricing and price-rounding rules, and many other aspects of the system's behaviour are configured based on the merchant’s specific needs and preferences. Domestic users continue to interact with the original merchant’s site, as do customers from countries that have not been selected by the merchant to be operated by Global‑e. This document describes the technical outline of the solution and highlights the steps needed to integrate the Global-e Module into an existing webstore. **Note:** In this documentation, the names "Bespoke Global-e Module" and "Global-e Module" are used interchangeably. **In this section:** * [Integration Summary](/integration-summary-bespoke-module) * [Catalog Management](/catalog-management) * [Storefront Implementation](/storefront-implementation) * [Order Placement Flow via API](/orders---placement-history#order-placement-flow-via-api) * [Order History](/orders---placement-history#order-history) * [Storefront Attributes](/storefront-attributes) * [Client Side Events](/client-side-events) * [Sale Prices and Discounts](/discounts) * [Endpoints: Merchant APIs](/integration-summary-bespoke-module) # BigCommerce Source: https://docs.global-e.com/bigcommerce-all This document provides a comprehensive guide to the Global-e solution for BigCommerce, detailing its features, functionalities, and integration process. For features and functionality supported across Bespoke-based platforms, and Global-e offerings, see [Cross-Platform Information](/cross-platform-information). **In this section:** * [Installation](/installation-bigcommerce) * [Configuration](/configuration-bigcommerce) # Billing and Order Summary Source: https://docs.global-e.com/billing-and-order-summary ## Product Bundles The **Bundles** feature lets merchants sell multiple individual items together as a single bundled product. This functionality is ideal for promoting related products or offering customers a convenient way to purchase complementary items in one streamlined experience. During the customer journey, a bundle is treated as a single product, from product display through checkout and post-purchase, simplifying the buying process. After order confirmation, however, each child product remains individually manageable. This flexibility enables seamless handling of refunds, replacements, or returns for specific items within a bundle without impacting the entire purchase. Bundles appear as a single product throughout checkout, reducing complexity for customers. Pricing, including discounts, is automatically distributed across child products either proportionally based on their value or evenly when child products are zero-priced. For **merchants**, managing child products individually reduces operational complexity while preserving clear pricing and flexible post-purchase workflows. Bundle presentation can be tailored to align with branding and business needs, ensuring a cohesive storefront experience. For **customers**, bundles offer clear pricing and a simplified purchasing flow. After purchase, individual items within the bundle remain visible for operational actions such as returns or replacements, ensuring transparency and convenience. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-15960e1a-591d-daf5-476b-05dfab61025c.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=5c9148d5285e0af8ac49434a569a59a9) **Bundle types** There are two types of bundles: * **Convenience Bundle:** This bundle aggregates multiple products under one product for quick and easy customer selection. * **Discount Bundle**: This bundle is a collection of multiple products under one discounted product. **To create a product bundle** 1. In the Merchant Dashboard select **Product Management** > **Product Bundle Mapping**.The Products Bundle Mapping page is displayed. 2. At the top right click **File Format Example** to download the template file. 3. Fill in the product details: * **BundleSKU** Holds the parent SKU as it exists on the products table. * **ChildSKU** Holds the child SKU as it should be passed by the merchant in the GSD request. * **Quantity** Holds the quantity of the child SKU items for this bundle. The following figure shows the product details that you must fill out: ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7b7e7fd9-0eec-d73e-1ed9-f0e291e0514b.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=a6b5ee5e797aa147b041da88171ec2a0) 4. Upload the file and import the mapping file into the Admin. After the file is uploaded successfully the table with all the records appears at the bottom of the page. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1daf480c-e1d1-ed41-6bfc-8ece95e1b18e.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=a8a02ca16a14e3ab53789069f3797347) The table displays all mapped bundles with a link to the product page (if it exists), the product name, the date of bundle mapping creation date, and the child SKUs with quantities. **Bundle Display Options** Merchants can customize how bundles are displayed during checkout, on confirmation pages, and in customer emails. Bundles can appear as: * A single product (only parent display) * A detailed list showing each individual item within the bundle (parent and child display) The following figure shows a single product (only parent display) example: ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-48098467-0030-c50e-928b-60df0697a5cd.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=f54859af11cd90329ecb6d163696359c) The following figure shows a detailed listing example, which displays the details related to each item in the bundle (parent and child display): ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-38c13799-3887-291b-ee64-eb5cfcbb1030.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=4d8279e3118d4ae9d0442a48c9e06587) **Possible Configurations** * **Parent-Child Display Options**: * **Show Parent and Child Products** in checkout and confirmation emails. * **Display Parent Product Only** in checkout, confirmation emails, and subsequent customer-facing touchpoints * **Pricing Distribution**: * If child products are zero-priced: The parent product's price is evenly distributed among child products. * If child products are priced: The parent product's price (after discounts) is divided proportionally based on the child products' relative prices. * **Merchant Configurations** (Global-e enables these for you on request): * Dynamic price distribution, with bundle-related data stored separately. * Hiding child products in the checkout and initial confirmation emails, while still showing them in dispatch and post-purchase emails. **Checkout & Confirmation Page Display** Bundles are presented as a single product with the total price displayed. Customers see a simplified order summary, ensuring clarity. **Email Display** * The **Parent Product** appears in confirmation emails. * The **Child Products** are shown in dispatch and post-purchase emails to aid with order fulfillment and customer service. **Post-Purchase Handling** **Child Product Management**: Each child product can be refunded, returned, or replaced independently. **Flexible Shipment Options**: Bundles can be shipped in multiple parcels as needed. ### Product Bundle Pricing Examples **Zero-Priced Child Products (No Discount)** * Parent Price: `$1004` * Child Products: `$0` each * Post-Purchase Price Per Child: `$25` each **Zero-Priced Child Products (With Discount)** * Parent Price: `$100` * Discount: `$20` * Post-Purchase Price Per Child: `$20` each **Priced Child Products (No Discount)** * Parent Price: `$100` * Child Products: $`$20`, `$30`, `$40`, `\$60\` ***Post-Purchase Price Per Child:*** * Product A: `$13.33` * Product B: `$20` * Product C: `$26.66` * Product D: `$40` **Priced Child Products (With Discount)** * Parent Price: `$100` * Discount: `$20` * Child Products: $`$20`, `$30`, `$40`, `\$60\` ***Post-Purchase Price Per Child:*** * Product A: `$10.66` * Product B: `$16` * Product C: `$21.33` * Product D: `$32` ## Display Savings The Display Savings feature shows customers the price of items after discounts, along with the total discounts applied. This provides greater transparency, improving the customer experience and reducing uncertainty about discounts. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-66380b2a-6c6a-e7b9-55b6-58c3c5b69422.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=e7acd2b1dd9e39e206bca7e64f88b5a8) This feature can be added to different areas of the Checkout page. * Display savings in **Order Summary** ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-06a4e5b3-ad4d-05d4-76f9-c64339950897.jpg?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=758adbdad69467f5fcdf88cf932ae34f) * Display savings in **Billing Summary** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8e1f6891-d671-2ca4-ba46-eca4eef1cbd8.jpg?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=b7543cefeeb9fb2ffc52f9830614e0fe) **Display Savings fields** Two fields are displayed below the Items Total field, based on merchant configuration: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-126df5a4-8fa7-de15-8b73-ba98b4380f71.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=1cd1f80646352d53524e577dca3dd483) * **Items total after discount**: * Shows the total price of items after applying order-level discounts affecting products only (excludes shipping and duties & taxes unless HFDDP). * Includes deductions from both product-level and order-level discounts if applicable. * For optional DDP, once the customer accepts DDP, the price remains unchanged. * **Total discounts**: * Displays the combined total of product-level and cart-level discounts. * Configurable text can be used to display this field. When there are both order level and product level discounts, the field displays the price deducting both types of discounts. Merchants can configure the fields and text. **Display savings in emails** Merchants can also enable the Display Savings feature in emails to provide consistency between the checkout and email experience. When enabled, Order discounts will be prorated on product price ## Display Discounts Merchants can display each discount type as a separate line in the billing summary section of the checkout and customize their labels. Displaying discounts separately enables Merchants to showcase various discount types distinctly within the billing summary of the Global-e Embedded Checkout page. This improves customer understanding of applied discounts and boosts checkout completion rates. By itemizing discounts, customers better understand their savings, reducing confusion. Clearly visible discounts emphasize the savings customers receive, making promotions more impactful. Aligning discount labels with branding enhances the customer experience and supports marketing campaigns. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-79c20c5f-c412-2649-cff4-d46171fc2a0e.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=59ffb990e6731022cbf4727207b03705) Merchants can define and display specific discount types, such as promotions, loyalty points, or special offers, as separate line items. Clear labels are configurable to align with merchant branding and messaging. Merchants can group similar discounts into one line (for example **Special Promotion**) or display them individually for greater detail, with the flexibility to present discounts tailored to customer expectations and business needs. The feature is available for all Merchants using the Global-e Embedded Checkout, requiring minimal setup effort. Customers can see a detailed breakdown of discounts applied to their orders. A detailed billing summary emphasizes the value customers receive. Merchants can use this feature to reinforce promotional campaigns by prominently displaying relevant discounts. Highlighting loyalty rewards and personalized discounts strengthens relationships with repeat customers. During seasonal sales, merchants can display discounts labeled **Holiday Sale** alongside loyalty rewards to emphasize combined savings. Merchants can highlight loyalty points used during checkout as a distinct line, reinforcing the value of their loyalty programs. Merchants can showcase targeted discounts, such as referral bonuses, to emphasize personalized offers. Merchants can activate this feature via [Campaign and Discount Management](/marketing-propositions--main-screen-#campaign-and-discount-management) in the Merchant Portal. Merchants can customize the discount types to display, configure the discount labels, and choose whether to group or itemize discounts. In the image below, there are two discounts listed: * Discounts * Sparks points ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b8222e57-ae87-c8e5-78ef-b40065e5fbd8.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=3172a589af8dd785b0f2d3e8ff52e419) ## Gift Cards Gift cards are purchasable as a virtual product with a stored value. They can be used in payment for products, shipping, and duties. Gift cards support multi-currency and cross-border use, and value conversion between currencies is supported. Validation is performed by API with balance checks. Customers can check their gift card balance directly from the Checkout page and apply a partial or full amount toward their purchase. This promotes transparency, flexibility, and convenience, driving higher sales conversion rates while reducing customer support inquiries. Customers no longer need to guess their gift card balance or abandon the Checkout to confirm it elsewhere. A seamless process for checking balances and applying funds helps ensure higher conversion rates and fewer support issues, leading to a stronger overall checkout experience. Customers have the flexibility to apply a portion of their gift card balance to the current purchase, and the remaining balance can be preserved for future purchases. The order summary dynamically updates to reflect the applied gift card amount and new total. Simplifying gift card application encourages customers to complete their purchases. Customers may spend beyond their gift card balance, combining it with other payment methods. Automating balance checks and partial usage reduces inquiries related to gift cards. Gift card usage is reflected in the invoice as a payment tender. Refunds are supported, and credits can be refunded back to a gift card via API. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-35721d22-64e2-73da-aa1d-6c14191fa8f3.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=c801d45a111ba61d051fc497d94d168b) **To check the card balance** Customers can do this when unsure of available funds in a gift card and want immediate confirmation within the checkout process. Or a customer may wish to apply part of their gift card balance to a large purchase, saving the remainder for another order. 1. In the Gift Card section, the customer clicks **Check Available Balance**. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-ab936362-36dc-ee3b-cf6c-555a9635dc82.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=cbe9550c4c52fa6cde142fff3ab9833e) The gift card is validated and the available balance is displayed. 2. The customer enters the amount they wish to use for their purchase in the **Set amount to use field** and clicks **Apply**. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-48960dbc-d21d-9351-5b16-eb96785f671f.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=3e590cfe6238e3242ea96209614c16b6) ## Coupon Field A Coupon Input Field can be added to the Checkout page, allowing customers to use coupons for their purchases. The Coupon Input Field functionality allows customers to apply Merchant-provided coupon codes directly on the Checkout page. This feature simplifies the discount application process, improving the overall customer experience and driving increased sales conversion rates. Coupons can be applied as cart- or product-level discounts and can be limited to discounts on specific items or carts. Note that coupons are shown in invoices as a discount, which may skew invoices. There is no refund mechanism for coupons. Customers expect quick and hassle-free ways to redeem coupons during checkout. A visible coupon input field reinforces marketing campaigns and encourages higher coupon usage. Transparent validation and immediate feedback build customer confidence in the platform. Easy-to-use coupon functionality streamlines the checkout process. Coupons encourage customers to complete purchases by providing clear savings. Merchants can drive marketing campaigns with coupon-based promotions. The platform automates coupon validation, reducing manual errors and inquiries and provides Merchants with a seamless way to integrate promotions. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-539861c3-5b04-0c59-5085-58d17664b48d.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=51cd4bfe3ef2e2243690cec95fcfa8c4) **Customer Journey** 1. The customer inputs the coupon code in the designated field and clicks “**Apply**”. 2. The system validates the coupon code through the **ValidateCoupon** API. The platform validates the coupon against Merchant-provided data. 3. If the coupon is valid, the Checkout page reloads with the coupon discount applied. The Checkout page displays the updated pricing and discount details. A negative value representing the discount appears in the billing summary. 4. If the coupon is not valid, an error message displays, informing the customer that the coupon could not be validated. A clear error message is provided to guide the customer. **Free Shipping** A free shipping coupon can also be applied, but it is displayed as a free shipping option and not a coupon. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d06d4f0a-80e8-9117-5a2e-aa3eeb4c51b1.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=f2844dd3d620546ac77d90de50dad64a) ## Discounts in Order Summary Merchants can display product prices after discounts in the order summary, creating transparency and improving customer confidence during Checkout. Both product-level and order-level discounts are supported for display. The following discounts displays are supported for the Order Summary: * **Items Total After Discount**: Displays the total price of items after applying product-level and order-level discounts (excluding shipping or D\&T unless HFDDP is applied). * **Total Discounts**: Displays the total amount of cart and product-level discounts applied to the order. These fields are configurable and can include custom text for the labels, as well as dynamic updates depending on the availability of discounts. ## Discounts Configuration The total in the billing summary supports the following variations: * **No Discount**: Displays the standard total. * **Discount Applied**: Displays the pre-discount total with a clear label, for example, **Balance before savings**. Merchants can customize the discount types to display, configure the discount labels, and choose whether to group or itemize discounts. For example, in the image below, there are two discounts listed, discounts and spark points. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b8222e57-ae87-c8e5-78ef-b40065e5fbd8.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=3172a589af8dd785b0f2d3e8ff52e419) ## Payment Method Discounts Merchants can incentivize specific payment methods by offering discounts during the checkout process. This functionality supports marketing campaigns in collaboration with payment providers, ultimately enhancing customer engagement and increasing the usage of preferred payment methods. Discounts can be applied as either coupon-based discounts or automatic discounts, offering flexibility in terms of implementation and user experience. Discounts are configurable according to Merchant, payment method, and country, and support both cart-level and order-level discounts. Payment method discounts offer several benefits to customers. By itemizing discounts, customers better understand their savings, thus reducing confusion. Clearly visible discounts emphasize the savings customers receive, making promotions more impactful. Further, aligning discount labels with branding can enhance the customer experience and support marketing campaigns. Benefits to Merchants include the ability to create campaigns that incentivize customers to use preferred payment methods, increasing payment method usage, as well as reducing cart abandonment by offering financial incentives. Payment method discounts also support dynamic and targeted marketing campaigns tied to specific payment providers. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-eac3da6a-5bba-cbf1-24b7-543e3736194b.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=7369483ea7e8ef1b1d61b7b3e2320449) **Manual Discounts** Customers enter a coupon code at the cart or checkout stage to activate the discount. The discount applies exclusively to purchases made using the designated payment method. The payment method is validated at checkout to ensure eligibility. For credit cards, the Bank Identification Number (BIN) of the card is verified. For alternative payment methods, the platform ensures compliance with the campaign's requirements. **Customer Journey for Manual Discounts** 1. The customer enters the coupon code in the cart or checkout. 2. The platform validates the coupon and applies the discount. 3. If the payment method matches the coupon requirements, the order proceeds. 4. If the payment method does not match coupon requirements, the customer is notified and prompted to either choose a different payment method or remove the coupon and proceed without the discount. **Automatic Discounts** Automatic discounts reduce the need for manual input, making checkout faster and easier. Clear notifications ensure customers understand why discounts are applied or removed. Incentives encourage customers to use preferred payment methods, providing financial benefits. With automatic discounts, the discounts are automatically applied when the customer selects the designated payment method. No manual coupon input is required, simplifying the process. The discount is applied dynamically when the customer selects a qualifying payment method. The platform validates the payment method and updates the checkout elements (order summary, billing summary, etc.). A notification informs the customer that the discount has been successfully applied. **Customer Journey for Automatic Discounts** 1. The customer chooses the eligible payment method during checkout. 2. The platform validates the payment method and applies the discount automatically. 3. Checkout elements dynamically refresh to reflect the applied discount. 4. If the customer switches to a non-eligible payment method, the discount is removed, and a notification is displayed. **Billing Summary Display** Payment method discounts are displayed as a distinct line in the Billing Summary for the applied discount. The discount can be labelled with customizable text resources per campaign, such as **VISA Discount Applied**. **Error Notifications** If customers attempt to use a payment method that is not eligible for this discount, the platform provides an error notification to inform customers. The platform will prompt customers to select an eligible payment method or remove the discount. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9e117de2-af33-0a0b-fc38-8cd0c7436d8d.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=340fc656838bd36f40b48928d617d331) **Dynamic Updates** Checkout elements refresh dynamically when discounts are applied or removed, preserving user inputs. ## Business-to-Business VAT Exceptions for European Union Orders The Business-to-Business (B2B) VAT exemption feature allows business customers within the European Union (EU) to benefit from VAT exemptions for eligible orders. This capability ensures compliance with EU regulations and provides a seamless, efficient checkout experience for B2B transactions. A VAT exemption is offered based on the customer's location and shipping country within the EU. Merchants can enable or disable the VAT exemption feature based on their business requirements. The feature supports a wide range of languages to accommodate global merchants and shoppers. The VAT Exception works seamlessly with various shipping methods, including merchant-specific logistics solutions. **Compliance & Reporting** VAT-exempt orders automatically include the required tax details on invoices, such as the customer’s VAT registration number and exemption statement. Regulatory alignment insures adherence to EU regulations for cross-border B2B transactions. **VAT Exceptions Process** Business customers can provide their company name and VAT registration number directly in the checkout process. Relevant fields appear only when necessary, reducing clutter and improving usability. The system validates the provided details to confirm eligibility for VAT exemption. Upon successful validation, VAT is removed from the cart instantly, ensuring a transparent shopping experience. Business customers can provide their details for accurate representation on invoices, even if VAT exemption is not applicable. **Examples** * **Cross-Border Transactions**: A French business ordering from a German merchant can receive VAT exemption by providing valid company details. * **Domestic Business Transactions**: In countries supporting domestic reverse charge, businesses can also benefit from VAT exemption for local transactions. * **Custom Invoicing Needs**: Businesses that require their company name on invoices can easily include this information during checkout. # Billing Period and Payment Terms Source: https://docs.global-e.com/billing-period-and-payment-terms--au- The reconciliation process typically takes place on a weekly basis and results in a comprehensive report of all Merchant sales for the week. Based on the report, Global-e pays the Merchant the sum of all products sold internationally during that week plus any relevant shipping, duties, and taxes, minus the agreed service fee. Global-e's standard payment terms state that 100% of the net proceeds are paid weekly, up to two business days after the weekly reporting day. # Billing Period and Payment Terms Source: https://docs.global-e.com/billing-period-and-payment-terms--us- The reconciliation process typically takes place on a weekly basis and results in a comprehensive report of all Merchant sales for the week. Based on the report, Global-e pays the Merchant the sum of all products sold internationally during that week plus any relevant shipping, duties, and taxes, minus the agreed service fee. Global‑e's standard payment terms: * A credit note for sales less refunds and an invoice for all services and fees * Payment within two days from the date of reconciliation # Billing Period and Payment Terms Source: https://docs.global-e.com/billing-period-and-payment-terms-eu The reconciliation process typically takes place weekly and results in a comprehensive report of all Merchant sales for the week. Based on the report, Global-e pays the Merchant the sum of all products sold internationally during that week plus any relevant shipping, duties, and taxes, minus the agreed service fee. Global-e's standard payment terms: * 80% of the net proceeds are paid weekly, up to two business days after the weekly reporting day. * 20% of the net proceeds are paid seven days after the end of each calendar month. # Billing Period and Payment Terms Source: https://docs.global-e.com/billing-period-and-payment-terms-uk The reconciliation process typically takes place on a weekly basis and results in a comprehensive report of all Merchant sales for the week. Based on the report, Global-e pays the Merchant the sum of all products sold internationally during that week plus any relevant shipping, duties, and taxes, minus the agreed service fee. Global-e's standard payment terms: * 80% of the net proceeds are paid weekly, up to two business days after the weekly reporting day. * 20% of the net proceeds are paid seven days after the end of each calendar month. # Bonus Products (order-creation fallback) Source: https://docs.global-e.com/bonus-products-sfcc The Global-e cartridges include fallback logic so an SFCC order can still be created when the Global-e **OrderCreate** request to SFCC fails. The fallback runs inside the **SendOrderToMerchant** request: SFCC builds a new basket from the request body and then creates the order. The basket is rebuilt by `int_globale/cartridge/models/globale/order/actions/decorators/generateBasketFromPayload.js`. This page covers the special case of **bonus products** in that fallback. For the broader recovery story, see [Failover and recovery](/failover-sfcc). ## The problem Bonus products often depend on conditions tied to the original storefront session — for example, promotions that apply only to registered customers. When the fallback rebuilds the basket during SendOrderToMerchant (a server-to-server call in a different session), those session-specific conditions cannot be reproduced, so the original basket's bonus products may be lost. ## The solution To recreate bonus products in the rebuilt basket, the cartridges ship a dummy SFCC promotion **`GLOBALE_BONUS_PRODUCTS`** and an SFCC customer group **`GlobaleOrderCreationFallbackScenario`**. The fallback applies them in this order: 1. It first tries to apply the **same** SFCC promotion that was used in the original storefront session, recreating the bonus products. 2. If that promotion cannot be applied, it uses the **`GLOBALE_BONUS_PRODUCTS`** promotion to generate the bonus products in the new basket. ## Configuration If your project uses SFCC bonus-product promotions together with Global-e, configure the following: **Step 1** Enable the SFCC customer group **`GlobaleOrderCreationFallbackScenario`** (available in the cartridge repository `metadata` folder). **Step 2** Enable the SFCC promotion **`GLOBALE_BONUS_PRODUCTS`** (available in the cartridge repository `metadata` folder). **Step 3** Configure the SFCC job **`GlobaleCouponRedemptions`** — contact **Global-e Merchant Support** for the job configuration. See [GlobaleCouponRedemptions](/globale-coupon-redemptions-sfcc). **Step 4** Enable the site preference **Enable Coupon Verification** (`geEnableCouponVerification`). **Merchant Tools → Site Preferences → Custom Site Preference Groups → Global-e Settings** With these in place, bonus products are correctly applied to the rebuilt basket even when the original session conditions cannot be reproduced. ## See also * [Failover and recovery](/failover-sfcc) — order-creation fallback / SendOrderToMerchant * [GlobaleCouponRedemptions](/globale-coupon-redemptions-sfcc) * [Promotions](/promotions-sfcc) * [Metadata reference](/metadata-sfcc) — `geEnableCouponVerification` # Cache data Source: https://docs.global-e.com/cache-data Mobile SDK optimizes the user experience by caching the `getCountries`, `getCurrencies`, and `getMerchantPriceDetails` calls. You can configure the cache time for each method. **iOS** The cache() method is integrated into Global-E SDK and used to save cache data to the above methods. You can use the clearCache() method to clear the cache for all requests. ``` func clearAllCachedResponses() { let urlCache = URLCache.shared urlCache.removeAllCachedResponses() } ``` **Android** ``` GET_MERCHANT_PRICE_DETAILS -> { maxAge = 15 } } val request = chain.request() if (chain.request().url().pathSegments().last() == GET_CART_TOKEN) { return chain.proceed(chain.request()) } return if (cacheManager.canGetFromCache(request)) { cacheManager.getCachedResponse(request) } else { chain.proceed(chain.request()).also { cacheManager.cacheResponse(it, maxAge, TimeUnit.MINUTES) } } } } ``` ``` fun clearCache(): Boolean { return File("${context.cacheDir}${File.separator}$CACHE_GLOBAL_E").deleteRecursively() } ``` # Cart and Checkout Source: https://docs.global-e.com/cart-and-checkout Depending on the shipping country selection, one of the following checkouts is triggered: the standard Hybris checkout or the Global‑e checkout. This section outlines the main differences between the Hybris checkout and the Global-e-operated checkout. ## The Shipping Country is Operated by Global-e When the shipping country is operated by Global-e, the Global-e cart and the checkout are triggered. ### Cart * Taxes are not displayed * The Express Checkout is disabled * The Cart in Backoffice does not display tax ### Front-end: Global‑e Operated Checkout (Example) ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e05eef95-8e84-184e-074e-c91f1f6bfc0d.jpg?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=8e5d0d9c98a9dd3609e0eec8a7d34e9e) ### Backoffice View of the Global‑e Cart (Example) ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3b70f624-55d7-447d-1f57-595279b49775.jpg?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=20dff78844de7fb3d929f70953e30a2a) ## The Shipping Country is Operated by the Merchant When the shipping country is operated by the Merchant, the standard Hybris checkout is enabled with OOB features such as the Express Checkout or Taxes showing in the checkout. ### Front-end: Hybris Standard Checkout (Example) ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9d3b0285-3071-9a27-672f-b650f7eaba34.jpg?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=b34fa8a7d4a49b987aab596e5826d6ee) ### Backoffice View of the Hybris Cart (Example) ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-10a62b00-3f95-cbb6-9926-c3d163c74234.jpg?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=b9f7b4e9eac6e7c85acc89d1bfe6b683) ## Checkout * Once customers enter the checkout, they can no longer switch countries * The Checkout iFrame is triggered for Global‑e operated countries * Delivery costs, tax, and duties are calculated in the Global‑e iFrame checkout * Global‑e handles its own payment methods available for each shipping country ### Global‑e iFrame Checkout (Example) ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-73451e82-69a1-8c63-d5e8-c14197dc536f.jpg?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=082c4ff83942aca69fd9638148d735fc) ### SAP Checkout (Example) ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e4d16827-8c79-498f-1aed-b2a2c7c3c0d3.jpg?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=c6daba936d3032a7cff20c72afb50620) # Cartridges Source: https://docs.global-e.com/cartridges-sfcc Global-e ships six cartridges. Every Global-e site needs **`int_globale`** plus one storefront cartridge (or popups-only variant). See [Installation](/installation-sfcc) and [Configuration](/configuration-sfcc) for upload, metadata import, and Business Manager steps. ## Required cartridges | Cartridge | Use with | Purpose | | - | - | - | | `int_globale` | Always | Core Global-e logic — never customize directly; extend via a storefront cartridge | | `int_globale_sitegenesis` | `int_globale` | SiteGenesis Pipelines or Controllers storefronts | | `int_globale_sfra` | `int_globale` | SFRA storefronts | | `int_globale_headless` | `int_globale` | Headless / PWA / mobile (Shop OCAPI or SCAPI) — see [Hooks](/hooks-sfcc) § Headless | > [!WARNING] > > Choose **one** storefront cartridge per site (`int_globale_sitegenesis`, `int_globale_sfra`, or `int_globale_headless`). SFRA and SiteGenesis cartridges extend templates, models, and controllers for Global-e checkout and pricing. ## Optional cartridges | Cartridge | Use with | Purpose | | - | - | - | | `int_globale_sitegenesis_popups` | `int_globale` only | Country Switcher on SiteGenesis sites **not** operated by Global-e (replaces `int_globale_sitegenesis`) | | `int_globale_sfra_popups` | `int_globale` only | Country Switcher on SFRA sites **not** operated by Global-e (replaces `int_globale_sfra`) | Popups cartridges provide a lightweight integration (Client JS SDK / Country Switcher) without full cross-border checkout. ## Cartridge path (summary) Path order details are in [Configuration](/configuration-sfcc). | Architecture | Typical path fragment (left = highest priority) | | - | - | | SiteGenesis | `int_globale_sitegenesis` : `int_globale` : … brand cartridges … | | SFRA | … brand cartridges … : `int_globale_sfra` : `int_globale` : `app_storefront_base` | | Headless (+ SFRA site) | … brand cartridges … : `int_globale_headless` : `int_globale_sfra` : `int_globale` : `app_storefront_base` | | Headless only | `int_globale_headless` : `int_globale` | > [!WARNING] > > `int_globale` must appear **after** cartridges that override its controllers, models, or factories. ## Upload with the b2c CLI From the repository root, deploy the cartridge set for your architecture to the active code version (replace the hostname with your sandbox): | Architecture | Example command | | - | - | | SFRA | `b2c code deploy ./cartridges -c int_globale -c int_globale_sfra --server your-sandbox-hostname.demandware.net --reload` | | SiteGenesis | `b2c code deploy ./cartridges -c int_globale -c int_globale_sitegenesis --server your-sandbox-hostname.demandware.net --reload` | | Headless | `b2c code deploy ./cartridges -c int_globale -c int_globale_headless --server your-sandbox-hostname.demandware.net --reload` | | SFRA popups only | `b2c code deploy ./cartridges -c int_globale -c int_globale_sfra_popups --server your-sandbox-hostname.demandware.net --reload` | | SiteGenesis popups only | `b2c code deploy ./cartridges -c int_globale -c int_globale_sitegenesis_popups --server your-sandbox-hostname.demandware.net --reload` | If you build client assets from source, run the compile scripts in `package.json` before deploy. See [Installation](/installation-sfcc) for metadata import order. ## Business Manager cartridge path Organization-context job steps in **GlobaleSettings** (for example `GlobaleUpdateCachePriceBooksConfigHash` with ``) resolve scripts from the **Business Manager** cartridge path, not from storefront site paths. Add **`int_globale`** to the BM path: `Administration > Sites > Manage Sites > Business Manager (header link) > Settings > Cartridges` Or use the B2C CLI (recommended for automation): ```bash theme={null} b2c sites cartridges add int_globale --bm --position first ``` Only `int_globale` is required on the BM path for org job steps — storefront cartridges (`int_globale_sfra`, brand overrides, and so on) stay on each storefront site. ## Next steps **Step 1** [Installation](/installation-sfcc) — upload cartridges and import metadata **Step 2** [Configuration](/configuration-sfcc) — site cartridge path, site preferences, jobs **Step 3** [Metadata reference](/metadata-sfcc) — full site-preference and custom-attribute list **Step 4** [Production readiness](/readiness-assessment) — checklist for promoting the integration from Staging to Production # Catalog Management Source: https://docs.global-e.com/catalog-management ## Prepare and Upload The following procedure details the steps required to prepare and upload your catalog. ### Step 1. Prepare Your Catalog Before uploading your catalog, prepare a CSV file with detailed information on your store products. This information is used by Global-e to check for restrictions and to assign an HS code to each product. For this reason, the information must be inserted in the correct fields and formats, following the guidelines below. You can prepare your catalog using a template provided by your Project Manager, or define your own CSV file. **To set up your CSV file:** 1. Open an Excel spreadsheet and save it as a CSV file, using the following naming conventions: \{MerchantName}\_product-catalogue_ddmmyyyyhhmm.csv Example: MyToysStore_product-catalog_100220151738.csv 2. Name the columns as listed in the table below, following the same order, and include all mandatory headers. Example of a CSV file with column headers: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-23b30696-fd54-a0b6-2851-f23d2ba8a58c.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=3fabbc981bf080fae757e04e04977804) **Field Names and Descriptions**
Headers/FieldsDescriptionField TypeMandatory\ on Initial UploadMandatory\ in Ongoing Updates
ID-SKUThe Product SKU as it appears in your product catalog. The SKU should not include spaces.StringYesYes
Display_NameProduct name as it is displayed on the website.StringYesYes
Product_DescriptionThe product description as it is displayed on the website.StringYesYes
Product_CompositionDescribes the HS Code of the composition of the product.\ The composition field can be empty if the Merchant provides an HS code, and is responsible for the catalog classification.\ If the HS code and composition are not specified, GE will apply the default HS code to all products.\ If the composition is part of the description, GE will use it for classification.String (no limit)YesNo
Product_WeightThe product's weight in grams, including the packaging. The value should be the Gross Weight including packaging. The measurement units are grams.DecimalYes (Mandatory only when shipping DG).
Is BlockedThe product is blocked in all countries operated by Global-e. Optional values:\ 0 or empty - Unblocked products.\ 1 - Completely restricted and blocked products.bitYes, (If the merchant does not specify it, Global-e will add and classify it in the catalog)No
Parent_Product_ID\ (Only for SFCC merchants)The SKU of the Product parent SKU (The master product, if it exists).StringNoNo
Product_HS_CodeThe Commodity Code. An international term for the classification of products, to classify traded goods for customs purposes.\ HS codes are assigned by the Global-e classification team for merchants who shipped with Global-e carriers.StringNo. It is not always available on the merchant side as part of the catalog If Yes, then the Global-e Classification team will validate If No, then Global-e will assign HS code (based on composition)No
Product_CategoriesThe product category.String (50)NoNo
HeightProduct height measurement. In cm.DecimalNoNo
WidthProduct width, in centimeters.DecimalNoNo
LengthThe product's length, in centimetres.DecimalNoNo
VolumeThe product's net volume, in cubic centimeters.DecimalNo\ Net Volume is mandatory only for dangerous goodsNo\ Net Volume is mandatory only for dangerous goods
Country_of_OriginCountry where the product is manufactured.\ The COO must be provided for tax calculation. If it is not specified then a default COO is assigned.\ If it is part of the catalog then ongoing upload is required to keep the data up to date.\ If it is not part of the catalog, we should agree on the default value.StringYesYes
Image_URLA link to the image of the product.StringYesNo
Is_DG?Indication of whether the product is considered a Dangerous Good.bit (1)Yes. Mandatory for merchants shipping dangerous goods with Global-e via DHL.No
Kids products (if applicable)If it is part of the product description. (Filled by Global-e)bit (1)Yes,\ (Global-e runs an automated process for ongoing classification, to flag new kids' SKUs, and special HS codes are applied).No
PriceThe product's price in the default merchant currency.DecimalNoNo
SizeProduct size, if applicable:\ Clothes: S, M, L, XL,\ Shoes: sizeString (3)NoNo
ColourProduct colourStringNoNo
Product_URLURL of the product page.StringNoNo
### Step 2. Populate Your Catalog To populate your catalog: 1. Add your list of products, one product per row with the relevant information in the relevant column, according to the Field Names and Descriptions detailed in [Step 1](/catalog-management#step-1--prepare-your-catalog). > [!WARNING] > > Do not include commas in the prices you list in the CSV file, as this may cause parsing errors. 2. When done, save your CSV file. > [!NOTE] > > When enabling editing in your CSV file, your security settings may change the CSV file format to Excel. Make sure to save your file in CSV format before uploading it to Global-e. ### Step 3. Submit your Catalog for Approval After you have completed filling your file, you need to send it to your Project Manager for approval. The Global-e Clarification team reviews your CSV file to ensure correct formatting. They also check product restrictions and assign an HS code to each item. If there are any errors in the file, it will be sent back to you to be corrected. After you make the corrections, return it to your Project Manager to be reviewed again. This process continues until meeting the requirements necessary to upload to your site. ### Step 4. Upload your Catalog After your catalog is approved, Global-e provides you with a username and password for the SFTP server to upload it to the Global-e server. # Centra Source: https://docs.global-e.com/centra This page describes how to configure your Centra platform when integrating with Global-e, and describes the following: * [Centra APIs Used by the Global-e Integration](/centra-apis-used-by-the-global-e-integration) * [How to extract the initial catalog](/1b--extracting-the-initial-catalog) * [How to configure the Centra plug-in](/plug-in-configuration) * [How to configure the storefront](/storefront-configuration) # Centra APIs Used by the Global-e Integration Source: https://docs.global-e.com/centra-apis-used-by-the-global-e-integration The Global-e integration with Centra relies on three Centra APIs working together, each responsible for a different stage of the order lifecycle. Before configuring the Global-e plugin (see [Plug-In Configuration](/plug-in-configuration)), it is important to understand which API handles which step, because each one is configured as a separate plugin in your Centra store. | API | Role in the integration | How it is configured in Centra | | - | - | - | | Checkout API/DTC API | Used by Global-e to read the shopper's cart (the selection) from Centra before the international checkout begins. This is the entry point of the cross-border flow. | Added as a Checkout API plugin in your Centra store. Global-e calls it using a session token. | | Order API | Used by Global-e to create the order in Centra once the shopper has paid, and to update the order when the payment is captured. This is the server-to-server channel Global-e uses to write into Centra. | Added as an Order API plugin in your Centra store, configured under Stores Management → Stores → Plugins. Global-e authenticates using the shared secret you generate when creating the plugin. | | Integration API (GraphQL) | Used by Global-e to confirm the order after payment, and to cancel the order when an order cancellation is initiated. | Enabled by creating a GraphQL Integration API Token under System → API Tokens. | ## API Order Lifecycle The diagram below shows the end-to-end order lifecycle and which Centra API handles each step: | # | Stage | Centra API used by Global-e | What happens | | - | - | - | - | | 1 | Shopper begins checkout | Checkout API/DTC API | Global-e reads the shopper's cart from your Centra store so it can present the international checkout. | | 2 | Shopper pays | Order API | Once payment is authorized, Global-e creates the order in your Centra store. The order is created with status Pending, based on your store configuration. | | 3 | Payment is captured | Order API | Global-e updates the existing order in Centra with the captured payment. | | 4 | Order is confirmed | Integration API (GraphQL) | Global-e moves the order from Pending to Confirmed in Centra. | | 5 | Order is cancelled (if applicable) | Integration API (GraphQL) | If a cancellation is initiated, Global-e cancels the order in Centra. | ## Webhooks In addition to the three APIs above, Global-e subscribes to selected Centra webhook events so that changes made on your Centra store (for example, order updates or returns) are pushed to Global-e in near real time. ## What you need to provide When you begin the integration, you will be asked to: * Confirm which Checkout API plugin Global-e should use, if your store has more than one. Please contact Global-e to inform us of which version you are using (Checkout API/DTC API). * Provide the shared secret generated for the Order API plugin (used for server-to-server authentication). * Provide the GraphQL Integration API Token generated under System → API Tokens. Step-by-step instructions for creating and configuring each of these are provided in the sections that follow. # Change Delivery Country Source: https://docs.global-e.com/change-delivery-country Customers can change the delivery country directly on the Checkout page without navigating away. When a new delivery country is selected, the page refreshes to reflect the new country’s shipping, duties, and taxation (D\&T) policies. This feature supports cross-border commerce by accommodating country-specific shipping and taxation policies and the updated delivery country’s regulations. Customers remain on the checkout page throughout the process, maintaining continuity. > [!NOTE] > > Merchants that hold separate sites for different countries (subdomains or different folders) do require additional configurations on the platform side. **Examples** * **International Shoppers**: A customer shopping from the U.S. decides to send their order to a relative in Canada. They can seamlessly change the delivery country to Canada within the checkout page, with prices and taxes updating accordingly. * **Multi-National Merchants**: Merchants operating in multiple regions can provide a unified shopping experience by enabling country changes without redirecting customers. ## Disable Countries from Use Merchants can choose to disable specific countries as shipping destinations and billing addresses This feature removes the risk of a merchant conducting business with a country under sanctions. It also allows merchants to disable countries that it prefers not to ship to, even if they are allowed by Global-e. **Banned countries** Countries classified as “banned” by Global-el no longer appear in the billing address section or as shipping destinations. These countries are automatically restricted, and merchants cannot override this setting. **Merchant-Defined Inactive Countries** Merchants can mark specific countries as “Inactive,” even if Global-e permits them. Inactive countries are excluded from billing and shipping address options and do not appear in the country switcher or welcome popups. **Registered Users in Inactive Countries** For users with addresses in an inactive country, the address fields will be cleared. These users will be prompted to provide valid inputs during their next interaction. # Changing User Passwords Source: https://docs.global-e.com/changing-user-passwords Any user can change their own password at any time. Owner and Admin users can also change passwords for other users in the store. > [!NOTE] > > Contact Support to enable changing user passwords. ## To change a password: 1. Click the email address in the top right corner of the dashboard. 2. From the **Account** dropdown menu, select **STORE ACCOUNT**. 3. Click the pencil icon corresponding to the user you want to edit. 4. In the **Password** section, click the **CHANGE** button. # Changing User Passwords Source: https://docs.global-e.com/changing-user-passwords-703410 Any user can change their own password at any time. Owner and Admin users can also change passwords for other users in the store. > [!NOTE] > > Contact Support to enable changing user passwords. ## To change a password: 1. Click the email address in the top right corner of the dashboard. 2. From the **Account** dropdown menu, select **STORE ACCOUNT**. 3. Click the pencil icon corresponding to the user you want to edit. 4. In the **Password** section, click the **CHANGE** button. # Chargebacks Source: https://docs.global-e.com/chargebacks When a chargeback is filed, the Global-e customer service team attempts to contact the customer to clarify the reason of dispute. Each chargeback is reviewed to determine: * Why the order was originally approved * Why the order was manually released (in a “Deny” case) * Whether the fraudulent activity was made by an individual or by an organized group * Pattern identification Conclusions drawn from these reviews are incorporated into Global-e’s fraud protocols. Information pertaining to fraudsters is blacklisted to facilitate their identification and prevent future attempts. # Check In Incoming Orders Source: https://docs.global-e.com/check-in-incoming-orders > [card] > > | | > | - | > | Upon arrival at the store, a consignment typically contains multiple parcels. Store personnel scan or record the pertinent information from the labels on each parcel to complete the check-in process into the Global-E system. This documentation is intended for Store Administrators and Store Employees responsible for processing Store Orders. Throughout this document, we will refer to the reader as "you." You can use the following methods to check in parcels: **Standard process** (Default): Scan or copy the **parcel code** from the **Store Label** to the Global‑e system. See [Store Label](/check-in-incoming-orders#store-label). **Customized process** (According to Merchant request): Scan or copy the **tracking number** from the **Shipping Label** to the Global‑e System. See [Shipping Label](/check-in-incoming-orders#shipping-label). The Global‑e Merchant Portal triggers an automated notification to inform the customer that their order is ready for pick up. | > [card] > > [Embedded media](https://www.youtube.com/embed/SzDoMVR_kfQ) > > (Duration: 3:04) ## Check In Parcels Using the Parcel Code (Standard Process) When receiving an order, perform the following procedure for each parcel. For each parcel in the order, repeat the following procedure. **To check in a parcel with the parcel code:** 1. From the Store Orders menu, select Check in. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cbd30578-7a35-2436-3618-900bdd35be90.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=f4129af1a9b9ac7db365c70a7e078362) Navigating to the Check-in Orders Screen The Check-in Orders screen opens. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5dcc1485-e009-c2e7-e8aa-43bfaef1d5d2.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=e0a5ff656c519b2c47e88d6463895994) Check-in Orders Screen 2. On the store label, locate the parcel code. The parcel code consists of a bar code and a number (generally under the bar code). See the example in *Figure: Check-in Orders Screen* (above) and details in the [Store Label](/check-in-incoming-orders#store-label). 3. Scan the bar code – *or* – Copy the parcel code number (from under the bar code) and type it in the field *Enter parcel code*. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-50f4c933-9d59-510b-70bb-c12aa62ce7f9.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=69d546d42fe193125fa117f16bb9213d) Enter the Parcel Code 4. Before checking in, inspect the parcel. * If the parcel is damaged, see [Recording a Damaged Parcel](/check-in-incoming-orders#record-a-damaged-parcel). * If the parcel is intact, click **Check in Parcel**. The confirmation message **Parcel \[Parcel Code] added successfully** appears at the bottom of the screen. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1fc5521b-1b49-b9a1-64a8-97e4afb0933a.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=5cf36715b458e79cffb3b892a7688dee) Check-in Screen – Parcel Added Successfully The parcel has now been checked into the Global-e system; it is used to recognize the order’s specific parcel. The customer has been notified. > [!NOTE] > > If the parcel check-in fails (for example, the parcel ID was not found) contact Global‑e’s customer support. See [Contact Details and Escalation Process](/contact-details-and-escalation-process). In the Global‑e system, the status for this order is set to **Delivered to Store**. ## Check In Parcels Using the Tracking Number If this configuration is set up, instead of using the parcel number, you can check in orders to the Global‑e Merchant Portal by using the **tracking number** displayed on the parcel’s [Shipping Label](/check-in-incoming-orders#shipping-label). For each parcel in the order, repeat the following procedure. **To check in a parcel using the Tracking Number:** 1. From the Store Orders menu, select Check-in (see *Figure: Navigating to the Check-in Orders Screen*). The Check-in Orders screen opens. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-26140658-c1f7-7822-2846-1408e2813221.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=8ea5f55179809ac83194f7ad413f0ed0) Check-in Orders Screen with Tracking Number 2. On the shipping label, locate the tracking number (generally under the bar code). See [Shipping Label](/check-in-incoming-orders#shipping-label). 3. On your screen, enter (type) the Parcel’s Tracking Number. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9c352a25-6db9-efe9-e975-07f073f22a98.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=5fce7a1ef4e9bd7fb356c2ee740342b2) Enter the Parcel Tracking Number 4. Before checking in the parcel, inspect it: * If the parcel is damaged, proceed with [Recording a Damaged Parcel](/check-in-incoming-orders#record-a-damaged-parcel). * If the parcel is intact, click **Check in Parcel**. The parcel has now been checked into the Global-e Merchant Portal. Make sure to repeat this procedure for each parcel. > [!NOTE] > > If the parcel check-in fails (for example, if the parcel ID was not found), contact Global‑e’s customer support. > > See [Contact Details and Escalation Process](/contact-details-and-escalation-process). Once all parcels have been checked into the system: * The Global‑e Merchant Portal sends (automatically) an email to the customer stating that their order is ready for pick-up. * The Global‑e Portal status for this order is set to **Delivered to Store**. ## Record a Damaged Parcel If the parcel is visibly damaged, open, or otherwise unfit to present to the customer, perform the following procedure. **To record a damaged parcel:** 1. In the [Check in Orders Screen](/check-in-incoming-orders#check-in-parcels-using-the-parcel-code--standard-process-), enter the parcel code. 2. In the field *Add Order Annotation*, add a description of the issue. 3. Click **DAMAGED PARCEL**. The entire order is recorded as damaged. 4. Prepare the parcel to be returned to the Merchant. See [Preparing the Parcels for Return Shipment to the Merchant](/prepare-the-parcels-for-the-return-shipment-to-the-merchant). > [!NOTE] > > **Note:** Make sure to include this parcel in the next consignment box to be returned to the Merchant. ## Examples of Documents: Parcels Shipped to Store The Store Label and Shipping label are applied to each parcel that arrives at the store. This section details the information on these labels to check-in orders so that you can perform the check-in accurately into the Global-e Merchant Portal. ### Store Label A store label is mandatory on each parcel that implements the standard process. See [Checking in Parcels Using the Parcel Code (Standard Process)](/check-in-incoming-orders#check-in-parcels-using-the-parcel-code--standard-process-). **The store label includes:** * The name of the sender (Merchant) * The store’s details * The customer details * The Global‑e Order ID * A bar code consisting of the parcel code and underneath, the parcel code number. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-6f4db63b-bbb3-1193-35db-5fcef362ef0a.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=231a010a88d68666cb8bbb4376dd3f7b) Parcel Code Note that the presentation of the Store label varies according to the Merchant template. **Example:** In the following example, order GE23311623GB contains two parcels. Each parcel bears a store label with a unique code number identifying the parcel ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9d8dbf1f-b25e-ab6c-7cc3-199155fa0182.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=30604a89f2d7b7f9321510c140e42442) Label and Parcel Code ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1097faca-ee7a-c853-c425-4ac97c499382.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=4108a31ff1b845b5ba5c84af404337b9) Label and Parcel Code ### Shipping Label The shipping label is mandatory on all parcels. The shipping label includes a bar code and underneath (generally), the tracking number. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-6ae64d73-e5e7-57a3-cd51-2812ba75b499.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=e0ca257bc5148b9f9ea219e274005efa) Tracking Number The following figure shows examples of shipping labels. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-25eaf4d2-badb-46a8-f669-44e312da4c8d.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=383af424030fa5cef1ac56e5cc43dd49) ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-aa4dfdf4-6792-fc4a-f7a5-0e74cacd3925.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=a31d6750d9060c1ee2b059cd3533af34) Examples of Shipping Labels and Tracking Numbers # Checking Out, Creating, and Viewing Orders Source: https://docs.global-e.com/checking-out-creating-and-viewing-orders This section provides information on the Global-e extension's API endpoints used during order placement and on the details of the order after placement. ## Checking Out and Creating Orders When the shopper adds items to the cart, the Global-e extension uses the CartInfo API to get the content of the cart . `/?wc-api=pro-cart-info` When the shopper clicks the checkout button, the extension redirects from the native environment to the Global-e checkout. ## Viewing Orders after Creation After the order was created, you can view the list of orders or the details of each order. You can do this by navigating to WooCommerce > Orders. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-7faa9b5c-e8d4-2802-d94f-b234029db80d.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=74b1ddc9529d6c52c45196a2640bffe3) Before the order is injected into WooCommerce, it is created in the Global-e system and given a Global-e Order ID. The Orders screen shows the internal order ID replaced by Global-e Order ID. See the example in the figure above (Order List Screen with the Global-e ID). This ID is also displayed when opening an order and Viewing Order Details. The Global-e Order ID is proceeded by GE and ends with the merchant country code initials. An example of the Global-e ID format is **GE11053927GB**. Note that when orders are placed in the native application, the internal order ID is shown: ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e56313dc-0e65-ded9-50b1-ff202dc48488.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=0edc5d374f9d3655158d79f047d2826a) To cross-reference the order on the Global-e Merchant Portal, you can use either the internal Order ID or the Global-e Order ID. ## Viewing Order Details You can click a Global-e order to view its details, such as its order information, Global-e order ID, order status, and payment information. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-dbba1e65-c3dd-a387-7a27-f9af71b612d9.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=7a610d7b14ef71dd67b9df5a3a160684) The following table describes the order statuses in WooCommerce. | Status | Description | | - | - | | Pending | Global-e injects the order in **Pending** status. Fulfillment is not performed at this stage. The status remains Pending until the payment is cleared. | | Processing | Once the payment is processed successfully and the order is cleared by the fraud engines (or via manual fraud team review), the status changes to “Processing” and fulfillment starts. Once the order is in “Processing” status, the order can be prepared for international shipping and dispatched to the end customer. | | Processed | Once the order was shipped to the customer and an email notification was sent on behalf of the merchant, the order’s status will be set to “Processed”. | | Canceled | Orders canceled via the Global-e merchant portal are in the **Canceled** status. | ## Shipping and Handling Information The shipping price field always shows 0.00. You can view the actual shipping price paid by the customer on the Global-e Merchant Portal. In the Items Ordered section, product prices for Global-e orders appear in both the merchant’s base currency and the customer’s checkout currency. > [!TIP] > > To verify the actual amounts paid by customers for shipping, refer to the Global-e Merchant Portal: *GlobaleAdmin > Orders > View Orders* The Merchant Orders screen is displayed. In the Order Details Area, select an order to view the order details, including payment and shipping details. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-ca77009d-ef82-7e7d-f2be-e4312e039f42.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=92625beced748cc94d40df739136bb01) # Checkout - Stock Validation, Block Source: https://docs.global-e.com/checkout---stock-validation-block ## Stock Validation during Checkout This feature lets you validate your stock when an order is placed. During checkout, when a customer clicks the **Pay and Place Order** button, Global-e sends a request to your stock validation endpoint. If a product is out of stock, a pop-up informs the customer that the items are no longer available, as shown in the following example. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2979e873-056a-0a8e-5faf-e27a8b7cea73.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=bcb9214d0acbb84a43671dd9aa19fb0c) When clicking **OK**, the customer is redirected to the cart page where they can modify quantities. **To set up stock validation:** Implement either of the following Stock Validation endpoints: * [GetCheckoutCartInfo](/checkout-cart-info--from-global-e-)add a parameter `validateStock=true` - OR - * Create a new API endpoint that returns the same response as the GetCheckoutCartInfo (see examples below). In this case, notify us so that we can configure it on the Global-e side. When Global-e calls your Stock Validation endpoint: * If all products are in stock, the API returns the same line items displayed in the original GetCheckoutCartInfo response. See examples 1 and 2 below. * If a product is out of stock, check your inventory and update the product availability for the line item(s) for which there is not enough stock. See example 3 below. This is the stage when the pop-up appears, prompting the shopper to modify their ordered quantity. ### Sample Response Example 1: Original `getCheckoutCartInfo` response used to initiate the checkout. The OrderedQuantity = 5 units. ``` { "productsList": [{ "ProductCode": "SKU or product identifier 1", "CartItemId": "lineID1", "NameEnglish": "My First Product", "Name": "Product name", "DescriptionEnglish": "Product description", "Description": "Product description", "URL": "https:/domain/page.html", "ImageURL": "https://domain/image.jpg", "ImageWidth": 100, "ImageHeight": 100, "OriginalListPrice": 100, "OriginalSalePrice": 100, "OrderedQuantity": 5, "IsBlockedForGlobalE": false, "Weight": 11 } ] } ``` Example 2: Stock validation response without changes in stock levels. The `OrderedQuantity` = 5, which is the same quantity as in the previous example. ``` { "productsList": [{ "ProductCode": "SKU or product identifier 1", "CartItemId": "lineID1", "NameEnglish": "My First Product", "Name": "Product name", "DescriptionEnglish": "Product description", "Description": "Product description", "URL": "https:/domain/page.html", "ImageURL": "https://domain/image.jpg", "ImageWidth": 100, "ImageHeight": 100, "OriginalListPrice": 100, "OriginalSalePrice": 100, "OrderedQuantity": 5, "IsBlockedForGlobalE": false, "Weight": 11 } ] } ``` Example 3: Stock validation response with changes in stock levels. The `OrderedQuantity` = 3, a stock reduction from 5 to 3 units. This is when the pop-up is displayed, prompting the shopper to adjust their ordered quantity. ``` { "productsList": [{ "ProductCode": "SKU or product identifier 1", "CartItemId": "lineID1", "NameEnglish": "My First Product", "Name": "Product name", "DescriptionEnglish": "Product description", "Description": "Product description", "URL": "https:/domain/page.html", "ImageURL": "https://domain/image.jpg", "ImageWidth": 100, "ImageHeight": 100, "OriginalListPrice": 100, "OriginalSalePrice": 100, "OrderedQuantity": 3, "IsBlockedForGlobalE": false, "Weight": 11 } ] } ``` ## Block Int'l Orders from the Domestic Checkout To prevent accidental international orders on your domestic checkout page, consider removing Global-e-operated countries from the country dropdown list; no action is needed if your checkout does not have a country dropdown. Alternatively, you can redirect your international shoppers to the international checkout after they make their country selection, as detailed below. **Guest Shoppers** 1. Add a country dropdown list to your checkout page if one is not already present. Ensure that each option's value is a two-letter country code. 2. Share the dropdown element ID with Global-e so that we can enable the feature for you. Upon activation, if a shopper chooses a Global-e-operated country from your dropdown list, a popup prompts them to confirm the shipping destination for the order. The shopper is then redirected to the cart page, where their country is pre-selected. Example: ``` ``` **Logged in Users** For shoppers with accounts containing saved addresses, Global-e must retrieve the two-letter country code from their selected shipping address. Specify the source—Cookie, LocalStorage, SessionStorage, Global, or DOM element—from which we should retrieve this value, and we will configure it accordingly. When clicking the checkout button, a popup prompts the shopper to confirm their shipping country. The shopper is then redirected to the cart page, where their country is pre-selected. # Retrieve Checkout Cart Information (Global-e to Merchant) Source: https://docs.global-e.com/checkout-cart-info--from-global-e- Global-e retrieves the shopper's cart contents from the merchant for international checkout via the GetCheckoutCartInfo API. The `GetCheckoutCartInfo` API retrieves cart information for international checkout processing. This API: * Is triggered when the cart page loads or when a checkout attempt is made * Only returns products that are in stock * Requires proper cart token validation * Is part of Global-e's extensions (custom integration only) This method is called from a Global-e server with the cart token rendered in a cookie or HTML.DOM. The client's session calculates the price totals. The `GetCheckoutCartInfo` API returns all cart contents, including customer information for logged-in customers. This API only returns products that are in stock. If special handling is required for stock validation on your side, for products in the basket (for example, calls to an external system), Global-e can specify an additional URL for this method, to indicate that stock validation is specifically required. If the cart data is unavailable, the checkout will not open and an error message will appear in the browser development console. The `GetCheckoutCartInfo` API is only triggered upon the cart page loading, or when a checkout attempt is made. > [!NOTE] > > This API is part of Global-e's extensions and plug-ins. Merchants do not need to implement this API unless a custom integration is required. ## Usage * Displays totals on the basket page * Opens the checkout process * Validates order ([SendOrderToMerchant](/api-reference/send-order-to-merchant)) ## Security Requirements * **Client-side**: Session and Cart token (present in the request URL parameters) * **Server-side**: For both GET and POST: * Cart token — Request URL parameter (required) * Custom parameter — Request URL parameter (optional) * Custom header (optional) * IP whitelist (optional) * HTTP Basic Authentication (optional) * JWT (optional) * Additional methods available with POST only: * OrderID — In the request payload * Merchant GUID — In request payload (required) ## Retry Logic None. The `GetCheckoutCartInfo` API is only triggered upon the cart page loading, or when a checkout attempt is made. If the `GetCheckoutCartInfo` request fails to execute on the cart page, the international cart totals will not be calculated or displayed there. If the `GetCheckoutCartInfo` request fails on the checkout, the checkout will not open. ## Method/URL * Client-side: `GET` * Server-side: `GET` / `POST` (default `GET`). Global-e can configure your preference. ``` GET https://www.merchant-site-domain.com/get-checkout-cart-info-url POST https://www.merchant-site-domain.com/get-checkout-cart-info-url ``` > [!WARNING] > > Some values in the payload are encoded and must be decoded by the merchant — for example URLs, addresses, emails, and phone numbers. ## Reference > [card] [Get Checkout Cart Info — full request & response](/api-reference/get-checkout-cart-info) > > Parameters, schema, and examples for `GET /get-checkout-cart-info-url` (merchant-hosted). # Checkout discount vouchers Source: https://docs.global-e.com/checkout-discount-vouchers-sfcc Some Global-e checkout vouchers (for example a payment-method provider code) must apply an SFCC **promotion** without creating an SFCC **coupon line item**. The Global-e cartridges support that via **checkout discount vouchers**: mapped codes that set a **session custom attribute**, qualify a **dynamic customer group**, and apply a **no-coupon promotion** during Global-e checkout only. This feature reuses the existing `Globale-Coupon` (VoucherValidation) endpoint. Unmapped codes continue to use the normal coupon-line-item path. ## Limitations * **Percentage discounts only.** This feature works only with **percentage** discounts (SFCC percent-off promotions with Global-e `geDiscountType` = `PERCENTAGE`). Other checkout discount types (for example fixed amount / currency-off) are **not supported** by the Global-e service and must not be used for payment-method provider / checkout discount vouchers. ## Behaviour * Shopper selects an eligible payment method (or enters a mapped voucher) on Global-e checkout → SFCC applies the mapped promotion for that `Globale-Coupon` request only and returns a new `CartToken`. * Mapped codes do **not** create an SFCC coupon line item. * The checkout discount (payment-method provider discount) does **not** survive a later real SFCC coupon apply/remove. When Global-e checkout reloads after voucher validation, payment-method selection is reset — the shopper must select an eligible payment method again to get the checkout discount. * Leaving Global-e checkout for the cart (or opening checkout again from the cart without re-entering the voucher / re-selecting the PM) does **not** keep or revive the checkout discount. * On order failover (SOTM / basket rebuilt from SendCartV2 payload), if the last SendCartV2 still carried the voucher in `UrlParameters`, it can be restored for calculate. * Works on SFRA, SiteGenesis, and headless storefronts, using the scenario that matches each integration: * **SFRA / SiteGenesis** — Global-e calls `Globale-Coupon` in the shopper session (forwarded `dwsid`); the cartridge applies the mapped promotion directly on the storefront basket and calls SendCartV2. No OCAPI/SCAPI basket or coupon hooks are involved. * **Headless (PWA, SFNext, etc.)** — Global-e calls with a JWT (`AuthToken`) through OCAPI/SCAPI; the `int_globale_headless` basket/coupon hooks apply the promotion and refresh the cart token. ## Prerequisites 1. **Global-e platform** — the voucher / payment-method provider discount must also be configured on the Global-e side for the merchant. Contact **Global-e Merchant Support** to confirm merchant-account configuration (including settings required for checkout discount / voucher refresh behaviour). 2. **Cartridge path** that includes `int_globale` and the storefront cartridge for the integration: `int_globale_sfra` or `int_globale_sitegenesis` (shopper-session scenario), or `int_globale_headless` (JWT OCAPI/SCAPI scenario). Only `int_globale_headless` registers the OCAPI basket/coupon hooks (`beforePATCH`/`afterPATCH`, `coupon.*`) that the JWT scenario relies on; SFRA/SiteGenesis do not need them because the shopper-session scenario runs entirely in `Globale-Coupon`. 3. **Site preference** `geCheckoutDiscountVoucherMappings` configured (see below). 4. An SFCC **dynamic customer group** whose membership depends on the session attribute in the mapping. 5. An SFCC **percentage** promotion (no coupon required) assigned to that customer group, with Global-e promotion attributes set as usual (`geDiscountType` = `PERCENTAGE`). Other discount types are not supported for this feature — see [Limitations](#limitations). See [Promotions](/promotions-sfcc). 6. **SFRA / SiteGenesis only** — the shopper `dwsid` cookie must be present in the SendCartV2 `UrlParameters` (inside the `ClientCookie` entry). Global-e replays it when it calls `Globale-Coupon`, letting SFCC re-bind to the shopper session and current basket. Without `dwsid`, voucher apply/remove (and session-bound order create) fail — see [Checkout flow → Session identifiers](/checkout-flow-sfcc#session-identifiers-in-sendcartv2-sfra--sitegenesis). Headless uses the OCAPI/SCAPI JWT instead and does not need `dwsid`. ## Configuration ### 1. Site preference — Checkout Discount Voucher Mappings **Merchant Tools → Site Preferences → Custom Site Preference Groups → Global-e Settings → Checkout Discount Voucher Mappings** (`geCheckoutDiscountVoucherMappings`) JSON array. Empty, `null`, or invalid JSON means no mapped codes (all vouchers use the normal coupon path). | Field | Description | | - | - | | `voucherCode` | Code the shopper enters on Global-e checkout (match is **case-insensitive**) | | `sessionAttribute` | Session custom attribute name to set (e.g. `geCheckoutDiscountOnCheckout`) | | `sessionValue` | Value to set (typically `true`) | | `promotionId` | SFCC promotion ID that must appear as a price adjustment after apply (fail-closed check) | Example: ```json theme={null} [ { "voucherCode": "DISCOUNT-ON-CHECKOUT", "sessionAttribute": "geCheckoutDiscountOnCheckout", "sessionValue": true, "promotionId": "globale-discount-on-checkout" } ] ``` ### 2. Customer group and promotion **Step 1** Create a dynamic customer group that includes shoppers when the session attribute from the mapping is set. **Step 2** Create (or reuse) a **percentage** (percent-off) promotion that qualifies on that group — **without** requiring an SFCC coupon. Do not use amount, fixed-price, or other non-percentage discount types for this feature. **Step 3** Assign the promotion to an active campaign and set Global-e promotion custom attributes with `geDiscountType` = `PERCENTAGE`. **Step 4** Ensure `promotionId` in the mapping matches the promotion ID exactly. ### 3. Metadata Import Global-e metadata that includes: * Site preference `geCheckoutDiscountVoucherMappings` * Basket attribute `geCheckoutDiscountVouchers` (used by the cartridge; merchants do not set this manually) See [Metadata reference](/metadata-sfcc). ## Expected checkout behaviour | Action | Result | | - | - | | Apply mapped voucher | `IsVoucherValid: true`, promotion price adjustment present, new `CartToken` | | Apply mapped voucher but promotion does not apply | `IsVoucherValid: false` (fail-closed) | | Apply or remove mapped voucher but no new `CartToken` is returned by Global-e | `IsVoucherValid: false` (fail-closed) | | Remove mapped voucher | Discount cleared, new `CartToken` | | Apply real SFCC coupon after payment-method checkout discount | Checkout discount is **cleared** (not revived); real coupon applies; new `CartToken`. Shopper must re-select an eligible payment method to get the checkout discount again | | Apply a real SFCC coupon that does not qualify | `IsVoucherValid: false`, coupon line item removed, no cart refresh sent to Global-e | | Leave Global-e checkout for the cart, then open it again without the voucher | Checkout discount **not** revived | | Unmapped code | Normal coupon path (create/remove coupon line item) + refreshed `CartToken` | ## Notes * SendCartV2 `UrlParameters` may carry checkout discount vouchers for **SOTM / fallback** basket rebuild when the discount-apply SendCart still had the basket attribute set. Other Global-e requests (`OrderClientCreate`, `OrderCreateV2`, `KeepAlive`, `ValidateCart`) neither apply nor validate vouchers, so they do not need the voucher session attributes. * Only one checkout discount voucher is active at a time. Applying another mapped voucher replaces the previous one. * On the Global-e platform, configure the matching payment-method provider / checkout discount as a **percentage** value only (for example `10%`). Non-percentage checkout discounts are not supported by the Global-e service. Confirm related merchant-account settings with **Global-e Merchant Support** before go-live. ## See also * [Promotions](/promotions-sfcc) * [Customer groups](/customer-groups-sfcc) * [Session attributes](/session-attributes-sfcc) * [Failover and recovery](/failover-sfcc) * [Metadata reference](/metadata-sfcc) # Checkout Flow Source: https://docs.global-e.com/checkout-flow The Checkout integration combines ultimate security with integration robustness since this integration method is independent of the structure and characteristics of the webstore’s cart page. The Global-e Magento2 Lite extension implements the `GetCheckoutCartInfo(GetCart)` API method that uses a Magento Quote object to load the contents of the user’s cart and pass it securely to the Global-e checkout using a server-to-server RESTful API call. The checkout page (container page) is provided by the Global-e Magento2 Lite extension on the URI /international/checkout. This page will be used to open the iframe with Global-e checkout. # Global-e Checkout Source: https://docs.global-e.com/checkout-flow-sfcc Global-e checkout runs in an iframe served from Global-e servers. SFCC sends the basket via **SendCartV2**, validates stock when the shopper places the order, creates a minimal SFCC order in the shopper session, then receives server-to-server updates with full international order data. **Read order:** [Checkout flow](/checkout-flow-sfcc) (this page) → [Order lifecycle](/order-lifecycle-sfcc) (post-create updates) → [Failover and recovery](/failover-sfcc) (SOTM fallback when order create fails). **See also:** [Configuration](/configuration-sfcc) · [Client JS SDK](/client-js-sdk-sfcc) · [Hooks → `globale.validateCart`](/hooks-sfcc) · [Metadata → Site Preferences](/metadata-sfcc) Once the customer clicks the checkout CTA on the cart page, they are redirected to Global-e checkout (iframe served from Global-e servers). Because checkout takes place outside SFCC, orders are created on Global-e first and then synchronized to SFCC through cartridge controller endpoints (`Globale-*`). ## Checkout journey **Step 1** **SendCartV2** — Before the iframe loads, SFCC calls the Global-e **SendCartV2** service (`Globale-SendCartV2`) with basket data, session identifiers (`dwsid` for SFRA/SiteGenesis, OCAPI/SCAPI JWT for headless), and merchant metadata. The response includes a **cart token** used by the Client JS SDK to render checkout. **Step 2** **Reserve inventory (optional)** — When site preference **`geEnableStockReservation`** is enabled, SFCC reserves basket inventory for **`geStockReservationTime`** minutes (default 30) before the Send Cart request. The **Globale-KeepAlive** endpoint keeps the SFCC session alive while the shopper is on checkout; it only creates a short (1-minute) reservation when none already exists — it does **not** extend the active SendCart reservation. **Step 3** **Show checkout** — The cartridge renders `globale/checkout/iframe.isml`, which hosts the Global-e checkout iframe using the cart token from SendCartV2. **Step 4** **Validate cart** — When the shopper clicks **Place order**, Global-e calls **`Globale-ValidateCart`** (server-to-server). SFCC runs the **`globale.validateCart`** hook (OOTB handler: `onGlobaleValidateCart.js` → `validateCartHelpers.js`). If a product is out of stock — or, when CAPI basket validation is enabled (`geEnableCartValidationCAPIBasket`, used for OCAPI/SCAPI/headless), the basket hash does not match — the shopper sees an error popup and is returned to the cart; no order is created on either side. (For the storefront default, the basket hash is enforced at order create rather than at `Globale-ValidateCart`.) **Step 5** **Order create** — After checkout completes on Global-e, SFCC must convert the basket to an order while bound to the original session (inventory reservation). Supported paths: * **`Globale-OrderCreate`** — legacy browser flow (Global-e SDK posts to SFCC from the container page). * **`Globale-OrderCreateV2`** — server-to-server order create (recommended; supports OCAPI/SCAPI session bridge for headless). Order create can fail due to session expiry, stock issues, or basket changes. Global-e may retry using stored basket data. On failure, the order-create response (both `Globale-OrderCreate` and `Globale-OrderCreateV2`) defaults to order number **`-1`** (`ORDER_CREATE_BYPASS_NO`) so Global-e can still send **Send Order To Merchant** (SOTM) — see [Failover and recovery](/failover-sfcc). **Step 6** **Send Order To Merchant (SOTM)** — Newly created SFCC orders start in status **Created** with minimal data. Global-e calls **`Globale-OrderSendToMerchant`** with the full international payload. The cartridge places the order (**New**), sets confirmation status to **Confirmed**, and writes Global-e attributes. When platform setting **`sfccPlaceOrderOnPaymentUpdate`** is enabled, place/confirm is deferred until payment update (step 7). **Step 7** **Perform payment** — After fraud checks pass, Global-e calls **`Globale-OrderPerformPayment`**. Payment status becomes **Paid** and export status **Ready for export** (and place/confirm runs here when **`sfccPlaceOrderOnPaymentUpdate`** is enabled). ## Checkout-phase SFCC endpoints | Endpoint | Direction | Purpose | | - | - | - | | `Globale-CheckoutShow` | Storefront | Loads checkout iframe container | | `Globale-SendCartV2` | SFCC → Global-e (service) | Sends basket; returns cart token | | `Globale-KeepAlive` | Global-e → SFCC | Keeps SFCC session alive; creates a short reservation only if none exists | | `Globale-ValidateCart` | Global-e → SFCC | Stock and basket validation at place order | | `Globale-OrderCreate` | Global-e → SFCC (browser) | Legacy session-bound order create | | `Globale-OrderCreateV2` | Global-e → SFCC (server) | Server-to-server order create | | `Globale-ClearCart` | Global-e → SFCC | Clears basket after order confirmation | Post-create endpoints (`Globale-OrderSendToMerchant`, `Globale-OrderPerformPayment`, and others) are documented in [Order lifecycle](/order-lifecycle-sfcc). ## Session identifiers in SendCartV2 (SFRA / SiteGenesis) > [!NOTE] > > **Mandatory for SFRA and SiteGenesis:** the shopper `dwsid` cookie must be present in the SendCartV2 `UrlParameters` (inside the `ClientCookie` entry). `getUrlParameters` collects it automatically from the storefront request, so it is only ever missing when SendCartV2 is triggered without the shopper's browser cookies (for example a misconfigured proxy/CDN that strips `dwsid`, or a custom flow that calls SendCartV2 outside the shopper request). On SFRA and SiteGenesis, Global-e replays the cookies it received in `ClientCookie` when it calls back server-to-server. SFCC uses the `dwsid` to re-bind to the **shopper session** and its current basket. Without it: * **`Globale-Coupon`** cannot resolve `BasketMgr.getCurrentBasket()` for the shopper, so coupon and checkout-discount voucher apply/remove fail (`IsVoucherValid: false`). * **`Globale-OrderCreate` / `Globale-OrderCreateV2`** cannot re-bind to the original session (inventory reservation, session-scoped promotions), so session-bound order create fails and Global-e falls back to SOTM — see [Failover and recovery](/failover-sfcc). Headless (`int_globale_headless`) does not depend on `dwsid`: it authenticates the same server-to-server calls with the OCAPI/SCAPI JWT (`AuthToken`) instead. ## Stock validation Out of the box, stock validation checks SFCC inventory when the shopper clicks **Place order** on Global-e checkout. Merchants can customize validation through the **`globale.validateCart`** hook — see [Hooks](/hooks-sfcc). ### Site preferences | Preference ID | Display name | Role | | - | - | - | | `geEnableStockReservation` | Enable Stock Reservation | Reserve basket inventory before Send Cart | | `geStockReservationTime` | Stock reservation time | Reservation duration in minutes (default 30) | When **`geEnableStockReservation`** is enabled, reservation runs in `SendCartOperation` before the SendCartV2 call. **`Globale-ValidateCart`** runs again at place order. ### Releasing a reservation When Global-e needs to release a reservation it has taken (for example, the shopper abandons checkout or the reservation expires), it calls the **`Globale-VoidInventoryReservation`** endpoint with `OrderId` and `ReservationRequestId`. This endpoint is implemented in `int_globale_sfra` only — it is not registered in the SiteGenesis controller. Because reservation storage is merchant-specific, the cartridge ships no out-of-the-box handler. Release is implemented through the **`globale.onAfterVoidReservation`** hook — see [Hooks](/hooks-sfcc#globaleonaftervoidreservation). The hook must return a boolean indicating whether the release was applied: 1. The endpoint invokes the hook **synchronously**. If it returns `true`, processing ends there. 2. If it returns anything falsy — including when no handler is registered — SFCC stores a `GLOBALE_INVENTORY_NOTIFICATION` custom object (`geNotificationType` = `VoidReservation`) so the release can be retried asynchronously. 3. The **`custom.GlobaleInventoryVoidReservation`** job step drains those custom objects in creation order, re-invoking the same hook for each and deleting the object once the hook returns `true`. The step type ships with the cartridge but is **not** included in the default `metadata/jobs.xml`. Create a Business Manager job for it only if you implement `globale.onAfterVoidReservation` and want the asynchronous retry path. It accepts the standard `geDisableJobStep` parameter and runs in site context. With no handler registered, the custom objects are still written but nothing consumes them; they expire under the type's 7-day retention. ### Validation enabled vs disabled When cart validation is **enabled** on the Global-e side, **`Globale-ValidateCart`** runs at place order. Out-of-stock products trigger a checkout popup and redirect back to the cart. When validation is **disabled**, the shopper may reach confirmation, but SFCC order create can still fail on inventory. Global-e may create a failed order while SFCC logs show missing inventory. When validation succeeds, the SFCC order is created with status **Created** and Global-e proceeds with checkout completion. ### Third-party inventory checks Implement custom logic in the **`globale.validateCart`** hook handler (`int_globale_sfra` or `int_globale_sitegenesis` → `scripts/hooks/checkout/onGlobaleValidateCart.js`). Do not override `validateCartHelpers.js` in `int_globale` directly. ## Test Global-e Checkout To pass fraud checks automatically on SFCC sandbox, development, or staging environments, use the test phone number and card numbers provided by your Global-e account or project manager (not published in this guide for security). Use valid, realistic billing and shipping addresses in test orders. # Global-e Embedded Checkout Page Source: https://docs.global-e.com/checkout-page > [!NOTE] > > **This section does not apply to Shopify. For information about Shopify, see [Shopify Native](/shopify-native).** After being greeted in their language, shoppers add the desired products to their carts. When done, Shoppers check out using Global‑e's secure checkout page, where they can view their order, prices, shipping rates, taxes, and duties in their currency, thanks to Global-e's conversion system from merchant's currency to the customer's local currency. Global‑e exposes the international checkout page via JavaScript in an iFrame on your Merchant's site. > [!WARNING] > > The information detailed in this section applies to the standard Global‑e checkout functionality. For information on the checkout in Shopify see the [Shopify Native](/shopify-native) . # Checkout Page Features Source: https://docs.global-e.com/checkout-page-features ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/uuid-037519a6-94a3-94e4-7fd8-3133fd633830.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=dba4c16abe8bf0779555654eca50ae5b) The following elements of the checkout page can be configured per the merchant's preference. * Language selection * Order Summary * Express Checkout * Shipping Options * Shipping Address * Customer Consent * B2B section * Billing Address * Shipping Method section * Package Options * Gift Message * Duties \&Taxes * Billing Summary section * Gift Card/Promo Code Section * Payment Method section * Terms and Conditions/contact us panel # Mandatory Items Source: https://docs.global-e.com/checkout-page-mandatory-items The following table lists the mandatory items for the checkout page. These items are required and must be part of every checkout page. | # | Element | Description | | - | - | - | | 1 | [Order summary review](/billing-and-order-summary) | Customers use the order summary to review their cart items, item prices and quantity. Minimizes errors and returns, ensuring users are confident in their purchases. | | 2 | [Shipping information](/shipping-orders#shipping-information) | Shipping information collects the customer's shipping address. Registered users can auto-fill their stored details. | | 3 | [Billing information](/billing-and-order-summary) | The customer enters their billing address in billing information. Ensures accurate billing and compliance. | | 4 | [Shipping method selection](/shipping-options) | The customer selects a preferred shipping option using the shipping method selection feature. Users can choose their preferred delivery method, such as home delivery or pickup points. Finalizes the preferred shipping method. | | 5 | [Billing summary](/billing-and-order-summary) | In the billing summary, the customer reviews all order details and places the order. Provides a final summary of the order, including itemized details, shipping costs, and taxes. | | 6 | [Payment methods](/payment-methods-386962) | The customer can select their preferred payment method from payment method options. Supports diverse payment preferences, reducing friction. | | 7 | [Terms and Conditions/Contact Us panel](/customer-consent) | The customer has the ability to check legal restrictions. Customers can review terms and conditions and access contact information. Ensures transparency and provides support channels. | | 8 | [Accessibility menu](/accessibility#accessibility-widget) | The accessibility menu supports accessibility for visually impaired customers. Provides accessibility options to make the checkout usable for all users. | # Client Analytics Source: https://docs.global-e.com/client-analytics ## Base Global‑e Script > [!WARNING] > > 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: ``` https:///merchant/clientsdk/?v= ``` To load our base script, you should use a self-invoking function: (\, \, \ + \, "script", "gle", \, \) **Production Example:** ``` (window, document, "https://web.global-e.com" + "/merchant/clientsdk/124125?v=2.1.5", "script", "gle", "2.1.5", 124125) ``` **Code Sample** ``` ``` **Script Parameters** | Parameter | Description | | - | - | | `sDomain` | Production: [https://web.global-e.com](https://web.global-e.com) Integration: [https://www.bglobale.com](https://www.bglobale.com) Staging: [https://www2.bglobale.com](https://www2.bglobale.com) | | `window` | The JavaScript window object | | `document` | The JavaScript document object | | `clientJsURL` | Local file path or direct to Global‑e servers`/merchant/clientsdk/?v=` | | `ScriptVersion` | The version of Global-e server API. Currently 2.1.5. | | `merchantId` | The 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. > [!NOTE] > > This list is subject to modifications and limitations that may affect the availability of payment methods on the checkout page. ## Order Transaction Analytics The Order Transaction 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 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. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4efe614a-6add-3c2d-a33a-744296df3b84.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=1c16b2c901381e86a68c5db6019718c1) The building blocks of the Order Transaction 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 Order Transaction Analytics flow. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d37528c6-ed07-5baa-93c3-617a478b5096.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=6d2a3040dc320f7073d236a3ea5b7630) The building blocks of the Order Transaction Analytics subscription flow are as follows: 1. Subscribe to the Global‑e `OnCheckoutStepLoaded` callback, as described in [Subscribing to OnCheckoutStepLoaded](/client-analytics#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. > [!NOTE] > > 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 Order Transaction Analytics 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](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 Order 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](/client-analytics#order-transaction-analytics-object-overview) 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](/client-analytics#order-transaction-analytics-object-overview) data. The [Order Transaction Analytics](/client-analytics#order-transaction-analytics-object-overview) 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. ``` gle("OnCheckoutStepLoaded",function(data){...} ``` ### 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. ``` gle("OnCheckoutStepLoaded", function (data) {     switch (data.StepId) {         case data.Steps.LOADED: if (data.IsSuccess && !data.IsPageReload) {                 // data contains product and cart information;   // Include analytics triggers here // use the data object fields;             break;         case data.Steps.CONFIRMATION:             if (data.IsSuccess && !data.IsPageReload) {                 // data contains order information;   // Include analytics triggers here // use the data object fields; // window.location = "https://www.yourconfirmationpage.com";             }            break;     } }); ``` The following table details the `OnCheckoutStepLoaded` callback properties. | Property | Description | | - | - | | `gle/glegem` | The Global‑e SDK instance to subscribe to, gle or glegem, depending on the Platform. | | `OnClientEvent` | The 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'`. | | `data` | The data parameter contains the object that holds the event data. The [data](/client-analytics#data) structure elements are detailed below. | ### data ``` { "Steps": {        "LOADED": 0 //"The checkout page (step) has loaded",      "CONFIRMATION": 4 //"The confirmation page is displayed" },  //---------------Applicable to the Confirmation Step------------------ "OrderID": "Global‑e order ID", //Confirmation only "AuthCode": "Global‑e payment authorization code", //Confirmation only //-------------------------------------------------------------------- "StepId": "" //"The Global‑e step ID",   "IsSuccess": "", "details": { ``` Where: | Property | Type | Description | | - | - | - | | `Steps` | object (enum) | Checkout step and confirmation stepValues: \{`{"LOADED":0,"CONFIRMATION":4}` | | `LOADED` | Integer | The checkout page (step) has loaded. Global‑e checkout loaded code. See Data structure and examples. | | `CONFIRMATION` | Integer | The confirmation page (step) is displayed immediately after the payment has been authorised.Global‑e confirmation code.See Data structure and examples. | | `StepId` | Integer | The Global‑e `stepId` corresponding to the relevant step in the checkout:`LOADED:0:``CONFIRMATION":4` | | `details` | Object | This 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](/client-analytics#order-transaction-analytics-object-overview) 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. > [!NOTE] > > 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). ``` { "Steps": {        "LOADED": 0 //"The checkout page (step) has loaded",      "CONFIRMATION": 4 //"The confirmation page is displayed"" },      "IsSuccess": “true” //"The value is always true",     "StepId": 0 //"The Global‑e step ID",   "details": {    "CustomerCurrencyCode": "", //See Order Properties         "MerchantCurrencyCode": "", //See Order Properties         "IsEU": "", //See Order Properties "CustomerDetails" " MerchantUserId": "" //See Customer Details        "HubCountryCode": "", //See Order Properties "ProductInformation" : "", //See Product Information "Discounts" : "", //See Discounts "cultureCode": "", //See Order Properties "InitialCheckoutCultureCode": "", //See Order Properties "URL" : "", //See Global‑e Properties      "CustomURL" : "", //See Global‑e Properties      "MerchantID" : "", //See Global‑e Properties "Title" : "", //See Global‑e Properties      "CustomHostName" : "", //See Global‑e Properties     "PageType" : "", //See Global‑e Properties      "CartToken" : "", //See Global‑e Properties      "URLReferer" : "", //See Global‑e Properties      "DoLog" : "" //See Global‑e Properties },  } ``` *See:* * The [Order Transaction Analytics Object](/client-analytics#order-transaction-analytics-object-overview) section and subsections for a description of the properties. * [Order Properties](/client-analytics#order-properties) * [Customer Details](/client-analytics#customer-details) * [Product Information](/client-analytics#product-information) * [Discounts](/client-analytics#discount-information) * [Global‑e Properties](/client-analytics#global-e-properties) * [Checkout LOAD Step](/client-analytics#checkout-load-step) example. ### CONFIRMATION Step (StepId: 4) When the `CONFIRMATION` step is triggered, the data property contains the following JSON object: ```  {     "Steps": {         "LOADED": 0 //"The checkout page (step) has loaded",        "CONFIRMATION": 4 //"The confirmation page is displayed"     },     "IsSuccess": "Whether the payment was successful",     "OrderID": "Global‑e order ID",     "AuthCode": "Global‑e payment authorization code",     "StepId": 4 //"The Global‑e step ID",     "details": { // "Order Transaction Analytics Object"         "OrderID": "",         "CartToken": "",         "CountryCode": "",         "UrlReferer": "", //See Order Transaction Analytics Object section and subsections //for the complete list of properties and descriptions.     } } ``` Where: | Property | Type | Description | | - | - | - | | `IsSuccess` | Bool | If 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 = "https://www.yourconfirmationpage.com"`) | | `OrderID` | String | The Global‑e Order ID. Example: GE103411992GB | | `AuthCode` | Integer | The Global‑e payment authorisation code. Example: 5 | See: [Order Transaction Analytics Object](/client-analytics#order-transaction-analytics-object-overview) section and subsections for the complete list of properties and descriptions. [Examples](/client-analytics#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** ``` { // General information ... "CustomerDetails": { "MerchantUserId":  "ShippingAddress": { ... }, "BillingAddress": { ... }, }, // Order Prices Component "OrderPrices": { // Merchant Transaction Group "MerchantTransaction": { ... }, // Merchant Transaction Exclusive of VAT Group "MerchantTransactionExcludingLocalVAT": { ... }, // Customer Transaction Group "CustomerTransaction": { ... }, // Customer Transaction In Merchant Currency Group "CustomerTransactionInMerchantCurrency": { ... }, }, // Product Information Component "ProductInformation": [{ ... "ProductPrices": { "MerchantTransaction": { ... }, "MerchantTransactionExcludingLocalVAT": { ... }, "CustomerTransaction": { ... }, "CustomerTransactionInMerchantCurrency": { ... }, } } ], // Payment Component "PaymentMethods": [{ ... }, ], // Discounts Component "Discounts": [{ ... "DiscountPrices": { "MerchantTransaction": { ... }, "MerchantTransactionExcludingLocalVAT": { ... }, "CustomerTransaction": { ... }, "CustomerTransactionInMerchantCurrency": { ... }, } } ] } ``` ### 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: > [!NOTE] > > 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](/client-analytics#order-prices-and-transactions) * **Product information:** This component includes all product-level information that does not include prices. See [Product Information](/client-analytics#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](/client-analytics#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](/client-analytics#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 | Property | Type | Description | | - | - | - | | `OrderID` | String | Global‑e order unique identifierExample: `GE538738292GB` | | `ReplacementOrder` | Bool | Indicates whether the order is a replacement. | | `CustomerCurrencyCode` | String | 3-char ISO currency code denoting the customer’s currency.Example: `EUR` | | `MerchantCurrencyCode` | String | 3-char ISO currency code denoting the original (merchant) currency on the merchant’s side.Example: `GBP` | | `IsEU` | Bool | Whether the destination country is in the EU. | | `CustomerDetails` | - | See *[CustomerDetails](/client-analytics#customer-details)* section. | | `HubCountryCode` | String | Two-letter country code of the hub from which the order is dispatched to the customer.Example: `GB` | | `Region` | String | Customer state or region (if available). | | `SiteURL` | String | Merchant website or store URL. | | `DutiesGuaranteed` | String | Indicates if the customer has selected the “guaranteed duties and taxes” option. | | `ShippingMethodName` | String | The name of the carrier, as was defined by Global-e for the specific merchant. Example: DHL, Spring Parcel Over 2Kg | | `ShippingMethodType` | String | The type of carrier, as selected by the customer on the checkout page. Example: Standard, Express | | `DeliveryDaysRangeFrom` | Decimal | The minimum number of days to delivery, as displayed on the Checkout page. | | `DeliveryDaysRangeTo` | Decimal | The maximum number of days to delivery, as displayed on the Checkout page. | | `cultureCode` | String | Culture 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 | | `InitialCheckoutCultureCode` | String | Culture code determined during the initial checkout load | | `CheckoutStep` | String | The checkout step (`LOAD` or `CONFIRMATION`) | | `CountryCode` | String | Order destination country code 2-char ISO.Example: `GB` | ### Customer Details > [!NOTE] > > 'CustomerDetails' is disabled by default. Make sure to request that Global‑e enables it. ### MerchantUserId | Property | Type | Description | | - | - | - | | `MerchantUserId` | String | The registered user ID as it figures on the merchant’s website Value for guests: “null” | ### ShippingAddress | Property | Type | Description | | - | - | - | | `ShippingFirstName` | String | The first name of the customer's shipping address | | `ShippingLastName` | String | The last name of the customer's shipping address | | `ShippingAddress1` | String | The first line of the customer’s shipping address | | `ShippingAddress2` | String | The second line of the customer's shipping address | | `ShippingCity` | String | The customer’s shipping city | | `ShippingCountryName` | String | The customer’s shipping country name | | `ShippingCountryCode` | String | The customers shipping country code ISO-2 | | `ShippingState` | String | The customer's shipping state name (if applicable) | | `ShippingStateCode` | String | The customer’s shipping state code ANSI (if applicable) | | `ShippingCompany` | String | The customer’s shipping company name | | `ShippingZipCode` | String | The customer’s shipping zip code | | `ShippingPhoneNumber` | String | The customer’s shipping phone number | ### BillingAddress | Property | Type | Description | | - | - | - | | `BillingFirstName` | String | The first name of the customer's billing address | | `BillingLastName` | String | The last name of the customer's billing address | | `BillingAddress1` | String | The first line of the customer's billing address | | `BillingAddress2` | String | The second line of the customer's billing address | | `BillingCity` | String | The customer's billing city | | `BillingCountryName` | String | The customer's billing country name | | `BillingCountryCode` | String | The customer's billing country code ISO-2 | | `BillingState` | String | The customer's billing state name (if applicable) | | `BillingStateCode` | String | The customer's billing state code ANSI (if applicable) | | `BillingCompany` | String | The customer's billing company name | | `BillingZipCode` | String | The customer's billing zip code | | `BillingPhoneNumber` | String | The customer's billing phone number | | `BillingEmail` | String | The 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. | Property | Type | Description | | - | - | - | | `EstimatedTotalPrice` | Decimal | Estimated total order price after deducting the shipping and duties discounts. | | `TotalProductsPrice` | Decimal | The total price of the products (only) before discounts | | `TotalDiscountedProductsPrice` | Decimal | The total price of the products after product discounts | | `EstimatedShippingCost` | Decimal | The estimated shipping cost to be subsidized by the merchant | | `ShippingVATRate` | Decimal | Shipping service fee VAT rate, if applicable | | `DutiesAndTaxes` | Decimal | Duties subsidy discount | | `ProductTotalVAT` | Decimal | The VAT paid by Global-e to the merchant on the products, if applicable. | | `TotalVAT` | Decimal | The total VAT sum to be paid by Global-e to the Merchant on the order, if applicable. | | `RemoteAreaSurchargeFee` | Decimal | Merchant 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. | Property | Type | Description | | - | - | - | | `EstimatedTotalPriceExcludingVAT` | Decimal | Estimated total order price after deducting the discounts | | `TotalProductsPriceExcludingVAT` | Decimal | Total products price before discounts (products only) | | `TotalDiscountedProductsPriceExcludingVAT` | Decimal | Total products price after discounts | | `EstimatedShippingCostExcludingVAT` | Decimal | The estimated shipping cost to be subsidised by the merchant | | `CustomerShippingPriceExcludingVAT` | Decimal | The shipping price paid by the customer | | `DutiesAndTaxesExcludingVAT` | Decimal | Duties subsidy discount taken by the Merchant | | `RemoteAreaSurchargeFeeExcludingVAT` | Decimal | Merchant 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. | Property | Type | Description | | - | - | - | | `CustomerTotalPrice` | Decimal | The total price paid for the order by the customer | | `CustomerTotalProductsPrice` | Decimal | The total price paid by the customer for the products (only) | | `CustomerTotalDiscountedProductPrice` | Decimal | The total price of the products after deducting cart and product discounts paid by the customer | | `CustomerShippingPrice` | Decimal | The 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`. | | `CustomerDutiesAndTaxes` | Decimal | The duties paid by the customer, including import duties, taxes, and customs clearance fees \[CCF]). (Only relevant to international transactions outside the EU). | | `CustomerTotalVAT` | Decimal | The total VAT included in the products or shipping sum paid by the customer (EU to EU transactions), if applicable. | | `CustomerShippingVATRate` | Decimal | Shipping VAT rate, if applicable. | | `CustomerUSSalesTax` | Decimal | US sales tax paid by the customer (US customers only, as applicable) | ### Fees The following table lists the fees paid by the customer. | Property | Type | Description | | - | - | - | | `CustomerCCF` | Decimal | Customs clearance fee, if not included in the shipping cost | | `CustomerCODFee` | Decimal | Cash on delivery fee | | `CustomerDangerousGoodsFee` | Decimal | Dangerous goods fee | | `CustomerSizeOverchargeFee` | Decimal | Size overcharge fee | | `CustomerRemoteAreaSurchargeFee` | Decimal | Remote 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. | Property | Type | Description | | - | - | - | | `CustomerTotalPriceInMerchantCurrency` | Decimal | The total price paid for the order by the customer | | `CustomerTotalProductsPriceInMerchantCurrency` | Decimal | The total price paid by the customer for the products (only) | | `CustomerTotalDiscountedProductsPriceInMerchantCurrency` | Decimal | The total price of the products after deducting cart and product discounts paid by the customer | | `CustomerShippingPriceInMerchantCurrency` | Decimal | The total shipping price, after discount, paid by the customerThe shipping price includes all shipping fees levied on the customer, such as `CustomerRemoteAreaSurchargeFeeInMerchantCurrency`. | | `CustomerVATInMerchantCurrency` | Decimal | The total VAT sum paid by the customer | | `CustomerShippingVATRate` | Decimal | Shipping VAT rate | | `CustomerDutiesAndTaxesInMerchantCurrency` | Decimal | The duties paid by the customer. This includes import duties, taxes, and customs clearance fees \[CCF]). (Only relevant to international transactions outside the EU). | | `CustomerUSSalesTaxInMerchantCurrency` | Decimal | US sales tax paid by the customer in Merchant currency | ### Fees The following table details the fees paid by the customer converted to merchant currency. | Property | Type | Description | | - | - | - | | `CustomerCCFInMerchantCurrency` | Decimal | Customer Custom Clearance Fee to be paid by the customer, if not included in the shipping cost | | `CustomerCODFeeInMerchantCurrency` | Decimal | Cash-on-Delivery fee to be paid by the customer | | `CustomerDangerousGoodsFeeInMerchantCurrency` | Decimal | Dangerous goods fee to be paid by the customer | | `CustomerSizeOverchargeFeeInMerchantCurrency` | Decimal | Size overcharge fee to be paid by the customer in the Merchant currency | | `CustomerRemoteAreaSurchargeFeeInMerchantCurrency` | Decimal | Remote area surcharge fee, if not subsidized by the Merchant | ### Product Information | Property | Type | Description | | - | - | - | | `ProductName` | String | The name of the product 2 Pack Regular Fit Checked Easy Iron Shirts | | `ProductURL` | String | URL of the product | | `Categories` | | See [Categories](/client-analytics#categories). | | `Brand` | | See [Brand](/client-analytics#brand) | | `SKU` | String | Product SKU | | `ProductGroupCode` | String | Product Group Code | | `SecondaryProductCode` | String | Secondary Product Code | | `Quantity` | String | Quantity of units | | `CartItemId` | Type | Cart Item ID | | `ProductCouponCodes` | List of strings | Product coupon code If there are multiple coupons, the list of product coupon codes | | `ParentCartItemID` | String | Parent Cart Item ID for product bundles | | `CartItemOptionId` | String | Option Cart Item ID | | `metadata` | | See [Metadata](/client-analytics#metadata) | ### Brand The following table lists brand names and codes received from the cart information. | Property | Type | Description | | - | - | - | | `code` | String | Product brand code | | `name` | String | Product brand name | ### Categories The list of all category names received. > [!NOTE] > > Product categories must be mapped on the Global‑e side or passed by default. Ask Global‑e to perform the mapping. | Property | Type | Description | | - | - | - | | `code` | String | Product category code | | `name` | String | Product category name | ### Metadata Metadata consists of product attributes that can vary for the same SKU; for example, customization such as engraving text. | Property | Type | Description | | - | - | - | | `AttributeKey` | String | Attribute key | | `AttributeValue` | String | Attribute 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. | Property | Type | Description | | - | - | - | | `AttributeCode` | String | Attribute Code | | `AttributeName` | String | Attribute Name - Custom product attribute name that is used to describe the personalised product | | `AttributeTypeCode` | String | Attribute 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. | Property | Type | Description | | - | - | - | | `ListPrice` | Decimal | Product 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. | | `SalePrice` | Decimal | Product 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. | | `TotalPrice` | Decimal | The total price of all units | | `VATRate` | Decimal | The VAT rate for the product, if applicable | | `DiscountedPrice` | Decimal | The 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. | Property | Type | Description | | - | - | - | | `ListPriceExcludingVAT` | Decimal | Product 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. | | `SalePriceExcludingVAT` | Decimal | The price of the sale | | `TotalPriceExcludingVAT` | Decimal | Total price of all units | | `DiscountedPriceExcludingVAT` | Decimal | Discounted price | In the following customer transactions, all prices are in customer currency, according to the values visible on the checkout page. | Property | Type | Description | | - | - | - | | `CustomerListPrice` | Decimal | Product list price | | `CustomerSalePrice` | Decimal | Product selling price | | `CustomerTotalPrice` | Decimal | Total price of all units | | `CustomerVATRate` | Decimal | VAT rate (if applicable) | | `CustomerDiscountedPrice` | Decimal | The discounted price paid by the customer | In the following customer transactions, all prices are in merchant currency. Prices are converted by exchange spot rate. | Property | Type | Description | | - | - | - | | `CustomerListPriceInMerchantCurrency` | Decimal | Product list price converted to merchant currency | | `CustomerSalePriceInMerchantCurrency` | Decimal | Product sale price as visible to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable), and `IncludeVAT` handling. | | `CustomerTotalPriceInMerchantCurrency` | Decimal | Total price of all the units included in the order converted to merchant currency | | `CustomerDiscountedPriceInMerchantCurrency` | Decimal | The 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). | Property | Type | Description | | - | - | - | | `PaymentMethodName` | String | The name of the payment method Example: Standard method: credit card (Visa) Alternative method: PayPal | | `PaymentMethodCode` | String | Payment Method Code | | `PaymentMethodTypeCode` | Numeric | Payment Method Type ID associated with the payment method type: 0 = Undefined 1 = Credit Card 2 = Local Alternative 3 = Global Alternative 4 = Coupon 5 = Credit Card Instalments | | `PaymentMethodTypeName` | String | Payment Method Type Name: Undefined, Credit Card, Local Alternative, Global Alternative, Coupon, Credit Card Instalments | ### Discount Information ### General Discount Information | Property | Type | Description | | - | - | - | | `Description` | String | The discount description | | `DiscountCode` | String | The discount code | | `DiscountTypeId` | Integer long | The cart discount type. Discount related to the amount, coupon, or another promotion value. The [Discount Type Option Values](/client-analytics#discount) table describes one of the following possible values of `DiscountTypeOptions` enumeration denoting a type of discount. See [Discounts - Discount Type Option Values](/client-analytics#discount). | | `DiscountTypeName` | String | Discount type name, such as shipping discount, cart discount, product discount, and more. | | `CouponCode` | String | The coupon code | | `ProductCartItemId` | String | Cart 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 | Property | Type | Description | | - | - | - | | `OriginalDiscountValue` | Decimal | Discount 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. | | `VATRate` | Decimal | The VAT rate applied to this discount (if applicable) | | `LocalVATRate` | Decimal (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. | | `DiscountValue` | Decimal | Discount value as displayed to the customer, after applying country coefficient, FX conversion, and IncludeVAT handling | | `Name` | String | Discount name | | `Description` | String (optional) | Discount textual description | | `CouponCode` | String (optional) | Merchant’s coupon code used for this discount (applicable to coupon-based discounts only) | | `ProductCartItemId` | String (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. | | `DiscountCode` | String (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. | | `LoyaltyVoucherCode` | String (optional) | Code used on the Merchant’s site to identify the loyalty voucher on which this discount is based. | | `DiscountType` | Int64 | The DiscountType Option Value table describes one of the following possible values of DiscountTypeOptions enumeration denoting a type of discount. | ### DiscountType Option Value | DiscountType Value | Name | Description | | - | - | - | | 1 | Cart discount | Discount related to volume, amount, coupon, or another promotion value | | 2 | Shipping discount | Discount aimed at subsidizing 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 at sponsoring taxes & duties pre-paid by the 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 at subsidizing the “Cash on Delivery” fee | | Property | Type | Description | | - | - | - | | `Price` | Decimal | Discount Value | | `vatRate` | Integer | The merchant Local VAT rate | | Property | Type | Description | | - | - | - | | `PriceExcludingVAT` | Decimal | Discount Value | | Property | Type | Description | | - | - | - | | `CustomerPrice` | Decimal | Discount Value | | `CustomerVATRate` | Integer | VAT Amount | ### Customer Transactions in Merchant Currency | Property | Type | Description | | - | - | - | | `customerPriceInMerchantCurrency` | Decimal | The price of the customer discount in customer currency | | `customerVATRate` | Integer | VAT 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. | Method | Type | Description | | - | - | - | | `OrderPaymentMethods` | Array | A list of payment methods used to place the order. | Each payment method contains the following elements. | Property | Type | Description | | - | - | - | | `PaymentMethodId` | Integer | The ID of the payment method in the Global‑e system. | | `PaymentMethodName` | String | The name of the payment method. | | `IsGiftCard` | Boolean | Used by the merchant to identify the gift card payment method. | | `GiftCardFields` | String | Key-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. | | `PaidAmountInCustomertCurrency` | Decimal | The amount paid in customer currency. | | `PaidIAmountnMerchantCurrency` | Decimal | The amount paid in merchant currency, using spot conversion. | | `PaymentMethodTypeCode` | Numeric | Payment Method Type ID associated with the payment method type: 0 = Undefined 1 = Credit Card 2 = Local Alternative 3 = Global Alternative 4 = Coupon 5 = Credit Card Instalments | | `PaymentMethodTypeName` | String | Payment Method Type Name: Undefined, Credit Card, Local Alternative, Global Alternative, Coupon, Credit Card Instalments | ``` "OrderPaymentMethods": [, { "PaymentMethodId": 1, "PaymentMethodName": "Visa", "IsGiftCard": false, "GiftCardFields": "null", "PaidAmountInCustomerCurrency": 388.0, "PaidAmountInMerchantCurrency": 99.0 "PaymentMethodTypeCode": "1" "PaymentMethodTypeName": "Credit Card" }, ] { "PaymentMethodId": 57, "PaymentMethodName": "gift card", "IsGiftCard": true, "GiftCardFields": "[{"FieldApiName":"CardId", "FieldNameResourceId":"checkout.GiftCard.GiftCardId", "FieldValue":"DDB4HB9BDFD466BD","IsId":true}]", "PaidAmountInCustomerCurrency": 388.0, "PaidAmountInMerchantCurrency": 99.0 }, ] ``` ### Global‑e Properties | Property | Type | Description | | - | - | - | | `URL` | String | URL (Store URL) | | `CustomURL` | String | Technical field for Global‑e use; to be disregarded in the merchant implementation. | | `MerchantId` | String | Merchant ID, as registered in the Global‑e system | | `Title` | String | The title of the transaction | | `HostName` | String | The name of the server hosting merchant website | | `CustomHostName` | String | Technical field for Global‑e use; to be disregarded in the merchant implementation. | | `PageType` | Number | Technical field for Global‑e use; to be disregarded in the merchant implementation. | | `CartToken` | String | Cart 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. | | `UrlReferer` | String | The URL of the previous web page from which a link was followed. | | `DoLog` | Boolean | Receives 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* | Property | Merchant Transactions | Merchant Transactions Excluding Local VAT | Customer Transactions | Customer Transactions in Merchant Currency | | - | - | - | - | - | | `EstimatedTotalPrice` | ✓ | ✓ | ✓ | ✓ | | `TotalProductsPrice` | ✓ | ✓ | ✓ | ✓ | | `TotalDiscountedProductsPrice` | ✓ | ✓ | ✓ | ✓ | | `EstimatedShippingCost` | ✓ | ✓ | ✗ | ✗ | | `CustomerShippingPrice` | ✗ | ✓ | ✓ | ✓ | | `ShippingVATRate` | ✓ | ✗ | ✓ | ✓ | | `DutiesAndTaxes` | ✓ | ✓ | ✓ | ✓ | | `TotalVAT` | ✓ | ✗ | ✓ | ✓ | | `RemoteAreaSurchargeFee` | ✓ | ✓ | ✓ | ✓ | | `CCF` | ✗ | ✗ | ✓ | ✓ | | `CODFee` | ✗ | ✗ | ✓ | ✓ | | `DangerousGoodsFee` | ✗ | ✗ | ✓ | ✓ | | `SizeOverchargeFee` | ✗ | ✗ | ✓ | ✓ | *PRODUCT Properties Distribution* | Property | Merchant Transactions | Merchant Transactions Excluding Local VAT | Customer Transactions | Customer Transactions in Merchant Currency | | - | - | - | - | - | | `ListPrice` | ✓ | ✓ | ✓ | ✓ | | `SalePrice` | ✓ | ✓ | ✓ | ✓ | | `DiscountedPrice` | ✓ | ✓ | ✓ | ✓ | | `TotalPrice` | ✓ | ✓ | ✓ | ✓ | | `Markdown` | ✓ | ✓ | ✓ | ✓ | *DISCOUNTS Properties Distribution* | Property | Merchant Transactions | Merchant Transactions Excluding Local VAT | Customer Transactions | Customer 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. ``` { "CustomerCurrencyCode": "ILS", "MerchantCurrencyCode": "GBP", "IsEU": false, "CustomerDetails":{ "MerchantUserId": "null", } "HubCountryCode": "GB", "ProductInformation": [ { "ProductName": "Chiara Neck Pleat Dress", "ProductURL": "https://johndoe.bglobale.de/dress-8070.html", "Categories": [ { "Code": "20", "Name": "Dresses" } ], "Brand": null, "SKU": "AE117botanical22", "ProductGroupCode": "AE117botanical", "SecondaryProductCode": null, "Quantity": "1", "CartItemId": "308588", "ProductCouponCodes": null, "ParentCartItemID": null, "CartItemOptionId": null, "MetaData": null, "ProductAttributes": [ { "AttributeCode": "color", "AttributeName": "Grey", "AttributeTypeCode": "color" }, { "AttributeCode": "size", "AttributeName": "L", "AttributeTypeCode": "size" } ] "ProductPrices": { "MerchantTransaction": { "ListPrice": 199, "SalePrice": 199.14, "TotalPrice": 199.14, "VATRate": 20, "DiscountedPrice": 199.14 }, "MerchantTransactionExcludingLocalVAT": { "ListPriceExcludingVAT": 165.83, "SalePriceExcludingVAT": 165.95, "TotalPriceExcludingVAT": 165.95, "DiscountedPriceExcludingVAT": 165.95 }, "CustomerTransaction": { "CustomerListPrice": 221, "CustomerSalePrice": 221, "CustomerTotalPrice": 221, "CustomerVATRate": 16, "CustomerDiscountedPrice": 221 }, "CustomerTransactionInMerchantCurrency": { "CustomerListPriceInMerchantCurrency": 200.93, "CustomerSalePriceInMerchantCurrency": 200.93, "CustomerTotalPriceInMerchantCurrency": 200.93, "CustomerDiscountedPriceInMerchantCurrency": 200.93 } } } ], "Discounts": [ { "Description": "Shipping discount provided from fixed price range 145943, negative discount provided to the merchant", "DiscountCode": null, "DiscountTypeId": 2, "DiscountTypeName": "Shipping discount", "CouponCode": "", "ProductCartItemId": null, "DiscountPrices": { "MerchantTransaction": { "Price": -3.67, "VATRate": 20 }, "MerchantTransactionExcludingLocalVAT": { "PriceExcludingVAT": -3.06 }, "CustomerTransaction": { "CustomerPrice": -4.212, "CustomerVATRate": 16 }, "CustomerTransactionInMerchantCurrency": { "CustomerPriceInMerchantCurrency": -3.83, "CustomerVATRate": 16 } } } ], "cultureCode": "en-GB", "InitialCheckoutCultureCode": "en-GB", "URL": null, "CustomURL": null, "MerchantID": 101, "Title": "Global‑e Checkout Load Information", "CustomHostName": null, "PageType": 0, "CartToken": "5b29b332-a798-4682-b803-97759753c8d5", "UrlReferer": null "Dolog": false } ``` ### 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. ``` { "OrderID": "GE9580788GB", "ReplacementOrder": false, "CustomerCurrencyCode": "AUD", "MerchantCurrencyCode": "GBP", "IsEU": false, "CustomerDetails": { "ShippingAddress": null, "BillingAddress": null }, "HubCountryCode": "GB", "Region": "Northern Territory", "SiteURL": "https://jdw-sit1.fuelourrocket.com/@@LOCALE@@/", "DutiesGuaranteed": true, "ShippingMethodName": "Skynet", "ShippingMethodType": "Express Courier (Air)", "DeliveryDaysRangeFrom": 4, "DeliveryDaysRangeTo": 6, "OrderPrices": { "MerchantTransaction": { "EstimatedTotalPrice": 445.19, "TotalProductsPrice": 586.5, "TotalDiscountedProductsPrice": 586.5, "EstimatedShippingCost": 19.92, "ShippingVATRate": 0, "DutiesAndTaxes": 121.39, "ProductTotalVAT": 97.74, "TotalVAT": 77.51, "RemoteAreaSurchargeFee": 0 }, "MerchantTransactionExcludingLocalVAT": { "EstimatedTotalPriceExcludingVAT": 367.67, "TotalProductsPriceExcludingVAT": 488.75, "TotalDiscountedProductsPriceExcludingVAT": 488.76, "EstimatedShippingCostExcludingVAT": 19.92, "CustomerShippingPriceExcludingVAT": 0, "DutiesAndTaxesExcludingVAT": 101.16, "RemoteAreaSurchargeFeeExcludingVAT": 0 }, "CustomerTransaction": { "CustomerTotalPrice": 986.3490909090909, "CustomerTotalProductsPrice": 1005, "CustomerTotalDiscountedProductsPrice": 1005, "CustomerShippingPrice": 0, "CustomerDutiesAndTaxes": 0, "CustomerTotalVAT": 72.7, "CustomerShippingVATRate": 0, "CustomerUSSalesTax": 0, "Fees": { "CustomerCCF": 15.06, "CustomerCODFee": 0, "CustomerDangerousGoodsFee": 0, "CustomerSizeOverchargeFee": 0, "CustomerRemoteAreaSurchargeFee": 0 } }, "CustomerTransactionInMerchantCurrency": { "CustomerTotalPriceInMerchantCurrency": 547.41, "CustomerTotalProductsPriceInMerchantCurrency": 557.76, "CustomerTotalDiscountedProductsPriceInMerchantCurrency": 557.76, "CustomerShippingPriceInMerchantCurrency": 0, "CustomerVATInMerchantCurrency": 40.35, "CustomerShippingVATRate": 0, "CustomerDutiesAndTaxesInMerchantCurrency": 0, "CustomerUSSalesTaxInMerchantCurrency": 0, "Fees": { "CustomerCCFInMerchantCurrency": 8.36, "CustomerCODFeeInMerchantCurrency": 0, "CustomerDangerousGoodsFeeInMerchantCurrency": 0, "CustomerSizeOverchargeFeeInMerchantCurrency": 0, "CustomerRemoteAreaSurchargeFeeInMerchantCurrency": 0 } } }, "ProductInformation": [ { "ProductName": "Dress and Jacket", "ProductURL": "/products/joanna-hope-lace-trim-dress-and-jacket-12/p/QT98802", "Categories": null, "Brand": null, "SKU": "QT98802", "ProductGroupCode": "QT988", "SecondaryProductCode": null, "Quantity": "3", "CartItemId": "0", "ProductCouponCodes": null, "ParentCartItemID": null, "CartItemOptionId": null, "MetaData": null, "ProductAttributes": [ { "AttributeCode": "color", "AttributeName": "PINK", "AttributeTypeCode": "color" }, { "AttributeCode": "size", "AttributeName": "12", "AttributeTypeCode": "size" } ], "ProductPrices": { "MerchantTransaction": { "ListPrice": 0, "SalePrice": 195.5, "TotalPrice": 586.5, "VATRate": 20, "DiscountedPrice": 195.5 }, "MerchantTransactionExcludingLocalVAT": { "ListPriceExcludingVAT": 0, "SalePriceExcludingVAT": 162.92, "TotalPriceExcludingVAT": 488.75, "DiscountedPriceExcludingVAT": 162.92 }, "CustomerTransaction": { "CustomerListPrice": 0, "CustomerSalePrice": 335, "CustomerTotalPrice": 1005, "CustomerVATRate": 10, "CustomerDiscountedPrice": 335 }, "CustomerTransactionInMerchantCurrency": { "CustomerListPriceInMerchantCurrency": 0, "CustomerSalePriceInMerchantCurrency": 185.92, "CustomerTotalPriceInMerchantCurrency": 557.76, "CustomerDiscountedPriceInMerchantCurrency": 185.92 } } } ], "PaymentMethods": [ { "PaymentMethodName": "Paypal", "PaymentMethodCode": "4" "PaymentMethodTypeCode": "3", "PaymentMethodTypeName": "Global Alternative" } ], "Discounts": [ { "Description": "Shipping discount provided from fixed price range 148015", "DiscountCode": null, "DiscountTypeId": 2, "DiscountTypeName": "Shipping discount", "CouponCode": "", "ProductCartItemId": null, "DiscountPrices": { "MerchantTransaction": { "Price": 19.92, "VATRate": 0 }, "MerchantTransactionExcludingLocalVAT": { "PriceExcludingVAT": 19.92 }, "CustomerTransaction": { "CustomerPrice": 37.24, "CustomerVATRate": 0 }, "CustomerTransactionInMerchantCurrency": { "CustomerPriceInMerchantCurrency": 20.67, "CustomerVATRate": 0 } } }, { "Description": "Discount generated to discount the DDP", "DiscountCode": "", "DiscountTypeId": 4, "DiscountTypeName": "Taxes Subsidization", "CouponCode": "", "ProductCartItemId": "", "DiscountPrices": { "MerchantTransaction": { "Price": 121.39, "VATRate": 20 }, "MerchantTransactionExcludingLocalVAT": { "PriceExcludingVAT": 101.16 }, "CustomerTransaction": { "CustomerPrice": 220.4216, "CustomerVATRate": 0 }, "CustomerTransactionInMerchantCurrency": { "CustomerPriceInMerchantCurrency": 122.33, "CustomerVATRate": 0 } } } ], "OrderPaymentMethods": [ { "PaymentMethodId": 4, "PaymentMethodName": "Paypal", "IsGiftCard": false, "GiftCardFields": "null", "PaidAmountInCustomerCurrency": 461.25, "PaidAmountInMerchantCurrency": 97.31578659366438, "PaymentMethodTypeCode": "3", "PaymentMethodTypeName": "Global Alternative" } ], "cultureCode": "en-GB", "InitialCheckoutCultureCode": "en-GB", "URL": null, "CustomURL": null, "CheckoutStep": null, "MerchantID": 325, "Title": "Global‑e Order Transaction", "HostName": "https://www2.bglobale.com/", "CustomHostName": null, "PageType": 0, "CartToken": "82dae938-f51d-4bce-878a-6270aa6d82ba", "CountryCode": "AU", "UrlReferer": null, "DoLog": false } ``` ### 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) ``` { "OrderID": "GE3609177US", "ReplacementOrder": false, "CustomerCurrencyCode": "EUR", "MerchantCurrencyCode": "USD", "IsEU": false, "CustomerDetails": { "MerchantUserId": "YoniT123", "ShippingAddress": { "ShippingFirstName": "Yoni", "ShippingLastName": "Test", "ShippingAddress1": "Wolfgang Schussel", "ShippingAddress2": "Liebiggasse 5/1/5", "ShippingCity": "WIEN", "ShippingCountryName": "Austria", "ShippingCountryCode": "AT", "ShippingState": null, "ShippingStateCode": null, "ShippingCompany": null, "ShippingZipCode": "1010", "ShippingPhoneNumber": "0000000000" }, "BillingAddress": { "BillingFirstName": "Yoni", "BillingLastName": "Test", "BillingAddress1": "Wolfgang Schussel", "BillingAddress2": "Liebiggasse 5/1/5", "BillingCity": "WIEN", "BillingCountryName": "Austria", "BillingCountryCode": "AT", "BillingState": null, "BillingStateCode": null, "BillingCompany": null, "BillingZipCode": "1010", "BillingPhoneNumber": "0000000000", "BillingEmail": "J@gmail.com" } }, "HubCountryCode": "US", "Region": null, "SiteURL": "https://www.colehaan.com/", "DutiesGuaranteed": true, "ShippingMethodName": "RRDonnelley DDP", "ShippingMethodType": "Standard Courier", "DeliveryDaysRangeFrom": 9, "DeliveryDaysRangeTo": 13, "OrderPrices": { "MerchantTransaction": { "EstimatedTotalPrice": 138.72, "TotalProductsPrice": 216.89, "TotalDiscountedProductsPrice": 216.89, "EstimatedShippingCost": 14.68, "ShippingVATRate": 0, "DutiesAndTaxes": 63.49, "ProductTotalVAT": 0, "TotalVAT": 0, "RemoteAreaSurchargeFee": 0 }, "MerchantTransactionExcludingLocalVAT": { "EstimatedTotalPriceExcludingVAT": 138.72, "TotalProductsPriceExcludingVAT": 216.89, "TotalDiscountedProductsPriceExcludingVAT": 216.89, "EstimatedShippingCostExcludingVAT": 14.68, "CustomerShippingPriceExcludingVAT": 0, "DutiesAndTaxesExcludingVAT": 63.49, "RemoteAreaSurchargeFeeExcludingVAT": 0 }, "CustomerTransaction": { "CustomerTotalPrice": 195, "CustomerTotalProductsPrice": 195, "CustomerTotalDiscountedProductsPrice": 195, "CustomerShippingPrice": 0, "CustomerDutiesAndTaxes": 0, "CustomerTotalVAT": 0, "CustomerShippingVATRate": 0, "CustomerUSSalesTax": 0, "Fees": { "CustomerCCF": 0, "CustomerCODFee": 0, "CustomerDangerousGoodsFee": 0, "CustomerSizeOverchargeFee": 0, "CustomerRemoteAreaSurchargeFee": 0 } }, "CustomerTransactionInMerchantCurrency": { "CustomerTotalPriceInMerchantCurrency": 229.44, "CustomerTotalProductsPriceInMerchantCurrency": 229.44, "CustomerTotalDiscountedProductsPriceInMerchantCurrency": 229.44, "CustomerShippingPriceInMerchantCurrency": 0, "CustomerVATInMerchantCurrency": 0, "CustomerShippingVATRate": 0, "CustomerDutiesAndTaxesInMerchantCurrency": 0, "CustomerUSSalesTaxInMerchantCurrency": 0, "Fees": { "CustomerCCFInMerchantCurrency": 0, "CustomerCODFeeInMerchantCurrency": 0, "CustomerDangerousGoodsFeeInMerchantCurrency": 0, "CustomerSizeOverchargeFeeInMerchantCurrency": 0, "CustomerRemoteAreaSurchargeFeeInMerchantCurrency": 0 } } }, "ProductInformation": [ { "ProductName": "ZERØGRAND Wingtip Oxford", "ProductURL": "https://staging-web-colehaan.demandware.net/s/ColeHaan_US/zerogrand-wingtip-oxford-ironstone-stitchlite-ivory/190595232037.html", "Categories": null, "Brand": null, "SKU": "190595232037", "ProductGroupCode": "C24944", "SecondaryProductCode": null, "Quantity": "1", "CartItemId": "1", "ProductCouponCodes": null, "ParentCartItemID": null, "CartItemOptionId": null, "MetaData": [ { "AttributeKey": "StyleID", "AttributeValue": "C24944" }, { "AttributeKey": "color", "AttributeValue": "Ironstone Stitchlite™-Ivory" }, { "AttributeKey": "width", "AttributeValue": "M" }, { "AttributeKey": "size", "AttributeValue": "7.5" } ], "ProductAttributes": [ { "AttributeCode": "Ironstone Stitchlite™-Ivory", "AttributeName": "Ironstone Stitchlite™-Ivory", "AttributeTypeCode": "color" }, { "AttributeCode": "M", "AttributeName": "M", "AttributeTypeCode": "width" }, { "AttributeCode": "7.5", "AttributeName": "7.5", "AttributeTypeCode": "size" }, { "AttributeCode": "C24944", "AttributeName": "C24944", "AttributeTypeCode": "style" } ], "ProductPrices": { "MerchantTransaction": { "ListPrice": 216.89, "SalePrice": 216.89, "TotalPrice": 216.89, "VATRate": 0, "DiscountedPrice": 216.89 }, "MerchantTransactionExcludingLocalVAT": { "ListPriceExcludingVAT": 216.89, "SalePriceExcludingVAT": 216.89, "TotalPriceExcludingVAT": 216.89, "DiscountedPriceExcludingVAT": 216.89 }, "CustomerTransaction": { "CustomerListPrice": 195, "CustomerSalePrice": 195, "CustomerTotalPrice": 195, "CustomerVATRate": 0, "CustomerDiscountedPrice": 195 }, "CustomerTransactionInMerchantCurrency": { "CustomerListPriceInMerchantCurrency": 229.44, "CustomerSalePriceInMerchantCurrency": 229.44, "CustomerTotalPriceInMerchantCurrency": 229.44, "CustomerDiscountedPriceInMerchantCurrency": 229.44 } } } ], "PaymentMethods": [ { "PaymentMethodName": "Visa", "PaymentMethodCode": "1", "PaymentMethodTypeCode": "1", "PaymentMethodTypeName": "Credit Card" } ], "Discounts": [ { "Description": "Shipping discount provided from fixed price range 329236", "DiscountCode": null, "DiscountTypeId": 2, "DiscountTypeName": "Shipping discount", "CouponCode": "", "ProductCartItemId": null, "DiscountPrices": { "MerchantTransaction": { "Price": 14.68, "VATRate": 0 }, "MerchantTransactionExcludingLocalVAT": { "PriceExcludingVAT": 14.68 }, "CustomerTransaction": { "CustomerPrice": 13.2, "CustomerVATRate": 0 }, "CustomerTransactionInMerchantCurrency": { "CustomerPriceInMerchantCurrency": 15.53, "CustomerVATRate": 0 } } }, { "Description": "Discount generated to discount the DDP", "DiscountCode": "", "DiscountTypeId": 4, "DiscountTypeName": "Taxes Subsidization", "CouponCode": "", "ProductCartItemId": "", "DiscountPrices": { "MerchantTransaction": { "Price": 63.49, "VATRate": 0 }, "MerchantTransactionExcludingLocalVAT": { "PriceExcludingVAT": 63.49 }, "CustomerTransaction": { "CustomerPrice": 55.99, "CustomerVATRate": 0 }, "CustomerTransactionInMerchantCurrency": { "CustomerPriceInMerchantCurrency": 65.88, "CustomerVATRate": 0 } } } ], "OrderPaymentMethods": [ { "PaymentMethodId": 1, "PaymentMethodName": "Visa", "IsGiftCard": false, "GiftCardFields": "null", "PaidAmountInCustomerCurrency": 461.25, "PaidAmountInMerchantCurrency": 97.31578659366438 "PaymentMethodTypeCode": "1", "PaymentMethodTypeName": "Credit Card" } ] "cultureCode": "en-GB", "InitialCheckoutCultureCode": "en-GB", "URL": null, "CustomURL": null, "CheckoutStep": null, "MerchantID": 575, "Title": "Global-e Order Transaction", "HostName": "https://www2.bglobale.com/", "CustomHostName": null, "PageType": 0, "CartToken": "1efcabe4-b5bf-47ef-ba28-37adb5f34407", "CountryCode": "AT", "UrlReferer": null, "DoLog": false } ``` ### 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). ``` { "OrderID": "GE3593948US", "ReplacementOrder": false, "CustomerCurrencyCode": "EUR", "MerchantCurrencyCode": "USD", "IsEU": false, "CustomerDetails": { "MerchantUserId": "VCustomer123", "ShippingAddress": { "ShippingFirstName": "Valued", "ShippingLastName": "Customer", "ShippingAddress1": "Basel 25", "ShippingAddress2": "", "ShippingCity": "Petah tikva", "ShippingCountryName": null, "ShippingCountryCode": null, "ShippingState": null, "ShippingStateCode": null, "ShippingCompany": "Global‑e", "ShippingZipCode": "49510", "ShippingPhoneNumber": "0732041382" }, "BillingAddress": { "BillingFirstName": "Valued", "BillingLastName": "Customer", "BillingAddress1": "Basel 25", "BillingAddress2": "", "BillingCity": "Petah tikva", "BillingCountryName": null, "BillingCountryCode": null, "BillingState": null, "BillingStateCode": null, "BillingCompany": "Global‑e", "BillingZipCode": "49510", "BillingPhoneNumber": "0732041382", "BillingEmail": "info@global-e.com" } }, "HubCountryCode": "US", "Region": null, "SiteURL": "https://dev05-store-modcloth.demandware.net/s/modcloth/home", "DutiesGuaranteed": true, "ShippingMethodName": "RRDonnelley DDP", "ShippingMethodType": "Tracked Post", "DeliveryDaysRangeFrom": 6, "DeliveryDaysRangeTo": 10, "OrderPrices": { "MerchantTransaction": { "EstimatedTotalPrice": 51.14, "TotalProductsPrice": 56.18, "TotalDiscountedProductsPrice": 56.18, "EstimatedShippingCost": 5.04, "ShippingVATRate": 0, "DutiesAndTaxes": 0, "ProductTotalVAT": 0, "TotalVAT": 0, "RemoteAreaSurchargeFee": 0 }, "MerchantTransactionExcludingLocalVAT": { "EstimatedTotalPriceExcludingVAT": 51.14, "TotalProductsPriceExcludingVAT": 56.18, "TotalDiscountedProductsPriceExcludingVAT": 56.18, "EstimatedShippingCostExcludingVAT": 5.04, "CustomerShippingPriceExcludingVAT": 5.55, "DutiesAndTaxesExcludingVAT": 0, "RemoteAreaSurchargeFeeExcludingVAT": 0 }, "CustomerTransaction": { "CustomerTotalPrice": 69.06, "CustomerTotalProductsPrice": 52, "CustomerTotalDiscountedProductsPrice": 52, "CustomerShippingPrice": 5.55, "CustomerDutiesAndTaxes": 11.51, "CustomerTotalVAT": 0, "CustomerShippingVATRate": 0, "CustomerUSSalesTax": 0, "Fees": { "CustomerCCF": 0, "CustomerCODFee": 0, "CustomerDangerousGoodsFee": 0, "CustomerSizeOverchargeFee": 0, "CustomerRemoteAreaSurchargeFee": 0 } }, "CustomerTransactionInMerchantCurrency": { "CustomerTotalPriceInMerchantCurrency": 81.26, "CustomerTotalProductsPriceInMerchantCurrency": 61.18, "CustomerTotalDiscountedProductsPriceInMerchantCurrency": 61.18, "CustomerShippingPriceInMerchantCurrency": 6.53, "CustomerVATInMerchantCurrency": 0, "CustomerShippingVATRate": 0, "CustomerDutiesAndTaxesInMerchantCurrency": 13.54, "CustomerUSSalesTaxInMerchantCurrency": 0, "Fees": { "CustomerCCFInMerchantCurrency": 0, "CustomerCODFeeInMerchantCurrency": 0, "CustomerDangerousGoodsFeeInMerchantCurrency": 0, "CustomerSizeOverchargeFeeInMerchantCurrency": 0, "CustomerRemoteAreaSurchargeFeeInMerchantCurrency": 0 } } }, "ProductInformation": [ { "ProductName": "In Knit to Win It Cotton Cardigan in L/XL", "ProductURL": "shop/tops/modcloth-in-knit-to-win-it-cotton-cardigan-in-ivory", "Categories": null, "Brand": null, "SKU": "100000370403", "ProductGroupCode": "10126810", "SecondaryProductCode": null, "Quantity": "1", "CartItemId": "1", "ProductCouponCodes": null, "ParentCartItemID": null, "CartItemOptionId": null, "MetaData": null, "ProductAttributes": [ { "AttributeCode": "WHT", "AttributeName": "White", "AttributeTypeCode": "colour" }, { "AttributeCode": "L/XL", "AttributeName": "L/XL", "AttributeTypeCode": "size" }, { "AttributeCode": "ModCloth", "AttributeName": "ModCloth", "AttributeTypeCode": "brand" } ], "ProductPrices": { "MerchantTransaction": { "ListPrice": 56.18, "SalePrice": 56.18, "TotalPrice": 56.18, "VATRate": 0, "DiscountedPrice": 56.18 }, "MerchantTransactionExcludingLocalVAT": { "ListPriceExcludingVAT": 56.18, "SalePriceExcludingVAT": 56.18, "TotalPriceExcludingVAT": 56.18, "DiscountedPriceExcludingVAT": 56.18 }, "CustomerTransaction": { "CustomerListPrice": 52, "CustomerSalePrice": 52, "CustomerTotalPrice": 52, "CustomerVATRate": 0, "CustomerDiscountedPrice": 52 }, "CustomerTransactionInMerchantCurrency": { "CustomerListPriceInMerchantCurrency": 61.18, "CustomerSalePriceInMerchantCurrency": 61.18, "CustomerTotalPriceInMerchantCurrency": 61.18, "CustomerDiscountedPriceInMerchantCurrency": 61.18 } } } ], "PaymentMethods": [ { "PaymentMethodName": "Paypal", "PaymentMethodCode": "4", "PaymentMethodTypeCode": "3", "PaymentMethodTypeName": "Global Alternative" } ], "Discounts": [ { "Description": "Shipping discount provided from fixed price range 256683", "DiscountCode": null, "DiscountTypeId": 2, "DiscountTypeName": "Shipping discount", "CouponCode": "", "ProductCartItemId": null, "DiscountPrices": { "MerchantTransaction": { "Price": 5.04, "VATRate": 0 }, "MerchantTransactionExcludingLocalVAT": { "PriceExcludingVAT": 5.04 }, "CustomerTransaction": { "CustomerPrice": 4.67, "CustomerVATRate": 0 }, "CustomerTransactionInMerchantCurrency": { "CustomerPriceInMerchantCurrency": 5.49, "CustomerVATRate": 0 } } } ], "OrderPaymentMethods": [ { "PaymentMethodId": 4, "PaymentMethodName": "Paypal", "IsGiftCard": false, "GiftCardFields": "null", "PaidAmountInCustomerCurrency": 461.25, "PaidAmountInMerchantCurrency": 97.31578659366438, "PaymentMethodTypeCode": "3", "PaymentMethodTypeName": "Global Alternative" } ] "cultureCode": "en-GB", "InitialCheckoutCultureCode": "en-GB", "URL": null, "CustomURL": null, "CheckoutStep": null, "MerchantID": 506, "Title": "Global‑e Order Transaction", "HostName": "https://www2.bglobale.com/", "CustomHostName": null, "PageType": 0, "CartToken": "2cea3b52-08aa-46dd-9d0f-5a663305149c", "CountryCode": "AT", "UrlReferer": null, "DoLog": false } ``` ### 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 ``` { "OrderID": "GE103831808GB", "ReplacementOrder": false, "CustomerCurrencyCode": "EUR", "MerchantCurrencyCode": "GBP", "IsEU": true, "CustomerDetails": { "MerchantUserId": "IvanT123", "ShippingAddress": { "ShippingFirstName": "Ivan", "ShippingLastName": "Test", "ShippingAddress1": "Germany, Rontgenstr. 9", "ShippingAddress2": null, "ShippingCity": "Maxdorf", "ShippingCountryName": "Germany", "ShippingCountryCode": "DE", "ShippingState": null, "ShippingStateCode": null, "ShippingCompany": "Israel", "ShippingZipCode": "6713333", "ShippingPhoneNumber": "0000000000" }, "BillingAddress": { "BillingFirstName": "Ivan", "BillingLastName": "Test", "BillingAddress1": "Germany, Rontgenstr. 9", "BillingAddress2": null, "BillingCity": "Maxdorf", "BillingCountryName": "Germany", "BillingCountryCode": "DE", "BillingState": null, "BillingStateCode": null, "BillingCompany": "Israel", "BillingZipCode": "6713333", "BillingPhoneNumber": "0000000000", "BillingEmail": "customer@example.com" } }, "HubCountryCode": "GB", "Region": null, "SiteURL": "https://anna.bglobale.de/", "DutiesGuaranteed": false, "ShippingMethodName": "DHL Road", "ShippingMethodType": "Standard Courier", "DeliveryDaysRangeFrom": 4, "DeliveryDaysRangeTo": 5, "OrderPrices": { "MerchantTransaction": { "EstimatedTotalPrice": 202.81, "TotalProductsPrice": 199.14, "TotalDiscountedProductsPrice": 199.14, "EstimatedShippingCost": -3.67, "ShippingVATRate": 20, "DutiesAndTaxes": 0, "ProductTotalVAT": 33.19, "TotalVAT": 33.8, "RemoteAreaSurchargeFee": 0 }, "MerchantTransactionExcludingLocalVAT": { "EstimatedTotalPriceExcludingVAT": 169.01, "TotalProductsPriceExcludingVAT": 165.95, "TotalDiscountedProductsPriceExcludingVAT": 165.95, "EstimatedShippingCostExcludingVAT": -3.06, "CustomerShippingPriceExcludingVAT": 12.93, "DutiesAndTaxesExcludingVAT": 0, "RemoteAreaSurchargeFeeExcludingVAT": 0 }, "CustomerTransaction": { "CustomerTotalPrice": 236, "CustomerTotalProductsPrice": 221, "CustomerTotalDiscountedProductsPrice": 221, "CustomerShippingPrice": 15, "CustomerDutiesAndTaxes": 0, "CustomerTotalVAT": 32.55, "CustomerShippingVATRate": 16, "CustomerUSSalesTax": 0, "Fees": { "CustomerCCF": 0, "CustomerCODFee": 0, "CustomerDangerousGoodsFee": 0, "CustomerSizeOverchargeFee": 0, "CustomerRemoteAreaSurchargeFee": 0 } }, "CustomerTransactionInMerchantCurrency": { "CustomerTotalPriceInMerchantCurrency": 214.57, "CustomerTotalProductsPriceInMerchantCurrency": 200.93, "CustomerTotalDiscountedProductsPriceInMerchantCurrency": 200.93, "CustomerShippingPriceInMerchantCurrency": 13.64, "CustomerVATInMerchantCurrency": 29.59, "CustomerShippingVATRate": 16, "CustomerDutiesAndTaxesInMerchantCurrency": 0, "CustomerUSSalesTaxInMerchantCurrency": 0, "Fees": { "CustomerCCFInMerchantCurrency": 0, "CustomerCODFeeInMerchantCurrency": 0, "CustomerDangerousGoodsFeeInMerchantCurrency": 0, "CustomerSizeOverchargeFeeInMerchantCurrency": 0, "CustomerRemoteAreaSurchargeFeeInMerchantCurrency": 0 } } }, "ProductInformation": [ { "ProductName": "Chiara Neck Pleat Dress", "ProductURL": "https://johndoe.bglobale.de/chiara-neck-pleat-dress-8070.html", "Categories": [ { "Code": "20", "Name": "Dresses" } ], "Brand": null, "SKU": "AE117botanical22", "ProductGroupCode": "AE117botanical", "SecondaryProductCode": null, "Quantity": "1", "CartItemId": "308588", "ProductCouponCodes": null, "ParentCartItemID": null, "CartItemOptionId": null, "MetaData": null, "ProductAttributes": null, "ProductPrices": { "MerchantTransaction": { "ListPrice": 199, "SalePrice": 199.14, "TotalPrice": 199.14, "VATRate": 20, "DiscountedPrice": 199.14 }, "MerchantTransactionExcludingLocalVAT": { "ListPriceExcludingVAT": 165.83, "SalePriceExcludingVAT": 165.95, "TotalPriceExcludingVAT": 165.95, "DiscountedPriceExcludingVAT": 165.95 }, "CustomerTransaction": { "CustomerListPrice": 221, "CustomerSalePrice": 221, "CustomerTotalPrice": 221, "CustomerVATRate": 16, "CustomerDiscountedPrice": 221 }, "CustomerTransactionInMerchantCurrency": { "CustomerListPriceInMerchantCurrency": 200.93, "CustomerSalePriceInMerchantCurrency": 200.93, "CustomerTotalPriceInMerchantCurrency": 200.93, "CustomerDiscountedPriceInMerchantCurrency": 200.93 } } } ], "PaymentMethods": [ { "PaymentMethodName": "Visa", "PaymentMethodCode": "1", "PaymentMethodTypeCode": "1", "PaymentMethodTypeName": "Credit Card" } ], "Discounts": [ { "Description": "Shipping discount provided from fixed price range 145943, negative discount provided to the merchant", "DiscountCode": null, "DiscountTypeId": 2, "DiscountTypeName": "Shipping discount", "CouponCode": "", "ProductCartItemId": null, "DiscountPrices": { "MerchantTransaction": { "Price": -3.67, "VATRate": 20 }, "MerchantTransactionExcludingLocalVAT": { "PriceExcludingVAT": -3.06 }, "CustomerTransaction": { "CustomerPrice": -4.212, "CustomerVATRate": 16 }, "CustomerTransactionInMerchantCurrency": { "CustomerPriceInMerchantCurrency": -3.83, "CustomerVATRate": 16 } } } ], "OrderPaymentMethods": [ { "PaymentMethodId": 1, "PaymentMethodName": "Visa", "IsGiftCard": false, "GiftCardFields": "null", "PaidAmountInCustomerCurrency": 461.25, "PaidAmountInMerchantCurrency": 97.31578659366438, "PaymentMethodTypeCode": "1", "PaymentMethodTypeName": "Credit Card" } ], "cultureCode": "en-GB", "InitialCheckoutCultureCode": "en-GB", "URL": null, "CustomURL": null, "CheckoutStep": null, "MerchantID": 101, "Title": "Global‑e Order Transaction", "HostName": "https://qa.bglobale.com/", "CustomHostName": null, "PageType": 0, "CartToken": "5b29b332-a798-4682-b803-97759753c8d5", "CountryCode": "DE", "UrlReferer": null } ``` ## Marketing Pixels 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 section. 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** The following code snippet presents the subscription to the `OnCheckoutStepLoaded` callback function. Note that this code currently does not contain any pixels. The `data.Steps.LOADED` case is executed when the Global‑e checkout has been **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. 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 [Examples](/client-analytics#examples) for an example. Use the relevant [data object variables](/client-analytics#common-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. | **Platform** | **Event** | **Example** | | - | - | - | | Google Tag Manager (Data Layer) | `Purchase` Event | [Example: GTM Tag Manager](/client-analytics#analytics-implementation-and-mapping-to-analytics) | | Google Ads (gtag) | `Conversion` Event | [Google Ads (gtag) - Conversion Event](/client-analytics#google-ads-gtag-conversion-event) | | TikTok | `PlaceAnOrder` Event | [TikTok - PlaceAnOrder Event](/client-analytics#tiktok-placeanorder-event) | 2. **Place the Final `OnCheckoutStepLoaded` Callback on your Site** Add the final `OnCheckoutStepLoaded` callback function to every page of your online 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 Definition** | **Variable JSON Path** | | - | - | | Global‑e Order Id | `data.details.OrderID` | | The merchant currency: The Store currency | `data.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 quantity | `data.details.ProductInformation[i].Quantity` | | Single product SKU | `data.details.ProductInformation[i].SKU` | See [Order Transaction Analytics Object Overview](/client-analytics#order-transaction-analytics-object-overview) for the complete list of variables. ### Google Ads (gtag) - Conversion Event ``` ``` ### TikTok - PlaceAnOrder Event ``` ``` ## 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. ``` window['GlobalE_Prices_Conversion_Complete'] = function() { console.log('GE prices conversion complete')}; ``` # Global-e SFCC Client JS SDK, Popups, Free Shipping Banner and Checkout Source: https://docs.global-e.com/client-js-sdk-sfcc Load the Global-e Client JS SDK on every storefront page. It drives the Welcome pop-up, standard Country Switcher, Checkout iframe, and Client-side analytics. **Related:** [Customization](/customization-sfcc) · [Configuration](/configuration-sfcc) · [Checkout flow](/checkout-flow-sfcc) · [Session attributes](/session-attributes-sfcc) Any Global-e function, which is defined in Client JS SDK can be called (executed) only when the Client JS SDK itself is loaded and the following JavaScript functions are triggered: **How the cartridge initializes the SDK:** the cartridge loads the SDK script and configures it in `int_globale_{architecture}/cartridge/client/default/js/geScriptLoader.js` using server-rendered values exposed on `window.geScriptLoaderData`. The key calls are: ```javascript theme={null} GlobalE.ScriptsURL(window.geScriptLoaderData.clientJsDomain); // e.g. https://www2.bglobale.com GlobalE.SetCookieDomain(window.geScriptLoaderData.cookieDomain); // e.g. www.site.com ``` The values come from the server (`Globale-ScriptLoaderData`), so you normally do not hard-code the hostname or cookie domain. Other SDK methods such as `GlobalE.SetMerchantParameters({...})` belong to the external Global-e Client SDK API and are **not** invoked by the SFCC cartridge. More details about the Global-e Client JS SDK, available commands and functions are in the [Global-e Client SDK online document](https://web.global-e.com/merchant/clientapi). > [!NOTE] > > In the paths below, `{architecture}` is `sfra` or `sitegenesis` (or the matching `*_popups` cartridge). The **headless** cartridge uses `int_globale_headless/cartridge/client/default/js/globaleClientScripts.js` for the same SDK calls and does not ship the SFRA/SiteGenesis `iframe.isml` checkout template (headless checkout is rendered by the PWA/front end). ## Global-e Welcome pop up The Welcome pop-up for international customers can be integrated with two ways: * **Standard** - Global-e Client JS SDK will show the welcome pop-up (enabled by default), based on the configuration made on the Global-e side, only for Global-e operated countries.\ The layout, look & feel and other elements of the Standard Global-e welcome pop-up is configured on the Global-e side and will be applied on the merchant storefront by Global-e Client JS SDK automatically.\ Standard Global-e welcome pop-up can be initialized by executing the JavaScript function: ```javascript theme={null} GlobalE.LoadWelcome("US", "en-US", "USD"); ``` It is triggered in int_globale\_\{architecture}/cartridge/client/default/js/geScriptLoader.js file. * **Custom** - You are fully free to implement your own custom Welcome pop-up using standard SFCC content slots/assets, templates and any other components.\ The Standard Global-e welcome pop-up should be disabled on the Global-e side. ## Global-e Country Switcher If you want to use the Standard Global-e Country Switcher (enabled by default) - you don't have to do anything on your platform, it is already available in our cartridge.\ You need only to provide the requirements and design of your Country Switcher to your Global-e Project/Account manager and it will be configured on the Global-e side only.\ Once the predefined event (by default defined in int_globale\_\{architecture}/cartridge/client/default/js/geScriptLoader.js) is triggered on your storefront - Global-e Client JS SDK will show the Country Switcher pop-up.\ Once the customer has selected Country/Currency and clicked on Save/Submit button - the Country Switcher pop up will be closed and the page will be refreshed staying on the same URL or redirecting to the predefined Site URL to the selected Country (if it's configured so). You can change the look & feel of the Standard Global-e Country Switcher by providing your design (HTML CSS and JS) to your Global-e Account/Project Manager.\ The Global-e country switcher can be styled according to your designs. Standard Global-e Country Switcher can be initialized by executing the JavaScript function: ```javascript theme={null} GlobalE.LoadShippingSwitcher("US", "en-US", "USD", false); ``` The SFRA cartridge may pass an optional fifth argument (callback handler). Calls are triggered from `int_globale_{architecture}/cartridge/client/default/js/geScriptLoader.js`. Global-e cartridges allow: 1. Display Global-e country switcher on SFCC sites operated and not operated by Global-e.\ On non-operated SFCC sites you can display the Global-e country switcher by adding `int_globale_sfra_popups` or `int_globale_sitegenesis_popups`, which contain a simple version of the Global-e integration used only for displaying the country switcher. 2. Redirect to the same page in the scope of one site or across different SFCC sites.\ In the current context 'redirect' means in case of the changing country/language/currency.\ The redirect works properly only if at the end of the site’s path is existed action/page location (for example homepage, cartpage, etc.) 3. Define allowed/disallowed countries for the site.\ Global-e country switcher allows defining allowed/disallowed countries for the site.\ For disallowed countries as a fallback will be preselected site default country. 4. Define allowed/disallowed countries for the locale.\ Global-e country switcher allows defining allowed/disallowed countries for the locale.\ For disallowed countries as a fallback will be preselected site default country. 5. Define only one allowed country for the locale.\ Makes sense to use only if each country has its own locale. 6. Use different domains across SFCC sites and set the correct country during redirection. 7. Use language selector for countries.\ Global-e country switcher allows using multiple languages in the scope of one country. 8. Set the right language of the welcome popup depending on the selected language in the selector. ### Installation of Global-e country switcher on non-operated SFCC sites For sites that only need the Welcome pop-up and Country Switcher (no full Global-e checkout), use the popups cartridges — see [Cartridges](/cartridges-sfcc) and [Installation](/installation-sfcc): | Architecture | Cartridges | | - | - | | SFRA | `int_globale` + `int_globale_sfra_popups` | | SiteGenesis | `int_globale` + `int_globale_sitegenesis_popups` | Upload both cartridges, import metadata, add them to the site cartridge path (**popups extension before `int_globale`**), then configure site preferences and run **GlobaleSettings** — details in [Configuration](/configuration-sfcc). Required site preferences (Merchant Tools → Site Preferences → **GLOBALE**): Global-e Enabled, Global-e API URL, Client JS Merchant ID, Merchant GUID, plus any mandatory fields required to save changes. Shipping switcher layout is configured on the Global-e side with your project team. The default implementation of the Global-e country switcher works out of the box with Global-e cartridges.\ The selected country is determined and set in the SFCC backend. In `int_globale_{architecture}/cartridge/client/default/js/geScriptLoader.js`, logic can show the country switcher once when geolocation country differs from the selected country. ## Custom Country Switcher ### Country list The list of all available Countries for the Merchant can be obtained from GLOBALE_COUNTRIES Custom Object.\ Each Global-e Country: * is an instance of Country configured on the Global-e side, and stored into GLOBALE_COUNTRIES Custom Object by running scheduled GlobaleSettings Job * has Name ("name" \{string} custom attribute of Custom Object) * has ISO2 Country Code ("code" \{string} custom attribute of Custom Object) * can be operated/non-operated by Global-e ("isOperatedByGlobalE" \{boolean} custom attribute of Custom Object) * has default ISO3 Currency Code ("defaultCurrencyCode" \{string} custom attribute of Custom Object) * can have a Site URL, where the customer should be redirected to if the customer selects this country ("siteUrl" \{string|null} custom attribute of Custom Object) ### Country Site redirect URL The Site URL on the Global-e side for each operated or non-operated country (present in the Country Switcher) can be empty, set as a string (static URL) or special format, which should be used on the SFCC side for generating the real static URL.\ If it's empty (or not set) - the customer will not be redirected to any custom Site URL, the page will be just refreshed and the customer will stay on the same page with the same URL parameters.\ If it's set as a string (static URL) - it should contain http(s):// or [www](http://www). in it, so the script in the int_globale cartridge will properly identify it. In this case, the customer will be redirected to the URL specified for this country.\ If it's set in the special format "**action|SiteID|locale\[|hostName|\[URLParameters]]**" - the end Site URL should be first generated by Salesforce B2C Commerce Digital (by default in int_globale cartridge), returned to front-end and then used as the final Site redirect URL.\ Here are the parameters of the special Site URL format: * **action** - standard SFCC action (i.e. "Home-Show") * **SiteID** (optional) - standard SFCC Site ID (i.e. "RefArch"). If present - will be used to replace the Site ID in the URL. * **locale** - standard SFCC request locale (i.e. "en_US") * **hostName** (optional) - the host which is different from the main host of the current storefront. Must be defined properly in SFCC BM for any available Site, otherwise, it won't work. If present - will be used to replace the current storefront host in the URL. * **URLParameters** (optional) - any additional URL parameters denoted by vertical line ("|") which should be passed to the end Site URL, in format parameter1=value1|parameter2=value2|...|parameterN=valueN. If present - will be added as additional URL parameters to the final Site redirect URL. For example, the following Site URL (configured on the Global-e side for selected Country) "Home-Show|RefArch|en_US|demo.merchant.com|source=12345678" will be parsed and generated to the "[https://demo.merchant.com/s/RefArch/home?source=12345678](https://demo.merchant.com/s/RefArch/home?source=12345678)" final Site redirect URL. ### Currency list The list of all supported by Global-e Currencies can be obtained from GLOBALE_CURRENCIES Custom Object.\ Each Global-e Currency: * is an instance of Currency configured on the Global-e side, and stored into GLOBALE_CURRENCIES Custom Object by running scheduled GlobaleSettings Job * has Name ("name" \{string} custom attribute of Custom Object) * has ISO3 Currency Code ("code" \{string} custom attribute of Custom Object) * has Currency Symbol ("symbol" \{string} custom attribute of Custom Object) * has Max Decimal Places ("maxDecimalPlaces" \{int} custom attribute of Custom Object) ## Global-e Free Shipping Banner Free shipping promotions for Global-e operated countries are managed on the Global-e platform and can be configured for each country individually.  Allow us to display a free shipping promotion banner on your site by adding the container below either directly to your header template or via a content slot. Please note that if you choose to add it via the content slot, this content slot needs to be configured and active at all times.   ```
``` ## Global-e Checkout Global-e Checkout loads in an iframe within the standard SFCC container (default template `int_globale_{architecture}/cartridge/templates/default/globale/checkout/iframe.isml`). See [Checkout flow](/checkout-flow-sfcc). ```javascript theme={null} GlobalE.Checkout("cart_token", "id_wrapper_tag"); ``` ## Checkout Analytics Data Implementation Once a customer started the Global-e checkout flow, Global-e Client JS SDK will notify the client (customer browser parent window from Global-e Checkout iframe) on every step loaded via triggering a JavaScript event. For some steps, basket/order data is passed to the handler. By default, the **OnCheckoutStepLoaded** event will be triggered twice, once for the initial checkout page load and the second time for the checkout confirmation page. Please note that when **OnCheckoutStepLoaded** is triggered on the Global-e checkout confirmation page, the SFCC order may not yet be created.\ Therefore, it is crucial to work with and retrieve all necessary details/info from the input **data** object, which is passed as an argument to **OnCheckoutStepLoaded**. Here is the example of how the Checkout Analytics Data can be integrated into your int_globale\_\{extension}/cartridge/client/default/js/geScriptLoader.js: ```javascript theme={null} /** * Handler function of 'GlobalE.OnCheckoutStepLoadedHandler' event * @param {Object} data - Event data */ GeScriptLoader.prototype.onCheckoutStepLoadedHandler = function (data) { try { if (data.StepId === data.Steps.CONFIRMATION) { // stop sending keepAlive ajax call if (('globaleKeepAlive' in window) && window.globaleKeepAlive) { clearInterval(window.globaleKeepAlive); } } /** * If you need to implement the frontend analytics please put it here */ /** * Only for Backend Analytics, like standard SFCC Merchant Tools / Analytics / Purchase Reports. * Should be handled in Globale-Analytics controller */ var geIframe = document.querySelector('#gle_iframe'); Helpers.makeJsonAjaxCall(geIframe.dataset.analyticsUrl, 'POST', JSON.stringify(data)) .then(function (response) { // eslint-disable-line no-unused-vars // handle response }) .catch(function (e) { console.warn(e); // eslint-disable-line no-console }); } catch (e) { console.warn(e); // eslint-disable-line no-console } }; ``` More information could be found in this [article](https://docs.global-e.com/enterprise/en/analytics-and-marketing.html). # Client-Side Analytics Source: https://docs.global-e.com/client-side-analytics Global-e Module, along with the Global-e Client SDK, allows for easy integration of any analytics framework, such as Google Analytics. This is done by intercepting an event that the Global-e checkout fires at the end of the checkout process (see Client-side events section above). Global-e passes all order information to this event, allowing the merchant to take this information and push it to an analytics system of its choice. For more information, refer to the Global-e Client SDK documentation [Client analytics](/client-analytics) # Client Side Events Source: https://docs.global-e.com/client-side-events Global‑e Client SDK fires various client events that can be handled by the merchant. For example, `OnBeforeWelcome` event is fired just before Global‑e “welcome” popup is displayed and allows embedding merchant-defined dynamic content to Global‑e “welcome” popup. For the list of all the available client-side events, please refer to Global‑e Client SDK documentation here: [Events Summary](/events-summary) # Commerce API support (OCAPI, SCAPI) Source: https://docs.global-e.com/commerce-api-sfcc The cartridge repository includes **`int_globale_headless`**, which enables Global-e on **headless** storefronts — PWA, mobile apps, or any client that renders pages itself and talks to SFCC through the Shop **OCAPI** (Open Commerce API) or **SCAPI** (B2C Commerce API). > [!NOTE] > > This is an optional feature for headless architectures. It requires additional cartridges, hook clean-up, and PWA-side implementation. See [Configuration](#configuration). ## Configuration ### Cartridge path Add three cartridges to the SFCC cartridge path: * **SiteGenesis architecture:** `int_globale_headless`, `int_globale_sitegenesis`, `int_globale` * **SFRA architecture:** `int_globale_headless`, `int_globale_sfra`, `int_globale` ### Hook handlers The headless OCAPI handlers ship in `int_globale_headless`, so remove the duplicates from the storefront cartridge: * **SiteGenesis:** remove `coupon.js`, `order.js`, `basket.js` from `int_globale_sitegenesis` (they also exist in `int_globale_headless`). * **SFRA:** remove `coupon.js`, `order.js`, `basket.js` from `int_globale_sfra`. If the headless approach is used for **all** storefront pages, also remove the overridden base-cartridge templates from `int_globale_sitegenesis` / `int_globale_sfra`. If you run a **hybrid** strategy (for example, headless everywhere except checkout, which stays on SFRA/SiteGenesis), keep those overridden templates. > [!NOTE] > > **Important:** enable hook execution for Commerce API requests. > **Administration → Global Preferences → Feature Switches → Enable Salesforce Commerce API Hook Execution.** The full list of headless platform hooks is in the [Hooks reference](/hooks-sfcc#headless-int_globale_headless). ### Site preferences Configure these regardless of which API you use, in the **Global-e Settings** group: * `geEnableCartValidationCAPIBasket` * `geCAPIType` (OCAPI or SCAPI) If you use **OCAPI**, configure the **Global-e OCAPI Settings** group: * `geOCAPIDomain`, `geOCAPIVersion`, `geOCAPIClientId` If you use **SCAPI**, configure the **Global-e SCAPI Settings** group: * `geSCAPIOrganizationId`, `geSCAPIShortCode`, `geSCAPIVersion`, `geSCAPIRedirectURI`, `geSCAPIAuthType`, `geSCAPIClientId`, `geSCAPIClientSecret` See [Configuration](/configuration-sfcc) for the full site-preference walkthrough. ### Open Commerce API (OCAPI) settings Configure the OCAPI Shop API JSON in Business Manager to cover the resources Global-e may use. Extend it to match your project's needs. ```json theme={null} { "_v": "**.*", "clients": [ { "client_id": "", "resources": [ { "resource_id": "/baskets", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/baskets/*", "methods": ["get", "patch", "delete"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/baskets/*/coupons", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/baskets/*/coupons/*", "methods": ["delete"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/baskets/*/items", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/baskets/*/items/*", "methods": ["delete", "patch"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/orders", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/orders/*", "methods": ["get", "patch"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/customers", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/customers/auth", "methods": ["post", "delete"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/customers/*", "methods": ["get", "patch"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/customers/*/auth", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/customers/*/baskets", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/product_search", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/products/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/sessions", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/custom_objects/*/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(**)" } ] } ] } ``` > **Important (SCAPI):** even when you integrate through SCAPI, you must still allow the `/sessions` resource via OCAPI, because Global-e uses it. You can reuse the same client ID as your other SCAPI requests — a separate client ID is not required. > > ```json theme={null} > { > "_v": "**.*", > "clients": [ > { > "client_id": "", > "resources": [ > { "resource_id": "/sessions", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" } > ] > } > ] > } > ``` ## Global-e checkout on a headless storefront On headless, the Global-e checkout page is initialized and shown the same way as on the classic web storefront. > [!NOTE] > > **Important:** if the shopper reaches the checkout but the SFCC basket is invalid (no product line items, or no total price), SFCC does **not** send the SendCart data to Global-e, and the basket custom attribute `c_geCartToken` is null or absent in the PATCH basket response. The PWA must handle this — for example by redirecting the shopper to the cart page. ### 1. Get the Global-e cart token Send a PATCH basket request with the query parameter `c_geGetCartToken`. Send it **once**, after all other basket requests are complete and just before the checkout page is shown. SFCC then sends the **SendCart** data to Global-e and stores the returned cart token in the basket custom attribute `c_geCartToken` (visible in the PATCH response). ### 2. Initialize the Global-e client SDK Initializing the SDK requires: * `clientJsUrl` — the client JS URL (composed of `clientJsBaseUrl` + `clientJsSource`) * `apiVersion` — the API version from the Global-e session * `clientJsMerchantId` — the merchant ID from preferences * `clientSettings` — client-specific settings * `clientJsDomain` — the client JS base URL * `cookieDomain` — the domain for Global-e cookies (defined on the PWA/app side) All of these except `cookieDomain` can be retrieved by requesting the `GLOBALE_APP_SETTINGS` custom object with the query parameter `c_geGetSDKInitData`. The headless cartridge provides the Global-e client-side JS at `int_globale_headless/cartridge/client/default/js/globaleClientScripts.js`, which the headless storefront can reuse. ### 3. Render the checkout Once the cart token is available and the SDK is initialized, use the token to show the Global-e checkout in an iframe. Add an empty `
` to the checkout template — it becomes the iframe wrapper. ### Checkout confirmation and hosted payment pages The Global-e checkout supports two kinds of payment methods: * **Without a hosted payment page** (for example credit/debit cards): on **Place Order**, the checkout refreshes **inside the iframe** (the browser page does not reload) and the shopper sees the confirmation page. * **With a hosted payment page** (for example PayPal): the shopper is redirected to the provider's page, completes payment, and is redirected back to the storefront. On return, the existing cart token is provided in the URL as the `token` query parameter — the storefront must re-initialize checkout from that token. Out of the box, SiteGenesis and SFRA handle this redirect flow. **Headless storefronts must implement it.** #### Handling the payment redirect (headless) Shoppers sometimes complete payment but are not returned to the confirmation page (for example, session loss in Safari Private Browsing, in-app WebViews, or 3DS redirects can drop the cart token). To handle it reliably: **Step 1** **Persist the cart token** — after each successful SendCart, save the cart token in a browser cookie and update it on every SendCart. **Step 2** **Add a dedicated endpoint** — implement a headless endpoint for the redirect scenario, initializing the SDK the same way as the checkout endpoint. **Step 3** **Resolve the cart token** — when the endpoint is hit, use the `token` URL parameter if present; otherwise fall back to the cart token in the cookie. **Step 4** **Show the confirmation page** — initialize the SDK with the resolved token and render the confirmation page. ### Helper tools (Postman) Postman environments and collections are available for developing and testing the headless integration (authorize a customer, create/modify a basket, apply coupons, work with products, get a cart token, and so on). Request these from **Global-e Merchant Support**. ## See also * [Configuration](/configuration-sfcc) — `geCAPIType` and OCAPI/SCAPI preferences * [Cartridges](/cartridges-sfcc) · [Installation](/installation-sfcc) * [Headless hooks](/hooks-sfcc#headless-int_globale_headless) * [Client JS SDK](/client-js-sdk-sfcc) # Composer-Based Installation Source: https://docs.global-e.com/composer-based-installation The Magento platform natively supports the following installation method. **To install the Global-e Magento2 lite extension:** 1. In your Magento2 installation, locate the **composer.json** file and open it. The **composer.json** file includes information about both the Global-e package and its corresponding repository. 2. To avoid installing the old version, either remove or update the `'magento2_lite'` version to `'1.*'`. Make sure to confirm with the Global-E Integration team that you are using the stable version of the module. For example: ``` "require": { "globale/magento2_lite": "1.*", } ``` 3. Global-e provides you public GitLab repository URL. For example: ``` { "repositories": [ { "type": "vcs", "url": "https://gitlab.com/global-e-public/Magento2_Lite.git" } ] } ``` > [!NOTE] > > * If necessary, Global-e can provide an alternative package version during integration. > * Global-e repositories are not publicly accessible, but read-only access can be requested. 4. Run the standard Magento2 deploy scripts. 5. Make sure that the Global-e modules are enabled: * `Globale_BrowsingLite` * `Globale_OrderLite` For information on enabling modules, see the [Magento documentation](https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/tutorials/manage-modules.html). # Configuration Source: https://docs.global-e.com/configuration-bigcommerce ## Integration Features | Feature | Description | | - | - | | Country and Currency Switcher | Choose over 200 countries with default or free currencies (which can be replaced by a custom implementation) | | Currency Conversion | View prices in local currency with up-to-date conversion rates, country coefficients, rounding rules, and currency symbols | | Duty and Tax Calculations | Country and continent-specific duty and tax calculations | | Delivery Cost | Dynamic delivery cost calculations based on country | | Multiple Shipping Options | Country-specific shipping options from standard to express | | Local Payment Methods | Choose from the most popular payment methods for each country | | Promotions | Manage promotions for Global‑e operated countries | | Customer Service | View and manage Global-e Orders through the Customer Services Tool | ## Examples ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cc70c928-d20f-4a37-71b1-69248c560887.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=230a59768057d782c729a8e459c49243) ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-51709f5b-6ace-0802-7fa9-3529f73b5289.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=642bec9b4cfcb6d85cde643c8049ee1d) ## High-Level Flow ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-f8da5c3d-431d-0988-8959-147cf8c5f38a.svg?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=080a03a9ffadb7090d71dc81f9380cfb) ## Sample Reference Architecture ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e245c6c0-ecc9-5c99-8cda-e938b1ff7407.svg?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=8e414f2891f987f80bba5ad0b77a3efc) ## Integration Overview Before Global‑e ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f6ac8d5c-5bce-967a-1226-0b572f3d97c4.svg?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=182fdffcb00e979e101d6bcf5ee22f91) ## Customer Journey (Technical) ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-eaa3eafe-1832-a796-6127-104c6e241069.svg?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=128a1d5d5d395b732ad7dbadb1762e4e) ## Integration Overview with GE - Customer Browsing ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cf522b18-d2dd-4c29-4ce9-56cc2c1c0a7b.svg?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=1c8ec34832f14269a4c34d441d56a7ee) ## Integration Overview with Global‑e - Order Creation ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3978ac07-e224-19e0-9356-8ce4b8ff3093.svg?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=38ee8b7c698d263fb685a1502643dc43) ## Client-side Includes ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-56ab865b-76f0-31bd-88c9-fac7a9454843.svg?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=c56fa04e28016c557ecb0f4df17cd67e) ## BigCommerce Order List ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-65be733b-915d-05f0-19de-feca2df13b66.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=c265612b789b926db31fac24bcc98b61) ## BigCommerce Order Details ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-38cbd9dc-6c8b-1e8f-5ba5-631f55ecae88.jpg?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=eee251cb805aa7e032c5e915e08304c2) * The order is created as domestic * The international details are stored in staff notes ## Integration Overview with Global‑e ### Order Dispatch ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7cc8af63-9279-ccd9-368c-9cfb481cce27.svg?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=627f30a376a76851f14f305e47e48f49) ## Marketing, Analytics, and Communication | Item | Handling | | - | - | | Google shopping feed | Leverage existing feeds and new feeds for Global‑e operated destinations leveraging the Global‑e cartridge or price feed API | | Analytics and tracking | Review current trackers and analytics integration to build the associated data layer and triggers using the Global‑e checkout callbacks | | Email Communications | Transactional emails provided by Global-e and suppressed on the merchant side All marketing material and communications remain with the brand | ## Analytics and Tracking Pixels - Client SDK ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7c0ddcd8-b410-33df-d10f-b36ab198b8d3.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=4a244a5cff072482226482885d2ebdc9) Implement a custom script to capture Global-e checkout and transactional analytics events:Create a new script at Storefront -> Script Manager -> Create Script.Add your tracking code to the script. Example snippets can be found in [Client Analytics](/client-analytics) ### Marketing Feeds Adjust existing Google feed and new feed for Global‑e markets. ## Order Processing Global‑e-operated orders are created in the e-commerce platform as domestic orders (base currency) with: * End Customer transaction currency data * End Customer shipping and billing address * “Global-e” shipping service(s) – for warehouse dispatch routing – to be mapped in ERP * “Global-e” payment provider – for financial/accountancy handling – to be mapped in ERP * Both Global‑e and brand platform order numbers referenced on both sides OMS/ERP Order flow: suppression of current activities on fraud, auth/capture, emails Shipping documentation (carrier label and invoice) when provided by Global‑e entails: → No actual end customer address is required by the Warehouse team and systems → Order number documentation allows retrieving from Portal or API ## Order Downstream Flow and Dispatch ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cbe33314-0cde-544c-7398-819f29170f6f.svg?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=6dcad7a8ccbe9867739e314f18d2924d) ## Returns and Refund Management ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8f194ded-82f6-b38c-6348-de657f83149a.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=1554126ba322895c14684e53b834199d) > [!NOTE] > > The customer submits returns requests directly through the Global-e Returns Portal (Global-e Customer Service Portal).\ > The Admin can perform returns via the Global-e Merchant Portal Returns screen.\ > Refunds are executed either via:\ > → The Global-e Customer Service Portal\ > → Direct API integration with Global-e ## To configure the Global-e Application 1. From the BigCommerce left menu, select **Apps > Global-e**. The Global-e Configuration screen opens. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-84115994-cbdb-be04-b00a-7fe41448ee55.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=3924c70934dc40ee0f50b99cc365bf6a) 2. Configure the following parameters, as required: | Field/Box | Description/Steps | | - | - | | Is Active | Adds or removes the Global-e includes to or from your site.Select **Is Active** to add the Global-e script includes to your Merchant site.Clear the box to delete the Global-e includes from your Pla site. | | Include type | The Global-e include types are based on the Global-e solutions (Pro, GEM). The default *include* type is based on the Global-e Module. | | Merchant ID | Your Merchant Account ID, as recorded in the Global-e system. Example: 899 Modify your Merchant Account ID, if required. | | Merchant GUID | The private key of your Merchant Account ID in the Global-e system. Example: F978DFEB-FF8C-4EE1-BFDA-68FB1B78E217Modify your Merchant Account ID private key, if required. | 3. Click **SAVE**. The Global-e scripts for BigCommerce are added to your Merchant site. # Configuration Source: https://docs.global-e.com/configuration-magento2-lite-overview This page describes the following: * [Integration Summary](/integration-summary-configuration) * [Order Placement](/order-placement) * [Shipping Method Code](/shipping-method-code) * [Checkout Flow](/checkout-flow) * [Discounts](/configuration-magento2-lite-overview#-285176) * [My Account](/configuration-magento2-lite-overview#my-account) * [Setting Up Fixed Prices in Magento](/configuration-magento2-lite-overview#setting-up-fixed-prices-in-magento) * [Fixed Prices Support](/configuration-magento2-lite-overview#fixed-prices-support) * [MID Support](/configuration-magento2-lite-overview#mid-support) * [Additional Integration Features](/configuration-magento2-lite-overview#additional-integration-features) ## Discounts Global-e supports standard discounts through the Magento platform. With Magento’s Global-e extension, you can offer your customers the following discounts: * **Percent of product per discount:** Reduces the price of a product by a certain percentage. For example, you can offer a 10% discount on all shirts. * **Fixed Amount Discount**: Reduce the price of a product by a set amount. For example, you can offer a \$5 discount on all hats. * **Fix the Amount for the whole cart**: Offer a discount on the total cart value, such as a 10% discount on orders over \$100. * **By X Get Y**: A promotional discount that offers customers a free item when they purchase one or more items. For example, you can offer one free pen with the purchase of two pens. ### Applying a Discount Customers can apply a discount code to the shopping cart or to the Global-e Checkout page once they finish shopping. **To apply a discount code** 1. After a customer finishes shopping, they click the shopping cart icon at the top of the page. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c0855e1f-1a89-5efb-dd4e-e7312406ccf9.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=89e186b1aca52396f0cb969ad27c28dd) 2. The customer clicks > **Proceed to Checkout**. The Checkout page opens. 3. The customer scrolls down to **Billing Summary** and enters their discount code. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5e395356-aec0-cbf4-01da-538f47a03bde.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=26e2176dcaaf107e0bd47e5e85db367a) 4. The customer clicks **Apply.** The discount is subtracted, displaying the new total. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-59967873-eae1-0cb4-45f7-a516f5826a9f.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=e9a530cd8d552841910c7d765f969007) 5. The customer fills out their payment details and clicks **Pay and place order** to complete their order. ### Viewing Your Discounts To view or edit existing discounts: 1. From the Magento dashboard navigate to **Marketing** > **Cart Price Rules**. The Cart Price Rules page opens, displaying all existing discounts. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2ec6d997-970a-2564-2233-d6e28e17cd15.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=ad884fcf58b996c9ab74cc657b15dd80) 2. Click on one of the rules from the list to view or edit the discount details. ## My Account ### Logged in Customer Details in the Global-e Checkout When a registered customer logs into the Merchant’s webstore before proceeding to Global-e checkout, the Global-e Magento2 Lite extension transfers securely transfer the customer’s details to Global-e checkout, where shipping and billing information will be pre-populated. ### Order History Orders placed by logged-in customers through Global-e are assigned to the corresponding account in your merchant store. You must update your order history pages to show the correct localized prices for your international orders. The prices displayed should show the same currency and prices that the customer paid and sent to your platform via the [sendOrderToMerchant](/orders---placement-history) request. ## Setting Up Fixed Prices in Magento You can set up **Fixed Prices** automatically or manually to ensure they display correctly on your storefront. > [!NOTE] > > Before you begin, contact your Client Success Manager. This feature requires additional configuration on the Global-e side to function correctly. ### Setting Up Automatic Fixed Prices Use this option if you want all countries using the same currency to have the same fixed prices as your Magento catalog. #### To set up automatic fixed prices 1. In Magento Admin, navigate to *Stores > Settings > Configuration > Services > Global-e Crossborder > Products*. 2. Select the option to use fixed prices from your catalog. This setting applies `"isFixedPrice": "true"` for all countries under that specific webstore. > [!WARNING] > > If you sell in multiple currencies (for example, USD and EUR), create separate Magento webstores for each base currency. ## Example 1. Example If your main store uses USD, prices in USD countries will be treated as fixed. If you also want fixed prices in EUR, create another store using EUR as the base currency. ### Uploading Fixed Prices Manually Use this method if you want full control over which countries and currencies have fixed prices. This method involves uploading a CSV file with specific details. #### To upload fixed prices manually 1. In Magento Admin, navigate to *Catalog > Global-E Fixed Prices > Import/Export Prices*. 2. Upload a CSV file containing the following fields: | Field | Description | | - | - | | `product_code` | The Magento product SKU. | | `currency_code` | Currency (e.g., USD). | | `country_code` | Country code (e.g., US). | | `price` | Fixed price value. | | `special_price` (optional) | Discounted price (if applicable). | | `date_from` (optional) | Start date for the fixed price, in the format YYYY-MM-DD. | | `date_to` (optional) | End date for the fixed price, in the format YYYY-MM-DD. | ### Showing Fixed Prices on Your Storefront To ensure fixed prices appear correctly on your product pages, Global-e requires a special `data-fp` attribute to be included in the price display. ### Configuring Traditional (Non-Headless) Magento Stores #### To configure traditional (non-headless) Magento stores 1. Navigate to *Stores > Settings > Configuration > Services > Global-e Crossborder > Products*. 2. Select the setting to automatically add the `data-fp` attribute to your storefront. ### Configuring Headless Magento Stores Headless setups require manual configuration of the `data-fp` attribute for each product. #### To configure headless Magento stores 1. Add a `data-fp` attribute to each product’s price HTML element, containing a JSON object of country-specific prices. 2. **Reminder:** Include FP data for both parent (configurable) and child (simple) products. ### Configuring Fixed Prices for Swatches If you sell product variations (such as colors or sizes) under the same SKU and need different fixed prices for each, Global-e supports swatch-specific fixed pricing. #### To configure fixed prices for swatches 1. In Magento Admin, navigate to *Stores > Settings > Configuration > Services > Global-e Crossborder > Products*. 2. Adjust your swatch pricing as needed. For more information, refer to: [Magento Product Swatches – Adobe Commerce Docs](https://experienceleague.adobe.com/docs/commerce-admin/catalog/products/catalog-product-swatches.html) ### Disabling Fixed Prices for a Country You can disable Fixed Prices for a specific country if needed. #### To disable fixed prices for a country 1. Ask your Global-e contact to turn off fixed prices for the country in the Global-e country settings. 2. In Magento Admin, navigate to *Stores > Settings > Configuration > Services > Global-e Crossborder > Products*. 3. Locate the webstore for that country and disable the Fixed Price setting. 4. Review your webstore setup and select one of the following: | Option | Description | | - | - | | **Option A**: Keep the country in the same webstore | Ensure product prices are pulled from the base currency of that webstore (for example, if the base is USD, prices for the US will reflect catalog pricing). | | **Option B**: Move the country to a different webstore | Update the routing settings in Global-e to direct traffic from that country to your ROW (Rest of World) webstore. | ## Fixed Prices Support In addition to sophisticated dynamic price localisation capabilities across multiple target countries and currencies (such as country uplift coefficients, VAT handling rules, marketing rounding rules, etc.), the Global-e Magento2 Lite extension supports fixed prices per country functionality. ### Fixed Price from Magento Catalogue This can be achieved by defining separate stores per target country’s currency and configuring the respective countries as “fixed price” on the Global-e side. For example, if a store in Magento has a base currency EUR, it can be used as a fixed price for all (or some) countries having EUR as a default currency. The fixed price will be used for all products. Configuration: * The country should be defined to support fixed prices in the Global-e back office * Magento store should be updated with prices including VAT * Global-e extensions should be configured on the store level to support fixed prices from the catalogue (see screenshot below) ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8130be27-3d8a-1431-d531-0f97fab2f37e.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=afa03802f0c784a26db2c8146fe6a08c) ### Fixed Prices Using Pricebook Upload (CSV) It’s possible to manage fixed prices by uploading the Pricebook CSV via the interface provided by the Global-e Magento2 Lite extension in the Magento admin: Catalogue-> Global-e Fixed prices. To display fixed prices on your site, make sure to enable the Global-e module setting **Add data-fp to product attribute automatically**. This adds data-fp attributes to products on HP/PLP/PDP/Search. ### Enabling the Global-e Module You must enable the following Global-e modules in order to display fixed prices on your site. * Globale_BrowsingLite * Globale_OrderLite To enable the Global-e Modules use the below command: ``` bin/magento module:enable [-c|--clear-static-content] [-f|--force] [--all] ``` Where * \ is a space-delimited list of modules to enable or disable. If any module name contains special characters, enclose the name in either single or double quotes. * \--all to enable or disable all modules at the same time. * -f or --force to force a module to be enabled or disabled despite dependencies. Before you use this option, see About enabling and disabling modules. * -c or --clear-static-content cleans generated static view files. ### Upload Pricebook To upload the Pricebook into Magento Admin, please proceed to Catalogue -> Global-E Fixed Prices -> Import/Export prices ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-377e458d-73d2-8ab0-f265-6bf0c26e922d.jpg?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=8dce404733ccb166af2012608074fdda) Price should have the following columns: | Parameter | Description | Example Format | State | | - | - | - | - | | `product_code` | Product SKU from Magento | | Mandatory | | `country_code` | ISO2 letters country | IE | Optional | | `currency_code` | ISO3 currency mode | EUR | Mandatory | | `price` | Fixed price in the specified currency | 111.0000 | Mandatory | | `special_price` | Fixed price for the special price | 111.0000 | Optional | | `date_from` | The date when the special price is applied | `Y-m-d``Y-m-d\TH:i:sP` | Optional | | `date_to` | The date until the special price is applied | `Y-m-d``Y-m-d\TH:i:sP` | Optional | Fixed prices should be uploaded for configurable and child products After upload, fixed prices will be stored in the dedicated table created by Global-e in the Magento database: *globale_fixed_price* table. ## MID Support U.S. Customs requires the Manufacturer's Identification Code (MID) for certain shipments to the United States. **What is Manufacturer’s Identification** Manufacturer's Identification (MID) includes details of the manufacturer of the goods which is required in some cases by the US customs. MID includes the full business name and postal address of the manufacturing supplier as well as a specific code based on the manufacturer's name and country. **MID is required for:** * Any order shipped to the USA, no matter the value, that includes at least one product manufactured in China/HK. * Any shipment to the USA with a declarative value to customs higher than \$2,500 (regardless of the Country Of Origin of the products). **Configuration** Configure the following MID fields: * **MIDCode**: A unique identifier generated from the manufacturer's name and location. * **MIDAddress**: The full postal address of the manufacturing supplier. * **MIDName**: The complete business name of the manufacturing supplier. **To generate an MID Code** If the required data is not already available in your system or cannot be obtained from your manufacturer, you can generate the MID code by following the steps below. 1. **Collect Supplier Information**: Ensure your manufacturing supplier has provided their complete business name and postal address. This information is essential for defining the MID code. 2. **Generate the MID Code** 1. Identify the two-letter ISO country code for the supplier’s country (e.g., GB for the United Kingdom, NL for the Netherlands, DE for Germany). 2. Use the first three letters of the supplier's first and second names (if applicable). 3. Extract the highest numerical digits (up to four) from the address line. 4. Use the first three letters of the supplier’s city name. **Example** **Supplier**: Ozrock, 92 Alice Springs Road, Melbourne, Victoria, Australia, 3001 **MIDCode**: AUOZR92MEL **MID Address and MID Name configuration** No special formatting is required for the MID Address and MID Name fields. These fields should be filled exactly as provided by the supplier's data. **Example** * **MIDAddress:** 92 Alice Springs Road, Melbourne, Victoria, Australia, 3001 * **MIDName:** Ozrock **Adding MID to Magento** Follow these steps so that Global-e can provide MID information to the carrier and display it on the commercial invoice: 1. Create MID product attributes in Magento. 1. In Magento Admin, navigate to **Stores > Configuration > Services > Global-e Crossborder > Products**. 2. Add the following 3 attributes to either **Extra Product Attributes** or **Extra Product Attributes From Simple**. **Important!** Be sure to add these attributes exactly as they are spelled here: * `midcode` * `midname` * `midaddress` ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b573ca4c-3d05-8ee8-4093-5424feab26d4.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=ec2eb800d352fb95c26b2e2d9bef6530) 2. Update your products with data for each MID attribute. ## Additional Integration Features ### Conversion Tracking for Global-e Orders The Global-e confirmation page comes from the Global-e platform, not the Magento confirmation page. To allow merchants to implement conversion tracking for Global-e orders, there are JavaScript events that will be sent from the Global-e checkout iframe to the container page. The `OnCheckoutStepLoaded` event is fired when the Global-e checkout is open (in this case no additional data is provided) and also when the confirmation page is showing. In the 2nd case, the `data`object with all the order details will be provided. This object can be used by merchants to report events to any platform (GA, GTM, Facebook etc). To simplify the implementation of conversion tracking, the Global-e Magento2 Lite extension provides 2 configuration fields in the Magento admin panel. Merchants can use these fields to add tracking code (in the form of executable JavaScript) to report the transaction. The advanced analytics feature allows merchants to track customer activities inside the checkout form and `OnClientEvent` will be fired on every change inside the form. This can be particularly useful in capturing customer e-mail addresses and implementing abandoned checkout integration. More details about this event can be found [here](/client-analytics). ### Conversion Tracking 1. Global-e checkout is opened in an iframe and this iframe is then reloaded to display the confirmation page to the customer. 2. In order to allow merchant to perform conversion tracking and implement goals in the GA, the Global-e iframe will fire JavaScript events to the container page. 3. As part of the extension, Global-e provides a configuration field in Magento Admin (Stores > Configurations > Services > Global-E Integration Lite > Checkout > JS Code on Success Page) where this event handler can be added. For example snippets, see [Client Analytics](/client-analytics). **Configuration (Example)** Add JS Code for successful international orders. These settings can be found under the Global-e Crossborder Checkout or Analytics section depending on the module version. Add JS Code to the body of the checkout page for successful international orders: ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-42f524f2-86a1-da34-f575-417028eebc05.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=e148934733cc08e332592af2293e84fd) Add JS Cod to the body of the page for successful international orders: ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5952dc18-8e43-c7f3-15bc-838d0a9a8981.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=2ba332dcccd90689caa5b27fe428e999) ### Pre-Order and Backorder (Magento) The Global-e Extension for Magento features a logic that determines whether an order should be marked as Backordered during the GetCart request process. This decision is based on specific criteria: * The item is marked as eligible for backorders in Magento ("`backOrders`" is enabled). * The item's quantity is less than or equal to 0. When both conditions are met, `IsBackOrdered = true`. Additionally, a `BackOrderMessage` is included in the `MetaData`. By default, this message is set to "`pre-order`". However, you can customize this message in the configuration settings of the Global‑e module within the Magento Admin panel. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3a2e4386-a636-e641-f439-a063bf6fcf2a.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=33adabb7ba4efa0c7975c2c26a41e982) This feature allows for a tailored communication strategy regarding back-ordered items to customers. # Configuration Source: https://docs.global-e.com/configuration-merchant-portal This documentation enables provides instructions on how to configure the Merchant Portal, including: * [Site Customization](/site-customization-storefront): Lets you configure the look-and-feel and behavior of various elements of your site * [Marketing Propositions](/marketing-propositions--main-screen-): Lets you manage your marketing propositions, such as campaigns and returns * [Email Management](/email-management-transactional-emails): Lets you configure the look-and-feel and behavior of your email notification behavior # Configuration Source: https://docs.global-e.com/configuration-prestashop ## Configure Global‑e This is the only section that you are required to configure on the **Configure** screen. All other sections are optional. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-0f022edf-4e27-f796-1030-1fa499c316e3.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=5015f31d202584b95b2df8ae86602662) **In the Global‑e API Settings area:** 1. Enable JS/CSS Include: Select **Yes** to enable price conversion. 2. Enter your Merchant ID (provided to you by Global‑e). 3. Enter your Merchant GUID (provided to you by Global‑e). Note that the GUID is not the same for staging and production environments. 4. Select the suitable Global‑e environment. 5. Click **Save**. The Configure screen also features the following Global‑e settings. These settings are available depending on your configuration. Refer to your Account Manager for more information. ## Installed Global‑e Functionality After installation, the following functionalities are installed: * [Configuring Your Welcome Popup Page](/site-customization-storefront#configuring-your-welcome-popup-page) * [Configuring Your Switcher Popup Page](/site-customization-storefront#configuring-your-switcher-popup-page) * [Configuring Your Shipping Banner Page](/site-customization-storefront#configuring-your-shipping-banner-page) ### Scripts The following Global‑e scripts are installed. * Global‑e CSS Include * Global‑e Include JavaScript code installed on all site pages as well as on the Checkout Page. ## Global‑e Orders ### View Orders **To view Global-e Orders:** * From the PrestaShop Admin left menu, select **Orders**. The Orders screen opens, showing the lists of Merchant orders, including Global orders. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f09e998a-f14c-29b6-3052-18b0b7ccd2e0.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=1defa805aed3b479c7a2c3b50ea6497f) Global‑e orders are saved in the native PrestaShop Orders structure. The Global‑e order number is displayed in the Reference column. The Payment column shows that the order was placed by Global-e and the payment is done through Global-e. The Status column shows the Global-e order status. The Total column shows the reconciliation price in Merchant currency. ### Order Details This section details the Order Details screen areas that apply to Global-e. **To view all order details:** 1. In the Orders screen, select an order. The order row expands. 2. Click **Order details**. The details of the order are displayed. ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fd765837-7ec8-3250-58f7-475939fe9849.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=dc04769f7f6bfeff38b72cae628754b5) > [!NOTE] > > The following order screen sections apply to the PrestaShop Native functionality. To configure these features, use the Global‑e Merchant Portal. > > * Documents (Invoice, shipping documentation, and more.) > * Carrier > * Returns > * Payments **The Global‑e Order ID** Before the order is injected into the Platform, it is created in the Global‑e system and given a Global‑e Order ID. Example: GE1234567GB The Global‑e Order ID is preceded by GE and ends with the merchant country code initials. **Customer Details and Shipping Information** The Order Details screen's **Customer** area shows the Customer Details and Shipping and Invoice (billing) information. Global‑e copies the customer details from the Global‑e Checkout page to the Order's Shipping and Billing information (Invoice), ensuring a secured transfer of customer data. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b98f038f-a6a0-5fb6-8db2-c70562654ada.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=3f050762222697469e50596268b8b823) **Standard PrestaShop Order Details** The Standard PrestaShop Order Details area shows the products included in the order and the reconciliation price in merchant currency. ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/uuid-019f78ef-5156-0025-1297-8b52326f182d.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=888806b450c02e9c78c5e5df2e94de27) **International Details** The International details area shows the products included in the order and the total value that the customer paid for the order in customer currency. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-71ad154b-d178-39a9-ab5d-63aed964fa69.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=d4cdb1fba8590ade629e43ad2effe6a3) **Order Status** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3b7cd821-4f93-23c2-4a68-48a7b48dbb61.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=9e968dd133aa6d19bf37bf771e394594) By default, PrestaShop does not have a strict order status flow. This means that the order status flow may be different on different systems. Global‑e uses a strict order status flow. These settings allow mapping the Global‑e order statuses to your internal order statuses. Basic Global‑e Statuses: * **Pending Payment**: The order is reserved but the fraud check is not done yet, and the money has not been captured from the customer. * **Processing** or **Payment accepted**: The order is confirmed. The fraud check passed. The money has been captured from the customer. The order is ready to be fulfilled. * **Cancelled**: Something went wrong. The order was cancelled. * **Complete**: The order has been fulfilled by Global‑e. To configure statuses on PrestaShop, see [Configure Orders](/configuration-prestashop#configure-orders). ### Discounts Global‑e supports standard discounts via the PrestaShop platform. Contact your Account Manager for more information. ### Cancel Orders Global‑e supports cancelling orders through the Global‑e Merchant Portal. Currently, if you cancel an order on your platform, it is not updated on the Global‑e side. You must cancel the order on the Global‑e Merchant Portal to enable customer notification and customer refund. See the Merchant Portal documentation for more information on cancelling orders and refunds. * [Cancelling Orders](/managing-orders#cancelling-orders) * [Refunds](/refunds-orders#overview) ### Order Returns and Refunds Global‑e supports Returns and Refunds through the Global‑e Merchant Portal. When a return is triggered, the order fulfillment stops. PrestaShop lets you create refunds for product prices only. To refund additional order components (shipping, duties \&taxes, service gesture), use the Global‑e Merchant Portal. Based on your configuration, PrestaShop allows you to restock refunded items to maintain stock consistency. ### Global‑e-to-Platform Order Updates **Canceling an Order** When Global-e cancels an order, an API request is sent by the Global-e platform to the Global-e plug-in to change the order status in PrestaShop to Cancelled. Currently, if you cancel an order on your platform, it is not updated on the Global‑e side. You must cancel the order on the Global‑e Merchant Portal to enable customer notification and customer refund. **Order Refunds** Based on your configuration, PrestaShop allows you to restock refunded items to maintain stock consistency. **Amending Orders** When you update orders on the Global-e Merchant Portal, the changes are updated in PrestaShop. However, when orders are updated in PrestaShop, they are not updated in Global‑e. **Payment and Shipping Notifications** The payment and shipping notifications are sent out from Global-e when triggered by the relevant event. **Checkout Page** The Global‑e plug-in implements a Global‑e API method that uses the PrestaShop API to load the contents of the user’s cart and pass it securely to the Global‑e checkout through a server-to-server API call. **Discounts** The discounts applied on the cart page are reflected on the Global‑e checkout page, on your Platform. ### Configure Orders This section provides an overview of the Order's configurable features in PrestaShop. **To configure Orders:** 1. From the PrestaShop Admin, navigate to **Modules > Module Manager >** The Module Manager screen opens. 2. Scroll down to Global‑e (at the bottom of the Module Manager Screen) and click **Configure**. The Configure screen opens. 3. Navigate to the **Order** section. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f2c09059-5e79-3d88-95d8-d31aa4821fd6.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=ff65a1fe94f05e679527949fa956a16e) 4. Set the following values, as required: * **Skip Cart Validation:** Avoids cart validation when creating the order (Order Create). * **Add shipping costs totals:** Creates orders in the platform including the shipping costs in the total value. * **Order Statuses**: Use the following statuses to map the Global‑e Order status to the PrestaShop status. * **Pending Payment**: The order is reserved but the fraud check is not done yet, and the money has not been captured from the customer. * **Processing** or **Payment accepted**: The order is confirmed. The fraud check passed. The money has been captured from the customer. The order is ready to be fulfilled. * **Cancelled**: Something went wrong. The order was cancelled. * **Complete**: The order has been fulfilled by Global‑e. * **Order Item Price Coefficient:** Adds a specific coefficient to all new Global‑e orders. * **Use Shipping Method Mapping:** Sets the preferred display for the shipping method on the order page in the platform. * **Restock Refunded Product:** Restocks the refunded items in Global‑e. ## Products Merchant defines their product catalogue in the Products Screen. This screen shows the Merchant Price in default Merchant currency. ### International Product Prices With the Global-e solution, international prices are automatically displayed in your Store (front-end). Global‑e identifies and processes international orders dynamically or processes the fixed prices you defined. ### Global‑e International Price Conversion (Dynamic) Global‑e supports price calculations in your platform. With the Global‑e solution, international prices are automatically displayed in your Store (front-end). Global‑e identifies and processes international orders dynamically or processes the fixed prices you defined. Global‑e identifies and processes international orders dynamically or processes your fixed prices, as you defined them (see [Fixed Prices Overview](/configuration-prestashop#fixed-prices-overview)). Global‑e uses the default price (product price in merchant currency) and converts it dynamically to the currency selected by the customer. The conversion is based on daily rates and business pricing rules set by Merchant, including country-specific pricing coefficients and marketing rounding. The Global‑e dynamic conversion is described below. **Merchant Catalogue** The merchant sets the product prices in the Platform Admin. (Default shop currency). **Customer Price** Global‑e converts the product price dynamically to the customer price and customer currency, based on the business rules defined in Global‑e. This is the price that the customer pays in customer currency. **Global‑e Reconciliation Price** After the purchase is complete, Global‑e converts the customer price back to shop currency. This is the reconciliation price. This is the amount that the merchant gets from Global‑e during reconciliation. You can view this amount on the Global‑e Merchant Portal. ### Fixed Prices Overview Fixed prices may be required if you have resellers or offline shops in specific countries or regions and wish to keep the same prices everywhere. Global‑e implements your fixed prices as defined, without converting them. ### Set up Fixed Prices in PrestaShop (Specific Prices) In PrestaShop Global‑e fixed prices are called “Specific prices”. The country must support fixed prices in Global‑e. **To set up fixed prices in PrestaShop:** 1. In PrestaShop, enable fixed prices for the countries and currencies for which you wish to support fixed prices. See the procedure below on how to enable currencies. For more details, see PrestaShop documentation [Localization > Currencies](https://docs.prestashop-project.org/1.7-documentation/user-guide/improving-shop/going-international/localization/currencies). See the procedure below on how to enable countries. For more details, see PrestaShop documentation [Locations > Countries](https://docs.prestashop-project.org/1.7-documentation/user-guide/improving-shop/going-international/locations/countries). 2. Set the fixed product price for each country and currency as detailed in the Example for Canada below and send us the link to each store. Global‑e gets your fixed prices from PrestaShop and adds them to your Global‑e account settings. For more information on setting fixed prices, see PrestaShop documentation: [Managing Products > Specific Prices](https://docs.prestashop-project.org/1.7-documentation/user-guide/selling/managing-catalog/managing-products#managingproducts-specificprices-managingdiscounts). **EXAMPLE FOR CANADA** Your base/native currency is EUR. Create a fixed price for CAD: 150 CAD. **To set up fixed prices for Canada:** 1. For each product in your Store, in the PrestaShop Admin, navigate to **Catalogue> Products**. 2. On the Products page, select the desired product. 3. At the top of the \[ProductName] screen, click the **Pricing** tab. 4. In the pricing screen, scroll down to the **Specific Prices** section. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8260689d-6594-ed77-7394-7be6e9d7eb45.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=ed6721c01326c3627759e5472a2d9876) 5. Click **Add specific prices**. The Specific price conditions area is displayed. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-627d157c-9565-8164-a04f-7da16e6b29cc.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=427562e44d560a2c80ddd10ee15e921f) 6. In the Specific Prices (see figure above), under specific price conditions, set: * Currency: Canadian Dollar * Country: Canada 7. Under Impact on price, set the Product Price: 150 (your fixed price in CAD). 8. Click **Apply**. The fixed price for your product is applied to Canada (under Specific Prices). ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c104e287-b8a5-fda3-6ada-67689c46b67d.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=9137f3aa9d0ce3c474174eb02c69c889) To edit the fixed price, click edit at the end of the product row and make the required changes. Your product fixed price is reflected on your storefront when the shopper selects Canada. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-eb5fd3f1-f578-3f3d-f8ef-68fc73ed3821.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=35350df6c87cd4f5cd666c1bc3e17b81) Global‑e gets your fixed prices from PrestaShop and adds them to your Global‑e account settings. ### Product Coefficients The Global‑e plugin uses the product coefficient settings to announce a product feature as `ProductClass`. The class is set in Merchant Account Settings to influence the price conversion formula. **To configure Product Coefficients:** 1. Create a specific product feature, that will reflect the `ProductClass`, as detailed in the PrestaShop documentation here: [Managing Product Features](https://docs.prestashop-project.org/1.7-documentation/user-guide/selling/managing-catalog/managing-product-features). 2. Set the required values for each product. 3. Enable the Product Feature as Product Class: 1. Navigate to **Modules > Module Manager** and scroll down to Global‑e. 2. Click **Configure**. ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-f816ce2e-9df1-6a57-9d0e-81e21598eda6.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=aba9000ada76ae6a567bf5ab0595ab90) 3. In the Products area, next, to Use Product Feature as Product Class, select `ProductClass`. 4. Click **Save**. The plug-in adds a hidden `data-pc` attribute to the price blockhtml and the Bespoke Global-e Module scripts can start using it. ### Configure Products This section provides an overview of the Product's configurable features in PrestaShop. **To configure Products:** 1. From the PrestaShop Admin, navigate to **Modules > Module Manager >** The Module Manager screen opens. 2. Scroll down to Global‑e (at the bottom of the Module Manager Screen) and click **Configure**. The Configure screen opens. 3. Navigate to the **Products** section. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c86c002e-daf6-18ba-7ce0-f23a894f8499.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=9a0baeeab60e251987c04ee43a0bd74c) 4. Set the following values, as required: * **Product Extra Attribute:** This option determines which custom product attributes should be shown in the Global‑e checkout. * **Use Product Feature as Product Class:** Affects the rates of a group of items in Global-e and adds a specific product class. * **Use Short URLs in API:** Prevents issues related to the lengths of URLs in the `GetCart`. * **English Language:** The default PrestaShop language ISO code is English 'en". For the Global‑e checkout, you can choose a different English ISO code language code such as "en-us", "en-gb", or similar. * **Free Gift Discount Calculation Mode:** If you offer free gifts, select **Relative**. ## Gift Cards ### Overview This feature lets your customers purchase and use gift cards in Global-e checkout using the third-party module Gift Card. Global-e supports: * Purchasing Gift Cards as regular products * Using Gift Cards on Global-e checkout The Gift Card module can be purchased in the [PrestaShop Marketplace.](https://addons.prestashop.com/en/wishlist-gift-card/16680-gift-card-advanced-solution.html) ### Creating Gift Cards Once you purchase and install the Gift Card module you can begin creating gift cards. To create gift cards: 1. Navigate to your Prestashop admin panel > Catalogue >Gift Cards. The Gift Card Product page opens. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-6ad6dc24-d7ea-ae6e-1358-865e37a22e73.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=42a2eb748a8881a06f3213d57504ea24) The page is preloaded with gift card templates ranging in values of 10, 30, 50, 100, and 150. 2. Select a gift card. The gift card page opens. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2729a018-7f77-4524-6182-930901521d52.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=fd08649809c9eb8dd60eef0db7357fdc) 3. On the gift card page, you can add a cover image, write a description, and insert all the necessary details for your gift card. 4. In the bottom menu, click **Save** or select one of the other options: **Preview**, **Duplicate**, **Go to Catalogue** , or **Add new product**. ### Purchasing Gift Cards Customers can purchase virtual gift cards from your PrestaShop in the same way as other products. To purchase a gift card: 1. The customer clicks the gift card option on the website ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-136a91c1-c563-6536-e9ae-e1e38cb10301.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=27e169bd812516bd54f5d0df92fb1743) The Gift card page opens. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-282233df-cde0-ec2f-b947-c0c9137eaa3f.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=b1b2f924c57c554bc0531a3273538ea0) 2. The customer selects a delivery option: * Print at home: Print the gift card and present the recipient with the printout. * Send by email: Email the gift card to the recipient. Customers can also choose to have the gift card emailed at a later date. 3. The remaining gift voucher options are filled out. 4. The customer clicks **Add To Cart** The gift card is added to the shopping cart and the customer can continue to shop or proceed to checkout. ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fecde784-06d1-e708-2998-66911d2aadf4.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=45e11bfe346bdd139188665826261c72) Once the gift card is paid for, a coupon is generated for the recipient to use in their online purchase. The coupon code can be found either in the printout or email, depending on the delivery method. The new gift card is added to the **Cart Rules** page, where you can view the gift card's coupon code, status, and expiration date. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-38d2911c-6aa5-611f-daee-d7802e6e743a.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=0e905dbbed968d33632f0632a2ecae7a) ### Using A Gift Card Customers can redeem gift cards on the checkout page. To use a gift card in checkout: 1. After your customer finishes their online order they proceed to checkout. 2. In the Billing Summary, the customer enters the coupon code provided with the gift card. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-36fd2eac-ccd5-f90e-4c77-ffb3ab086ec1.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=fbfb2946324dc53f104beb2b3c969896) 3. The customer clicks **Apply**. The value of the gift card is deducted from the total. ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fcf602dd-6dbc-7b92-93f8-f6c3bf19392f.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=f021c32e3d9dadeb157e00013b401cf9) * If the cart value is lower than the card’s balance then the amount of the cart is deducted from the card and the balance can be used for future purchases. * If the total exceeds the gift card amount, the customer fills in their payment details, and the remaining balance is charged to their credit card. 4. The customer clicks **Pay and Place Order** to complete their order. ### View Purchased Gift Cards You can view a list of all the gift cards purchased in your shop. 1. At the top of the Gift Cards page select **Gift Card Order** ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5f92efa3-3c76-6d31-a161-d315ffb8ae83.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=19cf18bff37a494799ea2e4dba050ef5) The Gift Card Order page opens. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-25a13bf0-6c73-2228-8569-f02259901247.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=30519655bd85458774062b12e275fa4a) 2. In the Gift Cards section view all of the gift cards purchased on your site and their statuses: * Waiting payment confirmation * Not yet used * Used * Cancelled or expired ## Configure the Checkout for Analytics This section provides an overview of the Checkout configurable features for Analytics. **To configure the checkout for Analytics:** 1. From the PrestaShop Admin, navigate to **Modules > Module Manager >** The Module Manager screen opens. 2. Scroll down to **Global‑e** (at the bottom of the Module Manager screen) and click **Configure**. The **Configure** screen opens. 3. Navigate to the Checkout section. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-79354fec-8287-4773-d030-f8f8e89c8104.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=4ab7c7a6beb5aec8c389c0d160c8ba9f) 4. Set the following values, as required: * **Split car discount to item level:** This option supports different formats of discount lists. * **JS Code on the checkout page:** By default, Global‑e adds the Global‑e JavaScript code to the checkout page and implements the event fired by the Global‑e checkout at the end of the checkout process. Then, Global-e passes all order information, enabling merchants to push this information to any analytics system of their choice. You can modify this snippet and implement your functionality for sending Analytics or other purposes. For more information, refer to the [Client Analytics](/client-analytics) documentation. * **Replace country in context based on the Global‑e cookie:** This Cookie contains the country code and currency code. The Global‑e plug-in for PrestaShop reads these values and controls the customer context. This option must always be enabled as it affects many Global‑e features, including fixed prices. # Configuration Source: https://docs.global-e.com/configuration-sfcc After [uploading cartridges and importing metadata](/installation-sfcc), configure the site in Business Manager. Cartridge selection and path rules are summarized in [Cartridges](/cartridges-sfcc). When the Staging setup is complete, use [Production readiness](/readiness-assessment) to promote it to Production. ## Add Global-e cartridges to the site cartridge path `Administration > Sites > Manage Sites > (Your Site) > [Settings Tab]` Global-e cartridges follow Salesforce Commerce Cloud standards. After adding them on a demo SiteGenesis or SFRA storefront, the site should be ready for basic Global-e flows. Customize **`int_globale_sitegenesis`** (SiteGenesis) or **`int_globale_sfra`** (SFRA) for brand-specific logic. ### SiteGenesis Pipelines or Controllers Add **`int_globale_sitegenesis`** and **`int_globale`** before your brand cartridges (left = highest priority). Example: ```text theme={null} int_globale_sitegenesis:int_globale::sitegenesis_storefront_controllers:sitegenesis_storefront_core ``` ### SFRA Add **`int_globale_sfra`** and **`int_globale`** after your brand cartridges and before `app_storefront_base` (left = highest priority). Example: ```text theme={null} :int_globale_sfra:int_globale:app_storefront_base ``` ### Business Manager (organization job steps) Add **`int_globale`** to the Business Manager cartridge path so organization-context **GlobaleSettings** steps can load cartridge scripts (for example `GlobaleUpdateCachePriceBooksConfigHash`). Configure manually in Business Manager or via `b2c sites cartridges add int_globale --bm --position first` — see [Cartridges](/cartridges-sfcc) § Business Manager cartridge path. ### Headless / PWA Add **`int_globale_headless`** with **`int_globale`**: * **Headless only** — `int_globale_headless` : `int_globale` (no SFRA/SiteGenesis storefront cartridge) * **Headless + SFRA site** — place `int_globale_headless` immediately before `int_globale_sfra` so Shop OCAPI hooks register for the site Set site preference **`geCAPIType`** to **OCAPI** or **SCAPI** as agreed with Global-e. See [Hooks](/hooks-sfcc) § Headless and [Metadata](/metadata-sfcc) § Global-e OCAPI / SCAPI Settings. ## Default Currency Settings `Administration > Sites > Manage Sites > (Your Site) > General` For all Global-e operated sites, **Default Currency** must be a base merchant currency (for example GBP or USD — not a Global-e operated shopper currency). ## Order Preferences (Merchant Tools > Site Preferences > Order) ### Limit Storefront Order Access Set this preference to **Allow List** and add the following Global-e endpoints: * Globale-CustomerRegistration * Globale-ValidateCart * Globale-OrderCreate * Globale-OrderCreateV2 * Globale-OrderSendToMerchant * Globale-OrderPerformPayment * Globale-OrderUpdateStatus * Globale-OrderUpdateShippingInfo * Globale-OrderRefund * Globale-OrderRMA * Globale-Coupon * Globale-ClearCart * Globale-VoidInventoryReservation *(SFRA only — this endpoint is implemented in `int_globale_sfra`; it is not registered in the SiteGenesis controller)* Enter the controllers as a comma-separated list in the Allow List field (Business Manager accepts other separators and normalizes them). ### Filter Storefront Orders by Customer Session Set to **No**. ### Failed Orders Settings By default this field is empty, so SFCC does not auto-fail orders in **CREATED** status. Set a timeout in minutes — for example **4320** (3 days). If Global-e account setting **Place Order On Payment Update** is **Yes**, set **Auto-Fail Orders** longer — for example **20160** (14 days). ## Payment Processor (Merchant Tools > Ordering > Payment Processors) Create the **GLOBALE** payment processor manually (**New** → Processor ID `GLOBALE`, description such as `Global-e Payment Processor`). After importing `metadata/site/paymentmethod.xml` you will have payment method **GLOBALE** (Globale). Assign it to payment processor **GLOBALE** (metadata does not create the processor). ## Shipping methods (Merchant Tools > Ordering > Shipping Methods) After importing `metadata/site/shippingmethods.xml` you will have Global-e shipping methods (IDs start with `GLOBALE` — for example `GLOBALE`, `GLOBALE_STANDARD`, `GLOBALE_EXPRESS`). These methods are placeholders so Salesforce B2C Commerce can create SFCC orders correctly — they are not live Global-e carrier methods. After a fresh import, open each Global-e shipping method and verify **Tax Class** is **Standard** or a valid custom tax class — not **Undefined** (a fresh import can reset it). ## Site Preferences (Merchant Tools > Site Preferences > Custom Site Preference Groups) ### Global-e Settings Obtain merchant details (Client JS Merchant ID, Merchant GUID, API base URL, and SDK base URL) from your Global-e project manager. **Site preferences** — in *Merchant Tools > Site Preferences > Custom Site Preference Groups > Global-e Settings*, set: | Preference | Description | | - | - | | **Global-e Enabled** (`geEnabled`) | Set to **Yes** when the site is ready for Global-e. | | **Global-e API Base URL** (`geApiUrl`) | Base URL for outbound Global-e API calls (for example `https://connect.bglobale.com`). Environment-specific; set per site. | | **Service Endpoint Config** (`geServiceEndpointConfig`) | Optional JSON map of per-service URL and/or credential overrides (see [Services configuration](/services-configuration-sfcc)). | | **Client JS Merchant ID** (`geClientJsMerchantId`) | Your numeric merchant account ID from Global-e (for example `10001`). Used by the storefront SDK and as the suffix for merchant GUID credentials. | | **Global-e Client JS SDK Base URL** (`geClientJsBaseUrl`) | Base URL for loading the Global-e client SDK (environment-specific; provided by Global-e). | ### Merchant GUID credentials (required) Metadata import creates Global-e **service instances** and a placeholder credential **`Globale-MerchantAccount`** (empty URL and password). That stub satisfies SFCC wiring only — **it is not your merchant account**. You must create **account ID credentials** manually for every Global-e merchant account used on the instance. In *Administration > Operations > Services > Credentials*, create: | Credential ID | Required when | URL | Password | | - | - | - | - | | **`Globale-{geClientJsMerchantId}`** | Every site using that merchant account (for example `Globale-10001` when Client JS Merchant ID is `10001`) | **Empty** | Merchant GUID (UUID from Global-e) | Rules: * **One credential per merchant account ID** on the instance (not per site). If two sites use merchant ID `10001`, they share `Globale-10001`; set **`geApiUrl`** per site for environment (INT, QA, HF, etc.). * If multiple merchant accounts are used (for example `10001` and `10002`), create **`Globale-10001`** and **`Globale-10002`**. * The cartridge reads **API base URL** from site preference **`geApiUrl`** and **Merchant GUID** from the credential **Password** for outbound calls and inbound request validation. * Optional extra credentials (password only), for example **`Globale-10001-PROD`**, only when a site uses **`geServiceEndpointConfig`** to point a specific service at a different protected GUID — see [Services configuration](/services-configuration-sfcc). Without `Globale-{merchantId}` credentials, outbound API calls and inbound Global-e callbacks (cart validation, order notifications, etc.) will fail. **Per-service endpoint overrides** — optional site preference **`geServiceEndpointConfig`** (JSON) in the Global-e Settings group. Keys are SFCC service IDs (for example `Globale-RecentProductCountryS`). Values are a relative path or full `https://` URL, or an object `{ "url": "...", "credentialId": "Globale-10001-PROD" }` when a service must use a different protected GUID credential. When empty, cartridge defaults apply with `geApiUrl`. ### Global-e Product Settings In *Merchant Tools > Site Preferences > Custom Site Preference Groups > Global-e Product Settings*, set **Product Image ViewType** (`geProductImageViewType`) to the catalog view type whose URLs should be sent to Global-e (for example `large`). Other **GLOBALE-PRODUCT** preferences are optional but recommended. Full descriptions and examples are in [Metadata](/metadata-sfcc). ### Global-e OCAPI Settings In *Merchant Tools > Site Preferences > Custom Site Preference Groups > Global-e OCAPI Settings*, set: | Preference | Description | | - | - | | **OCAPI Version** (`geOCAPIVersion`) | Required for headless / OCAPI integrations. Use a different format than the system OCAPI version — for example system version `21.3` maps to `v21_3`. | | **OCAPI Client ID** (`geOCAPIClientId`) | Required whenever `geCAPIType` uses OCAPI. Dedicated Account Manager API client — do not reuse the Data OCAPI client. | These preferences are not flagged mandatory in the metadata schema; set them whenever the site uses OCAPI. ## Price Books (Merchant Tools > Products and Catalogs > Price Books) See [Price Calculation](/price-calculation-sfcc) for configuration options and use cases. ## Pipeline URLs mapping (Merchant Tools > SEO > URL Rules) Navigate to *Business Manager > Site > Merchant Tools > Site URLs > URL Rules > Pipeline URLs* and set: | Alias | Pipeline | | - | - | | globale/checkout/pspredirect | Globale-PaymentRedirect | ## Open Commerce API Settings (Administration > Site Development > Open Commerce API Settings) Global-e uses OCAPI in two ways. Configure each with a **dedicated** Account Manager API client — do not reuse the same client for Shop and Data. ### Shop API (headless / Commerce API) Configure Shop API permissions for your headless OCAPI client. A reference template is in the repository at `metadata/ocapi-settings/wapi_shop_config.json`. Adjust `_v` and `client_id` for your instance; include at least basket read/update, coupon, session, customer auth, and order create: ```json theme={null} { "_v": "24.5", "clients": [ { "client_id": "your-account-manager-client-id", "resources": [ { "resource_id": "/customers/auth", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/sessions", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/baskets/*", "methods": ["get", "patch", "delete"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/baskets/*/coupons", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/baskets/*/coupons/*", "methods": ["delete"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/orders", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" } ] } ] } ``` Headless integrations also require `int_globale_headless` on the cartridge path — see [Hooks](/hooks-sfcc) § Headless. ### Data API (mandatory for new integrations) New Global-e SFCC integrations must create a **dedicated** Account Manager API client and grant it **Data** OCAPI permissions in Business Manager (type **Data**, context **Global**). Global-e uses this client over OCAPI to keep your storefront configuration aligned with Global-e — for example starting configuration sync jobs such as **GlobaleSettings**, and reading related Global-e custom objects, site preference groups, and product information. The resource list below defines the full access scope. Salesforce references: [Client Application Identification](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-commerce-ocapi/clientapplicationidentification.html), [OCAPI Settings](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-commerce-ocapi/ocapisettings.html). **Step 1** In **Account Manager**, create an API client (display name such as `Global-e Integration`), assign it to the organization and instances Global-e must call, set a password (OAuth client secret), and copy the **API Client ID**. Keep the client **Enabled**. **Step 2** In **Business Manager** → **Administration → Site Development → Open Commerce API Settings**, select type **Data** and context **Global**. Paste the JSON below (or start from `metadata/ocapi-settings/wapi_data_config.json`), replace `client_id` with the Account Manager client ID, then **Save**. `_v` is the OCAPI Settings document version (not the API URL version such as `v21_10`). Settings can take a few minutes to become effective. **Step 3** Share the following with Global-e over a secure channel: **client ID**, **password** (client secret), **SFCC base URL(s)**, and the **OCAPI Data API version** used on your instance (path segment such as `v21_10`). ```json theme={null} { "_v": "24.5", "clients": [ { "client_id": "your-account-manager-client-id", "allowed_origins": [], "resources": [ { "resource_id": "/jobs/*/executions", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/jobs/*/executions/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_APP_SETTINGS/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_COUNTRIES/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_COUNTRY_COEFFICIENTS/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_PRODUCT_CLASS_COEFFICIENTS/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_CULTURES/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_CURRENCIES/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_CURRENCY_RATES/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_ROUNDING_RULES/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_CACHE_PRICE_BOOK_COMBINATION/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_HUB_DETAILS/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_ORDER_NOTIFICATION/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_INBOUND_ORDER_FALLBACK/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_INVENTORY_NOTIFICATION/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_RESTRICTED_ITEMS/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_COUPON_REDEMPTIONS/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/custom_objects/GLOBALE_LOCAL_STORAGE/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/site_preferences/preference_groups/GLOBALE/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/site_preferences/preference_groups/GLOBALE-PRODUCT/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/site_preferences/preference_groups/GLOBALE-OCAPI/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/site_preferences/preference_groups/GLOBALE-SCAPI/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/sites/*/site_preferences/preference_groups/GLOBALE-CATALOG-JOBS/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/product_search", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/products/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/products/*/variation_groups", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/products/*/variation_groups/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/products/*/variations", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" }, { "resource_id": "/products/*/variations/*", "methods": ["get"], "read_attributes": "(**)", "write_attributes": "(none)" } ] } ] } ``` If Global-e needs additional OCAPI resources later, add the corresponding entries under `resources`. ## Services (Administration > Operations > Services) After importing `metadata/services.xml` you will have Global-e **service instances** (IDs start with `Globale-`) and the placeholder credential **`Globale-MerchantAccount`**. Service paths and API base URLs are **not** configured in per-endpoint credentials — they come from cartridge defaults, site preference **`geApiUrl`**, and optional **`geServiceEndpointConfig`**. You must still create **`Globale-{merchantId}`** merchant GUID credentials manually — see [Merchant GUID credentials (required)](#merchant-guid-credentials-required). Disable rate limiting on **Globale-SendCartV2** and enable communication logging on all Global-e services for at least the first few weeks after production launch. ## Scheduled Jobs (Administration > Operations > Jobs) After importing `metadata/jobs.xml` you will have Global-e jobs (IDs start with `Globale`). Run the **GlobaleSettings** job manually to pull configuration from Global-e into `GLOBALE_*` custom objects. After you complete [Data API](#data-api-mandatory-for-new-integrations) setup, Global-e can also start this sync over OCAPI when configuration changes. All Global-e jobs except **GlobaleSettings** are disabled by default — adjust schedules per your integration scope. Assign **GlobaleSettings** job flows only to sites operated by Global-e. For job purpose, step details, and scheduling guidance, see [Jobs](/jobs-sfcc). # Configurations Source: https://docs.global-e.com/configurations The following email customization is available: * Email Text * Sender Address * BCC For Customer Email * Customer Support Email / Help Center * Setting a link per country * Emails Language by Order Language * Send Emails in Cultures for Specific Countries Only * Display post-discount product prices * Convert Product’’ description to hyperlinks * Configure MetaData text to be displayed # Configuring and Managing Returns Reasons in the Portal Source: https://docs.global-e.com/configuring-and-managing-returns-reasons-in-the-portal ## Overview Use the **Admin Dashboard** home page and the **Manage Returns** page to monitor and process return and exchange requests (RMAs). The home page highlights what needs action, and Manage Returns is the main workspace for searching, filtering, reviewing, and completing RMA workflows. **Manage Your Returns** shows your status counts and shortcuts, while **Return Portal** includes a link to your live Return portal. > [!NOTE] > > Your layout may differ depending on your settings. ## Objectives By the end of this guide, you will be able to: * Use the home page to jump to key return queues. * Search, sort, and filter RMAs by status in Manage Returns. * Review an RMA and complete common actions (approve, reject, cancel, reopen, receive, done). * Validate, restock, and refund/credit. * Export a returns data report and find RMAs that require attention. ## Prerequisites Access to the Admin Dashboard with permission to manage RMAs. ## Understanding the Home Screen The Home screen is divided into sections that classify returns at different status, each representing a stage in the return life cycle. These sections are located in the **Manage Your Returns** section. In addition, the **Return Portal** section on this page shows your Returns Portal URL, which you can add to your store or share with customers. The following figure shows the **Home** screen: ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-75c10789-6293-cd58-ee08-ef0349a9417a.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=cedf1895571ad0e1a42b7fc473e86fb6) From here you can view: * Return requests that require your attention * Pending return requests to approve * Return shipments to be sent * Return shipments in transit * Received shipments to resolve You can expand each group by clicking the one you want to expand. Each row corresponds to a group. Each group shows a number, indicating the amount of items on that page. Clicking a group expands on a different page. ## Managing Returns In the Home screen description, we mentioned that you can view returns at different stages of the return life cycle. When you click one of the life cycle groups mentioned earlier, you can view the requests across the entire return life cycle. ### To manage returns 1. From the Home screen, click one of the following: * Return requests that require your attention * Pending return requests to approve * Return shipments to be sent * Return shipments in transit * Received shipments to resolve 2. In the top row, click one of the following status filters: > [card] > > * All > * Open RMAs > * Pending requests > * Approved requests > * In transit > * Shipment received > [card] > > * Done > * Rejected requests > * Canceled requests > * Shipment rejected > * Require attention > [!WARNING] > > RMAs that require attention pause processing until you resolve the issue. Hovering over an RMA number that requires attention shows a prompt providing the reason that it requires attention. ## Searching for an RMA ### To search for an RMA 1. Navigate to *Returns & Exchanges > Manage Returns*. 2. In the **Search RMA or order number** text field, type an RMA number, order number, or customer ID. 3. Optional: * Disable **Exact match** to search by partial number. * Enable **Exact match** to search by full number only. 4. Click the **search** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-90495a01-ea5b-d064-098e-b9d388c5e8cd.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=4f82fd9cf312287d99a56439669880bc) *button*. ## Sorting and Filtering RMAs ### To configure the Date column 1. Navigate to *Returns & Exchanges > Manage Returns*. 2. Click **SETTINGS**. 3. From the **Date Column** menu, select one: * RMA created * Shipment delivered * Shipment in-transit 4. Click **SAVE**. 5. Filter RMAs using any of the following: * Date Created (Select a start and end date, and click **Apply** to apply your date range) * Resolutions (exchange, return resolutions, other) * Return reason * Resolutions (exchange, return resolutions, other) * Reserved Item Expiration (All / By Date Range / By Days Remaining / Expired Reservations), requires item reservation * Refund/Payment Status (All / Not Refunded / Not Paid / Paid / Expiring/Expired Payments) 6. Click **APPLY**. ## Viewing RMA Details ### To view RMA details 1. Search for an RMA. 2. From the search results, click an RMA number. From here you can view: * RMA summary and order summary * Customer information * Original items and new items (if applicable) * Shipments and draft orders * Timeline * Bottom action bar (actions change by status) ## Approving a Return Request ### To approve a return request 1. Open the relevant RMA. 2. Review the request details. 3. Click **APPROVE** in the bottom action bar. ## Rejecting a Return Request ### To reject a return request 1. Open the relevant RMA. 2. Click **REJECT**. 3. Enter a rejection reason. 4. Click **SUBMIT**. ## Canceling an RMA ### To cancel an RMA 1. Open the relevant RMA. 2. Click **CANCEL**. 3. Confirm the cancellation. ## Reopening a Canceled RMA ### To reopen a canceled RMA 1. Open the canceled RMA. 2. Click **REOPEN**. ## Issuing a Refund or Credit ### To issue a refund or credit 1. Open the relevant RMA. 2. Click **REFUND/CREDIT**. 3. Review the refund calculator. 4. Click **APPLY**. 5. Select the refund method. 6. Click **SUBMIT**. ## Exporting a Returns Data Report ### To export a returns data report 1. Navigate to *Returns & Exchanges > Manage Returns*. 2. Click **EXPORT**. 3. Select the desired export format and filters. 4. Click **DOWNLOAD**. # Configuring and Managing Returns Reasons in the Portal Source: https://docs.global-e.com/configuring-and-managing-returns-reasons-in-the-portal-520608 **Overview** Use the **Admin Dashboard** home page and the **Manage Returns** page to monitor and process return and exchange requests (RMAs). The home page highlights what needs action, and Manage Returns is the main workspace for searching, filtering, reviewing, and completing RMA workflows. **Manage Your Returns** shows your status counts and shortcuts, while **Return Portal** includes a link to your live Return portal. > [!NOTE] > > Your layout may differ depending on your settings. **Objectives** By the end of this guide, you will be able to: * Use the home page to jump to key return queues. * Search, sort, and filter RMAs by status in Manage Returns. * Review an RMA and complete common actions (approve, reject, cancel, reopen, receive, done). * Validate, restock, and refund/credit. * Export a returns data report and find RMAs that require attention. **Preriquisites** Access to the Admin Dashboard with permission to manage RMAs. **Understanding the Home Screen** The Home screen is divided into sections that classify returns at different status, each representing a stage in the return life cycle. These sections are located in the **Manage Your Returns** section. In addition, the **Return Portal** section on this page shows your Returns Portal URL, which you can add to your store or share with customers. The following figure shows the **Home** screen: ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-75c10789-6293-cd58-ee08-ef0349a9417a.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=cedf1895571ad0e1a42b7fc473e86fb6) From here you can view: * Return requests that require your attention * Pending return requests to approve * Return shipments to be sent * Return shipments in transit * Received shipments to resolve You can expand each group by clicking the one you want to expand. Each row corresponds to a group. Each group shows a number, indicating the amount of items on that page. Clicking a group expands on a different page. **Managing Returns** In the Home screen description, we mentioned that you can view returns at different stages of the return life cycle. When you click one of the life cycle groups mentioned earlier, you can view the requests across the entire return life cycle. ## To manage returns 1. From the Home screen, click one of the following: * Return requests that require your attention * Pending return requests to approve * Return shipments to be sent * Return shipments in transit * Received shipments to resolve 2. In the top row, click one of the following status filters: > [card] > > * All > * Open RMAs > * Pending requests > * Approved requests > * In transit > * Shipment received > [card] > > * Done > * Rejected requests > * Canceled requests > * Shipment rejected > * Require attention > [!WARNING] > > RMAs that require attention pause processing until you resolve the issue. Hovering over an RMA number that requires attention shows a prompt providing the reason that it requires attention. **Searching for an RMA** ## To search for an RMA 1. Navigate to *Returns & Exchanges > Manage Returns*. 2. In the **Search RMA or order number** text field, type an RMA number, order number, or customer ID. 3. Optional: * Disable **Exact match** to search by partial number. * Enable **Exact match** to search by full number only. 4. Click the **search** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-90495a01-ea5b-d064-098e-b9d388c5e8cd.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=4f82fd9cf312287d99a56439669880bc) *button*. **Sorting and Filtering RMAs** ### To configure the Date column 1. Navigate to *Returns & Exchanges > Manage Returns*. 2. Click **SETTINGS**. 3. From the **Date Column** menu, select one: * RMA created * Shipment delivered * Shipment in-transit 4. Click **SAVE**. 5. Filter RMAs using any of the following: * Date Created (Select a start and end date, and click **Apply** to apply your date range) * Resolutions (exchange, return resolutions, other) * Return reason * Resolutions (exchange, return resolutions, other) * Reserved Item Expiration (All / By Date Range / By Days Remaining / Expired Reservations), requires item reservation * Refund/Payment Status (All / Not Refunded / Not Paid / Paid / Expiring/Expired Payments) 6. Click **APPLY**. **Viewing RMA Details** #### To view RMA details 1. Search for an RMA. 2. From the search results, click an RMA number. From here you can view: * RMA summary and order summary * Customer information * Original items and new items (if applicable) * Shipments and draft orders * Timeline * Bottom action bar (actions change by status) **Approving a Return Request** #### To approve a return request 1. Open the relevant RMA. 2. Review the request details. 3. Click **APPROVE** in the bottom action bar. **Rejecting a Return Request** #### To reject a return request 1. Open the relevant RMA. 2. Click **REJECT**. 3. Enter a rejection reason. 4. Click **SUBMIT**. **Canceling an RMA** #### To cancel an RMA 1. Open the relevant RMA. 2. Click **CANCEL**. 3. Confirm the cancellation. **Reopening a Canceled RMA** #### To reopen a canceled RMA 1. Open the canceled RMA. 2. Click **REOPEN**. **Issuing a Refund or Credit** #### To issue a refund or credit 1. Open the relevant RMA. 2. Click **REFUND/CREDIT**. 3. Review the refund calculator. 4. Click **APPLY**. 5. Select the refund method. 6. Click **SUBMIT**. **Exporting a Returns Data Report** #### To export a returns data report 1. Navigate to *Returns & Exchanges > Manage Returns*. 2. Click **EXPORT**. 3. Select the desired export format and filters. 4. Click **DOWNLOAD**. # Configuring Auto-Approvals Source: https://docs.global-e.com/configuring-auto-approvals Auto-approvals automatically approve RMAs that meet policy rule criteria. ## To configure auto-approval 1. Complete accessing your policy rules. 2. In the dropdown menu located to the right of **Approval Process**, select **Automatic**. 3. Click the **save icon** in the top right corner. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b7836736-2ec9-e0f9-b410-1beae89a91c9.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=3e90849eee1867f88516920d68a9bbca) > [!NOTE] > > The save icon is only displayed when you change your Approval Process selection. 4. In the left menu, click **Returns & Exchanges**.The **Manage Returns** window is displayed. 5. Click an RMA that matches the conditions in the policy rule. 6. Confirm the RMA does not remain in **Pending Requests**. # Configuring Auto-Refunds Source: https://docs.global-e.com/configuring-auto-refunds Auto-refund issues refunds based on events (immediate or delayed) you select, and is configured per policy rule. ## To configure auto-refund 1. Complete accessing your policy rules. 2. In the dropdown menu located to the right of **Refund Process**, select **Automatic**.The **Trigger** and **Execute** dropdown menus are displayed. 3. Set the **Trigger** event: * RMA is approved * Shipment is in transit * Shipment has been received * Items have been validated > [!NOTE] > > The available trigger options vary according to trigger selection and account. For example, selecting Items have been disabled displays the **Validation** dropdown menu. 4. In the **Execute** field, select one of the following: * Immediately * After... 5. Do one of the following: * If you selected Immediately, skip to [Step 6](/configuring-auto-refunds). * If you selected **After...**, set the following: * Number value * Time unit ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7aed6d71-2926-3aa2-8083-28a82cc6d3ae.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=dcb13479d3c9d8e475c1b872490c0fee) 6. Click the **save icon**. > [!NOTE] > > The save icon is only displayed when you change your Approval Process selection. # Configuring Automation Rules for Returns Source: https://docs.global-e.com/configuring-automation-rules-for-returns ## Overview **Automation rules** in the Admin Dashboard gives you automated control over the return life cycle. Configuring automation per policy rule lets you automatically approve RMAs, issue refunds, and mark RMAs as done, while keeping exceptions available for manual review. ## Objectives By the end of this guide, you will be able to: * Update a policy rule to use automated approval, refunds, and completion. * Configure automation triggers and delays (when available). * Enable item validation workflows for warehouse teams where required. * Verify that automations executed successfully (and troubleshoot common blockers). ## Prerequisites * You have access to the **Admin Dashboard** with permission to edit **Settings** (policy rules and store settings). * Your store is connected to **Shopify**. ## Accessing Your Policy Rules Because Global-e configures automation per policy rule, you can combine manual and automatic processing across different scenarios. ### To access a policy rule 1. Navigate to *Settings > Return Policy*. 2. The **Settings – Return Policy** page is displayed. 3. On the right side of the screen, click **Expand all**. 4. Click the **pencil** icon located to the right of the policy rule you want to update. 5. The selected policy rule’s details are displayed. 6. Expand the **RMA Handling Process** section. 7. Do one or more of the following: * [Configure Auto-Approval](/configuring-automation-rules-for-returns#configuring-auto-approvals) * [Configure Auto-Refund](/configuring-automation-rules-for-returns#configuring-auto-refund) * [Set Auto-Mark as Done](/configuring-automation-rules-for-returns#setting-auto-mark-as-done) * [Set Mark as Done after Partial Validation](/configuring-automation-rules-for-returns#setting-mark-as-done-after-partial-validation) * [Enable item validation](/configuring-automation-rules-for-returns#enabling-item-validation-for-warehouse-workflows) * [Validate items](/configuring-automation-rules-for-returns#validating-items) * [Verify and monitor your automation results](/configuring-automation-rules-for-returns#verifying-and-monitoring-automation-results) ## Configuring Auto-Approvals Auto-approvals automatically approve RMAs that meet policy rule criteria. ### To configure auto-approval 1. Complete [accessing your policy rules](/configuring-automation-rules-for-returns#accessing-your-policy-rules). 2. In the dropdown menu located to the right of **Approval Process**, select **Automatic**. 3. Click the **save** icon in the top right corner. > [!NOTE] > > The save icon is only displayed when you change your **Approval Process** selection. ## To verify auto-approval 1. Navigate to *Returns & Exchanges*.The **Manage Returns** window is displayed. 2. Click an RMA that matches the conditions in the policy rule. 3. Confirm the RMA is showing as **Approved**, and does not remain in **Pending Requests**. ## Configuring Auto-Refund Auto-refund issues refunds based on events (immediate or delayed) you select, and is configured per policy rule. ### To configure auto-refund 1. Complete [accessing your policy rules](/configuring-automation-rules-for-returns#accessing-your-policy-rules). 2. In the dropdown menu located to the right of **Refund Process**, select **Automatic**.The **Trigger** and **Execute** dropdown menus are displayed. 3. Set the **Trigger** event: * RMA is approved * Shipment is in transit * Shipment has been received * Items have been validated > [!NOTE] > > The available trigger options vary according to trigger selection and account. For example, selecting **Items have been validated** displays the **Validation** dropdown menu 4. In the **Execute** field, select one of the following: * Immediately * After… 5. Do one of the following: * If you selected Immediately, skip to **Step 6**. * If you selected **After…**, set the following, as shown in the figure below: * Number value * Time unit ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-f8fe4a88-fe94-d13f-cfac-d10e7c868c82.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=5040b4b02cb72390e570a76c76e003ec) 6. Click the **save** icon located in the top right corner of the page. > [!NOTE] > > The **save** icon is only displayed when you change your **Approval Process** selection. ## Setting Auto-Mark as Done Auto-mark as done marks an RMA as **Done** when all customer requests in the RMA are fulfilled. ### To set Auto-Mark as done 1. Complete [accessing your policy rules](/configuring-automation-rules-for-returns#accessing-your-policy-rules). 2. Set **Mark as Done** to **Automatic**. 3. Click the **save** icon located in the top right corner of the page. > [!NOTE] > > The save icon is only displayed when you change your **Approval Process** selection. 4. Verify that the auto-approval update worked: 1. Navigate to *Returns and Exchanges*. 2. Search or filter for an RMA processed under the policy rule in **Step**6 of **Configuring Auto-Approvals**. 3. Verify that the RMA status has changed to **Done automatically when conditions are met.** ## Setting Mark as Done After Partial Validation Setting **Mark as Done After Partial Validation** is an optional configuration that marks RMAs as Done after actions are completed, even if some items are negatively validated. This feature is activated only when all items have a validation status. > [!NOTE] > > This feature is limited to merchants with certain subscription plans. 1. Complete [accessing your policy rules](/configuring-automation-rules-for-returns#accessing-your-policy-rules). 2. Set **Mark as Done** to **Automatic**. 3. Select **Mark as Done After Partial Validation**. 4. Click the **save** icon located in the top right corner of the page. > [!NOTE] > > The **save** icon is only displayed when you change your **Approval Process** selection. ## Enabling Item Validation for Warehouse Workflows Item validation is an optional configuration. It supports automations that trigger on validation and is used for certain workflows, such as restocking. ### To enable item validation for warehouses 1. Navigate to *Settings > General*. 2. Scroll down to near the bottom of the page and expand **Items Validation**. 3. Select the **Document Shipment Content Inspection**. 4. Click the **save** icon in the top right corner. > [!NOTE] > > The **save** icon is only displayed when you change your **Approval Process** selection. ## Validating Items Validating items is only relevant for operations or the warehouse. ### To validate items 1. Navigate to *Returns and Exchanges*. 2. Search or filter for an RMA processed under the policy rule in **Step 6** of **Configuring Auto-Approvals**. 3. In the **Item Validation** region, set a status per item: * Returned * Returned + Restockable * Not Returned 4. Click **save** in the top right corner of the page. ## Verifying and Monitoring Automation Results Once you’ve set your configurations as needed, you can use the checks described in this section to verify and monitor your automation results. ### To verify and monitor automation results 1. Navigate to *Returns and Exchanges.* 2. Filter RMAs by status to confirm workflow status, such as: * Pending Requests * Requires Attention * Shipment Received * Done * Canceled Requests 3. Open an RMA. 4. Review the **Timeline** section for automation events, such as approval, refund, or completion. > [!TIP] > > If an RMA is stuck in the **Requires Attention** stage, verify that the automation trigger conditions were met, especially for validation-based automations. # Configuring Automation Rules for Returns Source: https://docs.global-e.com/configuring-automation-rules-for-returns-497380 This page describes the following: * [Overview](/overview) * [Objectives](/objectives) * [Prerequisites](/prerequisites-automation-rules) * [Accessing Your Policy Rules](/accessing-your-policy-rules) * [Configuring Auto-Approvals](/configuring-auto-approvals) * [Configuring Auto-Refunds](/configuring-auto-refunds) * [Setting Auto-Mark as Done](/setting-auto-mark-as-done) * [Setting Mark as Done After Partial Validation](/setting-mark-as-done-after-partial-validation) * [Enabling Item Validation for Warehouse Workflows](/enabling-item-validation-for-warehouse-workflows) * [Validating Items](/validating-items) * [Verifying and Monitoring Automation Results](/verifying-and-monitoring-automation-results) # Configuring Default RMA Values Source: https://docs.global-e.com/configuring-default-rma-values Configuring default RMA values lets you speed up the process and ensure RMAs are created properly to set the default values for internally-created RMAs. This is helpful especially if you always use the same policy. For instance, if you mostly create RMAs in-store, the return method will always be **Drop off at a store location**. > [!NOTE] > > You can select which fields to set defaults for and which to leave with no default. Global-e recommends setting automation defaults if you want to use automations for manually created RMAs or if you are accustomed to using a particular automation. > [!TIP] > > Set your defaults only for frequently-occurring cases and make sure to instruct your users to prevent mistakes. Configuring default values is a powerful tool and requires close attention to function optimally. ## To set RMA defaults for internally-created RMAs: 1. Navigate to *Settings > General*. 2. Expand the Internal RMA Creation section. 3. Set the item request defaults, including a default return reason, resolution, and return method, as well as fees and adjustments that will be the default for every item added to an RMA. 4. Set your automation defaults for internally-created RMAs. 5. Set the default for whether to send customer notifications on RMA updates. 6. Click the save icon to save your changes. # Configuring Default RMA Values Source: https://docs.global-e.com/configuring-default-rma-values-702686 Configuring default RMA values lets you speed up the process and ensure RMAs are created properly to set the default values for internally-created RMAs. This is helpful especially if you always use the same policy. For instance, if you mostly create RMAs in-store, the return method will always be **Drop off at a store location**. > [!NOTE] > > You can select which fields to set defaults for and which to leave with no default. Global-e recommends setting automation defaults if you want to use automations for manually created RMAs or if you are accustomed to using a particular automation. > [!TIP] > > Set your defaults only for frequently-occurring cases and make sure to instruct your users to prevent mistakes. Configuring default values is a powerful tool and requires close attention to function optimally. ## To set RMA defaults for internally-created RMAs: 1. Navigate to *Settings > General*. 2. Expand the Internal RMA Creation section. 3. Set the item request defaults, including a default return reason, resolution, and return method, as well as fees and adjustments that will be the default for every item added to an RMA. 4. Set your automation defaults for internally-created RMAs. 5. Set the default for whether to send customer notifications on RMA updates. 6. Click the save icon to save your changes. # Configuring Eligibility Conditions Source: https://docs.global-e.com/configuring-eligibility-conditions ## Overview Eligibility conditions are return policy rule properties that determine which customers, orders, and items are eligible to be returned or exchanged in the **New Return Portal**. The platform evaluates eligibility using order, customer, item, and RMA-level conditions, and shows customers which items they can, or cannot, select. The following video describes the eligibility condition configuration: [Embedded media](https://player.vimeo.com/video/1164297904) ## What You’ll Accomplish * Understand how eligibility appears to customers in the **New Return Portal**. * Configure eligibility conditions in the admin dashboard using return policy rules. * Set up Tracking Fallback settings to prevent missing delivery dates from affecting eligibility logic. * Test your setup safely using **Preview Mode** (no RMAs created). ## Requirements * Access to the **Admin Dashboard** * Permissions to edit **Settings** (including **Return Policy** and **Store Settings**) > [!NOTE] > > If you can’t see these menus, confirm your role/permissions with your team. ## Before You Start The following actions are recommended before you start: * List all scenarios you want to allow or deny, such as *“Final sale items not eligible”* or *“Eligible for 30 days from delivery”.* * Decide which eligibility level each scenario belongs to: * **Order-level** (such as order creation/delivery date, order tags, payment type) * **Customer-level** (such as location, customer type, customer tags) * **Item-level** (such as item tags, price paid, discount code, vendor) * **RMA-level** (such as total value or weight of items selected in the return) > [!TIP] > > To avoid logic conflicts, prefer **positive logic** (such as *“Eligible if delivered within 30 days”*) over negative logic (such as, *“Not eligible if not within 30 days”*). ## Viewing Eligibility in the New Return Portal This section describes how eligibility looks on the customer portal. ### To view eligibility in the New Return Portal 1. Access the **New Return Portal**. 2. Enter the customer’s order ID and the required identifier (email, ZIP, or phone number). ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/uuid-029def08-b40c-5d09-2961-a10a975c09a7.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=a6c1eb2bf3e6e0d3062018c3efae09d3) 3. Load the order and review the item list: * Eligible items are selectable. * Ineligible items are shown as not eligible and cannot be selected. The following figure shows the item list: ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-dfac2679-c526-ec47-a8c1-0ed287958a9b.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=4fad00035bb2ac2b95b01d32af4c07fc) ## Accessing Return Policy Rules on the Admin Dashboard ### To access the return policy rules region on the Admin Dashboard 1. Navigate to *Settings > Return Policy*. 2. Locate a policy rule. ## Creating a New Policy Rule ### To create a new rule 1. Navigate to *Settings > Return Policy*. 2. Click **ADD RULE**. 3. On the **Details** page, configure the rule basics. 4. For example, you can configure **rule name**, **resolution**, r**eturn method**. Note that fields may vary by account. 5. At the bottom of the page, click **Eligibility**. #### To edit an existing rule 1. Navigate to *Settings > Return Policy*. 2. (Optional) Click **EXPAND ALL** to find the rule quickly. 3. Click the pencil icon to the far right correspond to the policy rule you want to edit. 4. Click **Eligibility**. ## Configuring Eligibility Conditions In the **Eligibility** section, you can build your rule using the supported eligibility levels: **Order-level** conditions (examples supported): * Eligibility based on **order creation time frame** * Eligibility based on **order creation date** * Eligibility based on **original order creation date** (days or months) * Eligibility based on **order fulfillment date** (if fulfillment date is missing, the fallback is o**rder creation date**) * Eligibility based on **order delivery date** (if delivery date is missing, the fallback depends on **Tracking Fallback** settings) * Eligibility based on **order tags** (all/some/none; comma-separated; not case sensitive) * Eligibility based on **the number of RMAs created** (for the order) * Eligibility based on **order value** * Eligibility based on **payment type** (including whether paid with gift cards: only/partially/without) * Eligibility based on **included items** * Eligibility based on **custom attribute** * Eligibility based on **purchase source** or sales channel The figure below shows the eligibility conditions: ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a193fc79-c4a4-70cd-5b0e-16a06028f354.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=b1320fb84688cc02967b5ec6431ecb6b) **Customer-level** conditions (examples supported): * Eligibility based on the **customer’s location** (uses OR logic across selected locations) * Eligibility based on **customer tag** (current and historical tags) * Eligibility based on **customer type** (Registered/Guest) * Eligibility based on the **number of RMAs created by the customer** The following figure shows the customer-level conditions: ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ea5ca769-ff25-f0df-619d-f1718b65a6e1.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=87c1dd92173708ac224fb05a10414324) **Item-level** conditions (examples supported): * **Catalog price, paid price, cost** * **Item name** (contains/is and opposites; comma-separated; not case sensitive) * **Item tags** and **item historical tags** * **Number of exchanges** * **Discount codes** (contains/is and opposites) * **Discount value** (amount/percentage/comparative price percentage) * **Total compare-at price and discount %** (discount codes not included) * **Return reason** (limit offered resolutions based on the selected reason) * **Item weight, vendor, collection ID, custom attribute** (key/value) * **Item fulfillment** * **Percentage of the order value** ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-519aa130-465a-52d2-0fad-b0cd211a0492.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=9ba0febfa162a9462142452f62b8da8a) **RMA-level** conditions (examples supported): * Total **listed price**, total **paid price**, total **cost** * **Number of items** being returned (raw item count) * Overall **weight** * **Percentage of the order value** * **Kept order value** * Contains **items tags** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-49f43afb-63c1-3916-2ebe-a507c2719e16.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=0b92de852d8dfec76d0bc5382b119699) > [!WARNING] > > Eligibility is evaluated across all four levels. If **any** level results in **not eligible**, the policy rule will not be applied to that item. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e85f45a6-69bf-579d-ab17-3b9b49c70670.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=5dd6566c62d4bdf0648aa43682835dda) > [!WARNING] > > **AND/OR limitation:** You can’t combine **AND** and **OR** within the same eligibility level. Each level must use either all ANDs or all ORs. For complex logic, split conditions across multiple eligibility rules or different eligibility levels. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c3a4f543-8132-51b5-f932-73062818f0e5.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=0c53b9d332de66fff21d30927b00a409) ## Activating and Saving Policy Rules This section describes how to activate and save policy rules. ### To activate and save policy rules 1. Enable **Activate Policy Rule**. 2. Click the **save** icon located in the top right corner of the page. > [!NOTE] > > Saved changes will not affect the **New Return Portal** unless the rule is activated. ## Configuring Tracking Fallback This is an optional, but **highly recommended**, configuration. Configuring tracking fallback is used for delivery-based eligibility. If you use eligibility based on **order delivery date** and delivery dates may be missing, configure **Tracking Fallback** to ensure that eligibility checks run as expected. ### To configure tracking fallback 1. Navigate to *Settings > Genera*l. 2. Expand the **Tracking Fallback** section. 3. Set **When to refer to orders to Delivered**. > [!NOTE] > > Used when checking eligibility conditions, such as **Orders that were delivered…**, with a missing delivery date. 4. Set **When to refer to in-transit return shipments as Delivered**. > [!NOTE] > > This is used for automations triggered by a return shipment’s status. 5. Click the **save** icon in the top right corner of the page. ## Running Step-by-Step Verification This section describes how to run step-by-step verification. ### To run step-by-step verification 1. Test safely using **Preview Mode**: 1. Navigate to the Admin Dashboard **Home** page. 2. Click **PREVIEW MODE**. A new tab opens with the **New Return Portal** and a **Preview Mode** label (top right-hand corner of the page). ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-13fcd7b6-9404-a4b1-afc5-a01a99087e7f.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=34c30fc24d743b93335d37e10c4fd20a) 3. Enter a real order ID and test different scenarios (eligible vs not eligible items). > [!NOTE] > > Preview Mode lets you test without creating RMAs or sending notifications. 2. Confirm the customer-facing behavior in the **New Return Portal**: 1. Verify that eligible items are selectable, and ineligible items are marked **not eligible**. 2. Confirm the specific scenario you configured (such as date window, tags, reason, etc.) behaves as expected. ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fc6c0d50-9d90-088a-ff1a-68dbcaa70ada.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=6872f6899d94b27f1cc5d67683be2576) 3. Do one of the following: * **If you created a real RMA** - in the Admin Dashboard, verify your eligibility settings. * **If you tested outside of Preview Mode and submitted a real return** - navigate to **Manage Returns** and open the RMA to review what was returned and the results. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-84c7d1fb-e8e3-4072-6ffb-c75453253cf1.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=93fc115a360f162929c591e76bafbe8a) ## Reports and Analyses Eligibility controls what customers can select in the **New Return Portal** and which **policy rules** apply. If you need analytics or export specifics for returns created under certain rules, confirm which reporting views are enabled in your Admin Dashboard (Analytics, exports, etc.). ## Troubleshooting Common Issues This section describes how to troubleshoot common issues: | Issue | Solution | | - | - | | Nothing changes in the New Return Portal | Confirm the rule is toggled **Activate Policy Rule** = ON and saved (save icon). | | Delivery-based rules behave inconsistently | Configure Tracking Fallback so missing delivery dates don’t block eligibility checks. | | Complex logic not working | You can’t mix AND and OR within the same eligibility level. Split logic across multiple rules or levels. | | Expected item data is missing | Deleted/null items aren’t supported for eligibility checks (no item data to process a return). | | Tag rules not matching | Tags are not case sensitive; comma-separated values represent “A or B or C.” Also confirm whether the condition checks all/some/none. | ## Frequently Asked Questions This section includes some frequently asked questions and their answers. ### How are multiple eligibility levels combined? If any eligibility level (order/customer/item/RMA) evaluates to not eligible, the policy rule won’t apply to that item. ### Can I use AND and OR together in the same eligibility level? No. AND/OR cannot be combined within the same eligibility level. ### What happens if delivery date is missing? Delivery-based eligibility uses your Tracking Fallback settings. # Configuring Eligibility Conditions Source: https://docs.global-e.com/configuring-eligibility-conditions-520756 **New Return Portal** Eligibility conditions are return policy rule properties that determine which customers, orders, and items are eligible to be returned or exchanged in the **New Return Portal**. The platform evaluates eligibility using order, customer, item, and RMA-level conditions, and shows customers which items they can, or cannot, select. **What You'll Accomplish** * Understand how eligibility appears to customers in the **New Return Portal**. * Configure eligibility conditions in the admin dashboard using return policy rules. * Set up Tracking Fallback settings to prevent missing delivery dates from affecting eligibility logic. * Test your setup safely using **Preview Mode** (no RMAs created). **Requirements** * Access to the **Admin Dashboard** * Permissions to edit **Settings** (including **Return Policy** and **Store Settings**) > [!NOTE] > > If you can’t see these menus, confirm your role/permissions with your team. **Before You Start** The following actions are recommended before you start: * List all scenarios you want to allow or deny, such as *“Final sale items not eligible”* or *“Eligible for 30 days from delivery”.* * Decide which eligibility level each scenario belongs to: * **Order-level** (such as order creation/delivery date, order tags, payment type) * **Customer-level** (such as location, customer type, customer tags) * **Item-level** (such as item tags, price paid, discount code, vendor) * **RMA-level** (such as total value or weight of items selected in the return) > [!TIP] > > To avoid logic conflicts, prefer **positive logic** (such as *“Eligible if delivered within 30 days”*) over negative logic (such as, *“Not eligible if not within 30 days”*). **Viewing Eligibility in the New Return Portal** This section describes how eligibility looks on the customer portal. ## To view eligibility in the New Return Portal 1. Access the **New Return Portal**. 2. Enter the customer’s order ID and the required identifier (email, ZIP, or phone number). ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/uuid-029def08-b40c-5d09-2961-a10a975c09a7.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=a6c1eb2bf3e6e0d3062018c3efae09d3) 3. Load the order and review the item list: * Eligible items are selectable. * Ineligible items are shown as not eligible and cannot be selected. The following figure shows the item list: ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-dfac2679-c526-ec47-a8c1-0ed287958a9b.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=4fad00035bb2ac2b95b01d32af4c07fc) **Accessing Return Policy Rules on the Admin Dashboard** ### To access the return policy rules region on the Admin Dashboard 1. Navigate to *Settings > Return Policy*. 2. Locate a policy rule. **Creating a New Policy Rule** #### To create a new rule 1. Navigate to *Settings > Return Policy*. 2. Click **ADD RULE**. 3. On the **Details** page, configure the rule basics. 4. For example, you can configure **rule name**, **resolution**, r**eturn method**. Note that fields may vary by account. 5. At the bottom of the page, click **Eligibility**. #### To edit an existing rule 1. Navigate to *Settings > Return Policy*. 2. (Optional) Click **EXPAND ALL** to find the rule quickly. 3. Click the pencil icon to the far right correspond to the policy rule you want to edit. 4. Click **Eligibility**. **Configuring Eligibility Conditions** In the **Eligibility** section, you can build your rule using the supported eligibility levels: **Order-level** conditions (examples supported): * Eligibility based on **order creation time frame** * Eligibility based on **order creation date** * Eligibility based on **original order creation date** (days or months) * Eligibility based on **order fulfillment date** (if fulfillment date is missing, the fallback is o**rder creation date**) * Eligibility based on **order delivery date** (if delivery date is missing, the fallback depends on **Tracking Fallback** settings) * Eligibility based on **order custom attributes** (all/some/none; comma-separated; not case sensitive) * Eligibility based on **the number of RMAs created** (for the order) * Eligibility based on **order value** * Eligibility based on **payment type** (including whether paid with gift cards: only/partially/without) * Eligibility based on **included items** * Eligibility based on **custom attribute** * Eligibility based on **purchase source** or sales channel The figure below shows the eligibility conditions: ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a193fc79-c4a4-70cd-5b0e-16a06028f354.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=b1320fb84688cc02967b5ec6431ecb6b) **Customer-level** conditions (examples supported): * Eligibility based on the **customer’s location** (uses OR logic across selected locations) * Eligibility based on **customer attribute** (current attributes) * Eligibility based on **customer type** (Registered/Guest) * Eligibility based on the **number of RMAs created by the customer** The following figure shows the customer-level conditions: ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ea5ca769-ff25-f0df-619d-f1718b65a6e1.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=87c1dd92173708ac224fb05a10414324) **Item-level** conditions (examples supported): * **Catalog price, paid price, cost** * **Item name** (contains/is and opposites; comma-separated; not case sensitive) * **Item attributes** * **Number of exchanges** * **Discount codes** (contains/is and opposites) * **Discount value** (amount/percentage/comparative price percentage) * **Total compare-at price and discount %** (discount codes not included) * **Return reason** (limit offered resolutions based on the selected reason) * **Item weight, vendor, collection ID, custom attribute** (key/value) * **Item fulfillment** * **Percentage of the order value** ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-519aa130-465a-52d2-0fad-b0cd211a0492.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=9ba0febfa162a9462142452f62b8da8a) **RMA-level** conditions (examples supported): * Total **listed price**, total **paid price**, total **cost** * **Number of items** being returned (raw item count) * Overall **weight** * **Percentage of the order value** * **Kept order value** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-49f43afb-63c1-3916-2ebe-a507c2719e16.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=0b92de852d8dfec76d0bc5382b119699) > [!WARNING] > > Eligibility is evaluated across all four levels. If **any** level results in **not eligible**, the policy rule will not be applied to that item. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e85f45a6-69bf-579d-ab17-3b9b49c70670.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=5dd6566c62d4bdf0648aa43682835dda) > [!WARNING] > > **AND/OR limitation:** You can’t combine **AND** and **OR** within the same eligibility level. Each level must use either all ANDs or all ORs. For complex logic, split conditions across multiple eligibility rules or different eligibility levels. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c3a4f543-8132-51b5-f932-73062818f0e5.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=0c53b9d332de66fff21d30927b00a409) **Activating and Saving Policy Rules** This section describes how to activate and save policy rules. ## To activate and save policy rules 1. Enable **Activate Policy Rule**. 2. Click the **save** icon located in the top right corner of the page. > [!NOTE] > > Saved changes will not affect the **New Return Portal** unless the rule is activated. **Configuring Tracking Fallback** This is an optional, but **highly recommended**, configuration. Configuring tracking fallback is used for delivery-based eligibility. If you use eligibility based on **order delivery date** and delivery dates may be missing, configure **Tracking Fallback** to ensure that eligibility checks run as expected. ## To configure tracking fallback 1. Navigate to *Settings > Genera*l. 2. Expand the **Tracking Fallback** section. 3. Set **When to refer to orders to Delivered**. > [!NOTE] > > Used when checking eligibility conditions, such as **Orders that were delivered…**, with a missing delivery date. 4. Set **When to refer to in-transit return shipments as Delivered**. > [!NOTE] > > This is used for automations triggered by a return shipment’s status. 5. Click the **save** icon in the top right corner of the page. **Running Step-by-Step Verification** This section describes how to run step-by-step verification. ## To run step-by-step verification 1. Test safely using **Preview Mode**: 1. Navigate to the Admin Dashboard **Home** page. 2. Click **PREVIEW MODE**. A new tab opens with the **New Return Portal** and a **Preview Mode** label (top right-hand corner of the page). ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-13fcd7b6-9404-a4b1-afc5-a01a99087e7f.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=34c30fc24d743b93335d37e10c4fd20a) 3. Enter a real order ID and test different scenarios (eligible vs not eligible items). > [!NOTE] > > Preview Mode lets you test without creating RMAs or sending notifications. 2. Confirm the customer-facing behavior in the **New Return Portal**: 1. Verify that eligible items are selectable, and ineligible items are marked **not eligible**. 2. Confirm the specific scenario you configured (such as date window, tags, reason, etc.) behaves as expected. ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fc6c0d50-9d90-088a-ff1a-68dbcaa70ada.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=6872f6899d94b27f1cc5d67683be2576) 3. Do one of the following: * **If you created a real RMA** - in the Admin Dashboard, verify your eligibility settings. * **If you tested outside of Preview Mode and submitted a real return** - navigate to **Manage Returns** and open the RMA to review what was returned and the results. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-84c7d1fb-e8e3-4072-6ffb-c75453253cf1.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=93fc115a360f162929c591e76bafbe8a) **Reports and Analyses** Eligibility controls what customers can select in the **New Return Portal** and which **policy rules** apply. If you need analytics or export specifics for returns created under certain rules, confirm which reporting views are enabled in your Admin Dashboard (Analytics, exports, etc.). **Troubleshooting Common Issues** This section describes how to troubleshoot common issues: | Issue | Solution | | - | - | | Nothing changes in the New Return Portal | Confirm the rule is toggled **Activate Policy Rule** = ON and saved (save icon). | | Delivery-based rules behave inconsistently | Configure Tracking Fallback so missing delivery dates don’t block eligibility checks. | | Complex logic not working | You can’t mix AND and OR within the same eligibility level. Split logic across multiple rules or levels. | | Expected item data is missing | Deleted/null items aren’t supported for eligibility checks (no item data to process a return). | | Tag rules not matching | Tags are not case sensitive; comma-separated values represent “A or B or C.” Also confirm whether the condition checks all/some/none. | **Frequently Asked Questions** This section includes some frequently asked questions and their answers. ## How are multiple eligibility levels combined? If any eligibility level (order/customer/item/RMA) evaluates to not eligible, the policy rule won’t apply to that item. ## Can I use AND and OR together in the same eligibility level? No. AND/OR cannot be combined within the same eligibility level. ## What happens if delivery date is missing? Delivery-based eligibility uses your Tracking Fallback settings. # Configuring Return Reasons Source: https://docs.global-e.com/configuring-return-reasons You can define which return reasons can be selected when creating RMAs internally. This flexibility enables your team to utilize return reasons that may not be visible to customers in the Returns Portal. ## To configure return reasons 1. Navigate to *Settings > General*. 2. Expand the **Internal RMA Creation** section. 3. In the **Available Return Reasons** setting, select one of the following options: * **All return reasons** – Includes all return reasons, including those with the **Display reason** toggle set to OFF (for example, hidden from the Returns Portal). * **As offered to customers in the portal** – Limits the available return reasons to only those with the **Display reason** toggle set to ON (for example, visible to customers in the Returns Portal). 4. Click the save icon to save your changes. Selecting **All return reasons** lets your internal team choose from all configured return reasons, including those hidden from customers. This is particularly useful for handling special cases or internal processes that require reasons not applicable to the general customer base. > [!NOTE] > > This setting only affects the Dashboard used by your team for internal RMA creation. Customers using the Returns Portal will continue to see only the return reasons that have the Display reason toggle turned ON. # Configuring Return Reasons Source: https://docs.global-e.com/configuring-return-reasons-702681 You can define which return reasons can be selected when creating RMAs internally. This flexibility enables your team to utilize return reasons that may not be visible to customers in the Returns Portal. ## To configure return reasons 1. Navigate to *Settings > General*. 2. Expand the **Internal RMA Creation** section. 3. In the **Available Return Reasons** setting, select one of the following options: * **All return reasons** – Includes all return reasons, including those with the **Display reason** toggle set to OFF (for example, hidden from the Returns Portal). * **As offered to customers in the portal** – Limits the available return reasons to only those with the **Display reason** toggle set to ON (for example, visible to customers in the Returns Portal). 4. Click the save icon to save your changes. Selecting **All return reasons** lets your internal team choose from all configured return reasons, including those hidden from customers. This is particularly useful for handling special cases or internal processes that require reasons not applicable to the general customer base. > [!NOTE] > > This setting only affects the Dashboard used by your team for internal RMA creation. Customers using the Returns Portal will continue to see only the return reasons that have the Display reason toggle turned ON. # Configuring Sending Settings Source: https://docs.global-e.com/configuring-sending-settings You can configure the default settings to set which notifications are sent to customers, and whether they are sent directly from the Returns portal or through an email marketing integration for more advanced customization. ## Setting Default Notification Sending 1. Navigate to *Settings > Emails > Content*. 2. Open the type of email you want to configure. 3. For each notification, select whether you want to send it or not in the drop-down. 4. If you have an integration connected, choose whether to send it via the Returns portal or via the integration. 5. Click the save icon to save your changes. ## Configuring Carrier Notifications ### To set the default notifications sent: 1. Navigate to *Settings > Emails > Content*. 2. Open the type of email you want to configure. 3. For each notification, select whether you want to send it or not in the drop-down. 4. If you have an integration connected, choose whether to send it via the Returns portal or via the integration. 5. Click the save icon to save your changes. ## Setting Default Notification Sending 1. Navigate to *Settings > Emails > Content*. 2. Open the type of email you want to configure. 3. For each notification, select whether you want to send it or not in the drop-down. 4. If you have an integration connected, choose whether to send it via the Returns portal or via the integration. 5. Click the save icon to save your changes. ## Configuring Each Return Method’s Carrier Notifications Carrier notifications can also be customized per return method. ### To configure each return method's carrier notifications: 1. Navigate to *Settings > Return Methods*. 2. Click **EXPAND ALL**. 3. Click the pencil icon corresponding to the relevant return method. 4. Expand the **Advanced** section. 5. Select the phase during which to update customers on changes in their return shipment status: * None * On any update * Only when in-transit * Only when the shipment is received 6. Click the save icon located at the top of the page to save your changes. ## Customizing the Email Notifications Logo You can add your logo to customize emails sent to customers for a branded returns experience. ### To customize the email notifications logo 1. Navigate to *Settings > Emails > Look and Feel*. 2. Click **UPLOAD IMAGE** and select a file from your device. 3. Click the save icon located at the top of the page to save your changes. > [!NOTE] > > This logo appears both at the top of your Returns portal dashboard and in the emails sent to your customers. ## Customizing Email Notification Colors You can also customize the colors used in emails sent to your customers. ### To modify the email notification colors 1. Navigate to *Settings > Emails > Look and Feel*. 2. Customize the colors for: * Text * Background * Link > [!TIP] > > Click the color palette icon to change the color format (e.g., RGB, HSL, or HEX). 3. Click the save icon located at the top of the page to save your changes. > [!NOTE] > > You can always revert to the default colors. # Configuring Sending Settings Source: https://docs.global-e.com/configuring-sending-settings-701351 You can configure the default settings to set which notifications are sent to customers, and whether they are sent directly from the Returns portal or through an email marketing integration for more advanced customization. ## Setting Default Notification Sending 1. Navigate to *Settings > Emails > Content*. 2. Open the type of email you want to configure. 3. For each notification, select whether you want to send it or not in the drop-down. 4. If you have an integration connected, choose whether to send it via the Returns portal or via the integration. 5. Click the save icon to save your changes. ## Configuring Carrier Notifications ### To set the default notifications sent: 1. Navigate to *Settings > Emails > Content*. 2. Open the type of email you want to configure. 3. For each notification, select whether you want to send it or not in the drop-down. 4. If you have an integration connected, choose whether to send it via the Returns portal or via the integration. 5. Click the save icon to save your changes. ## Setting Default Notification Sending 1. Navigate to *Settings > Emails > Content*. 2. Open the type of email you want to configure. 3. For each notification, select whether you want to send it or not in the drop-down. 4. If you have an integration connected, choose whether to send it via the Returns portal or via the integration. 5. Click the save icon to save your changes. ## Configuring Each Return Method’s Carrier Notifications Carrier notifications can also be customized per return method. ### To configure each return method's carrier notifications: 1. Navigate to *Settings > Return Methods*. 2. Click **EXPAND ALL**. 3. Click the pencil icon corresponding to the relevant return method. 4. Expand the **Advanced** section. 5. Select the phase during which to update customers on changes in their return shipment status: * None * On any update * Only when in-transit * Only when the shipment is received 6. Click the save icon located at the top of the page to save your changes. ## Customizing the Email Notifications Logo You can add your logo to customize emails sent to customers for a branded returns experience. ### To customize the email notifications logo 1. Navigate to *Settings > Emails > Look and Feel*. 2. Click **UPLOAD IMAGE** and select a file from your device. 3. Click the save icon located at the top of the page to save your changes. > [!NOTE] > > This logo appears both at the top of your Returns portal dashboard and in the emails sent to your customers. ## Customizing Email Notification Colors You can also customize the colors used in emails sent to your customers. ### To modify the email notification colors 1. Navigate to *Settings > Emails > Look and Feel*. 2. Customize the colors for: * Text * Background * Link > [!TIP] > > Click the color palette icon to change the color format (e.g., RGB, HSL, or HEX). 3. Click the save icon located at the top of the page to save your changes. > [!NOTE] > > You can always revert to the default colors. # Configuring your Site to Support Fixed Prices Source: https://docs.global-e.com/configuring-your-site-to-support-fixed-prices Global-e supports fixed prices on WooCommerce with some setup on the merchant's site. ## To set up support for fixed prices 1. Define the countries for which you wish to set fixed prices. 2. Install and configure the 3rd-party extension: **WooCommerce Price Based on Country**. 3. Set the product prices for each pricing zone. 4. Contact `ProSupport@global-e.com` with the request to add fixed prices support and provide the list of countries. This information is added to your Global-e account settings. These pricing zones are now set to fixed prices, as defined in step 3 above. The Global-e extension will not calculate the price conversion for these zones, and the prices remain as you defined them in the currency of the pricing zone. # Global-e Documentation MCP Source: https://docs.global-e.com/connect-docs-to-your-ai-tool Connect this documentation to Claude, Cursor, VS Code, or any assistant that speaks the Model Context Protocol (MCP), and it searches these pages on demand while you work. **Server address (streamable HTTP):** `https://docs.global-e.com/mcp` > [!NOTE] > > Read-only: your assistant can search and read the published documentation, not change it. No > sign-in and no API key. ## Add the server **Claude Code** ```bash theme={null} claude mcp add --scope user --transport http globale-docs https://docs.global-e.com/mcp ``` `--scope user` makes it available in every project. Check it with `claude mcp list`. **Cursor.** Add to `~/.cursor/mcp.json`, or your project's `.cursor/mcp.json`: ```json theme={null} { "mcpServers": { "globale-docs": { "url": "https://docs.global-e.com/mcp" } } } ``` **VS Code.** Add to `.vscode/mcp.json`: ```json theme={null} { "servers": { "globale-docs": { "type": "http", "url": "https://docs.global-e.com/mcp" } } } ``` **Claude desktop and web.** Navigate to **Settings > Connectors**, click **Add custom connector**, and paste the address. Select it from the attachments menu in a conversation. **Codex.** Add to `~/.codex/config.toml`, then restart your `codex` session: ```toml theme={null} [mcp_servers.globale-docs] url = "https://docs.global-e.com/mcp" ``` **Any other client.** Point it at the address above. No key, no headers, no OAuth. > [!WARNING] > > Restart your assistant afterwards. Most clients read their MCP configuration only at startup, so > a session that was already open will not see the server even though it reports as connected. ## Tell your assistant to use it Connecting the server makes it available; it does not make your assistant reach for it. Put this in the file your tool reads for standing instructions (`AGENTS.md`, `CLAUDE.md`, or a Cursor rule): ```md theme={null} You have MCP tools named `search_global_e_docs` and `query_docs_filesystem_global_e_docs`. They search the published Global-e documentation, which is more current and more specific than your training data. Use them for any question about Global-e behaviour, API fields, endpoints, configuration or integration steps, and cite the page you used. ``` Otherwise, name the documentation in the question: *"using the Global-e docs, …"*. ## What it can do | Tool | What it does | | - | - | | **`search_global_e_docs`** | Searches the documentation and returns matching content, with links to the pages | | **`query_docs_filesystem_global_e_docs`** | Reads a full page. Search returns extracts; this returns the whole thing | | **`submit_feedback`** | Reports a problem with a page to the Global-e documentation team | If your assistant surfaces a page that is wrong or out of date, ask it to submit feedback. The report reaches the documentation team without a support ticket. ## What it covers * **Published pages on this site only.** Not drafts, internal material, or anything behind a sign-in. A page is reachable as soon as it is published. * **Documentation, not a product API.** It answers questions about the documentation; it does not place orders, read your account, or run anything against Global-e systems. # Contact Details and Escalation Process Source: https://docs.global-e.com/contact-details-and-escalation-process If you need help: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-180f2fe7-7144-e7db-77c4-f262dff7f233.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=d1db90a77095d92121c5f757dec89779) # Escalating a Ticket Source: https://docs.global-e.com/contact-us To submit a support case for all technical issues/matters visit the [Global-e Merchant Support Portal](https://global-e.zendesk.com/auth/v3/signin?auth_origin=13487874542365%2Cfalse%2Ctrue\&brand_id=13487874542365). Follow the instructions [here](/merchant-support-portal) to sign in. Global-e handles all tickets, including escalations, in the Portal. The following video shows you how to start using the Global-e platform: [Merchant Support Portal resources](https://player.vimeo.com/video/915194672) ## To escalate a ticket 1. From the Portal home page, click the user icon (top-right) and select View Existing Requests. 2. Open the relevant ticket (status must be *Open* / *unresolved*). 3. Click Escalation Request. 4. Choose an Escalation Reason from the dropdown. 5. Add Escalation Details explaining the urgency. 6. Click Submit.The ticket is flagged for prioritization handling by the relevant team. > [!TIP] > > We encourage using the Escalation Request button whenever an open ticket becomes time-sensitive or requires urgent attention. This ensures: > > * Escalations are logged and tracked through a centralized, visible channel > * No requests are overlooked or delayed > * The relevant support team can respond with the necessary priority and urgency # Currency conversion in content (client-side) Source: https://docs.global-e.com/content-currency-conversion-sfcc This feature converts prices that are rendered **inside content** — content assets, slots, promotion callout messages, and similar HTML — into the shopper's Global-e currency. It runs **client-side**, so use it for prices that are part of editorial/marketing HTML rather than product prices computed by the backend. The conversion is performed by the Global-e script loader (`geScriptLoader.js`), which scans the page for tagged elements. Mark up an element with `data-ge-convert-price` plus the appropriate data attributes. > [!NOTE] > > **Recommendation:** for product prices, prefer **backend** conversion (see [Price calculation](/price-calculation-sfcc)). Use client-side product conversion only for specific cases. ## Attributes | Attribute | Required | Purpose | | - | - | - | | `data-ge-convert-price` | Yes | Marks the element for Global-e conversion. | | `data-original-price` | For amount conversion | The amount in the original currency. | | `data-is-discount` | Optional | When `true`, the conversion ignores the pricing coefficient and rounding (use for discount amounts). | | `data-product-id` | For product price | Converts a specific product's price, applying tax rates, product coefficients, and so on. | If both `data-product-id` and `data-original-price` are present, only `data-product-id` is used and `data-original-price` is ignored. ## Examples ### Convert an amount ```html theme={null} $300 ``` The loader replaces the element's text with the amount converted to the shopper's Global-e currency (and applies FX/rounding rules for non-discount amounts). ### Convert a discount amount ```html theme={null} $300 ``` Same as amount conversion, but with `data-is-discount="true"` the conversion ignores the pricing coefficient and rounding. ### Convert a product's price ```html theme={null} ``` The loader fills the element with that product's converted price (tax rates, product coefficients, and so on applied). ## Summary Use `data-original-price` to convert an arbitrary amount, or `data-product-id` to render a specific product's converted price. For most product pricing, rely on backend conversion and reserve this client-side approach for prices embedded in content. ## See also * [Client JS SDK](/client-js-sdk-sfcc) — the Global-e script loader * [Price calculation](/price-calculation-sfcc) — backend price conversion # Cookies Source: https://docs.global-e.com/cookies-sfcc Global-e persists shopper country, culture, and currency in a single HTTP cookie so the Client JS SDK and storefront stay aligned across page loads. Cookie name: **`GlobalE_Data`** (constant `geCookieName` in the cartridge). | Cookie field | Description | Source in cartridge | Sample | | - | - | - | - | | countryISO | Selected country ISO2 | Same value as `session.custom.geCountry` / `geAppState.geCountry` | GB | | cultureCode | Global-e culture code | Same value as `geAppState.geCulture` (not a top-level `session.custom` attribute) | en-GB | | currencyCode | Selected currency ISO3 | Same value as `session.custom.geCurrency` / `geAppState.geCurrency` | GBP | | apiVersion | Client JS SDK API version | `GLOBALE_APP_SETTINGS.webClientVersion` (from GlobaleSettings job), not stored on session | 2.1.4 | The cookie is written in `int_globale` (`response.setCookieAppState`) when app state changes. Its lifetime comes from the `geCookieLifetime` site preference, and its domain from the optional `geCookieDomain` (JSON) preference — when `geCookieDomain` is not configured, the cartridge falls back to the current request host. See [Configuration](/configuration-sfcc). For the full session model, see [Session Custom Attributes](/session-attributes-sfcc). # Countries, Currencies and Languages Source: https://docs.global-e.com/countries-currencies-and-languages The Global-e operated countries, supported currencies and supported languages are outlined in the following sections. * [Supported Countries](/countries-supported) * [Supported Currencies](/supported-currencies) * [Supported Languages](/languages) # Countries Source: https://docs.global-e.com/countries-supported > [!NOTE] > > **This section does not apply to Shopify.** For information about Shopify, see [Supported Countries and Currencies](/sy_the_basics). Global‑e operates the following countries. These are the supported destination countries Global‑e ships to. ## Supported Countries | **A** | **F** | **M** | **S** | | - | - | - | - | | Albania | Falkland Islands | Macau | Saint Kitts and Nevis | | Algeria | Faroe Islands | Madagascar | Saint Lucia | | American Samoa (Not for US) | Fiji | Malawi | Saint Vincent and the Grenadines | | Andorra | Finland | Malaysia | Samoa | | Angola | France | Maldives | San Marino | | Anguilla | French Guiana | Malta | Sao Tome and Principe | | Antigua and Barbuda | French Polynesia | Marshall Islands | Saudi Arabia | | Argentina | | Martinique | Senegal | | Armenia | **G** | Mauritania | Serbia | | Aruba | Gabon | Mauritius | Seychelles | | Australia | Gambia | Mayotte | Sierra Leone | | Austria | Georgia | Mexico | Singapore | | Azerbaijan | Germany | Micronesia | Sint Maarten | | | Ghana | Moldova | Slovak Republic | | **B** | Gibraltar | Monaco | Slovenia | | Bahamas | Greece | Mongolia | Solomon Islands | | Bahrain | Greenland | Montenegro | South Africa | | Bangladesh | Grenada | Montserrat | Spain | | Barbados | Guadeloupe | Morocco | Sri Lanka | | Belgium | Guam (not for US) | Mozambique | St Barthelemy | | Belize | Guatemala | | St Martin | | Benin | Guernsey | **N** | St. Helena | | Bermuda | Guinea | Namibia | Sudan | | Bhutan | Guinea-Bissau | Nauru | Suriname | | Bolivia | Guyana | Nepal | Swaziland | | Bonaire, Sint Eustatius and Saba (Netherlands Antilles, Caribbean Netherlands) | | Netherlands | Sweden | | Bosnia and Herzegovina | **H** | Netherlands Antilles (Saba) | Switzerland | | Botswana | Haiti | New Caledonia | | | Brazil | Honduras | New Zealand | **T** | | British Virgin Islands | Hong Kong | Nicaragua | Taiwan | | Brunei Darussalam | Hungary | Nigeria | Tanzania | | Bulgaria | | Niue | Thailand | | Burkina Faso | **I** | North Macedonia | Togo | | Burundi | Iceland | Northern Mariana Islands | Tonga | | | India | Norway | Trinidad and Tobago | | **C** | Indonesia | | Tunisia | | Cambodia | Ireland (Republic of) | **O** | Turkmenistan | | Cameroon | Isle of Man | Oman | Turks and Caicos Islands | | Canada | Israel | | Tuvalu | | Cape Verde | Italy | **P** | | | Cayman Islands | | Pakistan | | | Chad | **J** | Palau (Not for US) | **U** | | Chile | Jamaica | Panama | Uganda | | China | Japan | Papua New Guinea | United Arab Emirates | | Colombia | Jersey | Paraguay | United Kingdom | | Comoros | Jordan | Peru | United States | | Congo | | Philippines | Uruguay | | Cook Islands | **K** | Poland | Uzbekistan | | Costa Rica | Kazakhstan | Portugal | | | Cote D'Ivoire (Ivory Coast) | Kenya | Puerto Rico (Not for US) | **V** | | Croatia | Kiribati | | Vanuatu | | Curacao | Korea (South) | **Q** | Vatican City (Holy See) | | Cyprus | Kuwait | Qatar | Venezuela | | Czech Republic | Kyrgyzstan | | Vietnam | | | | **R** | Virgin Islands (U.S.) (not for US) | | **D** | **L** | Reunion | | | Denmark | Latvia | Romania | **W** | | Djibouti | Laos | Rwanda | Wallis and Futuna Islands | | Dominica | Lebanon | | | | Dominican Republic | Lesotho | | **Z** | | | Liberia | | Zambia | | **E** | Liechtenstein | | Zimbabwe | | East Timor | Lithuania | | | | Ecuador | Luxembourg | | | | Egypt | | | | | El Salvador | | | | | Equatorial New Guinea | | | | | Estonia | | | | | Ethiopia | | | | ## Counties, States, and Provinces ### Australia | State | Code | | - | - | | Australian Capital Territory | ACT | | New South Wales | NSW | | Northern Territory | NT | | Queensland | QLD | | South Australia | SA | | Tasmania | TAS | | Tasmania | TAS | | Western Australia | WA | ### Brazil | State/Province | Code | | - | - | | São Paulo | SP | | Rondônia | RO | | Pernambuco | PE | | Mato Grosso do Sul | MS | | Amapá | AP | | Bahia | BA | | Distrito Federal | DF | | Espírito Santo | ES | | Maranhão | MA | | Mato Grosso | MT | | Minas Gerais | MG | | Paraíba | PB | | Paraná | PR | | Alagoas | AL | | Piauí | PI | | Rio de Janeiro | RJ | | Rio Grande do Sul | RS | | Roraima | RR | | Santa Catarina | SC | | Sergipe | SE | | Tocantins | TO | | Acre | AC | | Amazonas | AM | | Ceará | CE | | Goiás | GO | | Pará | PA | | Rio Grande do Norte | RN | ### Canada | State/Province | Code | | - | - | | Saskatchewan | SK | | New Brunswick | NB | | British Columbia | BC | | Northwest Territories | NT | | Alberta | AB | | Manitoba | MB | | Newfoundland and Labrador | NL | | Nova Scotia | NS | | Nunavut | NU | | Prince Edward Island | PE | | Quebec | QC | | Yukon Territory | YT | | Ontario | ON | ### China | State/Province | Code | | - | - | | Anhui | ANH | | Beijing | BEI | | Chongqing | CHO | | Fujian | FUJ | | Gansu | GAN | | Guangdong | GDG | | Guangxi | GXI | | Guizhou | GUI | | Hainan | HAI | | Hebei | HEB | | Heilongjiang | HEI | | Henan | HEN | | Hubei | HUB | | Hunan | HUN | | Inner Mongolia | MON | | Jiangsu | JSU | | Jiangxi | JXI | | Jilin | JIL | | Liaoning | LIA | | Ningxia | NIN | | Qinghai | QIN | | Shaanxi | SHA | | Shandong | SHD | | Shanghai | SHH | | Shanxi | SHX | | Sichuan | SIC | | Tianjin | TIA | | Xinjiang | XIN | | Xizang | XIZ | | Yunnan | YUN | | Zhejiang | ZHE | ### Ireland | Counties | | - | | Carlow | | Cavan | | Cork | | Donegal | | Dublin | | Galway | | Kerry | | Kildare | | Kilkenny | | Laois | | Leitrim | | Limerick | | Longford | | Louth | | Mayo | | Meath | | Monaghan | | Offaly | | Roscommon | | Sligo | | Tipperary | | Waterford | | Westmeath | | Wexford | | Wicklow | ### Japan | State/Province | Code | | - | - | | Hokkaido | JP-01 | | Aomori | JP-02 | | Iwate | JP-03 | | Miyagi | JP-04 | | Akita | JP-05 | | Yamagata | JP-06 | | Fukushima | JP-07 | | Ibaraki | JP-08 | | Tochigi | JP-09 | | Gunma | JP-10 | | Saitama | JP-11 | | Chiba | JP-12 | | Tokyo | JP-13 | | Kanagawa | JP-14 | | Niigata | JP-15 | | Toyama | JP-16 | | Ishikawa | JP-17 | | Fukui | JP-18 | | Yamanashi | JP-19 | | Nagano | JP-20 | | Gifu | JP-21 | | Shizuoka | JP-22 | | Aichi | JP-23 | | Mie | JP-24 | | Shiga | JP-25 | | Kyoto | JP-26 | | Osaka | JP-27 | | Hyogo | JP-28 | | Nara | JP-29 | | Wakayama | JP-30 | | Tottori | JP-31 | | Shimane | JP-32 | | Okayama | JP-33 | | Hiroshima | JP-34 | | Yamaguchi | JP-35 | | Tokushima | JP-36 | | Kagawa | JP-37 | | Ehime | JP-38 | | Kochi | JP-39 | | Fukuoka | JP-40 | | Saga | JP-41 | | Nagasaki | JP-42 | | Kumamoto | JP-43 | | Oita | JP-44 | | Miyazaki | JP-45 | | Kagoshima | JP-46 | | Okinawa | JP-47 | ### Mexico | State/Province | Code | | - | - | | Aguascalientes | AGU | | Baja California | BCN | | Baja California Sur | BCS | | Campeche | CAM | | Chiapas | CHP | | Chihuahua | CHH | | Ciudad de México | CMX | | Coahuila de Zaragoza | COA | | Colima | COL | | Durango | DUR | | Guanajuato | GUA | | Guerrero | GRO | | Hidalgo | HID | | Jalisco | JAL | | México | MEX | | Michoacán | MIC | | Morelos | MOR | | Nayarit | NAY | | Nuevo León | NLE | | Oaxaca | OAX | | Puebla | PUE | | Querétaro de Arteaga | QUE | | Quintana Roo | ROO | | San Luis Potosí | SLP | | Sinaloa | SIN | | Sonora | SON | | Tabasco | TAB | | Tamaulipas | TAM | | Tlaxcala | TLA | | Veracruz | VER | | Yucatán | YUC | | Zacatecas | ZAC | ### United States | State/Province | Code | | - | - | | West Virginia | WV | | Virginia | VA | | Utah | UT | | Tennessee | TN | | Pennsylvania | PA | | North Carolina | NC | | Minnesota | MN | | Missouri | MO | | Montana | MT | | Nevada | NV | | New Jersey | NJ | | New York | NY | | North Dakota | ND | | Oklahoma | OK | | Oregon | OR | | Alabama | AL | | Arizona | AZ | | California | CA | | Connecticut | CT | | District of Columbia | DC | | Georgia | GA | | Idaho | ID | | Indiana | IN | | Iowa | IA | | Kentucky | KY | | Maine | ME | | Massachusetts | MA | | Rhode Island | RI | | South Dakota | SD | | Texas | TX | | Vermont | VT | | Washington | WA | | Wisconsin | WI | | Wyoming | WY | | Illinois | IL | | Kansas | KS | | Louisiana | LA | | Maryland | MD | | Michigan | MI | | Mississippi | MS | | Nebraska | NE | | New Hampshire | NH | | New Mexico | NM | | Alaska | AK | | Arkansas | AR | | Colorado | CO | | Delaware | DE | | Florida | FL | | Hawaii | HI | | Ohio | OH | | South Carolina | SC | # Countries Source: https://docs.global-e.com/countries-zones ## Zones The Zones section displays a list of zones. Each zone contains countries sharing the exact same country coefficient, cart range, currency, and shipping rates. Zones make it easier to define shipping rates and coefficients for multiple countries in parallel. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1b3acff0-48bf-c45a-31ee-38b0bcbbf206.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=910d1ec5f8493c4a16d9847c36354e69) * Change a zone's coefficient * Define a zone's shipping rates and cart ranges # Country of Origin certificate for UK manufactured products Source: https://docs.global-e.com/country-of-origin-certificate-for-uk-manufactured-products Due to **Country of Origin (COO)** regulations, when trading into the EU post-Brexit, a Certificate of Origin is required for products that are manufactured in the United Kingdom. This certificate is necessary in case EU tax authorities ask the shippers for supporting documentation. A template of the certificate can be downloaded here ([Template COO UK)](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/Other+Resources/Template+COO+UK.docx). If all of your products are manufactured in the United Kingdom, you may declare this in the certificate, and we will set up all your products accordingly. # CPSC eFiling Compliance for US- Bound Shipments Source: https://docs.global-e.com/cpsc-efiling-compliance-for-us-bound-shipments ## CPSC eFiling Compliance for US- Bound Shipments- Overview ### Overview From July 8, 2026, U.S. Customs and Border Protection (CBP) requires electronic filing (eFiling) of product-safety Certificate of Compliance data for certain consumer products entering the United States. The requirement is set by the U.S. Consumer Product Safety Commission (CPSC). Global-e acts as Merchant of Record (MOR) and Importer of Record (IOR) for US imports, and is therefore legally responsible for filing this data with the CPSC Product Registry on Merchant’s behalf. Global-e handles the full technical integration with CPSC and registers the products on behalf of the Merchant — the merchant is responsible for supplying the underlying product-safety data. If that data is missing or incorrect, shipments can be held at US customs. For implementation details for Shopify and non-Shopify / SFTP merchants, see the [CPSC eFiling Compliance for US-Bound Shipments — Merchant Guide](/cpsc-efiling-compliance-for-us-bound-shipments-merchant-guide). ### Why this matters * Keeps shipments moving — prevents US customs holds on affected products. * Avoids penalties — protects you and Global-e from CPSC enforcement action. * Preserves US selling — required to continue US cross-border shipping via Global-e Logistics or Global-e integration after July 8, 2026. ### Who and what is in scope * Merchants shipping to the US via Global-e Logistics or Global-e integration. * Products whose HTS code appears on the CPSC in-scope list (\~600 codes) — e.g. toys, children's products, and other regulated consumer goods. Ref: CPSC-Guidance-and-HTSList-for-Filing-of-Electronic-Certificates-040826-V5.pdf * Merchants who believe their products are required by the regulation. * All Global-e supported platforms: Classic via SFTP and Shopify via the platform integration. If you are unsure which of your products are affected, your Global-e contact can run a CPSC exposure review against your catalog. # CPSC eFiling Compliance for US-Bound Shipments — Merchant Guide Source: https://docs.global-e.com/cpsc-efiling-compliance-for-us-bound-shipments-merchant-guide ## CPSC eFiling Compliance for US- Bound Shipments — Merchant Guide ### Overview From July 8, 2026, U.S. Customs and Border Protection (CBP) requires electronic filing (eFiling) of product-safety Certificate of Compliance data for certain consumer products entering the United States. The requirement is set by the U.S. Consumer Product Safety Commission (CPSC). Global-e acts as Merchant of Record (MOR) and Importer of Record (IOR) for US imports and is therefore legally responsible for filing this data with the CPSC Product Registry on Merchant’s behalf. Global-e handles the full technical integration with CPSC and registers the products on behalf of the Merchant — the merchant is responsible for supplying the underlying product-safety data. If that data is missing or incorrect, shipments can be held at US customs. ### Why this matters * Keeps shipments moving — prevents US customs holds on affected products. * Avoids penalties — protects you and Global-e from CPSC enforcement action. * Preserves US selling — required to continue US cross-border shipping via Global-e Logistics or Global-E integration after July 8, 2026. ### Who and what is in scope * Merchants shipping to the US via Global-e Logistics or Global-E integration. * Products whose HTS code appears on the CPSC in-scope list (\~600 codes) — e.g. toys, children's products, and other regulated consumer goods. Ref: CPSC-Guidance-and-HTSList-for-Filing-of-Electronic-Certificates-040826-V5.pdf * Merchants who believe their products are required by the regulation. * All Global-e supported platforms: Classic via SFTP and Shopify via the platform integration. If you are unsure which of your products are affected, your Global-e contact can run a CPSC exposure review against your catalog. ### How the process works Global-e registers the products with CPSC and then uses a “register once, reference each shipment” model: 1. You provide the full product-safety certificate dataset once per product. 2. Global-e stores the data and registers each product with the CPSC Product Registry. 3. On each US-bound order, the relevant certificate data is passed to the carrier for electronic filing with US Customs. ### Sharing your data You can share your product-safety data through one of two channels: #### Option 1 — SFTP (CSV upload) For non-Shopify / SFTP merchants. Global-e creates a /Cpsc folder in your Global-e SFTP server. You upload a CSV file (one row per product variant) using the provided template. #### Option 2 — Shopify metafields For Shopify merchants. Tag each affected product with the tag ‘CPSC product’ and populate the product-safety data in variant-level metafields in the ‘globale’ namespace. Only tagged products are scanned. ### The data you need to provide The same product-safety data set is required regardless of channel. The minimum required data per product is: 1. Version ID — certificate version identifier. 2. Primary Product ID + ID Type — your product identifier and its type (GTIN / UPC / SKU / Model Number / Serial Number / Registered Number / Alternate Identifier). 3. Certificate Type — GCC (General Certificate) or CPC (Children's Product Certificate). 4. Product Name. 5. Manufacture Date (MM/YYYY). 6. Last Test Date (MM/DD/YYYY). 7. Manufacturer — GLN or Alternate ID (plus name, address and contact details if the manufacturer is new). 8. Testing lab — at least one lab with citation codes (16 CFR codes), or applicable testing exemption codes. 9. Point of Contact for test-result records (Importer / Manufacturer / Laboratory / Broker / Other). Optional additional data can also be provided — including extra product identifiers, product details (brand, description, color, style), production dates and lot numbers, a second testing lab, and test report references. Full field lists and formats are in the CSV template and the Shopify metafield setup guide provided by your Global-e contact. ### Keeping your data current * Add CPSC data for any new regulated product as you add it to your catalog. * Update the certificate (new Version ID) whenever safety testing or certificate details change. * Have your data in place ahead of the July 8, 2026 effective date. ### Need help? Contact your Global-e account manager or CSM to: * Confirm whether your catalog is affected (CPSC exposure review). * Receive your SFTP /Cpsc folder details and the CSV upload template, or the Shopify meta field setup guide. # Create a Replacement Order Source: https://docs.global-e.com/createorder The CreateOrder API is used to create a replacement order in Global-e. ## Overview This section describes how to create a replacement order in Global-e. ## CreateOrder (Merchant to Global-e) The CreateOrder API is used to create a replacement order in Global-e. Key constraints: * Products must be pre-registered with Global-e. * Replacement orders inherit shipping service and details from the original unless specified. * Customers are not charged upgrade costs or remote area fees. * Destination country cannot change from the original order. * Orders default to Delivered Duty Paid (DDP) when supported. * Merchants must validate the original order status independently. * Billing details are immutable. * Added value replacement is unsupported. * Authentication uses Merchant GUID. * Must be implemented using cart item ID. * An `OrderReplacementCreated` email is sent upon successful replacement creation. > [card] [CreateOrder — full request & response](/api-reference/create-order) > > Parameters, schema, examples, and the interactive playground for `POST /checkout/CreateOrder`. ## CreateOrder Specification The full schema for all request and response objects — `SendOrderData`, `SendCartData`, `OrderReplacementData`, `ReplacedProduct`, `CartUserDetails`, `CustomProductAttribute`, `Discount`, and `CreateOrderResponse` — is rendered automatically from the spec on the [API Reference page](/api-reference/create-order). The narrative sections below cover logic and lookup tables not part of the schema. ### Hub Selection Logic Resolution order of precedence: 1. If `HubId` is provided → use that hub. 2. If only `HubCountryCode` is provided and matches the original order → use the original hub. 3. If `HubCountryCode` differs from the original → use the first active merchant hub in that country. 4. If neither `HubId` nor `HubCountryCode` is provided → use the original order hub. 5. Fallback: first active merchant hub in the merchant's country. ### Discount Type Options | Value | Description | | - | - | | 1 | Cart discount | | 2 | Shipping discount | | 3 | Loyalty points discount | | 4 | Duties discount | | 5 | Checkout Loyalty Points Discount | | 6 | Payment Charge | # Creating a Discount Source: https://docs.global-e.com/creating-a-discount Create a new discount by adding and configuring a new cart rule. ## Adding a New Cart Rule ## To add a new cart rule 1. From the Magento dashboard navigate to **Marketing** > **Cart Price Rules**. The **Cart Price Rules** page opens. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-05b1d12d-4e75-9dcd-3ce5-2e1a4bb30b60.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=948509781e878b2773e12f9450f501c2) 2. At the top-right, click **Add New Rule.** The **New Cart Price Rule** page opens. 3. In the Rule Information section complete the following information: 1. Give your rule a name and description. 2. In the Rule Information section complete the following information: Give your rule a name and description. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-7ef7da2f-2661-babb-96e5-d32d0f5f801d.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=a34b1239b61bc0783e9670a1aaba47a6) 3. Ensure the **Active** option is set to **Yes** if you want the rule to go into effect immediately. 4. Select the websites where you want to activate the discount and the customer groups to which the discount applies. 5. Under Coupon, set the rule to apply with or without a coupon: ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5ede0a03-e62c-196d-13b0-ca05db703624.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=a2d383de7da4530894022f15c0d58d37) * Select **No Coupon** to apply the cart rule to all cart items. * Select **Specific Coupon** to associate a coupon with a price rule: * Enter a Coupon Code that the customer must input to receive the discount. * Set a limit on the number of times the coupon can be used (optional). * Set a limit on the number of times a customer can use the coupon (optional). 6. Use the **Calendar** to select the start and end dates for the promotion. 7. In the **Priority** field, enter a number to define the priority of this rule.This is relevant if you have other coupon codes or cart rules for the same products simultaneously. ## Configuring the Cart Rule ## To configure the cart rule 1. In the **Conditions section**, configure conditions for the discount by selecting relevant options in the dropdown menu and entering data manually (e.g. figures) when needed. 2. Under the Actions section: ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9f1d7d36-b187-e719-a9b8-a5cce44f64ad.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=975cfbfc145d598a96b98a5c532cc93f) 1. From the **Apply** dropdown menu select the desired discount: * Percent of product per discount * Fixed amount discount * Fixed amount discount for the whole cart * Buy X get Y freeBuy X get Y free 2. Enter a number amount for the selected discount: * In the **Discount Amount** field, enter a number to indicate a percentage, fixed amount, or a quantity of items. * In the **Discount Qty Step (Buy X)** field, enter the quantity the customer must purchase to receive the Buy X get Y Free discount. * In the **Maximum Qty Discount is Applied To** field, enter the maximum quantity of the same product that can qualify for the discount in the same purchase. The remaining options in this section are optional so you can fill them out if relevant to you. 3. Set **Apply to Shipping Amount**. * Select yes if the discount applies separately to the subtotal and shipping amounts. * Select No if the discount applies only to the subtotal. 4. Set **Discard subsequent rules** to **Yes** if you want to stop running other rules after this rule is applied. This prevents multiple discounts from being applied to the same product. 3. Under the Actions section: 1. From the **Apply** dropdown menu select the desired discount: * Percent of product per discount * Fixed amount discount * Fixed amount discount for the whole cart * Buy X get Y free 2. Enter a number amount for the selected discount. * In the **Discount Amount** field, enter a number to indicate a percentage, fixed amount, or a quantity of items. * In the **Discount Qty Step (Buy X)** field, enter the quantity the customer must purchase to receive the Buy X get Y Free discount. * In the **Maximum Qty Discount is Applied To** field, enter the maximum quantity of the same product that can qualify for the discount in the same purchase. The remaining options in this section are optional so you can fill them out if relevant to you. 3. Set **Apply to Shipping Amount**. 4. Set **Discard subsequent rules** to **Yes** if you want to stop running other rules after this rule is applied. This prevents multiple discounts from being applied to the same product. 4. In the label section, you can add custom labels to the discount. These are displayed on the checkout page. 5. In the **Manage Coupon Codes** section, you can generate a list of coupon codes by filling out the requested details. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-656cdc86-911c-5f41-a485-3946acd691f0.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=2b82914f78cca0ac01dc66b1fb09e022) * **Coupons Qty**: The number of coupons that you want to generate. * **Code Length**: The length of the code, not including the prefix, suffix, or separators. * **Code Format**: Set it to one of the following: * Alphanumeric * Alphabetical * Numeric * **Code Prefix** (optional): To be added at the beginning of the code. * **Code Suffix** (optional): To be added at the end of the code. * **Dash Every X Characters**: (optional) If using a code with characters and dashes, here you select the number of characters that you want to have between each dash. 6. Click **Generate** to generate the codes.The list of codes appears at the bottom of the screen. 7. Click **Save**. ## Testing the Cart Rule After completing the above procedures, you must test the rule to verify that it works correctly. # Creating a Refund by Gift Card Source: https://docs.global-e.com/creating-a-refund-by-gift-card Refund by Gift Card is a return resolution for stores that offer gift cards as part of their return policy. It allows you to issue refunds as gift cards, keeping revenue within your store while offering customers flexible spending power on future purchases. ## Capabilities Enabling Refund by Gift Card allows you to: * **Issue gift cards as refunds** -customers receive a gift card they can use for future purchases. Gift cards can be combined with other gift cards and discount codes at checkout. * **Retain revenue in your store** - refund customers while keeping the sale value inside your store ecosystem. * **Offer incentive bonuses** - incentivize customers by offering a bonus amount when they choose this resolution. ## Requirements and Limitations The following list shows the requirements and limitations: * The gift card is issued to customers based on their email address. * Only one new gift card can be issued per RMA. * A new gift card is created each time a gift card refund is issued — gift cards are not rechargeable. *Note:* Gift cards in Shopify are not tied to specific accounts, which means anyone with access to the gift card code can use it. Ensure the secure communication and storage of gift card codes to prevent unauthorized use. ## Configuring Refund by New Gift Card There are several settings you can configure to manage how the Refund by New Gift Card resolution behaves in your returns flow. ### To configure refund by new gift card 1. Navigate to *Settings > Resolutions*. 2. Open the **Return Resolutions** section. 3. Click **REFUND BY NEW GIFT CARD**. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9644a35c-3c8f-b656-4d50-b3eb313969f4.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=41a20b4ae4abfc32183ff84979a56c91) 4. In the Details section, edit the internal name for this resolution. This name is for your reference only- customers will not see it in the portal. 5. Edit the display name, which is how this resolution will appear in your return portal. 6. Edit the description, which provides additional details about this resolution in your return portal. 7. In the Refund section, set the refund type to Gift Card. 8. Select **options from the Refund** Amount drop-down to set the amount you want to offer relative to the paid price. You can use this to incentivize customers who choose this refund type. 9. Click the **save** icon to save your changes. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-14be8266-59b1-11d5-66e1-f27381bb54f7.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=3ea2c80aae0c028b6c5b2d13d0fccae8) You can use this resolution to build your Return Policy, where you can configure additional settings such as eligibility rules, fees, and more. ## Issuing a New Gift Card Once you issue a new gift card, the following takes place automatically: * The system generates a gift card code with an initial balance equal to the refunded amount. * Two email notifications are triggered: * A notification from your store via the dashboard confirming that a gift card has been issued and stating the refunded amount. You can fully customize this email, including the sender address. * A notification from Shopify with a link to the gift card itself, where the customer can view the gift card code and balance. * The refunded amount is documented on both the RMA page and in the order’s notes and timeline. ## Setting the Expiration Period of Gift Cards You can define how long a gift card remains valid after it is issued. To set the gift card expiration period: 1. Navigate to *Settings > Store Settings.* 2. Open the **Refund Alternatives** section. 3. In the Gift Cards Expiration setting, enter the number of days, weeks, or months the gift card should remain valid. For example, enter 10 for a 10-day validity period. 4. Select the unit of time from the drop-down. 5. Click the **save** icon to save your changes. You can also manage the validity of existing gift cards or delete them through *Shopify Admin > Products > Gift Cards.* ## What’s the Difference Between Gift Cards and Store Credit? Store credit and gift cards are both types of virtual currency that can be issued as refunds and used for future purchases. The key differences are outlined below. | Feature | Gift Card | Store Credit | | - | - | - | | Used to pay for | Entire order (items, shipping, taxes) | Item value only (not shipping or taxes) | | Combined with discounts | Yes- can be combined with other gift cards and discount codes | No- cannot be combined with another discount code | | Rechargeable | No- a new gift card is created for each refund | Yes- credit accumulates on the same discount code | | Account-linked | No- anyone with the code can use it | Yes- tied to a specific customer account | *Reminder:* Because gift cards in Shopify are not tied to specific accounts, anyone who obtains the gift card code can use it. Ensure gift card codes are communicated securely to the intended customer. # Creating Return Reasons Source: https://docs.global-e.com/creating-return-reasons ## Overview You can **create return reasons** to track why customers return items, spot patterns, and reduce future returns. You can customize which reasons customers see in the **New Return Portal**, and add **follow-up questions** to collect the details your team needs for validation and analysis. The following video describes creating return reasons: [Embedded media](https://player.vimeo.com/video/1164298453) ## What You’ll Accomplish * Add, edit, and display return reasons in the Admin dashboard * Add follow-up questions (including mandatory questions and media requests) * Reorder reasons to control how they appear in the new return portal * Find return reasons on an RMA and analyze return reason trends in Analytics or exports ## Requirements Admin-level permissions in the admin dashboard (to manage return reasons and follow-up questions) ## Prerequisites Global-e recommends the following prerequisites: * Decide which reasons should be customer-facing (vs. internal-only). * Provide details (e.g., Damaged > request photo). * Keep reason names short and customer-friendly; use follow-up questions for specifics. ## Adding Return Reasons This procedure describes how to add return reasons. **To add return reasons** 1. Navigate to *Settings > Return Reasons*. 2. Do one of the following: * **Create a return reason** - click **ADD REASON**. * **Edit a return reason** - click the pencil icon next to an existing reason to edit it. 3. Enable **Display reason** to make the reason visible to customers in the new return portal. 4. Edit the reason’s display name. 5. Set a return reason category. 6. Click the **save** icon in the top right hand corner of the page. ## Adding Follow-up Questions to a Return Reason Follow-up questions appear in the new return portal **after** a customer selects a return reason (for that item). They help you collect context for validation, analytics, and processing. ### To add follow-up questions to a return reason 1. Click the **edit** icon corresponding to a return reason. 2. In the Return Reasons editor, click **ADD QUESTION**. 3. Click the **pencil** icon next to the follow-up question to configure it. 4. Toggle **Display question** so customers see it in the new return portal. 5. (Optional) Toggle **Mandatory question** to require an answer. 6. Edit the Internal name (for internal reference/reporting). 7. Choose an **Answer type**: * Free text * Media text * Multiple choice * Numerical stepper * Yes/No Additional fields are displayed based on your **Answer type** selection. For example, if you select **Multiple choice – select one**, fields for optional answers are displayed on the page. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8d701d95-7241-1c47-1f6f-2daec781c5cb.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=ab84786743e71f12a4f6cdbf9f9eb3fe) 8. Enter or edit the customer-facing **Question** text. 9. Enter **instructions** in the Instructions field using the **plus** and **minus** buttons to set the quantity.These numbers set what the Customer should provide. 10. Configure any additional settings required by the selected answer type, such as **media type** or **multiple-choice options**. > [!NOTE] > > The following limits apply to the **Media Request**: > > * Customers can upload **up to four** images or videos at a time > * Supported image types: **JPG**, **JPEG**, **PNG**, **HEIF** 11. Click the **save** icon in the top right corner of the page. ## Sorting Return Reasons and Questions Sorting return reasons and questions lets you determine the order they are displayed in the portal. **To sort return reasons and questions** 1. Navigate to *Settings > Return Reasons*. 2. Drag and drop return reasons into your preferred order. > [!TIP] > > Place the most common reasons near the top to reduce customer friction. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c93cd8ce-1f22-59e9-f2ea-257f20105350.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=ff56a7bd13db8b5390cc415488f9cc44) ## Verifying Created Returns This procedure describes to customers using the **New Returns Portal** how to verify that their returns have been created and can be seen in the platform. ### To verify created returns 1. Verify the return in the New Returns Portal: 1. Start a return for an order in the new return portal. 2. Select an item to return. 3. Confirm the customer sees your enabled reasons (those with **Display reason** turned on). 4. Select a reason that has follow-up questions and confirm: * Questions appear after selecting the reason * Mandatory questions must be completed before continuing * Media requests allow uploads (and video uploads only if the add-on is enabled) ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-61855d2d-aced-32ad-19b4-ff107f9fad67.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=e69ea3292a91d9711f8c4368bb645254) 2. **Verify on the RMA in the admin dashboard** 1. Navigate to **Manage Returns** and open an RMA. 2. In the item **Details** area, check the Details section (right side) to see the selected return reason next to each returned item. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-08a04e56-bcff-8a98-826e-3e09a021aa41.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=13274be44ff0174b94f0ee72a8cfa816) ## Troubleshooting Common Issues This section describes how to troubleshoot some commonly occurring issues: | Question | Answer | | - | - | | Reason doesn’t appear in the new return portal | Confirm Display reason is ON and you clicked the save icon. | | Follow-up question not showing | Confirm Display question is ON and saved. | | Customer can skip an answer you need. | Toggle Mandatory question ON. | | Customers can’t upload videos. | Video uploads require enabling the Video Upload add-on (images still work without it). | | Reason order in the portal isn’t what you expect. | Reorder reasons via drag-and-drop in *Settings > Return Reasons*. | ## Frequently Asked Questions The following table shows some common frequently asked questions and their answers: | Question | Answer | | - | - | | What are the default return reasons? | The platform includes a built-in set of commonly used default return reasons you can use as-is or customize. | | How many return reasons can I add? | There is no limit. | | How many follow-up questions can I add per reason? | There is no limit. | | How do I change the order shown in the new return portal? | Reorder items in Settings > Return Reasons (drag-and-drop). The portal follows that order for reasons (and follow-up questions). | | What’s the upload limit for media requests? | Up to 4 files at a time, 140MB per file. Supported images: JPG, JPEG, PNG, HEIF. Videos require the Video Upload add-on. | | Do return reasons appear on order notes in Shopify? | Return reasons are included in the order’s notes once the item has been restocked, provided Restock by is set to Refund \$0 and restock. | # Creating Return Reasons Source: https://docs.global-e.com/creating-return-reasons-520757 **Overview** You can **create return reasons** to track why customers return items, spot patterns, and reduce future returns. You can customize which reasons customers see in the **New Return Portal**, and add **follow-up questions** to collect the details your team needs for validation and analysis. **What You'll Accomplish** * Add, edit, and display return reasons in the Admin Dashboard * Add follow-up questions (including mandatory questions and media requests) * Reorder reasons to control how they appear in the new return portal * Find return reasons on an RMA and analyze return reason trends in Analytics or exports **Requirements** Admin-level permissions in the admin dashboard (to manage return reasons and follow-up questions) **Prerequisites** Global-e recommends the following prerequisites: * Decide which reasons should be customer-facing (vs. internal-only). * Provide details (e.g., Damaged > request photo). * Keep reason names short and customer-friendly; use follow-up questions for specifics. **Adding Return Reasons** This procedure describes how to add return reasons. **To add return reasons** 1. Navigate to *Settings > Return Reasons*. 2. Do one of the following: * **Create a return reason** - click **ADD REASON**. * **Edit a return reason** - click the pencil icon next to an existing reason to edit it. 3. Enable **Display reason** to make the reason visible to customers in the new return portal. 4. Edit the reason’s display name. 5. Set a return reason category. 6. Click the **save** icon in the top right hand corner of the page. **Adding Follow-up Questions to a Return Reason** Follow-up questions appear in the new return portal **after** a customer selects a return reason (for that item). They help you collect context for validation, analytics, and processing. ### To add follow-up questions to a return reason 1. Click the **edit** icon corresponding to a return reason. 2. In the Return Reasons editor, click **ADD QUESTION**. 3. Click the **pencil** icon next to the follow-up question to configure it. 4. Toggle **Display question** so customers see it in the new return portal. 5. (Optional) Toggle **Mandatory question** to require an answer. 6. Edit the Internal name (for internal reference/reporting). 7. Choose an **Answer type**: * Free text * Media text * Multiple choice * Numerical stepper * Yes/No Additional fields are displayed based on your **Answer type** selection. For example, if you select **Multiple choice – select one**, fields for optional answers are displayed on the page. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8d701d95-7241-1c47-1f6f-2daec781c5cb.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=ab84786743e71f12a4f6cdbf9f9eb3fe) 8. Enter or edit the customer-facing **Question** text. 9. Enter **instructions** in the Instructions field using the **plus** and **minus** buttons to set the quantity.These numbers set what the Customer should provide. 10. Configure any additional settings required by the selected answer type, such as **media type** or **multiple-choice options**. > [!NOTE] > > The following limits apply to the **Media Request**: > > * Customers can upload **up to four** images or videos at a time > * Supported image types: **JPG**, **JPEG**, **PNG**, **HEIF** 11. Click the **save** icon in the top right corner of the page. **Sorting Return Reasons and Questions** Sorting return reasons and questions lets you determine the order they are displayed in the portal. **To sort return reasons and questions** 1. Navigate to *Settings > Return Reasons*. 2. Drag and drop return reasons into your preferred order. > [!TIP] > > Place the most common reasons near the top to reduce customer friction. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c93cd8ce-1f22-59e9-f2ea-257f20105350.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=ff56a7bd13db8b5390cc415488f9cc44) **Verifying Created Returns** This procedure describes to customers using the **New Returns Portal** how to verify that their returns have been created and can be seen in the platform. ## To verify created returns 1. Verify the return in the New Returns Portal: 1. Start a return for an order in the new return portal. 2. Select an item to return. 3. Confirm the customer sees your enabled reasons (those with **Display reason** turned on). 4. Select a reason that has follow-up questions and confirm: * Questions appear after selecting the reason * Mandatory questions must be completed before continuing * Media requests allow uploads (and video uploads only if the add-on is enabled) ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-61855d2d-aced-32ad-19b4-ff107f9fad67.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=e69ea3292a91d9711f8c4368bb645254) 2. **Verify on the RMA in the admin dashboard** 1. Navigate to **Manage Returns** and open an RMA. 2. In the item **Details** area, check the Details section (right side) to see the selected return reason next to each returned item. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-08a04e56-bcff-8a98-826e-3e09a021aa41.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=13274be44ff0174b94f0ee72a8cfa816) **Troubleshooting Common Issues** This section describes how to troubleshoot some commonly occurring issues: | Question | Answer | | - | - | | Reason doesn’t appear in the new return portal | Confirm Display reason is ON and you clicked the save icon. | | Follow-up question not showing | Confirm Display question is ON and saved. | | Customer can skip an answer you need. | Toggle Mandatory question ON. | | Customers can’t upload videos. | Video uploads require enabling the Video Upload add-on (images still work without it). | | Reason order in the portal isn’t what you expect. | Reorder reasons via drag-and-drop in *Settings > Return Reasons*. | **Frequently Asked Questions** The following table shows some common frequently asked questions and their answers: | Question | Answer | | - | - | | What are the default return reasons? | The platform includes a built-in set of commonly used default return reasons you can use as-is or customize. | | How many return reasons can I add? | There is no limit. | | How many follow-up questions can I add per reason? | There is no limit. | | How do I change the order shown in the new return portal? | Reorder items in Settings > Return Reasons (drag-and-drop). The portal follows that order for reasons (and follow-up questions). | | What’s the upload limit for media requests? | Up to 4 files at a time, 140MB per file. Supported images: JPG, JPEG, PNG, HEIF. Videos require the Video Upload add-on. | | Do return reasons appear on order notes in Shopify? | Return reasons are included in the order’s notes once the item has been restocked, provided Restock by is set to Refund \$0 and restock. | # Cross-Platform Information Source: https://docs.global-e.com/cross-platform-information > [!NOTE] > > \*\*This section does not apply to Shopify.\*\***For information about Shopify, see [The section on Replacements under Shopify](/global-e-orders-in-shopify#replacements-in-shopify).** **The Global-e Offering** The Global-e solution seamlessly integrates with your platform, supporting a myriad of features, operation models, and configurations. It establishes a robust and comprehensive foundation for seamless international transactions. Delve into the extensive array of features and capabilities that Global-e supports for your platform by navigating through the following sections. # Custom Clearance Fee Source: https://docs.global-e.com/custom-clearance-fee The customs clearance fee (CCF) is a charge levied by the customs broker to handle the customs clearance. The CCF will be charged when the order value is above the Duties threshold. This charge is a fixed fee per Shipper. The CCF, if required, is taken into the D\&T calculation. On the Checkout, the CCF is added to the D\&T Cost. It is not displayed separately on the checkout page. # Customer Consent Source: https://docs.global-e.com/customer-consent The Customer Consent feature allows merchants to request explicit agreement from customers to their Terms and Conditions (T\&C) during the checkout process. This capability ensures compliance with regional regulations and provides a transparent way for merchants to gather consent from customers. This capability ensures compliance with regional regulations and provides a transparent way for merchants to gather consent from customers. This feature ensures compliance with local legal requirements while providing customers with the necessary legal disclosures during checkout. Automated consent tracking reduces manual effort and ensures records are readily available for audits or disputes. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-6986cdbf-0328-8677-8368-b041ab48bf07.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=b6a41853c2d4533033835c71fdf836d1) **Customer Consent in Checkout** is a critical feature for merchants seeking to operate globally and address diverse legal landscapes with customizable options. It demonstrates transparency by ensuring customers understand and agree to the terms before completing their purchase and helps Merchants meet regulatory standards in all operational regions without compromising on customer experience. Merchants serving a worldwide audience can enable a universal consent checkbox while customizing it for specific legal requirements in certain countries. Merchants can configure tailored consent options for regions like China and South Korea, meeting local requirements while maintaining a seamless checkout experience. Consent records are securely stored, providing a reliable trail for merchants to reference if needed. **Key Features** * **Global Consent**: A checkbox is displayed for customers to confirm their agreement to the Merchant's T\&C. This option is available for all countries unless regional-specific consent is configured. * **Country-Specific Consent** offers tailored solutions for regions with stricter requirements and overrides global consent for these regions: * **China**: A single checkbox with specific text. * **South Korea**: Multiple checkboxes (up to five), including an optional "Check All" feature. * **Consent Logging**: Customer consent is securely saved for every order, ensuring traceability and compliance with legal standards. **Customer Experience** * **Global Consent**: Customers see a single checkbox requesting agreement to the T\&C before completing their order. Clear and concise messaging ensures understanding. * **Regional-Specific Consent**: In countries like China and South Korea, customers encounter additional or tailored checkboxes aligned with local requirements. Customers must check all boxes (or use the "Check All" option) before finalizing the purchase. * **Order Completion**: Consent is seamlessly recorded with the order, enhancing the transaction’s transparency and security. **Examples of Consent Texts** Following are examples of consent texts for different use cases: * **Global Consent**: "I agree to the Terms and Conditions of \[Merchant Name]. * **China-Specific Consent**: "I understand and accept the Terms and Conditions for purchases in China." * **South Korea-Specific Consent**: * Checkbox 1: "I consent to the collection of personal data for order processing." * Checkbox 2: "I agree to the merchant’s privacy policy." * Checkbox 3: "I understand and accept the terms for returns and refunds." ## Customer Cookie Consent This feature allows merchants to identify and respect a customer’s choice regarding cookies during browsing. This ensures compliance with GDPR guidelines by only enabling non-essential services after the customer has provided explicit consent. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-20c9d16c-a1ab-b0c8-3c78-68c89b94e66c.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=b4142689f7890be20b643c3a4d63003c) When a customer visits your store they are presented with a message asking if they consent to having their cookies tracked. The following options are offered: * Accept All: Enables all cookies. * Reject All: Enables only essential cookies. * Accept Only Necessary: Enable only essential cookies. * No selection (pop-up is closed): Enables only essential cookies. * Customize/Manage preferences: Customers choose preferences. **Non-Essential services** The following services are considered non-essential and are disabled by default, or if the customer chooses to enable only essential cookies: * Google Analytics * Fullstory * VWO * Raygun ## Legal Consent The Legal Consent feature allows merchants to configure a consent request on the checkout page, ensuring that customers agree to legal disclaimers before completing an order. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ecfe1655-3271-dde6-db1c-26a07321f0a8.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=459f6f5ad05ec4a58ec17f230db67aa5) This feature ensures compliance with local legal requirements while providing customers with the necessary legal disclosures during checkout. **Configurations** The following settings can be configured: * **Location:** Merchants can configure the legal consent request for specific countries or apply it universally. This ensures that the consent request meets the legal requirements of each jurisdiction. * **Text resources**: To display the consent checkboxes, merchants must configure text resources. The default resource format is `Checkout.CountryName.LegalConsent#` **Example:** * Checkout.Korea(South).LegalConsent1 * Checkout.Korea(South).LegalConsent2 * Checkout.Korea(South).LegalConsent3 The number of checkboxes displayed corresponds to the number of resources configured for the country. * **CheckAll**: A checkbox to check all boxes can be added, by adding the resource in the following format: `Checkout.CountryName.LegalConsent.CheckAll` * **Example**: `Checkout.Korea(South).LegalConsent.CheckAll` * **Text Placeholders:** Placeholders can be included in the text resources to dynamically populate information. The following placeholders are supported: * \{PRIVACYPOLICY}: The link to the Global-e Privacy Policy * \{MERCHANTNAME}: The merchant’s name * \{TERMS}: The link to the Global-e Terms and Conditions * \{MERCHANTPRIVACYPOLICY}: A new placeholder linking to the merchant’s privacy policy. Ask Global-e to set your privacy policy URL for your account. **Error Message** If a customer leaves any required checkboxes unselected, the order is not confirmed and an error message is displayed above the first unselected checkbox. For multiple unselected checkboxes, the error message appears above the highest one on the page. As the customer selects each checkbox, the message moves to the next unselected checkbox until all are addressed. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-dd13ca5b-6688-8027-b98a-281750ccacfd.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=da5ab319e5c54d9976f758e06cc19fb3) ## Marketing Consent Customers are offered the option to opt in or out of receiving marketing materials and SMS messages from the merchant. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1eed2ca9-478a-f02b-f8a3-46b9c8e666c0.jpg?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=ecec3e691876921b3ad4cb36beae101b) Under the address section are two check boxes that offer customers the option to: * Opt-in/ out of receiving special offers and promotions. * Opt-in/ out of receiving SMS messages. By default, the checkboxes are unselected. ## Translated Privacy Policy and Terms of Sale Customers are redirected to the Privacy Policy and Terms of Sale pages in the language selected during checkout, ensuring a seamless and consistent multilingual experience. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-67ec013e-29be-99be-b1ef-e0aa9ffe20d9.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=d26fd8fdc3ad4587faeb71a7b2ef671c) # Customer Experience Source: https://docs.global-e.com/customer-experience > [!NOTE] > > **This section does not apply to Shopify. For information about Shopify, see [Shopify Native](/shopify-native).** When International Customers Visit your website, Global-e automatically detects their country. * The Global-e Welcome pop-up greets shoppers in their language. * Optional: If configured, the Marketing Banner shows shoppers promotional messages in their language. * The Country Switcher lets shoppers set or change the shipping destination. * During their browsing journey, shoppers add products to their carts in their local currencies. * Shoppers proceed to the Global-e checkout page where they can: * Select the language to complete the checkout process. * Adjust the accessibility settings. * Review the order summary. * Enter the shipping and billing details. If the provided address is incorrect, an alternative address is suggested to the customer. * Select the preferred shipping method. See the supported Shipping Methods. * Select their preferred payment method. See the supported Payment Methods. * View and prepay all duties and taxes when checking out. * View the total amount. * Once the payment has been verified and approved, the order is confirmed. An email notification notifies the shopper of the status of their order. See [Transactional Emails](/transactional-emails). ## Additional Features and Tools * Shoppers can use the Tracking Portal to track their orders. See [Tracking Portal](/tracking-portal). * Shoppers can use the Return Portal to return or replace an order or part of an order. Alternatively, the Merchant can return or replace orders on behalf of the customers. See [Returns Portal](/returns-portal). ## See Also [Supported Countries](/countries-supported#supported-countries) [Supported Payment Methods](/payment-methods-386962) [Supported Currencies](/supported-currencies) [Supported Languages](/languages#supported-languages) # Customer Groups Source: https://docs.global-e.com/customer-groups-sfcc Global-e exposes [session custom attributes](/session-attributes-sfcc) that work in Dynamic Customer Group membership rules. Use them in content slots, promotions, and other BM targeting. For example, to restrict promotions to Global-e international customers, define Dynamic Customer Group rules in Business Manager on **`session.custom.geIsOperated`** (and optionally `geCountry`, `geCurrency`, `gePriceStrategy`). Demo groups ship in **`metadata/demo/demo.customergroup.xml`** (`GlobaleCustomers`, `NonGlobaleCustomers`). Combine attributes such as `geIsOperated`, `geCountry`, `geCurrency`, and `gePriceStrategy` with **AND** / **OR** conditions. > [!NOTE] > > These `session.custom.ge*` attributes are populated by the `globale.onInit` handler in `int_globale_sfra` / `int_globale_sitegenesis`. On popups-only or headless-only sites they are not set out of the box — see [Session attributes](/session-attributes-sfcc) for scope. **See also:** [Customization](/customization-sfcc) (hiding domestic UI) · [Cookies](/cookies-sfcc) · [Promotions](/promotions-sfcc) # Customization Source: https://docs.global-e.com/customization-sfcc Global-e cartridges follow SFCC LINK partner guidelines: install **`int_globale`** plus a storefront extension without modifying `app_storefront_base`. Global-e **does not recommend** editing **`int_globale`** directly. Extend behavior in **`int_globale_sfra`**, **`int_globale_sitegenesis`**, or your brand cartridge using the same patterns as SFRA/SiteGenesis overrides (copy or superModule extend controllers, models, templates, and client JS). **Related topics:** [Session attributes](/session-attributes-sfcc) · [Customer groups](/customer-groups-sfcc) · [Client JS SDK](/client-js-sdk-sfcc) · [Hooks](/hooks-sfcc) ## Extension cartridge rules If you customize a controller, model, or template from **`int_globale`**, copy or extend it in **`int_globale_sfra`** / **`int_globale_sitegenesis`** (or your brand cartridge) and keep changes out of core. Some **`int_globale_sitegenesis`** templates override SiteGenesis core and hardcode cartridge IDs (for example `importScript('app_storefront_core:catalog/libCompareList.ds')`). Update those IDs to match your project's core cartridge when needed. After installation, align existing brand logic with Global-e using either approach: * Customize scripts and templates in **`int_globale_sfra`** or **`int_globale_sitegenesis`**, or * Move overrides into your brand cartridge. ## Hiding non-applicable elements Hide domestic-only UI for Global-e operated countries by checking session or app context. Example from **`int_globale_sfra/cartridge/templates/default/cart/cartShippingMethodSelection.isml`** (shipping methods do not apply to Global-e checkout): ```xml theme={null}
...
``` Equivalent check using [session attribute](/session-attributes-sfcc) `geIsOperated`: ```xml theme={null} ``` Common elements to hide for Global-e customers: * Domestic shipping methods on the cart page * PayPal or other domestic payment methods on the cart page * In-store pickup * Domestic customer service contact information For welcome popup, country switcher, and checkout iframe behavior, see [Client JS SDK](/client-js-sdk-sfcc). For checkout and order flows, see [Checkout flow](/checkout-flow-sfcc). # Customizing Email Notifications Source: https://docs.global-e.com/customizing-email-notifications This page describes the following: * [Limitations](/limitations) * [Editing Email Notification Texts](/editing-email-notification-texts) * [Configuring Sending Settings](/configuring-sending-settings) * [Receiving Notification Copies](/receiving-notification-copies) * [Email Notification Elements](/email-notification-elements) * [Customizing Email Notifications](/customizing-email-notifications-701332) * [RMA Variables & Events](/rma-variables---events) # Customizing Email Notifications Source: https://docs.global-e.com/customizing-email-notifications-2-701330 This page describes the following: * [Limitations](/limitations) * [Editing Email Notification Texts](/editing-email-notification-texts) * [Configuring Sending Settings](/configuring-sending-settings) * [Receiving Notification Copies](/receiving-notification-copies) * [Email Notification Elements](/email-notification-elements) * [Customizing Email Notifications](/customizing-email-notifications-701332) * [RMA Variables & Events](/rma-variables---events) # Customizing Email Notifications Source: https://docs.global-e.com/customizing-email-notifications-3-701332 **Email notifications** are automated emails that your customers receive throughout the post-purchase process. Different types of email notifications are sent based on actions taken by the store, the customer, or automated flows in the returns process. ## Global Email Notification Elements Most returns or order tracking email notifications include several general statements and details. These are included without regard to the action that triggered the sending of emails. ### To configure general email notification elements 1. Navigate to *Settings > Emails > Content*. 2. Click **TRANSLATE RETURNS EMAILS** or **TRANSLATE ORDER TRACKING EMAILS** to edit the relevant notification type. 3. Click the pencil icon corresponding to the language you want to edit. 4. Expand the **General Email** section. 5. Customize the required fields. > [!NOTE] > > You can use the **Hint** located below each field to understand how the content is used in the email. 6. Click **SAVE** at the bottom of the page to save the changes. ## Notification-Specific Email Templates The Returns portal provides different email notifications based on the return status. For each notification you can edit the subject line and email body. You can find the right field by searching for the default subject text. As stated above, you can use the Hint located below each field to understand how the content is used in the email. > [card] > > * [Manual Credits Email](/customizing-email-notifications-701332#manual-credits-email) > * [Request Approved Email](/customizing-email-notifications-701332#request-approved-email) > * [Shipment In-Transit Email](/customizing-email-notifications-701332#shipment-in-transit-email) > * [Shipment Received Email](/customizing-email-notifications-701332#shipment-received-email) > * [Request Rejected Email](/customizing-email-notifications-701332#request-rejected-email) > * [Request Canceled Email](/customizing-email-notifications-701332#request-canceled-email) > * [Request Reopened Email](/customizing-email-notifications-701332#request-reopened-email) > [card] > > * [Pending Approval Email](/customizing-email-notifications-701332#pending-approval-email) > * [Order Canceled Email](/customizing-email-notifications-701332#order-canceled-email) > * [Manual and Instant Gift Card Emails](/customizing-email-notifications-701332#manual-and-instant-gift-card-emails) > * [Charged Fees Invoice](/customizing-email-notifications-701332#charged-fees-invoice) > * [Exchange Order Invoice](/customizing-email-notifications-701332#exchange-order-invoice) > * [Instant Credits Email](/customizing-email-notifications-701332#instant-credits-email) > * [Instant Refund Email](/customizing-email-notifications-701332#instant-refund-email) ### Manual Credits Email * Triggers when a refund to store credit is issued for the RMA. * The email includes the store credit amount, the discount code, and the redemption instructions. * Default subject: A store credit refund has been issued * The subject line and email body can be customized. ### Request Approved Email * Triggers when an RMA is approved, whether manually or automatically. * This email includes the shipping instructions for the selected return method. * If the resolution is Return Score-based Instant Credits, the email will include next steps for the customer: whether to keep the item, ship it back, or donate it. * Default subject: Your return request has been approved * The subject line and email body can be customized. ### Shipment In-Transit Email * Triggers when a return label is scanned by the carrier. * Only available if the shipping platform used to generate the label offers live tracking. * Typically includes the link to the shipment's tracking page. * Default subject: Return shipment is in transit * The subject line and email body can be customized. ### Shipment Received Email * Triggers when the RMA is marked as Shipment Received. * Default subject: We have received your returned items * The subject line and email body can be customized. ### Request Rejected Email * Triggers when a return request is rejected. * Default subject: Your return request has been rejected * The subject line and email body can be customized. > [!NOTE] > > The `:reject_reason` variable will display the reason added at the time of rejection. This value cannot be edited from the email template. ### Request Canceled Email * Triggers when a return request is canceled. * Default subject: Your return request has been canceled * The subject line and email body can be customized. > [!NOTE] > > The `:cancel_reason` variable will display the reason added at the time of cancellation. This value cannot be edited from the email template. ### Request Reopened Email * Triggers when a return request is reopened. * Default subject: Your return request has been reopened * The subject line and email body can be customized. ### Pending Approval Email * Triggers when a return request is submitted through the return portal and is pending approval. * Default subject: You submitted a return request * The subject line and email body can be customized. ### Order Canceled Email * Triggers when an order is canceled. * This triggers the OMS (e.g. Shopify) to send a separate email saying the order has been canceled. * Default subject: Order #### has been canceled per your request * The subject line and email body can be customized. ### Manual and Instant Gift Card Emails * Triggers when a refund to a new gift card is issued. * The email includes the gift amount only - not the gift card code. * This triggers the OMS (e.g. Shopify) to send a separate email that includes the gift card details. * Default subject (the Returns portal): A gift card refund has been issued * Default subject (Shopify): Store \$X gift card * Both the subject line and email body can be customized. ### Charged Fees Invoice * Sent automatically as soon as an exchange/return request is submitted where there are fees to be settled. * The email comes from the OMS (e.g. Shopify), not the Returns portal. * Includes the amount to be settled and a link to pay the remaining charges. * Default subject: Fee charges for RMA # of Order #### * The subject line and email body can be customized. ### Exchange Order Invoice * Triggers when an exchange has a price difference that needs to be settled. * The email comes from the OMS (e.g. Shopify), not the Returns portal. * Includes the amount to be settled and a link to pay the remaining charges. * Default subject: Remaining charges for exchange of Order #### * The subject line and email body can be customized. ### Instant Credits Email * Triggers when store credits are issued instantly. * Default subject: Yay 🎉 Congrats on your store credits! What to do next? * The subject line and email body can be customized. ### Instant Refund Email * Triggers when an RMA is auto-approved and the return type is a virtual value (e.g., Refundid or Rise.ai credits) with automation set to auto-refund upon approval. * Default subject: Yay 🎉 You are eligible for an instant refund! * The subject line and email body can be customized. # Customizing Email Notifications Source: https://docs.global-e.com/customizing-email-notifications-701332 **Email notifications** are automated emails that your customers receive throughout the post-purchase process. Different types of email notifications are sent based on actions taken by the store, the customer, or automated flows in the returns process. ## Global Email Notification Elements Most returns or order tracking email notifications include several general statements and details. These are included without regard to the action that triggered the sending of emails. ### To configure general email notification elements 1. Navigate to *Settings > Emails > Content*. 2. Click **TRANSLATE RETURNS EMAILS** or **TRANSLATE ORDER TRACKING EMAILS** to edit the relevant notification type. 3. Click the pencil icon corresponding to the language you want to edit. 4. Expand the **General Email** section. 5. Customize the required fields. > [!NOTE] > > You can use the **Hint** located below each field to understand how the content is used in the email. 6. Click **SAVE** at the bottom of the page to save the changes. ## Notification-Specific Email Templates The Returns portal provides different email notifications based on the return status. For each notification you can edit the subject line and email body. You can find the right field by searching for the default subject text. As stated above, you can use the Hint located below each field to understand how the content is used in the email. > [card] > > * [Manual Credits Email](/customizing-email-notifications-701332#manual-credits-email) > * [Request Approved Email](/customizing-email-notifications-701332#request-approved-email) > * [Shipment In-Transit Email](/customizing-email-notifications-701332#shipment-in-transit-email) > * [Shipment Received Email](/customizing-email-notifications-701332#shipment-received-email) > * [Request Rejected Email](/customizing-email-notifications-701332#request-rejected-email) > * [Request Canceled Email](/customizing-email-notifications-701332#request-canceled-email) > * [Request Reopened Email](/customizing-email-notifications-701332#request-reopened-email) > [card] > > * [Pending Approval Email](/customizing-email-notifications-701332#pending-approval-email) > * [Order Canceled Email](/customizing-email-notifications-701332#order-canceled-email) > * [Manual and Instant Gift Card Emails](/customizing-email-notifications-701332#manual-and-instant-gift-card-emails) > * [Charged Fees Invoice](/customizing-email-notifications-701332#charged-fees-invoice) > * [Exchange Order Invoice](/customizing-email-notifications-701332#exchange-order-invoice) > * [Instant Credits Email](/customizing-email-notifications-701332#instant-credits-email) > * [Instant Refund Email](/customizing-email-notifications-701332#instant-refund-email) ### Manual Credits Email * Triggers when a refund to store credit is issued for the RMA. * The email includes the store credit amount, the discount code, and the redemption instructions. * Default subject: A store credit refund has been issued * The subject line and email body can be customized. ### Request Approved Email * Triggers when an RMA is approved, whether manually or automatically. * This email includes the shipping instructions for the selected return method. * If the resolution is Return Score-based Instant Credits, the email will include next steps for the customer: whether to keep the item, ship it back, or donate it. * Default subject: Your return request has been approved * The subject line and email body can be customized. ### Shipment In-Transit Email * Triggers when a return label is scanned by the carrier. * Only available if the shipping platform used to generate the label offers live tracking. * Typically includes the link to the shipment's tracking page. * Default subject: Return shipment is in transit * The subject line and email body can be customized. ### Shipment Received Email * Triggers when the RMA is marked as Shipment Received. * Default subject: We have received your returned items * The subject line and email body can be customized. ### Request Rejected Email * Triggers when a return request is rejected. * Default subject: Your return request has been rejected * The subject line and email body can be customized. > [!NOTE] > > The `:reject_reason` variable will display the reason added at the time of rejection. This value cannot be edited from the email template. ### Request Canceled Email * Triggers when a return request is canceled. * Default subject: Your return request has been canceled * The subject line and email body can be customized. > [!NOTE] > > The `:cancel_reason` variable will display the reason added at the time of cancellation. This value cannot be edited from the email template. ### Request Reopened Email * Triggers when a return request is reopened. * Default subject: Your return request has been reopened * The subject line and email body can be customized. ### Pending Approval Email * Triggers when a return request is submitted through the return portal and is pending approval. * Default subject: You submitted a return request * The subject line and email body can be customized. ### Order Canceled Email * Triggers when an order is canceled. * This triggers the OMS (e.g. Shopify) to send a separate email saying the order has been canceled. * Default subject: Order #### has been canceled per your request * The subject line and email body can be customized. ### Manual and Instant Gift Card Emails * Triggers when a refund to a new gift card is issued. * The email includes the gift amount only - not the gift card code. * This triggers the OMS (e.g. Shopify) to send a separate email that includes the gift card details. * Default subject (the Returns portal): A gift card refund has been issued * Default subject (Shopify): Store \$X gift card * Both the subject line and email body can be customized. ### Charged Fees Invoice * Sent automatically as soon as an exchange/return request is submitted where there are fees to be settled. * The email comes from the OMS (e.g. Shopify), not the Returns portal. * Includes the amount to be settled and a link to pay the remaining charges. * Default subject: Fee charges for RMA # of Order #### * The subject line and email body can be customized. ### Exchange Order Invoice * Triggers when an exchange has a price difference that needs to be settled. * The email comes from the OMS (e.g. Shopify), not the Returns portal. * Includes the amount to be settled and a link to pay the remaining charges. * Default subject: Remaining charges for exchange of Order #### * The subject line and email body can be customized. ### Instant Credits Email * Triggers when store credits are issued instantly. * Default subject: Yay 🎉 Congrats on your store credits! What to do next? * The subject line and email body can be customized. ### Instant Refund Email * Triggers when an RMA is auto-approved and the return type is a virtual value (e.g., Refundid or Rise.ai credits) with automation set to auto-refund upon approval. * Default subject: Yay 🎉 You are eligible for an instant refund! * The subject line and email body can be customized. # Sale Prices and Discounts Source: https://docs.global-e.com/discounts This section outlines the steps necessary for implementing sale prices as part of the checkout process, covering both dynamic and fixed pricing scenarios. ## Dynamic Prices To implement sale prices for countries for which Global-e converts the prices, you must pass as the sale price through the `OriginalSalePrice` field in the `getCheckoutCartInfo` response in your domestic currency. **Example:** `"OriginalListPrice": 46,` `"OriginalSalePrice": 25` **Sample:** ``` {    "productsList": [      {        "ProductCode": "4296033",        "ProductGroupCode": "697662",        "CartItemId": "8426207451",        "NameEnglish": "Name",        "Name": " Name",        "DescriptionEnglish": "Lorem ipsum dolor sit amet",        "Description": " Lorem ipsum dolor sit amet",        "URL": "https://domain/image.html",        "GenericHSCode": "610443",        "Brand": {          "BrandCode": "661",          "Name": "Brand"        },        "ImageURL": "https://domain/images/image.jpg",        "ImageWidth": 560,        "ImageHeight": 840,        "OriginalListPrice": 46,        "OriginalSalePrice": 25,        "OrderedQuantity": 1,        "IsBlockedForGlobalE": false,        "Weight": 6.64      }    ]  } ``` ## Fixed Prices To implement sale prices that are fixed, you must pass the fixed prices in the `SalePrice`, `OriginalPrice` fields, and set `isFIxedPrice` to true in the `getCheckoutCartInfo` response in the local currency. **Example:** `"IsFixedPrice": true,` `"SalePrice": 120,` `"ListPrice": 120,` The `OriginaListPrice` and `OriginalSalePrice` fields are ignored if they are passed. **Sample:** ``` { "productsList": [ { "ProductCode": "4296033", "ProductGroupCode": "697662", "CartItemId": "8426207451", "NameEnglish": "Name", "Name": " Name", "DescriptionEnglish": "Lorem ipsum dolor sit amet", "Description": " Lorem ipsum dolor sit amet", "URL": "https://domain/image.html", "GenericHSCode": "610443", "Brand": { "BrandCode": "661", "Name": "Brand" }, "ImageURL": "https://domain/images/image.jpg", "ImageWidth": 560, "ImageHeight": 840, "IsFixedPrice": true, "SalePrice": 120, "ListPrice": 120, "OriginalListPrice": 0, "OriginalSalePrice": 0, "OrderedQuantity": 1, "IsBlockedForGlobalE": false, "Weight": 6.64 } ] } ``` To implement a fixed price display outside of the checkout, see [Fixed Prices Support](/prices---sales-fixed-prices#fixed-prices-support). ## Checkout Discount Discounts are passed to the Global-e checkout via the `getCheckoutCartInfo’s` [discountsList](/api-reference/get-checkout-cart-info) object. ### Product-level Discounts To apply a discount to a product, assign the same value to the `discountsList.ProductCartItemId`  as for the `productsList.CartItemId` ``` { "productsList": [ { "ProductCode": "SKU or product itentifier", "CartItemId": "lineID1", "NameEnglish": "Product name", "Name": "Product name", "DescriptionEnglish": "Product description", "Description": "Product description", "URL": "https:/domain/page.html", "ImageURL": "https://domain/image.jpg", "ImageWidth": 100, "ImageHeight": 100, "OriginalListPrice": 100, "OriginalSalePrice": 100, "OrderedQuantity": 2, "IsBlockedForGlobalE": false, "Weight": 11.4 } ], "discountsList": [ { "CalculationMode": 1, "Name": "Discount Name", "Description": "Discount description", "OriginalDiscountValue": 20, "CouponCode": "yourCouponCode", "DiscountCode": "yourDiscountCode", "DiscountType": 1, "ProductCartItemId": "lineID1" } ] } ``` ### Cart Level Discounts Implement Cart-level discounts as you have done for product-level discounts but omit the `ProductCartItemId` for it to be considered a cart-level discount. For the different types of calculation modes, see [Discount](/api-reference/get-checkout-cart-info). ``` { "productsList": [ { "ProductCode": "SKU or product itentifier", "CartItemId": "lineID1", "NameEnglish": "Product name", "Name": "Product name", "DescriptionEnglish": "Product description", "Description": "Product description", "URL": "https:/domain/page.html", "ImageURL": "https://domain/image.jpg", "ImageWidth": 100, "ImageHeight": 100, "OriginalListPrice": 100, "OriginalSalePrice": 100, "OrderedQuantity": 2, "IsBlockedForGlobalE": false, "Weight": 11.4 } ], "discountsList": [ { "CalculationMode": 1, "Name": "Discount Name", "Description": "Discount description", "OriginalDiscountValue": 20, "CouponCode": "yourCouponCode", "DiscountCode": "yourDiscountCode", "DiscountType": 1 } ] } ``` # Dispatch Notifications (Global‑e to Merchant) Source: https://docs.global-e.com/dispatch-notifications--from-global-e- The Update Parcel Dispatch API pushes to the merchant Global-e updated Parcel Dispatch Information. This notification will trigger when the prepared Orders/Parcels reach a status of "Dispatched to Customer" upon running the Carrier end-of-day manifest from the hub of dispatch (Global-e Hub or Merchant Hub depending on the logistics model). > [card] [Update Parcel Dispatch](/api-reference/update-parcel-dispatch) > > POST /UpdateParcelDispatch # Dispatch Notifications (Merchant to Global‑e) Source: https://docs.global-e.com/dispatch-notifications-via-api Manifest shipping requirements sent by Merchants to Global-e via API. This section describes the manifest shipping requirements sent by Merchants to Global-e via API. The Manifest allows the timely and correct processing of parcels in the Global‑e hub or in the Merchant's warehouse. This procedure is required for: * Merchants sending multi-parcel orders. * Merchants wishing to fulfill backordered items. The manifest includes information about items and parcels that you ship on a given day and allows Global‑e to: * Create relevant Airway bills (AWB) and export documentation for all parcels when the parcels are processed at the Global-e hub. * Amend out-of-stock items automatically: * The customer is notified in advance that some of the items are out of stock. * The customer is refunded or authorization amounts are amended. * The export paperwork is updated to reflect the correct items and quantities for duties and taxes calculations, ensuring timely release from customs in the destination country. * Shipping via the Global‑e hub: Know in advance how many parcels are on the way and their unique identifier codes so that these can be scanned and processed on arrival. > [!NOTE] > > The manifest is recommended but not required when: > > * Shipping a single parcel order and you do not require backorder (pre-order) items support. When implementing the manifest, the order is automatically amended for out-of-stock items. > * Shipping multi-parcel orders from your warehouse and all parcels are shipped the same day (order fulfilment is not split over a period of few days). When implementing the manifest, the order is automatically amended for out-of-stock items and the airway bills (AWB) and export paperwork are automatically generated. As part of its cross-border enablement, Global‑e provides the following shipping-related features: * Duties & Taxes calculation * Commercial Invoice generation (or paperless trading when relevant) * Carrier label * Automated international refunds * Order split shipment * Customer dispatch notification and tracking information As part of the order fulfilment process, the following should be covered to guarantee that the shipping documentation matches the order dispatch: * Multiple parcels order declaration * Order items line cancellation (for example, Out of stock) * Partial delayed shipments (for example, restocking items) **Types of shipping exceptions** | ExceptionType | Name | Description | | - | - | - | | 1 | Out-of-Stock | Out of stock, will not be fulfilled. | | 2 | Backorder Pre-order Customized Item | Backorder/preorder/customized item/to be restocked will be fulfilled. | | 3 | Cancelled by request | The customer requested to remove this product. Will not be fulfilled. | **Used in the following cases** (1) Shipping from the Global‑e hub and the merchant notifies about the parcel shipped from the merchant hub to the Global‑e hub (2) Out of Stock Notification (3) Shipping with a non-Global-e carrier: In this case, no documents are needed. > [!NOTE] > > The manifest process (and related API) is designed to support notifications of parcel preparation/dispatch. Calls should always be made upon dispatching a product and never be used to notify only exceptions. > > The only edge case with using only an exception in a call is to notify no further expected items will be dispatched thus requiring to close the order with "Out of stock" and "order complete" where all remaining items would be refunded. ## Prerequisites The Merchant OMS or WhMS should have knowledge of the following information and allow, either directly or through an escalation process, to: * Have the full list of items in the order * Enable selection of items to be dispatched * If applicable, enable the cancellation of line items * If applicable, enable the declaration of items as back-ordered After performing the effective pick & pack and required actions in the OMS/WhMS, the following integration can be used to process the orders prior to dispatch. **Schedule** The report should be sent once the pick and pack in the Merchant warehouse has been completed for the day and before the orders arrive at the Global-e hub or before the orders are prepared for international shipping by merchants fulfilling from their own warehouse. > [!NOTE] > > The API triggers an asynchronous process, only the first-level JSON body structure will be checked upon receiving a call to trigger a success or failure response. Hence expected results must not be presumed on Success response depending on body sub-attributes processed asynchronously. > [card] [Update Order Dispatch V2](/api-reference/update-order-dispatch-v2) > > POST /Order/UpdateOrderDispatchV2 ## Main Attributes Description For the full list of attributes, see the [Update Order Dispatch V2](/api-reference/update-order-dispatch-v2) API reference. The following rules apply to this integration: * **IsCompleted**: Once True, all items not already declared as part of a parcel will be cancelled and refunded. Until True, consolidation of parcels is expected if no backorders. If orders have backorders exception specified: not required to allow for dispatch of existing parcels without delay. * **ParcelCode**: Merchant unique identifier for each parcel(/box) to be shipped. Can be freely generated in any range as long as unique. * **ProductCode** OR **CartItemId**: should match cart information fields exchanged at checkout time. ## Use Cases **Examples of request body as** `UpdateOrderDispatchRequest` Considerations regarding examples for simplicity: * Using the merchant's own order number in `OrderId` rather than the GE order ID * Using `ProductCode` rather than `CartItemId` ### Single Parcel Shipping Order description for this section: * Product-A in quantity 1 * Product-B in quantity 2 #### No Exceptions ```json theme={null} { "OrderId": "100018322", "IsCompleted": true, "Parcels": [{ "ParcelCode": "100018322-1", "Products": [ { "ProductCode": "product-A", "DeliveryQuantity": 1 }, { "ProductCode": "product-B", "DeliveryQuantity": 2 } ] }], "Exceptions": [] } ``` #### Explicit Partial Cancellation Cancellation of 1 product-B Single Call ```json theme={null} { "OrderId": "100018322", "IsCompleted": true, "Parcels": [{ "ParcelCode": "100018322-1", "Products": [ { "ProductCode": "product-A", "DeliveryQuantity": 1 }, { "ProductCode": "product-B", "DeliveryQuantity": 1 } ] }], "Exceptions": [{ "ProductCode": "product-B", "ExceptionType": 1 }] } ``` #### Implicit Partial Cancellation Cancellation of 1 product-B Single call ```json theme={null} { "OrderId": "100018322", "IsCompleted": true, "Parcels": [{ "ParcelCode": "100018322-1", "Products": [ { "ProductCode": "product-A", "DeliveryQuantity": 1 }, { "ProductCode": "product-B", "DeliveryQuantity": 1 } ] }] } ``` ### Multi Parcel (No Splitting / Partial Shipping) Order description for this section: * product-A in quantity 1 * product-B in quantity 2 #### No Exceptions Single call ```json theme={null} { "OrderId": "100018322", "IsCompleted": true, "Parcels": [ { "ParcelCode": "100018322-1", "Products": [{ "ProductCode": "product-A", "DeliveryQuantity": 1 }] }, { "ParcelCode": "100018322-2", "Products": [{ "ProductCode": "product-B", "DeliveryQuantity": 2 }] } ] } ``` #### Partial Dispatches and Calls with Consolidation Request Dispatch of 1 product-B at a later date but to be consolidated with other parcels before shipping any. > [!NOTE] > > The 1st call flags the order as incomplete but no "backorder" is specified. **First call ("day 1")** ```json theme={null} { "OrderId": "100018322", "IsCompleted": false, "Parcels": [ { "ParcelCode": "100018322-1", "Products": [{ "ProductCode": "product-A", "DeliveryQuantity": 1 }] }, { "ParcelCode": "100018322-2", "Products": [{ "ProductCode": "product-B", "DeliveryQuantity": 1 }] } ] } ``` **Subsequent call ("day 2")** ```json theme={null} { "OrderId": "100018322", "IsCompleted": true, "Parcels": [{ "ParcelCode": "100018322-3", "Products": [{ "ProductCode": "product-B", "DeliveryQuantity": 1 }] }] } ``` ### Split Parcel Supporting Pre-orders and Backorders Order description for this section: * product-A in quantity 1 * product-B in quantity 2 * product-C in quantity 1 #### Explicit Backordering and Explicit Cancellation Cancellation of 1 product-C Backordering of 1 product-A **First call ("day 1")** ```json theme={null} { "OrderId": "100018322", "IsCompleted": false, "Parcels": [{ "ParcelCode": "100018322-1", "Products": [{ "ProductCode": "product-B", "DeliveryQuantity": 2 }] }], "Exceptions": [ { "ProductCode": "product-C", "ExceptionType": 1 }, { "ProductCode": "product-A", "ExceptionType": 2 } ] } ``` **Subsequent call ("day 2")** ```json theme={null} { "OrderId": "100018322", "IsCompleted": true, "Parcels": [{ "ParcelCode": "100018322-2", "Products": [{ "ProductCode": "product-A", "DeliveryQuantity": 1 }] }] } ``` #### Implicit Partial Cancellation (split) Cancellation of 1 product-C Backordering of 1 product-A **First call ("day 1")** ```json theme={null} { "OrderId": "100018322", "IsCompleted": false, "Parcels": [{ "ParcelCode": "100018322-1", "Products": [{ "ProductCode": "product-B", "DeliveryQuantity": 2 }] }], "Exceptions": [{ "ProductCode": "product-A", "ExceptionType": 2 }] } ``` **Subsequent call ("day 2")** ```json theme={null} { "OrderId": "100018322", "IsCompleted": true, "Parcels": [{ "ParcelCode": "100018322-2", "Products": [{ "ProductCode": "product-A", "DeliveryQuantity": 1 }] }] } ``` #### Multiple Partial Dispatches with Explicit Cancellation (Consolidated) Cancellation of 1 product-B Backordering of 1 product-A Backordering of 1 product-C **First call ("day 1")** ```json theme={null} { "OrderId": "100018322", "IsCompleted": false, "Parcels": [{ "ParcelCode": "100018322-1", "Products": [{ "ProductCode": "product-B", "DeliveryQuantity": 1 }] }], "Exceptions": [{ "ProductCode": "product-B", "ExceptionType": 1 }] } ``` **Subsequent call ("day 2")** ```json theme={null} { "OrderId": "100018322", "IsCompleted": false, "Parcels": [{ "ParcelCode": "100018322-2", "Products": [{ "ProductCode": "product-A", "DeliveryQuantity": 1 }] }] } ``` **Subsequent call ("day 3")** ```json theme={null} { "OrderId": "100018322", "IsCompleted": true, "Parcels": [{ "ParcelCode": "100018322-3", "Products": [{ "ProductCode": "product-C", "DeliveryQuantity": 1 }] }] } ``` #### Partial Dispatch Followed by the Cancellation of Missing Item(s) **First call ("day 1")** ```json theme={null} { "OrderId": "100018322", "IsCompleted": false, "Parcels": [{ "ParcelCode": "100018322-1", "Products": [ { "ProductCode": "product-A", "DeliveryQuantity": 1 }, { "ProductCode": "product-B", "DeliveryQuantity": 2 } ] }] } ``` **Subsequent call ("day 2")** Cancellation of product-C as non-available in the end, "close order" call ```json theme={null} { "OrderId": "100018322", "IsCompleted": true, "Parcels": [], "Exceptions": [{ "ProductCode": "product-C", "ExceptionType": 1 }] } ``` #### Auto Complete with Split **First Dispatch** 1 product-B dispatch, 1 product-A backorder, 1 product-B backorder, 1 product-C backorder ```json theme={null} { "OrderId": "100018322", "Parcels": [{ "ParcelCode": "100018322-1", "Products": [{ "ProductCode": "product-B", "DeliveryQuantity": 1 }] }], "Exceptions": [ { "ProductCode": "product-A", "ExceptionType": 2 }, { "ProductCode": "product-B", "ExceptionType": 2 }, { "ProductCode": "product-C", "ExceptionType": 2 } ] } ``` **Intermediate Cancel** 1 product-B cancel ```json theme={null} { "OrderId": "100018322", "Parcels": [], "Exceptions": [{ "ProductCode": "product-B", "ExceptionType": 1 }] } ``` **Second Dispatch** 1 product-A dispatch ```json theme={null} { "OrderId": "100018322", "Parcels": [{ "ParcelCode": "100018322-2", "Products": [{ "ProductCode": "product-A", "DeliveryQuantity": 1 }] }] } ``` **Closing Cancel** (last cannot be dispatched) 1 product-C cancel ```json theme={null} { "OrderId": "100018322", "Parcels": [], "Exceptions": [{ "ProductCode": "product-C", "ExceptionType": 1 }] } ``` ### Non-Global-e Carriers – Recording Parcel Tracking ```json theme={null} { "OrderId": "100018322", "IsCompleted": true, "Parcels": [{ "ParcelCode": "123454321", "Products": [{ "DeliveryQuantity": 1, "ProductCode": "121212" }], "TrackingDetails": { "TrackingNumber": "1111111166", "TrackingURL": "https://trackingurlofshipper.com", "ShipperName": "MyCarrier" } }], "Exceptions": null } ``` # Documents Source: https://docs.global-e.com/documents ## General Rules * Documents are generated per parcel * The legal entity on each document reflects the parcel’s fulfillment hub ## Document Types * Commercial Invoice and Customer Receipt are generated for cross-border shipments outside the EU * VAT Invoice is generated for domestic shipments and shipments within the EU ## Limitations * E-invoicing is not supported for Mixed Orders * Intra-EU shipments with a non-Global-e carrier must be excluded using country-level configuration * Drawback is not supported for Mixed Orders # Duties and Country Tax Regulations Source: https://docs.global-e.com/duties-and-country-tax-regulations Global‑e can collect and pay taxes on behalf of your company for certain countries or regions depending on where your entity is registered. Each country or region has a different VAT or GST rate and duty thresholds. Global‑e will be able to collect and pay duties depending on certain thresholds. The following specifies each country or region's VAT/GST rates and duty thresholds and whether Global e can collect and pay them on your behalf. **Australia** * 10% GST on every order * Duties, Import fee, and CCF above 1000 AUD * Orders below 1000 AUD taxes are paid directly by Global‑e to the local authorities. For orders above 1000 AUD, the courier is responsible to pay the D\&T. **New Zealand** * 15% GST on every order * Duties, Import fee, and CCF above 1000 NZD * Orders below 1000 NZD are paid directly by Global‑e to the local authorities. For orders above 1000 NZD, the courier is responsible to pay the D\&T. **United Kingdom** * 20% VAT on every order * Duties and CCF above 135 GBP * Orders below 135 GBP are paid directly by Global‑e to the local authorities. For orders above 135 GBP, the courier is responsible to pay the D\&T. **Switzerland** * 7% VAT on every order * Duties and CCF above 65 CHF * Taxes on all orders are paid directly by Global‑e to the local authorities * Shipments are sent as DDU, even above the duties threshold of 65 CHF * The VAT registration number appears also on the commercial invoice **Norway** * 25% VAT on every order * Duties and CCF above 3000 NOK based only on one item * Orders with all products below 3000 NOK are paid directly by Global‑e to the local authorities. For orders above 3000 NOK, the courier is responsible to pay the D\&T. **EU (all EU countries)** * VAT on every order (based on shipping country) * Duties above 150 EUR * Orders below\equal 150 EUR paid by Global‑e to the local authorities. For orders above 150EUR, the courier is responsible to pay the D\&T. **Countries from which Global e collects taxes and pays to the local authorities** | Merchant Country | Destination Country | Tax Collected By Global‑e | Start Date | | - | - | - | - | | UK | Australia | Yes | 01/11/2019 | | US | Australia | Yes | 01/11/2019 | | FR | Australia | Yes | 01/11/2019 | | NL | Australia | Yes | 20/03/2020 | | ES | Australia | Yes | 01/01/2021 | | IL | Australia | No | – | | UK | New Zealand | Yes | 01/12/2019 | | US | New Zealand | Yes | 01/12/2019 | | FR | New Zealand | Yes | 01/05/2020 | | NL | New Zealand | Yes | 01/05/2020 | | ES | New Zealand | No | 01/10/2021 | | AU | New Zealand | Yes | 01/07/2021 | | CH | New Zealand | Yes | 01/09/2021 | | IL | New Zealand | No | – | | UK | Switzerland | Yes | 01/12/2019 | | US | Switzerland | Yes | 01/05/2020 | | FR | Switzerland | Yes | 01/05/2020 | | NL | Switzerland | Yes | 01/05/2020 | | IL | Switzerland | No | – | | UK | Norway | Yes | 01/05/2020 | | US | Norway | Yes | 01/05/2020 | | FR | Norway | Yes | 01/05/2020 | | NL | Norway | Yes | 01/05/2020 | | IL | Norway | Yes | 01/05/2020 | | ES | Norway | Yes | 01/05/2020 | | CA | Norway | Yes | 01/09/2021 | | CH | Norway | No | 01/08/2021 | | US | United Kingdom | Yes | 01/01/2021 | | FR | United Kingdom | Yes | 01/01/2021 | | NL | United Kingdom | Yes | 01/01/2021 | | IL | United Kingdom | Yes | 01/01/2021 | | ES | United Kingdom | Yes | 01/01/2021 | | CA | United Kingdom | Yes | 01/01/2021 | | CA | EU | Yes | 01/07/2021 | | US | EU | Yes | 01/07/2021 | | UK | EU | Yes | 01/07/2010 | **US Sales Tax Collected by Global-e** | Merchant Country | US Sales Tax | Start Date | | - | - | - | | UK | Yes | 01/01/2020 | | FR | Yes | 01/09/2020 | | NL | Yes | 01/05/2020 | | IL | No | – | | ES | No | – | | US | No | 01/07/2021 | # Duties and Taxes Source: https://docs.global-e.com/duties-and-taxes ## Calculation Principles 1. Duties and taxes at checkout are calculated based on initial product allocation to hubs 2. For domestic shipments (within the US or Canada), Shopify calculates domestic taxes which are combined with Global-e cross-border D\&T (if applicable) 3. Duties and taxes are calculated per parcel based on parcel hub and destination country: * Threshold calculations are based on parcel value (not order value) * If final D\&T exceeds the amount paid at checkout, the difference is absorbed as a merchant subsidy 4. If a refund is issued before fulfillment is completed, the D\&T will be refunded based on the D\&T paid for the product at checkout. ## How Shipping Cost Is Calculated ## Overview Many Shopify merchants use multiple shipping profiles or hubs. Shopify’s carrier-service API sends one request per hub, each containing only part of the cart, which leads to duplicate shipping charges, incorrect free-shipping threshold evaluations, and inconsistent promotions. This feature introduces a consolidated shipping-cost engine. At checkout start, a new ingestion API captures the full cart data (items, quantities, discounts, addresses). The shipping domain computes the total cost once, caches it, and returns delta-based responses so shoppers only pay the highest cost. The solution supports fallback to existing behaviour when data isn’t available, allows merchants to opt into split-shipping, and improves the checkout experience for mixed-hub orders, benefitting both merchants and Global-e. ## Business Process The following shows the business process: 1. **Checkout start**: The client triggers a SaveShopifyCheckoutData API call (via webhooks, analytics, or UI extension) that sends the full cart context (items, quantities, discounts, addresses, locale, currency, token). 2. **Data ingestion & storage**: Platform stores this snapshot in Couchbase/ValKey using the checkout token and merchant ID as keys. 3. **Carrier-service calls**: Shopify calls the carrier service in parallel per hub/profile. 4. **Split-shipping option**: If merchant opts for split shipping, skip consolidation and return individual hub costs. 5. **Fallback**: If no cached checkout data is found (cache miss), perform the current per-hub shipping calculation (“as today”) to avoid blocking checkout. 6. **Duties & Taxes**: The service reads the consolidated shipping cost from cache to compute duties and taxes consistently across hubs. ## Prerequisites & Dependencies The following list shows the prerequisites and dependencies: * Shopify checkout integration to trigger the ingestion API. * Couchbase/ValKey storage layer with an atomic “first call” claim logic. * Merchant configuration to align shipping service levels across hubs. ## Relevant Platforms and Shippers/Carriers The relevant platforms include Shopify, but may be extended to other platforms in the future. The relevant shippers/carriers include Global-e shipping services, and integration with the Duties & Taxes domain. ## Edge Cases and Limitations If the ingestion API isn’t called before carrier-service calls (e.g., headless checkout or network failures), consolidation falls back to standard per-hub calculations. ## Feature KPIs The following list shows the feature KPIs: * Percentage reduction in duplicate shipping charges for mixed-order merchants. * Free-shipping thresholds evaluated at checkout level rather than per hub. * Consolidated shipping-cost accuracy (is greater or equal to 95% of calls return single cost). * Response time: 99% of consolidated shipping calls is less than 500 ms. * Fallback hit rate is less thsn 5%. ## FAQ and Common Questions * **Can this work with X platform?** The initial implementation is for Shopify. Support for other platforms (Global-e Module, Magento, SFCC, BigCommerce) may be considered after the Shopify rollout. * **Will it impact existing customers?** Regular (single-hub) orders will not be affected, and shipping costs are calculated as today. For mixed-order merchants, the feature consolidates costs to avoid duplicates; merchants can opt out via configuration. * **What happens if checkout data is missing?** If the ingestion API isn’t called or cache lookup fails, the system falls back to the existing per-hub calculation to avoid blocking checkout, and the event is logged. * **Can merchants opt to charge shipping separately?** Yes. Merchants can choose split-shipping mode via configuration, which disables consolidation. # Duties and Taxes on the Checkout Page Source: https://docs.global-e.com/duties-and-taxes-on-the-checkout-page Global-e calculates the duties and taxes due for each relevant order. If there is an option to pay them in advance, it displays them to the customer on the checkout page. Paying in advance guarantees no additional costs on delivery. The option of charging the D\&T depends on the Merchant. * **DDP** (Delivered Duty Paid) - Import D\&T is handled, guaranteed, and paid at the point of sale (i.e. checkout). No additional charges apply to the customer on receiving the parcel. * **DDU** (Delivered Duty Unpaid) - Import D\&T is not paid for before arriving in the destination country. It is paid by the customer when the products arrive at the destination. * **Hidden Force DDP** (HFDDP) - A method in which the D\&T is hidden in the product price. The Merchant can uplift the product prices using the Country Price Coefficient to cover the D\&T, taking into consideration the Country threshold and D\&T Rates. From the buyer's point of view, the product price includes D\&T – so it is a DDP order. * **Partial Force DDP** (PFDDP) - Either the duties or taxes are included in the total price displayed on the checkout page. The shipper is notified if the parcel is DDP or DDU, as an indication of who should be charged. In the reconciliation between Global-e and the Merchant, the D\&T charges are applied to the Merchant. ## Hidden Force DDP A Hidden Force DDP means that the duties and taxes (D\&T) are hidden in the product price. From the buyer's point of view, the product price includes D\&T, making it a DDP order. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-0fc65043-6472-a019-735f-167057857165.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=05d2cdf210826a4cb88c3c9f930fe1f9) In the above example, the \$1,049.00 subtotal is the price the international shopper sees on the Merchant’s site before checkout. Merchants can uplift the product price using the Country Price Coefficient to cover for the D\&T (taking into consideration Country threshold and D\&T Rates). In the reconciliation between Global-e and the Merchant, the D\&T is charged to the Merchant. ## Partial Hidden Force DDP In a Partial Hidden Force DDP (Partial HFDDP) either the duties are hidden in the product price and the taxes are added in the checkout **-OR-** The taxes are hidden in the product price and the duties are added in the checkout. When a Merchant uplifts the product price (by using the Country Price Coefficient), they should consider the rate of the hidden component. Example of hidden tax: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-0df01045-7f50-147b-2375-e2c8552c50b0.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=ca85369904a3b20500580987b69a4010) Example of hidden duty: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-31f72362-5276-8af4-3cf4-59dd59c2237a.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=30d5f50d4872ad4f9c9ea75cb9c08a4b) # Duties and Taxes Process Source: https://docs.global-e.com/duties-and-taxes-process-eu Below are examples of the financial process that takes place between European Merchants and both European and Non-European customers, **Example: Intra-EU “distance selling” to Germany (VAT = 19%)** EU Merchant – EU Customer * Product price in Europe = €121 (€100 + 21% VAT) - exported into the EU (Germany) * Shipping cost €10 , charged to customer €5 (shipping subsidy €5) ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-6409f528-76fb-dbc4-1113-5ab0fe0f910f.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=c1a1ffc4b29b374ac1bdc954ce2f94dc) Net product sale for Merchant: €100 Net after shipping subsidy: €95 **Example: Deduct Dutch VAT outside the EU** Dutch Merchant – Non-EU Customer * Product price in Europe = €121 (€100 + 21% VAT) - exported out of the EU * Shipping cost €10 , charged to customer €5 (shipping subsidy €5) ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f5eaac23-0f1c-f183-e774-71de74ee6d67.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=6e146ff364e259c5cae46c24d8c28934) Net product sale for Merchant: €100 Net after shipping subsidy: €95 > [!NOTE] > > While the sale is a domestic sale between two Dutch entities, since the final destination of the goods is outside of the EU, a VAT exemption applies. **Example: “Pocket” VAT outside the EU** Dutch Merchant – Non-EU Customer * Product price in Europe = €121 (€100 + 21% VAT) - exported out of the EU * Shipping cost €10 , charged to customer €5 (shipping subsidy €5) ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2e11b16d-9d1b-174e-1bf4-ffb0fe0cd265.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=56126266cd69389665494fecb3556c6b) Net product sale for Merchant: €121 Net after shipping subsidy: €116 > [!NOTE] > > While the sale is a domestic sale between two Dutch entities, since the final destination of the goods is outside of the EU, a VAT exemption applies. # Duties and Taxes Process Source: https://docs.global-e.com/duties-and-taxes-process-uk Merchants can choose between two methods of collecting duties and taxes from customers: * **Optional/Forced DDP**: Customers pre-pay duties and taxes at checkout, which are passed by Global-e to the Merchant, and in most cases, passed on to their shipper. However, in some countries, like the US, Global‑e will retain and remit these to the authorities directly. * **Hidden Forced DDP**: Duties and taxes are built into the amount paid by the end customer. For most countries, Global‑e will pass the full value of the product to the Merchant, including the duties and taxes intended for the shipper. In some countries like Australia, Global‑e will retain and remit these taxes directly to the authorities. Below are two examples of the financial process that takes place when a non-UK customer purchases from a British Merchant. **Example: Optional/Forced DDP for Duties & Taxes** British Merchant - Non-UK Customer * Product price in the UK = £120 (£100 + 20% VAT) - exported out of the UK * Shipping cost £10, charged to customer £5 (shipping subsidy £5) ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3ddb0989-4bb8-84d9-964f-d21eb5b2616c.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=bc040cef60c4fc8f85183464e725ab45) Net product sale for the Merchant: £100 Net after shipping subsidy: £95 **Example: Hidden Forced DDP for Duties & Taxes** British Merchant - Non-UK Customer * Product price in the UK = £120 (£100 + 20% VAT) - exported out of the UK * Shipping cost £10, charged to customer £5 (shipping subsidy £5) ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-15f1da98-bc36-604b-1c5a-90cd245dab71.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=7d3eb5a9fd106f4dbeba81196232c297) Net product sale for the merchant: £120 Net after shipping subsidy: £105 # Duties, Taxes, and Regulations Source: https://docs.global-e.com/duties-taxes-and-regulations When shipping goods internationally, it is important to consider the effect of duties, taxes, and other clearance charges. Clearance charges could significantly impact the total shipment cost depending on the shipment content and the destination country. Calculating and communicating the landed cost up-front can save you and your customers valuable time, money, and effort. Global-e will calculate the duties and taxes applicable to each order and present the relevant options to the customer on the checkout page. A shipment’s duty and tax amount is based on the following parameters: * Product value * Trade agreements * Country of manufacture * Description and end use of the product * The product’s Harmonized System (HS) code * Country-specific regulations For EU merchants, distance selling regulations will apply to all transactions within the EU. This means that no duties are applied, however, the seller must collect the local taxes. **In this section:** * [What are Duties and Taxes?](/what-are-duties-and-taxes-) * [Shipping Costs](/shipping-costs) * [Custom Clearance Fee](/custom-clearance-fee) * [Duties and Taxes on the Checkout Page](/duties-and-taxes-on-the-checkout-page) * [VAT Calculation](/vat-calculation) * [Duties and Country Tax Regulations](/duties-and-taxes-on-the-checkout-page) * [Country of Origin certificate for UK Manufactured Products](/country-of-origin-certificate-for-uk-manufactured-products) * [GST in Australia](/gst-in-australia) * [Q\&A Duties, Taxes, Distance Selling](/q-a-duties-taxes-distance-selling) # eCommerce Integration Source: https://docs.global-e.com/ecommerce-integration Global‑e provides support across a wide array of vendor platforms pre-built extensions as well as API-based integration capabilities to allow our services to be used for all brands. This integration covers all localisation aspects during customer browsing and checkout using merchant-specific configurations, including currency exchange rates, country coefficients, and rounding rules. The list of serviced countries benefits automatically from Global-e capabilities through a unique integration. Domestic users continue to interact with the original merchant’s site, as do customers from countries that are not operated by Global‑e. On top of pricing and checkout management, the Global‑e integration also provides UX functionalities, such as displaying the Global‑e Country Switcher when the user wishes to change the shipping destination country and/or the currency used for browsing and interacting with the webstore. # Edit Orders Source: https://docs.global-e.com/edit-order Change an existing Global-e order by adding, exchanging, or removing products. ## Overview The Edit Order API lets you change an order. The API has two separate URLs with an identical structure. The **quote** URL returns the updated order content and prices without changing the order. To apply the changes, call the **editing** URL with the same request. > [!NOTE] > > This API does not apply to Shopify. ## Prerequisites * The order must be in the **"Received by Global-e"** status. Orders can be edited only when they are in this status. ## How order editing works The following assumptions apply: * Editing an order to a **lower** value is possible if the payment has not been captured yet. * Editing an order to a **higher** value is allowed only if the merchant is willing to subsidize the difference between the original and the adjusted order value. The end customer is not charged for any additional cost. Set `SubsidizeHigherValue` to `1` on the edit request to subsidize the difference; if the new value is higher and `SubsidizeHigherValue` is `0`, null, or empty, the editing request fails. * The edit request must contain new items — new additional products or exchanging current ones. The API cannot be used to only remove items from an order. The edit is not obligated to be identical to the quote total price. It is advised to call the edit request immediately following an approval of a quote. > [card] [Edit order — full request & response](/api-reference/edit-order) > > Parameters, the `OrderChangeRequest` schema, the `Merchant.Order` response, examples, and the > interactive playground for `POST /api/orders/changes`. > [card] [Quote order changes](/api-reference/edit-order-quote) > > Preview the updated order content and prices without applying the change — > `POST /api/orders/changes/quote`. ## Use Cases ### Exchange a product in an order Remove a line item and add its replacement in a single request. Reference the removed item's `CartItemId` from the new product's `ReplacementOfCartItemId`. First call the **quote** endpoint to preview the updated order and prices: ```json theme={null} { "OrderId": "GE379858112TS", "RemovedProducts": [ { "CartItemId": "1", "Quantity": 1 } ], "NewProducts": [ { "ProductCode": "750518703039M", "CartItemId": "2", "OrderedQuantity": 1, "OriginalSalePrice": 125.12, "ReplacementOfCartItemId": "1" } ], "SubsidizeHigherValue": 0 // enum No = 0, Yes = 1 } ``` The response is a `Merchant.Order` object with the updated content and prices: ```json theme={null} { "OrderId": "GE379858112TS", "CurrencyCode": "GBP", "Products": [ { "Sku": "750518703039M", "CartItemId": "2", "ParentCartItemId": null, "Quantity": 1, "Price": 125.12, "InternationalPrice": 160, "DiscountedPrice": 125.12, "InternationalDiscountedPrice": 160 } ], "Discounts": [ { "Name": "Hidden DDP", "Description": "Discount generated to discount the DDP", "Price": 8, "InternationalPrice": 10.00, "ProductCartItemId": null } ], "TotalDutiesAndTaxesPrice": 79.83, "USSalesTax": 0.00, "CCFPrice": 12.40, "TotalDutiesPaidByCustomerPrice": 0.00, "InternationalDetails": { "CurrencyCode": "EUR", "TotalPrice": 160.00, "TransactionCurrencyCode": "EUR", "TransactionTotalPrice": 160.00, "TotalShippingPrice": 0.00, "TotalCCFPrice": 14.79, "TotalDutiesPrice": 0.00, "USSalesTax": 0.00, "DutiesGuaranteed": true, "ConsignmentFee": 0.0000, "DiscountedShippingPrice": 0.00 } } ``` To apply the change, send the same request to the [Edit order](/api-reference/edit-order) endpoint (`POST /api/orders/changes`). # Editing Email Notification Texts Source: https://docs.global-e.com/editing-email-notification-texts You can edit email notification texts displayed in the various email notifications your customers receive. ## To edit the texts displayed in the various email notifications your customers receive: 1. Navigate to *Settings > Emails > Content*. 2. Click **TRANSLATE RETURNS EMAILS** or **TRANSLATE ORDER TRACKING EMAILS** to edit the relevant notification type. 3. Click the pencil icon corresponding to the language you want to edit. 4. Open the relevant email notification to edit its content. 5. Edit the content in each field. 6. Use the Hint for each field to see exactly which part of the email notification it refers to. 7. Click **SAVE** at the bottom of the page to save your changes. # Editing Email Notification Texts Source: https://docs.global-e.com/editing-email-notification-texts-701339 You can edit email notification texts displayed in the various email notifications your customers receive. ## To edit the texts displayed in the various email notifications your customers receive: 1. Navigate to *Settings > Emails > Content*. 2. Click **TRANSLATE RETURNS EMAILS** or **TRANSLATE ORDER TRACKING EMAILS** to edit the relevant notification type. 3. Click the pencil icon corresponding to the language you want to edit. 4. Open the relevant email notification to edit its content. 5. Edit the content in each field. 6. Use the Hint for each field to see exactly which part of the email notification it refers to. 7. Click **SAVE** at the bottom of the page to save your changes. # Email Management Source: https://docs.global-e.com/email-management-configuration When an order reaches a specific status, Global-e automatically sends a localized email to your customer. The Global‑e Email Management tool lets you modify the content of this email, customize the look and feel, add custom text, and provide your own translation. In addition, you can preview your email configuration settings both on desktop and mobile and test your settings before submitting (publishing) your final template to Global‑e. Before configuring your email template, see the following: * [Prerequisites](/email-management-transactional-emails#prerequisites) * [Legal Statement](/email-management-transactional-emails#legal-statement) ## Prerequisites > [!WARNING] > > **For optimal use of the Email Management tool, a basic understanding of HTML and familiarity with HTML structure and CSS styling concepts are required.** ## To use the Email Management tool: * Verify the Email Management feature is enabled. * Verify you have one of the following roles in the Merchant Portal for configuring emails: * Global Merchant Admin with the default Merchant Admin username and password * Merchant Emails Operator with the default Merchant Email Operator username and password. Contact your Success Manager if you cannot access the Merchant Portal or do not have permission. * Manage your HTML content: * The Merchant owns the HTML for creating email. * Translation of the texts to other languages is handled by the Merchant. * Familiarity with the Mustache Templating Specification and Language is required. For more information, see [https://mustache.github.io/mustache.5.html](https://mustache.github.io/mustache.5.html). ## Legal Statement The following legal statement must be included in the email description paragraph (in all languages): Your order will be processed by Global-e as a merchant of record for this transaction. | [Click here to download the legal statement](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/Other+Resources/Email+-+Legal+Dieclaimer.xlsx) | | - | | | ## Create your Email Template and Text Resources **Before getting started:** 1. Create your email HTML template. Make sure to include all the default text resources and placeholders. For more information, see: [Create your HTML Template](/email-management-transactional-emails#create-your-html-template) [TextResource Excel Format and Example](/email-management-transactional-emails#textresources-excel) [Placeholders](/email-management-transactional-emails#placeholders). 2. Create your Text Resources Excel file, as detailed in: [Create your Text Resources File](/email-management-transactional-emails#create-your-text-resources-file) [TextResource Excel Format and Example](/email-management-transactional-emails#textresources-excel) [Placeholders](/email-management-transactional-emails#placeholders). ## Manage your Emails This procedure assumes that you have already created your HTML template and Text Resources. **To manage your emails:** 1. Log in to the Global‑e Merchant Portal. 2. Navigate to **Configuration > Email Management**. The Email Management screen opens. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1b1a5f22-adb1-0d76-1b43-2faed3fc7475.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=ab8089e0b7d7a5af5a156673f64b52cd) 3. Set up and manage your email template, as detailed in the screen capture above and in the following table. | | Step | For more information | | - | - | - | | Step 1 | Select the **Email Type** you wish to customize from the drop-down menu. | [\[1\] Email Type](/email-management-transactional-emails#1-email-type) | | Step 2 | **Upload the HTML template you have created:** Click **Upload New** and select your HTML file. | [\[2\] HTML Template](/email-management-transactional-emails#2-html-template) | | Step 3 | **Upload the new Text Resources:** Click **Upload New** and select your Text Resources file (Excel). | [\[3\] Text Resources](/email-management-transactional-emails#3-text-resources)[TextResources (Excel)](/email-management-transactional-emails#textresources-excel) | | Step 4 | **Preview your draft template in the preview area:** Click **Save Changes**. (Make sure you are in draft mode).Note that, when switching from Draft mode to Publish mode, the **Save Changes** button switches to a **Publish** button \[8]. | [\[4\] Save your Template and Preview your Changes](/email-management-transactional-emails#4-save-your-template-and-preview-your-changes) | | Step 5 | **Preview your email language:** Select the desired language from the drop-down menu. | [\[5\] Preview the Language](/email-management-transactional-emails#5-preview-the-language) | | Step 6 | **Preview an order as part of your email template:** Enter the order ID | [\[6\] Preview an Order](/email-management-transactional-emails#6-preview-an-order) | | Step 7 | **Test your Draft or Publish template before publishing it to Global‑e:** Click **Send Test** and fill out the Send Test email form.- OR –Select **Send** for a quick send (if you have already filled out the form). | [\[7\] Test your Setup - Send a Test Email](/email-management-transactional-emails#7-test-your-setup---send-a-test-email) | | Step 8 | **Publish your changes:** Select the **Publish** mode and click **Publish Changes**. | [\[8\] Publish your Changes](/email-management-transactional-emails#8-publish-your-changes) | | Optional | **Unpublish your changes** | [Revert your Published Changes (Optional)](/email-management-transactional-emails#revert-your-published-changes-optional) | ### \[1] Email Type Select the **Email Type** you wish to customize from the drop-down menu. See the list of email types here, [Global‑e Default HTML Template.](/email-management-transactional-emails#global‑e-default-html-template) All email transactions are supported. ### \[2] HTML Template This section provides instructions on how to create or modify your HTML template. ### Create your HTML Template **To create your HTML template:** 1. Write the content and design your HTML template using a tool of your choice. > [!NOTE] > > **[Click here to view and save an example of the HTML template](https://www.global-e.com/wp-content/uploads/2023/11/Template.html)** 2. Add all the mandatory text resources at the correct location, as defined in the [TextResources](/email-management-transactional-emails#textresources-excel) file. 3. When done, click **Upload New** to upload your HTML template. 4. Click **Upload New** to upload the text resources file have created (see [Create your Text Resources File](/email-management-transactional-emails#create-your-text-resources-file) [Create your Text Resources File](/email-management-transactional-emails#create-your-text-resources-file)). 5. Click **Save Changes** and preview your draft. Example: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-0ba01672-6449-2777-41af-08e4d3fafd5d.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=082087535a76a65d966e87aafa170bc4) ### Modify your HTML Template **To modify your HTML Template:** 1. Click **Download Current** HTML template. 2. Modify the HTML text using a tool of your choice. Note that if you modify the HTML text and you do not include that new text with its translation in the text resources file, the text will not be translated. 3. Make sure you have included all the mandatory text resources at the correct location, as defined in the [TextResources](/email-management-transactional-emails#textresources-excel) file. 4. Save your file as HTML. 5. When done, click **Upload New** to upload your HTML template. ### \[3] Text Resources TextResources are the strings that are included in the placeholders within your email template. They are displayed in curly brackets. When you create or modify text resources in your email template, make sure that all mandatory text resources are included in your email and formatted correctly. ### Create your Text Resources File **To create your Text Resources file:** 1. Create your text resources file by using the format and example [TextResources](/email-management-transactional-emails#textresources-excel) file. 2. Make sure to add all the mandatory text resources as defined in the [TextResources](/email-management-transactional-emails#textresources-excel) file. > [!WARNING] > > By default, you must define the language of all text resources in English. > > In the text resources file, the column "English - United Kingdom" must always contain text in English. This text is used as a basis for the translation to other languages. 3. Save your file as Excel. 4. When done, click **Upload New** to upload your TextResources file. 5. Click **Save Changes**. After uploading your text resources, if you have included the text resources in your HTML Template (see [\[2\] HTML Template](/email-management-transactional-emails#2-html-template),) you can preview your email with the placeholders of the text resources. Example: ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-6f816a71-9619-edbd-5652-4a5fc25d979f.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=a16e066a4598329bacdec2d5b4cb948a) ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ebdbabc9-b214-6576-de24-f67e00d3c5ae.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=85e7f700b680b000157492b34915dc08) See: [Placeholders](/email-management-transactional-emails#placeholders) for the list of supported placeholders. [Preview an Order](/email-management-transactional-emails#6-preview-an-order) to view how the template with the placeholders converts to actual data. ### Modify Text Resources This section assumes that you have previously uploaded your text resources file. See [Create your Email Template and Text Resources](/email-management-transactional-emails#create-your-email-template-and-text-resources). > [!WARNING] > > By default, the language of all text resources is set to English United Kingdom. In the text resources file, the column **English - United Kingdom** must always contain text in English. This text is used as a basis for the translation to other languages. **To modify a Text Resource:** 1. Click **Download Current** text resources file. 2. To modify English Text Resources, modify the text in the column **English – United Kingdom**. 3. To modify Text Resources in Other Languages: 1. Translate the TextResource you have modified under the column **English - United Kingdom** to the target language. 2. Add the translation of each text resource in the corresponding language column and row (cell). 4. Click **Upload New** to upload your file. ### Add a New Text Resource > [!WARNING] > > By default, the language of all text resources is set to English United Kingdom. In the text resources file, the column **English - United Kingdom** must always contain text in English. This text is used as a basis for the translation to other languages. **To add new Text Resources:** 1. In your HTML template, add the new text resource at the correct location. For example: `{{TR_NewSaltutation}}` 2. In your TextResources Excel: 1. Add a new row for the new text resource. 2. Mandatory: Add a description in the column **English – United Kingdom**. **Note:** English UK must be filled as it is used as the basis for translations. 3. To add Other Languages: 1. Make sure you have added a column for the target language. 2. Translate the text you have added under the **English - United Kingdom** column to the target language. 3. Add the translation of each text resource in the corresponding language column and row (cell). 4. When done, click **Upload New** to upload your TextResources file. 3. HTML template: 1. Make sure you have added all the required TextResources in your HTML template. 2. When done, click **Upload New** to upload your HTML template. ### Remove a Text Resource To remove a text resource, **you must remove the resource from both**: * The HTML template * The TextResource Excel ### \[4] Save your Template and Preview your Changes **To save your template and preview your changes:** 1. Select **Draft** or **Publish** mode, as required. 2. When you are satisfied with your modifications, click **Save Changes**. and preview your changes. 3. If you are in draft mode, you can edit the draft at a later stage. 4. Optional: Click **Discard Changes** if you do not wish to save your changes. Example: ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-90892817-ea71-dba7-7f80-c657cb3360ba.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=99874dabdcf7b7ccbc937731cbdbf49a) ### \[5] Preview the Language **To preview the language:** 1. Select **Draft** or **Publish** mode, as required. 2. Select the language you wish to preview. **Notes:** * You must have translated the text in the TextResources Excel file for the text to be displayed in the selected language. * Static text is text that has not been defined as a Text Resource. Static text is not translated or modified. If you have included static text in your HTML template and you wish to translate it, you must first define it as a text resource in the [TextResources (Excel)](/email-management-transactional-emails#textresources-excel), provide the translation, and upload your modified text resource. * You can modify the Sender and the Subject line in the text resources. Example: In this example, the email was translated into Spanish, but "Dear First Name" has not been translated since it is static text, and the translation was not defined in the TextResources file. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5b02e3ad-859f-a8aa-4eb0-01fb26d4b77e.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=1b01f2480a90089a292bb3278aa6fd6f) ### \[6] Preview an Order **To preview an order:** 1. Select **Draft** or **Publish** mode, as required. 2. In **Preview an Order**, enter the order ID or the Merchant ID. 3. Select **Show Order Values in the device previews**. This option toggles the preview between the placeholders and the real data. When selecting this option, the preview area shows the template with the data taken from the real order. The placeholders in the template are converted to actual data. Example: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1848fc35-ab33-39bb-9d77-93be82948dd4.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=a81c64c65f9c461e75b01aa2330ac592) ### \[7] Test your Setup - Send a Test Email **To test your setup:** ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d0c05b1d-c9c2-e9c9-fa0c-288b4de4af07.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=25cf3477234c2ab5debaa722a9b76f93) 1. Click **Send Test**. The Send test email box opens. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f290e4b8-ba59-f788-9ace-ac4488019a69.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=6db09e00e71b69576b04e040eb7282ea) 2. In the Send test email box: 1. Enter the Order ID. 2. Select the Email Type. 3. Select the language. 4. Select the Version: Draft or Publish 5. Enter the email address to which the test should be sent. 3. Click **Send**. A confirmation message is displayed. 4. Open the email and review it. **To perform a "quick send":** If your email management screen already contains the above information, click the down arrow and select **Send To**. A confirmation message is displayed and by default, the email test is sent to you (the logged-in user's email address). ### \[8] Publish your Changes When you are satisfied with the results, you can publish your changes. * Click **Publish** to submit your final changes to Global‑e. A confirmation message is displayed. Your published template is uploaded to the Global-e system. This is the email template that Global-e will be using for your email templates from now on. > [!NOTE] > > Clicking **Publish** uploads the final email template (HTML) to the Global‑e Production whereas **Save Changes** saves your draft for further editing. ### Revert your Published Changes (Optional) After publishing, you can click **Unpublish** to revert to the default Global‑e template. ## Using Custom Fonts Follow these guidelines when using non-standard fonts in your emails. * **Use Web-Safe Fonts as Fallbacks** * Always specify a web-safe font as a fallback in case the custom font does not load. * Common web-safe fonts include Arial, Verdana, Georgia, and Times New Roman. * **Host Fonts Appropriately** * Host the fonts on a reliable server or use a service like Google Fonts or Adobe Fonts. * Ensure that the font files are compressed (e.g., WOFF or WOFF2 format) to minimize loading time. * **Use Inline CSS for Font Integration** * Apply custom fonts using inline CSS within the \

This is custom font text.

``` * **Test Across Multiple Email Clients** * Different email clients render fonts differently. Test emails across popular clients to ensure the custom font displays. * Pay attention to mobile clients as well. * **Limit the Use of Custom Fonts** * Use custom fonts sparingly, reserving them for headers or branding elements. * For longer bodies of text, use standard web-safe fonts. * **Consider Email Load Times** * Custom fonts can increase the size of the email, which might affect load times. Ensure the font files are as small as possible. * Keep the total email size under 102KB to avoid clipping in some email clients. * **Ensure Legal Compliance** * Verify that you have the correct licensing to use and distribute the font in emails. * **Monitor Email Deliverability** * Custom fonts can sometimes cause deliverability issues. Monitor open rates, click rates, and spam reports. * **Fallback on System Fonts in Case of Issues** * If any issues arise, be prepared to revert to system fonts to ensure the email remains functional. ## Moving from Testing Environment to Production When you are ready to move to Production, follow these steps for each email type: 1. In the **Testing environment,** download the current HTML and the current text resources file. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9a2dd4fc-c1ff-0d76-21f6-8fe704b2fa7a.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=373778767566d5150e9f2831f4bbeacd) Download Current HTML ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7b77b85f-b3cb-4627-b536-07feaffad0f7.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=24c7559cfa7702328ed15204aa8e78f4) Download the current text resources file 2. In the **Production environment**, select the relevant email type (e.g. Order Confirmed). 3. Upload the HTML downloaded in step #1. 4. Upload the text resources file downloaded in step #2. 5. Click **Save Changes**. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7451b761-b2e1-6c5f-f205-3190a8916c41.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=f1cb0b22f8b8d5f01ceb1fa3b59c3108) 6. Preview and Test. 7. Click **Publish**. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f7858c9d-9d45-7176-2974-956a93ceaf84.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=283ccae74cebdd08c0a105c5190905b9) ## Placeholders The Global‑e templates are based on the Mustache templating specification and language. For more information on Mustache, see [https://mustache.github.io/mustache.5.html](https://mustache.github.io/mustache.5.html). Mustache serves as a powerful templating system that enables the utilization of pre-existing text files containing designated placeholders. These placeholders are dynamically substituted with values specific to a particular request during runtime. Global‑e supports two types of placeholders that you can use in the HTML template: * Placeholders related to Orders, such as the order ID, shipping address, totals, products, and more. * Custom placeholders to manage Text Resources, which can hold texts, translations, links, and html snippets for the header, footer, and CSS. ### Custom Placeholders Custom placeholders often start with the prefix `TR_` to differentiate between order placeholders and resource placeholders. However, this convention is not mandatory. Example: `TR_Salutation` **To add, create and upload custom placeholders:** 1. Include your custom placeholder values in your text resource file as keys (without `{}`). 2. Include the custom placeholders' unique key \{`TR_Salutation`} in your HTML template. **Required Placeholders** `Subject` `SenderName` `SenderEmail` **Variations** `[CountryName].SenderName` `[CountryName].SenderEmail` > [!NOTE] > > CountryName is a 2-letter country code. For example, use US for USA. ### Available Placeholders This section provides a list of placeholder tags and examples. ### Customer The following placeholders are supported in all email types. * `{{FirstName}}` * `{{LastName}}` * `{{FullName}}` - the recipient's first name and last name * `{{Email}}` - the recipient's email address Usage: ```
Dear {{FirstName}}
Hello {{FullName}}
Dear {{LastName}}
Your email address: {{Email}}
``` ### Order The following placeholders are supported in all email types. * `{{OrderReceiveDate}}` * `{{OrderTrackingNumber}}` * `{{OrderId}}` * `{{MerchantOrderId}}` * `{{MerchantInternalOrderId}}` * `{{OrderConfirmedDate}}` Usage: ```
We have received your order on {{OrderReceiveDate}}.
Your tracking number is {{OrderTrackingNumber}}
Your order id is {{OrderId}}
Your merchant order id is {{MerchantOrderId}}
Your merchant internal order id is {{MerchantInternalOrderId}}
Your order has been confirmed on {{OrderConfirmedDate}}
``` ### Merchant The following placeholders are supported in all email types. * `{{CustomerSupportEmail}}` * `{{MerchantName}}` * `{{MerchantStatementName}}` ### Shipping The following placeholders are supported in all email types. * `{{ShipFullName}}` * `{{ShipFirstName}}` * `{{ShipAddress}}` * `{{ShipAddress2}}` * `{{Company}}` * `{{ShipState}}` * `{{ShipCity}}` * `{{ShipZip}}` * `{{ShipPhone}}` * `{{ShipCityRegion}}` * `{{ShipCompanyName}}` * `{{ShipCountry}}` * `{{ShippingMethodName}}` * `{{ShippingService}}` * `{{CarrierName}}` * `{{ShipVatRegistrationNumber}}` * `{{ShippedTo}}` > [!NOTE] > > `ShippedTo` is a 2-letter `CountryCode`. For example, IL, TW, U.S. To be able to add logic per shipping country like extra-legal text for Taiwan. Usage: ``` {{#ShippedToTW}} // If shipping country is TW
Due to recent regulatory changes for orders shipped to Taiwan, you are required to register your mobile phone number through the EZWAY Customs application, and then pre-authenticate the order once as soon as you are notified by the shipping partner (via SMS/e-mail) and via the EZWAY application to allow the Customs Clearance of the goods.
{{/ShippedToTW}} ``` ### Billing The following placeholders are supported in all email types. * `{{BillFullName}}` * `{{BillAddress}}` * `{{BillAddress2}}` * `{{BillState}}` * `{{BillCity}}` * `{{BillZip}}` * `{{BillPhone}}` * `{{BillCityRegion}}` * `{{BillCountry}}` * `{{BillCompanyName}}` * `{{BillVatRegistrationNumber}}` ### Payment The following placeholder is supported in all email types. `{{PaymentDetails}}` ### Legal Footer The following placeholders are supported in all email types. * `{{FooterLinks.ContactUs}}` * `{{FooterLinks.FAQ}}` * `{{FooterLinks.Help}}` * `{{FooterLinks.ReturnPolicy}}` * `{{FooterLinks.TermAndConditions}}` * `{{FooterLinks.PrivacyPolicy}}` * `{{FullLocalDelivery}}` ### Other The following placeholders are supported in all email types except for `{{RefundTotals}}`, which is only supported in Refund emails. * `{{EmailDirection}}` - Values: “`rtl`”, “`ltr`”. * `{{Culture}}` - See the [Culture](/email-management-transactional-emails#culture-information) object. * `{{Products}}` - See the [Products, OOSProducts, RefundProducts](/email-management-transactional-emails#products-oosproducts-refundproducts) objects. * `{{OOSProducts}}` - See the [Products, OOSProducts, RefundProducts](/email-management-transactional-emails#products-oosproducts-refundproducts) objects. * `{{OrderTotals}}` - See the [Order Totals](/email-management-transactional-emails#order-totals) object. * `{{RefundProducts}}` - See the [Products, OOSProducts, RefundProducts](/email-management-transactional-emails#products-oosproducts-refundproducts) objects. * `{{RefundTotals}}` - See the [Refund Totals](/email-management-transactional-emails#refund-totals) object. These placeholders are only supported in Refund emails. * `{{DisplayGiftMessageInConfirmationEmail}}` * `{{GiftMessage}}` * `{{IsFlashSale}}` * `{{IsRaffle}}` * `{{OrderEtaMessage}}` Usage: ``` EmailDirection Your content here ``` ### Products, OOSProducts, RefundProducts The following placeholders are supported in all email types. Data availability is based on the status of the order. For example, the OOS products placeholder remains empty if there are no products that are out of stock in the order. Use the `
` tag as a generic container for associating similar content. In this case, Products, Out of Stock Products, and Refunds Products and their properties. See [Products, Out-of-Stock Products, and Refund Products](/email-management-transactional-emails#products-out-of-stock-products-and-refund-products) for the list of product properties. The following example shows the structure for all Product placeholders: '`Products`', '`RefundProducts`', '`OOSProducts`'. Example: ```
{{#Products}} {{Name}} {{/Products}}
{{#OOSProducts}} {{Name}} {{/OOSProducts}}
{{#RefundProducts}} {{Name}} {{/RefundProducts}}
``` ### Products, Out-of-Stock Products, and Refund Products You can include the following placeholders in all email types. The Products, Out-of-Stock, and Refund placeholders serve as containers for general product information and assets. * `{{ImageURL}}` * `{{Name}}` * `{{OOSQuantity}}` * `{{OrderedQuantity}}` * `{{Price}}` * `{{ProductCode}}` * `{{#Products}}{{ProductAttributesHTML}}{{/Products}}` * `{{Quantity}}` * `{{Size}}` * `{{Url}}` ### Products Attributes You can include the following placeholder in all email types. This placeholder serves as a container for product attributes. `{{ProductAttributes.[Attribute key name]}}` Example: Render the product attribute ‘`Color`’ ‘size’. ``` {{#Products}} ``` ### Culture Information The following placeholders are supported in all email types. * `{{Culture.CultureName}}` * `{{Culture.CultureNameDisplay}` * `{{Culture.CultureNameOriginal}}` * `{{Culture.CultureProgId}}` * `{{Culture.CultureURL}}` * `{{Culture.IsRTL}}` Example: ```
My culture is {{Culture.CultureName}}
``` ### Order Totals You can use the following placeholders in all email types. These placeholders contain the amount with the currency symbol - for example, \$100. * `{{OrderTotals.OrderDiscounts}}` * `{{OrderTotals.OrderSubTotal}}` * `{{OrderTotals.ShippingDiscounts}}` * `{{OrderTotals.TotalCustomerPrepaidRefundAmount}}` * `{{OrderTotals.TotalDutiesAndTaxes}}` * `{{OrderTotals.TotalDutiesAndTaxesRefundAmount}}` * `{{OrderTotals.TotalGiftCardsRefundAmount}}` * `{{OrderTotals.TotalLoyaltyPointsRefundAmount}}` * `{{OrderTotals.TotalMoneyRefundAmount}}` * `{{OrderTotals.TotalPrice}}` * `{{OrderTotals.TotalProductsRefund}}` * `{{OrderTotals.TotalServiceGestureAmount}}` * `{{OrderTotals.TotalShipping}}` ### Refund Totals You can use the following placeholders as part of the Refund Notification Template, to build a dynamic message per refund reason. These placeholders contain the amount with the currency symbol - for example, \$100. * `{{RefundTotals.TotalDutiesAndTaxes}}` * `{{RefundTotals.AvalaraSalesTaxes}}` * `{{RefundTotals.TotalDutiesAndTaxesRefundAmount}}` * `{{RefundTotals.TotalGiftCardsRefundAmount}}` * `{{RefundTotals.TotalLoyaltyPointsRefundAmount}}` * `{{RefundTotals.TotalPrice}}` * `{{RefundTotals.TotalProductsRefund}}` * `{{RefundTotals.TotalServiceGestureAmount}}` * `{{RefundTotals.TotalShipping}}` ### Refund Reasons You can add the following refund reasons to the Refund notification template to build a dynamic message for each refund reason. For example, if the refund reason is out of stock, render the out-of-stock message as detailed below. **Out-of-Stock Refund Reason** ``` {{#IsOutOfStockRefundReason}}    {{TR_OutOfStockRefundReason}} {{/IsOutOfStockRefundReason}} ``` **Shipping Cost Refund Reason** ``` {{#IsShippingCostRefundReason}}       {{TR_ShippingCostRefundReason}} {{/IsShippingCostRefundReason}} ``` **No SSD Refund Reason** ``` {{#IsNoSDDRefundReason}} {{TR_NoSDDRefundReason}}         {{/IsNoSDDRefundReason}} ``` **Cancelled Order Refund Reason** ``` {{#IsCancelledOrderRefundReason}}                    {{TR_CancelledOrderRefundReason}} {{/IsCancelledOrderRefundReason}} ``` **Return Refund Reason** ``` {{#IsReturnRefundReason}}            {{TR_ReturnRefundReason}}         {{/IsReturnRefundReason}} ``` **Wrong Item Refund Reason** ``` {{#IsWrongItemRefundReason}}             {{TR_WrongItemRefundReason}}     {{/IsWrongItemRefundReason}} ``` **Missing Item Refund Reason** ``` {{#IsMissingItemRefundReason}}                    {{TR_MissingItemRefundReason}}     {{/IsMissingItemRefundReason}} ``` **Damaged Item Refund Reason** ``` {{#IsDamagedItemRefundReason}}        {{TR_DamagedItemRefundReason}} {{/IsDamagedItemRefundReason}} ``` **Warranty Issue Refund Reason** ``` {{#IsWarrantyIssueRefundReason}}          {{TR_WarrantyIssueRefundReason}}  {{/IsWarrantyIssueRefundReason}} ``` **Lowest Price Guarantee Refund Reason** ``` {{#IsLowestPriceGuaranteeRefundReason}}           {{TR_LowestPriceGuaranteeRefundReason}} {{/IsLowestPriceGuaranteeRefundReason}} ``` **Service Gesture Refund Reason** ``` {{#IsServiceGestureRefundReason}}             {{TR_ServiceGestureRefundReason}}         {{/IsServiceGestureRefundReason}} ``` **Swapped Part Refund Reason** ``` {{#IsSwappedPartRefundReason}}              {{TR_SwappedPartRefundReason}}         {{/IsSwappedPartRefundReason}} ``` **Lost In Transit Refund Reason** ``` {{#IsLostInTransitRefundReason}}              {{TR_LostInTransitRefundReason}}         {{/IsLostInTransitRefundReason}} ``` **Out-Of-Stock Item Refund Reason** ``` {{#IsOutOfStockItemRefundReason}}             {{TR_OutOfStockItemRefundReason}}         {{/IsOutOfStockItemRefundReason}} ``` **Cancelled Pending Payment Refund Reason** ``` {{#IsCancelledPendingPaymentRefundReason}}                {{TR_CancelledPendingPaymentRefundReason}}         {{/IsCancelledPendingPaymentRefundReason}} ``` **Gift Card Redeem Failed Refund Reason** ``` {{#IsGiftCardRedeemFailedRefundReason}}              {{TR_IsGiftCardRedeemFailedRefundReason}}         {{/IsGiftCardRedeemFailedRefundReason}} ``` **Damaged Box Received Refund Reason** ``` {{#IsDamageBoxReceivedRefundReason}}              {{TR_DamageBoxReceivedRefundReason}} {{/IsDamageBoxReceivedRefundReason}} ``` **Damaged Product Received Refund Reason** ``` {{#IsDamagedProductReceivedRefundReason}}            {{TR_DamagedProductReceivedRefundReason}}         {{/IsDamagedProductReceivedRefundReason}} ``` **Item Not Received Refund Reason** ``` {{#IsItemNoReceivedRefundReason}}              {{TR_ItemNoReceivedRefundReason}}         {{/IsItemNoReceivedRefundReason}} ``` **Lost In Shipment Refund Reason** ``` {{#IsLostInShipmentRefundReason}}                {{TR_LostInShipmentRefundReason}}     {{#IsLostInShipmentRefundReason}}     ``` **Missing Item From Order Refund Reason** ``` {{#IsMissingItemFromOrderRefundReason}}             {{TR_MissingItemFromOrderRefundReason}}         {{/IsMissingItemFromOrderRefundReason}} ``` **Other Refund Reason** ``` {{#IsOtherRefundReason}}                  {{TR_OtherRefundReason}}         {{/IsOtherRefundReason}} ``` **Product Out-of-Stock Refund Reason** ``` {{#IsProductOutOfStockRefundReason}}                  {{TR_ProductOutOfStockRefundReason}}         {{/IsProductOutOfStockRefundReason}} ``` **Wrong Item Received Refund Reason** ``` {{#IsWrongItemReceivedRefundReason}}              {{TR_WrongItemReceivedRefundReason}}         {{/IsWrongItemReceivedRefundReason}} ``` **Wrong Price Charged Refund Reason** ``` {{#IsWrongPriceChargedRefundReason}}              {{TR_WrongPriceChargedRefundReason}}         {{/IsWrongPriceChargedRefundReason}} ``` **Lost by Merchant and Refund Refund Reason** ``` {{#IsLostbymerchantandrefundRefundReason}}           {{TR_LostbymerchantandrefundRefundReason}}         {{/IsLostbymerchantandrefundRefundReason}} ``` **Gift Card Redeem Refund Reason** ``` {{#IsGiftCardRedeemRefundReason}}               {{TR_GiftCardRedeemRefundReason}}         {{/IsGiftCardRedeemRefundReason}} ``` **Cancelled By Customer Request Refund Reason** ``` {{#IsCanceledByCustomerRequestRefundReason}}              {{TR_CanceledByCustomerRequestRefundReason}}         {{/IsCanceledByCustomerRequestRefundReason}} ``` ### Currency The following placeholders are supported in all email types. * `{{CurrencyCode}}` * `{{CurrencyName}}` * `{{CurrencySymbol}}` ### Return The following placeholders are included when return information is available. * `{{ReturnId}}` * `{{RMANumber}}` * `{{ReturnDate}}` * `{{ReturnProducts}}` - See the [Return Product](/email-management-transactional-emails#return-product) objects. * `{{TotalProductsRefund}}` * `{{TotalShippingRefund}}` * `{{TotalDutiesRefund}}` * `{{TotalRefund}}` ### Return Product The following placeholders are included when return information is available. * `{{ProductName}}` * `{{ProductCode}}` * `{{UnitSalePrice}}` * `{{ApprovedQuantity}}` * `{{TotalPrice}}` ### Store Info The Store Info placeholders are supported in the following email types: * `OrderReplacementDeliveredToStore` * `OrderDeliveredToStore` **Placeholders:** * `{{Store.Name}}` * `{{Store.Description}}` * `{{Store.Address1}}` * `{{Store.Address2}}` * `{{Store.StateOrProvince}}` * `{{Store.City}}` * `{{Store.Zip}}` * `{{Store.Phone1}}` * `{{Store.Phone2}}` * `{{StoreOpeningHours}}` ### Tracking Info The following placeholders are supported when tracking information is available. * `{{TrackingNumber}}` * `{{TrackingLink}}` ### Example of Placeholders in the Products Section ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e32c429f-2d47-9112-ae01-cf92feed5b2b.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=394f83bfe33a48e6a55b01db68e78913) ### Example of Placeholder Rendering in the Products Section ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-33a58ef5-6e51-982f-2e6f-934817dc3fa8.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=228039d85992530272f08a4141ab2df8) ## Examples and File Formats ### Global‑e Default HTML Template The following table lists all the HTML file and their related TextResource Excel file offered by Global-e. | # | Email Name | HTML File | TextResource Excel File | | - | - | - | - | | 1 | Customer Line Cancellation | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/CustomerLineCancellation.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/CustomerLineCancellation.xlsx) | | 2 | Order Cancelled by Customer | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Customr.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Customr.xlsx) | | 3 | Order Cancelled by Customer - Discontinued Product | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+discontinued+product.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+discontinued+product.xlsx) | | 4 | Order Cancelled by Customer - Fraud Check | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+fraud+check.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+fraud+check.xlsx) | | 5 | Order Cancelled by Customer - Incorrect Address Details | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+Incorrect+Address+Details.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+Incorrect+Address+Details.xlsx) | | 6 | Order Cancelled by Customer - Out of Stock Product | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+out+of+stock+product.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+out+of+stock+product.xlsx) | | 7 | Order Confirmed | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Confirmed.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Confirmed.xlsx) | | 8 | Order Dispatched | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Dispatched.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Dispatched.xlsx) | | 9 | Order Received | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Received.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Received.xlsx) | | 10 | Partial Shipment | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Partial+Shipment.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Partial+Shipment.xlsx) | | 11 | Refund Notification | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Refund+Notification.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Refund+Notification.xlsx) | | 12 | RMA Created | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/RMA+Created.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/RMA+Created.xlsx) | > [!NOTE] > > If you have the **New Returns Portal** set up, the **RMA Created** email is not configured via the Email Tool. Unlike other transactional emails, this email is managed directly within the Returns Portal. For more details, refer to **Customizing Email Notifications**. ## TextResources (Excel) > [!WARNING] > > By default, the language of all text resources is set to English United Kingdom. In the text resources file, the column **English - United Kingdom** must always contain text in English. This text is used as a basis for the translation to other languages. TextResources are listed in the Text Resources Excel file’s `ResourceKey` column and are preceded by `TR_`. The TextResources Excel file features the following text resource columns: * `ResourceKey` * `ResourceGroupTypeId` * `ResourceGroupReferenceId` * `ResourceMerchantPlatformId` * English United Kingdom (default language) - See Translation. * Translation to Other Languages - See Translation. | **[Click here to download an example of a TextResources file](https://www.global-e.com/wp-content/uploads/2023/11/TextResources.xlsx)** | | - | | | > [!WARNING] > > The column **English - United Kingdom** must always contain text in English. This text is used as a basis for the translation to other languages. * ResourceKey * ResourceGroupTypeId * ResourceGroupReferenceId * ResourceMerchantPlatformId * English – United Kingdom (2057) * Additional Languages | **ResourceKey** | **ResourceGroupTypeId** | **ResourceGroupReferenceId** | **ResourceMerchantPlatformId** | **English – United Kingdom** (**2057**) | Additional Languages | | - | - | - | - | - | - | | `SenderEmail` (Mandatory) | 0 | 0 | 0 | [noreply@global-e.com](mailto:noreply@global-e.com) | Translation | | `SenderName` (Mandatory) | 0 | 0 | 0 | Global‑e | Translation | | `Subject` | 0 | 0 | 0 | Your order is confirmed – order number `{{ORDERID}}` | Translation | | `TR_Disclaimer` | 0 | 0 | 0 | Disclaimer | Translation | | `TR_DutiesAndTaxes` | 0 | 0 | 0 | Duties & Taxes | Translation | | `TR_EmailDirection` | 0 | 0 | 0 | ltr | Translation | | `TR_FOOTTER_SNIPPET` | 0 | 0 | 0 | \ \You have questions ? We are here to help you.\ Do not hesitate to contact our support service by phone or by e-mail via the following link \See our support service\. \ | Translation | | `TR_GlobleEMerchantName` | 0 | 0 | 0 | E-commerce services provided by Global‑e. | Translation | | `TR_OrderConfirmedDescription` | 0 | 0 | 0 | Thanks for shopping at `{{MerchantName}}`. Your order will be processed by Global-e as a merchant of record for this transaction. We are happy to inform you that this order is now confirmed, and we will begin processing your purchase for despatch. Please don’t hesitate to contact us with any Questions \{\{CustomerSupportEmail}} | Translation | | `TR_OrderDiscounts` | 0 | 0 | 0 | Order Discounts | Translation | | `TR_OrderDispatchedDescription` | 0 | 0 | 0 | Hi There! Questions? \Contact us\ | Translation | | `TR_OrderNumber` | 0 | 0 | 0 | Order Number: | Translation | | `TR_OrderPlaced` | 0 | 0 | 0 | Order Placed: | Translation | | `TR_PaymentDetailsText` | 0 | 0 | 0 | Payment Details | Translation | | `TR_PREHEADER` | 0 | 0 | 0 | This is the PreHeader…. | Translation | | `TR_ProductSupport` | 0 | 0 | 0 | Product Support | Translation | | `TR_Qty` | 0 | 0 | 0 | Qty | Translation | | `TR_Salutation` | 0 | 0 | 0 | Dear `{{Firstname}}` | Translation | | `TR_ShipmentDesc` | 0 | 0 | 0 | Once your order has been shipped, we will send you an email, which will include the shipment tracking number for your reference. | Translation | | `TR_ShipmentItemsText` | 0 | 0 | 0 | Shipment Items | Translation | | `TR_Shipping` | 0 | 0 | 0 | Shipping | Translation | | `TR_ShippingDiscount` | 0 | 0 | 0 | Shipping refund | Translation | | `TR_ShippingMethodText` | 0 | 0 | 0 | Shipping Method | Translation | | `TR_StoreSupport` | 0 | 0 | 0 | Store Support | Translation | | `TR_Subtotal` | 0 | 0 | 0 | Subtotal | Translation | | `TR_Total` | 0 | 0 | 0 | Total | Translation | | `TR_YourBillingAddress` | 0 | 0 | 0 | Your billing address: | Translation | | `TR_YourOrderedText` | 0 | 0 | 0 | You Ordered | Translation | | `TR_YourShippingAddress` | 0 | 0 | 0 | Your shipping address: | Translation | | **ResourceKey** | **ResourceGroupTypeId** | **ResourceGroupReferenceId** | **ResourceMerchantPlatformId** | **English – United Kingdom** (**2057**) | Additional Languages | | - | - | - | - | - | - | | `SenderEmail` (Mandatory) | 0 | 0 | 0 | [noreply@global-e.com](mailto:noreply@global-e.com) | Translation | | `SenderName` (Mandatory) | 0 | 0 | 0 | Global‑e | Translation | | `Subject` | 0 | 0 | 0 | Your order is confirmed – order number `{{ORDERID}}` | Translation | | `TR_Disclaimer` | 0 | 0 | 0 | Disclaimer | Translation | | `TR_DutiesAndTaxes` | 0 | 0 | 0 | Duties & Taxes | Translation | | `TR_EmailDirection` | 0 | 0 | 0 | ltr | Translation | | `TR_FOOTTER_SNIPPET` | 0 | 0 | 0 | \ \You have questions ? We are here to help you.\ Do not hesitate to contact our support service by phone or by e-mail via the following link \See our support service\. \ | Translation | | `TR_GlobleEMerchantName` | 0 | 0 | 0 | E-commerce services provided by Global‑e. | Translation | | `TR_OrderConfirmedDescription` | 0 | 0 | 0 | Thanks for shopping at `{{MerchantName}}`. Your order will be processed by Global-e as a merchant of record for this transaction. We are happy to inform you that this order is now confirmed, and we will begin processing your purchase for despatch. Please don’t hesitate to contact us with any Questions \{\{CustomerSupportEmail}} | Translation | | `TR_OrderDiscounts` | 0 | 0 | 0 | Order Discounts | Translation | | `TR_OrderDispatchedDescription` | 0 | 0 | 0 | Hi There! Questions? \Contact us\ | Translation | | `TR_OrderNumber` | 0 | 0 | 0 | Order Number: | Translation | | `TR_OrderPlaced` | 0 | 0 | 0 | Order Placed: | Translation | | `TR_PaymentDetailsText` | 0 | 0 | 0 | Payment Details | Translation | | `TR_PREHEADER` | 0 | 0 | 0 | This is the PreHeader…. | Translation | | `TR_ProductSupport` | 0 | 0 | 0 | Product Support | Translation | | `TR_Qty` | 0 | 0 | 0 | Qty | Translation | | `TR_Salutation` | 0 | 0 | 0 | Dear `{{Firstname}}` | Translation | | `TR_ShipmentDesc` | 0 | 0 | 0 | Once your order has been shipped, we will send you an email, which will include the shipment tracking number for your reference. | Translation | | `TR_ShipmentItemsText` | 0 | 0 | 0 | Shipment Items | Translation | | `TR_Shipping` | 0 | 0 | 0 | Shipping | Translation | | `TR_ShippingDiscount` | 0 | 0 | 0 | Shipping refund | Translation | | `TR_ShippingMethodText` | 0 | 0 | 0 | Shipping Method | Translation | | `TR_StoreSupport` | 0 | 0 | 0 | Store Support | Translation | | `TR_Subtotal` | 0 | 0 | 0 | Subtotal | Translation | | `TR_Total` | 0 | 0 | 0 | Total | Translation | | `TR_YourBillingAddress` | 0 | 0 | 0 | Your billing address: | Translation | | `TR_YourOrderedText` | 0 | 0 | 0 | You Ordered | Translation | | `TR_YourShippingAddress` | 0 | 0 | 0 | Your shipping address: | Translation | # Email Management Source: https://docs.global-e.com/email-management-transactional-emails When an order reaches a specific status, Global-e automatically sends a localized email to your customer. The Global‑e Email Management tool lets you modify the content of this email, customize the look and feel, add custom text, and provide your own translation. In addition, you can preview your email configuration settings both on desktop and mobile and test your settings before submitting (publishing) your final template to Global‑e. Before configuring your email template, see the following: * [Prerequisites](/email-management-transactional-emails#prerequisites) * [Legal Statement](/email-management-transactional-emails#legal-statement) ## Prerequisites > [!WARNING] > > **For optimal use of the Email Management tool, a basic understanding of HTML and familiarity with HTML structure and CSS styling concepts are required.** ## To use the Email Management tool: * Verify the Email Management feature is enabled. * Verify you have one of the following roles in the Merchant Portal for configuring emails: * Global Merchant Admin with the default Merchant Admin username and password * Merchant Emails Operator with the default Merchant Email Operator username and password. Contact your Success Manager if you cannot access the Merchant Portal or do not have permission. * Manage your HTML content: * The Merchant owns the HTML for creating email. * Translation of the texts to other languages is handled by the Merchant. * Familiarity with the Mustache Templating Specification and Language is required. For more information, see [https://mustache.github.io/mustache.5.html](https://mustache.github.io/mustache.5.html). ## Legal Statement The following legal statement must be included in the email description paragraph (in all languages): Your order will be processed by Global-e as a merchant of record for this transaction. | [Click here to download the legal statement](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/Other+Resources/Email+-+Legal+Dieclaimer.xlsx) | | - | | | ## Create your Email Template and Text Resources **Before getting started:** 1. Create your email HTML template. Make sure to include all the default text resources and placeholders. For more information, see: [Create your HTML Template](/email-management-transactional-emails#create-your-html-template) [TextResource Excel Format and Example](/email-management-transactional-emails#textresources-excel) [Placeholders](/email-management-transactional-emails#placeholders). 2. Create your Text Resources Excel file, as detailed in: [Create your Text Resources File](/email-management-transactional-emails#create-your-text-resources-file) [TextResource Excel Format and Example](/email-management-transactional-emails#textresources-excel) [Placeholders](/email-management-transactional-emails#placeholders). ## Manage your Emails This procedure assumes that you have already created your HTML template and Text Resources. **To manage your emails:** 1. Log in to the Global‑e Merchant Portal. 2. Navigate to **Configuration > Email Management**. The Email Management screen opens. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1b1a5f22-adb1-0d76-1b43-2faed3fc7475.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=ab8089e0b7d7a5af5a156673f64b52cd) 3. Set up and manage your email template, as detailed in the screen capture above and in the following table. | | Step | For more information | | - | - | - | | Step 1 | Select the **Email Type** you wish to customize from the drop-down menu. | [\[1\] Email Type](/email-management-transactional-emails#1-email-type) | | Step 2 | **Upload the HTML template you have created:** Click **Upload New** and select your HTML file. | [\[2\] HTML Template](/email-management-transactional-emails#2-html-template) | | Step 3 | **Upload the new Text Resources:** Click **Upload New** and select your Text Resources file (Excel). | [\[3\] Text Resources](/email-management-transactional-emails#3-text-resources)[TextResources (Excel)](/email-management-transactional-emails#textresources-excel) | | Step 4 | **Preview your draft template in the preview area:** Click **Save Changes**. (Make sure you are in draft mode).Note that, when switching from Draft mode to Publish mode, the **Save Changes** button switches to a **Publish** button \[8]. | [\[4\] Save your Template and Preview your Changes](/email-management-transactional-emails#4-save-your-template-and-preview-your-changes) | | Step 5 | **Preview your email language:** Select the desired language from the drop-down menu. | [\[5\] Preview the Language](/email-management-transactional-emails#5-preview-the-language) | | Step 6 | **Preview an order as part of your email template:** Enter the order ID | [\[6\] Preview an Order](/email-management-transactional-emails#6-preview-an-order) | | Step 7 | **Test your Draft or Publish template before publishing it to Global‑e:** Click **Send Test** and fill out the Send Test email form.- OR –Select **Send** for a quick send (if you have already filled out the form). | [\[7\] Test your Setup - Send a Test Email](/email-management-transactional-emails#7-test-your-setup---send-a-test-email) | | Step 8 | **Publish your changes:** Select the **Publish** mode and click **Publish Changes**. | [\[8\] Publish your Changes](/email-management-transactional-emails#8-publish-your-changes) | | Optional | **Unpublish your changes** | [Revert your Published Changes (Optional)](/email-management-transactional-emails#revert-your-published-changes-optional) | ### \[1] Email Type Select the **Email Type** you wish to customize from the drop-down menu. See the list of email types here, [Global‑e Default HTML Template.](/email-management-transactional-emails#global‑e-default-html-template) All email transactions are supported. ### \[2] HTML Template This section provides instructions on how to create or modify your HTML template. ### Create your HTML Template **To create your HTML template:** 1. Write the content and design your HTML template using a tool of your choice. > [!NOTE] > > **[Click here to view and save an example of the HTML template](https://www.global-e.com/wp-content/uploads/2023/11/Template.html)** 2. Add all the mandatory text resources at the correct location, as defined in the [TextResources](/email-management-transactional-emails#textresources-excel) file. 3. When done, click **Upload New** to upload your HTML template. 4. Click **Upload New** to upload the text resources file have created (see [Create your Text Resources File](/email-management-transactional-emails#create-your-text-resources-file) [Create your Text Resources File](/email-management-transactional-emails#create-your-text-resources-file)). 5. Click **Save Changes** and preview your draft. Example: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-0ba01672-6449-2777-41af-08e4d3fafd5d.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=082087535a76a65d966e87aafa170bc4) ### Modify your HTML Template **To modify your HTML Template:** 1. Click **Download Current** HTML template. 2. Modify the HTML text using a tool of your choice. Note that if you modify the HTML text and you do not include that new text with its translation in the text resources file, the text will not be translated. 3. Make sure you have included all the mandatory text resources at the correct location, as defined in the [TextResources](/email-management-transactional-emails#textresources-excel) file. 4. Save your file as HTML. 5. When done, click **Upload New** to upload your HTML template. ### \[3] Text Resources TextResources are the strings that are included in the placeholders within your email template. They are displayed in curly brackets. When you create or modify text resources in your email template, make sure that all mandatory text resources are included in your email and formatted correctly. ### Create your Text Resources File **To create your Text Resources file:** 1. Create your text resources file by using the format and example [TextResources](/email-management-transactional-emails#textresources-excel) file. 2. Make sure to add all the mandatory text resources as defined in the [TextResources](/email-management-transactional-emails#textresources-excel) file. > [!WARNING] > > By default, you must define the language of all text resources in English. > > In the text resources file, the column "English - United Kingdom" must always contain text in English. This text is used as a basis for the translation to other languages. 3. Save your file as Excel. 4. When done, click **Upload New** to upload your TextResources file. 5. Click **Save Changes**. After uploading your text resources, if you have included the text resources in your HTML Template (see [\[2\] HTML Template](/email-management-transactional-emails#2-html-template),) you can preview your email with the placeholders of the text resources. Example: ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-6f816a71-9619-edbd-5652-4a5fc25d979f.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=a16e066a4598329bacdec2d5b4cb948a) ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ebdbabc9-b214-6576-de24-f67e00d3c5ae.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=85e7f700b680b000157492b34915dc08) See: [Placeholders](/email-management-transactional-emails#placeholders) for the list of supported placeholders. [Preview an Order](/email-management-transactional-emails#6-preview-an-order) to view how the template with the placeholders converts to actual data. ### Modify Text Resources This section assumes that you have previously uploaded your text resources file. See [Create your Email Template and Text Resources](/email-management-transactional-emails#create-your-email-template-and-text-resources). > [!WARNING] > > By default, the language of all text resources is set to English United Kingdom. In the text resources file, the column **English - United Kingdom** must always contain text in English. This text is used as a basis for the translation to other languages. **To modify a Text Resource:** 1. Click **Download Current** text resources file. 2. To modify English Text Resources, modify the text in the column **English – United Kingdom**. 3. To modify Text Resources in Other Languages: 1. Translate the TextResource you have modified under the column **English - United Kingdom** to the target language. 2. Add the translation of each text resource in the corresponding language column and row (cell). 4. Click **Upload New** to upload your file. ### Add a New Text Resource > [!WARNING] > > By default, the language of all text resources is set to English United Kingdom. In the text resources file, the column **English - United Kingdom** must always contain text in English. This text is used as a basis for the translation to other languages. **To add new Text Resources:** 1. In your HTML template, add the new text resource at the correct location. For example: `{{TR_NewSaltutation}}` 2. In your TextResources Excel: 1. Add a new row for the new text resource. 2. Mandatory: Add a description in the column **English – United Kingdom**. **Note:** English UK must be filled as it is used as the basis for translations. 3. To add Other Languages: 1. Make sure you have added a column for the target language. 2. Translate the text you have added under the **English - United Kingdom** column to the target language. 3. Add the translation of each text resource in the corresponding language column and row (cell). 4. When done, click **Upload New** to upload your TextResources file. 3. HTML template: 1. Make sure you have added all the required TextResources in your HTML template. 2. When done, click **Upload New** to upload your HTML template. ### Remove a Text Resource To remove a text resource, **you must remove the resource from both**: * The HTML template * The TextResource Excel ### \[4] Save your Template and Preview your Changes **To save your template and preview your changes:** 1. Select **Draft** or **Publish** mode, as required. 2. When you are satisfied with your modifications, click **Save Changes**. and preview your changes. 3. If you are in draft mode, you can edit the draft at a later stage. 4. Optional: Click **Discard Changes** if you do not wish to save your changes. Example: ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-90892817-ea71-dba7-7f80-c657cb3360ba.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=99874dabdcf7b7ccbc937731cbdbf49a) ### \[5] Preview the Language **To preview the language:** 1. Select **Draft** or **Publish** mode, as required. 2. Select the language you wish to preview. **Notes:** * You must have translated the text in the TextResources Excel file for the text to be displayed in the selected language. * Static text is text that has not been defined as a Text Resource. Static text is not translated or modified. If you have included static text in your HTML template and you wish to translate it, you must first define it as a text resource in the [TextResources (Excel)](/email-management-transactional-emails#textresources-excel), provide the translation, and upload your modified text resource. * You can modify the Sender and the Subject line in the text resources. Example: In this example, the email was translated into Spanish, but "Dear First Name" has not been translated since it is static text, and the translation was not defined in the TextResources file. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5b02e3ad-859f-a8aa-4eb0-01fb26d4b77e.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=1b01f2480a90089a292bb3278aa6fd6f) ### \[6] Preview an Order **To preview an order:** 1. Select **Draft** or **Publish** mode, as required. 2. In **Preview an Order**, enter the order ID or the Merchant ID. 3. Select **Show Order Values in the device previews**. This option toggles the preview between the placeholders and the real data. When selecting this option, the preview area shows the template with the data taken from the real order. The placeholders in the template are converted to actual data. Example: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1848fc35-ab33-39bb-9d77-93be82948dd4.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=a81c64c65f9c461e75b01aa2330ac592) ### \[7] Test your Setup - Send a Test Email **To test your setup:** ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d0c05b1d-c9c2-e9c9-fa0c-288b4de4af07.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=25cf3477234c2ab5debaa722a9b76f93) 1. Click **Send Test**. The Send test email box opens. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f290e4b8-ba59-f788-9ace-ac4488019a69.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=6db09e00e71b69576b04e040eb7282ea) 2. In the Send test email box: 1. Enter the Order ID. 2. Select the Email Type. 3. Select the language. 4. Select the Version: Draft or Publish 5. Enter the email address to which the test should be sent. 3. Click **Send**. A confirmation message is displayed. 4. Open the email and review it. **To perform a "quick send":** If your email management screen already contains the above information, click the down arrow and select **Send To**. A confirmation message is displayed and by default, the email test is sent to you (the logged-in user's email address). ### \[8] Publish your Changes When you are satisfied with the results, you can publish your changes. * Click **Publish** to submit your final changes to Global‑e. A confirmation message is displayed. Your published template is uploaded to the Global-e system. This is the email template that Global-e will be using for your email templates from now on. > [!NOTE] > > Clicking **Publish** uploads the final email template (HTML) to the Global‑e Production whereas **Save Changes** saves your draft for further editing. ### Revert your Published Changes (Optional) After publishing, you can click **Unpublish** to revert to the default Global‑e template. ## Using Custom Fonts Follow these guidelines when using non-standard fonts in your emails. * **Use Web-Safe Fonts as Fallbacks** * Always specify a web-safe font as a fallback in case the custom font does not load. * Common web-safe fonts include Arial, Verdana, Georgia, and Times New Roman. * **Host Fonts Appropriately** * Host the fonts on a reliable server or use a service like Google Fonts or Adobe Fonts. * Ensure that the font files are compressed (e.g., WOFF or WOFF2 format) to minimize loading time. * **Use Inline CSS for Font Integration** * Apply custom fonts using inline CSS within the \

This is custom font text.

``` * **Test Across Multiple Email Clients** * Different email clients render fonts differently. Test emails across popular clients to ensure the custom font displays. * Pay attention to mobile clients as well. * **Limit the Use of Custom Fonts** * Use custom fonts sparingly, reserving them for headers or branding elements. * For longer bodies of text, use standard web-safe fonts. * **Consider Email Load Times** * Custom fonts can increase the size of the email, which might affect load times. Ensure the font files are as small as possible. * Keep the total email size under 102KB to avoid clipping in some email clients. * **Ensure Legal Compliance** * Verify that you have the correct licensing to use and distribute the font in emails. * **Monitor Email Deliverability** * Custom fonts can sometimes cause deliverability issues. Monitor open rates, click rates, and spam reports. * **Fallback on System Fonts in Case of Issues** * If any issues arise, be prepared to revert to system fonts to ensure the email remains functional. ## Moving from Testing Environment to Production When you are ready to move to Production, follow these steps for each email type: 1. In the **Testing environment,** download the current HTML and the current text resources file. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9a2dd4fc-c1ff-0d76-21f6-8fe704b2fa7a.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=373778767566d5150e9f2831f4bbeacd) Download Current HTML ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7b77b85f-b3cb-4627-b536-07feaffad0f7.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=24c7559cfa7702328ed15204aa8e78f4) Download the current text resources file 2. In the **Production environment**, select the relevant email type (e.g. Order Confirmed). 3. Upload the HTML downloaded in step #1. 4. Upload the text resources file downloaded in step #2. 5. Click **Save Changes**. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7451b761-b2e1-6c5f-f205-3190a8916c41.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=f1cb0b22f8b8d5f01ceb1fa3b59c3108) 6. Preview and Test. 7. Click **Publish**. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f7858c9d-9d45-7176-2974-956a93ceaf84.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=283ccae74cebdd08c0a105c5190905b9) ## Placeholders The Global‑e templates are based on the Mustache templating specification and language. For more information on Mustache, see [https://mustache.github.io/mustache.5.html](https://mustache.github.io/mustache.5.html). Mustache serves as a powerful templating system that enables the utilization of pre-existing text files containing designated placeholders. These placeholders are dynamically substituted with values specific to a particular request during runtime. Global‑e supports two types of placeholders that you can use in the HTML template: * Placeholders related to Orders, such as the order ID, shipping address, totals, products, and more. * Custom placeholders to manage Text Resources, which can hold texts, translations, links, and html snippets for the header, footer, and CSS. ### Custom Placeholders Custom placeholders often start with the prefix `TR_` to differentiate between order placeholders and resource placeholders. However, this convention is not mandatory. Example: `TR_Salutation` **To add, create and upload custom placeholders:** 1. Include your custom placeholder values in your text resource file as keys (without `{}`). 2. Include the custom placeholders' unique key \{`TR_Salutation`} in your HTML template. **Required Placeholders** `Subject` `SenderName` `SenderEmail` **Variations** `[CountryName].SenderName` `[CountryName].SenderEmail` > [!NOTE] > > CountryName is a 2-letter country code. For example, use US for USA. ### Available Placeholders This section provides a list of placeholder tags and examples. ### Customer The following placeholders are supported in all email types. * `{{FirstName}}` * `{{LastName}}` * `{{FullName}}` - the recipient's first name and last name * `{{Email}}` - the recipient's email address Usage: ```
Dear {{FirstName}}
Hello {{FullName}}
Dear {{LastName}}
Your email address: {{Email}}
``` ### Order The following placeholders are supported in all email types. * `{{OrderReceiveDate}}` * `{{OrderTrackingNumber}}` * `{{OrderId}}` * `{{MerchantOrderId}}` * `{{MerchantInternalOrderId}}` * `{{OrderConfirmedDate}}` Usage: ```
We have received your order on {{OrderReceiveDate}}.
Your tracking number is {{OrderTrackingNumber}}
Your order id is {{OrderId}}
Your merchant order id is {{MerchantOrderId}}
Your merchant internal order id is {{MerchantInternalOrderId}}
Your order has been confirmed on {{OrderConfirmedDate}}
``` ### Merchant The following placeholders are supported in all email types. * `{{CustomerSupportEmail}}` * `{{MerchantName}}` * `{{MerchantStatementName}}` ### Shipping The following placeholders are supported in all email types. * `{{ShipFullName}}` * `{{ShipFirstName}}` * `{{ShipAddress}}` * `{{ShipAddress2}}` * `{{Company}}` * `{{ShipState}}` * `{{ShipCity}}` * `{{ShipZip}}` * `{{ShipPhone}}` * `{{ShipCityRegion}}` * `{{ShipCompanyName}}` * `{{ShipCountry}}` * `{{ShippingMethodName}}` * `{{ShippingService}}` * `{{CarrierName}}` * `{{ShipVatRegistrationNumber}}` * `{{ShippedTo}}` > [!NOTE] > > `ShippedTo` is a 2-letter `CountryCode`. For example, IL, TW, U.S. To be able to add logic per shipping country like extra-legal text for Taiwan. Usage: ``` {{#ShippedToTW}} // If shipping country is TW
Due to recent regulatory changes for orders shipped to Taiwan, you are required to register your mobile phone number through the EZWAY Customs application, and then pre-authenticate the order once as soon as you are notified by the shipping partner (via SMS/e-mail) and via the EZWAY application to allow the Customs Clearance of the goods.
{{/ShippedToTW}} ``` ### Billing The following placeholders are supported in all email types. * `{{BillFullName}}` * `{{BillAddress}}` * `{{BillAddress2}}` * `{{BillState}}` * `{{BillCity}}` * `{{BillZip}}` * `{{BillPhone}}` * `{{BillCityRegion}}` * `{{BillCountry}}` * `{{BillCompanyName}}` * `{{BillVatRegistrationNumber}}` ### Payment The following placeholder is supported in all email types. `{{PaymentDetails}}` ### Legal Footer The following placeholders are supported in all email types. * `{{FooterLinks.ContactUs}}` * `{{FooterLinks.FAQ}}` * `{{FooterLinks.Help}}` * `{{FooterLinks.ReturnPolicy}}` * `{{FooterLinks.TermAndConditions}}` * `{{FooterLinks.PrivacyPolicy}}` * `{{FullLocalDelivery}}` ### Other The following placeholders are supported in all email types except for `{{RefundTotals}}`, which is only supported in Refund emails. * `{{EmailDirection}}` - Values: “`rtl`”, “`ltr`”. * `{{Culture}}` - See the [Culture](/email-management-transactional-emails#culture-information) object. * `{{Products}}` - See the [Products, OOSProducts, RefundProducts](/email-management-transactional-emails#products-oosproducts-refundproducts) objects. * `{{OOSProducts}}` - See the [Products, OOSProducts, RefundProducts](/email-management-transactional-emails#products-oosproducts-refundproducts) objects. * `{{OrderTotals}}` - See the [Order Totals](/email-management-transactional-emails#order-totals) object. * `{{RefundProducts}}` - See the [Products, OOSProducts, RefundProducts](/email-management-transactional-emails#products-oosproducts-refundproducts) objects. * `{{RefundTotals}}` - See the [Refund Totals](/email-management-transactional-emails#refund-totals) object. These placeholders are only supported in Refund emails. * `{{DisplayGiftMessageInConfirmationEmail}}` * `{{GiftMessage}}` * `{{IsFlashSale}}` * `{{IsRaffle}}` * `{{OrderEtaMessage}}` Usage: ``` EmailDirection Your content here ``` ### Products, OOSProducts, RefundProducts The following placeholders are supported in all email types. Data availability is based on the status of the order. For example, the OOS products placeholder remains empty if there are no products that are out of stock in the order. Use the `
` tag as a generic container for associating similar content. In this case, Products, Out of Stock Products, and Refunds Products and their properties. See [Products, Out-of-Stock Products, and Refund Products](/email-management-transactional-emails#products-out-of-stock-products-and-refund-products) for the list of product properties. The following example shows the structure for all Product placeholders: '`Products`', '`RefundProducts`', '`OOSProducts`'. Example: ```
{{#Products}} {{Name}} {{/Products}}
{{#OOSProducts}} {{Name}} {{/OOSProducts}}
{{#RefundProducts}} {{Name}} {{/RefundProducts}}
``` ### Products, Out-of-Stock Products, and Refund Products You can include the following placeholders in all email types. The Products, Out-of-Stock, and Refund placeholders serve as containers for general product information and assets. * `{{ImageURL}}` * `{{Name}}` * `{{OOSQuantity}}` * `{{OrderedQuantity}}` * `{{Price}}` * `{{ProductCode}}` * `{{#Products}}{{ProductAttributesHTML}}{{/Products}}` * `{{Quantity}}` * `{{Size}}` * `{{Url}}` ### Products Attributes You can include the following placeholder in all email types. This placeholder serves as a container for product attributes. `{{ProductAttributes.[Attribute key name]}}` Example: Render the product attribute ‘`Color`’ ‘size’. ``` {{#Products}} ``` ### Culture Information The following placeholders are supported in all email types. * `{{Culture.CultureName}}` * `{{Culture.CultureNameDisplay}` * `{{Culture.CultureNameOriginal}}` * `{{Culture.CultureProgId}}` * `{{Culture.CultureURL}}` * `{{Culture.IsRTL}}` Example: ```
My culture is {{Culture.CultureName}}
``` ### Order Totals You can use the following placeholders in all email types. These placeholders contain the amount with the currency symbol - for example, \$100. * `{{OrderTotals.OrderDiscounts}}` * `{{OrderTotals.OrderSubTotal}}` * `{{OrderTotals.ShippingDiscounts}}` * `{{OrderTotals.TotalCustomerPrepaidRefundAmount}}` * `{{OrderTotals.TotalDutiesAndTaxes}}` * `{{OrderTotals.TotalDutiesAndTaxesRefundAmount}}` * `{{OrderTotals.TotalGiftCardsRefundAmount}}` * `{{OrderTotals.TotalLoyaltyPointsRefundAmount}}` * `{{OrderTotals.TotalMoneyRefundAmount}}` * `{{OrderTotals.TotalPrice}}` * `{{OrderTotals.TotalProductsRefund}}` * `{{OrderTotals.TotalServiceGestureAmount}}` * `{{OrderTotals.TotalShipping}}` ### Refund Totals You can use the following placeholders as part of the Refund Notification Template, to build a dynamic message per refund reason. These placeholders contain the amount with the currency symbol - for example, \$100. * `{{RefundTotals.TotalDutiesAndTaxes}}` * `{{RefundTotals.AvalaraSalesTaxes}}` * `{{RefundTotals.TotalDutiesAndTaxesRefundAmount}}` * `{{RefundTotals.TotalGiftCardsRefundAmount}}` * `{{RefundTotals.TotalLoyaltyPointsRefundAmount}}` * `{{RefundTotals.TotalPrice}}` * `{{RefundTotals.TotalProductsRefund}}` * `{{RefundTotals.TotalServiceGestureAmount}}` * `{{RefundTotals.TotalShipping}}` ### Refund Reasons You can add the following refund reasons to the Refund notification template to build a dynamic message for each refund reason. For example, if the refund reason is out of stock, render the out-of-stock message as detailed below. **Out-of-Stock Refund Reason** ``` {{#IsOutOfStockRefundReason}}    {{TR_OutOfStockRefundReason}} {{/IsOutOfStockRefundReason}} ``` **Shipping Cost Refund Reason** ``` {{#IsShippingCostRefundReason}}       {{TR_ShippingCostRefundReason}} {{/IsShippingCostRefundReason}} ``` **No SSD Refund Reason** ``` {{#IsNoSDDRefundReason}} {{TR_NoSDDRefundReason}}         {{/IsNoSDDRefundReason}} ``` **Cancelled Order Refund Reason** ``` {{#IsCancelledOrderRefundReason}}                    {{TR_CancelledOrderRefundReason}} {{/IsCancelledOrderRefundReason}} ``` **Return Refund Reason** ``` {{#IsReturnRefundReason}}            {{TR_ReturnRefundReason}}         {{/IsReturnRefundReason}} ``` **Wrong Item Refund Reason** ``` {{#IsWrongItemRefundReason}}             {{TR_WrongItemRefundReason}}     {{/IsWrongItemRefundReason}} ``` **Missing Item Refund Reason** ``` {{#IsMissingItemRefundReason}}                    {{TR_MissingItemRefundReason}}     {{/IsMissingItemRefundReason}} ``` **Damaged Item Refund Reason** ``` {{#IsDamagedItemRefundReason}}        {{TR_DamagedItemRefundReason}} {{/IsDamagedItemRefundReason}} ``` **Warranty Issue Refund Reason** ``` {{#IsWarrantyIssueRefundReason}}          {{TR_WarrantyIssueRefundReason}}  {{/IsWarrantyIssueRefundReason}} ``` **Lowest Price Guarantee Refund Reason** ``` {{#IsLowestPriceGuaranteeRefundReason}}           {{TR_LowestPriceGuaranteeRefundReason}} {{/IsLowestPriceGuaranteeRefundReason}} ``` **Service Gesture Refund Reason** ``` {{#IsServiceGestureRefundReason}}             {{TR_ServiceGestureRefundReason}}         {{/IsServiceGestureRefundReason}} ``` **Swapped Part Refund Reason** ``` {{#IsSwappedPartRefundReason}}              {{TR_SwappedPartRefundReason}}         {{/IsSwappedPartRefundReason}} ``` **Lost In Transit Refund Reason** ``` {{#IsLostInTransitRefundReason}}              {{TR_LostInTransitRefundReason}}         {{/IsLostInTransitRefundReason}} ``` **Out-Of-Stock Item Refund Reason** ``` {{#IsOutOfStockItemRefundReason}}             {{TR_OutOfStockItemRefundReason}}         {{/IsOutOfStockItemRefundReason}} ``` **Cancelled Pending Payment Refund Reason** ``` {{#IsCancelledPendingPaymentRefundReason}}                {{TR_CancelledPendingPaymentRefundReason}}         {{/IsCancelledPendingPaymentRefundReason}} ``` **Gift Card Redeem Failed Refund Reason** ``` {{#IsGiftCardRedeemFailedRefundReason}}              {{TR_IsGiftCardRedeemFailedRefundReason}}         {{/IsGiftCardRedeemFailedRefundReason}} ``` **Damaged Box Received Refund Reason** ``` {{#IsDamageBoxReceivedRefundReason}}              {{TR_DamageBoxReceivedRefundReason}} {{/IsDamageBoxReceivedRefundReason}} ``` **Damaged Product Received Refund Reason** ``` {{#IsDamagedProductReceivedRefundReason}}            {{TR_DamagedProductReceivedRefundReason}}         {{/IsDamagedProductReceivedRefundReason}} ``` **Item Not Received Refund Reason** ``` {{#IsItemNoReceivedRefundReason}}              {{TR_ItemNoReceivedRefundReason}}         {{/IsItemNoReceivedRefundReason}} ``` **Lost In Shipment Refund Reason** ``` {{#IsLostInShipmentRefundReason}}                {{TR_LostInShipmentRefundReason}}     {{#IsLostInShipmentRefundReason}}     ``` **Missing Item From Order Refund Reason** ``` {{#IsMissingItemFromOrderRefundReason}}             {{TR_MissingItemFromOrderRefundReason}}         {{/IsMissingItemFromOrderRefundReason}} ``` **Other Refund Reason** ``` {{#IsOtherRefundReason}}                  {{TR_OtherRefundReason}}         {{/IsOtherRefundReason}} ``` **Product Out-of-Stock Refund Reason** ``` {{#IsProductOutOfStockRefundReason}}                  {{TR_ProductOutOfStockRefundReason}}         {{/IsProductOutOfStockRefundReason}} ``` **Wrong Item Received Refund Reason** ``` {{#IsWrongItemReceivedRefundReason}}              {{TR_WrongItemReceivedRefundReason}}         {{/IsWrongItemReceivedRefundReason}} ``` **Wrong Price Charged Refund Reason** ``` {{#IsWrongPriceChargedRefundReason}}              {{TR_WrongPriceChargedRefundReason}}         {{/IsWrongPriceChargedRefundReason}} ``` **Lost by Merchant and Refund Refund Reason** ``` {{#IsLostbymerchantandrefundRefundReason}}           {{TR_LostbymerchantandrefundRefundReason}}         {{/IsLostbymerchantandrefundRefundReason}} ``` **Gift Card Redeem Refund Reason** ``` {{#IsGiftCardRedeemRefundReason}}               {{TR_GiftCardRedeemRefundReason}}         {{/IsGiftCardRedeemRefundReason}} ``` **Cancelled By Customer Request Refund Reason** ``` {{#IsCanceledByCustomerRequestRefundReason}}              {{TR_CanceledByCustomerRequestRefundReason}}         {{/IsCanceledByCustomerRequestRefundReason}} ``` ### Currency The following placeholders are supported in all email types. * `{{CurrencyCode}}` * `{{CurrencyName}}` * `{{CurrencySymbol}}` ### Return The following placeholders are included when return information is available. * `{{ReturnId}}` * `{{RMANumber}}` * `{{ReturnDate}}` * `{{ReturnProducts}}` - See the [Return Product](/email-management-transactional-emails#return-product) objects. * `{{TotalProductsRefund}}` * `{{TotalShippingRefund}}` * `{{TotalDutiesRefund}}` * `{{TotalRefund}}` ### Return Product The following placeholders are included when return information is available. * `{{ProductName}}` * `{{ProductCode}}` * `{{UnitSalePrice}}` * `{{ApprovedQuantity}}` * `{{TotalPrice}}` ### Store Info The Store Info placeholders are supported in the following email types: * `OrderReplacementDeliveredToStore` * `OrderDeliveredToStore` **Placeholders:** * `{{Store.Name}}` * `{{Store.Description}}` * `{{Store.Address1}}` * `{{Store.Address2}}` * `{{Store.StateOrProvince}}` * `{{Store.City}}` * `{{Store.Zip}}` * `{{Store.Phone1}}` * `{{Store.Phone2}}` * `{{StoreOpeningHours}}` ### Tracking Info The following placeholders are supported when tracking information is available. * `{{TrackingNumber}}` * `{{TrackingLink}}` ### Example of Placeholders in the Products Section ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e32c429f-2d47-9112-ae01-cf92feed5b2b.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=394f83bfe33a48e6a55b01db68e78913) ### Example of Placeholder Rendering in the Products Section ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-33a58ef5-6e51-982f-2e6f-934817dc3fa8.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=228039d85992530272f08a4141ab2df8) ## Examples and File Formats ### Global‑e Default HTML Template The following table lists all the HTML file and their related TextResource Excel file offered by Global-e. | # | Email Name | HTML File | TextResource Excel File | | - | - | - | - | | 1 | Customer Line Cancellation | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/CustomerLineCancellation.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/CustomerLineCancellation.xlsx) | | 2 | Order Cancelled by Customer | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Customr.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Customr.xlsx) | | 3 | Order Cancelled by Customer - Discontinued Product | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+discontinued+product.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+discontinued+product.xlsx) | | 4 | Order Cancelled by Customer - Fraud Check | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+fraud+check.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+fraud+check.xlsx) | | 5 | Order Cancelled by Customer - Incorrect Address Details | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+Incorrect+Address+Details.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+Incorrect+Address+Details.xlsx) | | 6 | Order Cancelled by Customer - Out of Stock Product | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+out+of+stock+product.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Cancelled+by+Global-e+due+to+out+of+stock+product.xlsx) | | 7 | Order Confirmed | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Confirmed.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Confirmed.xlsx) | | 8 | Order Dispatched | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Dispatched.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Dispatched.xlsx) | | 9 | Order Received | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Received.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Order+Received.xlsx) | | 10 | Partial Shipment | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Partial+Shipment.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Partial+Shipment.xlsx) | | 11 | Refund Notification | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Refund+Notification.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/Refund+Notification.xlsx) | | 12 | RMA Created | [Example](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/RMA+Created.html) | [File](https://global-e-prod-public-static-files.s3.eu-west-1.amazonaws.com/Documentation/GE+Resources/RMA+Created.xlsx) | > [!NOTE] > > If you have the **New Returns Portal** set up, the **RMA Created** email is not configured via the Email Tool. Unlike other transactional emails, this email is managed directly within the Returns Portal. For more details, refer to **Customizing Email Notifications**. ## TextResources (Excel) > [!WARNING] > > By default, the language of all text resources is set to English United Kingdom. In the text resources file, the column **English - United Kingdom** must always contain text in English. This text is used as a basis for the translation to other languages. TextResources are listed in the Text Resources Excel file’s `ResourceKey` column and are preceded by `TR_`. The TextResources Excel file features the following text resource columns: * `ResourceKey` * `ResourceGroupTypeId` * `ResourceGroupReferenceId` * `ResourceMerchantPlatformId` * English United Kingdom (default language) - See Translation. * Translation to Other Languages - See Translation. | **[Click here to download an example of a TextResources file](https://www.global-e.com/wp-content/uploads/2023/11/TextResources.xlsx)** | | - | | | > [!WARNING] > > The column **English - United Kingdom** must always contain text in English. This text is used as a basis for the translation to other languages. | **ResourceKey** | **ResourceGroupTypeId** | **ResourceGroupReferenceId** | **ResourceMerchantPlatformId** | **English – United Kingdom** (**2057**) | Additional Languages | | - | - | - | - | - | - | | `SenderEmail` (Mandatory) | 0 | 0 | 0 | [noreply@global-e.com](mailto:noreply@global-e.com) | Translation | | `SenderName` (Mandatory) | 0 | 0 | 0 | Global‑e | Translation | | `Subject` | 0 | 0 | 0 | Your order is confirmed – order number `{{ORDERID}}` | Translation | | `TR_Disclaimer` | 0 | 0 | 0 | Disclaimer | Translation | | `TR_DutiesAndTaxes` | 0 | 0 | 0 | Duties & Taxes | Translation | | `TR_EmailDirection` | 0 | 0 | 0 | ltr | Translation | | `TR_FOOTTER_SNIPPET` | 0 | 0 | 0 | \ \You have questions ? We are here to help you.\ Do not hesitate to contact our support service by phone or by e-mail via the following link \See our support service\. \ | Translation | | `TR_GlobleEMerchantName` | 0 | 0 | 0 | E-commerce services provided by Global‑e. | Translation | | `TR_OrderConfirmedDescription` | 0 | 0 | 0 | Thanks for shopping at `{{MerchantName}}`. Your order will be processed by Global-e as a merchant of record for this transaction. We are happy to inform you that this order is now confirmed, and we will begin processing your purchase for despatch. Please don’t hesitate to contact us with any Questions \{\{CustomerSupportEmail}} | Translation | | `TR_OrderDiscounts` | 0 | 0 | 0 | Order Discounts | Translation | | `TR_OrderDispatchedDescription` | 0 | 0 | 0 | Hi There! Questions? \Contact us\ | Translation | | `TR_OrderNumber` | 0 | 0 | 0 | Order Number: | Translation | | `TR_OrderPlaced` | 0 | 0 | 0 | Order Placed: | Translation | | `TR_PaymentDetailsText` | 0 | 0 | 0 | Payment Details | Translation | | `TR_PREHEADER` | 0 | 0 | 0 | This is the PreHeader…. | Translation | | `TR_ProductSupport` | 0 | 0 | 0 | Product Support | Translation | | `TR_Qty` | 0 | 0 | 0 | Qty | Translation | | `TR_Salutation` | 0 | 0 | 0 | Dear `{{Firstname}}` | Translation | | `TR_ShipmentDesc` | 0 | 0 | 0 | Once your order has been shipped, we will send you an email, which will include the shipment tracking number for your reference. | Translation | | `TR_ShipmentItemsText` | 0 | 0 | 0 | Shipment Items | Translation | | `TR_Shipping` | 0 | 0 | 0 | Shipping | Translation | | `TR_ShippingDiscount` | 0 | 0 | 0 | Shipping refund | Translation | | `TR_ShippingMethodText` | 0 | 0 | 0 | Shipping Method | Translation | | `TR_StoreSupport` | 0 | 0 | 0 | Store Support | Translation | | `TR_Subtotal` | 0 | 0 | 0 | Subtotal | Translation | | `TR_Total` | 0 | 0 | 0 | Total | Translation | | `TR_YourBillingAddress` | 0 | 0 | 0 | Your billing address: | Translation | | `TR_YourOrderedText` | 0 | 0 | 0 | You Ordered | Translation | | `TR_YourShippingAddress` | 0 | 0 | 0 | Your shipping address: | Translation | # Email Notification Elements Source: https://docs.global-e.com/email-notification-elements Different actions in the returns process trigger different email notifications. The general structure of email notifications is the same across all emails, you can edit the subject and the middle statement in the email body. # Email Notification Elements Source: https://docs.global-e.com/email-notification-elements-701464 Different actions in the returns process trigger different email notifications. The general structure of email notifications is the same across all emails, you can edit the subject and the middle statement in the email body. # Email Notifications Adjustments Source: https://docs.global-e.com/email-notifications-adjustments ## Email Notifications **Shopify and Third-Party Email Notifications** The Global‑e solution allows brands to retain control over their transactional emails by relying on Shopify’s email notifications or any third-party application used for that purpose. As part of the standard Global‑e order flow, the following Shopify email notifications are triggered by the events in Shopify: * Order confirmation * Order cancelled * Order refund * Shipping confirmation Depending on your offering, the following notifications may also be applicable: * Draft order invoice * Gift card created > [!WARNING] > > If you use a third-party app to send emails rather than using the native Shopify emails, make sure to disable the Shopify notifications (otherwise two emails will be sent for each event). > > If you use the notifications natively available in Shopify, make sure that this option is enabled in Shopify. > > For more information, see [https://help.shopify.com/en/manual/orders/notifications/order-notifications?utm_campaign=Guru+Ask\&utm_medium=forums\&utm_source=social#disable-a-notification](https://help.shopify.com/en/manual/orders/notifications/order-notifications?utm_campaign=Guru+Ask\&utm_medium=forums\&utm_source=social#disable-a-notification) **Global‑e Email Notifications** If you are using the Global‑e Returns portal, Global‑e sends the RMA notification email including the Returns documents directly to the customer. ## Include Duties in Your Email Templates The following templates are located under **Shopify Admin > Settings > Notifications**. * Order Confirmation * Order Cancellation * Pending Payment Success * Order Refund To include duties in your email templates, use the following code: ``` {% if current_total_duties or total_landed_cost_additional_fees %} {% assign total_duties_line = 0 %} {% if current_total_duties %} {% assign total_duties_line = total_duties_line | plus: current_total_duties %} {% endif %} {% if total_landed_cost_additional_fees %} {% assign total_duties_line = total_duties_line | plus: total_landed_cost_additional_fees %} {% endif %}

Duties

{{ total_duties_line | money }} {% endif %} ``` To exclude the Taxes line when the amount is 0, adjust your template as shown below: ``` {% if tax_price > 0 %}

Taxes

{{ tax_price | money }} {% endif %} ``` ## Draft Order Invoice Notification Adjust the Draft Order Invoice notification per Merchant to ensure that the invoice: * Does not display a zero value for shipping and taxes * Does display **Calculated at checkout**. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d0593174-acc8-9153-0594-f592b65da0f9.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=182ac97c342fcdce38a6b316e8173c67) If your Draft Order Invoice notification template contains a condition for delivery_method == "pickup', use the snippet below: ``` {% elsif delivery_method == ''%}  

Shipping

Calculated at checkout {% else %} ``` If your Draft Order Invoice notification template does not contain a condition for delivery_method, use this snippet instead, replacing your domestic country code on line 1 where indicated. ``` {% if shipping_address && shipping_address.country_code != '<>' %}

Shipping

Calculated at checkout

Duties & Taxes

Calculated at checkout {% else %} {% endif %} ``` ## Prevent Payment on an Expired Order To prevent a situation in which a customer receives an e-mail to resubmit payment for an expired Global-e order, you must adjust the **Pending Payment error** notification e-mail. The Pending Payment error email can be edited in the Shopify Admin by going to **Settings > Notifications > Customer Notifications > Pending payment error > Edit code**. **Find:** ``` {% capture email_body %} You have not been charged, please try paying for the order again. {% endcapture %} ``` **Replace with:** ``` {% assign gateway_is_globale = false %} {% if order.gateway contains "Global-e" %} {% assign gateway_is_globale = true %} {% endif %} {% if gateway_is_globale %} {% capture email_body %}Your payment couldn't be processed for order {{ order_name }}, please try to reach back to the website and place an order again.{% endcapture %} {% else %} {% capture email_body %}You have not been charged, please try paying for the order again.{% endcapture %} {% endif %} ``` **Find:** ```
Pay now
``` **Replace with:** ``` {% unless gateway_is_globale %}
Pay now
{% endunless %} ``` ## Remove "Total paid today" If you prefer to exclude the “Total paid today” from the order confirmation emails, you can do so by removing the below code block from the notification template. Please note that this code block will appear twice, so you will need to remove both instances. ```

Total paid today

{{ transaction_amount | money_with_currency }} ``` # Email Types Source: https://docs.global-e.com/email-types Global‑e supports many different email types that are sent during the various stages of the order’s lifecycle. The following are the supported email types: ## Order Received The Order Received emails are sent when the order is received but pending authorization. These emails are triggered when the order is flagged for a “fraud check” at checkout or the payment is pending, and the order is not yet confirmed. ### Attachments N/A ### The Email Title Chargeback request received for order number \{orderId} ### The Email Content ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3fcbed29-8041-98a8-b7fb-38113daac31e.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=f011b03d6375733391b26f05e96bf7e9) ## Order Confirmed The Order Confirmed email is sent out once the order is confirmed and payment is authorized. The email is triggered when the order status is changed to: Received by Global‑e. ### Attachments N/A ### The Email Title Order confirmed - \{Merchant Name} by Global‑e - order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d978697d-b577-b324-ce86-059e9ebd2512.jpg?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=ebfac3dda0eba9a72f4cce56b00a1e1e) ## Order Dispatched This email is sent to the customer when the order is dispatched from the hub and picked up by the carrier. This email is triggered once the order status is changed to “Dispatched to Customer”. The status change can happen: 1. Following a manual processing 2. Shipper EOD Manifest 3. Automatic status change based on tracking events ### Attachments The following attachments are added to the email: 1. VAT invoice – for EU internal orders (both merchant and customer are from the EU) and for domestic orders. 2. Customer Receipt – for cross-border orders or outside the EU. * Enabled by default but can be disabled. 1. Commercial invoice – when enabled, for emails outside of the EU. * Disabled by default. ### The Email Title Your order has been shipped! - \{Merchant Name} by Global-e - order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-ae24393c-bffb-4abf-da2b-5dcaed8f503f.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=36757536f51d2b21dc752e94763624b0) ## Order Dispatched Partially This email is sent in case of a split order, when only one or some of the total parcels have been sent to the customer and some are still waiting to be sent. The email is triggered when: for Split orders, where the status of some of the parcels change to “Dispatched to Customer.” 1. A parcel or some of the parcels have been processed manually. 2. Sent in the Shipper EOD manifest. ### Attachments The following attachments are added to the email: 1. VAT invoice – for EU internal orders (both Merchant and customer are from the EU) and for domestic orders. 2. Customer Receipt – for cross-border orders or outside the EU. * Enabled by default but can be disabled 1. Commercial invoice – when enabled, for emails outside the EU. * Disabled by default ### The Email Title One of your packages has been shipped. ### The Email Content ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-f8f97b8d-2335-d64d-6d24-bbd4d6b770e3.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=af3e3ce0f031485b0947c8165c02eec7) ### Last Parcel Notice The ability to send a different email for the last parcel of split orders is supported and can be configured. The email is triggered in case of a split order and one of the following occurs: 1. The final parcel is shipped (when parcel quantity is known) 2. The Entire remaining content is shipped with the parcel. If the email is configured, the Dispatched Partially email is sent to the first parcels and the Last parcel email will be sent to the last parcel. **Comment: Not clear** ## Dispatch Emails with Out-of-Stock Products The ability to display Out of Stock (OOS) products in the dispatch emails ([Dispatched](/email-types#order-dispatched) and [Dispatched Partially](/email-types#order-dispatched-partially)) is available. If configured, the OOS products can be displayed below the order summary section. ### The Behavior 1. A product is identified as OOS during fulfilment. 2. The OOS email is not sent to the customer. 3. The order or parcel is fulfilled and shipped. 4. The dispatched emails are triggered with the OOS element: 1. In case the full order is shipped (single parcel or consolidated shipments) – the element is added to the Order Dispatched email. 2. In case of a split order – the element is added to the Dispatched Partially email. ### The Email Title The same email title set for the original email is used. The title can be modified. ### The Email Content ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-65b0c7c3-99d4-ff23-fe6b-3ac90e2671a7.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=bfa77caca3a75f50d4d889f2fc41eda6) ## No Manifest Parcel Dispatched This email notifies customers that additional parcels were dispatched after a previous parcel was already sent. The email is triggered when a merchant that works with “No Merchant EOD” changes the status of a second parcel (or more) to “Dispatch to Customer”. This happens after the first parcel was already processed and changed to “Dispatch to Customer” and then the second parcel (or more) is also processed. ### Attachments The following attachments are added to the email: 1. VAT invoice – for EU internal orders (both merchant and customer are from the EU) and for domestic orders. 2. Customer Receipt – for cross-border orders or outside the EU. * Enabled by default but can be disabled. 1. Commercial invoice – when enabled, for emails outside the EU. * Disabled by default. ### The Email Title Update about your order - \{Merchant Name} by Global-e - order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cd99aa38-fb10-1e54-db0b-653c97ee1359.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=0d3a8e8403040d18a760e745d312dc2b) ## Order Delivered to Store This email notifies customers that their order has arrived at the store and is ready for collection. This email is triggered when the order status has changed to “Delivered to Store”. ### Attachments The following attachments are added to the email: 1. VAT invoice – for EU internal orders (both merchant and customer are inside the EU) 2. Commercial invoice – when enabled, for emails outside the EU. **Note**: Disabled by default. ### The Email Title Your order is ready for collection. ### The Email Content ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-ce3fec60-667f-0b0a-21ad-fde7032b70ca.jpg?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=0e02edf72f8de6770f6d9ad04040f0e0) ## Parcel Arrived in Destination Country The email is sent to the customer when the parcel is identified as “arrived in the shipping country”. This email is configurable per merchant. The arrival at the destination is identified according to the following logic: A Tracking event previously mapped as “arrived in destination country” for the shipper. ### Attachments N/A ### The Email Title Your order has arrived in the country. ### The Email Content ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1b6b809a-b021-ce17-0e1f-87ff142ef07e.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=6e993fb6b183f968bb9ef4f4cdb4c783) ## Order Cancelled by Customer This email is sent after an order has been cancelled following a customer request. The email is triggered when the order is cancelled on the Merchant Portal by the Global‑e personnel and the reason chosen is “Order cancelled – by customer request email.” ### Attachments N/A ### The Email Title Order Cancellation - \{Merchant Name} by Global‑e - order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a32764d1-6b3d-42e7-a2f1-45cd2b5ef492.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=23879302135052ad7fa73ea651a6bb57) ## Order Cancelled – Unverified Information This email notifies the customer about a cancelled order due to incorrect information provided by the customer. The email is triggered when the order is cancelled on the Global‑e Merchant Portal by the Global‑e personnel and the cancellation reason chosen is “Order Cancelled – unverified information.” ### Attachments N/A ### The Email Title Order Cancellation - \{Merchant Name} by Global‑e - order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-64c9e10f-1b11-dfa8-12b4-ec0f999c4218.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=f2133d1a77734f395c887c71bc5bf138) ## Order Cancelled due to Technical Reasons This email notifies the customer about a cancelled order due to a technical reason. The email is triggered when the order is cancelled on the Global‑e Merchant Portal by the Global‑e personnel and the reason chosen is “Order Cancelled – Tech issue.” ### Attachments N/A ### The Email Title Order Cancellation - \{Merchant Name} by Global‑e - order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-87ef0c39-9760-1e14-3813-b2caeb815edb.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=3e64ed16b6920235b8e2a4bbc8448910) ## Order Cancelled – Discontinued This email notifies the customer about a cancelled order due to a discontinued product. The email is triggered when the order is cancelled on the Global‑e Merchant Portal by the Global‑e personnel and the reason chosen is “Order Cancelled – Discontinued.” ### Attachments N/A ### The Email Title Order Cancellation - \{Merchant Name} by Global‑e - order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cb168bf4-e6a5-41cd-3386-3771971e7cca.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=c6882adc261edec2804ad073cf4fb1f1) ## Order Cancelled Due to Out-of-Stock This email notifies the customer about a cancelled order due to the product being out of stock. The email is triggered when the order is cancelled on the Global‑e Merchant Portal by the Global‑e personnel and the reason chosen is “out of stock email.” ### Attachments N/A ### The Email Title Order Cancellation - \{Merchant Name} by Global‑e - order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-482299d7-488c-9f04-a69d-af15e0aeff7d.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=7b84ebb93590a280f18c0fc767f1a118) ## Order Cancelled – Incorrect Address This email notifies customers about a cancelled order due to incorrect shipping information. This email is triggered when the order is canceled from the Merchant Portal for the following reason: “Cancelled – Incorrect Address”. ### Attachment N/A ### The Email Title Order Cancellation - \{Merchant Name} by Global‑e - order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b5761320-ef90-0631-fbf4-e4d9765ccb4a.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=a08364ff1b8b73885ec9aa9742d25238) ## Order Collection Reminder This email reminds customers to pick up their store orders. If an order is uncollected after a set number of days, the reminder email is triggered. The trigger options include: * **Days After Delivery** **Example:** The merchant sets the reminder to be sent 5 days after the order is delivered to the store. * **Percent of Collection Period** **Example**: The merchant schedules an email reminder to be sent halfway (50%, 4 days) through the collection period (eg. 8 days until marked as uncollected). ### Attachments The following attachments are added to the email: 1. VAT invoice – for EU internal orders (both merchant and customer are inside the EU) 2. Commercial invoice – when enabled, for emails outside the EU. **Note**: Disabled by default. ### The Email Title Your order \{ORDERID} is waiting ### The Email Content ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-94540aca-9df4-5e57-7770-100f02df65f2.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=401ce563e2f84ce3115016901ea4e183) ## Lost by Merchant, Lost by Hub, and Lost by Shipper ### Attachments N/A ### The Email Title Your order lost - \{Merchant Name} by Global-e - order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a6cf55d7-e67b-49c3-1ebd-51206f5bf336.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=beba98da85cba1787d84912f3c7a60f0) ## Out-of-Stock Notification This email notifies customers that at least one product in their order is out of stock (OOS). This email is triggered when: 1. Some products are marked as Out of Stock in the merchant’s manifest. 2. Some products are amended to be OOS on the Merchant Portal. ### Attachments N/A ### The Email Title One of your packages has been shipped. ### The Email Content ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8002bc0b-1800-a432-6648-3547d71a690b.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=34fc097be902862b44dd8d75cae9e3f2) ## RMA Created This email notifies customers that an approved return was created. This email is triggered when a return is created for the product in the return portal. ### Attachments The following attachments are added to the email: 1. Return label 2. Commercial invoice ### The Email Title Return Merchandise Authorisation number \{RMA Number} ### The Email Content ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-97988db5-2079-dc01-0864-32bd80e1491c.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=1493ac76834c0bfd17c7c55cb7ad5657) ## Refund Notification on Returned Products This email notifies customers that a refund was created for specific products. This email is triggered when a refund is created on the Global-e Merchant Portal or via CreateOrderRefundAPI for a product or as a full refund. ### The Email Title Refund Notification - \{Merchant Name} - order number \{GE Order ID} ### Attachments N/A ### The Email Content ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a03e810b-653f-fd8d-f0dc-7c85b6fb6e8f.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=8b024f4a8128c6686567816d40f168c1) ## Refund Notification – No Products These emails are sent to the customer regarding a refund that was approved by customer support personnel, without assigning it to a specific product. The email is triggered when a refund is created for a service gesture or shipping cost without assigning it to a product. ### Attachments N/A ### The Email Title Refund Notification - \{Merchant Name} - order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2f4a9aca-27b6-14bb-cf0e-27b074965c15.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=3aa5b484dbc70a827ddbb3bc3c222ca2) ## Replacement Order Created This email is sent once a replacement order is created on the Merchant Portal: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-7d08a6e3-b73c-5dc3-8e30-5478e2981acd.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=e5808e19e64f1342c93c8dd6fcb57dab) The email is triggered when the replacement process is complete, and the replacement order is created. ### Attachments N/A ### The Email Title Replacement order created - \{Merchant Name} by Global‑e - order number \{Global‑e Replacement Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8eafaf7c-0733-3ec4-e1ac-1c35d50839bc.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=e19e31f592d433cd9504d39195818845) ## Replacement Order Delivered to Store This email notifies the customer that their replacement order has arrived at the store and awaits pickup. The email is triggered when the replacement order status has changed to “Delivered to Store”. ### Attachments The following attachments are added to the email: 1. VAT invoice – for EU internal orders (both merchant and customer are inside the EU) 2. Commercial invoice – when enabled, for emails outside the EU. **Note**: Disabled by default. ### The Email Title Your replacement order is ready for collection. ### The Email Content ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-27b8de3a-43f5-5aa3-0783-e69464fb94d5.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=2a28c2a968101877d2220faede6d98b4) ## Replacement Order Shipped This email is sent when the replacement order is dispatched to the customer. This email is triggered when the replacement status is changed to “Dispatched to Customer”. ### Attachments The following attachments are added to the email: 1. VAT invoice – for EU internal orders (both merchant and customer are inside the EU). 2. Commercial invoice – when enabled, for emails outside the EU. * Disabled by default ### The Email Title Your replacement order has been shipped! - \{Merchant Name} by Global-e - order number \{Global-e Replacement Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-47e7667b-1c14-6a1f-5541-f53935f6bc92.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=d13d76b3fe15502a316a2398525179a8) ## Virtual Goods Order Confirmed This email notifies customers about a confirmed order that includes Virtual Goods only. This email is sent instead of the [Confirmation email.](/email-types#order-confirmed) ### Attachments N/A ### The Email Title Order confirmed - \{Merchant Name} by Global‑e - order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-523ba315-d5f6-f026-8b10-f8cd7b8b4d58.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=2f01280d9d0dc5e3a7dfc1d1dad9829c) ## Customer Details Enquiry This email notifies customers about a pending contact from the Carrier regarding their Order. To clear customs in some countries, additional personal information may be required (such as your ID number or Tax ID). To notify customers about the pending inquiry and make sure the Carrier’s request is not ignored, this email is sent together with the confirmation email. ### Attachments N/A ### The Email Title Additional information required for your order - \{Merchant Name} by Global‑e - order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/uuid-0073a8ca-808a-3ca6-a762-48bb5f073fe8.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=00475a97879aaee766ef6316223e2cef) ## Flash Sale Order Confirmed The Flash Sale Order Confirmed email is sent when the order is confirmed during a Flash sale. The emails are triggered when the order is confirmed and the setting for Flash sale is enabled. ### Attachments N/A ### The Email Title Chargeback request received for order number \{orderId} ### The Email Content ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-86b5fbfa-f322-5057-1717-b742518b59f1.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=344d1616de217a7d6fcadd82033d247e) ## Incorrect Address Query This email notifies customers that the address provided is not identified and requests a correction. The email is triggered manually by the Global‑e operations team. There are 2 types of email templates: 1. Customer email – If Global‑e provides first-line customer support, this email is sent directly to the customer, asking the customer to provide a correct address. 2. Merchant email – if the merchant handles Customer support, the email is sent to the merchant’s customer care team, asking them to contact the customer and get the correct address. ### Attachments N/A ### The Email Title Chargeback request received for order number \{orderId} ### The Email Content – Customer Version ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9b3ada3d-c8e7-6358-416f-1f29b3173234.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=c970eeb8d0bf1f2b1e6efdae29efa7d5) ### The Email Content – Merchant Version ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-af34ef5f-0564-5a7a-4ce3-6e6fe032973d.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=afcc682165e37b4559474e98004318c0) ## Order Received - Bank Transfer This email notifies customers that their order has been received and that the confirmation is pending payment completion via bank transfer as selected on the checkout page. This email is triggered once an order is received, and the selected payment method is “bank transfer”. ### Attachments N/A ### The Email Title Chargeback request received for order number \{orderId} ### The Email Content ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-775f378c-2e3a-e763-1039-1e0a063e3864.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=c32b9242f48776ca9bc216392149ff64) ## Raffle Order Confirmed The Raffle Order confirmed email is sent out once the raffle order is confirmed. The email is triggered when: 1. The order status is changed to: “Received by Global-e” 2. The order includes a single product that holds a MetaData attribute, which is mapped to flag a “raffle product”. This email is branded. ### Attachments N/A ### The Email Title Raffle participation confirmed - \{\{Merchant Name} by Global‑e - order number \{GE Order Id} ### The Email Content ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-62a6b119-2de4-32f2-aced-8bb51705b669.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=548f5f82ca131b85b42d49830242ce3a) ## Chargeback Enquiry This email notifies customers that Global-e was informed about a request for a chargeback, and we enquire about the reason. This email is triggered manually by the Global-e Finance team. This email is not branded. ### Attachments N/A ### The Email Title Chargeback request received for order number \{orderId} ### The Email Content – Customer Version ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4d3ee7e8-729b-4e7b-3812-9d93dde277ac.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=0ef61ab4a41453f3e4cf3be054d11c75) ## Incorrect Phone number This email notifies customers that there is an issue with their phone number and asks them to provide the correct number to the Global-e Customer Support (CS) team. This email is triggered manually by the Global-e CS team. This email is not branded. ### Attachments N/A ### The Email Title Incorrect phone number provided for order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e83b002a-c2f0-06d6-3a28-c09a322fe639.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=6183da3d678497a428fcac1d9db7c11c) ## Incorrect Phone number – Contact Carrier This email notifies customers that there is an issue with their phone number and asks them to provide the correct number directly to the carrier. This email is triggered manually by the Global=-e CS team. This email is not branded. ### Attachments N/A ### The Email Title Incorrect phone number provided for order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8f241329-55ce-f932-8590-b7fa99e4c97b.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=099e25a53109ec10655ecb94915499c8) ## Incorrect Address - Contact Carrier This email notifies the customer that the provided shipping address is not clear. It asks the customer to provide a detailed and accurate shipping address. ### Attachments N/A ### The Email Title \{Merchant Name} by Global-e - order number \{GE Order ID} – ADDRESS ISSUE ### The Email Content ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9173d36f-49b1-0cf9-d7ce-7b0050603451.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=404b629b81f60d00e59f463636a0e75c) ## Personal ID Required This email notifies customers that their personal ID is required to clear their order from customs. This email is triggered manually by the Global-e CS team. This email is not branded. ### Attachments N/A ### The Email Title Personal ID required for order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-240a6676-8007-3f82-3d63-878201d2a4ad.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=5571d99e832ffb88ffbff3e49a6738d4) ## Personal ID Required - Contact Carrier This email notifies customers that their personal ID is required to clear their order from customs and asks them to provide it directly to the carrier. This email is triggered manually by the Global-e CS team. This email is not branded. ### Attachments N/A ### The Email Title Personal ID required for order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d9955dab-2bb3-2315-3572-708c79f3162b.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=fcd1a08ccd22f176d017629539bbe33b) ## KYC Number Required This email notifies customers that their KYC number is required to clear their order from customs and asks them to provide it directly to the carrier. *Comment: Is this a mistake?* This email is triggered manually by the Global-e CS team. This email is not branded. ### Attachments N/A ### The Email Title KYC number is required for order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7321a85c-cbc2-0969-28fe-cd2fdd4edfd5.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=89ecd2ccd5aaf2f331af12a47104c28e) ## KYC Number Required – Contact Carrier This email notifies customers that their KYC number is required to clear their order from customs and asks them to provide it directly to the carrier. This email is triggered manually by the Global-e CS team. This email is not branded. ### Attachments N/A ### The Email Title KYC number is required for order number \{GE Order ID} ### The Email Content ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9173d36f-49b1-0cf9-d7ce-7b0050603451.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=404b629b81f60d00e59f463636a0e75c) ## Failed Refund This email notifies customers that a refund attempt has failed and that their bank details are required. The email is triggered manually by the Global‑e CS team. This email is not branded. ### Attachments N/A ### The Email Title Your requested refund has failed. ### The Email Content ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-65b1c79c-4d29-b362-f25c-d1f6fd73f2d1.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=8cde0dc0c73d942781008732334e1c14) ## Delayed Fulfilment This email notifies customers that their order is delayed due to fulfilment issues. This email is triggered manually by CS team. This email is branded. ### Attachments N/A ### The Email Title Your order has been delayed ### The Email Content ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/uuid-03f2d0b8-5147-b227-365d-3c93706619ed.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=bb48edd222fad840b8456e2ebf07f3bd) ## Coupon Appeasement This email informs customers that the CS team wishes to provide them with a new coupon as a way of appeasement. This email is triggered manually by the Global-e CS team. This email is branded. ### Attachments N/A ### The Email Title You got a free coupon! ### The Email Content ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-bac26bc1-efcf-24de-01ff-9a92604220e8.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=a7d64e169f57b2518ebe475b0e198a40) ## Carrier Delay This email notifies customers that their order is delayed due to issues with the carrier. This email is triggered manually by CS team. This email is not branded. ### Attachments N/A ### The Email Title You order has been delayed. ### The Email Content ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9d8ec357-3bb3-2e64-0a6a-dd1b7e0c8709.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=d361626212c4d7a4b68cc70ba8e46df3) # Enabling Item Validation for Warehouse Workflows Source: https://docs.global-e.com/enabling-item-validation-for-warehouse-workflows Item validation is an optional configuration. It supports automations that trigger on validation and is used for certain workflows, such as restocking. ## To enable item validation for warehouses 1. Navigate to *Settings > General*. 2. Scroll down to near the bottom of the page and expand **Items Validation**. 3. Select the **Document Shipment Content Inspection**. 4. Click the **save icon** in the top right corner. > [!NOTE] > > The **save** icon is only displayed when you change your **Approval Process** selection. # Enforced Policy Eligibility Mode Source: https://docs.global-e.com/enforced-policy-eligibility-mode **Enforced Policy Eligibility mode** requires you to select a policy rule when internally creating an RMA. When doing so you cannot select any combination of resolution, return method, etc., but are limited by set policy rules. The system checks the order for eligibility, and when you create an RMA through the Dashboard you can choose from a list of eligible rules todetermine the return method, resolution, automations, fees, and more. ## Evaluating Eligiblity When you create an RMA from the Dashboard, the system evaluates eligibility in multiple stages. When you open the order that you want to return in the Dashboard, the system checks the following: * Order-level eligibility rules * Customer-level eligibility rules * Item-level eligibility rules After you select the return reason and the specific items, the system checks the following: * RMA-level eligibility rules * Remaining item-level eligibility rules If the RMA does not meet the eligibility criteria at this stage, it will be marked as **Out of Policy**. The system performs a final eligibility check before you submit the RMA. If the selected combination of policy rules does not meet the required conditions, the system prevents the RMA from being created and displays the corresponding error message. ## Creating an RMA in Enforced Policy Eligibility Mode ### To create an RMA in Enforced Policy Eligibility mode 1. From your **Returns Dashboard**, navigate to the **Manage Returns** page. 2. Click **CREATE RMA**. 3. Search for the order by the order number. 4. At the top of the page, review all the order details and customer information. 5. Select an item you want to add to the RMA by clicking on the plus (+) symbol: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8bd67225-13f3-aa87-5f5d-0c49684f4fbe.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=549918c9b68fdc37a2327f662d305f26) 6. In the **ORIGINAL ITEM** region, select the return reason: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-89197b2a-4e98-41a6-e03e-d49fcd0e5afe.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=f9c14f20fe24005fb17c9a8120fd793c) 7. In the **Policy Rule** region, select the return method and resolution: ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e7b1f7f9-aae3-64df-e129-ad65acd74055.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=21166b5ef719d152d8805df174b7a594) 8. In the Add Items to RMA section, click the plus sign at the far-right end of the row corresponding to the item that you want to add to the RMA. 9. The Return Details section shows all the items added to the RMA. You can edit or remove them by clicking on the pencil and trash icons. > [!NOTE] > > Label fees are calculated only after an RMA is created. 10. Review the RMA summary showing the total refund amount, including any fees and adjustments. 11. *Optional*: Add an internal note that will appear on the RMA. 12. Choose whether to send automated customer emails: * Enabling **Send Customer Emails** sends emails as normal according to your email settings. * If you want to refund the customer on the spot, Global-e does not recommend sending the customer all the return emails, in which case you can disable the email. You can also always send specific emails later through the RMA page if you want to send a notification during a manual process. 13. Submit the RMA. 14. The RMA is created and you will be redirected to the relevant RMA, which includes an internal note identifying that it was manually created from the Dashboard. The **Timeline** section also shows which user created the RMA, and store location (if done from a physical store user). > [!NOTE] > > When creating an RMA internally using a custom policy, connected 3PL, WMS, or helpdesk will only be notified if the selected policy rule is set to notify the integrations. # Enforced Policy Eligibility Mode Source: https://docs.global-e.com/enforced-policy-eligibility-mode-702676 **Enforced Policy Eligibility mode** requires you to select a policy rule when internally creating an RMA. When doing so you cannot select any combination of resolution, return method, etc., but are limited by set policy rules. The system checks the order for eligibility, and when you create an RMA through the Dashboard you can choose from a list of eligible rules todetermine the return method, resolution, automations, fees, and more. ## Evaluating Eligiblity When you create an RMA from the Dashboard, the system evaluates eligibility in multiple stages. When you open the order that you want to return in the Dashboard, the system checks the following: * Order-level eligibility rules * Customer-level eligibility rules * Item-level eligibility rules After you select the return reason and the specific items, the system checks the following: * RMA-level eligibility rules * Remaining item-level eligibility rules If the RMA does not meet the eligibility criteria at this stage, it will be marked as **Out of Policy**. The system performs a final eligibility check before you submit the RMA. If the selected combination of policy rules does not meet the required conditions, the system prevents the RMA from being created and displays the corresponding error message. ## Creating an RMA in Enforced Policy Eligibility Mode ### To create an RMA in Enforced Policy Eligibility mode 1. From your **Returns Dashboard**, navigate to the **Manage Returns** page. 2. Click **CREATE RMA**. 3. Search for the order by the order number. 4. At the top of the page, review all the order details and customer information. 5. Select an item you want to add to the RMA by clicking on the plus (+) symbol: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8bd67225-13f3-aa87-5f5d-0c49684f4fbe.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=549918c9b68fdc37a2327f662d305f26) 6. In the **ORIGINAL ITEM** region, select the return reason: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-89197b2a-4e98-41a6-e03e-d49fcd0e5afe.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=f9c14f20fe24005fb17c9a8120fd793c) 7. In the **Policy Rule** region, select the return method and resolution: ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e7b1f7f9-aae3-64df-e129-ad65acd74055.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=21166b5ef719d152d8805df174b7a594) 8. In the Add Items to RMA section, click the plus sign at the far-right end of the row corresponding to the item that you want to add to the RMA. 9. The Return Details section shows all the items added to the RMA. You can edit or remove them by clicking on the pencil and trash icons. > [!NOTE] > > Label fees are calculated only after an RMA is created. 10. Review the RMA summary showing the total refund amount, including any fees and adjustments. 11. *Optional*: Add an internal note that will appear on the RMA. 12. Choose whether to send automated customer emails: * Enabling **Send Customer Emails** sends emails as normal according to your email settings. * If you want to refund the customer on the spot, Global-e does not recommend sending the customer all the return emails, in which case you can disable the email. You can also always send specific emails later through the RMA page if you want to send a notification during a manual process. 13. Submit the RMA. 14. The RMA is created and you will be redirected to the relevant RMA, which includes an internal note identifying that it was manually created from the Dashboard. The **Timeline** section also shows which user created the RMA, and store location (if done from a physical store user). > [!NOTE] > > When creating an RMA internally using a custom policy, connected 3PL, WMS, or helpdesk will only be notified if the selected policy rule is set to notify the integrations. # EOD Examples Source: https://docs.global-e.com/eod-examples This page shows the following EOD examples: * [Example 1](/eod-examples#example-1-single-parcel-order-with-all-items-in-stock): Single parcel order with all items in stock * [Example 2](/eod-examples#example-2-multi-parcel-order-with-all-items-in-stock): Multi-parcel order with all items in stock * [Example 3](/eod-examples#example-3-split-multi-parcel-order-with-all-items-in-stock): Split multi-parcel order with all items in stock * [Example 4](/eod-examples#example-4-multi-parcel-order-with-some-items-out-of-stock): Multi-parcel order with some items out of stock * [Example 5](/eod-examples#example-5-split-multi-parcel-order-with-some-items-out-of-stock): Split multi-parcel order with some items out of stock * [Example 6](/eod-examples#example-6-split-multi-parcel-order-with-some-items-out-of-stock-with-exceptions): Split multi-parcel order with some items out of stock with exceptions * Example 7: * Example 8: * Example 9: * Example 10: * Example 11: ## Example 1: Single Parcel Order with All Items in Stock ### Description This example describes a single parcel order when all items are in stock. In this example the customer has purchased the following products: * **SKU 1** – quantity 1 * **SKU 2** – quantity 1 * **SKU 3** – quantity 1 ### Shipping Scenario The following describes the shipping scenario for this example: ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b036984b-80bc-448b-7158-b027ca528168.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=bd709bf90f65127adb842eedddf59ba2) 1. All the items are sent in one parcel, P1. 2. The order is marked as completed and is dispatched to the customer on arrival at the Global-e hub. ## Example 2: Multi-Parcel Order with All Items in Stock ### Description This example describes a multi-parcel order when all items are in stock. In this example the customer has purchased the following products: * **SKU 1** – quantity 1 * **SKU 2** – quantity 1 * **SKU 3** – quantity 1 ### Shipping Scenario The following describes the shipping scenario for this example: 1. All the items are sent in one parcel, P1 and P2. 2. The order is marked as completed and is dispatched to the customer on arrival at the Global-e hub. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9ddb81e9-4419-5726-b068-f1af93d0799f.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=d599cac9620c0fd82e7072a235f2c945) ## Example 3: Split Multi-Parcel Order with All Items in Stock ### Description This example describes a split multi-parcel order when all items are in stock. In this example the customer has purchased the following products: * **SKU 1** – quantity 1 * **SKU 2** – quantity 3 * **SKU 3** – quantity 1 * **SKU 4** - quantity 2 ### Shipping Scenario The following describes the shipping scenario for this example: 1. Two parcels, P1 and P2, arrive on the first day and the order is marked as incomplete. 2. The Global-e hub processes the parcels and puts them in Holding Area 2. 3. The following day, parcel P3 arrives. The parcel is processed, the hub operator is notified and collects the on-hold parcels. 4. All three parcels are dispatched to the customer. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7c13225e-5518-4b99-cd0a-ea514debc34a.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=0784cd6e8f15494b80e4973bb53d7e7e) ## Example 4: Multi-Parcel Order with Some Items out of Stock ### Description This example describes a multi-parcel order when some items are out of stock. In this example the customer has purchased the following products: * **SKU 1** – quantity 1 * **SKU 2** – quantity 3 ### Shipping Scenario The following describes the shipping scenario for this example: 1. Two parcels, P1 and P2, arrive and the order is flagged as completed. 2. Product SKU 2 shows that only two out of three items were shipped. However, because the order is flagged as completed, the manifest processor treats the third item of SKU 2 as **Stock Not Available (SNA)**: * The customer is notified and refunded. * The export documentation is amended. * The parcels are dispatched to the customer on the same day. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9bcd5170-8499-0735-7f61-fac2d7cf0dc3.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=f36c84192f6708644884807d129b9b87) ## Example 5: Split Multi-Parcel Order with Some Items out of Stock ### Description This example describes a split multi-parcel order when some items are out of stock. In this example the customer has purchased the following products: * **SKU 1** – quantity 1 * **SKU 2** – quantity 3 ### Shipping Scenario The following describes the shipping scenario for this example: ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7032e227-c096-ade6-81c0-300aa13856dd.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=f29276aaed3f90416a1dc497fe6320f5) 1. Two parcels, P1 and P2, arrive and the order is flagged as incomplete. 2. Product SKU2 shows that only 1 item out of the ordered 3 are shipped. 3. The Global-e hub processes the parcels and puts them in Holding Area 3. 4. The following day parcel P3 arrives, and the order is flagged as completed, however, product SKU2 only shows 1 additional item. This parcel is processed and: * The customer is notified and refunded for one item of SKU2 which is out of stock. * The export documentation is amended accordingly. * The hub operator is notified of additional parcels in the holding area and collects the on-hold parcels. All three parcels are dispatched to the customer. ## Example 6: Split Multi-Parcel Order with Some Items out of Stock with Exceptions ### Description This example describes a split multi-parcel order when some items are out of stock, with some exceptions. In this example the last item is SNA indefinitely. In this example the customer has purchased the following products: * **SKU 1** – quantity 1 * **SKU 2** – quantity 3 ### Shipping Scenario The following describes the shipping scenario for this example: 1. Two parcels, P1 and P2, arrive and the order is flagged as incomplete. Product SKU2 shows that only 2 out of 3 items were shipped. 2. The Global-e hub processes the parcels and puts them in the holding area. 3. The following day, the Merchant realizes that the third item of SKU2 is not being put back in stock and will never be fulfilled. 4. The Merchant notifies Global-e via the manifest by sending the missing item with quantity 0, triggering the following actions: * The customer is notified and refunded for one item of SKU2 which is out of stock. * The export documentation is amended accordingly. * A notification is sent to the hub operators to collect the parcels in the holding area and dispatch them to customers. > [!NOTE] > > It is important to immediately notify Global-e if an item cannot be fulfilled to avoid longer waiting periods for parcels in the holding area and compromising customer delivery promises. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-ca53ec16-87c5-2335-999a-46ba142eba0f.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=abeaf3bed54d5d5e886f19519940dc2e) ## Example 7: All Orders are SNA and Cannot be Fulfilled ### Description This example describes a scenario where all orders are SNA and cannot be fulfilled, and a notification is sent to Global-e through the manifest to update and refund the customer. In this example the customer has purchased the following products: * **SKU 1** – quantity 1 * **SKU 2** – quantity 1 ### Shipping Scenario The following describes the shipping scenario for this example: 1. Both products are out of stock so the Merchant sends Global-e a notification with Is Completed flag set to 1 (order is completed). 2. The parcel codes are missing (since nothing is actually being shipped) and quantities show 0. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-31b2a77b-93d6-e960-da46-3bea30f4a646.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=02dc0718f77e43f9178502b5ad6c4d92) > [!NOTE] > > In this situation, merchants do not need to notify Global-e through the EOD manifest if they send an Order Status Update notification via API. Contact your account manager or Technical Support if you are unsure if the Order Status Update API is implemented for your store. **Example 7: SNA exception – all of the order items are SNA and will never be fulfilled** In a situation where all of the order items are out of stock and will not be fulfilled, a notification is sent to Global-e through the manifest so that the customer can be updated and refunded. A customer has purchased the following products: * SKU 1 – quantity 1 * SKU 2 – quantity 1 **The shipment scenario:** Both products are out of stock so the Merchant sends Global-e a notification with Is Completed flag set to 1 (order is completed). The parcel codes are missing (since nothing is actually being shipped) and quantities show 0. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-61485c74-11a3-8184-bb40-0cf7bf2d2eca.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=806ef339f01e114bb71b70df4b4159da) > [!NOTE] > > In this situation, Merchants do not need to notify Global-e through the EOD manifest if they send an Order Status Update notification via API. > > Contact your Account Manager or Technical Support if you are unsure if the Order Status Update API is implemented for your store. **Example 8: Order with backordered items** A customer has purchased the following products: * SKU 1 – quantity 5 **The shipment scenario:** While fulfilling the order, 3 items are available while 2 are out of stock but can be fulfilled within a few weeks. One parcel arrives at the hub. The manifest shows the order is incomplete and additional items will be fulfilled later on. The parcel is dispatched to the customer on the same day. Once the additional items arrive, the order is marked as complete. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c0561997-e734-b0eb-1dd6-75ac92ffc118.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=0718bc1527e66944f5065c56151a10bd) In X days, when one of the backordered items is available in stock, the Merchant sends an updated line. Note: When an item is no longer backordered – the flag is changed accordingly (Is Backorder = 0) and the date is removed. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8108888e-7520-b1f7-d7c5-19ef56ce384a.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=981b469b71dda170c6aa3780cfa49ac5) In additional X days the order is fully completed, Is Order completed flag = 1: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1d5a0b7b-a828-18dd-98cc-28c70bace3a4.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=f5944f7f3917fef4d5f9bf480edf1fc3) **Example 9 Split multi-parcel order with backordered items and out of stock items** A customer has purchased the following products: * SKU 1 – quantity 2 * SKU 2 – quantity 1 * SKU 3 – quantity 3 **The shipment scenario:** 1. One parcel, P1, is received at the hub with SKU 1. The order is marked as incomplete and some of the items are marked as backordered. 2. The P1 parcel is processed and dispatched to the customer. The customer is notified of the backordered items. 3. The following day, the P2 parcel arrives at the hub with SKU 2 item. The order is still incomplete. 4. In x days, the backordered items arrive at the hub in parcel P3. The order is marked as completed. The manifest processor: * Recognizes that one of the items (SKU3) is missing. * Refunds the customer and amends export documents for parcel P3. * Dispatches the parcel to the customer. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-83931fde-de3c-edce-23f2-c03029ef6e62.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=15fd54913de344dfe3002f3be417c2f1) **Example 10: Backorder Exception - all items order items are backordered** A customer has purchased the following products: * SKU 1 – quantity 1 * SKU 2 – quantity 2 **The shipment scenario:** While fulfilling the order the Merchant realizes that all of the items are backordered. Though no items are being shipped physically to the hub, the Merchant notifies Global-e of the backordered items via the manifest, so that the customer can be updated. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-946dea2d-870b-4988-21e4-aa4db3b92f12.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=49819be31003b89178679a6e9d1718a8) ## Example 1: Single Parcel Order with All Items in Stock ### Description This example describes a single parcel order when all items are in stock. In this example the customer has purchased the following products: * SKU 1 * SKU 2 * SKU 3 - quantity 1 ### Shipping Scenario The following describes the shipping scenario for this example: # EOD Manifest Source: https://docs.global-e.com/eod-manifest-sdk-api The End of Day (EOD) manifest includes information on items and parcels shipped by Merchants on a given day. This form allows the timely and correct processing of parcels in the Global-e hub or Merchant’s warehouse. An EOD manifest is required for Merchants that send multi-parcel orders or to issue reorders (back-ordered items). Global-e uses the EOD manifest to: * Create relevant Airway bills (AWB) and export documentation for all parcels. * Automatically amend out-of-stock items. * Notify Merchants shipping via Global-e of the number of parcels on the way and their unique identifier codes so they can be scanned and processed upon arrival. # EU Consumer Guarantee Information (Notice & GARAN) Source: https://docs.global-e.com/eu-consumer-guarantee-notice-and-garan ## Overview From **27 September 2026**, EU rules ([Directive - EU - 2024/825 - EN - EUR-Lex](https://eur-lex.europa.eu/eli/dir/2024/825/oj)) require online traders selling goods to EEA consumers (EU + Norway, Iceland and Liechtenstein) to provide clearer information about **legal guarantee rights** and, for qualifying products, a **producer commercial guarantee of durability** (free, covering the whole product, lasting **more than two years**). The regulation requires this information in **two places**: 1. **On your EEA-facing website** — the harmonised legal guarantee notice as a **prominent reminder** on the storefront; for qualifying products, the **GARAN label** before purchase (for example on the **product page / PDP**). 2. **In the order confirmation email** — on a **durable medium** (for example, an attached PDF), so the shopper receives the harmonised notice and any qualifying GARAN labels after they buy. From **27 September 2026**, where **Global-e sends** the order confirmation email, Global-e meets the **confirmation-email** part of the regulation on qualifying EEA goods orders (by shipping address). We attach the following on a **durable medium** (PDF): * **Harmonised legal guarantee notice** — official English Commission artwork. Attached **by default**; contact your CSM to **disable** harmonised notice attachment on confirmation emails. * **GARAN label** — when GARAN attachment is **enabled** for your account (contact CSM) and you have supplied a valid `GaranImageURL` per relevant line item (your PNG, converted to PDF).\ No URL for a line item = no GARAN attachment for that item. Global-e will add a link to the harmonised notice on **Terms of Sale (TOS)** for all platforms (inc. Shopify). > [!NOTE] > > **Important:** Steps **1–2** and **Sections A–B** below apply where **Global-e sends** the order confirmation email. > > **Shopify merchants:** Global-e does **not** send that email — Shopify does. See [**Shopify merchants**](/eu-consumer-guarantee-notice-and-garan#shopify-merchants) for full implementation guidance. ## Who needs to do what | Responsibility | Who | | - | - | | Harmonised notice on your **website** (prominent reminder) | **Merchant** — we **highly recommend** prominent on-site placement even though Global-e adds a link in TOS | | Link to harmonised notice in **Terms of Sale (TOS)** | **Global-e** — will add a link to the harmonised notice on Terms of Sale (TOS) for all platforms (inc. Shopify) | | Create the **GARAN** for every **relevant product** (see [GARAN file requirements (PNG)](/eu-consumer-guarantee-notice-and-garan#garan-file-requirements-png)) | **Merchant** | | **GARAN** on your website before purchase (for example on the **product page / PDP**) where the product qualifies | **Merchant** | | Providing a valid link (GaranImageURL) to an English GARAN per relevant product\* | **Merchant** | | Harmonised notice + GARAN in **confirmation email** (durable medium) | **Global-e** — **Harmonised notice:** attached by default on qualifying GE-sent emails (disable via CSM). **GARAN:** enable via CSM; per line item when a valid `GaranImageURL` is supplied. | | Enabling GARAN attachment on confirmation emails | **Merchant** — contact CSM | | Disabling harmonised notice attachment on confirmation emails (optional) | **Merchant** — if you don't want the notice to be sent, disable it by contacting CSM | \* **Relevant product (for GARAN data):** a product where the producer offers a **free** commercial guarantee of durability that covers the **whole product** and lasts **more than 2 years**. You do not need to send GARAN data for products that do not qualify. **GARAN in the confirmation email:** If functionality was enabled, for each line item, **if you have supplied a valid** `GaranImageURL`, we attach the GARAN. Products without a URL are sent without a GARAN attachment for that item only. ## Official artwork — examples Use the **official Commission** assets. Do not redesign. [Commission download pack](https://commission.europa.eu/publications/practical-guidelines-and-high-resolution-vector-files-eu-notice-and-label-product-guarantees_en). On-Site digital display examples can be found [here](https://commission.europa.eu/document/download/3e4dbee6-8184-4256-923d-c52551c7e9f0_en?filename=Practical%20guidelines%20Harmonised%20Label%26Notice%20product%20guarantees_ARES%2027042026.pdf). ### Harmonised notice (English) Global-e attaches this artwork on every qualifying confirmation email **by default from 27 September 2026**, unless harmonised notice attachment is disabled for your account. ![The official European Commission harmonised legal guarantee notice, in English.](https://mintcdn.com/globale-enterprise/Wb7OHMoDPGqpYYED/images/eu-consumer-guarantee/harmonised-notice-en.png?fit=max\&auto=format\&n=Wb7OHMoDPGqpYYED\&q=85\&s=5430c3086ae8d35cbee7408e8598821a) ### GARAN label — filled example Illustrative only (use the template as is and update years · brand · model per product). brand and model should be written in English. You must supply your own finished **PNG** at `GaranImageURL` for each qualifying product. ![The official Commission GARAN durability label, filled in with example years, brand and model.](https://mintcdn.com/globale-enterprise/Wb7OHMoDPGqpYYED/images/eu-consumer-guarantee/garan-label-filled-example.png?fit=max\&auto=format\&n=Wb7OHMoDPGqpYYED\&q=85\&s=cf55c8b433e8543aa0ba20e253014683) ### GARAN file requirements (PNG) For each relevant product, prepare a finished **GARAN** PNG that: * GARAN label should be a **color PNG** * **Physical size:** at least **95 × 100 mm** * **Image resolution:** at least **300 DPI**, which at that minimum size means at least **1122 × 1181 pixels**. Do not supply a smaller pixel canvas and scale it up * **Keep the official GARAN artwork unchanged:** no distortion, cropping that changes layout, colour shifts, or change of proportions * **Keep the QR code unchanged** (content, module pattern, quiet zone). At \~25 × 25 mm and 300 DPI the QR area is about **295 × 295 pixels** * **QR encoding:** at least **4 pixels per module** so it stays scannable. The sample GARAN (QR Version 5) is about 6 px/module; 300 DPI at 95 × 100 mm is intended for QR Version 9 or lower * The **QR code must remain scannable** in normal lighting with a standard phone camera ## Before you begin — checklist | Check | Detail | | - | - | | GE sends confirmation email? | Required for this GE feature. **Not applicable for Shopify** — Shopify sends confirmation. | | Harmonised notice | **Email attachment:** on by default from **27 September 2026** — no action unless you want to **disable** harmonised notice attachment (contact CSM). | | GARAN file format | PNG only. Global-e downloads the file from your provided URL, converts it to PDF, and attaches the PDF in the email. | | Official artwork | Use the **official Commission GARAN** artwork for each product (years · brand · model on the label). Do not redesign. | | Harmonised notice (website and TOS) | **Website:** you remain responsible for prominent placement — we **highly recommend** this even though Global-e will add a link to the harmonised notice on **Terms of Sale (TOS)** for all platforms (inc. Shopify). | ## Step 1 — Default email behaviour and GARAN ### Harmonised notice (default) From **27 September 2026**, Global-e **automatically attaches** the official English harmonised notice (PDF) on every qualifying GE-sent EEA goods confirmation email (EEA by shipping address). **Disable:** contact your **Customer Success Manager (CSM)** if you wish to disable harmonised notice attachment on your confirmation emails. This does **not** remove the harmonised notice link from **Terms of Sale (TOS)**. ### GARAN (merchant-supplied) **Enable:** GARAN attachment is **not enabled by default**. Contact your **Customer Success Manager (CSM)** to enable GARAN attachment on your confirmation emails. **GARAN will be sent for a line item only when** GARAN attachment is enabled for your account and Global-e has received a valid `GaranImageURL` (PNG) for that product. We download the file, convert it to PDF, and attach it to the confirmation email. Line items without a valid URL are sent without a GARAN attachment for that product only. The harmonised notice is still attached on that email unless harmonised notice attachment is disabled for your account. ## Step 2 — Supply GARAN image URLs per relevant product You can provide `GaranImageURL` using one of the following methods: | Method | When to use | Field | | - | - | - | | **A - Catalog** | Product master data is synced to Global-e catalog / products table | `GaranImageURL` on the product | | **B - SendCart** | Attributes are passed on each cart / order | `SendCartData.Products[].GaranImageURL` per line item | Choose the method that fits your integration. ### GARAN URL requirements | Requirement | Detail | | - | - | | **URL** | Publicly reachable HTTPS URL to the finished GARAN image for that product | | **File type** | **PNG only** — see [GARAN file requirements (PNG)](/eu-consumer-guarantee-notice-and-garan#garan-file-requirements-png) | | **Content** | Official Commission GARAN label, filled for that product (years, brand/trademark, model). Design preserved; QR scannable | | **GE behaviour** | Global-e downloads the PNG at email send time, converts to **PDF**, and attaches the PDF to the confirmation email | | **No URL for this line item** | That line item is sent **without** a GARAN attachment. Other line items with a valid URL still receive GARAN. The harmonised notice is still sent **unless you requested to disable this capability** for your account | ## Section A - Catalog: `GaranImageURL` **Applies to:** Merchants who maintain product data in Global-e catalog (or products table) and want GARAN resolved **by SKU** at email send time. ### What to add Add a product-level attribute: | Attribute | Type | Description | | - | - | - | | `GaranImageURL` | URL (string) | Link to the **PNG** file of the official GARAN label for this product | Set `GaranImageURL` only on **relevant products** (free producer commercial guarantee of durability > 2 years, whole product). ## Section B - SendCart: `SendCartData.Products[].GaranImageURL` **Applies to:** Merchants / integrators who pass product attributes on the cart for each order. ### What to add For each **qualifying line item** in the SendCart payload, populate: ``` SendCartData.Products[].GaranImageURL ``` | Field | Type | Description | | - | - | - | | `GaranImageURL` | URL (string) | Link to the **PNG** file of the official GARAN label for this line item / product | Omit the field (or send empty) for line items that do not qualify. Global-e will not attach GARAN for those items. ## Platform-specific instructions **Applies to:** Merchants using **Section A (Catalog)** or **Section B (SendCart)** who need platform-specific setup guidance. Step-by-step guides for supplying `GaranImageURL` per platform: | Platform | Guide | | - | - | | PrestaShop | [EU Consumer Guarantee — PrestaShop](/eu-consumer-guarantee-setup-prestashop) | | WooCommerce | [EU Consumer Guarantee — WooCommerce](/eu-consumer-guarantee-setup-woocommerce) | | BigCommerce | [EU Consumer Guarantee — BigCommerce](/eu-consumer-guarantee-setup-bigcommerce) | | Centra | [EU Consumer Guarantee — Centra](/eu-consumer-guarantee-setup-centra) | | Magento 2 Lite | [EU Consumer Guarantee — Magento 2 Lite](/eu-consumer-guarantee-setup-magento2-lite) | | Magento 2 Full | [EU Consumer Guarantee — Magento 2](/eu-consumer-guarantee-setup-magento2) | | Shopware 6 | [EU Consumer Guarantee — Shopware 6](/eu-consumer-guarantee-setup-shopware) | | Hybris | [EU Consumer Guarantee — Hybris (SAP Commerce)](/eu-consumer-guarantee-setup-hybris) | | SFCC | [EU Consumer Guarantee — Salesforce B2C Commerce (SFCC)](/eu-consumer-guarantee-setup-sfcc) | | Wix | Link to platform guide — coming soon | | Bespoke Global-e Module | [EU Consumer Guarantee — Bespoke Global-e Module](/eu-consumer-guarantee-setup-global-e-module) | | Shopline | Link to platform guide — coming soon | Contact your CSM if your platform is not listed yet. ## Shopify merchants **Shopify merchants:** Global-e does **not** send Shopify order confirmation emails — Shopify does. **Step 1**, **Step 2**, and **Sections A–B** above apply only where **Global-e sends** the confirmation email. If you are on Shopify, follow this section instead. ### What Global-e does for Shopify | What | Who | | - | - | | Link to harmonised notice in **Terms of Sale (TOS)** | **Global-e** — will add a link to the harmonised notice on Terms of Sale (TOS) for all platforms (inc. Shopify) | | Harmonised notice + GARAN in **Shopify** order confirmation email | **Merchant** — see [Shopify implementation guide](/eu-consumer-guarantee-setup-shopify) below | | Harmonised notice on **website** (prominent reminder) | **Merchant** — we **highly recommend** prominent on-site placement | | Create **GARAN PNG** per relevant product | **Merchant** — see [GARAN file requirements (PNG)](/eu-consumer-guarantee-notice-and-garan#garan-file-requirements-png) | | **GARAN** on your website before purchase (for example on the **product page / PDP**) where the product qualifies | **Merchant** | ### Shopify implementation guide [Shopify implementation guide](/eu-consumer-guarantee-setup-shopify) ## Your storefront obligations (not configured in this guide) Even when Global-e handles confirmation emails, **you** remain responsible for: 1. Displaying the official **harmonised legal guarantee notice** prominently on your EEA-facing website. Regulatory wording (Directive 2024/825, Recital 28): *in cases of online sale, placed as a general reminder on the website of the trader selling goods.* Global-e will add a link to the harmonised notice on **Terms of Sale (TOS)** for all platforms (inc. Shopify). The TOS link supports compliance but **does not replace** prominent on-site placement — we **highly recommend** you still display the notice prominently on your storefront. **Shopify merchants:** see [**Shopify merchants**](/eu-consumer-guarantee-notice-and-garan#shopify-merchants) for full implementation guidance. 2. Showing the **GARAN label** for each qualifying product **before purchase** (for example on the product page / PDP), where applicable. Official EU assets and guidelines: [Commission practical guidelines + download pack](https://commission.europa.eu/publications/practical-guidelines-and-high-resolution-vector-files-eu-notice-and-label-product-guarantees_en). ## Testing checklist Run at least one end-to-end test on a sandbox or low-volume EEA market **after** GARAN data setup: | Check | Done | | - | - | | Harmonised notice on test EEA order **without** merchant disable action | ☐ | | Disable test (if applicable): notice **not** attached after CSM disables harmonised notice attachment | ☐ | | Test order: **EEA shipping address**, goods, **GE sends** confirmation email | ☐ | | Confirmation email includes **harmonised notice** attachment (PDF) | ☐ | | Qualifying line item with valid `GaranImageURL` (PNG): **GARAN** attached as PDF | ☐ | | Line item **without** `GaranImageURL`: **no** GARAN; notice still present | ☐ | | Non-EEA shipping address: notice/GARAN behaviour matches expectation (no EEA obligation) | ☐ | | GARAN URL returns valid **PNG** (not JPG/SVG/PDF at source URL) | ☐ | ## Frequently asked questions ### About the regulation > [accordion] What is ECGT? > > Directive (EU) 2024/825, "Empowering Consumers for the Green Transition" — also called EmpCo. It is an amending directive: it does not stand alone, it rewrites parts of two existing pillars of EU consumer law, the Unfair Commercial Practices Directive (UCPD) and the Consumer Rights Directive (CRD). > [accordion] What is it trying to do? > > Two things. First, stamp out greenwashing by banning a list of environmental claims outright. Second, make sure shoppers are told, before they buy, about the guarantee that applies to the goods, how long the product is expected to last, and whether it can be repaired. > [accordion] Which merchants are affected? > > Any trader selling goods to consumers in the EEA (EU + Norway, Iceland and Liechtenstein). > [accordion] Does it apply to merchants based outside the EU? > > Yes. The test is whether commercial activity is directed at EEA consumers, not where the seller is established. > [accordion] What is the legal guarantee notice? > > A standardised notice, designed by the Commission, reminding shoppers that they have a minimum two-year legal guarantee if goods turn out to be defective. It applies to all goods sold to EEA consumers. It is a general reminder, not a per-product element. > [accordion] What is the GARAN label? > > A standardised label shown where the producer offers a commercial guarantee of durability that covers the whole product, at no extra cost, for more than two years — and has actually given that information to us. All four conditions must be met. It shows the guarantee duration alongside a reminder of the legal guarantee. > [accordion] Does showing one replace the other? > > No, as they cover different rights: the notice is about the statutory guarantee for defective goods, the GARAN label is about a voluntary producer guarantee on how long the product lasts. Where both apply, both are shown. > [accordion] Does this regulation require me to start offering new guarantees on my products? > > No. The regulation is about **informing** shoppers about rights and commitments that already apply — not creating new ones. The **harmonised notice** reminds shoppers of the **statutory legal guarantee** that already exists for all goods sold to EEA consumers. **GARAN** applies only where the **producer** has already chosen to offer a **free commercial durability guarantee** covering the whole product for **more than two years**, and has given you that information. If you do not have such a producer guarantee on a product today, you are not being asked to invent one. > [accordion] What do the harmonised notice and GARAN cover — and how are they different? > > The **harmonised notice** relates to the **legal guarantee of conformity**: goods must not be faulty, unsafe, or unfit for normal use **when delivered** — including manufacturing faults, mismatch with description, and defects that existed at delivery even if they appear later. It does **not** cover wear and tear, accidental damage, or misuse after delivery. It is **not** a separate right to return goods or a promise of how long a product will last in ordinary use. > > **GARAN** reflects a **voluntary producer durability guarantee** beyond the two-year legal minimum: the product should **keep working as intended** for the stated period. The same exclusions apply (wear and tear, accidental damage, misuse). It does **not** apply by default to every sale — only where the producer has already disclosed such a commitment. In practice, GARAN is likely to be **more common** for long-life or luxury products (for example watches) and **less common** for categories such as apparel. If a product does not qualify, you do not need to supply GARAN data for it. > [accordion] Who produces the artwork? > > The Commission publishes both designs, in colour and black-and-white, under Implementing Regulation (EU) 2025/1960 — use the colour version for online display. For the GARAN label, only three fields may be changed — guarantee duration, brand or producer, and model. Everything else, including the multilingual strip along the bottom, stays exactly as issued and must not be cropped. > [accordion] Does it need translating for each market? > > No. The GARAN label already carries a multilingual strip covering all EU official languages. For the notice, one official language version — the Commission's English file — is acceptable across every market. > [accordion] Where does the legal guarantee notice go? > > Prominently somewhere on the storefront — a dedicated information section, a footer link, or a banner. It is a website-level reminder, not a checkout step, and it must be readable on both desktop and mobile. > > Global-e will add a link to the harmonised notice in **Terms of Sale (TOS)** including Shopify's. We **highly recommend** you still display the notice prominently on your storefront. > [accordion] Where does the GARAN label appear? > > On your website before purchase — for example on the product page or product catalogue. It will also be provided to the shopper upon purchase, as part of the confirmation email. > [accordion] What about the order confirmation email? > > Where Global-e sends the confirmation email: the harmonised notice is attached by default from 27 September 2026 (unless harmonised notice attachment is disabled for your account). GARAN is attached for qualifying products when GARAN attachment is enabled and you supply `GaranImageURL`. Where both apply, both are provided on a durable medium — attached PDF. **Shopify merchants:** see [**Shopify merchants**](/eu-consumer-guarantee-notice-and-garan#shopify-merchants) — Global-e will add a link to the harmonised notice on **Terms of Sale (TOS)** for all platforms (inc. Shopify); you implement notice and GARAN on your website (for example PDP) and Shopify confirmation email per the [Shopify implementation guide](/eu-consumer-guarantee-setup-shopify). ### Global-e setup and behaviour > [accordion] Is the data a one-time thing? > > No. Guarantee terms, models and catalogues change. Merchants should refresh what they have given us when and if their range changes. > [accordion] Can I disable harmonised notice attachment on confirmation emails? > > Yes. The harmonised notice is **on by default** from 27 September 2026 on qualifying GE-sent EEA emails. Contact your CSM to disable harmonised notice attachment. This does **not** remove the harmonised notice link from **Terms of Sale (TOS)**. > [accordion] When does the regulation start? > > The regulation applies from **27 September 2026**. From that date, Global-e attaches the harmonised notice by default on qualifying GE-sent EEA confirmation emails unless harmonised notice attachment is disabled for your account. GARAN is sent per line item once GARAN attachment is **enabled** for your account (via CSM) and you provide a valid `GaranImageURL` (PNG) via Catalog or SendCart. > [accordion] What if I do not send GaranImageURL for some products? > > For each line item, if GARAN attachment is enabled and we have a valid `GaranImageURL`, we attach the GARAN; products without a URL are sent without a GARAN attachment for that item. Other qualifying items on the same order are unaffected. The harmonised notice is still attached on every qualifying email unless harmonised notice attachment is disabled for your account. > [accordion] Can I use a JPG or PDF URL instead of PNG? > > No. `GaranImageURL` must point to a PNG file. Global-e converts it to PDF for the email attachment. > [accordion] Do I need both Catalog and SendCart? > > No. Use any method - Catalog or SendCart, whichever fits how you pass product data to Global-e. > [accordion] Does Global-e generate the GARAN artwork for me? > > No. You must create the GARAN, and host the finished official GARAN PNG at the URL you provide. > [accordion] What about Shopify? > > Global-e does not send Shopify order confirmation emails. > > Global-e will add a link to the harmonised notice on **Terms of Sale (TOS)** for all platforms (inc. Shopify). > [accordion] Does the order confirmation email change in any way? > > No. Global-e does not change your existing confirmation email — not the body text, layout, or product line items. We only attach files: the harmonised notice (by default, unless harmonised notice attachment is disabled for your account) and qualifying GARAN labels when GARAN attachment is enabled (converted to PDF). Nothing else in the email changes. > [accordion] Will guarantee years appear in the email body under each product? > > No. Years appear only on the GARAN attachment you supply - not as separate text in the email body. ## Need help? * **Directive**: [Directive - EU - 2024/825 - EN - EUR-Lex](https://eur-lex.europa.eu/eli/dir/2024/825/oj) * **Implementation**: [Implementing regulation - EU - 2025/1960 - EN - EUR-Le](https://eur-lex.europa.eu/eli/reg_impl/2025/1960/oj/eng) * **High Resolution files**: [Practical guidelines and High Resolution Vector files of the EU notice and label on product guarantees - European Commission](https://commission.europa.eu/publications/practical-guidelines-and-high-resolution-vector-files-eu-notice-and-label-product-guarantees_en) * **Digital display**: [Practical guidelines Harmonised Label\&Notice product guarantees (PDF)](https://commission.europa.eu/document/download/3e4dbee6-8184-4256-923d-c52551c7e9f0_en?filename=Practical%20guidelines%20Harmonised%20Label%26Notice%20product%20guarantees_ARES%2027042026.pdf) * Open a support ticket: [Contact Us](/contact-us) * For **disabling harmonised notice attachment**, GARAN enablement, field mapping, or platform setup: contact your **Customer Success Manager**. ## Legal disclaimer This guide explains how Global-e attaches the official EU harmonised notice (by default on qualifying GE-sent emails from 27 September 2026, unless harmonised notice attachment is disabled for your account) and qualifying GARAN labels (when GARAN attachment is enabled and you supply `GaranImageURL`) as a **durable medium**. It is **not legal advice**. Directive (EU) 2024/825 and Implementing Regulation (EU) 2025/1960 apply across EU member states; you remain the trader of record for your storefront, product pages, and any confirmation emails **not** sent by Global-e. Review your setup with your own legal counsel before go-live (**27 September 2026**). # EU Consumer Guarantee (Notice & GARAN) - Platform Setup Guides Source: https://docs.global-e.com/eu-consumer-guarantee-platform-setup-guides How to supply GaranImageURL to Global-e on your ecommerce platform, with a guide per platform and the requirements that apply to all of them. These guides cover one thing: how to get `GaranImageURL` to Global-e on a specific ecommerce platform. Find your platform in the matrix below. Before you start, read [EU Consumer Guarantee Information (Notice & GARAN)](/eu-consumer-guarantee-notice-and-garan) — it covers what the rules require, how to opt in, and the GARAN file requirements that apply on every platform. ## Support matrix | Platform | Status | Guide | | - | - | - | | BigCommerce | Available | [BigCommerce](/eu-consumer-guarantee-setup-bigcommerce) | | Centra | Available | [Centra](/eu-consumer-guarantee-setup-centra) | | Bespoke Global-e Module | Available | [Bespoke Global-e Module](/eu-consumer-guarantee-setup-global-e-module) | | Hybris (SAP Commerce) | Available | [Hybris (SAP Commerce)](/eu-consumer-guarantee-setup-hybris) | | Magento 2 | Available | [Magento 2](/eu-consumer-guarantee-setup-magento2) | | Magento 2 Lite | Available | [Magento 2 Lite](/eu-consumer-guarantee-setup-magento2-lite) | | PrestaShop | Available | [PrestaShop](/eu-consumer-guarantee-setup-prestashop) | | Salesforce Commerce Cloud (SFCC) | Available | [Salesforce B2C Commerce (SFCC)](/eu-consumer-guarantee-setup-sfcc) | | Shopify | Not applicable | [Shopify](/eu-consumer-guarantee-setup-shopify) | | Shopware | Available | [Shopware 6](/eu-consumer-guarantee-setup-shopware) | | WooCommerce | Available | [WooCommerce](/eu-consumer-guarantee-setup-woocommerce) | | Wix | Coming soon | | ## Available guides > [card] [BigCommerce](/eu-consumer-guarantee-setup-bigcommerce) > > Populate a variant-level metafield; the adapter sends it on both the catalog sync and at checkout. > [card] [Centra](/eu-consumer-guarantee-setup-centra) > > Add a fixed product attribute in Centra; the adapter sends it on the cart payload at checkout. > [card] [Bespoke Global-e Module](/eu-consumer-guarantee-setup-global-e-module) > > Supply GaranImageURL per product on your GetCart response; Global-e Checkout carries it through at checkout. > [card] [Hybris (SAP Commerce)](/eu-consumer-guarantee-setup-hybris) > > Fill in GARAN Image URL on the product in Backoffice; the value travels on the cart payload at checkout. > [card] [Magento 2](/eu-consumer-guarantee-setup-magento2) > > Map a product attribute code in Global-e configuration; the module sends it on catalog and at checkout. > [card] [Magento 2 Lite](/eu-consumer-guarantee-setup-magento2-lite) > > Map a product attribute code, then run a full catalog push once to backfill existing products. > [card] [PrestaShop](/eu-consumer-guarantee-setup-prestashop) > > Map a product Feature and let the plugin emit the value on both the catalog sync and at checkout. > [card] [Salesforce B2C Commerce (SFCC)](/eu-consumer-guarantee-setup-sfcc) > > Implement one Global-e hook handler in your cartridge; it serves both the checkout and catalog paths. > [card] [Shopify](/eu-consumer-guarantee-setup-shopify) > > The platform has no built-in feature for the notice or GARAN label; you implement both through standard theme and notification customization. > [card] [Shopware 6](/eu-consumer-guarantee-setup-shopware) > > Map a product custom field in the plugin settings; the value travels on both the catalog sync and at checkout. > [card] [WooCommerce](/eu-consumer-guarantee-setup-woocommerce) > > Set a product attribute with slug garan-image-url; the value travels on the catalog sync. If your platform is not listed, contact your Customer Success Manager. # EU Consumer Guarantee Source: https://docs.global-e.com/eu-consumer-guarantee-setup-bigcommerce Part of the [EU Consumer Guarantee (Notice & GARAN) - Platform Setup Guides](/eu-consumer-guarantee-platform-setup-guides). ## One-time setup 1. In BigCommerce, create a **variant-level metafield** with namespace `globale` and key `garan_image_url` (single-line text). Use a Metafields Manager app (like Hypa) to create and populate it. > [!WARNING] > > Creating the metafield in BigCommerce is not enough on its own. Ask your Customer Success Manager to enable GARAN label support on your Global-e account and confirm the adapter is configured to read variant metafield `globale` / `garan_image_url`. Until that is in place, `GaranImageURL` will be empty in all payloads. If you already store the URL under a different variant metafield, contact Global-e before changing anything. They will either configure the adapter to read your existing namespace/key, or ask you to adopt the standard `globale` / `garan_image_url`. Do not use a product custom field, or a generic "send metafields as attributes" mapping. Those do not populate the dedicated `GaranImageURL` field. ## Per variant The GARAN URL is read at **variant** level, not parent product level — the same grain as the product image. Set the metafield on each eligible variant. Leave it empty for variants with no guarantee. | Variant SKU | Metafield value | | - | - | | JKT-4471-BLK-M | `https://cdn.example.com/garan/JKT-4471.png` | | JKT-4471-BLK-L | `https://cdn.example.com/garan/JKT-4471.png` | | TEE-1102-WHT-L | (empty — no guarantee) | Different variants can carry different URLs. A value on the parent product alone is not read. Products with no size or colour options still have a default variant — set the metafield on that variant. ## When the value syncs | Event | Path | | - | - | | Variant save in the BigCommerce admin | Catalog sync | | Product/variant updates via API or bulk import | Catalog sync (same webhooks as admin save) | | Checkout / cart refresh | Cart (GetCart) | ## Prerequisites | Requirement | Value | | - | - | | Minimum adapter version | Global-e BigCommerce 1.59 or later | | Merchant data source | Variant metafield namespace `globale`, key `garan_image_url` | | Admin tool | A Metafields Manager app (like Hypa), or equivalent metafield UI/API | | Global-e enablement | GARAN label support enabled on your account; adapter configured to read `globale` / `garan_image_url` (see [One-time setup](/eu-consumer-guarantee-setup-bigcommerce#one-time-setup)) | ## Delivery paths The value reaches Global-e on two paths: catalog sync (`SaveProductsList`) and checkout (GetCart). Where both supply a value for the same variant, the Catalog value wins. ## Platform notes Namespace matching is case-sensitive; key matching is case-insensitive. Use `globale` / `garan_image_url` unless Global-e has confirmed a different namespace/key pair for your account (see [One-time setup](/eu-consumer-guarantee-setup-bigcommerce#one-time-setup)). BigCommerce's native admin has limited support for variant-level metafields on some stores. Many merchants use a Metafields Manager app (for example Hypa) to create and populate them. If your metafield namespace/key do not match what Global-e configured on your account, `GaranImageURL` will be empty even when a URL exists on the variant. Use a full public `https://` URL to the GARAN PNG. Relative paths are not valid. This is not the storefront product image. ## Payload reference For technical readers. The field name is `GaranImageURL` on both catalog and cart. **Catalog — POST /Browsing/SaveProductsList** ```json theme={null} [ { "ProductCode": "JKT-4471-BLK-M", "ProductGroupCodeSecondary": "4471", "Name": "Alpine Insulated Jacket", "ImageURL": "https:\/\/cdn.example.com\/products\/jkt-4471-blk.jpg", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/JKT-4471.png" }, { "ProductCode": "TEE-1102-WHT-L", "Name": "Cotton Crew Tee", "ImageURL": "https:\/\/cdn.example.com\/products\/tee-1102-wht.jpg", "GaranImageURL": null } ] ``` Other catalog fields (for example `ProductGroupCode`) may appear on real payloads; only `GaranImageURL` and related product fields are shown here. **Cart — GetCart `productsList[]`** ```json theme={null} { "productsList": [ { "ProductCode": "JKT-4471-BLK-M", "CartItemId": "17984028-0eec-46aa-9af3-4817a207bcc7", "Name": "Alpine Insulated Jacket", "OrderedQuantity": 1, "ImageURL": "https:\/\/cdn.example.com\/products\/jkt-4471-blk.jpg", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/JKT-4471.png" } ] } ``` ## Verify | Check | Done | | - | - | | Variant metafield `globale` / `garan_image_url` exists and is populated on a test variant | ☐ | | Global-e has enabled GARAN on your account (until then, `GaranImageURL` stays null even when the metafield is populated) | ☐ | | `GaranImageURL` appears on the catalog payload after admin save or API/bulk update | ☐ | | `GaranImageURL` appears in GetCart for that variant at checkout | ☐ | | A variant without the metafield sends `GaranImageURL` as null or omits it | ☐ | > [!NOTE] > > Activation modes and the general preparation steps — opting in, identifying qualifying products, and creating and hosting the GARAN PNG — are covered on the [EU Consumer Guarantee Information (Notice & GARAN)](/eu-consumer-guarantee-notice-and-garan) overview page. ## FAQ > [accordion] Do product variants each need their own URL? > > Yes. The value is read per variant. Set the metafield on each variant Global-e syncs. > [accordion] My product has no options — where do I set the URL? > > Single-SKU products still have a default variant in BigCommerce. Set the metafield on that variant, not on the parent product alone. > [accordion] Can I use a custom field instead of a metafield? > > No. Variant metafields are the only supported source. > [accordion] Why is GaranImageURL always empty? > > Check in order: (1) the variant metafield is missing or set on the parent product only; (2) the namespace/key do not match what Global-e configured for your account — the default is `globale` / `garan_image_url` unless Global-e told you otherwise; (3) GARAN label support is not enabled on your Global-e account, or the adapter is not configured to read your metafield — ask your CSM to confirm both. Until Global-e completes that enablement, `GaranImageURL` stays null in every payload even when the metafield is populated. > [accordion] What if the URL breaks? > > That attachment is skipped and logged. The order and confirmation email are unaffected. > [accordion] Does checkout use SendCart? > > On this adapter, checkout coverage is GetCart. You do not set a separate SendCart field in BigCommerce. # EU Consumer Guarantee Source: https://docs.global-e.com/eu-consumer-guarantee-setup-centra Part of the [EU Consumer Guarantee (Notice & GARAN) - Platform Setup Guides](/eu-consumer-guarantee-platform-setup-guides). ## One-time setup 1. In Centra, navigate to **System → Configuration** and create a custom product attribute group named `ge_product_data`. If that group already exists for other Global-e product fields, add the element in step 2 to it — Centra does not allow two attribute groups with the same name, so you cannot create a second group. 2. Add an element with key `garan_image_url`, type input, description **Global-E GARAN Label Image URL**. 3. The Global-e adapter reads these names as-is. There is no mapping dropdown in the adapter. Attribute definition: ```json theme={null} { "desc": "Global-E Product Information", "readonly": false, "group": "product", "elements": { "garan_image_url": { "type": "input", "desc": "Global-E GARAN Label Image URL" } } } ``` ## Per product On each qualifying product, set **Global-E GARAN Label Image URL** to the full HTTPS URL of that product's GARAN PNG. Leave it empty for products with no guarantee. | Product | Attribute value | | - | - | | Alpine Insulated Jacket | `https://cdn.example.com/garan/JKT-4471.png` | | Cotton Crew Tee | (empty — no guarantee) | Set this at product level. All size and colour variants of the same product carry the same URL. ## When the value syncs The value is read when the shopper checks out, on both Centra's DTC API and the Checkout API. Updating the product attribute alone does not send the label — a checkout must run. ## Prerequisites | Requirement | Value | | - | - | | Minimum adapter version | Global-e Centra adapter 1.5.0 or later | | Attribute | Group `ge_product_data`, element `garan_image_url` | | Catalog path | Not supported in the current release | | Feature enablement | Confirm with your Customer Success Manager that this feature is enabled for your account | ## Delivery paths SendCart only: `SendCartData.Products[].GaranImageURL`. The adapter reads the same attribute on both Centra's DTC API and Checkout API at checkout — you do not set a second field. ## Platform notes > [!WARNING] > > The group name and element key are fixed. A differently named attribute will not be read; the adapter will send `GaranImageURL` as `null` and will not error. The attribute is product-level (`group: product`). All size and colour variants of the same product carry the same URL. Per-SKU or per-variant values are not supported in the current implementation. ## Payload reference For technical readers. The field name is `GaranImageURL` on SendCart (`SendCartData.Products[]`). **Cart — `SendCartData.Products[]`** ```json theme={null} { "Products": [ { "ProductCode": "JKT-4471-BLK-M", "CartItemId": "1057", "Name": "Alpine Insulated Jacket", "OrderedQuantity": 1, "ImageURL": "https://cdn.example.com/products/jkt-4471-blk.jpg", "GaranImageURL": "https://cdn.example.com/garan/JKT-4471.png", "GenericHSCode": "620193" } ] } ``` ## Verify | Check | Done | | - | - | | `GaranImageURL` appears in the SendCart payload for that product at checkout (DTC and/or Checkout API, whichever you use) | ☐ | | A product with an empty attribute sends `GaranImageURL` as null or omits it | ☐ | | Size and colour SKUs of the same product carry the URL you expect | ☐ | > [!NOTE] > > Activation modes and the general preparation steps — opting in, identifying qualifying products, and creating and hosting the GARAN PNG — are covered on the [EU Consumer Guarantee Information (Notice & GARAN)](/eu-consumer-guarantee-notice-and-garan) overview page. ## FAQ > [accordion] Do I need a different field for DTC vs Checkout API? > > No. The same `ge_product_data` / `garan_image_url` attribute is read on both checkout paths. > [accordion] Do product variants each need their own URL? > > No. Set the value on the product — all size and colour variants inherit the same URL. Per-variant values are not supported in the current implementation. > [accordion] Can I name the attribute something else? > > No. The adapter looks up this group and element by those exact keys. A different name is treated as missing and sent as `null`. # EU Consumer Guarantee Source: https://docs.global-e.com/eu-consumer-guarantee-setup-global-e-module Part of the [EU Consumer Guarantee (Notice & GARAN) - Platform Setup Guides](/eu-consumer-guarantee-platform-setup-guides). ## Who this page is for Use this page if Global-e Module 2.0 Checkout calls **your** GetCart endpoint, and you supply product fields on that response. Put `GaranImageURL` on GetCart **per product**; Global-e Checkout includes it when the shopper checks out. > [!NOTE] > > If you already use a Global-e **platform plugin or adapter** (Shopware, WooCommerce, PrestaShop, BigCommerce, Hybris, Magento, Centra, and similar), follow **that platform's page** instead. Do not also change GetCart unless Global-e asks you to. ## One-time setup 1. Confirm the store is on **Global-e Module 2.0**. Note that Global-e Module 1.0 / LightGEPI does not carry this field — upgrade first (contact your CSM for more info). 2. Add an optional string `GaranImageURL` on GetCart `productsList`. Apply it **per product** (same grain as `ImageURL`). ## Per product Apply `GaranImageURL` on each product that has a guarantee, with the full HTTPS URL of that product's GARAN PNG. Leave it empty or omit it where there is no guarantee. | Product | GetCart value | | - | - | | Argus All-Weather Tank (`MT07-S-Gray`) | `https://cdn.example.com/garan/MT07.png` | | Radiant Tee (`WS12-S-Orange`) | (empty / omitted — no guarantee) | A generic product attribute bag is not enough. Global-e Checkout maps a named field; unnamed attributes are dropped. ## When the value syncs The value is read when Global-e Checkout calls GetCart. There is no catalog path on Global-e Module 2.0 — updating catalog alone will not send the label at checkout. ## Prerequisites | Requirement | Value | | - | - | | Minimum Global-e Module version | Global-e Module 2.0 | | Intake path | GetCart `productsList[].GaranImageURL` only | | File format | Merchant-hosted **PNG** at a public HTTPS URL | | Feature enablement | Confirm with your Customer Success Manager that this feature is enabled for your account | ## Delivery paths The value reaches Global-e only at checkout, from GetCart. Global-e Module 2.0 does not read the catalog. ## Platform notes > [!WARNING] > > Global-e Module 1.0/ LightGEPI will not receive this field. Merchants still on Global-e Module 1.0 who need GARAN must upgrade to Global-e Module 2.0. Do not reuse the storefront photo field. `ImageURL` is the product image; `GaranImageURL` is the guarantee label. ## Payload reference For technical readers. The field name is `GaranImageURL` on GetCart. The products array on GetCart is `productsList` (camelCase). Product fields inside are PascalCase, including `GaranImageURL`. **GetCart — your response (truncated example)** ```json theme={null} { "productsList": [ { "ProductCode": "MT07-S-Gray", "Name": "Argus All-Weather Tank", "ImageURL": "https:\/\/cdn.example.com\/catalog\/MT07.png", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/MT07.png", "OrderedQuantity": 3, "CartItemId": "5" }, { "ProductCode": "WS12-S-Orange", "Name": "Radiant Tee", "ImageURL": "https:\/\/cdn.example.com\/catalog\/WS12.png", "OrderedQuantity": 1, "CartItemId": "9" } ] } ``` The second line omits `GaranImageURL` to show a product with no guarantee. Omit the field or send `null` in that case. **Checkout cart — after GetCart, the same field appears on each matching line in `Products[]` (truncated example)** ```json theme={null} { "Products": [ { "ProductCode": "MT07-S-Gray", "Name": "Argus All-Weather Tank", "ImageURL": "https:\/\/cdn.example.com\/catalog\/MT07.png", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/MT07.png", "OrderedQuantity": 3, "CartItemId": "5" }, { "ProductCode": "WS12-S-Orange", "Name": "Radiant Tee", "ImageURL": "https:\/\/cdn.example.com\/catalog\/WS12.png", "OrderedQuantity": 1, "CartItemId": "9" } ] } ``` Do not put a GARAN URL in `ImageURL` or in `Attributes[]`. ## Verify | Check | Done | | - | - | | `GaranImageURL` appears on a test GetCart product that you populated | ☐ | | The same value is present on that line after checkout (cart `Products[]`) | ☐ | | A line with no URL still checks out | ☐ | | Storefront `ImageURL` is unchanged | ☐ | > [!NOTE] > > Activation modes and the general preparation steps — opting in, identifying qualifying products, and creating and hosting the GARAN PNG — are covered on the [EU Consumer Guarantee Information (Notice & GARAN)](/eu-consumer-guarantee-notice-and-garan) overview page. ## FAQ > [accordion] Do variants each need their own URL? > > Apply the field per product. If variants are separate products on GetCart, set `GaranImageURL` on each one that needs a label. > [accordion] I use the BigCommerce / Woo / Shopware plugin. > > Use that platform's page. This Bespoke Global-e Module page is the GetCart JSON contract, not a second admin setup. # EU Consumer Guarantee Source: https://docs.global-e.com/eu-consumer-guarantee-setup-hybris Part of the [EU Consumer Guarantee (Notice & GARAN) - Platform Setup Guides](/eu-consumer-guarantee-platform-setup-guides). ## One-time setup There is no plugin mapping screen for this field. After you install a Global-e Hybris addon that includes GARAN support, each product shows **GARAN Image URL** in Backoffice. ## Per product 1. In Backoffice, navigate to **Catalog → Products** and open the product. 2. Open the **Administration** tab. 3. In **GARAN Image URL**, enter the full HTTPS URL of that product's GARAN PNG. Leave it empty for products with no guarantee. 4. Save the product. | Product | GARAN Image URL | | - | - | | Alpine Insulated Jacket | `https://cdn.example.com/garan/JKT-4471.png` | | Cotton Crew Tee | (empty — no guarantee) | This is not the product photo. Multimedia / `ImageURL` stays the storefront image. For variants, see [Platform notes](/eu-consumer-guarantee-setup-hybris#platform-notes) — an empty variant field can inherit the parent URL. ## When the value syncs The value is sent on checkout, on the SendCart payload for that cart line. ## Prerequisites | Requirement | Value | | - | - | | Minimum addon version | Global-e Hybris addon 2211.11.2 or later | | Merchant field | **GARAN Image URL** on the product in Backoffice | | Catalog path | Not available on this platform | | Feature enablement | Confirm with your Customer Success Manager that this feature is enabled for your account | ## Delivery paths SendCart only: `SendCartData.Products[].GaranImageURL`. ## Platform notes > [!WARNING] > > Do not put the GARAN PNG in the product image / multimedia slot. The addon keeps `ImageURL` (storefront photo) and `GaranImageURL` (guarantee label) as separate fields. If a variant's **GARAN Image URL** is empty and the parent product has a value, the cart line uses the parent URL. Set the field on the parent if every variant shares one label; set it on the variant when a size or colour needs a different file. Same behaviour as Shopware 6. ## Payload reference For technical readers. The field name is `GaranImageURL` on SendCart (`POST /Checkout/SendCartV2`). **Cart — SendCartData.Products\[]** ```json theme={null} { "Products": [ { "ProductCode": "29533", "CartItemId": "0", "Name": "Snowboard Ski Tool Toko Ergo Multi Guide yellow", "NameEnglish": "Snowboard Ski Tool Toko Ergo Multi Guide yellow", "ImageURL": "https:\/\/cdn.example.com\/products\/jkt-4471-blk.jpg", "ImageHeight": 0, "ImageWidth": 0, "GaranImageURL": "https:\/\/cdn.example.com\/garan\/JKT-4471.png", "ListPrice": 65.00, "OrderedQuantity": 1 }, { "ProductCode": "45572", "CartItemId": "1", "Name": "Snowboard Ski Tool Toko Waxremover HC3 500ml", "NameEnglish": "Snowboard Ski Tool Toko Waxremover HC3 500ml", "ImageURL": "https:\/\/cdn.example.com\/products\/tee-1102-wht.jpg", "ImageHeight": 0, "ImageWidth": 0, "GaranImageURL": null, "ListPrice": 0.00, "OrderedQuantity": 1 } ] } ``` SKU 29533 has a GARAN URL. SKU 45572 has none — `GaranImageURL` is `null` and no attachment is generated for that line. The storefront photo remains on `ImageURL`. ## Verify | Check | Done | | - | - | | Product in Backoffice **Administration** has **GARAN Image URL** set to an HTTPS PNG | ☐ | | A test checkout SendCart payload includes `GaranImageURL` for that SKU | ☐ | | A product with an empty field sends `GaranImageURL` as null | ☐ | | A variant with an empty field inherits the parent URL when the parent is set | ☐ | | `ImageURL` is still the storefront photo, not the GARAN file | ☐ | > [!NOTE] > > Activation modes and the general preparation steps — opting in, identifying qualifying products, and creating and hosting the GARAN PNG — are covered on the [EU Consumer Guarantee Information (Notice & GARAN)](/eu-consumer-guarantee-notice-and-garan) overview page. ## FAQ > [accordion] Do variants each need their own URL? > > Only if they differ. An empty variant field uses the parent product's value. > [accordion] Can I reuse the product image? > > No. Use **GARAN Image URL** for the official label PNG. # EU Consumer Guarantee Source: https://docs.global-e.com/eu-consumer-guarantee-setup-magento2 Part of the [EU Consumer Guarantee (Notice & GARAN) - Platform Setup Guides](/eu-consumer-guarantee-platform-setup-guides). ## Who this page is for Use this page if the store runs the Global-e **Magento 2** integration. > [!NOTE] > > If the store runs **Magento 2 Lite** (BrowsingLite), use the [Magento 2 Lite](/eu-consumer-guarantee-setup-magento2-lite) page instead. ## One-time setup 1. In **Stores → Attributes → Product → Add New Attribute**, create a text attribute to hold the GARAN URL. Example: label `GARAN Image URL`, attribute code `ge_garan_image_url`. Catalog Input Type = **Text Field**, Values Required = No. 2. Add the attribute to the relevant attribute set in **Stores → Attributes → Attribute Set**, so it appears on the product edit page. 3. Navigate to **Stores → Configuration → Global-e → API Settings → Products Settings**. In **GARAN Image URL attribute**, enter the attribute's **code** (not the label) — e.g. `ge_garan_image_url`. 4. Click **Save Config**, then flush Magento cache (**System → Cache Management → Flush Magento Cache**). Leaving the configuration field empty turns the feature off. No extra Magento setting is required for catalog vs checkout — the same mapped attribute is used on both paths. ## Per product Set the mapped attribute on the product record Global-e sends for that line — on the **simple product** for non-configurable products. For configurable products, set it on each **child simple** when variants need different URLs, or on the **configurable parent** when every child should share the same URL. Use the full HTTPS URL of that product's GARAN PNG. Leave it empty where there is no guarantee. Global-e reads the **child simple first**. If that value is empty, it uses the **configurable parent**. | Product | Attribute value | | - | - | | Alpine Insulated Jacket — JKT-4471-BLK-M | `https://cdn.example.com/garan/JKT-4471.png` | | Alpine Insulated Jacket — JKT-4471-BLK-L | `https://cdn.example.com/garan/JKT-4471.png` | | Cotton Crew Tee — TEE-1102-WHT-L | (empty — no guarantee) | ## When the value syncs The value is picked up automatically on: | Event | Trigger | | - | - | | Product save | Saving a product in admin (catalog sync and checkout use the same mapped attribute) | | Checkout | At checkout, on the cart path | ## Prerequisites | Requirement | Value | | - | - | | Minimum module version | GE Module version 2.17.0 or later | | Configuration | Make sure the value exists for the relevant product or child | | Feature enablement | Confirm with your Customer Success Manager that this feature is enabled for your account | ## Delivery paths The value reaches Global-e on two paths: the catalog sync (`SaveProductsList`) and at checkout. ## Platform notes > [!WARNING] > > Enter the attribute **code** in configuration, not its storefront label. Mapping `GARAN Image URL` instead of `ge_garan_image_url` is the usual reason the field is missing from the payload. Flush cache after saving the config. The module forwards the attribute value exactly as entered. Use a full public `https://` URL. A relative path such as `/media/garan/x.png` will not work. Clearing **GARAN Image URL attribute** turns the feature off. Product data is left untouched, so it can be switched back on later. ## Payload reference For technical readers. The field name is `GaranImageURL` on catalog and at checkout. **Catalog — product list sent to Global-e** ```json theme={null} [ { "ProductCode": "JKT-4471-BLK-M", "Name": "Alpine Insulated Jacket", "ImageURL": "https:\/\/cdn.example.com\/products\/jkt-4471-blk.jpg", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/JKT-4471.png" }, { "ProductCode": "TEE-1102-WHT-L", "Name": "Cotton Crew Tee", "ImageURL": "https:\/\/cdn.example.com\/products\/tee-1102-wht.jpg" } ] ``` The t-shirt omits `GaranImageURL` (no guarantee). Omit the field or send `null`. **Checkout cart — matching line on `Products[]`** ```json theme={null} { "Products": [ { "ProductCode": "JKT-4471-BLK-M", "Name": "Alpine Insulated Jacket", "ImageURL": "https:\/\/cdn.example.com\/products\/jkt-4471-blk.jpg", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/JKT-4471.png", "OrderedQuantity": 1 } ] } ``` Do not put a GARAN URL in `ImageURL` or in a generic attribute bag. ## Verify | Check | Done | | - | - | | `GaranImageURL` appears in a test catalog payload for a product with a populated mapped attribute | ☐ | | The same value is present on that line at checkout | ☐ | | The mapped attribute is populated on the relevant simple product, child, or configurable parent | ☐ | | A product with an empty child attribute can still pick up a parent URL | ☐ | | A product with no URL on child or parent still checks out | ☐ | | Storefront `ImageURL` is unchanged | ☐ | > [!NOTE] > > Activation modes and the general preparation steps — opting in, identifying qualifying products, and creating and hosting the GARAN PNG — are covered on the [EU Consumer Guarantee Information (Notice & GARAN)](/eu-consumer-guarantee-notice-and-garan) overview page. ## FAQ > [accordion] Do product variants each need their own URL? > > For configurable products, set the attribute on each child simple when variants should differ, or on the configurable parent when they should share one URL. Global-e reads the child first, then the parent. For simple products, set it on that product. > [accordion] Can I use a relative path such as /media/garan/x.png? > > No. The value is forwarded exactly as entered. Use a full `https://` URL. > [accordion] Why is the value missing from my payload? > > Most often the configuration holds the attribute **label** instead of its **code**, cache was not flushed after the config change, or the attribute is empty on that product. Check in that order. > [accordion] I use Magento 2 Lite. > > Use the [Magento 2 Lite](/eu-consumer-guarantee-setup-magento2-lite) page. This page is Magento 2 only. > [accordion] How do I turn the feature off? > > Clear **GARAN Image URL attribute**. Product data is left untouched. # EU Consumer Guarantee Source: https://docs.global-e.com/eu-consumer-guarantee-setup-magento2-lite Part of the [EU Consumer Guarantee (Notice & GARAN) - Platform Setup Guides](/eu-consumer-guarantee-platform-setup-guides). ## One-time setup 1. In **Stores → Attributes → Product → Add New Attribute**, create a text attribute to hold the GARAN URL. Example: label `GARAN Image URL`, attribute code `ge_garan_image_url`. Catalog Input Type = **Text Field**, Values Required = No. 2. Add the attribute to the relevant attribute set in **Stores → Attributes → Attribute Set**, so it appears on the product edit page. 3. Navigate to **Stores → Configuration → Global-e → API Settings → Products Settings**. In **GARAN Image URL attribute**, enter the attribute's **code** (not the label) — e.g. `ge_garan_image_url`. 4. Click **Save Config**, then flush Magento cache (**System → Cache Management → Flush Magento Cache**). Leaving the configuration field empty turns the feature off. The setting is available at default, website, and store-view scope, so a different attribute can be mapped per store if needed. ## Per product Set the mapped attribute on the product record Global-e sends for that line — on the **simple product** for non-configurable products, or on each **child simple** for configurable products. Use the full HTTPS URL of that product's GARAN PNG. Leave it empty where there is no guarantee. | Product | Attribute value | | - | - | | Alpine Insulated Jacket — JKT-4471-BLK-M | `https://cdn.example.com/garan/JKT-4471.png` | | Alpine Insulated Jacket — JKT-4471-BLK-L | `https://cdn.example.com/garan/JKT-4471.png` | | Cotton Crew Tee — TEE-1102-WHT-L | (empty — no guarantee) | For bulk population use **Catalog → Products → select products → Actions → Update Attributes**, or a CSV import via **System → Import**. ## When the value syncs The value is picked up automatically on: | Event | Trigger | | - | - | | Product save | Saving a product in admin | | Mass attribute update | **Actions → Update Attributes** on a product selection | | Full catalog push | **Stores → Configuration → Global-e → API Settings → Products Settings → Send Product Catalog via SaveProductsList API with queue** | | Checkout | At checkout, on the cart path | Run the full catalog push once after initial setup to backfill existing products. On large catalogs this runs through the queue and can take some time. ## Prerequisites | Requirement | Value | | - | - | | Minimum module version | GE Module version 1.24.2 or later | | Configuration | Make sure the value exists for the relevant product or child | | Feature enablement | Confirm with your Customer Success Manager that this feature is enabled for your account | ## Delivery paths The value reaches Global-e on two paths: the catalog sync (`SaveProductsList`) and at checkout. ## Platform notes > [!WARNING] > > Enter the attribute **code** in configuration, not its storefront label. Mapping `GARAN Image URL` instead of `ge_garan_image_url` is the usual reason the field is missing from the payload. Flush cache after saving the config. The module forwards the attribute value exactly as entered. Use a full public `https://` URL. A relative path such as `/media/garan/x.png` will not work. Clearing **GARAN Image URL attribute** turns the feature off. Product data is left untouched, so it can be switched back on later. ## Payload reference For technical readers. The field name is `GaranImageURL` on catalog and at checkout. GetCart uses array name `productsList` (camelCase); product fields stay PascalCase. **Catalog — POST /Browsing/SaveProductsList** ```json theme={null} [ { "ProductCode": "JKT-4471-BLK-M", "Name": "Alpine Insulated Jacket", "ImageURL": "https:\/\/cdn.example.com\/products\/jkt-4471-blk.jpg", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/JKT-4471.png", "OriginCountryCode": "PT", "GenericHSCode": "620193" }, { "ProductCode": "JKT-4471-BLK-L", "Name": "Alpine Insulated Jacket", "ImageURL": "https:\/\/cdn.example.com\/products\/jkt-4471-blk.jpg", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/JKT-4471.png", "OriginCountryCode": "PT", "GenericHSCode": "620193" }, { "ProductCode": "TEE-1102-WHT-L", "Name": "Cotton Crew Tee", "ImageURL": "https:\/\/cdn.example.com\/products\/tee-1102-wht.jpg", "GaranImageURL": null, "OriginCountryCode": "PT", "GenericHSCode": "610910" } ] ``` Both jacket SKUs carry the same URL because the attribute was populated on both child simples. The t-shirt has no guarantee — `GaranImageURL` is `null` and no attachment is generated for it. Omitting the property entirely has the same effect as `null`. **Checkout cart — `productsList[]`** ```json theme={null} { "productsList": [ { "ProductCode": "24-MB01", "Name": "Joust Duffle Bag", "URL": "https:\/\/cdn.example.com\/products\/mb01-blue.html", "ImageURL": "https:\/\/cdn.example.com\/products\/mb01-blue.jpg", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/MB01.png", "OrderedQuantity": 1, "CartItemId": "95" } ] } ``` Do not put a GARAN URL in `ImageURL`. ## Verify | Check | Done | | - | - | | `GaranImageURL` appears in a test catalog payload for a product with a populated mapped attribute | ☐ | | `GaranImageURL` appears in GetCart `productsList[]` for a product with a populated mapped attribute | ☐ | | A product with an empty attribute sends `GaranImageURL` as null or omits it | ☐ | | The mapped attribute is populated on the relevant simple product or child | ☐ | > [!NOTE] > > Activation modes and the general preparation steps — opting in, identifying qualifying products, and creating and hosting the GARAN PNG — are covered on the [EU Consumer Guarantee Information (Notice & GARAN)](/eu-consumer-guarantee-notice-and-garan) overview page. ## FAQ > [accordion] Do product variants each need their own URL? > > For configurable products, set the attribute on each child simple Global-e sends. For simple products, set it on that product. > [accordion] Can I use a relative path such as /media/garan/x.png? > > No. The value is forwarded exactly as entered. Use a full `https://` URL. > [accordion] Why is the value missing from my payload? > > Most often the configuration holds the attribute **label** instead of its **code**, cache was not flushed after the config change, or the attribute is empty on that product. Check in that order. > [accordion] How do I turn the feature off? > > Clear **GARAN Image URL attribute**. Product data is left untouched. # EU Consumer Guarantee Source: https://docs.global-e.com/eu-consumer-guarantee-setup-prestashop How to supply GaranImageURL to Global-e on PrestaShop: map a product Feature once, and the plugin emits the value on both the catalog sync and at checkout. Part of the [EU Consumer Guarantee (Notice & GARAN) - Platform Setup Guides](/eu-consumer-guarantee-platform-setup-guides). ## One-time setup 1. In **Catalog → Attributes & Features**, create a feature named, for example, `Global-e GARAN Image URL`. 2. In Global-e plugin settings, find the **GARAN Image URL** dropdown and select that feature. 3. If using the Catalog path, confirm **Enable save product list** is switched on. If it is off, only the cart path will carry the value. ## Per product Populate the mapped feature once on each eligible parent product. Leave it empty for products with no guarantee. Features cannot differ by combination — see [Platform notes](/eu-consumer-guarantee-setup-prestashop#platform-notes). | Product | Feature value | | - | - | | Alpine Insulated Jacket | `https://cdn.example.com/garan/JKT-4471.png` | | Cotton Crew Tee | (empty — no guarantee) | The plugin then emits `GaranImageURL` automatically on both the catalog sync and at checkout. ## When the value syncs The value is picked up on product save. ## Prerequisites | Requirement | Value | | - | - | | Minimum plugin version | Global-e PrestaShop plugin 1.11.0 or later | | Catalog path toggle | **Enable save product list** must be on to use the Catalog path | | Feature enablement | Confirm with your Customer Success Manager that this feature is enabled for your account | ## Delivery paths The value reaches Global-e on two paths: the catalog sync and at checkout. Where both supply a value for the same product, the Catalog value wins. ## Platform notes > [!WARNING] > > PrestaShop Features cannot differ by combination. Size and colour variants of the same parent product inherit the same URL, and you cannot assign a different GARAN URL per combination. The plugin still sends one catalog and cart row per combination SKU; each row carries a copy of the parent value. ## Payload reference For technical readers. The field name is `GaranImageURL` on both the catalog and cart contracts, with no per-path variation. **Catalog — POST /Browsing/SaveProductsList** ```json theme={null} [ { "ProductCode": "JKT-4471-BLK-M", "ProductGroupCode": "JKT-4471", "Name": "Alpine Insulated Jacket", "ImageURL": "https:\/\/cdn.example.com\/products\/jkt-4471-blk.jpg", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/JKT-4471.png", "Weight": "1200", "OriginCountryCode": "PT", "GenericHSCode": "620193" }, { "ProductCode": "JKT-4471-BLK-L", "ProductGroupCode": "JKT-4471", "Name": "Alpine Insulated Jacket", "ImageURL": "https:\/\/cdn.example.com\/products\/jkt-4471-blk.jpg", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/JKT-4471.png", "Weight": "1250", "OriginCountryCode": "PT", "GenericHSCode": "620193" }, { "ProductCode": "TEE-1102-WHT-L", "Name": "Cotton Crew Tee", "ImageURL": "https:\/\/cdn.example.com\/products\/tee-1102-wht.jpg", "GaranImageURL": null, "Weight": "180", "OriginCountryCode": "PT", "GenericHSCode": "610910" } ] ``` The two jacket combination SKUs (M and L) share the same `GaranImageURL` because the Feature was set once on the parent product. The t-shirt has no guarantee — `GaranImageURL` is `null` and no attachment is generated for it. Omitting the property entirely has the same effect as `null`. **Cart — SendCartData.Products\[]** ```json theme={null} { "Products": [ { "ProductCode": "JKT-4471-BLK-M", "CartItemId": "1057", "Name": "Alpine Insulated Jacket", "OrderedQuantity": 1, "ImageURL": "https://cdn.example.com/products/jkt-4471-blk.jpg", "GaranImageURL": "https://cdn.example.com/garan/JKT-4471.png", "GenericHSCode": "620193" } ] } ``` ## Verify | Check | Done | | - | - | | `GaranImageURL` appears in a test catalog payload for a product with a populated Feature | ☐ | | `GaranImageURL` appears in the cart payload for that product at checkout | ☐ | | A product with an empty Feature sends `GaranImageURL` as `null` or omits it | ☐ | | Combination SKUs of the same parent all carry the same URL | ☐ | > [!NOTE] > > Activation modes and the general preparation steps — opting in, identifying qualifying products, and creating and hosting the GARAN PNG — are covered on the [EU Consumer Guarantee Information (Notice & GARAN)](/eu-consumer-guarantee-notice-and-garan) overview page. ## FAQ > [accordion] Do product variants each need their own URL? > > No. Set the Feature once on the parent product. Each combination SKU (size, colour) carries a copy of that same URL to Global-e. You cannot assign a different GARAN URL per combination on PrestaShop. # EU Consumer Guarantee Source: https://docs.global-e.com/eu-consumer-guarantee-setup-sfcc Part of the [EU Consumer Guarantee (Notice & GARAN) - Platform Setup Guides](/eu-consumer-guarantee-platform-setup-guides). > [!NOTE] > > **Plan for a developer.** Unlike platforms with a plugin setting for this, SFCC resolves the GARAN URL through a Global-e integration hook. Someone with access to your SFCC cartridge code needs to implement one small handler. The rest is configuration. ## One-time setup **1. Decide where the URL lives on your products** Create or choose a product custom attribute to hold the GARAN image URL — for example `garanImageUrl` (string). There is no fixed attribute name: your hook handler decides where to read from, so any attribute id works. You can also compute the URL instead of storing it. **2. Implement the Global-e hook** In your project cartridge, register the hook in `hooks.json`: ```json theme={null} { "name": "globale.product.getGaranImageUrl", "script": "./cartridge/scripts/hooks/getGaranImageUrl.js" } ``` Then add `cartridge/scripts/hooks/getGaranImageUrl.js`: ```javascript theme={null} 'use strict'; exports.getGaranImageUrl = function (product) { // Return the full HTTPS URL of this product's GARAN PNG, or null. return (product && product.custom.garanImageUrl) || null; }; ``` > [!WARNING] > > Two details that fail silently if missed: > > * The export must be named exactly `getGaranImageUrl`. A different name returns null with no error anywhere. > * Guard against a null product (`product && ...`). The handler is called for every cart line, including product-option lines that have no product of their own. Without the guard you get an error entry in the Global-e log for each one. No handler ships with the Global-e cartridges — if you do not add one, `GaranImageURL` is always empty. **3. Enable the SendCart path** The SendCart mapping is held in Global-e's platform settings, not in Business Manager. Ask your Customer Success Manager to add a `GaranImageURL` product mapping for your account. Once added, it reaches your instance on the next run of the scheduled `GlobaleSettings` job (daily, 02:00 UTC). Run that job manually if you want it sooner. For reference, the mapping Global-e adds looks like this: ```json theme={null} { "targetPath": "GaranImageURL", "getterFunc": "return require('*/cartridge/scripts/helpers/globaleHooksHelper').invokeCustomHookWithFallback('globale.product.getGaranImageUrl', function () { return null; }, source.productLineItem.product);" } ``` **4. Enable the Catalog path** This one you configure yourself, in Business Manager: **Merchant Tools → Site Preferences → Custom Preferences → Global-e**, preference `geCatalogFeedConfig`. Add a column to `file.columns`: ```json theme={null} { "type": "hook", "header": "GaranImageURL", "hookName": "globale.product.getGaranImageUrl", "fallback": { "type": "static", "attr": "" } } ``` Nothing is added to your feed automatically — the column appears only after you add it. `header` and `hookName` are both required; without them the catalog feed job fails validation. ## Per product Populate the attribute on each product that qualifies, with the full HTTPS URL of that item's GARAN PNG. Leave it empty where there is no producer durability guarantee. | Product | Attribute value | | - | - | | Alpine Insulated Jacket | `https://cdn.example.com/garan/JKT-4471.png` | | Cotton Crew Tee | (empty — no guarantee) | ## When the value syncs **SendCart** reads the attribute at checkout, on every cart, so changes take effect immediately. **Catalog** picks the value up on the next scheduled run of the `GlobaleCatalogFeed` job — it is a batch export, not a live sync. If your feed is configured with `processOnlyModifiedProducts`, editing the attribute marks the product modified and it is included in the next run. ## Prerequisites | Requirement | Value | | - | - | | Minimum cartridge version | `int_globale` 24.7.0 or later (adds the hook catalog column type) | | Hook handler | `globale.product.getGaranImageUrl` implemented in your project cartridge — mandatory, nothing ships by default | | SendCart mapping | Added on the Global-e side by your CSM, then synced by the `GlobaleSettings` job | | Catalog column | Added by you to the `geCatalogFeedConfig` site preference | | Feature enablement | Confirm with your Customer Success Manager that GARAN attachment is enabled for your account | ## Delivery paths The value reaches Global-e on two paths, and one hook serves both: * **SendCart / GetCart at checkout** — `SendCartData.Products[].GaranImageURL` * **GlobaleCatalogFeed** — a scheduled job that writes a CSV and uploads it to Global-e over SFTP SFCC does not use Browsing/SaveProductsList. If other Global-e documentation refers to that call for the catalog path, the SFCC equivalent is the CSV feed described here. You do not need both. Use whichever matches how you already send product data to Global-e. ## Platform notes > [!WARNING] > > The GARAN URL must be reachable from your hook handler. Putting it only in the Global-e MetaData attributes bag will not populate `GaranImageURL`. Do not reuse the product image field. `ImageURL` is the storefront photo and `GaranImageURL` is the guarantee label — Global-e keeps them as separate fields. **Variants.** The hook receives a `dw.catalog.Product` for each product exported or added to the cart, which for most catalogs means variants. If every variant shares one label, read from the master in your handler: ```javascript theme={null} exports.getGaranImageUrl = function (product) { if (!product) { return null; } if (product.custom.garanImageUrl) { return product.custom.garanImageUrl; } var master = product.variant && product.masterProduct; return (master && master.custom.garanImageUrl) || null; }; ``` Product options and gift certificates do not carry a GARAN label. Option lines send `GaranImageURL` as null; gift-certificate lines omit it entirely. **Older cartridges.** If your cartridge predates Global-e's SendCart attribute-mapping support and you are not upgrading, the SendCart value can instead be set directly in `getProduct()` in your cartridge, calling the same hook. Ask your CSM or SFCC integration contact for the snippet. ## Payload reference For technical readers. The field name is `GaranImageURL` on both paths. **Cart — `SendCartData.Products[]`** ```json theme={null} { "Products": [ { "ProductCode": "JKT-4471-BLK-M", "CartItemId": "1057", "Name": "Alpine Insulated Jacket", "OrderedQuantity": 1, "ImageURL": "https://cdn.example.com/products/jkt-4471-blk.jpg", "GaranImageURL": "https://cdn.example.com/garan/JKT-4471.png" }, { "ProductCode": "TEE-1102-WHT-L", "CartItemId": "1058", "Name": "Cotton Crew Tee", "OrderedQuantity": 1, "ImageURL": "https://cdn.example.com/products/tee-1102-wht.jpg", "GaranImageURL": null } ] } ``` The t-shirt has no guarantee — `GaranImageURL` is null and no attachment is generated for it. **Catalog — CSV over SFTP.** Column order follows your `file.columns` configuration: ```csv theme={null} ProductCode,Name,ImageURL,GaranImageURL JKT-4471-BLK-M,Alpine Insulated Jacket,https://cdn.example.com/products/jkt-4471-blk.jpg,https://cdn.example.com/garan/JKT-4471.png TEE-1102-WHT-L,Cotton Crew Tee,https://cdn.example.com/products/tee-1102-wht.jpg, ``` Products with no GARAN URL produce an empty cell, not a missing column. ## Verify | Check | Done | | - | - | | Hook handler registered and its export named exactly `getGaranImageUrl` | ☐ | | `GaranImageURL` appears in the cart payload for a product with a populated attribute | ☐ | | A product with an empty attribute sends `GaranImageURL` as null | ☐ | | Catalog feed job completes and the CSV contains a `GaranImageURL` column | ☐ | | The CSV cell is populated for a qualifying product and empty for a non-qualifying one | ☐ | | No UTIL_HOOK errors in the Global-e log after a checkout containing a product with options | ☐ | | GARAN URL returns a valid PNG (not JPG/SVG/PDF at the source URL) | ☐ | > [!NOTE] > > Activation modes and the general preparation steps — opting in, identifying qualifying products, and creating and hosting the GARAN PNG — are covered on the [EU Consumer Guarantee Information (Notice & GARAN)](/eu-consumer-guarantee-notice-and-garan) overview page. ## FAQ > [accordion] Do I have to change cartridge code? > > Yes, one handler. There is no site preference or Business Manager setting that maps an attribute directly, because the handler is what lets you read from any attribute or compute the URL. > [accordion] Can I skip the hook and just set a mapping? > > No. The mapping calls the hook; without a handler it returns null. > [accordion] Why is my GaranImageURL always empty? > > Most often the handler export is misnamed — it must be `getGaranImageUrl`, matching the last segment of the hook id. Also check that the handler is registered in a cartridge that is actually on your site's cartridge path. > [accordion] Do variants each need their own URL? > > Only if they differ. See [Platform notes](#platform-notes) for a handler that falls back to the master product. > [accordion] Can I reuse the product image attribute? > > No. `ImageURL` is the storefront photo. GARAN must come from its own attribute or logic. > [accordion] Does the catalog feed change for products without a guarantee? > > No. The column is present for every row; rows without a URL simply have an empty cell. # EU Consumer Guarantee Source: https://docs.global-e.com/eu-consumer-guarantee-setup-shopify For Shopify merchants, the platform doesn't have a built-in feature for the harmonised notice or GARAN label. You implement both through standard theme and notification customization. The steps below are platform-agnostic in spirit; how you execute each one depends on your theme and app stack. **Applies to:** orders shipping to an EU/EEA destination, from 27 September 2026. Each step below includes an implementation example for the native Shopify workflow (no third-party apps). These examples are illustrative, not prescriptive: your theme structure, app stack, and internal process may call for a different approach. Adapt as needed. ## 1. Prerequisites * Have your [GARAN label image(s)](https://commission.europa.eu/document/download/435fbeb1-fccc-4ead-bfa9-96625962ba09_en?filename=GARAN%20label%20for%20website.zip) and [harmonised notice content](https://global-e-public-files.s3.eu-west-1.amazonaws.com/Knowledge-Hub/Harmonised+notice+in+24+languages+colour+and+black+and+white_0.zip) ready (per regulation guidelines [here](/eu-consumer-guarantee-notice-and-garan#who-needs-to-do-what)), including any per-market translations. * Decide how you'll store the label per product. The common approach is a product metafield holding the label's image URL, set per product (or per product type, if the label is shared). * Host the harmonised notice image (or translated variants) somewhere accessible to your theme and email templates. The GARAN label and harmonised notice must be PNG files, not PDF. Wherever they're embedded (storefront, PDP, or email body) they render as an image, which requires an image format. A PDF won't display and will show as a broken image or a bare link. **Example (native Shopify):** 1. Upload your harmonised notice PNG (and any translated variants) to **Content > Files**, and note the resulting file URLs. ![](https://mintcdn.com/globale-enterprise/Lau_o7RR84ewzO3c/images/eu-consumer-guarantee/shopify-files-upload.png?fit=max\&auto=format\&n=Lau_o7RR84ewzO3c\&q=85\&s=3abc431fbea3510cbf8f7f94cf280eae) 2. In Shopify admin, navigate to **Settings > Metafields and metaobjects > Products** and add a metafield definition to hold the GARAN label URL (e.g. a "URL" type field). ![](https://mintcdn.com/globale-enterprise/Lau_o7RR84ewzO3c/images/eu-consumer-guarantee/shopify-product-metafield.png?fit=max\&auto=format\&n=Lau_o7RR84ewzO3c\&q=85\&s=1d61d42ed571b2b69f003627fea7d206) ## 2. Harmonised notice on the storefront Unlike the GARAN label, the harmonised notice is not tied to a specific product; it must be visible somewhere on the storefront to any shopper browsing from an EU/EEA country, regardless of what they're viewing. The footer is a common, low-effort placement since it's already present on every page. * Add the harmonised notice (as text, an image, or a link to a dedicated page) to a site-wide element such as the footer. * Gate its visibility to EU/EEA visitors only. Most themes already have some form of country/market detection you can reuse for this. **Example (native Shopify):** 1. Navigate to **Online Store > Themes > Edit code**. 2. Open the theme's footer section file. ![](https://mintcdn.com/globale-enterprise/Lau_o7RR84ewzO3c/images/eu-consumer-guarantee/shopify-theme-footer-edit-code.png?fit=max\&auto=format\&n=Lau_o7RR84ewzO3c\&q=85\&s=04304b054e898b738aed86f596dbe8bf) 3. Insert the harmonised notice (image or text), gated to EU/EEA using your theme's existing localization/market logic. 4. Save, then preview the storefront with an EU market/location selected to confirm it appears. ## 3. GARAN label on the product page (PDP) * Embed the GARAN label on the product page, visible to the shopper before purchase. Placement is flexible (near the product description, in a dedicated info block, etc.) as long as it isn't hidden behind an extra click, e.g. a collapsed tab that must be manually opened isn't sufficient. * Gate rendering on the metafield being populated, so products without a label don't show a broken image. ![](https://mintcdn.com/globale-enterprise/Lau_o7RR84ewzO3c/images/eu-consumer-guarantee/shopify-pdp-garan-label.png?fit=max\&auto=format\&n=Lau_o7RR84ewzO3c\&q=85\&s=6edc326fab78685d11e6e0dd0a0962d3) **Example (native Shopify):** 1. Still in **Edit code**, open the product template/section file used by your theme (e.g. the main product section). 2. Insert a snippet that reads the GARAN metafield for the current product and renders it as an image, only when the metafield is populated. 3. Save, then preview a product that has the metafield populated to confirm the label renders. ## 4. Harmonised notice in the order confirmation email The harmonised notice must appear in every order confirmation email sent to an EU/EEA shopper, regardless of whether any product in the order has a GARAN label. The email footer is a natural place for it, since it's rendered once regardless of cart contents. * Add the harmonised notice to the email footer (or another location that renders on every order). * Gate it to EU/EEA destinations, based on the order's shipping (or billing, if you don't collect shipping) country. ## 5. GARAN label in the order confirmation email This is separate from the notice above, and only applies when the order contains a product with a GARAN label. * Embed the GARAN label(s) for the relevant line item(s) in the email body. * Shopify's native notification templates don't support true file attachments. This is a platform limitation, not something you can configure around. Two paths: | Path | How it works | Requirement | | - | - | - | | **A. Native Shopify** | Embed the harmonised notice and GARAN label as images directly in the email body (same approach as the PDP) | None, works on any plan. Image must be PNG. | | **B. Third-party app** | Use an app that supports true file/PDF attachments to attach the notice as a document | Requires installing and configuring a compatible app. PDF is fine here, since it's a true attachment, not an embedded image. | Most merchants use Path A, since it needs no additional app. * Gate the GARAN block to EU/EEA destinations only (based on shipping country), so non-EU/EEA orders don't see it. * Reuse the same per-product metafield from step 1 to pull each order's GARAN label(s) into the email. ![](https://mintcdn.com/globale-enterprise/Lau_o7RR84ewzO3c/images/eu-consumer-guarantee/shopify-order-confirmation-email.png?fit=max\&auto=format\&n=Lau_o7RR84ewzO3c\&q=85\&s=83f24cd5fd48582d1596c32aadf93233) **Example (native Shopify, both step 4 and 5):** 1. Navigate to **Settings > Notifications > Order confirmation**, then **Edit code**. ![](https://mintcdn.com/globale-enterprise/Lau_o7RR84ewzO3c/images/eu-consumer-guarantee/shopify-notifications-edit-code.png?fit=max\&auto=format\&n=Lau_o7RR84ewzO3c\&q=85\&s=7d9ca33f6b729a623a98e013bdc442f5) 2. Insert the harmonised notice into the email footer, gated to EU/EEA shipping destinations, so it appears on every EU/EEA order. > [accordion] Snippet example > > ```liquid theme={null} > {%- comment -%} > Harmonised notice on the legal guarantee of conformity (EU consumer guarantee regulation). > Renders on every order shipping to an EU or EEA destination, regardless of product/GARAN. > {%- endcomment -%} > {%- assign eu_eea_countries = 'AT,BE,BG,CY,CZ,DE,DK,EE,ES,FI,FR,GR,HR,HU,IE,IT,LT,LU,LV,MT,NL,PL,PT,RO,SE,SI,SK,IS,LI,NO' | split: ',' -%} > {%- assign guarantee_country = shipping_address.country_code | default: billing_address.country_code -%} > {%- if eu_eea_countries contains guarantee_country -%} > > > > > > {%- endif -%} > ``` 3. Separately, insert code to embed the GARAN label(s) for line items whose product has the metafield populated, also gated to EU/EEA. > [accordion] Snippet example > > ```liquid theme={null} > {%- assign eu_countries = 'AT,BE,BG,CY,CZ,DE,DK,EE,ES,FI,FR,GR,HR,HU,IE,IT,LT,LU,LV,MT,NL,PL,PT,RO,SE,SI,SK' | split: ',' -%} > {%- if requires_shipping and shipping_address and eu_countries contains shipping_address.country_code -%} > > > > >
>
> > > > >
>

Your guarantee rights

>
> > > > >
>

> You have a legal guarantee of conformity of at least two years on the goods > in this order. This period may be longer under national law. If the goods > are not as they should be, contact us. >

> {%- assign garan_seen = '' -%} > {%- for line in line_items -%} > {%- assign garan_url = line.product.metafields.custom.garan_image_url -%} > {%- if garan_url != blank -%} > {%- unless garan_seen contains garan_url -%} >

{{ line.product.title }} - producer durability guarantee:

> src="{{ garan_url }}" > alt="GARAN label: the producer guarantees the durability of {{ line.product.title }} for more than two years, at no extra cost, covering the whole product." > width="300" > style="display:block; max-width:100%; height:auto; border:0;" > > > {%- assign garan_seen = garan_seen | append: garan_url -%} > {%- endunless -%} > {%- endif -%} > {%- endfor -%} >
>
>
> {%- endif -%} > ``` 4. Save, then send a test order to confirm both the notice and the label render correctly. ## 6. Test before going live * Place a test order shipping to an EU/EEA address and confirm the harmonised notice appears in the email footer, the GARAN label appears for eligible products (in both the email and the PDP), and nothing breaks for products without a label. * Place a test order shipping outside the EU/EEA and confirm the notice and label do not appear. ## 7. Ongoing maintenance * Populate the GARAN metafield for every new product going forward. Nothing enforces this automatically, so it's a manual step in your product-creation process. # EU Consumer Guarantee Source: https://docs.global-e.com/eu-consumer-guarantee-setup-shopware Part of the [EU Consumer Guarantee (Notice & GARAN) - Platform Setup Guides](/eu-consumer-guarantee-platform-setup-guides). ## One-time setup 1. Create a new **custom field** on the Product entity to hold the GARAN URL (text), and give it a technical name. 2. In the Global-e plugin settings, under the **Products** section, set **GARAN Image URL Attribute** to that technical name. There is no fixed custom-field name — the plugin uses whatever you enter here (same pattern as **HS Code Attribute**). 3. Make sure **Enable save product list** is switched on if you want the catalog path. If it is off, only the cart path will carry the value. ## Per product Populate the custom field on each product or variant with the full HTTPS URL of that item's GARAN PNG. Leave it empty where there is no guarantee. | Product | Custom field value | | - | - | | Alpine Insulated Jacket | `https://cdn.example.com/garan/JKT-4471.png` | | Cotton Crew Tee | (empty — no guarantee) | For variants, see [Platform notes](/eu-consumer-guarantee-setup-shopware#platform-notes) — an empty variant field can inherit the parent URL. ## When the value syncs The catalog path picks the value up when the product is written in Shopware (create or update), if **Enable save product list** is on. The cart path reads the custom field when the shopper checks out. ## Prerequisites | Requirement | Value | | - | - | | Minimum plugin version | Global-e Shopware 6 plugin 1.8.2 or later | | Catalog path toggle | **Enable save product list** must be on to use the Catalog path | | Attribute mapping | **GARAN Image URL Attribute** must name an existing product custom field | | Feature enablement | Confirm with your Customer Success Manager that this feature is enabled for your account | ## Delivery paths The value reaches Global-e on two paths: the catalog sync (`SaveProductsList`) and at checkout (SendCart / GetCart). ## Platform notes > [!WARNING] > > The GARAN URL must live on a Shopware **product custom field**. Putting the URL only in product media, extra attributes, or MetaData will not populate `GaranImageURL`. If a variant's custom field is empty and the parent product has a value, the plugin uses the parent URL. Set the field on the parent if every variant shares one label; set it on the variant when a size or colour needs a different file. Do not put the GARAN PNG in the normal product image slot. The plugin keeps `ImageURL` (storefront photo) and `GaranImageURL` (guarantee label) as separate fields. ## Payload reference For technical readers. The field name is `GaranImageURL` on both the catalog and cart contracts. **Cart — SendCartData.Products\[]** ```json theme={null} { "Products": [ { "ProductCode": "JKT-4471-BLK-M", "CartItemId": "1057", "Name": "Alpine Insulated Jacket", "OrderedQuantity": 1, "ImageURL": "https:\/\/cdn.example.com\/products\/jkt-4471-blk.jpg", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/JKT-4471.png" } ] } ``` **Catalog — POST /Browsing/SaveProductsList** (expected shape; same top-level key) ```json theme={null} [ { "ProductCode": "JKT-4471-BLK-M", "ProductGroupCode": "JKT-4471", "Name": "Alpine Insulated Jacket", "ImageURL": "https:\/\/cdn.example.com\/products\/jkt-4471-blk.jpg", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/JKT-4471.png" }, { "ProductCode": "TEE-1102-WHT-L", "Name": "Cotton Crew Tee", "ImageURL": "https:\/\/cdn.example.com\/products\/tee-1102-wht.jpg", "GaranImageURL": null } ] ``` The t-shirt has no guarantee — `GaranImageURL` is `null` and no attachment is generated for it. ## Verify | Check | Done | | - | - | | `GaranImageURL` appears in a test catalog payload for a product with a populated custom field | ☐ | | `GaranImageURL` appears in the cart payload for that product at checkout | ☐ | | A product with an empty custom field sends `GaranImageURL` as null | ☐ | | A variant with an empty field inherits the parent URL when the parent is set | ☐ | > [!NOTE] > > Activation modes and the general preparation steps — opting in, identifying qualifying products, and creating and hosting the GARAN PNG — are covered on the [EU Consumer Guarantee Information (Notice & GARAN)](/eu-consumer-guarantee-notice-and-garan) overview page. ## FAQ > [accordion] Do variants each need their own URL? > > Only if they differ. An empty variant custom field uses the parent product's value. > [accordion] Can I reuse the product image field? > > No. `ImageURL` is the storefront photo. GARAN must be a separate custom field mapped in **GARAN Image URL Attribute**. # EU Consumer Guarantee Source: https://docs.global-e.com/eu-consumer-guarantee-setup-woocommerce Part of the [EU Consumer Guarantee (Notice & GARAN) - Platform Setup Guides](/eu-consumer-guarantee-platform-setup-guides). ## One-time setup 1. In **Products → Attributes**, create an attribute to hold the GARAN URL. Use slug `garan-image-url` (the name can be something like `GARAN Image URL`). 2. Navigate to **WooCommerce → Settings → Integrations → Global-e Cross-Border Integration**. 3. In **GARAN image URL attribute**, enter `garan-image-url`. 4. Leave **Enable save product list** switched on if you want the catalog path. If it is off, only the cart path will carry the value. ## Per product Set the attribute value to the full HTTPS URL of that product's GARAN PNG. Leave it empty for products with no guarantee. | Product | Attribute value | | - | - | | Alpine Insulated Jacket | `https://cdn.example.com/garan/JKT-4471.png` | | Cotton Crew Tee | (empty — no guarantee) | For variable products, see [Platform notes](/eu-consumer-guarantee-setup-woocommerce#platform-notes) — variations do not inherit the parent value by default. ## When the value syncs The catalog path picks the value up when the product is saved or updated, if **Enable save product list** is on. Saving or updating a variable product also sends its variations. The cart path reads the attribute when the shopper checks out. ## Prerequisites | Requirement | Value | | - | - | | Minimum plugin version | Global-e Cross-Border for WooCommerce 1.17.0 or later | | Catalog path toggle | **Enable save product list** must be on to use the Catalog path | | Attribute mapping | **GARAN image URL attribute** must be set to `garan-image-url` | | Feature enablement | Confirm with your Customer Success Manager that this feature is enabled for your account | ## Delivery paths The value reaches Global-e on two paths: the catalog sync (`SaveProductsList`) and at checkout (SendCart). ## Platform notes > [!WARNING] > > The value must live on a WooCommerce **product attribute** with slug `garan-image-url`. A plain custom field or post meta key will not be read. For variable products, each variation is sent as its own row and reads its own attribute value first. A variation with an empty value falls back to the parent product **only** when **Variation inherit parent attributes** is enabled in the Global-e integration settings. That setting is off by default, so unless you turn it on, set the attribute on every variation you want covered. ## Payload reference For technical readers. The field name is `GaranImageURL` on both the catalog and cart contracts, with no per-path variation. **Catalog — POST /Browsing/SaveProductsList** ```json theme={null} [ { "ProductCode": "JKT-4471-BLK-M", "ProductGroupCode": "JKT-4471", "Name": "Alpine Insulated Jacket", "ImageURL": "https:\/\/cdn.example.com\/products\/jkt-4471-blk.jpg", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/JKT-4471.png", "OriginCountryCode": "PT", "GenericHSCode": "620193" }, { "ProductCode": "TEE-1102-WHT-L", "Name": "Cotton Crew Tee", "ImageURL": "https:\/\/cdn.example.com\/products\/tee-1102-wht.jpg", "GaranImageURL": null, "OriginCountryCode": "PT", "GenericHSCode": "610910" } ] ``` The t-shirt has no guarantee — `GaranImageURL` is `null` and no attachment is generated for it. Omitting the property entirely has the same effect as `null`. **Cart — SendCartData.Products\[]** ```json theme={null} { "Products": [ { "ProductCode": "JKT-4471-BLK-M", "CartItemId": "1057", "Name": "Alpine Insulated Jacket", "OrderedQuantity": 1, "ImageURL": "https:\/\/cdn.example.com\/products\/jkt-4471-blk.jpg", "GaranImageURL": "https:\/\/cdn.example.com\/garan\/JKT-4471.png", "GenericHSCode": "620193" } ] } ``` ## Verify | Check | Done | | - | - | | `GaranImageURL` appears in a test catalog payload for a product with a populated attribute | ☐ | | `GaranImageURL` appears in the cart payload for that product at checkout | ☐ | | A product with an empty attribute sends `GaranImageURL` as null or omits it | ☐ | | Each variation of a variable product carries the URL you expect | ☐ | > [!NOTE] > > Activation modes and the general preparation steps — opting in, identifying qualifying products, and creating and hosting the GARAN PNG — are covered on the [EU Consumer Guarantee Information (Notice & GARAN)](/eu-consumer-guarantee-notice-and-garan) overview page. ## FAQ > [accordion] Do product variants each need their own URL? > > By default yes — set the attribute on each variation. If you enable **Variation inherit parent attributes**, variations with no value of their own will use the parent product's URL instead. > [accordion] Can I use a custom field instead of an attribute? > > No. The plugin reads the WooCommerce product attribute with slug `garan-image-url` only. # EU Deforestation Regulation (EUDR) Source: https://docs.global-e.com/eu-deforestation-regulation-eudr ## Overview * **What:** Regulation (EU) 2023/1115 on deforestation-free products, amended by Regulation (EU) 2025/2650 (Dec 2025). It replaces the EU Timber Regulation. * **Which goods:** products derived from **7 commodities – cattle, cocoa, coffee, oil palm, rubber, soya, wood** – but only the HS/CN codes listed in **Annex I** (closed list, see [Product scope](#annex-i-hs-codes)). Not on the list = not in scope, even if the product contains the commodity. * **Condition to trade:** from **30 December 2026** such goods may enter or leave the EU only if they are deforestation-free (land not deforested after 31 Dec 2020), legally produced, and covered by a **Due Diligence Statement (DDS)** filed in the EU Information System (TRACES) before the goods move. * **Who files:** the **Operator** = whoever first places the product on the EU market (import) or exports it from the EU. In Global-e's cross-border model this is, in principle, the **merchant**. Customs brokers and carriers have no EUDR duty of their own. * **Enforcement:** the customs declaration must quote a valid DDS reference and TARIC document code. No reference = shipment blocked. Fines up to 4% of EU turnover, confiscation. ## What is changing Global-e transmits DDS Reference and Taric document code to a Carrier on your behalf. The values are passed via Ship Request or Commercial Invoice. The Carrier/Broker must submit the EUDR info electronically via Customs Declaration. ## Timeline | Date | Milestone | | - | - | | **29 June 2023** | EUDR enters into force. | | **17 September 2026** | Delegated Regulation (EU) 2026/2102 published in the Official Journal (in force 18 Sep 2026): leather 4101/4104/4107, belts 4010, other vulcanised rubber articles 4016, retreaded tyres, seed soya and aircraft/car seats are out of scope; soluble coffee, palm-oil derivatives and frozen cattle tongues added from 30 Dec 2027. | | **30 December 2026** | **Application date** for large/medium operators and traders (and micro/small in the timber sector). Contingency plan for IS outages must be in place. | | **30 June 2027** | Application date for micro and small operators. | | **30 December 2027** | Newly added products apply (soluble coffee 2101 11, palm-oil derivatives incl. soap, frozen cattle tongues 0206 21). | ## Why it matters The goal of EUDR is to reduce global deforestation and forest degradation. Its objective is to increase supply chain transparency and make companies accountable for proving that regulated products entering the EU are deforestation-free and legally produced. An item that arrives without a Due Diligence Statement Reference becomes a candidate for customs hold, inspection or rejection — delayed deliveries and a poor experience for your customers. ## Does this apply to me? Yes. If you Import or Export to/from EU and your product falls under the [EUDR Annex I HS codes list](#annex-i-hs-codes) ## GE solution * Merchant is to provide a DDS reference or Taric Code for Exemption cases per SKU. * Merchant has two option to deliver the EUDR data to GE: Via Platform/product Attributes or a [SFTP server/File upload](/eu-deforestation-regulation-sftp-file-guide). * GE will Store the values and transmit to Carriers via Ship Request or Commercial invoice. * The document will contain Taric Document code and DDS reference \[if applicable] ## Merchant role 1. Review the affected SKUs 2. Collect supplier data. 3. Create an EU Login into a personal account in EU Information system, TRACES. 4. Register in the EU Information System, TRACES with the company’s own EORI, Operator role, Activity Export; File the DDS. * If not registered, need to request a new Operator Role * Non-EU company need to get EU EORI number in addition. 5. File the Due Diligence Statement. 6. Send the DDS references or Taric Document code to Global-e per SKU. ## TARIC document code supported by GE | Taric Document Code | Declared for | Description | DDS required? | Exemption | | - | - | - | - | - | | C716 | Import / Export | DDS reference on customs declaration — DDS reference must be supplied | Yes | No | | C720 | Re-import | Downstream operators quote original/upstream DDS reference | Yes | No | | Y129 | Import / Export | Exemption for “ex” HS codes — product not made from an EUDR-relevant commodity | No | Yes | | Y196 | Export | Export by Non-SME downstream operators | No | Yes | | Y188 | Export | Export by SME downstream operators | No | Yes | ## What EUDR Information Does the Merchant Need to Provide? The EUDR information required depends on the merchant's role in the supply chain. **For Exports** Provide one of the following: | If you are... | Provide | | - | - | | **A Downstream Non-SME Exporter** | Y196 | | **A Downstream SME Exporter** | Y188 | | **An Operator** | DDS Reference Number | | **An Operator** | Y129 | > [!NOTE] > > * If you provide a DDS Reference Number, Global-e will submit C716 + provided DDS reference. > * If you are providing Y196 or Y188, no DDS Reference Number is required. Global-e will submit the provided Taric document code. > * Global-e does not determine whether a merchant qualifies as an SME or Non-SME. Merchants are responsible for providing the appropriate code. > * If neither DDS nor Exemption Taric code are provided, the default code is Y196. **For Imports** Provide: | Scenario | Provide | | - | - | | **Import** | DDS Reference Number | | **Import** | Y129 | > [!NOTE] > > Global-e will submit C716+provided DDS reference. **For Re-Imports \[Return into EU]** The merchant does not need to provide data. > [!NOTE] > > Global-e will submit C720 + DDS reference from the original Order. **Quick Reference** | Flow | Merchant Must Provide | | - | - | | **Export (Downstream Non-SME)** | Y196 | | **Export (Downstream SME)** | Y188 | | **Export (Operator)** | DDS Reference Number | | **Import** | DDS Reference Number | | **Export (Operator) / Import** | Y129 | ## Platform setup guides | Platform | Guide | | - | - | | Shopify | Pending Shopify support for native platform fields. | | PrestaShop | [EU Deforestation Regulation (EUDR) — PrestaShop](/eu-deforestation-regulation-setup-prestashop) | | WooCommerce | [EU Deforestation Regulation (EUDR) — WooCommerce](/eu-deforestation-regulation-setup-woocommerce) | | BigCommerce | The Platform Guide is currently being finalized and will be published soon. | | Centra | The Platform Guide is currently being finalized and will be published soon. | | Magento 2 Lite | [EU Deforestation Regulation (EUDR) — Magento 2 Lite](/eu-deforestation-regulation-setup-magento2-lite) | | Magento 2 Full | [EU Deforestation Regulation (EUDR) — Magento 2 Full](/eu-deforestation-regulation-setup-magento2) | | Shopware 6 | [EU Deforestation Regulation (EUDR) — Shopware 6](/eu-deforestation-regulation-setup-shopware) | | Hybris | [EU Deforestation Regulation (EUDR) — Hybris](/eu-deforestation-regulation-setup-hybris) | | SFCC | The Platform Guide is currently being finalized and will be published soon. | | Wix | [EU Deforestation Regulation (EUDR) — Wix](/eu-deforestation-regulation-setup-wix) | | Global-e Module (1.0, 2.0) | [EU Deforestation Regulation (EUDR) — Global-e Module](/eu-deforestation-regulation-setup-global-e-module) | | ShopLine | The Platform Guide is currently being finalized and will be published soon. | ## CSV file guide | File | Guide | | - | - | | CSV file template | [Data Requirements for Global-e Merchants using SFTP server as a DDS source for EUDR regulation](/eu-deforestation-regulation-sftp-file-guide) | ## Frequently asked questions > [accordion] What does EUDR stand for and what does it do? > > EU Deforestation Regulation. It bans placing on the EU market, or exporting from the EU, products made from cattle, cocoa, coffee, oil palm, rubber, soya or wood unless they are proven deforestation-free and legal and are covered by a Due Diligence Statement (DDS). > [accordion] When does it apply? > > **30 Dec 2026** for large and medium companies (and micro/small companies in the timber sector). **30 Jun 2027** for other micro/small companies (\<50 staff and \<€10M turnover). **30 Dec 2027** for products newly added by Delegated Regulation (EU) 2026/2102 (soluble coffee, palm-oil derivatives incl. soap, frozen cattle tongues). The Commission has confirmed there will be no further delay. > [accordion] Is it only about imports into the EU? > > No. It also covers **exports from the EU**. EU merchants exporting notebooks, wooden goods, chocolate etc. to the UK, US, Australia… need a DDS too (activity "Export"). > [accordion] Does it apply to non-EU companies (UK, US, Israel…)? > > Yes. Any company that places in-scope goods on the EU market is an Operator, wherever it is established. Non-EU companies need an **EU EORI** to register (a GB EORI or US EIN is not accepted). > [accordion] What happens if there is no DDS? > > From 30 Dec 2026 EU customs will not release the parcel (import) or will not let it leave (export). Competent authorities can fine (up to 4% of EU turnover), confiscate goods and exclude from public procurement. ## References | Reference | What it covers | Where | | - | - | - | | **EU TRACES helpdesk** | Registration, validation, IT (Mon–Fri 08:30–18:00 Brussels) | [SANTE-TRACES@ec.europa.eu](mailto:SANTE-TRACES@ec.europa.eu) | | **Commission EUDR implementation site** | Guidance, FAQ, competent-authority list, training | [green-forum.ec.europa.eu → Deforestation Regulation implementation](https://green-forum.ec.europa.eu/deforestation-regulation-implementation_en) | | **Information System (official Commission page)** | Production and acceptance servers, free virtual training sessions (Zoom, several dates per month – register on the page), recordings of past sessions, the Information System User Guide, GeoJSON geolocation format and the API documentation (CIRCABC) | [The Information System of the EU Deforestation Regulation](https://green-forum.ec.europa.eu/nature-and-biodiversity/deforestation-regulation-implementation/information-system-deforestation-regulation_en) | | **Information System – direct links** | Production server (legal value) · acceptance server (training/testing, no legal value – separate registration needed for each environment) · User Guide · API reference · EUDR newsletter | [production server](https://eudr.webcloud.ec.europa.eu/tracesnt/login) · [acceptance server](https://acceptance.eudr.webcloud.ec.europa.eu/tracesnt/login) · [User Guide](https://circabc.europa.eu/ui/group/34861680-e799-4d7c-bbad-da83c45da458/library/6dd87338-661c-48d7-8a61-f900cbe4f6db/details) · [API reference](https://circabc.europa.eu/ui/group/34861680-e799-4d7c-bbad-da83c45da458/library/3819b9e2-b889-4714-9bb3-b4dde1ebe649?p=1\&n=10\&sort=modified_DESC) · [EUDR newsletter](https://ec.europa.eu/newsroom/env/user-subscriptions/7236/create) | | **Legal texts** | Regulation (EU) 2023/1115 · Regulation (EU) 2025/2650 · Delegated Regulation (EU) 2026/2102 (OJ L 17 Sep 2026) and SWD(2026) 194 · Implementing Regulation (EU) 2026/1565 · Implementing Regulation (EU) 2025/1093 · DG TAXUD TARIC data document, Rev 1 (23 Sep 2026) | [Regulation (EU) 2023/1115](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX%3A32023R1115) · [Regulation (EU) 2025/2650](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX%3A32025R2650) · [DG TAXUD TARIC data document, Rev 1 (23 Sep 2026)](https://eos-oes.eu/2026/09/26/eudr-updated-taric-document/) | | **To create an EU login into personal account in TRACES** | — | [webgate.ec.europa.eu/cas](https://webgate.ec.europa.eu/cas) | | **Create a new Operator Role** | — | [eudr.webcloud.ec.europa.eu/tracesnt/](https://eudr.webcloud.ec.europa.eu/tracesnt/) | | **Due Diligence Statement** | Data should be collected for each in-scope product: HS code (the DDS is filed per HS code; the Global-e classification can be used), product description, estimated quantity, country of production, geolocation (GPS point or polygon) of every plot where the wood/pulp, rubber, cocoa etc. was produced, production date range, supplier details, legality documentation. | — | | **Filing the Due Diligence Statement to TRACES** | Can be done Manually in the web UI, by CSV upload or via API. One DDS can cover many products and an estimated annual quantity for up to 12 months. The system returns a reference number and a verification number; amendments possible within 72 hours. | — | | **Connection with TRACES** | Can be practiced first in the acceptance environment | [acceptance.eudr.webcloud.ec.europa.eu/tracesnt/](https://acceptance.eudr.webcloud.ec.europa.eu/tracesnt/) | | **Free official training webinars and recorded sessions on how to register and submit a DDS** | — | [Commission – Information System page](https://green-forum.ec.europa.eu/nature-and-biodiversity/deforestation-regulation-implementation/information-system-deforestation-regulation_en) | ## Annex I HS codes Status as of 25 October 2026. "ex" = only the part of the code made of the relevant commodity (e.g. seats *of wood*, *natural* rubber, cattle of genus *Bos*). Annex I as amended by Delegated Regulation (EU) 2026/2102 (in force 18 Sep 2026): removals are effective; additions apply from 30 Dec 2027. | Commodity | CN/HS code | Product | Status | | - | - | - | - | | **Cattle** | 0102 21, 0102 29 | Live cattle | In scope | | **Cattle** | ex 0201, ex 0202 | Meat of cattle, fresh/chilled/frozen | In scope | | **Cattle** | ex 0206 10/22/29 | Edible offal of cattle | In scope | | **Cattle** | ex 0206 21 00 | Frozen cattle tongues | Added – applies 30 Dec 2027 | | **Cattle** | ex 1602 50 | Prepared/preserved meat of cattle | In scope | | **Cattle** | ex 4101, ex 4104, ex 4107 | Raw hides, tanned hides, prepared leather of cattle | Removed 18 Sep 2026 | | **Cocoa** | 1801–1805 | Cocoa beans, shells, paste, butter, powder | In scope | | **Cocoa** | 1806 | Chocolate and food preparations containing cocoa | In scope – consumer-relevant | | **Coffee** | 0901 | Coffee, roasted or not; husks; substitutes containing coffee | In scope | | **Coffee** | 2101 11 00 | Soluble / instant coffee, extracts | Added – applies 30 Dec 2027 | | **Oil palm** | 1207 10, 1511, 1513 21, 1513 29, 2306 60 | Palm nuts/kernels, palm oil and fractions, palm kernel oil, oilcake | In scope | | **Oil palm** | ex 2905 45, 2915 70, 2915 90, 3823 11/12/19/70 | Glycerol ≥95%, palmitic/stearic acid, industrial fatty acids and alcohols | In scope | | **Oil palm** | ex 2916 15 + further derivatives (Ch. 15/29/34/38), incl. soap | Oleic/linoleic acids, fatty alcohols, soap made with palm oil | Added – applies 30 Dec 2027 | | **Rubber** | 4001 | Natural rubber (Hevea only; synthetic out) | In scope | | **Rubber** | ex 4005–4008 | Compounded/unvulcanised rubber, thread, plates and sheets | In scope | | **Rubber** | ex 4010 | Conveyor and transmission belts | Removed 18 Sep 2026 | | **Rubber** | ex 4011 | New pneumatic tyres | In scope | | **Rubber** | ex 4012 | Retreaded/used tyres, treads, flaps | In scope – only new tyre treads 4012 90 30 | | **Rubber** | ex 4013 | Inner tubes | In scope | | **Rubber** | ex 4015 | Rubber apparel and accessories incl. gloves | In scope | | **Rubber** | ex 4016 | Other articles of vulcanised rubber (mats, erasers, seals…) | Removed 18 Sep 2026 | | **Rubber** | ex 4017 | Hard rubber (ebonite) | In scope | | **Soya** | 1201, 1208 10, 1507, 2304 | Soya beans, flour, oil, oilcake | In scope (seed for sowing excluded since 18 Sep 2026) | | **Wood** | 4401–4413 | Fuel wood, charcoal, rough/sawn wood, veneer, boards, plywood, densified wood | In scope | | **Wood** | 4414 | Wooden frames for pictures, photos, mirrors | In scope – consumer-relevant | | **Wood** | 4415–4418 | Packing cases/pallets (sold as products), casks, tool handles, joinery | In scope | | **Wood** | 4419, 4420, 4421 | Wooden tableware, ornaments/caskets, other articles of wood | In scope – consumer-relevant | | **Wood** | Chapter 47 (all) | Pulp of wood (except bamboo and recovered) | In scope | | **Wood** | Chapter 48 (all) | Paper and paperboard and articles: 4814 wallpaper, 4817 envelopes, 4819 boxes/bags, 4820 notebooks/diaries, 4823 other articles (except bamboo/recovered; marketing material and correspondence exempt) | In scope | | **Wood** | ex Chapter 49 | Printed books, newspapers, pictures | Removed (Reg. 2025/2650) | | **Wood** | ex 9401 | Seats and parts, of wood | In scope (9401 10/20 aircraft & car seats removed 18 Sep 2026) | | **Wood** | 9403 30/40/50/60/91 | Wooden furniture and parts | In scope – consumer-relevant | | **Wood** | 9406 10 | Prefabricated wooden buildings | In scope | > [!NOTE] > > **Common misconceptions:** finished leather goods (bags, wallets, belts – Ch. 42), footwear (Ch. 64, even with rubber soles), textiles, cosmetics and soap (until 30 Dec 2027), printed books/newspapers (Ch. 49), synthetic rubber and bamboo/rattan products are **not** in scope. # EU Deforestation Regulation (EUDR) Source: https://docs.global-e.com/eu-deforestation-regulation-setup-global-e-module Part of [EU Deforestation Regulation (EUDR)](/eu-deforestation-regulation-eudr). On Global-e Module 2.0, Global-e does not read EUDR values from your catalog or add them for you. Global-e Module passes your GetCart response through as-is: whatever you place on each cart line is exactly what Global-e receives. This means all setup happens in your cart API or middleware. ## What you need to do 1. Keep the DDS reference and TARIC document code in your catalog or PIM under whatever field names you already use. 2. When Global-e calls your GetCart endpoint at checkout, map those values onto each cart line inside `MetaData.Attributes`, using the exact keys below. | Sent as | What it holds | When to leave it out | | - | - | - | | `eudrDdsReference` | The Due Diligence Statement (DDS) reference for that line | When the item has no DDS reference | | `eudrTaricCode` | The TARIC document code for that line | When the item has no TARIC document code | ```json theme={null} "MetaData": { "Attributes": [ { "AttributeKey": "eudrDdsReference", "AttributeValue": "99EU9999999999" }, { "AttributeKey": "eudrTaricCode", "AttributeValue": "C716" } ] } ``` ## Key points * **One set of values per cart line.** Each line carries its own pair. * **Use the right collection.** These go on `MetaData.Attributes` (with `AttributeKey` / `AttributeValue`), not the separate per-product `Attributes` collection used for display and duties. * **Omit, don't fake.** When you have no value, leave the key out entirely. Never send an empty string, NA, 0 or -. * **EU PID and US MID keep working alongside it.** If you already send `standardcode`, `mididentifier` or the US MID keys, keep sending them and add the EUDR keys to the same list. ## Quick check before go-live | Check | Done | | - | - | | Each cart line carries `eudrDdsReference` and `eudrTaricCode` when it has values | ☐ | | Lines with no value omit the key (no empty string or placeholder) | ☐ | | The keys sit on `MetaData.Attributes`, not the display and duties `Attributes` collection | ☐ | | EU PID and US MID keys still pass through unchanged | ☐ | # EU Deforestation Regulation (EUDR) Source: https://docs.global-e.com/eu-deforestation-regulation-setup-hybris Part of [EU Deforestation Regulation (EUDR)](/eu-deforestation-regulation-eudr). On SAP Commerce (Hybris), the Global-e addon reads the product attributes you list in configuration and sends them to Global-e at checkout as `eudrDdsReference` and `eudrTaricCode`. This uses the same configuration properties as EU Product Identifiers (PID). ## Prerequisites | Requirement | Value | | - | - | | Minimum plugin version | Global-e plugin `2211.12` | ## What you need to do 1. Store the DDS reference and TARIC document code in product attributes defined in the **Type System** (`items.xml`). Classification attributes and Dynamic Attributes are not supported. 2. Populate the values on each variant that can appear in the cart. If a variant has no value, the addon uses the value on the parent (base) product. 3. Add the attributes to the two Global-e configuration properties, in the **Administration Console (HAC)** or in `local.properties`. If you already send EU Product Identifiers, append the EUDR attributes to the same properties: ``` globale.product.metadata.attributes=ean,manufacturerAID,eudrDdsReference,eudrTaricCode globale.product.metadata.attributes.map={"ean":"standardcode","manufacturerAID":"mididentifier","eudrDdsReference":"eudrDdsReference","eudrTaricCode":"eudrTaricCode"} ``` `globale.product.metadata.attributes` is a comma-separated list of the attribute qualifiers to send. `globale.product.metadata.attributes.map` maps each qualifier to the key Global-e receives. The mapped values must be exactly `eudrDdsReference` and `eudrTaricCode`. If your values are stored in attributes with different qualifiers, use those qualifiers in both properties. 4. Place a test order and confirm both keys appear when values exist and are omitted when blank. | Sent as | What it holds | When to leave it out | | - | - | - | | `eudrDdsReference` | The Due Diligence Statement (DDS) reference for that variant | When the item has no DDS reference | | `eudrTaricCode` | The TARIC document code for that variant | When the item has no TARIC document code | ## How Global-e reads the values For each cart line and each mapped attribute, the addon uses the first non-empty value: 1. The attribute on the variant in the cart 2. The same attribute on the parent (base) product 3. Otherwise omit ## Key points * **Type System attributes only.** Values held in Classification attributes or Dynamic Attributes are not read. * **Exact camelCase keys.** The keys Global-e receives are whatever you put in the map, so use exactly `eudrDdsReference` and `eudrTaricCode`. * **Omit, don't fake.** When an attribute is blank, the addon leaves it out. Never enter a placeholder such as NA, 0 or -. * **EU PID keeps working.** `standardcode` and `mididentifier` are sent unchanged alongside the EUDR keys. ## Quick check before go-live | Check | Done | | - | - | | DDS reference and TARIC document code stored in **Type System** attributes | ☐ | | Both configuration properties include the EUDR attributes, with the map using `eudrDdsReference` and `eudrTaricCode` | ☐ | | `eudrDdsReference` and `eudrTaricCode` appear in SendCart when values exist | ☐ | | Keys omitted when a variant and its parent have no value | ☐ | | `standardcode` and `mididentifier` still appear when configured | ☐ | # EU Deforestation Regulation (EUDR) Source: https://docs.global-e.com/eu-deforestation-regulation-setup-magento2 Part of [EU Deforestation Regulation (EUDR)](/eu-deforestation-regulation-eudr). On Magento, the two EUDR values are read from product attributes at checkout and sent to Global-e by the Global-e module. This is a configuration task, not custom code: you create two product attributes, list them in the module settings, and populate the values on your products. On Magento the attribute codes themselves must be exactly `eudrDdsReference` and `eudrTaricCode`. ## Prerequisites | Requirement | Value | | - | - | | Minimum version | Global-e 2.6.0 | ## What you need to do 1. **Create two product attributes.** Navigate to **Stores**, then **Attributes**, then **Product**. ![Stores menu with Attributes, Product highlighted](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/magento2-stores-attributes-product.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=158afa094a91be240b97ff0777962cd0) 2. Click **Add Attribute** and create two attributes with the codes `eudrDdsReference` and `eudrTaricCode`. Set **Catalog Input Type** to **Text Field** and **Values Required** to **No**. ![New Product Attribute form with the EUDR attribute codes in Default Label](https://mintcdn.com/globale-enterprise/MMwnCGVEBp9Y6xhy/images/eu-deforestation-regulation-setup-magento2-magento2-lite-new-product-attribute-eudr.png?fit=max\&auto=format\&n=MMwnCGVEBp9Y6xhy\&q=85\&s=bc9685560e3bddfe77c9f8797a8084c9) 3. **List them in the Global-e module.** Navigate to **Stores**, then **Configuration**, then **Services**, then **Global-e**, then **Global-E API Settings**, then **Products**. Enter `eudrDdsReference,eudrTaricCode` (comma-separated, no spaces) in both fields: **Extra Product Attributes (Configurable)**, and **Extra Product Attributes (Simple)**. If you already list EU Product Identifiers or US MID attributes, append the EUDR codes to the same list in both fields. ![Extra Product Attributes (Configurable) and (Simple) set to the EUDR attribute codes](https://mintcdn.com/globale-enterprise/MMwnCGVEBp9Y6xhy/images/eu-deforestation-regulation-setup-magento2-magento2-extra-product-attributes-eudr.png?fit=max\&auto=format\&n=MMwnCGVEBp9Y6xhy\&q=85\&s=c9a3ef3062ca45ddc35862356daf558e) 4. **Save and flush cache.** Click **Save Config**, then flush the Magento cache (**System**, **Cache Management**, **Flush Magento Cache**). ![Flush Magento Cache button in Cache Management](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/magento2-flush-cache.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=b2767d0a81950ca02db9235c0fa08afd) 5. Populate the values on each variant and/or configurable parent. | Sent as | What it holds | When to leave it out | | - | - | - | | `eudrDdsReference` | The Due Diligence Statement (DDS) reference for that variant | When the item has no DDS reference | | `eudrTaricCode` | The TARIC document code for that variant | When the item has no TARIC document code | ## Key points * **One pair of values per cart line.** For simple products, populate that SKU's attributes. For configurable products, set values on the parent, on each child, or both: when a child has no value, the module uses the parent's value. * **Both settings must match.** List `eudrDdsReference,eudrTaricCode` in both Extra Product Attributes (Configurable) and Extra Product Attributes (Simple). * **Exact camelCase.** The Magento attribute codes and the keys sent to Global-e are both `eudrDdsReference` and `eudrTaricCode`. * **Omit, don't fake.** When a variant has no value, leave the key out. Never send an empty string, NA, 0 or -. * **EU PID keeps working.** `standardcode` and `mididentifier` are sent unchanged alongside the EUDR keys. ## Quick check before go-live | Check | Done | | - | - | | Two attributes created with codes `eudrDdsReference` and `eudrTaricCode`, added to the attribute set | ☐ | | Both **Extra Product Attributes** settings list `eudrDdsReference,eudrTaricCode` | ☐ | | Values populated on each variant (or on the configurable parent for inheritance) | ☐ | | `eudrDdsReference` and `eudrTaricCode` appear when the variant has values | ☐ | | Keys are omitted (not empty) when a variant has no value | ☐ | | Configurable child inherits the parent when the child is blank | ☐ | | Cache flushed after the configuration change | ☐ | # EU Deforestation Regulation (EUDR) Source: https://docs.global-e.com/eu-deforestation-regulation-setup-magento2-lite Part of [EU Deforestation Regulation (EUDR)](/eu-deforestation-regulation-eudr). On Magento, the two EUDR values are read from product attributes at checkout and sent to Global-e by the Global-e module. This is a configuration task, not custom code: you create two product attributes, list them in the module settings, and populate the values on your products. On Magento the attribute codes themselves must be exactly `eudrDdsReference` and `eudrTaricCode`. ## Prerequisites | Requirement | Value | | - | - | | Minimum plugin version | Global-e plugin 1.14.4 | You can check your plugin version by looking at: **src/BrowsingLite/etc/module.xml** ## What you need to do 1. **Create two product attributes.** Navigate to **Stores**, then **Attributes**, then **Product**. ![Stores menu with Attributes, Product highlighted](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/magento2-lite-stores-attributes-product.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=d11de0c1118ccda1b3c32c4f15340040) 2. Click **Add Attribute** and create two attributes with the codes `eudrDdsReference` and `eudrTaricCode`. Set **Catalog Input Type** to **Text Field** and **Values Required** to **No**. ![New Product Attribute form with the EUDR attribute codes in Default Label](https://mintcdn.com/globale-enterprise/MMwnCGVEBp9Y6xhy/images/eu-deforestation-regulation-setup-magento2-lite-magento2-lite-new-product-attribute-eudr.png?fit=max\&auto=format\&n=MMwnCGVEBp9Y6xhy\&q=85\&s=055f3ef5001be4b9e4eedb38205c43fc) 3. **List them in the Global-e module.** Navigate to **Stores**, then **Configuration**, then **Services**, then **Global-e Crossborder**, then **Global-E API Settings**, then **Products**. Enter `eudrDdsReference,eudrTaricCode` (comma-separated, no spaces) in both fields: **Extra Product Attributes**, and **Extra Product Attributes From Simple**. If you already list EU Product Identifiers or US MID attributes, append the EUDR codes to the same list in both fields. ![Extra Product Attributes and Extra Product Attributes From Simple set to the EUDR attribute codes](https://mintcdn.com/globale-enterprise/MMwnCGVEBp9Y6xhy/images/eu-deforestation-regulation-setup-magento2-lite-magento2-lite-extra-product-attributes-eudr.png?fit=max\&auto=format\&n=MMwnCGVEBp9Y6xhy\&q=85\&s=ecf5c4f0e6ef670f14477f4b3bdd6b81) 4. **Save and flush cache.** Click **Save Config**, then flush the Magento cache (**System**, **Cache Management**, **Flush Magento Cache**). ![Flush Magento Cache button in Cache Management](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/magento2-lite-flush-cache.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=412f2d136c36382099fd2e95a71da070) 5. Populate the values on each variant and/or configurable parent. | Sent as | What it holds | When to leave it out | | - | - | - | | `eudrDdsReference` | The Due Diligence Statement (DDS) reference for that variant | When the item has no DDS reference | | `eudrTaricCode` | The TARIC document code for that variant | When the item has no TARIC document code | ## Key points * **One pair of values per cart line.** For simple products, populate that SKU's attributes. For configurable products, set values on the parent, on each child, or both: when a child has no value, the module uses the parent's value. * **Both settings must match.** List `eudrDdsReference,eudrTaricCode` in both Extra Product Attributes and Extra Product Attributes From Simple. * **Exact camelCase.** The Magento attribute codes and the keys sent to Global-e are both `eudrDdsReference` and `eudrTaricCode`. * **Omit, don't fake.** When a variant has no value, leave the key out. Never send an empty string, NA, 0 or -. * **EU PID keeps working.** `standardcode` and `mididentifier` are sent unchanged alongside the EUDR keys. ## Quick check before go-live | Check | Done | | - | - | | Two attributes created with codes `eudrDdsReference` and `eudrTaricCode`, added to the attribute set | ☐ | | Both **Extra Product Attributes** settings list `eudrDdsReference,eudrTaricCode` | ☐ | | Values populated on each variant (or on the configurable parent for inheritance) | ☐ | | `eudrDdsReference` and `eudrTaricCode` appear when the variant has values | ☐ | | Keys are omitted (not empty) when a variant has no value | ☐ | | Configurable child inherits the parent when the child is blank | ☐ | | Cache flushed after the configuration change | ☐ | # EU Deforestation Regulation (EUDR) Source: https://docs.global-e.com/eu-deforestation-regulation-setup-prestashop Part of [EU Deforestation Regulation (EUDR)](/eu-deforestation-regulation-eudr). On PrestaShop, you hold the two EUDR values in product Features, then list those feature names in the Global-e module. The module sends them to Global-e at checkout. ## Prerequisites | Requirement | Value | | - | - | | Minimum plugin version | Global-e PrestaShop plugin 1.2.2 | You can check your plugin version by going to **Modules → Module manager** ![Global-e plugin version under Modules, Module manager](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/prestashop-plugin-version.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=120270f339f0c2df7e0d5afe0be0a904) ## What you need to do 1. **Create the features.** Navigate to **Catalog**, then **Attributes & Features**, then **Features**. Create features named exactly `eudrDdsReference` and `eudrTaricCode`. ![Features list under Catalog, Attributes & Features, with Add new feature highlighted](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/prestashop-features-list.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=7c04c58d551ed47d475aefa374b47fe0) 2. **Set values per product.** On each product, open the **Features** tab and assign a customised value for each feature. Leave a feature blank when you have nothing to send. ![Features section on the product page, with eudrDdsReference selected and a customised value](https://mintcdn.com/globale-enterprise/MMwnCGVEBp9Y6xhy/images/eu-deforestation-regulation-setup-prestashop-prestashop-product-features-eudr.png?fit=max\&auto=format\&n=MMwnCGVEBp9Y6xhy\&q=85\&s=bdeaffd74b65a47e670bb984698f11c6) 3. **List the features in the module.** Navigate to **Modules**, then **Module Manager**, then **Global-e Cross-Border**, then **Configure**, then **Products**. In **Product extra meta data**, add the feature names comma-separated: `eudrDdsReference,eudrTaricCode`. If you already list EU Product Identifiers features, append the EUDR names to the same list. ![Product extra meta data in the Global-e Cross-Border module settings, set to the EUDR feature names](https://mintcdn.com/globale-enterprise/MMwnCGVEBp9Y6xhy/images/eu-deforestation-regulation-setup-prestashop-prestashop-product-extra-meta-data-eudr.png?fit=max\&auto=format\&n=MMwnCGVEBp9Y6xhy\&q=85\&s=74cf53736d78430fc153666bcbb228c5) 4. Save the module settings, place a test order, and confirm the values appear when populated and are omitted when blank. | Sent as | What it holds | When to leave it out | | - | - | - | | `eudrDdsReference` | The Due Diligence Statement (DDS) reference for that product | When the item has no DDS reference | | `eudrTaricCode` | The TARIC document code for that product | When the item has no TARIC document code | **Do not use the native combination EAN-13.** It does not populate the EUDR keys. Use PrestaShop Features instead. **Features are set per product.** PrestaShop Features are set once per product, so all combinations of a product share the same EUDR values. If different variants of a product need different values, use separate products or confirm alternatives with your Global-e contact. ## Key points * Use Features plus the Product extra meta data setting, not the native combination EAN-13. * The values are sent under the keys `eudrDdsReference` and `eudrTaricCode`. * **Omit, don't fake.** Leave a feature blank when you have no value. Never enter NA, 0 or -. ## Quick check before go-live | Check | Done | | - | - | | Features created and given values on each product that needs them | ☐ | | Feature names listed in the module's **Product extra meta data** | ☐ | | Values appear in cart `MetaData` when populated on the product | ☐ | | Keys omitted (not empty) when a feature has no value | ☐ | | Not using the native combination EAN-13 as the EUDR source | ☐ | # EU Deforestation Regulation (EUDR) Source: https://docs.global-e.com/eu-deforestation-regulation-setup-shopware Part of [EU Deforestation Regulation (EUDR)](/eu-deforestation-regulation-eudr). On Shopware, the two EUDR values are read from your catalog at checkout and sent to Global-e by the Global-e plugin. This is a configuration task, not a code change: you store the values in your catalog, then point the plugin at the fields that hold them. ## Prerequisites | Requirement | Value | | - | - | | Minimum plugin version | Global-e Shopware 6 plugin 1.6.7 | You can check your plugin version by going to **Extensions** → **My Extensions** ![Global-e plugin version under Extensions, My Extensions](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/shopware-plugin-version.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=5beb397ccb6a89ea6182d3c0ecc8824b) ## What you need to do 1. **Store the values on your products.** Make sure each variant that can appear in the cart holds its DDS reference and TARIC document code. Use whichever catalog fields you choose. 2. **Point the plugin at those fields.** Navigate to **Extensions**, then **My Extensions** and click on **Configure** next to the **Global-e Cross-Border extension**. ![Configure next to the Global-e Cross-Border extension in My Extensions](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/shopware-configure-extension.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=1cc226443a9c31f29e1987afb1d721b9) Under **Products**, in **Product Extra Attributes**, list the technical field names that hold your DDS reference and TARIC document code. The plugin sends them to Global-e as `eudrDdsReference` and `eudrTaricCode`. ![Product Extra Attributes in the Global-e Cross-Border extension settings, with Save highlighted](https://mintcdn.com/globale-enterprise/MMwnCGVEBp9Y6xhy/images/eu-deforestation-regulation-setup-shopware-shopware-product-extra-attributes-eudr.png?fit=max\&auto=format\&n=MMwnCGVEBp9Y6xhy\&q=85\&s=9685c45634c1e5c089af0660e1ca8ace) 3. **Save**, and clear the Shopware cache if your deployment requires it. | Sent as | What it holds | When to leave it out | | - | - | - | | `eudrDdsReference` | The Due Diligence Statement (DDS) reference for that variant | When the item has no DDS reference | | `eudrTaricCode` | The TARIC document code for that variant | When the item has no TARIC document code | ## Key points * **One pair of values per variant.** Populate each variant that can appear in the cart. A value on the parent product alone is not enough when the variant has no value of its own. * **Omit, don't fake.** When a variant has no value, leave the key out. Never send an empty string, NA, 0 or -. * **EU PID keeps working.** `standardcode` and `mididentifier` are sent unchanged alongside the EUDR keys. ## Quick check before go-live | Check | Done | | - | - | | Each variant that needs EUDR data has its values in the catalog | ☐ | | The plugin's **Product Extra Attributes** lists those catalog fields | ☐ | | `eudrDdsReference` and `eudrTaricCode` appear when the variant has values | ☐ | | Keys are omitted (not empty) when a variant has no value | ☐ | | Each variant in the cart sends its own pair | ☐ | | Cache cleared after the configuration change | ☐ | # EU Deforestation Regulation (EUDR) Source: https://docs.global-e.com/eu-deforestation-regulation-setup-wix Part of [EU Deforestation Regulation (EUDR)](/eu-deforestation-regulation-eudr). On Wix, you add both EUDR values on the product page in your Wix dashboard, in the Global-E App Production section. The Global-e app reads them at checkout and sends them to Global-e as `eudrDdsReference` and `eudrTaricCode`. ## Where each value goes | Value | Wix field | Where to find it | | - | - | - | | `eudrDdsReference` | eudrDdsReference | Product page, Global-E App Production section | | `eudrTaricCode` | eudrTaricCode | Product page, Global-E App Production section | ## Adding the required data on the product page 1. In your Wix dashboard, navigate to **Products** and open the product. 2. Scroll to the **Global-E App Production** section at the bottom of the product page and fill in the DDS reference and the TARIC document code. ![Global-E App Production section on the Wix product page, with the eudrDdsReference and eudrTaricCode fields](https://mintcdn.com/globale-enterprise/MMwnCGVEBp9Y6xhy/images/eu-deforestation-regulation-setup-wix-wix-global-e-app-production-eudr.png?fit=max\&auto=format\&n=MMwnCGVEBp9Y6xhy\&q=85\&s=d83bfcf37dd7f9ce82be3fdb28b6ce1f) 3. Save the product, place a test order, and confirm both keys appear when values exist and are omitted when blank. | Sent as | What it holds | When to leave it out | | - | - | - | | `eudrDdsReference` | The Due Diligence Statement (DDS) reference for that product | When the item has no DDS reference | | `eudrTaricCode` | The TARIC document code for that product | When the item has no TARIC document code | ## Key points * **Omit, don't fake.** Leave the field empty when you have no value. Never enter NA, 0 or -. * **EU PID keeps working.** Barcode (GTIN) and midIdentifier are sent unchanged alongside the EUDR values. ## Quick check before go-live | Check | Done | | - | - | | DDS reference and TARIC document code filled in under the **Global-E App Production** section on each product that needs them | ☐ | | `eudrDdsReference` and `eudrTaricCode` appear in SendCart when the item has values | ☐ | | Keys omitted (not empty) when an item has no value | ☐ | # EU Deforestation Regulation (EUDR) Source: https://docs.global-e.com/eu-deforestation-regulation-setup-woocommerce Part of [EU Deforestation Regulation (EUDR)](/eu-deforestation-regulation-eudr). On WooCommerce, the Global-e plugin sends `eudrDdsReference` and `eudrTaricCode` to Global-e at checkout. WooCommerce has no built-in field for these values, so a developer adds a short code snippet: the code filter. ## Before you start | Requirement | Minimum version | | - | - | | Global-e WooCommerce plugin | 1.14.0 | You can check your plugin version by navigating to **Plugins → Installed Plugins**. ![Global-e plugin version under Plugins, Installed Plugins](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/woocommerce-plugin-version.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=493330ee8dfd489d2aedd0f01e8d626e) ## Set up EUDR with the code filter Requires: Global-e WooCommerce plugin 1.14.0 or later. 1. Store the DDS reference and TARIC document code for each product or variation. Your developer decides where the values come from: for example, a custom field on each variation (added by your developer or a custom fields plugin), or an external system such as your ERP or PIM. 2. **Send both values with the code filter.** Add the code from **The code filter** below. 3. Place a test order and confirm both keys appear when values exist and are omitted when blank. ## The code filter The plugin's `woocommerce_globale_pro_add_cart_product_meta_attributes` filter adds key/value pairs to each cart line's MetaData. The filter reads the values from the variation when there is one, otherwise from the product, so each variation can send its own pair. Example for your theme's `functions.php` or a custom plugin. Replace the meta keys with wherever you store the values: ```php theme={null} add_filter( \GCBWC\Globale\Pro\Model\Cart::FILTER_CART_PRODUCT_META_ATTRIBUTES, 'gcbwc_add_eudr_meta_attributes', 10, 2 ); if ( ! function_exists( 'gcbwc_add_eudr_meta_attributes' ) ) : function gcbwc_add_eudr_meta_attributes( $metaAttributes, $cart_item ) { // Read from the variation when there is one, otherwise from the product. $id = ! empty( $cart_item['variation_id'] ) ? $cart_item['variation_id'] : $cart_item['product_id']; // Replace these meta keys with wherever you store the identifiers. // Option A: remove the standardcode line. $pids = array( 'eudrDdsReference' => get_post_meta( $id, '_your_eudr_dns_reference_meta_key', true ), 'eudrTaricCode' => get_post_meta( $id, '_your_eudr_taric_code_meta_key', true ), ); foreach ( $pids as $key => $value ) { if ( '' === trim( (string) $value ) ) { continue; // Leave the key out when there is no value. } $attribute = new \GCBWC\Globale\Pro\Api\Entity\CustomProductAttribute(); $attribute->setAttributeKey( $key ); $attribute->setAttributeValue( $value ); $metaAttributes[] = $attribute; } return $metaAttributes; } endif; ``` * Use the keys exactly as written, in camelCase: `eudrDdsReference` and `eudrTaricCode`. * Leave a key out when there is no value. Never send NA, 0 or -. * Send each key from one source only. Keys sent by the filter do not need to be listed in Extra Product Attributes. * If you already send EU Product Identifiers with the same filter, add the EUDR keys to the same function. `standardcode` and `mididentifier` keep working unchanged. * Test on a staging site first and confirm both keys appear on the cart line. ## Reference **What gets sent** | Sent as | What it holds | When to leave it out | | - | - | - | | `eudrDdsReference` | The Due Diligence Statement (DDS) reference for that product or variation | When the item has no DDS reference | | `eudrTaricCode` | The TARIC document code for that product or variation | When the item has no TARIC document code | **Key points** * **Per variation.** A variation sends its own values. A product without variations sends the product's values. * **Omit, don't fake.** Leave the value empty when you have none. Never enter NA, 0 or -. * **Separate from PID.** EUDR keys are sent alongside `standardcode` and `mididentifier` on the same cart line; they do not replace them. **Quick check before go-live** | Check | Done | | - | - | | Global-e WooCommerce plugin is 1.14.0 or later | ☐ | | The code filter sends `eudrDdsReference` and `eudrTaricCode` | ☐ | | Two variations with different values each show their own pair in SendCart | ☐ | | Keys omitted (not empty) when an item has no value | ☐ | | `standardcode` and `mididentifier` still appear when configured | ☐ | # Data Requirements for Global-e Merchants using SFTP server as a DDS source for EUDR regulation Source: https://docs.global-e.com/eu-deforestation-regulation-sftp-file-guide Part of [EU Deforestation Regulation (EUDR)](/eu-deforestation-regulation-eudr). ## About This Service Global-e offers an EUDR (EU Deforestation Regulation) data intake service that receives your product-level Due Diligence Statement (DDS) reference and/or TARIC document codes via SFTP. Global-e stores this data and passes the applicable values into shipping and customs documents so EU customs clearance is not delayed for EUDR-regulated products. To use this service, provide the data listed below in a CSV file. Global-e handles parsing, storage, and use of the data on documents — you supply the product identifiers and EUDR values. ## What does this service do? * Accepts product-level EUDR data (DDS reference and/or TARIC document code) via .CSV file through merchant's SFTP server * Matches each row to the product in the Global-e catalogue using `ProductCode` * Stores the values so they can be included on documents used for customs declaration * Supports exemption TARIC codes (Y196 / Y129 / Y188) that do not require a DDS reference number ## How do you submit the required data? * Via SFTP Server. * Merchants with an existing SFTP configuration with Global-e should submit the file using their current SFTP credentials. * Merchants without an SFTP configuration, including both existing and onboarding merchants, must contact their Global-e CSM to have an SFTP server set up. * Files must be submitted to the `/eudr` folder on the SFTP server. * File format is .CSV ## What do you need to provide? The table below lists the fields in the EUDR SFTP file. `ProductCode` is always required. For each product row, you must populate either `eudrDdsReference` or `eudrTaricCode` (one of the two). | Field | What to Provide | Required? | | - | - | - | | `ProductCode` | Your product identifier used by Global-e for catalogue lookup Use product code stored in the Global-e catalogue \[SKU]. | Yes — Mandatory | | `eudrDdsReference` | Due Diligence Statement (DDS) reference number issued after registration in TRACES. Quoted on the customs declaration for EUDR-regulated products. | Not mandatory on its own — but required if `eudrTaricCode` is empty | | `eudrTaricCode` | TARIC document code for the product when a DDS reference is not required (or when declaring an applicable exemption / special case code). | Not mandatory on its own — but required if `eudrDdsReference` is empty | **Business rule** > [!NOTE] > > **One of the two fields must be populated on each row: either `eudrDdsReference` or `eudrTaricCode`.** > > TARIC codes Y196, Y129, and Y188 do not require a DDS reference number. For those products, populate `eudrTaricCode` with the applicable code and leave `eudrDdsReference` empty. ## File data examples | ProductCode | eudrDdsReference | eudrTaricCode | Notes | | - | - | - | - | | WD-4401-NAT | 123YYSS | | DDS reference provided; TARIC code left empty | | BAG-LEATHER-02 | 3456ZZZZ | | DDS reference provided; TARIC code left empty | | 40192837465812 | | Y196 | Exemption / special TARIC code — DDS not required | | SHOE-OXF-BRN-42 | | Y129 | Exemption TARIC code — DDS not required | ## Field checklist (quick reference) | Field | Requirement | | - | - | | **ProductCode** | Mandatory | | **eudrDdsReference** | Not mandatory (fill if no TARIC code) | | **eudrTaricCode** | Not mandatory (fill if no DDS reference) | | **Row rule** | Populate either `eudrDdsReference` or `eudrTaricCode` | | **Y196 / Y129 / Y188** | DDS reference not required — use `eudrTaricCode` | ## File Format: .csv file **File layout** Header row: **ProductCode, eudrDdsReference, eudrTaricCode** ```csv theme={null} ProductCode,eudrDdsReference,eudrTaricCode ``` * Include all three columns in every file. * Leave the unused optional column empty for that row — do not omit the column from the header. ## How Global-e uses this data * On product lookup, Global-e uses `ProductCode` to match the catalogue item * If a DDS reference is present, it can be passed into documents for customs declaration * If a TARIC code such as Y196 / Y129 / Y188 is present instead, documents reflect that code without a DDS reference * If neither `eudrDdsReference` nor `eudrTaricCode` is provided for a product, the .csv file should not contain a record with a product code only. Such record is not valid. # EU Customs Reform - Product Identifiers (PID) Source: https://docs.global-e.com/eu-product-identifiers-pid ## Overview As part of the EU's new customs requirements for e-commerce imports, Product Identifiers (PIDs) will become mandatory from 1 November 2026 for distance sales of goods imported into the EU. The requirement is intended to give customs authorities more precise product-level information, improving traceability and supporting checks relating to product safety, regulatory compliance, prohibitions and restrictions. A general product description alone will no longer be sufficient. Product identifier information will need to be captured accurately by the seller, marketplace or platform and transmitted through the customs declaration process. ## What is changing Global-e submit these identifiers to customs on your behalf and display them on the Commercial Invoice and Customer Receipt. ## Timeline | Date | What happens | | - | - | | **1 July 2026** | Voluntary period | | **1 November 2026** | Mandatory. All EU-27 B2C orders must carry the identifiers | ## Why it matters EU customs is moving away from free-text product descriptions towards structured identifiers that can be matched automatically against a recognised product. The aim is to identify undervalued, misdescribed or unsafe goods before they enter the EU. An item that arrives without usable identifiers becomes a candidate for customs hold, inspection or rejection — delayed deliveries and a poor experience for your customers. ## Does this apply to me? Yes, if you ship consumer (B2C or B2B2C) orders to any of the 27 EU member states. | | | | - | - | | **Applies to** | All B2C orders to EU-27 destinations | | **Order value** | Customs requires PIDs on orders with a total value of 150 EUR or less. The threshold applies to the whole order, not to individual products. Because any product can end up in a qualifying order, populate PIDs for all products in your catalog. | | **Fulfilment model** | Both Global-e Logistics and fulfilment on Global-e carrier integrations with your own carrier account | | **Does not apply to** | Non-EU destinations | ## PIDs requirements | Identifier | What it is | | - | - | | **M-PID — Merchant Product Identifier** | SKU or productid/variantid based on platform integration | | **NS-PID — Non-Standardised Product Identifier** | The manufacturer's product code, model name, or supplier reference. May be merchant own product code or SKU if own manufacturer | | **S-PID — Standardised Product Identifier** | Global standard, assigned by the product manufacturer (e.g., GTIN, EAN, UPC). Not providing a standardized code will be treated by Global-e as confirmation that none exists for that product. | ## If a product has no standardcode (S-PID) Leave S-PID empty - and add no value in `standardcode`. Global-e automatically declares to customs that no standardised identifier exists for that item. > [!WARNING] > > Do not enter placeholder values. Never use NA, N/A, 0, -, a blank space, or your SKU repeated. An empty field is handled correctly. A placeholder is sent to customs as though it were a real barcode, fails matching, and creates exactly the customs problem this requirement exists to prevent. ## The manufacturer product code is always required (NS-PID) **NS-PID** must be populated for every product/variant. Use the first of these that applies: 1. The manufacturer's product code (sometimes called MPN or manufacturer reference) 2. The product's model name or model number 3. The purchase or supplier SKU - the code your supplier uses for the item 4. Your own product or style code, if you manufacture the item yourself Because option 4 always exists as a last resort, every product has a valid value. If you sell unbranded or generic goods with no identifiable manufacturer, use the model name or the purchase SKU. Check your PIM or purchasing system before assuming you do not have this - it is often already stored as "MPN", "supplier part number" or "manufacturer reference". > [!WARNING] > > Do not fake this field. Do not enter NA, 0, -, unknown, or a generic description such as "t-shirt". These are transmitted to customs as though they were real identifiers. ## Platform setup guides | Platform | Guide | | - | - | | Shopify | [EU Product Identifiers — Shopify](/eu-product-identifiers-setup-shopify) | | PrestaShop | [EU Product Identifiers — PrestaShop](/eu-product-identifiers-setup-prestashop) | | WooCommerce | [EU Product Identifiers — WooCommerce](/eu-product-identifiers-setup-woocommerce) | | BigCommerce | [EU Product Identifiers — BigCommerce](/eu-product-identifiers-setup-bigcommerce) | | Centra | [EU Product Identifiers — Centra](/eu-product-identifiers-setup-centra) | | Magento 2 Lite | [EU Product Identifiers — Magento 2 Lite](/eu-product-identifiers-setup-magento2-lite) | | Magento 2 Full | [EU Product Identifiers — Magento 2](/eu-product-identifiers-setup-magento2) | | Shopware 6 | [EU Product Identifiers — Shopware 6](/eu-product-identifiers-setup-shopware) | | Hybris | [EU Product Identifiers — SAP Hybris](/eu-product-identifiers-setup-hybris) | | SFCC | [EU Product Identifiers — Salesforce B2C Commerce (SFCC)](/eu-product-identifiers-setup-sfcc) | | Wix | [EU Product Identifiers — Wix](/eu-product-identifiers-setup-wix) | | Global-e Module (1.0, 2.0) | [EU Product Identifiers — Global-e Module 2.0](/eu-product-identifiers-setup-global-e-module) | | ShopLine | **Contact your Global-e CSM.** Setup for ShopLine is handled per merchant. Contact your Global-e Customer Success Manager for the current approach and requirements. | # EU Product Identifiers Source: https://docs.global-e.com/eu-product-identifiers-setup-bigcommerce Part of the [EU Customs Reform - Product Identifiers (PID)](/eu-product-identifiers-pid). On BigCommerce, you store the values in your catalog using native product/variant fields (**UPC/EAN**, **MPN**, and product-level **GTIN**) and/or metafields. The Global-e integration reads them at checkout and sends them to Global-e. Your SKU is already sent separately, so there is no new SKU field to add. Do **not** use the US MID fields (`MIDCode`, `ManufName`, and similar) for EU PID. Those remain for US customs and coexist with EU PID keys. For what each identifier is, see [The three identifiers](/eu-product-identifiers-pid#the-three-identifiers) on the overview page. ## What you need to do 1. **`standardcode`:** for each variant that can appear in the cart, populate the native **UPC/EAN** field in BigCommerce (variant **Barcodes & Identifiers**). ![](https://mintcdn.com/globale-enterprise/LezcnfC2KKGsi0cK/images/eu-product-identifiers/bigcommerce-gtin.png?fit=max\&auto=format\&n=LezcnfC2KKGsi0cK\&q=85\&s=c4712b52acdc73db40e5630afc9a05dc) If a variant has no UPC/EAN, create a metafield named exactly `standardcode` (or `StandardCode`) on the variant. Product-level sources are used only as a fallback when the variant has no UPC/EAN and no variant metafield: product **GTIN**, then product **UPC/EAN**, then a product metafield `standardcode`. **Product Metafield** ![](https://mintcdn.com/globale-enterprise/LezcnfC2KKGsi0cK/images/eu-product-identifiers/bigcommerce-product-metafield.png?fit=max\&auto=format\&n=LezcnfC2KKGsi0cK\&q=85\&s=5ae199fcc8cf0e2454bb7a14a338cc52) **Variant Metafield** ![](https://mintcdn.com/globale-enterprise/LezcnfC2KKGsi0cK/images/eu-product-identifiers/bigcommerce-variant-metafield.png?fit=max\&auto=format\&n=LezcnfC2KKGsi0cK\&q=85\&s=d2ded95d91603d3e32480d10e3dc222d) 2. **`mididentifier`:** when available, populate the native **MPN** (Manufacturer Part Number) on the variant. If a variant has no MPN, create a metafield named exactly `mididentifier` (or `MidIdentifier`) on the variant. Product-level **MPN** or a product metafield `mididentifier` is used only as a fallback. 3. **Confirm with your Global-e CSM** that EU PID is enabled for your account and that you are on a BigCommerce integration release that supports EU PID. 4. **Place a test order** and confirm both keys appear when values exist and are omitted when blank. | Sent as | What it holds | When to leave it out | | - | - | - | | **`standardcode`** | The barcode for that variant (UPC, EAN, or GTIN) | When the item has no barcode. Global-e declares the "no barcode" code automatically. | | **`mididentifier`** | The manufacturer's product code for that variant | When you have no manufacturer code to send. | ## How Global-e reads the values For each cart line, the integration uses the **first non-empty value** in this order: **`standardcode`** 1. Variant native **UPC/EAN** 2. Variant metafield `standardcode` / `StandardCode` (case-insensitive) 3. Product native **GTIN** 4. Product native **UPC/EAN** 5. Product metafield `standardcode` / `StandardCode` (case-insensitive) 6. Otherwise omit **`mididentifier`** 1. Variant native **MPN** 2. Variant metafield `mididentifier` / `MidIdentifier` (case-insensitive) 3. Product native **MPN** 4. Product metafield `mididentifier` / `MidIdentifier` (case-insensitive) 5. Otherwise omit > [!NOTE] > > Variant-level GTIN is **not** used for `standardcode` (BigCommerce Admin exposes GTIN at product level; use variant UPC/EAN instead). ## Key points **Exact lowercase on SendCart.** Outbound MetaData keys are exactly `standardcode` and `mididentifier`. Metafield keys may vary in casing (`StandardCode` / `MidIdentifier`). **UPC/EAN is the preferred source for `standardcode`** when populated on the variant. You do not need a `standardcode` metafield when UPC/EAN is set. **MPN is the preferred source for `mididentifier`** when populated on the variant. You do not need a `mididentifier` metafield when MPN is set. **One pair of values per variant.** A value on the parent product alone is not used when the variant has its own UPC/EAN, MPN, or variant metafield. **Omit, don't fake.** Leave the key out when you have no value. Never send an empty string, NA, 0 or -. **When values are read:** at checkout, when the customer proceeds to Global-e. Updated catalog values apply on that variant's next checkout. **Keep separate from US MID** (`MIDCode`, `ManufName`, namespace `GE_MID`, and similar) and from other product fields such as `MerchantHSCode`. EU PID and US MID MetaData keys coexist; they are not interchangeable. ## Quick check before go-live | Check | Done | | - | - | | `standardcode` appears when the variant has UPC/EAN (or a `standardcode` metafield / product fallback) | ☐ | | `mididentifier` appears when the variant has MPN (or a `mididentifier` metafield / product MPN fallback) | ☐ | | Keys are omitted (not empty) when a variant has no value | ☐ | | Each variant in the cart sends its own pair | ☐ | | EU PID keys are separate from US MID keys and `MerchantHSCode` | ☐ | ## Frequently asked questions > [accordion] Can we use the BigCommerce UPC/EAN field for standardcode? > > Yes. Variant UPC/EAN is the primary source. Product GTIN / product UPC/EAN are fallbacks when the variant has no UPC/EAN and no variant metafield. > [accordion] Can we reuse US MID metafields (GE_MID / MIDCode) for mididentifier? > > No. Those fields continue to feed US MID MetaData. For EU `mididentifier`, use native **MPN** (preferred) or a metafield keyed `MidIdentifier`. > [accordion] Only a manufacturer code, no barcode? > > Send `mididentifier` only; omit `standardcode`. > [accordion] Who configures Global-e field mapping? > > No per-merchant field mapping is required. Your CSM enables EU PID on the Global-e side. # EU Product Identifiers Source: https://docs.global-e.com/eu-product-identifiers-setup-centra Part of the [EU Customs Reform - Product Identifiers (PID)](/eu-product-identifiers-pid). On Centra, `standardcode` is read automatically from the native Centra barcode field (GTIN for DTC, EAN for Checkout API) — no custom attribute needed for it. `mididentifier` is stored on each variant using the `ge_variant_data` custom attribute. Both are mapped at checkout. Your SKU is already sent separately, so there is no new SKU field to add. Do not use the US MID fields for EU PID. For what each identifier is, see [The three identifiers](/eu-product-identifiers-pid#the-three-identifiers) on the overview page. ## What you need to do 1. **Create the Global-e attribute type.** In Centra, navigate to **System**, then **Configuration**, click **Create attribute type** ![](https://mintcdn.com/globale-enterprise/oqal72MN88mO9lN7/images/eu-product-identifiers/centra-create-attribute-type.png?fit=max\&auto=format\&n=oqal72MN88mO9lN7\&q=85\&s=15b12530165f20f39b552f2b3ee3dd24) and add `ge_variant_data` (**Global-E Variant Information**) using the definition below. ``` { "desc": "Global-E Variant Information", "readonly": false, "group": "variation", "elements": { "mid_identifier": { "type": "input", "desc": "Global-E Manufacturer Product Code" } } } ``` 2. **Populate the values per variant.** Open the product, navigate to the **Variants** tab and click on the variant name, then **Custom attributes**. On each variant, fill Global-E Manufacturer Product Code when you have a value to send. ![](https://mintcdn.com/globale-enterprise/ppAqaW1d41r_3dOu/images/eu-product-identifiers/centra-variant-custom-attributes.png?fit=max\&auto=format\&n=ppAqaW1d41r_3dOu\&q=85\&s=3c4ae61ed29b30b1aefa78152e29809e) 3. **DTC merchants only:** navigate to **Platform**, then **Stores management**, then **Stores**, ![](https://mintcdn.com/globale-enterprise/oqal72MN88mO9lN7/images/eu-product-identifiers/centra-stores-management.png?fit=max\&auto=format\&n=oqal72MN88mO9lN7\&q=85\&s=e871eb202074a2afb3a2243890c1db36) open your store, then **Plugins**, then **DTC API**, then **View**. ![](https://mintcdn.com/globale-enterprise/oqal72MN88mO9lN7/images/eu-product-identifiers/centra-dtc-api-view.png?fit=max\&auto=format\&n=oqal72MN88mO9lN7\&q=85\&s=080a916d637fda2f5dd56e759f1141c9) Under **Display item attributes**, search `global-e variant` and select **Global-E Manufacturer Product Code** ![](https://mintcdn.com/globale-enterprise/oqal72MN88mO9lN7/images/eu-product-identifiers/centra-display-item-attributes.png?fit=max\&auto=format\&n=oqal72MN88mO9lN7\&q=85\&s=0cac648a70ad6a3db959fad5aafe36b0) then click **Save.** ![](https://mintcdn.com/globale-enterprise/oqal72MN88mO9lN7/images/eu-product-identifiers/centra-storefront-api-save.png?fit=max\&auto=format\&n=oqal72MN88mO9lN7\&q=85\&s=c28abd35fc9928f1b1108443785d9e99) Checkout API merchants skip this step. 4. **Place a test order** and confirm the values appear when populated and are omitted when blank. | Sent as | What it holds | When to leave it out | | - | - | - | | **`standardcode`** | The barcode for that size, read from the native GTIN (DTC) or EAN (Checkout API) field in Centra | When the native barcode field is empty — the key is omitted automatically. | | **`mididentifier`** | The manufacturer's product code for that variant | Never. This is required on every line. | ## Where `standardcode` comes from | API | Source | | - | - | | DTC (GraphQL) | Native **GTIN** field on each size/item in Centra. Populated via your ERP or PIM integration. | | Checkout API | Native **EAN** field on each size in Centra. Visible in the product editor under **Variants →** Manage Stock → Size Info. | No custom attribute configuration is required for `standardcode`. If the native field is empty, the key is omitted automatically. **EAN field location in Centra** ![](https://mintcdn.com/globale-enterprise/ppAqaW1d41r_3dOu/images/eu-product-identifiers/centra-ean-size-info.png?fit=max\&auto=format\&n=ppAqaW1d41r_3dOu\&q=85\&s=155ed5efcb4974a52133b282cde494eb) EAN is entered per size under Manage Stock → Size Info on each product variant in Centra. ## Key points **One pair of values per variant.** Populate each variant that can appear in the cart. A value on the parent product alone is not enough when the variant has no value of its own. In Centra you see Global-E Manufacturer Product Code under Custom attributes on the variant. The integration maps it to `mididentifier` (lowercase) at checkout. `standardcode` is mapped automatically from the native barcode field — no custom attribute needed. **The catalog setup is the same for DTC (GraphQL) and Checkout API.** DTC has one extra step: select Global-E Manufacturer Product Code under store, **DTC API**, **Display item attributes**, then **Save**. **Omit, don't fake.** When a variant has no value, leave it blank. Never enter an empty placeholder such as NA, 0 or -. **When values are read:** at checkout. Updated variant values apply on that SKU's next checkout. ## Quick check before go-live | Check | Done | | - | - | | `ge_variant_data` attribute type created | ☐ | | Global-E Manufacturer Product Code populated on each variant | ☐ | | Native EAN (Checkout API) or GTIN (DTC) filled for each size in Centra | ☐ | | `standardcode` and `mididentifier` appear in SendCart when values exist | ☐ | | Keys omitted (not empty) when a variant has no value | ☐ | | Each variant in the cart sends its own pair | ☐ | | DTC only: **Global-E Manufacturer Product Code** selected under store, **DTC API**, **View**, and saved | ☐ | # EU Product Identifiers Source: https://docs.global-e.com/eu-product-identifiers-setup-global-e-module Part of the [EU Customs Reform - Product Identifiers (PID)](/eu-product-identifiers-pid). On Global-e Module, Global-e does not read identifiers from your catalog or add them from a Global-e screen. Global-e Module passes your GetCart response through as-is: whatever you place on each cart line is exactly what Global-e sends to customs. This means all setup happens in your cart API or middleware. For what each identifier is, see [The three identifiers](/eu-product-identifiers-pid#the-three-identifiers) on the overview page. ## What you need to do 1. Keep your identifiers in your catalog or PIM under whatever field names you already use (for example `ean`, `gtin`, `upc`, manufacturer SKU). 2. When Global-e calls your GetCart endpoint at checkout, map those values onto each product line inside `MetaData.Attributes`, using the exact keys below. | Sent as | What it holds | When to leave it out | | - | - | - | | **`standardcode`** | The barcode for that line (GTIN, EAN or UPC) | When the item has no barcode. Global-e declares the "no barcode" code automatically. | | **`mididentifier`** | The manufacturer's product code for that line | Never. This is required on every line. | ```json theme={null} "MetaData": { "Attributes": [ { "AttributeKey": "standardcode", "AttributeValue": "5901234123457" }, { "AttributeKey": "mididentifier", "AttributeValue": "MFG-JKT-4471" } ] } ``` ## Key points **One set of values per cart line or variant.** Each size or colour that appears as its own line must carry its own values, not just the parent product. **Map from your own fields.** Your catalog can name the barcode anything (`ean`, `gtin`, `barcode`); the response must still send it under `standardcode`. **Omit, don't fake.** When you have no value, leave the key out entirely. Never send an empty string, NA, 0 or -. **Use the right bag.** These go on `MetaData.Attributes` (with `AttributeKey` / `AttributeValue`), not the separate per-product `Attributes` collection used for display and duties. **US MID keeps working alongside it.** If you already send `midcode` / `midname` / `midaddress`, keep sending them and add `standardcode` and `mididentifier` to the same list. ## Quick check before go-live | Check | Done | | - | - | | Each cart line carries `standardcode` when it has a barcode, and `mididentifier` always | ☐ | | Lines with no barcode omit the key (no empty string or placeholder) | ☐ | | Every variant SKU has its own values, not just the parent product | ☐ | | The keys sit on `MetaData.Attributes`, separate from the US MID keys | ☐ | # EU Product Identifiers Source: https://docs.global-e.com/eu-product-identifiers-setup-hybris Part of the [EU Customs Reform - Product Identifiers (PID)](/eu-product-identifiers-pid). On SAP Commerce (Hybris), the Global-e addon reads the product attributes you list in configuration and sends them to Global-e at checkout as `standardcode` and `mididentifier`. Your SKU is already sent separately, so there is no new SKU field to add. Do not use the US MID fields for EU PID. For what each identifier is, see [The three identifiers](/eu-product-identifiers-pid#the-three-identifiers) on the overview page. ## Prerequisites | Requirement | Value | | - | - | | Minimum plugin version | Global-e plugin `2211.12` | ## What you need to do 1. Confirm with your Global-e CSM that EU PID is enabled for your account and that you are on a Global-e addon release that supports it (`2211.12`). 2. **Store the values in product attributes defined in the Type System** (`items.xml`). The native SAP Commerce attributes `ean` and `manufacturerAID` work out of the box. Classification attributes and Dynamic Attributes are not supported. 3. **Populate the values on each variant** that can appear in the cart. If a variant has no value, the addon uses the value on the parent (base) product. 4. **Set the two Global-e configuration properties**, in the Administration Console (HAC) or in `local.properties`: ``` globale.product.metadata.attributes=ean,manufacturerAID globale.product.metadata.attributes.map={"ean":"standardcode","manufacturerAID":"mididentifier"} ``` * `globale.product.metadata.attributes` is a comma-separated list of the attribute qualifiers to send. * `globale.product.metadata.attributes.map` maps each qualifier to the key Global-e receives. The values must be exactly `standardcode` and `mididentifier` (lowercase). * If your barcode or manufacturer code is stored in a different attribute, replace `ean` or `manufacturerAID` with that attribute's qualifier in both properties. 5. Place a test order and confirm both keys appear when values exist and are omitted when blank. | Sent as | What it holds | When to leave it out | | - | - | - | | **`standardcode`** | The barcode for that variant (UPC, EAN, or GTIN) | When the item has no barcode. Global-e declares the "no barcode" code automatically. | | **`mididentifier`** | The manufacturer's product code for that variant | When you have no manufacturer code to send. | ## How Global-e reads the values For each cart line and each mapped attribute, the addon uses the first non-empty value: 1. The attribute on the variant in the cart 2. The same attribute on the parent (base) product 3. Otherwise omit ## Key points * **Type System attributes only.** Values held in Classification attributes or Dynamic Attributes are not read. * **Exact lowercase keys.** The keys Global-e receives are whatever you put in the map, so use exactly `standardcode` and `mididentifier`. * **The original attribute is also sent.** Each listed qualifier is sent under its own name as well as under the mapped key, for example both `ean` and `standardcode` with the same value. Global-e uses only `standardcode` and `mididentifier` for EU PID; the extra keys are expected. * **Omit, don't fake.** When an attribute is blank, the addon leaves it out. Never enter a placeholder such as NA, 0 or -. * Keep separate from US MID fields and from other product fields such as `MerchantHSCode`. ## Quick check before go-live | Check | Done | | - | - | | Global-e addon on a release that supports EU PID, and EU PID enabled by your CSM | ☐ | | Barcode and manufacturer code stored in Type System attributes (for example `ean`, `manufacturerAID`) | ☐ | | Both configuration properties set, with the map using lowercase `standardcode` and `mididentifier` | ☐ | | `standardcode` and `mididentifier` appear in SendCart when values exist | ☐ | | Keys omitted when a variant and its parent have no value | ☐ | | Each variant in the cart sends its own pair | ☐ | ## Frequently asked questions > [accordion] Do I need new attributes named standardcode or mididentifier? > > No. Those are the keys Global-e receives. Keep your values in your existing attributes and map them in `globale.product.metadata.attributes.map`. > [accordion] Our barcodes are in Classification attributes. Can Global-e read them? > > No. Only Type System attributes are supported. Store the values in a Type System attribute such as `ean`, or contact your CSM. > [accordion] Only a manufacturer code, no barcode? > > Map only the manufacturer code attribute. `standardcode` is omitted and Global-e declares the "no barcode" code. # EU Product Identifiers Source: https://docs.global-e.com/eu-product-identifiers-setup-magento2 Part of the [EU Customs Reform - Product Identifiers (PID)](/eu-product-identifiers-pid). On Magento, the two identifiers are read from product attributes at checkout and sent to Global-e by the Global-e module. This is a configuration task, not custom code: you create two product attributes, list them in the module settings, and populate the values on your products. Your SKU is already sent separately, so there is no new SKU field to add. For what each identifier is, see [The three identifiers](/eu-product-identifiers-pid#the-three-identifiers) on the overview page. Unlike some platforms, on Magento the attribute codes themselves must be exactly `standardcode` and `mididentifier`. ## Prerequisites | Requirement | Value | | - | - | | Minimum version | Global-e 2.6.0 | ## What you need to do 1. **Create two product attributes.** Navigate to **Stores**, then **Attributes**, then **Product** ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/magento2-stores-attributes-product.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=158afa094a91be240b97ff0777962cd0) 2. Create two attributes by clicking on the **Add Attributes** button: Set Catalog Input Type to **Text Field** and Values Required to **No**; ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/magento2-new-product-attribute.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=dc5ffe9c1933c7822476598ec32e994f) 3. **List them in the Global-e module.** Navigate to **Stores**, then **Configuration**, then **Services**, then **Global-e**, then **Global-E API Settings**, then **Products**. Enter `standardcode,mididentifier` (comma-separated, no spaces) in both fields: **Extra Product Attributes (Configurable)**, and **Extra Product Attributes (Simple).** 4. ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/magento2-extra-product-attributes.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=4326f7b5aa9c478c2899085ded028901) **Save and flush cache.** Click **Save Config**, then flush the Magento cache (**System**, **Cache Management**, **Flush Magento Cache**). ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/magento2-flush-cache.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=b2767d0a81950ca02db9235c0fa08afd) 5. **Populate the values** on each variant and/or configurable parent. | Sent as | What it holds | When to leave it out | | - | - | - | | `standardcode` | The barcode for that variant (GTIN, EAN or UPC) | When the item has no barcode. Global-e declares the “no barcode” code automatically. | | `mididentifier` | The manufacturer’s product code for that variant | Never. This is required on every line. | ## Key points **One pair of values per cart line.** For simple products, populate that SKU’s attributes. For configurable products, set values on the parent, on each child, or both: when a child has no value, the module uses the parent’s value. **Both settings must match.** List `standardcode,mididentifier` in both **Extra Product Attributes** and **Extra Product Attributes From Simple**. **Exact lowercase.** The Magento attribute codes and the values sent to Global-e are both `standardcode` and `mididentifier`.**Omit, don’t fake.** When a variant has no value, leave the key out. Never send an empty string, NA, 0 or -. **Keep separate from US MID.** Do not use `midcode`, `midname` or `midaddress` for EU PID. If you already list US MID attributes in these settings, append `standardcode,mididentifier` to the same comma-separated list in both fields. **When values are read:** at checkout, when the customer proceeds to Global-e. Updated catalog values apply on that SKU’s next checkout. ## Quick check before go-live | Check | Done | | - | - | | Two attributes created with codes `standardcode` and `mididentifier`, added to the attribute set | ☐ | | Both **Extra Product Attributes** settings list `standardcode,mididentifier` | ☐ | | Values populated on each variant (or on the configurable parent for inheritance) | ☐ | | `standardcode` and `mididentifier` appear when the variant has values | ☐ | | Keys are omitted (not empty) when a variant has no value | ☐ | | Configurable child inherits the parent when the child is blank | ☐ | | Cache flushed after the configuration change | ☐ | # EU Product Identifiers Source: https://docs.global-e.com/eu-product-identifiers-setup-magento2-lite Part of the [EU Customs Reform - Product Identifiers (PID)](/eu-product-identifiers-pid). On Magento, the two identifiers are read from product attributes at checkout and sent to Global-e by the Global-e module. This is a configuration task, not custom code: you create two product attributes, list them in the module settings, and populate the values on your products. Your SKU is already sent separately, so there is no new SKU field to add. For what each identifier is, see [The three identifiers](/eu-product-identifiers-pid#the-three-identifiers) on the overview page. Unlike some platforms, on Magento the attribute codes themselves must be exactly `standardcode` and `mididentifier`. ## Prerequisites | Requirement | Value | | - | - | | Minimum plugin version | Global-e plugin 1.14.4 | You can check your plugin version by looking at: **src/BrowsingLite/etc/module.xml** ## What you need to do 1. **Create two product attributes.** Navigate to **Stores**, then **Attributes**, then **Product** ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/magento2-lite-stores-attributes-product.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=d11de0c1118ccda1b3c32c4f15340040) 2. Create two attributes by clicking on the **Add Attributes** button: Set Catalog Input Type to **Text Field** and Values Required to **No**; ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/magento2-lite-new-product-attribute.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=1a5fe959b3245d4d04ed34fdebaf0d9c) 3. **List them in the Global-e module.** Navigate to **Stores**, then **Configuration**, then **Services**, then **Global-e Crossborder**, then **Global-E API Settings**, then **Products**. Enter `standardcode,mididentifier` (comma-separated, no spaces) in both fields: **Extra Product Attributes**, and **Extra Product Attributes From Simple**. ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/magento2-lite-extra-product-attributes.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=c73019e16f14e2fde348586898ca221e) 4. **Save and flush cache.** Click **Save Config**, then flush the Magento cache (**System**, **Cache Management**, **Flush Magento Cache**). ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/magento2-lite-flush-cache.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=412f2d136c36382099fd2e95a71da070) 5. **Populate the values** on each variant and/or configurable parent. | Sent as | What it holds | When to leave it out | | - | - | - | | `standardcode` | The barcode for that variant (GTIN, EAN or UPC) | When the item has no barcode. Global-e declares the “no barcode” code automatically. | | `mididentifier` | The manufacturer’s product code for that variant | Never. This is required on every line. | ## Key points **One pair of values per cart line.** For simple products, populate that SKU’s attributes. For configurable products, set values on the parent, on each child, or both: when a child has no value, the module uses the parent’s value. **Both settings must match.** List `standardcode,mididentifier` in both **Extra Product Attributes** and **Extra Product Attributes From Simple**. **Exact lowercase.** The Magento attribute codes and the values sent to Global-e are both `standardcode` and `mididentifier`.**Omit, don’t fake.** When a variant has no value, leave the key out. Never send an empty string, NA, 0 or -. **Keep separate from US MID.** Do not use `midcode`, `midname` or `midaddress` for EU PID. If you already list US MID attributes in these settings, append `standardcode,mididentifier` to the same comma-separated list in both fields. **When values are read:** at checkout, when the customer proceeds to Global-e. Updated catalog values apply on that SKU’s next checkout. ## Quick check before go-live | Check | Done | | - | - | | Two attributes created with codes `standardcode` and `mididentifier`, added to the attribute set | ☐ | | Both **Extra Product Attributes** settings list `standardcode,mididentifier` | ☐ | | Values populated on each variant (or on the configurable parent for inheritance) | ☐ | | `standardcode` and `mididentifier` appear when the variant has values | ☐ | | Keys are omitted (not empty) when a variant has no value | ☐ | | Configurable child inherits the parent when the child is blank | ☐ | | Cache flushed after the configuration change | ☐ | # EU Product Identifiers Source: https://docs.global-e.com/eu-product-identifiers-setup-prestashop Part of the [EU Customs Reform - Product Identifiers (PID)](/eu-product-identifiers-pid). On PrestaShop, you hold the two values in product **Features**, then list those feature names in the Global-e module. The module sends them to Global-e at checkout. Your product reference is already sent separately, so there is no new SKU field to add. Do not use the US MID fields for EU PID. For what each identifier is, see [The three identifiers](/eu-product-identifiers-pid#the-three-identifiers) on the overview page. ## Prerequisites | Requirement | Value | | - | - | | Minimum plugin version | Global-e PrestaShop plugin 1.2.2 | You can check your plugin version by going to **Modules → Module manager** ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/prestashop-plugin-version.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=120270f339f0c2df7e0d5afe0be0a904) ## What you need to do 1. **Create the features.** Navigate to **Catalog**, then **Attributes & Features**, then **Features**. Create features named exactly `standardcode` and `mididentifier`. ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/prestashop-features-list.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=7c04c58d551ed47d475aefa374b47fe0) 2. **Set values per product.** On each product, open the **Features** tab and assign a customised value for each feature. Leave a feature blank when you have nothing to send. ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/prestashop-product-features.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=167fa380c94e1ac3d094213e76429618) 3. **List the features in the module.** Navigate to **Modules**, then **Module Manager**, then **Global-e Cross-Border**, then **Configure**, then **Products**. In **Product extra meta data**, add the feature names comma-separated: `standardcode,mididentifier`. ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/prestashop-product-extra-meta-data.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=7c638cb55a7c6c3dd2fd206b85834db4) 4. **Save the module settings**, place a test order, and confirm the values appear when populated and are omitted when blank. | Sent as | What it holds | When to leave it out | | - | - | - | | `standardcode` | The barcode for that line (GTIN, EAN or UPC) | When the item has no barcode. Global-e declares the “no barcode” code automatically. | | `mididentifier` | The manufacturer’s product code for that line | Never. This is required on every line. | **Do not use the native combination EAN-13.** The native combination EAN-13 field is not the EU PID path and does not populate `standardcode`. Use PrestaShop Features instead. **Features are set per product.** PrestaShop Features are set once per product, so all combinations of a product share the same values. If different variants of a product need different identifiers, use separate products or confirm alternatives with your Global-e contact. ## Key points **Use Features plus the Product extra meta data setting**, not the native combination EAN-13. **The values are sent under the keys** `standardcode` and `mididentifier`.**Omit, don’t fake.** Leave a feature blank when you have no value. Never enter NA, 0 or -. **When values are read:** at checkout, when the customer proceeds to Global-e. ## Quick check before go-live | Check | Done | | - | - | | Features created and given values on each product that needs them | ☐ | | Feature names listed in the module’s **Product extra meta data** | ☐ | | Values appear in cart `MetaData` when populated on the product | ☐ | | Keys omitted (not empty) when a feature has no value | ☐ | | Not using the native combination EAN-13 as the EU PID source | ☐ | # EU Product Identifiers Source: https://docs.global-e.com/eu-product-identifiers-setup-sfcc Part of the [EU Customs Reform - Product Identifiers (PID)](/eu-product-identifiers-pid). On SFCC, the two identifiers are read from your product catalog at checkout and sent to Global-e on each cart line. For most merchants this is a configuration update, not a code change: if your Global-e integration already uses SendCart dynamic mapping, your CSM adds a mapping that reads your catalog attributes directly. Older cartridges that do not support dynamic mapping use a small project hook instead. For what each identifier is, see [The three identifiers](/eu-product-identifiers-pid#the-three-identifiers) on the overview page. ## Check your cartridge version EU Product Identifiers on SFCC depend on **SendCart dynamic attribute mappings**. That capability was added in Global-e cartridge **24.1.0**. Your next step depends on which `int_globale` version is running on the site. ### How to find the version Use either method. Both read the same release string. 1. **From the active code version in Business Manager (recommended)** 1. In **Business Manager**, navigate to **Administration → Site Development → Code Deployment**. 2. Open the **active** code version. 3. Open `int_globale/cartridge/templates/resources/globale.properties`. 4. Read the `version` line. Example: ``` version=24.6.0 ``` That value is the Global-e cartridge version deployed on the instance. 2. **From the cartridge properties file** In the same code version, open `int_globale/cartridge/int_globale.properties` and read the `#version` comment: ``` #version 24.6.0 ``` If you manage cartridges in source control rather than only on the instance, the same `version=` line lives in `cartridges/int_globale/cartridge/templates/resources/globale.properties` in the package you deployed. If the version line or comment is **missing**, treat the cartridge as **earlier than 24.1.0** and follow the older-cartridge route below. ### What the version means for this guide | Your `int_globale` version | What to do | | - | - | | **24.1.0 or later** | Use the **configuration path** below. Ask your CSM to add the SendCart mapping. No cartridge code change is required. | | **Earlier than 24.1.0**, or **version missing** | Either **upgrade** to 24.1.0+ (preferred), or use the **hook path** for older cartridges. Do not enable the CSM mapping and the hook for the same keys. | > **Note:** SendCart dynamic attribute mapping shipped in **24.1.0**. Versions **24.1.0 and above** support the configuration path. ## Prerequisites | Requirement | Value | | - | - | | Minimum cartridge version for the mapping path | `int_globale` **24.1.0** or later | | Product custom attributes | `geStandardCode` and `geMidIdentifier` (exact IDs) | | SendCart mapping | Added on the Global-e side by your CSM, then synced by the **GlobaleSettings** job (mapping path only) | | Feature enablement | Confirm with your Customer Success Manager that EU PID is enabled for your account | ## What you need to do ### 1. Store the values on your products Create two product custom attributes to hold the identifiers, named exactly `geStandardCode` and `geMidIdentifier`. Populate them on each variation SKU independently, and leave a value unset when you have nothing to send for that line. | Sent as | What it holds | When to leave it out | | - | - | - | | `standardcode` | The barcode for that line (GTIN, EAN or UPC) | When the item has no barcode. Global-e declares the "no barcode" code automatically. | | `mididentifier` | The manufacturer's product code for that line | Never. This is required on every line. | ``` "Products": [ { "ProductCode": "JKT-4471-BLK-M", "MetaData": { "Attributes": [ { "AttributeKey": "standardcode", "AttributeValue": "5901234123457" }, { "AttributeKey": "mididentifier", "AttributeValue": "MFG-JKT-4471" } ] } } ] ``` ### 2a. Cartridge 24.1.0 or later — ask your CSM to enable the SendCart mapping The mapping lives in your Global-e platform settings (`sfccSendCartMappings`), not in Business Manager, so your CSM or integration contact adds it for your account. When you ask your CSM, tell them: * Your cartridge version (from the check above) * Whether the values live on the **variation SKU**, the **master product**, or both Once added, the mapping reaches your instance on the next run of the scheduled settings sync (**GlobaleSettings**, daily at 02:00 UTC). Run that job manually if you want it sooner. No cartridge code change is needed on supported cartridges. ### 2b. Cartridge earlier than 24.1.0, or version missing — upgrade, or use the project hook Use this path when the version is **below 24.1.0**, or when you **cannot find a version** in `globale.properties` / `int_globale.properties`. **Preferred:** upgrade `int_globale` (and the matching SFRA / SiteGenesis / headless extension cartridges) to **24.1.0 or later**, then follow step 2a. **If you cannot upgrade yet**, supply the values through the `globale.getPLICustomMetadata` hook in your project cartridge. Register the hook in `hooks.json` and return the lowercase keys only when a value exists: ```json theme={null} { "hooks": [ { "name": "globale.getPLICustomMetadata", "script": "./cartridge/scripts/globale/hooks/getPLICustomMetadata.js" } ] } ``` ```js theme={null} 'use strict'; /** * Returns per-PLI metadata for the SendCart request. * @param {dw.order.ProductLineItem} productLineItem - Product line item * @returns {Object|null} - Key/value pairs added to Product.MetaData.Attributes */ exports.getPLICustomMetadata = function (productLineItem) { var apiProduct = productLineItem && productLineItem.product; if (!apiProduct) { return null; } var result = {}; var standardCode = apiProduct.custom.geStandardCode; var midIdentifier = apiProduct.custom.geMidIdentifier; if (standardCode) { result.standardcode = String(standardCode); } if (midIdentifier) { result.mididentifier = String(midIdentifier); } return Object.keys(result).length ? result : null; }; ``` Do **not** use both the CSM SendCart mapping and this hook for `standardcode` / `mididentifier`, or you will get duplicate entries. ## Key points **One pair of values per variant.** Each variation SKU sends its own `standardcode` and `mididentifier`, not just the master product. **The values are sent under the exact keys** `standardcode` and `mididentifier` (lowercase). **Omit, don't fake.** When you have no value, leave the key out entirely. Never send an empty string, `NA`, `0`, or `-`. **Do not use the** `geMetadataCustomAttributes` **site preference for EU PID.** It only skips null values, not empty strings, so it can send blanks. **Keep separate from US MID.** If you already send `midcode` / `midname` / `midaddress`, keep sending them and add these two alongside. Do not map EU PID onto the MID keys. ## Quick check before go-live | Check | Done | | - | - | | Cartridge version confirmed (`globale.properties` → `version=`), or missing version treated as \< 24.1.0 | ☐ | | Path chosen: mapping (24.1.0+) **or** hook (\< 24.1.0 / version missing), not both for the same keys | ☐ | | Catalog attributes populated on each variation SKU that needs identifiers | ☐ | | SendCart mapping added and synced (settings job has run) — mapping path only | ☐ | | Hook registered and returning lowercase keys — hook path only | ☐ | | `standardcode` appears on a line when the variant has a barcode | ☐ | | `mididentifier` appears on every line that has a manufacturer code | ☐ | | Lines with no barcode omit the key (no empty string or placeholder) | ☐ | | Each variation SKU sends its own pair of values | ☐ | | EU PID keys are separate from the US MID keys, with no duplicates | ☐ | # Setting Up Global-E Product Identifiers in Shopify for EU Compliance Source: https://docs.global-e.com/eu-product-identifiers-setup-shopify Part of the [EU Customs Reform - Product Identifiers (PID)](/eu-product-identifiers-pid), please read for overall regulation context and requirements. From 1 November 2026 you need to add two pieces of product data in Shopify. Your **SKU** already reaches us and needs no action. You can provide the data in **either** of these ways (or both): * **Recommended - Shopify variant Barcodes** - see **Option A** below * **Alternative if unable to use barcodes - Global-e variant metafields** - see **Option B** below, only used if Shopify barcodes are empty > [!NOTE] > > **Already using the metafields?** You do **not** need to migrate to Barcodes right now. We keep reading the metafields but recommend moving to Shopify new standardised barcode fields in the future. *** ## What you need to provide For what each identifier is, see [The three identifiers](/eu-product-identifiers-pid#the-three-identifiers) on the overview page. Data is set **per variant**, not per product. A barcode belongs to a specific sellable item - a size M black t-shirt has a different barcode from a size L. Use product-level fields only if the product has a single variant, or if the value is genuinely identical across every variant. | What we need | Barcodes type (Option A) | Metafield (Option B) | | - | - | - | | **NS-PID** - manufacturer / supplier product code (required) | **NS-PID** (non-standardised product identifier) | `globale.mididentifier` | | **S-PID** - standardised barcode when you have one. If there is still no S-PID, we treat the product as having no standardised barcode | **GTIN**, **EAN**, **UPC**, or **ISBN** | `globale.standardcode` | > [!WARNING] > > Do not enter placeholder values. Never use NA, N/A, 0, -, a blank space, or similar. *** ## Option A - Shopify Barcodes Shopify lets you add **more than one barcode per variant**, each with a **type**. Use the **bulk editor**, **CSV**, or **Admin API** to perform changes on multiple products/variants. In Shopify Admin: 1. Open **Products** → choose a product → open a **variant**. 2. In **Barcodes**, add an entry and choose the type: * **NS-PID** → for **NS-PID** (manufacturer code, model number, supplier SKU, or your own style code * **GTIN**, **EAN**, **UPC**, or **ISBN** → for **S-PID** when you have a real barcode 3. Save the variant.. **Detailed Guide:** **1.Non Standardized Product ID (NS-PID)** NS-PIDs can be added to the product in the NS-PID field in the barcode dropdown. This is available at both the Product and Variant level. Make sure you select the ‘NS-PID’ option. ![](https://mintcdn.com/globale-enterprise/8l6AV_68U27_hcFh/images/eu-product-identifiers/shopify-barcode-type-ns-pid.png?fit=max\&auto=format\&n=8l6AV_68U27_hcFh\&q=85\&s=f8c63f798a260031ad75d848eb23408d) If you have added the NS-PID correctly, it should look like this: ![](https://mintcdn.com/globale-enterprise/8l6AV_68U27_hcFh/images/eu-product-identifiers/shopify-ns-pid-added.png?fit=max\&auto=format\&n=8l6AV_68U27_hcFh\&q=85\&s=fedae0a0ade8c43342d79233c3212866) **2. Standardized Product Identifier (S-PID) - Barcode** S-PIDs can be added to the product in the Barcode field. This is available at both the Product and Variant level. Make sure you select one of the applicable S-PID options: GTIN, UPC, EAN or ISBN. ![](https://mintcdn.com/globale-enterprise/8l6AV_68U27_hcFh/images/eu-product-identifiers/shopify-barcode-type-s-pid.png?fit=max\&auto=format\&n=8l6AV_68U27_hcFh\&q=85\&s=b10565ae520e0d1d4bcfa5c4b6923765) Once you have both the NS-PID and S-PID added to your product/variant, it should look something like this: ![](https://mintcdn.com/globale-enterprise/8l6AV_68U27_hcFh/images/eu-product-identifiers/shopify-ns-pid-and-s-pid.png?fit=max\&auto=format\&n=8l6AV_68U27_hcFh\&q=85\&s=1f62c094072dd90daeaa5700ec2e3160) > [!NOTE] > > **Legacy single Barcode field:** Shopify is moving that value into **Barcodes**. We can use it where it maps to S-PID. You still need **NS-PID** in **NS-PID**. **If you already have barcode values on a variant**, Global-e picks your **S-PID** (`standardcode`) from that variant's **Barcodes** list using the first match below. 1. A **Custom** (or untyped) barcode that passes Shopify's **GTIN** format checks 2. The first barcode typed **GTIN** 3. The first barcode typed **EAN** 4. The first barcode typed **UPC** 5. The first barcode typed **ISBN** 6. A **Custom** (or untyped) barcode that did not pass GTIN checks at step 1 *** ## Option B - Global-e metafields ### What to do - three steps **Step 1 - Create the two metafield definitions** Navigate to **Settings → Metafields and metaobjects → Variants → Add definition** and create both of the following. After entering the metafield name, click `custom.standardcode` to change the namespace: ![](https://mintcdn.com/globale-enterprise/7RFF9xle0aJHH2fk/images/eu-product-identifiers/shopify-metafield-namespace-link.png?fit=max\&auto=format\&n=7RFF9xle0aJHH2fk\&q=85\&s=6250cdf7a041277b04f758b9917d6a5a) Change the default `custom` namespace to `globale`: ![](https://mintcdn.com/globale-enterprise/7RFF9xle0aJHH2fk/images/eu-product-identifiers/shopify-metafield-namespace-field.png?fit=max\&auto=format\&n=7RFF9xle0aJHH2fk\&q=85\&s=90bec6b98b6bb11b89d6f57e6aeb78cf) | Name | Namespace and key | Content type | | - | - | - | | standardcode | `globale.standardcode` | Single line text | | mididentifier | `globale.mididentifier` | Single line text | > [!WARNING] > > Enter these exactly as shown. Changing the name, the namespace and key, or the content type will stop Global-e from reading the values, and your orders will be submitted without the identifiers. **Step 2 - Populate the metafields on your variants** You can edit values individually, or in bulk using the Shopify bulk editor, a CSV import, or the Admin API. * `standardcode` - set per variant. It normally differs across sizes and colours. * `mididentifier` - required on every variant. Often identical across all variants of a product, so it usually bulk-edits cleanly. **Step 3 - Keep metafields in your product-creation process** New variants added after go-live will not inherit these values automatically. Re-check coverage after any catalogue migration, PIM change or bulk update. **Bulk Editing** You may bulk edit all of your products to fill in the Barcode in one go: Editing Barcode in bulk: [Shopify Help Center Bulk Editing](https://help.shopify.com/en/manual/shopify-admin/productivity-tools/bulk-editing) Configuration for each product/variants may also be done individually via the Products page. # EU Product Identifiers Source: https://docs.global-e.com/eu-product-identifiers-setup-shopware Part of the [EU Customs Reform - Product Identifiers (PID)](/eu-product-identifiers-pid). On Shopware, the two identifiers are read from your catalog at checkout and sent to Global-e by the Global-e plugin. This is a configuration task, not a code change: you store the values in your catalog, then point the plugin at the fields that hold them. Your SKU is already sent separately, so there is no new SKU field to add. For what each identifier is, see [The three identifiers](/eu-product-identifiers-pid#the-three-identifiers) on the overview page. ## Prerequisites | Requirement | Value | | - | - | | Minimum plugin version | Global-e Shopware 6 plugin 1.6.7 | You can check your plugin version by going to **Extensions** → **My** **Extensions** ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/shopware-plugin-version.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=5beb397ccb6a89ea6182d3c0ecc8824b) ## What you need to do 1. **Store the values on your products.** Make sure each variant that can appear in the cart holds the values you want to send: the barcode (GTIN, EAN or UPC) and the manufacturer code. Use whichever catalog fields you already keep them in. 2. **Point the plugin at those fields.** Navigate to **Extensions**, then **My Extensions** and click on **Configure** next to the **Global-e Cross-Border extension** ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/shopware-configure-extension.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=1cc226443a9c31f29e1987afb1d721b9) Under **Products**, in **Product Extra Attributes**, list the technical field names that hold your barcode and your manufacturer code. The plugin sends them to Global-e as `standardcode` and `mididentifier`. ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/shopware-product-extra-attributes.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=f99eba5651b281b4147bd251e9644876) 3. **Save**, and clear the Shopware cache if your deployment requires it. | Sent as | What it holds | When to leave it out | | - | - | - | | `standardcode` | The barcode for that variant (GTIN, EAN or UPC) | When the item has no barcode. Global-e declares the “no barcode” code automatically. | | `mididentifier` | The manufacturer’s product code for that variant | Never. This is required on every line. | ## Key points **One pair of values per variant.** Populate each variant that can appear in the cart. A value on the parent product alone is not enough when the variant has no value of its own.**Your Shopware field names are your choice.** The plugin maps them to the exact keys `standardcode` and `mididentifier` (lowercase), so your own field names do not need to match.**Omit, don’t fake.** When a variant has no value, leave the key out. Never send an empty string, NA, 0 or -. **Keep separate from US MID.** Do not use the US MID fields for EU PID. **When values are read:** at checkout, when the customer proceeds to Global-e. Updated catalog values apply on that variant’s next checkout. ## Quick check before go-live | Check | Done | | - | - | | Each variant that needs identifiers has its values in the catalog | ☐ | | The plugin’s **Product Extra Attributes** lists those catalog fields | ☐ | | `standardcode` and `mididentifier` appear when the variant has values | ☐ | | Keys are omitted (not empty) when a variant has no value | ☐ | | Each variant in the cart sends its own pair | ☐ | | Cache cleared after the configuration change | ☐ | # EU Product Identifiers Source: https://docs.global-e.com/eu-product-identifiers-setup-wix Part of the [EU Customs Reform - Product Identifiers (PID)](/eu-product-identifiers-pid). On Wix, you add both identifiers on the product page in your Wix dashboard. The Global-e app reads them at checkout and sends them to Global-e as `standardcode` and `mididentifier`. Your SKU is already sent separately, so there is no new SKU field to add. For what each identifier is, see [The three identifiers](/eu-product-identifiers-pid#the-three-identifiers) on the overview page. ## Where each identifier goes | Identifier | Wix field | Where to find it | | - | - | - | | **`standardcode`** (S-PID) | **Barcode (GTIN)** | Product page, Inventory and pre-order section. For products with variants, on the Variants page. | | **`mididentifier`** (NS-PID) | **midIdentifier** | Product page, Global-E App Production section. One value per product, used for all its variants. | ## Adding the required data on the product page 1. **S-PID — Standardised Product Identifier (`standardcode`).** In your Wix dashboard, navigate to Products and open the product. **Product without variants.** In the Inventory and pre-order section, fill in **Barcode (GTIN)**. ![](https://mintcdn.com/globale-enterprise/TIZd0vloxoX5BIyR/images/eu-product-identifiers/wix-barcode-product.png?fit=max\&auto=format\&n=TIZd0vloxoX5BIyR\&q=85\&s=18463e12f3cbe75774cbc6f841e193bd) Product without variants: Barcode (GTIN) in Inventory and pre-order. **Product with variants.** In the Inventory and pre-order section, click **Go to Variants**. ![](https://mintcdn.com/globale-enterprise/TIZd0vloxoX5BIyR/images/eu-product-identifiers/wix-go-to-variants.png?fit=max\&auto=format\&n=TIZd0vloxoX5BIyR\&q=85\&s=52dc51b546a9eabdb8db5d38c96b09ca) Product with variants: inventory is managed per variant. Fill in **Barcode (GTIN)** for each variant that can appear in the cart, then click **Apply & Continue**. ![](https://mintcdn.com/globale-enterprise/TIZd0vloxoX5BIyR/images/eu-product-identifiers/wix-variants-barcode.png?fit=max\&auto=format\&n=TIZd0vloxoX5BIyR\&q=85\&s=9e783b360de0d46a79a9d3780581513e) Variants page: one Barcode (GTIN) per variant. 2. **NS-PID — Non-Standardised Product Identifier (`mididentifier`).** Scroll to the **Global-E App Production** section at the bottom of the product page and fill in **midIdentifier**. This is set once per product and applies to all of its variants. The same section also holds **garanImageURL**, which is used for GARAN labels, not for EU PID. ![](https://mintcdn.com/globale-enterprise/TIZd0vloxoX5BIyR/images/eu-product-identifiers/wix-global-e-app-section.png?fit=max\&auto=format\&n=TIZd0vloxoX5BIyR\&q=85\&s=398f09e0b463d7d72a609a27725b1041) Global-E App Production section: midIdentifier. 3. Save the product, place a test order, and confirm both keys appear when values exist and are omitted when blank. | Sent as | What it holds | When to leave it out | | - | - | - | | **`standardcode`** | S-PID: the global standard code for that item (GTIN, EAN or UPC) | When the item has no S-PID. Global-e treats a missing S-PID as confirmation that none exists for that product. | | **`mididentifier`** | NS-PID: the manufacturer's product code for that product | Never. This is required on every line. | ## Key points * **S-PID per variant.** For products with variants, fill in Barcode (GTIN) on each variant that can appear in the cart. * **NS-PID per product.** midIdentifier is set at product level, so every variant of a product sends the same value. * **Omit, don't fake.** Leave the field empty when you have no value. Never enter NA, 0 or -. * **When values are read:** at checkout, when the customer proceeds to Global-e. Updated product values apply on that product's next checkout. ## Quick check before go-live | Check | Done | | - | - | | Barcode (GTIN) filled in on each product, or on each variant for products with variants, where an S-PID exists | ☐ | | midIdentifier filled in under the Global-E App Production section on each product | ☐ | | `standardcode` and `mididentifier` appear in SendCart when the item has values | ☐ | | Keys omitted (not empty) when an item has no value | ☐ | # EU Product Identifiers Source: https://docs.global-e.com/eu-product-identifiers-setup-woocommerce Part of the [EU Customs Reform - Product Identifiers (PID)](/eu-product-identifiers-pid). On WooCommerce, the Global-e plugin sends `standardcode` and `mididentifier` to Global-e at checkout. Your SKU is already sent separately, so there is no new SKU field to add. For what each identifier is, see [The three identifiers](/eu-product-identifiers-pid#the-three-identifiers) on the overview page. ## Choose your setup There are two ways to send the identifiers. Both need a developer to add a short code snippet, because WooCommerce has no built-in field for the manufacturer code. Pick the option that fits your store and follow only that section. | Option | Use it when | `standardcode` (S-PID) comes from | `mididentifier` (NS-PID) comes from | Minimum versions | | - | - | - | - | - | | **A. Native GTIN field + code filter** (recommended) | You are on WooCommerce 9.2 or later | The native GTIN, UPC, EAN, or ISBN field, per variation | The code filter, per variation | Plugin **1.17.2**, WooCommerce **9.2** | | **B. Code filter only** | You are on WooCommerce below 9.2, or your barcodes are stored outside WooCommerce | The code filter, per variation | The code filter, per variation | Plugin **1.14.0** | You can check your plugin version by navigating to **Plugins → Installed Plugins**. ![](https://mintcdn.com/globale-enterprise/TSLEJxyEPjRJOJpp/images/eu-product-identifiers/woocommerce-plugin-version.png?fit=max\&auto=format\&n=TSLEJxyEPjRJOJpp\&q=85\&s=493330ee8dfd489d2aedd0f01e8d626e) ## Option A: Native GTIN field + code filter **Requires:** Global-e WooCommerce plugin 1.17.2 or later, on WooCommerce 9.2 or later. 1. **Fill in the S-PID (`standardcode`).** Fill in **GTIN, UPC, EAN, or ISBN**. For a simple product, it's under Product data, then Inventory. For a variable product, fill it in on each variation (Variations, then open the variation). You can also fill it in on the parent product's Inventory tab: any variation without its own value uses the parent's value. No plugin setting is needed for this field. ![](https://mintcdn.com/globale-enterprise/NaDKZJBQKzig2Mzi/images/eu-product-identifiers/woocommerce-native-gtin-simple.png?fit=max\&auto=format\&n=NaDKZJBQKzig2Mzi\&q=85\&s=6e82acd2b70881e14d40831a5a7f8042) Simple product: Product data, then Inventory. ![](https://mintcdn.com/globale-enterprise/bNbyOWzwAlbV9q4r/images/eu-product-identifiers/woocommerce-native-gtin-variation.png?fit=max\&auto=format\&n=bNbyOWzwAlbV9q4r\&q=85\&s=b460fae45b3d9864f4ed40bac35c141f) Variable product: the field on each variation. ![](https://mintcdn.com/globale-enterprise/NaDKZJBQKzig2Mzi/images/eu-product-identifiers/woocommerce-native-gtin-parent.png?fit=max\&auto=format\&n=NaDKZJBQKzig2Mzi\&q=85\&s=4bda5908323857c06bc402c224d78d83) Variable product: the parent's Inventory tab, used for variations without their own value. 2. **Send the NS-PID (`mididentifier`) with the code filter.** Add the code from [The code filter](#the-code-filter) below, and remove the `standardcode` line from the example so the native field value is used. 3. Place a test order and confirm both keys appear when values exist and are omitted when blank. ## Option B: Code filter only **Requires:** Global-e WooCommerce plugin 1.14.0 or later. 1. **Send both identifiers with the code filter.** Add the code from [The code filter](#the-code-filter) below, with both the `mididentifier` and `standardcode` lines. 2. Place a test order and confirm both keys appear when values exist and are omitted when blank. If you later upgrade to WooCommerce 9.2 and plugin 1.17.2, you can move `standardcode` to the native field (Option A). Remove the `standardcode` line from the code when you do. ## The code filter The plugin's `woocommerce_globale_pro_add_cart_product_meta_attributes` filter adds key/value pairs to each cart line's MetaData. Your developer decides where the values come from: for example, a custom field on each variation (added by your developer or a custom fields plugin), or an external system such as your ERP or PIM. Example for your theme's `functions.php` or a custom plugin. Replace the meta keys with wherever you store the identifiers: ```php theme={null} add_filter( \GCBWC\Globale\Pro\Model\Cart::FILTER_CART_PRODUCT_META_ATTRIBUTES, 'gcbwc_add_pid_meta_attributes', 10, 2 ); if ( ! function_exists( 'gcbwc_add_pid_meta_attributes' ) ) : function gcbwc_add_pid_meta_attributes( $metaAttributes, $cart_item ) { // Read from the variation when there is one, otherwise from the product. $id = ! empty( $cart_item['variation_id'] ) ? $cart_item['variation_id'] : $cart_item['product_id']; // Replace these meta keys with wherever you store the identifiers. // Option A: remove the standardcode line. $pids = array( 'mididentifier' => get_post_meta( $id, '_your_mididentifier_meta_key', true ), 'standardcode' => get_post_meta( $id, '_your_standardcode_meta_key', true ), ); foreach ( $pids as $key => $value ) { if ( '' === trim( (string) $value ) ) { continue; // Leave the key out when there is no value. } $attribute = new \GCBWC\Globale\Pro\Api\Entity\CustomProductAttribute(); $attribute->setAttributeKey( $key ); $attribute->setAttributeValue( $value ); $metaAttributes[] = $attribute; } return $metaAttributes; } endif; ``` * Use the keys exactly as written, in lowercase: `mididentifier` and `standardcode`. * Leave a key out when there is no value. Never send NA, 0 or -. * Send each key from one source only. If `standardcode` is in the native field, don't also send it with the filter. * Test on a staging site first and confirm both keys appear on the cart line. ## Reference **What gets sent** | Sent as | What it holds | When to leave it out | | - | - | - | | **`standardcode`** | S-PID: the global standard code for that product or variation (GTIN, EAN, UPC or ISBN) | When the item has no S-PID. Global-e treats a missing S-PID as confirmation that none exists for that product. | | **`mididentifier`** | NS-PID: the manufacturer's product code for that product or variation | Never. This is required on every line. | **Key points** * **Native field fallback.** For the native GTIN, UPC, EAN, or ISBN field, a variation without its own value uses the parent product's value. * **Omit, don't fake.** Leave the value empty when you have none. Never enter NA, 0 or -. * **When values are read:** at checkout, when the customer proceeds to Global-e. Updated catalog values apply on the next checkout. **Quick check before go-live** | Check | Done | | - | - | | You meet the minimum versions for the option you chose | ☐ | | Option A: GTIN, UPC, EAN, or ISBN filled in, and the code filter sends `mididentifier` | ☐ | | Option B: the code filter sends `standardcode` and `mididentifier` | ☐ | | No `standardcode` or `mididentifier` attributes left in Extra Product Attributes | ☐ | | `standardcode` and `mididentifier` appear in SendCart when the item has values | ☐ | | Keys omitted (not empty) when an item has no value | ☐ | # EU Right of Withdrawal - Overview Source: https://docs.global-e.com/eu-right-of-withdrawal-merchant-setup-guide ## Overview From 19 June 2026, EU Directive 2023/2673 requires online traders to provide EU consumers with a visible, dedicated withdrawal mechanism that is as easy to use as the original purchase process. The 14-day right of withdrawal itself is not new - but merchants must now make it actively and easily accessible online. As your Merchant of Record for EU transactions, Global-e provides the withdrawal entry point across checkout, order confirmation, Service Center, confirmation emails, and the CS AI chatbot. This guide covers everything you need to configure on your side. There are two things to set up: * **Step 1 - Return Policy** * On the new returns platform? See [Section A](/eu-right-of-withdrawal-merchant-setup-guide-implementing#section-a-activating-your-return-policy-new-returns-platform) * On the legacy portal (not yet upgraded)? See [Section B](/eu-right-of-withdrawal-merchant-setup-guide-implementing#section-b-handling-withdrawals-on-the-legacy-return-portal) * **Step 2 - Emails** * Using Global-e Email Management? See [Section C1](/eu-right-of-withdrawal-merchant-setup-guide-implementing#c1-global-e-custom-email-tool-email-management) * Using Shopify Notification Emails? See [Section C2](/eu-right-of-withdrawal-merchant-setup-guide-implementing#c2-shopify-notification-emails) # EU Right of Withdrawal - Merchant Setup Guide Source: https://docs.global-e.com/eu-right-of-withdrawal-merchant-setup-guide-implementing ### Overview From 19 June 2026, EU Directive 2023/2673 requires online traders to provide EU consumers with a visible, dedicated withdrawal mechanism that is as easy to use as the original purchase process. The 14-day right of withdrawal itself is not new - but merchants must now make it actively and easily accessible online. As your Merchant of Record for EU transactions, Global-e provides the withdrawal entry point across checkout, order confirmation, Service Center, confirmation emails, and the CS AI chatbot. This guide covers everything you need to configure on your side. There are two things to set up: * **Step 1 - Return Policy** * On the new returns platform? See [Section A](/eu-right-of-withdrawal-merchant-setup-guide-implementing#section-a-activating-your-return-policy-new-returns-platform) * On the legacy portal (not yet upgraded)? See [Section B](/eu-right-of-withdrawal-merchant-setup-guide-implementing#section-b-handling-withdrawals-on-the-legacy-return-portal) * **Step 2 - Emails** * Using Global-e Email Management? See [Section C1](/eu-right-of-withdrawal-merchant-setup-guide-implementing#c1-global-e-custom-email-tool-email-management) * Using Shopify Notification Emails? See [Section C2](/eu-right-of-withdrawal-merchant-setup-guide-implementing#c2-shopify-notification-emails) ### Managing EU Right of Withdrawal Requests The sections below (A and B) walk you through how to configure your return setup depending on which platform you use. Before getting started, note that certain product types are **not legally excluded** from withdrawal but cannot be processed through the standard returns portal - these require manual Customer Service handling regardless of which platform you are on. ### Product Types Not Supported in the Returns Portal The following product types are **not legally exempt** from the right of withdrawal - the right technically still exists - but they cannot be processed through the standard returns portal due to the nature of the product. Shoppers are directed to Customer Service. | Product Type | How It Is Handled | | - | - | | Dangerous goods | Right of Withdrawal legally still applies, but these items are blocked in the return portal. Shoppers are directed to Customer Service. | | Virtual goods / digital content | Right of Withdrawal can only be waived if the merchant obtained explicit prior consent at checkout. Without that consent, handled by Customer Service. | > [!WARNING] > > **Final-sale and non-returnable items - different situation** > > Unlike dangerous goods or virtual content, "final sale" and "non-returnable" are **merchant designations, not product-type exemptions**. Under EU law, these labels do not exempt items from the statutory right of withdrawal. The shoppers' right still exists and must be honored. > > If you're using the legacy portal, such items won't appear returnable in the portal. > > Handle the withdrawal manually via Customer Service and make sure your returns policy text reflects this correctly. > [!NOTE] > > **This guide has two paths - find yours before you begin** > > **New returns platform:** Global-e has pre-built a ready-to-use EU Right of Withdrawal policy in your account. You only need to activate it. See [Section A](/eu-right-of-withdrawal-merchant-setup-guide-implementing#section-a-activating-your-return-policy-new-returns-platform). > > **Legacy return portal (not yet upgraded):** There is no pre-built policy. A new return reason has been added to help you identify withdrawal requests, but eligibility validation and refund calculation are manual steps you own. See [Section B](/eu-right-of-withdrawal-merchant-setup-guide-implementing#section-b-handling-withdrawals-on-the-legacy-return-portal). > > *Not sure which platform you're on? Check with your Customer Success Manager.* ### Section A: Activating Your Return Policy (New Returns Platform) **Applies to:** Merchants already upgraded to the new returns platform. Global-e has pre-built the policy in your account - you only need to activate it. > [!NOTE] > > **What's pre-built in your policy** > > The `EU Right of Withdrawal` rule arrives pre-configured and is **inactive by default**. It is a new, additive rule - it runs alongside your existing return policy rules without modifying them. #### Pre-configured Policy Settings | # | Setting | Pre-configured Value | | - | - | - | | 1 | **Eligibility window** | 14 days from delivery, scoped to EU destinations only. The countdown starts on the day of delivery; however, consumers can also withdraw before goods arrive. | | 2 | **Return reason** | "Order Withdrawal" - no follow-up questions, no media upload, no manual approval. | | 3 | **Resolution** | Refund to Original Payment Method only. Gift cards and exchange are disabled for this reason. | | 4 | **Refund composition** | Item price + collected duties & taxes (DDP orders only) + original outbound shipping fee. | | 5 | **Additional fees** | Restocking and return-handling fees are prohibited. Return shipping costs can be charged only if clearly disclosed before purchase; otherwise merchant covers it. | | 6 | **Confirmation email** | The legally required durable-medium acknowledgement is sent automatically when the RMA is created. | #### Step 1 - Activate the Return Reason The `Order Withdrawal` return reason has been created in your platform and is hidden by default. Activate it so shoppers can select it in the withdrawal flow. 1. In your returns platform admin, navigate to **Settings > Return Reasons**. 2. Locate the return reason named **Order Withdrawal**. 3. Click the return reason to open it. 4. Toggle **Display reason** to **ON**. 5. Click the save icon. 6. Drag the new return reason to the top of your list. #### Step 2 - Activate the Policy Rule 1. In your returns platform admin, navigate to **Settings > Return Policy**. 2. Locate the rule named **EU Right of Withdrawal**. 3. Click the rule to open it and review the pre-configured settings (optional but recommended). 4. Toggle **Activate Policy Rule** to **ON**. 5. Click the save icon. #### Customizing the Policy - What You Can and Cannot Change > [!WARNING] > > **Do not remove these directive-required settings** > > The following must remain in the policy: the OPM-only resolution, the 14-day eligibility window, the EU country scope, and the refund of original outbound shipping. Removing any of these will put the configuration out of compliance with the directive. **Using final sale or non-returnable tags?** Make sure the EU Right of Withdrawal policy is not restricted by those tags. EU shoppers retain the statutory right of withdrawal regardless of how an item is tagged in your store. **Selling customizable or personalized goods?** Customized and personalized items are legally exempt from the right of withdrawal under Article 16 of the Consumer Rights Directive. If you sell such products, add an item-level exclusion condition to the EU Right of Withdrawal policy rule so those items are not eligible for withdrawal. Without this exclusion, personalized items may incorrectly appear eligible in the return portal. #### Step 3 - Withdrawal Confirmation Email (Durable Medium) Article 11a requires that on receipt of the withdrawal request, you confirm it on a durable medium without undue delay. **The return platform sends this automatically** when creating the RMA under the policy - no action needed on your side. #### Step 4 - Test the Full Flow End-to-End Before going live, run at least one full test on a sandbox or low-volume EU market: 1. Place a test order from an EU destination address. 2. Mark the order as fulfilled and delivered. 3. Open the Global-e Right of Withdrawal entry point (confirmation page, Help Center, or confirmation email). 4. Verify: items within 14 days are eligible; selecting Order Withdrawal triggers no follow-up question or photo upload; resolution shown is Refund to original payment method only; refund summary shows item price + tax + original outbound shipping - return label fee; a pre-paid label is generated; the shopper receives the acknowledgement email immediately after submitting. 5. Confirm in the RMA page that the request was auto-approved. 6. Submit a second test RMA using a non-withdrawal reason (e.g. "Didn't fit") and confirm it matches your existing return policy rule, not the new EU Withdrawal rule. ### Section B: Handling Withdrawals on the Legacy Return Portal **Applies to:** Merchants selling to the EU who are still on the legacy return portal (not yet upgraded to the new returns platform). **What's New** A new return reason, **"EU Shoppers - Order Withdrawal"**, now appears in the legacy return portal's reason list. The name leads with the region tag to signal it is intended for EU shoppers exercising their statutory right of withdrawal, and discourage non-EU shoppers from selecting it. > [!NOTE] > > **Using a custom return reason list?** If your return portal is configured with a custom return reason list, this reason will not appear automatically - it is only added to the platform-wide generic reason list. Please contact your Customer Success Manager to have it added to your custom list. > [!WARNING] > > **Important limitations - please read before proceeding** > > 1. The "EU Shoppers - Order Withdrawal" reason is **shown to all shoppers**, regardless of country or delivery date. The legacy portal cannot restrict it to EU shoppers or to the 14-day window. The reason name is the only deterrent. > 2. Selecting the "EU Shoppers - Order Withdrawal" reason **does not automatically change the refund**. It is purely an identification flag. **You are responsible for validating eligibility and issuing the correct refund.** > 3. **Early-refund** - The legacy portal's early-refund will NOT add the original outbound shipping fee. It must be refunded as a separate manual step outside the portal. **What to Do When a Return Comes In with "EU Shoppers - Order Withdrawal"** 1. Check the shopper's destination country - confirm it is an EU member state (the reason is not country-restricted in the portal). 2. Check the return window - the request must be within 14 days of delivery. 3. If both conditions are met, the withdrawal is valid. Issue a refund that includes: item price + collected duties and taxes (DDP orders only) + original outbound shipping fee (standard rate only - if the shopper selected express or premium shipping, only the standard rate is required). Restocking and return-handling fees may NOT be charged. Return shipping cost may only be charged to the shopper if clearly disclosed before purchase; otherwise, you cover it. 4. Action the additional refund (duties/tax + outbound shipping) via Global-e Admin, Shopify Admin, or the Refund API. **If Your Returns Flow Is Already Automated** If your OMS or WMS already processes returns automatically, you can map the "EU Shoppers - Order Withdrawal" reason to trigger your own EU + 14-day validation and automatically issue the full refund (item + duties & taxes + outbound shipping) via the Refund API. > [!NOTE] > > **Upgrading to the new returns platform** - The legacy return portal will be retired by end of 2026. All merchants are required to complete the upgrade before then. After upgrading, you will have a pre-built EU Right of Withdrawal policy scoped to EU shoppers within 14 days of delivery - it automatically calculates the correct refund and sends the durable-medium confirmation with no manual steps required. If your upgrade is already scheduled, please complete it as soon as possible. ### Section C: Adding the Withdrawal Link to Your Emails Complete the section below that matches how you send order emails to EU shoppers. ### C1 - Global-e Custom Email Tool (Email Management) **Applies to:** Merchants using Global-e's Custom Email Tool (Email Management) to send order emails. **Prerequisites:** Email Management active for your account; basic HTML editing skills. **Path:** Global-e Merchant Portal → Configuration → Email Management **Email types to update:** Order Confirmed · Order Dispatched · Order Dispatched Partially · Order Delivered to Store > [!NOTE] > > Repeat Steps 2-9 below for **each** of the four email types listed above. 1. **Step 1: Open Email Management** - Log in to the Global-e Merchant Portal → Configuration → Email Management. 2. **Step 2: Select the Email Type** - Use the Email Type dropdown to pick one. 3. **Step 3: Download the Current HTML** - Template (HTML) → Download Current. Save the .html file and open it in your HTML editor. 4. **Step 4: Download Text Resources (Optional)** - To translate the link label to other languages: Text Resources (Excel) → Download Current. Add a new line with `ResourceKey` = `TR_withdrawal_label` and `English - United Kingdom` = `Withdraw this order` (or your preferred label). Add translations to the required language columns. 5. **Step 5: Edit the HTML** - The placeholder `WithdrawalUrl` is filled dynamically by Global-e per order. Place the following code in the **footer area** of your email template: ``` {{#WithdrawalUrl}}

{{TR_withdrawal_label}}

{{/WithdrawalUrl}} ``` > [!WARNING] > > Do NOT remove MoR legal text. Do NOT use a hardcoded URL instead of the `WithdrawalUrl` placeholder. 6. **Step 6: Upload the HTML** - Template (HTML) → Upload New\... → your edited file. If you changed Text Resources, upload the Excel file too. 7. **Step 7: Save Draft and Preview** - Stay in Draft → Save Changes → Preview an Order using an EU ship-to Order ID. Check both Desktop and Mobile previews. 8. **Step 8: Send Test Email** - Send Test → your inbox. Click the withdrawal link and verify it works. 9. **Step 9: Publish** - Publish / Publish Changes → Confirm **Published** for that email type. 10. **Step 10: Repeat** - Repeat Steps 2-9 for all four email types listed above. ### C2 - Shopify Notification Emails **Applies to:** Shopify merchants who manage their own notification emails (not using Global-e email templates). **Prerequisites:** Shopify Admin access; basic HTML editing skills; your withdrawal page URL (provided by your CSM for Global-e Retail, or from your external return vendor). **Email types to update:** Order confirmation · Shipping confirmation · Shipping update · Delivery confirmation (if applicable) 1. **Step 1: Open Shopify Email Templates** - Shopify Admin → Settings → Notifications → Customer notifications → Select the email to edit. 2. **Step 2: Select Email Type and Edit Code** - Select the email type template, then click **Edit code**. 3. **Step 3: Add Withdrawal Code at the Top of the File** - Choose **one** of the two options below and paste it at the very top of the file. **Option A - Show link for all orders (simpler)** ``` {% comment %} Merchant-provided withdrawal URL {% endcomment %} {% assign withdrawal_url = 'https://YOUR-WITHDRAWAL-URL-HERE' %} {% assign withdrawal_label = 'Withdraw this order' %} {% assign show_withdrawal_link = true %} ``` Replace `https://YOUR-WITHDRAWAL-URL-HERE` with your withdrawal page URL. Global-e Retail solution (new or legacy portal): your CSM will provide this link. External return vendor: use the withdrawal link from your vendor. **Option B - Show link for EU countries only (recommended)** ``` {% comment %} Withdrawal-right countries (ISO 3166-1 alpha-2). Maintain as one comma-separated list. {% endcomment %} {% assign withdrawal_country_codes = 'DE,FR,IT' | split: ',' %} {% comment %} Merchant-provided withdrawal URL {% endcomment %} {% assign withdrawal_url = 'https://YOUR-WITHDRAWAL-URL-HERE' %} {% assign withdrawal_label = 'Withdraw this order' %} {% comment %} Prefer shipping country; fall back to billing (digital/no-ship orders) {% endcomment %} {% assign customer_country = shipping_address.country_code %} {% if customer_country == blank %} {% assign customer_country = billing_address.country_code %} {% endif %} {% assign show_withdrawal_link = false %} {% if customer_country != blank and withdrawal_country_codes contains customer_country %} {% assign show_withdrawal_link = true %} {% endif %} ``` Replace the example country codes (DE, FR, IT) with all EU countries you sell to. Full list: AT, BE, BG, CY, CZ, DE, DK, EE, ES, FI, FR, GR, HR, HU, IE, IS, IT, LI, LT, LU, LV, MT, NL, NO, PL, PT, RO, SE, SI, SK, XI. 4. **Step 4: Add the Link to the Email Footer** - This section is the same for both options. 1. Search for `footer__cell` in the template. 2. Inside the footer, after `disclaimer__subtext`, add the following code: ``` {% if show_withdrawal_link and withdrawal_url != blank %} {% endif %} ``` 5. **Step 5: Save and Repeat** - Click **Save**. Repeat Steps 1-4 for all four email types listed above. **Testing Checklist** | Check | Done | | - | - | | EU ship-to order: link appears in email | ☐ | | Non-EU order: link does not appear (Option B) or appears (Option A) | ☐ | | Link opens correct withdrawal page | ☐ | | All four email types updated | ☐ | ### Frequently Asked Questions **Do I need to build the policy from scratch?** No. Global-e has pre-built the EU Right of Withdrawal rule in your return platform. It is inactive by default - all you need to do is activate it. **Will this change anything for non-EU shoppers?** No. The pre-built policy is scoped to EU customer locations only. All other shoppers continue to follow your existing return policy rules unchanged. **What happens to EU items returned outside the 14-day window?** They fall outside the Withdrawal policy rule and will be matched against your existing return policy (e.g. your regular 30-day return policy). No change. **Can I customize the pre-built policy?** Yes - the pre-built rule is fully editable. Be careful not to remove the settings required by the directive: the OPM-only resolution, the 14-day eligibility window, the EU country scope, and the refund of original outbound shipping. **Are "final sale" or non-returnable items exempt from the Right of Withdrawal?** No. Under EU consumer law, labelling an item as "final sale" or tagging an order as "non-returnable" does not exempt it from the statutory 14-day Right of Withdrawal. Make sure the EU Right of Withdrawal policy is not restricted by those tags. **Can I keep charging a restocking fee on withdrawals?** No. Under Directive (EU) 2023/2673 you may only retain the direct cost of returning the goods (the return label fee). Restocking deductions on a clean withdrawal are not allowed. **Do I need to enable this for every EU country separately?** No. The pre-built policy covers every EU country. If your return label cost varies materially per country, you can duplicate the rule and scope each copy to specific countries. **Will this conflict with my existing return policy rules?** No. The Withdrawal rule is additive and will only match when all three eligibility conditions are met: EU location AND within 14 days of delivery AND reason = Order Withdrawal. **What if I want to disable this entirely?** Toggle Activate Policy Rule OFF on the EU Right of Withdrawal rule (Settings > Return Policy). Note: the customer-facing withdrawal link in checkout, confirmation page, email, and Help Center will continue to display as Global-e remains subject to the directive. ### Need Help? * Return platform documentation (Shopify): [New Returns Portal for Shopify](/new-returns-portal-for-shopify) * Return platform documentation (other platforms): [New Returns Portal for Other Platforms](/new-returns-portal-for-all-platforms--excluding-shopify-) * Open a support ticket: [Escalating a Ticket](/contact-us) * For Global-e-side questions (withdrawal link placement, MOR obligations, scope of the directive), contact your Global-e account manager or Customer Success Manager. ### Legal Disclaimer > [!WARNING] > > This article is intended to help you configure your return platform in a way that supports compliance with Directive (EU) 2023/2673 and its national transpositions. It is **not legal advice**. Certain aspects of this directive remain legally unsettled, with no definitive guidance available as of yet. The configurations described reflect Global-e's current interpretation and operational approach, and should not be relied upon as a statement of law. The right of withdrawal is implemented through national law in each EU member state, and additional or differing local requirements may apply. We strongly recommend reviewing your final configuration with your own legal counsel before going live. # European Merchants with Non-Global-e Carriers Source: https://docs.global-e.com/eur-merchants-with-non-global-e-carriers > [card] > > ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-39644233-7d1c-841f-de54-c0ff278ff07a.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=c5c9fad7b2826516a39be20bd4d0c88a) > > When an international customer visits your site, Global‑e converts the price of your product to the customer's currency. > > At checkout, the customer is presented with the financial details of the transaction: > > * The price of the product minus discounts > * Shipping > * Duties and taxes > > After verifying the validity of the transaction, Global‑e collects the payment and the order is packed and shipped. > > * If you are shipping the products directly from your hub then the final title transfer takes place in the origin country, making this a domestic B2B sale. > * If you are shipping from a Global-e hub, the final title transfer occurs when the goods arrive at the domestic Global-e hub. > > Global‑e then converts the amount of the sale back to your currency and refunds you the amount of the sale, deducting relevant fees and subsidies. > > If you are using your own carriers then the shipping fee, plus duties and taxes (if paid for by the carrier), are included in the refund. > [card] ## Duties and Taxes Process Below are two examples of the financial process that takes place between EU Merchants and both EU and non-EU customers. **EU Merchant- EU Customer** Example: Intra EU “distance selling” to Germany (VAT = 19%) * Product price in Europe = €121 (€100 + 21% VAT) - exported into the EU (Germany) * Shipping charged to customer €5 ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-10781414-e5db-d1c8-9a93-d88a3b3ae6bc.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=de1066bb778ea494b6d90c9faf7e96c4) Net product sale for Merchant: €100 Net including shipping: €105 **EU Merchant - Non-EU Customer** Example: “Pocket” VAT outside the EU * Product price in Europe = €121 (€100 + 21% VAT) - exported out of the EU * Shipping charged to customer €5 ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e71ce19a-a921-02f5-bed4-ce04f66b631b.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=ab05ba9586cc29e5e4b9a59ef85b0e9f) Net product sale for Merchant: €121 Net after shipping subsidy: €126 ## Billing Period and Payment Terms The reconciliation process typically takes place on a weekly basis and results in a comprehensive report of all Merchant sales for the week. Based on the report, Global-e pays the Merchant the sum of all products sold internationally during that week plus any relevant shipping, duties, and taxes, minus the agreed service fee. Global-e's standard payment terms: * 80% of the net proceeds are paid weekly, up to two business days after the weekly reporting day. * 20% of the net proceeds are paid seven days after the end of each calendar month. ## Invoicing When the Reconciliation Report is generated, Global-e also provides Merchants with two invoices: * A self-billing invoice for sales less refunds. * An invoice for Global-e’s services, fees, and any shipping subsidies. To view the invoice navigate to the Global-e Merchant Portal > Merchants > Reports > Reconciliation Reports. **Invoice for Service and Fees** ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a4aa148c-bd2b-10ce-8be0-ab8d83b38bde.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=df190fdacc3866291a7bc4cf6dc09a2b) **Credit Note for Net Sales** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-83af9d65-2890-653d-e9c8-30229efaa79a.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=b10d3068b05408d7ce1d2c0cae5ab28b) ## Global-e Purchase Examples The following two purchase examples offer a detailed look at the price conversion process. There are two types of price conversions: * **Dynamic pricing** - Global-e converts the customer currency on the website for the Merchant. * **Fixed pricing** - The Merchant gives Global-e the customer's price in the customer's currency and that information is fed into the website. **Dutch Merchant- EU customer** Example of dynamic pricing ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e7b06fee-dc55-ed5c-7af6-b086ffdef46f.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=c528c617d708b4e0c57116ed9513bfd6) **Dutch Merchant- Non-EU customer** Example of dynamic pricing ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c032a314-efd7-4f0a-0c07-cbcc1ed64970.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=6983fc61249e8d728357b240db134cca) **Dutch Merchant- Swedish customer** Example of Fixed Pricing ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-663875b7-04a1-0cdc-48a1-a51cb98840a0.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=4b995b2840be8a85c025aa01a6319e4e) ## Reconciliation Report Example Below is a sample Reconciliation Report with a breakdown of the services and fees for that week. For a list of all the report fields and their definitions, see [Reconciliation Report](/reconciliation-report-overview). | | Amount Excl. VAT | VAT | Amount Incl. VAT | | | - | - | - | - | - | | Sales Total | €17108.55 | €3592.80 | €20701.35 | [Sales Example](/eur-merchants-with-non-global-e-carriers#sales-total) | | Refunds Total | (€625.40) | (€131.33) | (€756.73) | [Refunds Example](/eur-merchants-with-non-global-e-carriers#refunds-total) | | **Amount to Invoice** | **€16483.15** | **€3461.47** | **€19944.62** | | | Service Fee | €1262.55 | €265.14 | €1527.69 | 7% of Total Order Value | | Shipping Subsidies (EU) | (€390.42) | (€81.99) | (€472.41) | [Shipping Example](/eur-merchants-with-non-global-e-carriers#shipping-subsidies) | | Shipping Subsidies (Non-EU) | (€405.10) | €0.00 | (€405.10) | | | Taxes Subsidization | (€132.30) | £0.00 | (€132.30) | | | Handling Fee | €76.50 | €16.07 | €92.57 | | | Returns | (€4.00) | (€0.84) | €4.84 | [Returns Example](/eur-merchants-with-non-global-e-carriers#returns) | | **Services and Fees** | **€931.82** | **€82.83** | **€1014.65** | | ### Sales Total **Order Level** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8055631c-6784-9694-1a46-6b4b5deb1277.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=e58d8b152c0d96f013517d7b2eee241d) *Sales Total on the Order Level* **Product Level** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-45681d01-bd95-88f8-8a91-a4015eb83f8a.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=1be61bd8b24d7f88a06be1b3d18e8169) *Sales total on the Product Level* ### Refunds Total ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8e3f4862-8bdd-de90-b8c3-889781e2033e.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=5b25f3000ba3d6255d9acd2807bf922e) *Lists all the refunds that were issued through Global‑e during the relevant period* ### Shipping Subsidies Shipping prices are based on the actual weight that we received from the shipper or measured at our hub. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4d2681d9-bced-ae9f-66d1-9de10cf606f7.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=acc2911aab96eacdd5a41be998d8ad6d) *shipping costs are reconciled based on the date of the shipment* ### Returns ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-dbd30617-2b13-e2e3-3364-73e6835dc0f1.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=2915affa7d985a178cb7a69643851f1a) *Includes the details of each returned parcel* # Events Summary Source: https://docs.global-e.com/events-summary This section summarizes the events exposed by the Client SDK library. > [!WARNING] > > When using the Global-e Module platform, make sure to incorporate the following line prior to registering for the events detailed in this section. Note that the correct queue name for event registration is "`glegem`" (and not "`gle`"). > > ``` > var glegem = window["glegem"] || function(){(window["glegem"].q = window["glegem"].q || []).push(arguments)}; > ``` ## OnBeforeWelcome This event occurs before the Welcome pop-up is displayed. ``` /*event data*/ //e.country = e.g. IL, GB,US //e.culture = e.g. RU,EN //e.currency = e.g. EUR,USD //e.onComplete = argument array of key,value e.g. [{key : 'templateDivId', value : 'some html'}] gle("OnBeforeWelcome",function(e){ var html = ""; switch(e.country){ case "NL": html = "
Dynamic Content - Holand
"; break; case "US": case "GB": html = "
Dynamic Content - US & GB
"; break; } e.onComplete([{key : "clientDynamicContent", value : html}]); }); ``` ## OnWelcomeShown The `OnWelcomeShown` event is fired when the welcome pop-up is shown to the customer. ``` gle("OnWelcomeShown", function(){ //Welcome popup Shown; }) ``` ## OnChangeShippingCountryClicked The `OnChangeShippingCountryClicked` event is fired when the "change shipping country" link on the welcome pop-up is clicked. ``` gle("OnChangeShippingCountryClicked",function(){ //change shipping country click on welcome popup clicked }); ``` For more information. ## OnBeforeSwitcher The `OnBeforeSwitcher` event is fired before the country and currency pop-up is shown. ``` /*event data*/ //e.country = e.g. IL, GB,US //e.culture = e.g RU,EN //e.currency = e.g. EUR,USD //e.onComplete = argument array of key,value e.g. [{key : 'templateDivId', value : 'some html'}] gle("OnBeforeSwitcher",function(e){ var html = ""; if (e.culture == "RU"){ html = "
Dynamic Switcher Content - Rusky
"; } else{ html = "
Dynamic Switcher Content - Other
"; } e.onComplete([{key : "clientSwitcherDynamicContent", value : html}]); }); ``` ## OnWelcomePopupClosed The `OnWelcomePopupClosed` event is fired after the welcome pop-up is closed. ``` gle("OnWelcomePopupClosed", function(result){ }); ``` ## OnShippingSwitcherClosed The `OnShippingSwitcherClosed` event is fired after the country and currency pop-up is closed. ``` gle("OnShippingSwitcherClosed", function(result){ return false; }); ``` ## OnCheckoutStepLoaded The `OnCheckoutStepLoaded` event is fired twice when the checkout is first loaded. then when it is complete. ``` gle("OnCheckoutStepLoaded",function(data){ switch(data.StepId){ case data.Steps.LOADED: case data.Steps.CONFIRMATION: if (data.IsSuccess){ //data.OrderId //window.location = "https://www.yourconfirmationpage.com"; } break; } }); ``` ## OnClientEvent The `OnClientEvent` is fired when the customer interacts with the checkout. ``` gle("OnClientEvent",function(source,data){ switch(source){ //events } }); ``` For more information, see [Advanced Checkout Events](/advanced-checkout-events) ## QuerySessionValidity The `QuerySessionValidity` event is used to cause the checkout session to expire after a specified amount of time. ``` gle("QuerySessionValidity",function(oncomplete){ oncomplete( {valid : true,expSeconds :7200}); }); ``` **Note**: * If this feature is not implemented, the checkout will stay open indefinitely until the shopper clicks the place order button. Once the timer expires, a pop-up will redirect the customer back to the cart page. # Export Documents Source: https://docs.global-e.com/export-documents Global-e posts the required shipping documents of an order to the merchant's site once they are ready. ## EAD — Export From Germany An EAD (Export Accompanying Document) is required by German Customs for orders with a customs declarative value above 1,000 EURO shipped from Germany to a country outside the European Union. Global-e can provide this document to Merchants who are doing the shipping themselves. This functionality is not yet supported for Merchants who are using Global-e for shipping. When an order is created, Global-e flags any additional shipping documents required for merchants that are shipping the order themselves in `AdditionalRequiredDocuments` on the [SendOrderToMerchant (Global-e to Merchant)](/api-reference/send-order-to-merchant) notification. In that case, the merchant should delay the fulfillment until the documents are ready and provided to the merchant in the [SendAdditionalRequiredDocumentsToMerchant](/api-reference/send-additional-required-documents-to-merchant) webhook. The `SendAdditionalRequiredDocumentsToMerchant` (Global-e to Merchant) notification posts the required shipping documents of the order to the Merchant's site. This notification informs the Merchant that the documents previously listed in the `SendOrderToMerchant` notification (under `AdditionalRequiredDocuments`), initiated by calling `CreateAdditionalRequiredDocuments`, are ready. The document's content is included in this notification. ## Procedure for receiving an EAD 1. When an order is created, Global-e sends an indication that an EAD is required in the [SendOrderToMerchant (Global-e to Merchant)](/api-reference/send-order-to-merchant) notification (see the `AdditionalRequiredDocuments` section). Do not start fulfilment until the document is ready. 2. Global-e notifies you when the EAD is ready by sending the [SendAdditionalRequiredDocumentsToMerchant (Global-e to Merchant)](/api-reference/send-additional-required-documents-to-merchant) endpoint and including the document itself (base64 encoded) in the notification. Upon receiving this notification, you can do the fulfilment with this document included in the order shipping documents. ## Reference > [card] [Send Order To Merchant — full request & response](/api-reference/send-order-to-merchant) > > Parameters, schema, examples for `POST` (merchant-hosted) `/order-update-create-url`. > [card] [Send Additional Required Documents To Merchant — full request & response](/api-reference/send-additional-required-documents-to-merchant) > > Parameters, schema, examples for `POST` (merchant-hosted) `/send-additional-required-documents-url`. ## Use Cases ### EAD indication on the order (SendOrderToMerchant) The EAD indication is carried in the `AdditionalRequiredDocuments` array of the order payload (`DocumentTypeCode` `11` = EAD): ```json theme={null} "AdditionalRequiredDocuments": [ { "DocumentTypeCode": "11", "DocumentTypeName": "EAD" } ] ``` ### Send additional required documents (SendAdditionalRequiredDocumentsToMerchant) Global-e posts the ready document(s) to the merchant-hosted endpoint. The document file content is base64 encoded in `DocumentData`; `DocumentTypeCode` `11` denotes an EAD. ```json theme={null} { "OrderId": "Sample order id", "MerchantOrderId": "Sample order id from the merchant's system", "CountryCode": "US", "AdditionalRequiredDocuments": [ { "TrackingNumber": "98789723874839", "DocumentData": "base 64 string", "URL": "URL do download document", "DocumentTypeCode": "11", "DocumentTypeName": "EAD", "DocumentExtension": "pdf", "DocumentReference": "24DE85123822923B8", "CreationDateTime": "2024-01-30T10:55:21" } ] } ``` > [!NOTE] > > Some values are encoded and require the merchant to decode them, for example URLs, addresses, emails, and phone numbers. ## Document type codes `DocumentTypeCode` can be one of the following values: | Document type | Code | | - | - | | CommercialInvoice | 1 | | PackingList | 2 | | ShipperManifest | 3 | | Label | 4 | | VATInvoice | 5 | | DangerousGoodDeclarationLink | 6 | | GELabel | 7 | | CustomerReceiptInvoice | 8 | | ArchibeLabel | 9 | | DeliveryAdvice | 10 | | EAD | 11 | # External Methods Source: https://docs.global-e.com/external-methods ## Localize Price Convert prices from the native currency to the currently selected currency. This method uses the currently selected country and currency rules. **Input `priceDetails` object** ``` { "Price": 19.95, "ProductClassCoefficient": 1.05, "Quantity": 1 } ``` **Example** ``` var priceDetails = { "Price": 19.95, "ProductClassCoefficient": 1.05, "Quantity": 1 }; var callback = function(localizedPrice) { console.log(JSON.stringify(localizedPrice)); }; GEM_Components.ExternalMethodsComponent.LocalizePrice(priceDetails, callback); ``` | Field Name | Type | Optional | Description | | - | - | - | - | | `Price` | number | No | The single price of a product, to be converted. | | `ProductClassCoefficient` | number | Yes | The product class coefficient to be used in this price conversion. Use null if the product does not have a product class. | | `Quantity` | number | No | The quantity of the product to be converted. If no value is provided, a default value of 1 is used. | | `IsRoundingSkipped` | boolean | Yes | If the field is true, the converted price will not be rounded. Do not provide this field if rounding is required. | > [!NOTE] > > Due to rounding rules, the individual product price must be used for the price parameter, not the line item subtotal. **Returned `localizedPrice` object** ``` { "ConvertedPrice": 34.99, "SymboledPrice": "€34.99", "CurrencySymbol": "€" } ``` | Field Name | Type | Description | | - | - | - | | `ConvertedPrice` | number | The converted price’s value. | | `SymboledPrice` | string | The converted price, formatted for the selected currency | | `CurrencySymbol` | string | The currently selected currency symbol. | ## De-localize Converted Price Convert the customer's local currency back to the original currency. This method uses the rules from the current country and currency in the calculation. **Example** ``` var priceDetails = { "Price": 100, "ProductClassCoefficient": 1.05, "Quantity": 1 }; var callback = function(delocalizedPrice) { console.log(JSON.stringify(delocalizedPrice)); }; GEM_Components.ExternalMethodsComponent.DelocalizePrice(priceDetails, callback); ``` > [!NOTE] > > Refer to `LocalizePrice` method to view the structure of the `priceDetails` and `delocalizedPrice` objects. The `delocalizedPrice` object is structured the same as the `localizedPrice` object. ## Format Converted Price Format an already converted price, using the currently selected currency. **Input `convertedPriceDetails` object** ``` { "ConvertedPrice" = 60 } ``` | Field Name | Type | Description | | - | - | - | | `ConvertedPrice` | number | The converted price, to be formatted using the selected currency. | **Returned `formattedPrice` object** ``` { "SymboledPrice": "€60.00", "CurrencySymbol": "€" } ``` | Field Name | Type | Description | | - | - | - | | `SymboledPrice` | string | The converted price, formatted for the selected currency. | | `CurrencySymbol` | string | The currently selected currency symbol. | ## Is Operated by Global-e Check if the currently selected shipping destination country is a Global-e-operated country. **Example** ``` var callback = function(isOperated) { console.log(isOperated); }; GEM_Components.ExternalMethodsComponent.IsOperatedByGlobalE(callback); ``` ## Get Checkout URL Get the checkout URL that you want to direct customers to. `urlParams` is a JSON object with a single `CartToken` string parameter. If you have a headless Shopify site, use the `ShopifyCheckoutId` instead of the `CartToken.` **Example** ``` var urlParams = { CartToken: "customer cart token" }; var callback = function(url) { console.log(url); }; GEM_Components.ExternalMethodsComponent.GetCheckoutUrl(urlParams, callback); ``` ## Update Cart Receive a notification when the cart needs to be updated on the client side, using this latest `cartData` that is passed in. **Example** ``` var cartData = { }; // get cart data. GEM_Components.ExternalMethodsComponent.UpdateCart(cartData); ``` The following events trigger this method: * A product is added to the cart * A product is removed from the cart * The quantity of a product is changed * The cart is shown to the user **cartData** `cartData`is a JSON object that matches a specific schema. **Example** ``` { "productsList": [ { "Name": "Red Shoes", "CartItemId": "abcd-1234-qwe", "OrderedQuantity": 1, "OriginalListPrice": 20, "OriginalSalePrice": 15.95 } ], "discountsList": [ { "Name": "10% off", "OriginalDiscountValue": 1.59, "ProductCartItemId": "abcd-1234-qwe" } ] } ``` **productsList** `productsList` is an array of product objects, detailed below: | Field Name | Type | Description | | - | - | - | | `Name` | string | The name of the discount. | | `OriginalDiscountValue` | number | The value of the discount, in your native currency. This value is converted to the customer’s selected currency | | `ProductCartItemId` | string | The \`\`CartItemId of the product this discount is for. | ## Troubleshooting failed code If you attempted to use a Global-e Module external method and the code failed, this could be because the Global-e Module has not loaded yet. In this situation, you can use an `ExternalEventsComponent` With the `ExternalEventsComponent` you can set a function on the window object and Global-e's code executes that function when a certain event is triggered. We recommend that you listen for the `GlobalE_Loaded event` before executing the code. To do this, set the below function on the window object and the code will be executed when the Global-e Module loads. **Example** ``` window['GlobalE_Loaded'] = function() { //add code here } ``` # Failover and Recovery Source: https://docs.global-e.com/failover-sfcc This page covers two recovery scenarios: **disabling Global-e** when services are unavailable, and **order-create fallback** when SFCC cannot create an order during checkout but Global-e still completes the sale. **See also:** [Checkout flow](/checkout-flow-sfcc) · [Order lifecycle](/order-lifecycle-sfcc) · [Introduction → SOTM](/sfcc) · [Metadata → Order (`geIsOrderCreatedFallbackScenario`)](/metadata-sfcc#order) ## Disable Global-e integration (manual failover) If Global-e services are unavailable, operators can disable the integration by setting site preference **`geEnabled`** (display name **Global-e Enabled**) to **No**. Domestic checkout continues on SFCC. Operated-country shoppers no longer route to Global-e until the preference is re-enabled and Global-e settings are current (run the **GlobaleSettings** job after re-enabling — see [Configuration](/configuration-sfcc)). ## Order-create fallback (SOTM recovery) Checkout normally creates a minimal SFCC order in the shopper session via **`Globale-OrderCreate`** or **`Globale-OrderCreateV2`**. Session loss, stock issues, or basket drift can cause this step to fail after the shopper has already paid on Global-e. ### How recovery works **Step 1** **Order create response** — On failure, the cartridge may return SFCC order number **`-1`** (`ORDER_CREATE_BYPASS_NO`) — this applies to both `Globale-OrderCreate` and `Globale-OrderCreateV2`. Global-e treats this as a signal to continue and send **Send Order To Merchant** (SOTM) with the full order payload. **Step 2** **SOTM creates the order** — **`Globale-OrderSendToMerchant`** searches for an existing order by SFCC or Global-e order number. If none exists, the cartridge builds a temporary basket from the SOTM payload (`generateBasketFromPayload`), creates the SFCC order, then applies the same place/confirm and attribute updates as the happy path. **Step 3** **Fallback flag** — Orders created from an SOTM-generated basket set **`geIsOrderCreatedFallbackScenario`** on the order (and basket during generation). This drives coupon/price-adjustment handling differences in the SOTM handler. Recovery is automatic on the Global-e side once order create returns **`-1`** or when SOTM arrives without a matching SFCC order. Merchants should monitor **GLOBALE_ORDER\_**\* logs for collision or validation errors (for example duplicate `MerchantOrderId` or cart-hash mismatch when **`sfccCartHashValidation`** is enabled). ### What this is not * **Manual `geEnabled` disable** does not replay failed orders; it only stops new Global-e checkout sessions. * SOTM must not receive **`MerchantOrderId` = `-1`** in the payload (that value is reserved for the order-create bypass response only). For endpoint sequencing and status transitions after recovery, see [Order lifecycle](/order-lifecycle-sfcc). # Features Source: https://docs.global-e.com/features The Global-e Wix Application provides your store with the following capabilities: * **Browsing and buying in local currencies:** Shoppers can browse and buy in their local currency; Global-e supports 100+ currencies. * **Local pricing**: Prices are rounded and formatted according to local conventions and adjusted per country and merchant configurations. * **Local and alternative payment methods:** Shoppers can pay with their preferred local payment method; Global-e supports 150+ payment methods. * **Duty and tax calculation:** Shoppers can view and prepay all duties and taxes at checkout to prevent unpleasant surprises upon delivery. * **Multiple shipping options:** Shoppers can choose from a variety of international shipping methods at competitive rates. * **Convenient returns portal**: Transparent and easy returns process; prepaid returns option. * **Localized welcome and checkout:** Complete shopping experience with a localized welcome message and checkout process, available in 30+ languages. * **Shopper's geolocation:** When the shopper accesses the store, the Global-e application detects the shopper's location (IP address) and uses it to predefine the relevant country's `currencysettings`. * **Country switcher**: A shopper can use the Country Switcher to change the order delivery to a different country by clicking the flag at the top of the page and changing the shipping destination. * **Price conversion by Global-e**: Global-e converts the value of the merchant's product prices to the shopper's local currency. This conversion includes current conversion rates, country coefficients, VAT calculation, rounding rules, currency symbols, and more (if applicable). * **International Checkout Page**: The International checkout page is powered by Global-e and opens in an iFrame on the merchant's site. In addition, it provides the ability to pre-pay duties and taxes for the relevant shipping methods. Unsupported features * Fixed prices * Gift cards * My account ## Architecture Schema ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-577b20ac-120b-94c0-8efc-23f3d276ca14.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=237994444139722e17a9c00bf39213c3) # Features and Capabilities Source: https://docs.global-e.com/features-and-capabilities > [!NOTE] > > **Note that some of the following Global‑e functionality may vary depending on your platform.** > > **For details about the following functionality in Shopify, refer to the section dedicated to [Shopify Native](/shopify-native).** With our application installed and your Global-e Merchant account set up, your store will enjoy the following features and capabilities. * **Shopper's geolocation**: When the shopper accesses the store, the Global‑e application detects the shopper's location (IP address) and uses that location to predefine the relevant country/currency settings. See [Supported Currencies](/supported-currencies). * **Browsing and buying in local currencies**: Shoppers can browse and buy in their local currency; Global‑e supports 100+ currencies. Shoppers can use the shipping switcher to change the order delivery to a different destination or currency. * **Localised pricing by Global‑e**: Global‑e converts the value of the merchant's product prices to the shopper's local currency. This conversion includes current conversion rates, country coefficients, VAT calculation according to distance selling regulations (EU), rounding rules, currency symbols, and uplift/downlift coefficients across products and categories. * **Fixed prices / RRP**: Global‑e supports fixed prices on your platform so that you can keep online pricing (webstore) aligned with the local stores, sites, and franchises. * **Local and alternative payment methods**: Shoppers can pay with their preferred local payment method; Global‑e supports 150+ payment methods. See [Payment Methods](/payment-methods). * **Landed cost - duty and tax calculation**: Shoppers can view and prepay all duties and taxes when checking out to prevent unpleasant surprises upon delivery. * **Optimised shipping options**: Shoppers can choose from various international shipping methods at competitive rates, all served via a robust Shipping Engine to serve relevant options for any basket scenario and destination. * **Merchant Of Record**: Move all international markets payment fraud liability, tax regulation and compliance to Global‑e as the MOR/SOR. * **International Checkout**: The International checkout page is powered by Global‑e to serve all the above capabilities, available as a one-page checkout for optimal conversion. * **Localised** **welcome and checkout**: Complete the shopping experience with a localised welcome message and checkout process, available as part of your platform. See [Supported Languages](/languages#supported-languages). # Field Mappings Source: https://docs.global-e.com/field-mappings The API method return a list of order details. In the context of producing shipping documentation, the below fields and associated logic must be considered: | **Exporter details** | Should remain the same as today, i.e. the brand, 3PL, or other relevant party | | - | - | | **Global-e local tax registration** | In specific destinations, such as Norway, the UK, the EU (Cross-border), Switzerland, Australia, New Zealand, Singapore, and Malaysia (the exact list of applicable countries will be confirmed during the project), Global-e is responsible for remitting taxes to local authorities. For orders below the threshold, Global-e’s local tax registration must be included on the commercial invoice and declared to the carrier, as Global-e will handle the direct filing of applicable taxes with the respective local authorities. **Merchant.Order.ExporterDetails.LocalRegistrationClearance** *– A Boolean value indicating whether Global-e will remit the tax locally for the order.* If TRUE, the following fields must be considered: **Merchant.Order.ExporterDetails.DestinationRegistrationNumber _–_** *GE local registration registration number in destination country* **Merchant.Order.ExporterDetails.IOSSNumber _–_** *for shipments to the EU* ️ **Important Note:** Global-e’s IOSS number **must NOT** be displayed on the Commercial Invoices | | **Importer and import type mention** | If (**Merchant.ImporterDetails.ImporterType** = 0)“**Private Import Mention**” for B2C shipment\*\*- Merchant.Order.ImportDetails.CustomerTaxId\*\* - \*Customer Tax number provided at checkout as required for clearance into certain markets (eg. Brazil, Turkey)\*If (**Merchant.ImporterDetails.ImporterType** = 1)Importer details should have the Mention "**Business Importer**" – *only applicable for shipments to Switzerland.*__- Merchant.Order.ImporterDetails.Company__ –*Global-e importer entity name for relevant markets (e.g. Switzerland)*__- Merchant.Order.ImporterDetails.VATRegistrationNumber__ - *Global-e importer entity registration number for relevant markets (e.g. Switzerland)*__- Merchant.Order.ImporterDetails.Address -__ *Global-e Importer entity* | | **Shipper name/address** | Should remain the same as today, e.g. the brand, 3PL, or other relevant party | | **Currency** | **Merchant.Order.InternationalDetails.CurrencyCode** | | **Incoterm** | If **shipping country** **= “Switzerland”** Shipment to be cleared under Global-e’s ZAZ account / "Terms of Delivery" to be decided with carrier️ **Important Note:** Only the taxes applicable to the clearance into Switzerland should be billed against Global-e’s ZAZ account. Any other fee charged by the carrier in relation to the clearance should be billed to the Shipper of Record (brand/3PL)**Merchant.Order.InternationalDetails.DutiesGuaranteed :** trueShipment to be cleared as DDP or equivalent incoterm, to ensure no additional Duties and/or Taxes are requested to be paid at delivery by the customer.If **"Merchant.Order.InternationalDetails.DutiesGuaranteed"** : false and **"Merchant.Order.ExporterDetails.LocalRegistrationClearance”** : falseShipment to be cleared as DAP or equivalent incoterm, with applicable Duties and/or Taxes paid at delivery by the customer.If **"Merchant.Order.InternationalDetails.DutiesGuaranteed"** : false and **"Merchant.Order.ExporterDetails.LocalRegistrationClearance”** : trueGlobal-e’s local tax registration to be provided to the carrier and presented on the clearance documents, considering that taxes will be filled by Global-e in the destination country (as mentioned in section “Global-e local tax registration number”)Shipment booking to be done following carrier requirements (process to be aligned by the brand with carrier) | | **Products** | **\ Merchant.Order.Products** | | ·         COO | n/a – to be taken from own systems | | ·         HS Code | n/a – to be taken from own systems | | **Price exclusive of D\&T** | **Merchant.Order.Products\[i].InternationalDiscountedPriceForCustoms** | | **Shipping Cost** | **Merchant.Order.InternationalDetails.DiscountedShippingPrice** | | **Destination Tax calculation rule** | **Merchant.Order.TaxCalculationRule -** determines how duties and taxes are calculated for an order. Possible values:**CIF** (Cost, Insurance, and Freight): This method calculates duties and taxes based on the total cost of goods, including insurance and freight charges.**FOB** (Free on Board): This method calculates duties and taxes based only on the value of the goodsTax calculation rules defined per country in Global-e system. Clearance documents to be aligned accordingly. | | **Total shipment declarative value for customs** | **Merchant.Order.TotalValueForCustoms** | # Financial Process - Australia Country Source: https://docs.global-e.com/financial-process---australia-hub-country ## A Financial Overview - Australia > [card] > > ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a8bcf1fe-4ec4-67d8-b733-4d10bef92c4c.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=70f5618aab26b25bea7d56b3f452d0a1) > [card] When an international customer visits your site, Global‑e converts the price of your product to the customer's currency. At checkout, the customer is presented with the financial details of the transaction: * The price of the product minus discounts * Shipping fees * Duties and taxes After verifying the validity of the transaction, Global‑e collects the payment and the order is packed and shipped. * If you are shipping the products directly from your hub then the final title transfer takes place in the origin country, making this a domestic B2B sale. * If you are shipping from a Global-e hub, the final title transfer occurs when the goods arrive at the domestic Global-e hub. Global‑e then converts the amount of the sale back to your currency and refunds you the amount of the sale, deducting relevant fees and subsidies. For more information, see [The Reconciliation Process (Finance)](/financial-processes#the-reconciliation-process--finance-) # Financial Process - United Kingdom Country Source: https://docs.global-e.com/financial-process---united-kingdom-hub-country ## A Financial Overview - United Kingdom > [card] > > ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-08bc1cfa-8756-766a-a038-abed6d9ecf85.svg?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=fbe807f8a51dcf2a1dae683c91702771) > [card] When an international customer visits your site, Global-e converts the price of your product to the customer's currency. At checkout, the customer is presented with the financial details of the transaction: * The price of the product minus discounts * Shipping fees * Duties and taxes After verifying the validity of the transaction, Global‑e collects the payment and the order is packed and shipped. * If you are shipping the products directly from your hub then the final title transfer takes place in the origin country, making this a domestic B2B sale. * If you are shipping from a Global-e hub, the final title transfer occurs when the goods arrive at the domestic Global-e hub. Global‑e then converts the amount of the sale back to your currency and refunds you the amount of the sale, deducting relevant fees and subsidies. For more information, see [The Reconciliation Process (Finance)](/financial-processes#the-reconciliation-process--finance-). # Financial Process - EU Country Source: https://docs.global-e.com/financial-process--europe-hub-country ## A Financial Overview - Europe ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-64432d3e-56f3-e1b6-186c-ed03368d2e3c.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=61e43270bc1bd6c82a9be65ba36af7af) When an international customer visits your site, Global‑e converts the price of your product to the customer's currency. At checkout, the customer is presented with the financial details of the transaction: * The price of the product minus discounts * Shipping fees * Duties and taxes After verifying the validity of the transaction, Global‑e collects the payment and the order is packed and shipped. * If you are shipping the products directly from your hub then the final title transfer takes place in the origin country, making this a domestic B2B sale. * If you are shipping from a Global-e hub, the final title transfer occurs when the goods arrive at the domestic Global-e hub. Global‑e then converts the amount of the sale back to your currency and refunds you the amount of the sale, deducting relevant fees and subsidies. For more information, see [The Reconciliation Process.](/financial-processes#the-reconciliation-process--finance-) # Financial Process - United States Country Source: https://docs.global-e.com/financial-process--united-states-hub-country ## A Financial Overview - United States ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-794a04b2-7d1f-d352-6de3-75e9b2604085.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=27fead0cde9b3dde230c65a39d51007a) When an international customer visits your site, Global‑e converts the price of your product to the customer's currency. At checkout, the customer is presented with the financial details of the transaction: * The price of the product minus discounts * Shipping fees * Duties and taxes After verifying the validity of the transaction, Global‑e collects the payment and the order is packed and shipped. * If you are shipping the products directly from your hub then the final title transfer takes place in the origin country, making this a domestic B2B sale. * If you are shipping from a Global-e hub, the final title transfer occurs when the goods arrive at the domestic Global-e hub. Global‑e then converts the amount of the sale back to your currency and refunds you the amount of the sale, deducting relevant fees and subsidies. For more information, see [The Reconciliation Process.](/financial-processes#the-reconciliation-process--finance-) # Financial Processes Source: https://docs.global-e.com/financial-processes ## Overview This section describes the reconciliation reports generated by Global-e on the reconciliation process. there are differences in the reports depending on the region, as described below. General descriptions of the reconciliation report are detailed in the [Reconciliation Report](/reconciliation-report-overview). This section describes the following examples: * [Financial Process - United Kingdom Country](/financial-process---united-kingdom-hub-country) * [Financial Process - United States Country](/financial-process--united-states-hub-country) * [Financial Process - Australia Country](/financial-process---australia-hub-country) * [Financial Process - EU Country](/financial-process--europe-hub-country) ## The Reconciliation Process (Finance) The following fields appear in the report: * **D\&T Paid by Customer:** Total D\&Ts paid by the customer as reflected in column Q of the reconciliation report. * **Total Order Value:** The total order value used as the base to calculate the service fee. * **Base for Service Fee:** The total order value used as the base to calculate the service fee. * **Service Fee Percentage:** The percentage from the contract used to calculate the service fee; referred to as the platform fee in the contract. * **Service Fee:** The service fee based on the percentage listed in the field above, based on the total order value paid by the customer, also listed in the fields above. * **Base for Reconciliation Fee:** The fee calculation based on the Total Order Value paid by the customer. * **Reconciliation Fee Percentage:** Percentage from the contract used to calculate the payment processing fee. * **Reconciliation Fee:** Percentage per contract of the base for Reconciliation Fee noted above. The reconciliation process entails the following steps: * Global-e generates a Reconciliation Report which provides comprehensive detail of all your sales. See [Reconciliation Report](/reconciliation-report-overview). * Global-e generates the following invoices: * A self-billing invoice for sales less refunds. * An invoice for Global-e’s services, fees, and any shipping subsidies. See invoice examples: [United Kingdom](/invoicing--uk-), [United States](/invoicing--us-), [Australia](/invoicing--au-), [Europe](/invoicing). * Payment: Global-e processes the payment for the net total of the self-billing invoice and the corresponding fees invoice, according to the standard payment terms. See [Billing Period and Payment Terms](/billing-period-and-payment-terms--au-) > [!NOTE] > > The Sales Total serves as the basis for the service fee calculation each week. > > Orders are included for reconciliation according to ‘Received In Hub’ date and refunds by their creation date. # Flash Sale Mode Source: https://docs.global-e.com/flash-sales > [!NOTE] > > Flash Sale Mode is not necessary for Shopify Native merchants, and should not be enabled. ## Flash Sale Mode – Overview & Order Flow Flash Sale Mode is designed for your most high-traffic events (such as product “drops” or limited-time sales) to maximize checkout stability, prevent overselling, and protect the customer experience. Once activated, all orders will process with real-time stock validation (requires merchant development — see below, “Technical Requirement”), and fast payment methods (i.e., credit cards only) to handle high traffic. It can be switched ON or OFF in the Global-e Admin by merchant users with the Merchant CS Admin role, or by special per-product activation. It can also be switched on by the Global-e NOC team if you alert us about your sale ahead of time. Please note: If your sale may result in over 300 orders/minute, please reach out to the Global-e Client Success team for additional support. ## Enabling Flash Sale Mode ### Enable for All Orders (Global Activation) * Turns Flash Sale Mode ON for all checkouts in the Global-e Admin portal under **Merchants → Flash Sales → Start Now** (for users with the CS Admin role). * Use this for site-wide flash sales, such as Black Friday or other major promotional events. * Activation is immediate for any newly opened checkouts. Once it is enabled, click the **Stop** button to deactivate it. ### Schedule a Flash Sale (Scheduled Activation in Portal) * Set up and schedule your flash sale ahead of time via the Global-e Admin Portal under **Merchants → Flash Sales → Add New Schedule** (for users with the CS Admin role). * You can define the exact start and end time for your sale — ideal for events that need to go live at a specific moment (e.g., a new collection drop). * All orders received during the active window will follow the Flash Sale checkout flow. ### Enable for Specific Items (Per-Item/Product Activation) * Flash Sale Mode is triggered only when certain products are in the shopper’s cart — this gives you precise control and flexibility. * This method is perfect for limited-time product drops or sales targeting only select items. * Add a special “IsFlashSale” attribute to each flash sale item in your cart payload, as shown below (platform specific). * If any product in the cart contains this attribute, Flash Sale Mode will activate automatically for that checkout session, even if the overall store setting is OFF. **Full Bespoke Global-e Module Integration** ```json theme={null} { "productsList": [ { "CartItemId": "1234", "ProductCode": "5678", "Name": "Example Product", "MetaData": { "Attributes": [ { "AttributeKey": "IsFlashSale", "AttributeValue": "true" } ] }, ... } ] } ``` ## Oversell Protection During a flash sale, every order submission triggers a real-time request to your SendOrderToMerchant endpoint to verify stock before payment is finalized or confirmation is shown. If all items are in stock: your backend returns a standard success response and the order is completed. If any item is out of stock: your backend must respond with error code 1100 (which is the default code). This tells Global-e that the order cannot be fulfilled, blocks the order, notifies the customer that an item is unavailable, and redirects them back to the cart page. ### Technical Requirement: Out-of-Stock SOTM Response Your backend must immediately process every order request and, if any item is out of stock, respond exactly as specified below. Example SendOrderToMerchant out-of-stock response: ```json theme={null} { "StatusCode": -1, "ErrorCode": 1100, "Success": false, "Message": "Insufficient inventory for one or more items in order", "ErrorText": "Insufficient inventory for one or more items in order" } ``` * Returning ErrorCode: 1100 is required for proper flash sale out-of-stock handling. * The error code can be changed via Global-e configuration, but 1100 is the default. * Can also be triggered via pattern matching on the Message; requires Global-e configuration. * For successful orders (stock is available), respond with your usual success response. ## Payment Method Restrictions To ensure maximum speed and system stability, only the fastest and most reliable payment methods (typically cards) are enabled for the duration of a flash sale. If you have special requirements for accepted payment types during events, please discuss them with the Global-e Client Success team in advance. ## Access and Support For assistance with integration or event setup, please contact your CSM or Global-e Support. # Shipping Pricing Strategy Source: https://docs.global-e.com/flat-shipping-rates-shipping ## Flat Shipping Rates ### Best Practices in Selected Countries Based on our experience, high shipping fees are the main barrier to successful conversions. We recommend that merchants implement low shipping fees, and, if necessary add 5-10% to the product price to compensate for higher shipping prices. You can add the extra margin using our Country Coefficient tool. It is always advisable to have two viable shipping options, one which is faster and more expensive and one which is slower and cheaper. Global‑e also recommends that merchants set free shipping thresholds slightly higher than the current AOV to increase basket value. We do not advise using mail for goods over £200/\$250. The following table shows the best practices according to a customer’s region. Note that this is a general recommendation that does not consider additional factors such as your vertical or AOV. These are considered during the onboarding process and are reflected in the initial proposition we configure for you. For more information, see [Setting Up Flat Shipping rates](/marketing-propositions--main-screen-). | Area | Standard | Express | | - | - | - | | Central Europe | \< EUR 5 | \< EUR 10 | | Other European countries | \< EUR 7 | \< EUR 12 | | USA | USD 5 | USD 10 | | Australia | AUD 10 | AUD 20 | | NZ | NZD 10 | NZD 20 | | Canada | CAD 7 | CAD 12 | | Asia | GBP 8\* | GBP 12\* | | Middle East | GBP 5\* | GBP 12\* | | ROW | GBP 10\* | GBP 12\* | (\*) Local currency equivalent > [!NOTE] > > We have found that offering a similar shipping rate throughout Europe is beneficial while main markets such as Ireland, Germany, and France may be slightly cheaper. > > In China, this may be slightly lower as they have price-sensitive shoppers. Communicating the checkout proposition throughout the customer journey increases customer trust; letting customers know that all taxes and duties can be paid before delivery and clearly outlining the shipping costs enables customers to avoid unwelcome surprises. # Fraud Check Challenge Source: https://docs.global-e.com/fraud-check-challenge Use the following information to simulate a fraud check challenge: * **Local Sandboxes**: Last Name = Decline * **Production**: Last Name = Global-e test # Fraud Detection Source: https://docs.global-e.com/fraud-detection The Global-e fraud solution combines a machine-learning fraud engine with an in-house fraud team that operates 7 days a week. This double-layered fraud prevention process minimizes false positives and ensures only orders with strong fraud indications are canceled. The Global-e fraud engine is customized to the Merchant’s profile, markets, countries, and products. **In this section:** * [The Fraud Prevention Process](/the-fraud-prevention-process) * [Manual Review](/manual-review) * [Chargebacks](/chargebacks) * [Fraud Check Challenge](/fraud-check-challenge) * [Q\&A Fraud](/q-a-fraud) # API to Retrieve Free Shipping Banner Data Source: https://docs.global-e.com/free-shipping-banner-data-api ## Overview Retrieve the free shipping banner configuration and localized message for a specific country, culture, and currency combination. The data is available through two endpoints that return an identical response and differ only in how the merchant is identified: * **Authenticated** – merchant resolved from the authentication context (merchant GUID). * **Anonymous** – merchant supplied as `merchantId` in the URL path, no authentication required. Intended for integrations that cannot hold a merchant GUID securely (for example Shopify themes and other storefront integrations). ## Prerequisites Merchant must have the free shipping banner configuration feature enabled. ## Security Requirements **Authenticated endpoint** * Authenticated request required. * Merchant GUID is resolved from the authentication context. **Anonymous endpoint** * No authentication required – do not send a merchant GUID. * The merchant is identified by the numeric `merchantId` in the URL path. * The endpoint returns only the banner text and threshold already displayed publicly on the storefront; no confidential data is exposed. > [!NOTE] > > The `merchantId` is part of the **path**, not a query-string parameter. Adding `&merchantId=` to the authenticated URL will not work – that request is still authenticated and returns `401`. ## Reference > [card] [Get free shipping banner data — reference & playground](/api-reference/get-free-shipping-banner-data) > > Request (`countryCode`, `cultureCode`, `currencyCode`), the banner data response, error shapes, and examples for the authenticated `GET /banners/data/free-shipping`. > [card] [Get free shipping banner data (anonymous) — reference & playground](/api-reference/get-free-shipping-banner-data-anonymous) > > Request (`merchantId` in the path, `countryCode`, `cultureCode`, `currencyCode`), the same banner data response, error shapes, and examples for `GET /banners/data/{merchantId}/free-shipping`. ## Use Cases ### 1. Retrieve the banner data (authenticated) ``` {API_BASE_URL}/banners/data/free-shipping?countryCode=GB¤cyCode=GBP&cultureCode=en-GB ``` ### 2. Retrieve the banner data (anonymous) ``` {API_BASE_URL}/banners/data/1803/free-shipping?countryCode=GB¤cyCode=GBP&cultureCode=en-GB ``` Both calls return the same response: ```json Response theme={null} { "IsEnabled": true, "CurrencyCode": "GBP", "CultureCode": "en-GB", "CountryCode": "GB", "Text": "Enjoy our great international shipping rates", "FreeShippingThreshold": -1.0 } ``` # General Functionality Source: https://docs.global-e.com/general-functionality The following screen is displayed when you access Analytics: ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-408fbb23-ea9b-7723-f188-46ef8f3ab727.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=5a71e4f22b60173e33ba6a2b03dae757) From here you can see the following functionality common to all sheets. The following lists describe the following top menu options and Chart options, which you access by right-clicking in one of the metric visualizations: > [card] > > * Top menu: > > * [Sheets](/general-functionality#sheets) > * [Bookmarks](/general-functionality#bookmarks) > * [Selection panel](/general-functionality#selection-panel) > [card] > > * Chart options: > > * [Subscriptions](/general-functionality#subscriptions) > * [Alerts](/general-functionality#alerts) > * [Downloads](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Download/downloading-visualization.htm) The following image shows the location of the top menu and Chart options: ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fd996393-9dca-c674-f7f8-a594b453cb2f.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=81fe7632769acf23f0738253077396b5) For more information about Chart options, see [Tutorial - Beginning with the Basics](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Tutorials/introduction-beginning-with-basics.htm). ## Sheets The **Sheets** option shows all public sheets. A *sheet* is a collection of data about a specific topic. Common features include the following: * **Grid/list view** - Toggle between the grid or condensed list views. * **Pin/unpin assets** - Pin the Assets panel to the screen or unpin to adjust its width. * **Full screen/Exit full screen** - Expands the Assets panel to its maximum width to easily view its Published and Added timestamp. You can search all existing sheets using the Search field directly below these functions. In addition, the ellipsis (three vertical dots) on the right edge of each sheet lets you view more basic details about the sheet and download it as a PDF. For more information on Qlik's official documentation on sheets, see [Sheet View](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Sheets/sheet-view.htm). ## Bookmarks **Bookmarks** lets you save specific selections. ### To make a bookmark 1. In a sheet, make a set of selections that you want to save as a bookmark. 2. Click Bookmarks.The Bookmarks panel is displayed. 3. Select My own. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-696a3237-7e17-94ca-7cf8-a8c0227a9300.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=e03eb53ae609545c361a272d23e81a7c) 4. Click Create new bookmark. 5. Add a title to the bookmark in the Title field and optional description. 6. Save/clear the current sheet location: * **Save sheet location** - Lets you switch to the saved sheet's location when you apply it. * **Save layout** - Save the sheet settings including its layout, such as the sorting and presentation of charts. * **Save all variable states** - Save variable states. For a short tutorial video on using bookmarks, see [Bookmarking selections](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Bookmarks/keep-track-of-important-data.htm). In addition, the ellipsis (three vertical dots) on the right edge of each bookmark lets you do the following: * **Apply bookmark** - Apply both the location and selections of the saved bookmark. * **Apply selections only** - Apply the selections of the saved bookmark, but not its location. * **Details** - Shows details about the bookmark, such as its description. ## Selection Panel The Selection Panel has two main functional areas: * The **gray navigation squares on the left** - used for searching, historical navigation, and clearing selections. * The **green tiles on the right** - used for showing the dimensions that have selections, and for making certain selections. The following figure shows the **Selection Panel**: ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9f29464d-cd8b-1343-6a56-d93be83fc708.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=5a22b291d88dcfda4969a8136412289d) The following list describes the navigation buttons: * **Smart search** - Displays a search field directly below the buttons for searching your data. * **Step back** - Undoes the most current configuration operation, such as adding the Date configuration. * **Step forward** - Reapplies the most current configuration operation, such as removing the Date configuration. * **Clear all selections** - Clears all selections and reverts to the default setting. The following list describes the default selections: * **AOV interval** - Adjusts the AOV (Average Order Value) interval shown in the % Orders by AOV Class graph (default value: 50). * **Currency symbol and conversion** - Converts between the merchant's currency and USD (default value: USD). * **Date** - Shows the business metrics values based on the selected dates (default value: current year). For more information on Qlik's official documentation about the Selections Panel, see [Exploring with Selections](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Selections/SelectionsToolbar/work-with-selections.htm). ## Filters From the **Filter** you can filter information shown in other areas of Analytics, such as **Destination Country** and **Currency**. The following image shows the filters: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8d089494-107d-f5f8-d45b-4539f02d7746.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=b32e290e68ccbe899c2aa2ed5c1f99a7) The filter includes the following: * **Date range** - Lets you select the date range of the shown data with built-in selections for the previous day, last seven days, last 30 days, current year, and last 12 months. The default date range selection is year-to-date. * **Destination Country** - Lets you select a country or countries. Clicking the ellipsis located directly above the list of countries reveals the following sub-options: * Select all - Selects the entire list of countries. * Select possible - Selects all possible countries. Disabled countries (shown as grey) indicate countries with no data, such as a selected date range outside of which the selected countries generated no sales. * Select alternative - Selects the inverse of the countries that you've manually selected. * Select excluded - Selects all excluded countries. This should be used to exclude dates related to anomalous data, such as outlying spikes in sales for a singular date. * Clear selection - Clears all of your selections. * Cancel selection - Closes the selection menu. * Confirm selection - Confirms and applies your selection, which is reflected in the relevant values in the Business Metrics panel. * **Currency** - Lets you select a currency (available for non-USD merchants only). Selecting a different currency affects all business metrics with monetary value. ## Alerts From the **Alerts** section you can do the following: * [Create alerts](/general-functionality#creating-alerts) * [Manage alerts](/general-functionality#managing-alerts) * [Edit alerts](/general-functionality#editing-alerts) ### Creating Alerts #### To create an alert 1. Right-click while in a metric visualization area, such as Net Sales by Destination Country. 2. From the menu, click Alerts. 3. Click Create new alert. The Create alert window is displayed. 4. Fill out the Title and Description of the alert in the Details section. 5. Add the following to the alert in the Add data to the alert section: * **A measure or measures** - defines the measure or measures that the alert applies to * **Dimension** - splits up the measure per dimension for a more specific result * **Selections** - sets which selections to use in the data alert 6. Preview the data that you've selected to monitor in the Data preview section and modify if needed. 7. Click Next. 8. Add the required conditions in the Condition 1 section: * Measure or dimension * Operator * Compare with * Value 9. *Optional* - Add an additional condition by clicking Add additional condition. 10. Do the following in the Schedule section: 1. Define the alert refresh frequency in the Evaluate the alert region. 2. Define the amount of times per day to receive an alert notification in the Times per day region. 3. Set your timezone in the Timezone region. 4. Set the time of day in your timezone in the Time of day region. 5. Set the alert duration schedule in the Run this schedule region. 11. Set the snooze notification frequency in the Snooze notifications section. 12. *Optional* - Set the recipients to share the alert notifications with in the Share with other users section. You will receive an alert even if you do not define a recipient or recipients. 13. Click Create. For more information, see [Monitoring data with alerts](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Alerting/monitoring-changes-with-alerts.htm). ### Managing Alerts Once you've created an alert or alerts, you can manage them. Managing alerts lets you view and edit alert details. #### To manage alerts 1. Follow steps 1 and 2 in **Creating Alerts** above. 2. Click Manage alerts in the lower left corner of the Create alert window. 3. *Optional* - Filter the alerts from the menu in the top left corner. Alert owners can add or remove recipients. Non-owners can remove alerts. 4. *Optional* - Sort the alerts from the menu in the top right corner. 5. Review your alert settings by clicking the ellipsis at the right end of the row, For more information, see [Monitoring data with alerts](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Alerting/monitoring-changes-with-alerts.htm). ### Unsubscribing from an Alert If needed, you can unsubscribe users from or delete alerts. Only alert owners can delete alerts, while others can only unsubscribe from them. Alert owners have the following additional options: ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cc8ad470-e0f8-5c93-bcc6-4d92406ad7a4.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=304f16f7fd808344ea97f108b2b4bdc1) #### To unsubscribe from or delete an alert 1. Follow steps 1 through 3 in **Creating Alerts** above. 2. Click Manage alerts in the lower left corner of the Create alert window. 3. Click the ellipsis at the right end of the row corresponding to a subscription and click Unsubscribe or Delete. For more information, see [Monitoring data with alerts](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Alerting/monitoring-changes-with-alerts.htm). ### Editing Alerts Once you've created an alert or alerts, you can edit them. #### To edit alerts 1. Right-click while in a metric visualization area, such as Net Sales by Destination Country. 2. From the menu, click Alerts. 3. Click the created alert title. 4. Edit your alert settings in the Edit alert window. 5. Click Next until you reach the final window and click Save. For help about alerts, in the Create alert or Edit alert window click the ellipsis and then Help. ## Subscriptions From the **Subscriptions** section you can do the following: * [Create subscriptions](/general-functionality#creating-subscriptions) * [Manage subscriptions](/general-functionality#managing-subscriptions) * [Unsubscribe from or deleting a subscription](/general-functionality#unsubscribing-from-or-deleting-a-subscription) * [Edit subscriptions](/general-functionality#editing-subscriptions) ### Creating Subscriptions #### To create a subscription 1. Right-click while in a metric visualization area, such as Net Sales by Destination Country. 2. From the menu, click Subscriptions.The Subscribe window is displayed. 3. Set the following in the Subscribe section: * **Title** - type a title * **Description** - type a description * **Format** - select a format * **Data** - toggle the data switch on or off 4. Set the frequency for sending emails in the Send email section. 5. Set the time of day to send emails. 6. *Optional* - Set the recipients to subscribe in the Share with others section. 7. Click Preview to download a preview of your subscription in PDF format. 8. Click Subscribe. ### Managing Subscriptions Once you've created a subscription or subscriptions, you can manage them. Managing subscriptions lets you easily review your alert settings, such as **details** and **data conditions**. #### To manage subscriptions 1. Follow steps 1 and 2 in **Creating Subscriptions** above. 2. Click Manage subscriptions in the lower left corner of the Create subscriptions window. 3. *Optional* - Filter the subscriptions from the menu in the top left corner. 4. *Optional* - Sort the subscriptions from the menu in the top right corner. 5. Review your subscription settings by clicking the ellipsis at the right end of the row: * View in app * Details * Unsubscribe ### Unsubscribing from or Deleting a Subscription If needed, you can unsubscribe users from or delete subscriptions. Only subscription owners can delete subscriptions, while others can only unsubscribe from them. Subscription owners have the following additional options: ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9589d71c-db44-3cc1-a098-6536b4d4d497.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=f208414c91fa3d4e1726b18371c4cf40) #### To unsubscribe from or delete a subscription 1. Follow steps 1 through 2 in **Creating Subscriptions** above. 2. Click Manage subscriptions in the lower left corner of the Subscribe window. 3. Click the ellipsis at the right end of the row corresponding to a subscription and click Unsubscribe or Delete. ### Editing Subscriptions Once you've created a subscription or subscriptions, you can edit them. You can only edit subscriptions that you've created. #### To edit subscriptions 1. Right-click while in a metric visualization area, such as Net Sales by Destination Country. 2. From the menu, click Subscriptions.The Subscribe window is displayed. 3. Click Manage subscriptions in the lower left corner of the Create subscriptions window. 4. Click the ellipsis at the right end of the row corresponding to your subscription and click Edit. 5. Edit your subscription settings in the Edit subscription window. 6. Click Save. # General Product Safety Regulation (GPSR) Source: https://docs.global-e.com/general-product-safety-regulation--gpsr- ### General Product Safety Regulation (GPSR) #### GPSR at a glance * The General Product Safety Regulation (EU) 2023/988 (GPSR) is the latest piece of legislation from the EU. The GPSR aims to ensure that consumer products are safe. This Regulation, which replaces Directive 2001/95/EC, emphasizes product safety, including for online sales, and introduces detailed requirements for safety with an emphasis on manufacturer traceability, documentation, and incident reporting. * The primary objective of the GPSR is to modernize EU legislation to address safety concerns, especially for mass-produced items, often from sources that are hard to trace. Our analysis including conversation with legal and industry experts have indicated that the GPSR has specific interest in marketplaces who often evade responsibility for products ‘placed on the market’. * There is unfortunately a secondary effect on ‘legitimate’ brands selling safe products, however we believe that this regulation doesn’t add new or heavy burdens. * We anticipate that enforcement will focus on un-safe, less sophisticated outfits (such as marketplaces), and less regulated countries of origin. The focus of regulators will be ensuring that products can be traced back to a responsible party in the event of safety issues, and this is likely to primarily impact comparatively high-risk goods. * As long as your brand’s products are safe (based on their nature and the standards the brand already follows when selling domestically or for other regulated markets), and maintains clear documentation, the products and the brand are unlikely to be affected by the more stringent parts of this regulation. For safe, well-managed brands, there’s little to worry about! ## The main consideration – selling safe products > [accordion] Show details > > * GPSR defines ‘safe product’ as any product which, under normal or reasonably foreseeable conditions of use, including the actual duration of use, does not present any risk or only the minimum risks compatible with the product’s use, considered acceptable and consistent with a high level of protection of the health and safety of consumers. > * The requirement, practically speaking, is to conduct an internal risk analysis and compile the necessary technical documentation to be able to demonstrate that safety. There is a high probability that brands already selling in domestic regulated markets (US, Japan, Canada etc.) have such documentation anyhow to follow local requirements (in case of the UK, the standards are generally the same). The EU (and UK) safety laws rely on the presumption that products are declared to be safe. > * Technical documentation is a comprehensive term that includes various documents, which can differ depending on the product. Generally, the higher the risk associated with the product, the more extensive the documentation required. This may include a risk assessment, a declaration of conformity, test reports, instructions for use, and more. > * However, for lower-risk products, such as a plain t-shirt, the technical documentation may simply consist of a product description and high-level risk analysis, and there is typically no need for external assessments or conformity declarations in such a case. ## Are your EU compliance needs already covered? > [accordion] Show details > > * If your product is already being made available in the EU, then you might already have an "Economic Operator" (EO) established in the EU (for example, marketplaces, or even yourself directly by way of your own manufacturing, stores or other EU sales channels such as distributor/re-sellers). This entity will take on several tasks in relation to those products, including the responsibility for their safety. Think of the EO as your brand’s local representative in the EU. They’re responsible for handling all the roles of the EO, including verifying necessary documentation has been drawn up and communicating (as needed) with European authorities to ensure your products meet safety standards. > * In this case, you probably don’t need another EO like Global-e to handle compliance for the products sold through Global-e. ## So what if the brand sells safe products but only makes such products available on the market through online e-commerce (via Global-e)? > [accordion] Show details > > * Global-e can take on the role of responsible person in the EU through appointment as an Authorized Representative (AR) for e-commerce activities through Global-e. > * The AR serves as the point of contact for EU market surveillance authorities, helps maintain compliance documentation, and assist your brand in case of regulatory issues. > * It is important to stress that when acting as the brand’s AR, we will rely on your statements in regards to the safety of the products, and will expect full cooperation in that regard, mainly if there is a safety incident or regulatory review. > * Global-e will not charge for acting as the AR as long as the sale to the EU are carried through Global-e. ## What are Global-e's responsibilities as your AR? > [accordion] Show details > > * As your AR, Global-e will: > > * **Communicate with Authorities**: Act as the primary contact for EU market surveillance authorities and ensure prompt communication if safety issues arise. > * **Manage Compliance Reporting**: Use the EU Safety Business Gateway to report safety incidents and will assist with handling recalls as needed. > * **Provide Incident Support**: Coordinate with you in the event of a product issue, from notifying relevant authorities to helping manage corrective actions, ensuring timely responses to maintain market compliance. ## What documentation do you need to provide to Global-e as your AR? > [accordion] Show details > > * First, we will need a written mandate from you, setting out the responsibilities Global-e will take on. Formally, our Irish Global-e entity will be the nominated AR. > * Then, we will need you to confirm that the following documents are readily available and can be furnished promptly when we ask for them (at the request of the authorities): > > * **Inhouse-prepared safety confirmation**: A statement prepared internally that a safety assessment has been conducted and it was internally decided that your products are safe. No need to provide further documentation, unless requested at time of need. Of course, if your products underwent formal or external risk assessments and safety checks, your confirmation may rely on that. > * **Incident Records**: If any of your products were subject to any previous incident records (or you experience such incidents after our appointment), we’ll need to have them available as well. ## How is Global-e’s role as AR reflected? > [accordion] Show details > > The GPSR requires that the contact information of the AR be presented and available to consumers and regulators. We've added our Irish entity information and dedicated contact details (such as controlled special mailbox and a landing webpage) to certain transaction emails, commercial invoice, the terms of sale and in some cases the checkout page. ## What if the brand's products may not be considered as low-risk under GPSR? > [accordion] Show details > > Global-e is still happy to act as your AR! Generally, the higher the risk associated with the product, the more extensive the documentation required. This may include a risk assessment, a declaration of conformity \[required only when specific product safety directives mandate it (e.g., Toy or Cosmetics Directives)], test reports, instructions for use, and more. **Contact us for more information**. ## So what happens now that GPSR is into effect? > [accordion] Show details > > * It is important to understand that import clearance process (for e-commerce) does not change by virtue of the GPSR. > * Taking into consideration the nature and purpose of the legislation and the inherent safety and low risk of the brand’s products – the market anticipates gradual uptake, with some focus on the targeted audience of the GPSR (marketplaces or massproduct importers). > > **For any questions or more information regarding the above, please contact your CSM.** # Geo-Detection and Redirection Source: https://docs.global-e.com/geo-detection-and-redirection How a shopper's country is detected, and whether they are redirected to it, depends on which kind of storefront you run. ## Liquid Storefronts If the “Domain/Subfolder redirection” feature is enabled in the Global‑e Cross-border app, and subfolders or international-specific subdomains or top-level domains (TLDs) are configured for your store, Shopify automatically redirects the customer to their geo-detected country. > [!NOTE] > > Due to regulations, for stores located within the EU only, Shopify never auto-redirects any shoppers that are detected as being from an EU country, and shoppers remain on the merchant country experience. ### Customer Experience - Localized Journey The customer country is automatically detected using Shopify's geolocation detection. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5a13e87c-d838-7aef-842a-10b667d8e5c0.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=c648f9ef1312d64fecda306cc5d35db0) ## Headless Storefronts You must implement geo-detection and redirection features using a custom or 3rd party solution that works with your headless storefront. # Getting Started Source: https://docs.global-e.com/getting-started The **Getting Started** page describes helpful or useful information for starting to use the Global-e platform: * [Global-e roles and features](/global-e-roles-and-features) * [Logging into the Global-e Merchant Portal](/logging-in-to-the-global-e-merchant-portal) # Gift Card Operations Source: https://docs.global-e.com/gift-cards-281937 Customers with a gift card can use the card to pay for their purchases just as they would use other payment methods. ## Overview Customers with a gift card can use the card to pay for their purchases just as they would use other payment methods. During Checkout, customers have the option to provide their gift card details and have their payment deducted from the total on the card. To offer your customers the option to purchase and pay with gift cards, ask your Project Manager to add Gift Cards to your store. ## Gift Card Validation Flow ![Gift card validation flow](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/giftcards/gift-card-validation-flow.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=e57042b79b100a095ec0c805f9f61776) ## Purchasing Gift Cards Gift cards can be purchased from the Global-e Checkout as either a virtual or physical good. Important information about gift cards: * The gift card purchase price is displayed in the customer's currency. * The gift card price is set according to the daily currency rate unless the price is fixed. * The value of the gift card remains the same and is not affected by currency rate changes. * The gift card is included when calculating flat rates but not included when calculating D\&T. * When purchased as a physical product, the gift card should exist in the Merchant manifest. * When purchased as a virtual product, the gift card is not included when calculating shipping taxes (CIF). ## Paying with a Gift Card Customers can redeem gift cards on the checkout page, whether purchased from Global-e or external vendors. Gift cards can be used to purchase goods as well as to pay for shipping, duties, and taxes. They can also be used for purchases in a different currency than the one used to purchase the card. For a Global-e gift card, the exchange rate from the purchase date is used. For a non-Global-e gift card, the daily exchange rate is applied. To use a gift card in Checkout: 1. In Billing Summary click **Gift Card**. 2. Fill in the required fields. 3. Click **save**. The cart total is deducted from the card balance and the amount redeemed is displayed in the sub totals. If the total in the cart is lower than the card's balance then the cart's value is deducted from the card and the balance can be used for future purchases. If the total in the cart is higher than the card balance then the customer must use a second payment method to pay the rest of the cart balance. You can view gift card purchases in Orders under **General Payment > Payment Details**. ![Paying with a gift card](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/giftcards/paying-with-gift-card.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=72d2e5a3d8fa2fc0bbfceb106a84cc77) ![Gift card purchase in Payment Details](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/giftcards/gift-card-purchase-in-payment-details.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=de815cc97f257edf72e1cce6901dfe25) ## Returning a Gift Card A physical gift card can be returned, but a virtual gift card cannot. A customer attempting to return a virtual gift card will not find the gift card displayed in the return portal. ## Refunding Gift Card Purchases Refunds for orders purchased with a gift card are processed in the same way as other orders. If an order is paid for with both a gift card and a credit card then the credit card is refunded first, and then the gift card. Merchants are notified by API as well as in the reconciliation report about the gift card refund. The refund email also includes a note about money refunded from a gift card purchase. When performing a refund, products are refunded first, then shipping, service gesture and D\&T. > [!NOTE] > > For the reconciliation report, it is necessary to know which products are refunded with money and which with gift cards. The NotifyOrderRefund API reflects the gift card part in the refund as well. A refund of 0 value is created when the order is purchased with a gift card as well. In cases in which a refund is not possible, the process used for COD, where the customer's Paypal account is used for refunds, is taken. ![Gift card refund process](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/giftcards/gift-card-refund-process.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=feae7715f5dff69b3485a3911bd3b7ad) ## Gift Cards on the Invoice In a commercial invoice: * Neither physical or virtual gift cards are included in a commercial invoice. * If an order only includes the physical gift card, the shipment is sent as documents. * For a virtual gift card, the Invoice total amount does not match the order total. In a VAT Invoice: * Both physical and virtual gift cards are included. * The real product price is shown. * No VAT is charged for the product. ## API Calls to Platforms Three API calls are set up with platforms to handle the gift cards: * **Validate** — validates the card's authenticity and balance. * **Redeem** — sent once the order is confirmed and will redeem the card's balance. * **Release** — releases the card's balance and refunds it on order cancellations and refunds. > [!NOTE] > > These three calls are sent **by Global-e to the merchant's platform** — the platform implements and hosts the endpoints. Most calls use the shared `CardData` base model. The full request/response contract for each is rendered on its reference page below. > [card] [Validate gift card](/api-reference/validate-gift-card) > > Validate the card's authenticity and balance. > [card] [Redeem gift card](/api-reference/redeem-gift-card) > > Redeem the card's balance once the order is confirmed. > [card] [Refund gift card](/api-reference/refund-gift-card) > > Return the used balance on cancellation or refund. For the Refund call, the following values need to be set in the response for each card: * `RefundedBalanceInGiftCardCurrency` — make sure it is lower than the provided value of `BalanceUsedInCardCurrency`. * `RefundedBalanceInCustomerCurrency` — make sure it is lower than the provided value of `BalanceUsedInCustomerCurrency`. * `IsRefundSuccess` — set to `true` if the two previous values are set on the card and the values are successfully refunded; if a refund is added but something went wrong, set to `false`. If you are not adding any refunds for a particular card, do not set these values. ## Use Cases ### Refund multiple cards Request to refund every applied card on an order. The platform determines the refund value per card and returns the same `Cards` list with the refunded amounts and `IsRefundSuccess` set per card. ```json theme={null} { "MerchantGUID": "", "Cards": [ { "CardId": 167, "BalanceInGiftCardCurrency": 10.000000, "BalanceInCustomerCurrency": 21.390000, "GiftCardCurrencyCode": "GBP", "CustomerCurrencyCode": "EUR", "BalanceUsedInCardCurrency": 10.000000, "BalanceUsedInCustomerCurrency": 21.390000, "RedeemTransactionId": "120423", "CardFields": { "CardId": "card10", "CardPin": "111" } }, { "CardId": 168, "BalanceInGiftCardCurrency": 10.000000, "BalanceInCustomerCurrency": 21.390000, "GiftCardCurrencyCode": "GBP", "CustomerCurrencyCode": "EUR", "BalanceUsedInCardCurrency": 10.000000, "BalanceUsedInCustomerCurrency": 21.390000, "RedeemTransactionId": "120424", "CardFields": { "CardId": "card20", "CardPin": "222" } } ], "TotalToRefundInCustomerCurrency": 42.77654, "TotalToRefundInGiftCardCurrency": 20.00, "ConversionRate": 2.138827 } ``` ### Refund only one card of a multiple-card order When only some cards are refunded, leave `RefundedBalanceInGiftCardCurrency`, `RefundedBalanceInCustomerCurrency`, and `IsRefundSuccess` unset (`null`) for the cards that are not refunded. ```json theme={null} { "Cards": [ { "CardId": 167, "RedeemTransactionId": "120423", "CardFields": { "CardId": "card10", "CardPin": "111" }, "RefundedBalanceInGiftCardCurrency": 10.000000, "RefundedBalanceInCustomerCurrency": 21.390000, "IsRefundSuccess": true }, { "CardId": 168, "RedeemTransactionId": "120424", "CardFields": { "CardId": "card20", "CardPin": "222" }, "RefundedBalanceInGiftCardCurrency": null, "RefundedBalanceInCustomerCurrency": null, "IsRefundSuccess": null } ], "IsRefunded": true } ``` A complete set of request/response examples (validation, redemption, and the success/partial-failure refund responses) is rendered on the reference pages linked above. ## Changes in Existing Methods **SendOrderToMerchant** — the `SendOrderToMerchant` call is used to pass all card information. A new property `GiftCards` (`List`) is added in the `BaseOrder` model at the same level as `InternationalDetails`. The platform checks that each `CardData.RedeemTransactionId` is not empty. See the example in `SendOrderToMerchantWithGiftCards.json`. In cases where a platform has its own Send Cart Call, like some Pro merchants, the same changes should be implemented in the platform's Send Cart Call. **SendCart** — when a gift card is purchased using Global-e checkout, a new field should be passed as part of the `Product` model: `bool IsGiftCart` — a flag that indicates that a product is a Gift Card. Models for all calls are described in `CORE API calls models.cs` (C#). # Gift Cards Source: https://docs.global-e.com/gift-cards-sfcc The Global-e cartridges support **purchasing gift cards as regular products** and **redeeming gift cards on the Global-e checkout**. This page covers the custom (non-native) gift card flow; for SFCC native gift certificates, see [Native Gift Certificates](/native-gift-certificates-sfcc). The cartridges include the framework plus a **demo implementation** based on SFCC custom objects of type `DEMO_GLOBALE_GIFT_CARDS`. The demo is a working example only — **replace it with your own provider before production**. Do **not** import demo custom-object data from `metadata/demo/` into production. > [!NOTE] > > This is an optional feature. It requires both Business Manager configuration and project code. See [Required customization](#required-customization). ## Selling a gift card as a product A gift card is sold like any other product. In Business Manager, create the product and enable the product custom attribute **Is Globale Gift Card** (`geIsGiftCard`) under the product attributes. The product can be a standalone SKU or a master with variants for different amounts. The shopper adds it to the basket and purchases it like any other product. ## Redeeming a gift card on checkout On the Global-e checkout, the shopper enters the card details and applies the card. The number of input fields (Card ID only, Card ID + PIN, and so on) is configured on the Global-e side per project. The redemption uses three Global-e requests handled on the SFCC side: | Request | When it is sent | What SFCC does | | - | - | - | | **Validate** | When the shopper applies the card | Parses the payload and checks the card with SFCC custom objects or an external provider (for example Givex). Returns a valid/invalid response; invalid cards show an error. A valid card's balance is converted to the checkout currency and the totals refresh. | | **Redeem** | After the shopper clicks **Pay and Place Order** and Global-e creates the order on its side (before the SFCC order is created) | Performs the redeem operation for the card. If redeem fails, the shopper sees an error and **no SFCC order is created**. If it succeeds, the confirmation page is shown and the SFCC order is created. | | **Refund** | When a refund case is created on the Global-e side (for example, the order is cancelled) | Reverses the redemption for the card. | After a card is applied, checkout totals show how much of the order is covered by the gift card. * If the card covers the full order total, the shopper can place the order without any additional payment. * If the card covers only part of the total, the shopper selects a payment method for the remainder. Details of the cards used are added to the **SendOrderToMerchant** and **PaymentNotification** payloads. ## Required customization ### Purchase (create the gift card after payment) To create gift cards when a card product is purchased through the Global-e checkout, implement the [`globale.onAfterPaymentUpdate`](/hooks-sfcc#globaleonafterpaymentupdate) hook in your project cartridge (or in `int_globale_sfra` / `int_globale_sitegenesis`, depending on your architecture). `./hooks.json` ```json theme={null} { "hooks": [ { "name": "globale.onAfterPaymentUpdate", "script": "./cartridge/scripts/globale/hooks/onAfterPaymentUpdate.js" } ] } ``` `./cartridge/scripts/globale/hooks/onAfterPaymentUpdate.js` ```javascript theme={null} 'use strict'; exports.onAfterPaymentUpdate = function (order, payload) { var globaleHelpers = require('*/cartridge/scripts/helpers/globaleHelpers'); var logger = globaleHelpers.getLogger(); try { var GiftCardStrategy = require('*/cartridge/models/globale/alternativePayments/GiftCardStrategy'); var giftCard = new GiftCardStrategy(payload); giftCard.create(order); } catch (e) { logger.error('PAYMENTS_GIFT_CARD_CREATE: {0}', logger.message(e)); } }; ``` ### Redemption (provide a real card provider) The demo implementation uses SFCC custom objects of type `DEMO_GLOBALE_GIFT_CARDS`. Override it with a provider that integrates your gift card system: `int_globale/cartridge/scripts/globale/alternativePayments/providers/GiftCardProvider.js` The strategy that drives validate/redeem/refund/create lives at `int_globale/cartridge/models/globale/alternativePayments/GiftCardStrategy.js`. ## Summary The demo (based on SFCC custom objects) is a minimal reference that shows the core moving parts of the gift card feature. Production projects supply their own provider and, where required, an `onAfterPaymentUpdate` handler. Never deploy the demo `DEMO_GLOBALE_GIFT_CARDS` provider or demo object data to production. ## See also * [Native Gift Certificates](/native-gift-certificates-sfcc) · [Loyalty Points Cards](/loyalty-points-cards-sfcc) * [`globale.onAfterPaymentUpdate` hook](/hooks-sfcc#globaleonafterpaymentupdate) * [Metadata reference](/metadata-sfcc) — `geIsGiftCard`, `DEMO_GLOBALE_GIFT_CARDS` # Gift Message Source: https://docs.global-e.com/gift-message The gift message feature enables customers to include a heartfelt message with their gifts, creating a more meaningful and memorable experience. This feature offers merchants a way to stand out by providing added value for customers during the purchasing journey and enhancing customer satisfaction for those purchasing gifts. The gift message section is seamlessly integrated into the checkout flow, ensuring a smooth customer experience. The feature only appears for orders containing physical products, ensuring relevance. When enabled, this feature replaces any existing "Customer Comments" section to avoid redundancy. By adding emotional value to the purchase, customers are more likely to complete their orders. Customers who feel their needs are met are more likely to return for future purchases **Customer Journey** 1. During checkout, customers are presented with the option to include a gift message. This section is visible below the D\&T section. 2. Customers can opt to include a gift message by checking the displayed checkbox. 3. Once selected, a text field appears where customers can type their personalized message. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-0ba21758-82a2-1ece-721b-858cba7edad5.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=f908940bbe5f19a16bdd2b075bc23d6b) ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-33a61edc-598a-3a76-9629-6e1e66d37e22.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=1a5e4a41327bf3890f4c32ce98eb85f0) **Customizable Messaging** * **Default text**: "Add your gift message here..." * **Merchant-specific**: Add a personalized messages tailored for specific brands. **Enablement** The feature is configurable per merchant, allowing businesses to decide if and when to activate the gift message option based on their strategy. Merchants can customize the display texts to align with their brand's tone and messaging. **Analytics & Insights** Merchants have access to data on feature usage, such as: * Percentage of customers who opted for the gift message feature. * Insights into the popularity of the feature across campaigns or seasons. # Global‑e Analytics and Marketing Source: https://docs.global-e.com/global-e-analytics-and-marketing 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](/client-analytics) * [Advanced Checkout Events](/advanced-checkout-events) * [Marketing Pixels](/client-analytics#marketing-pixels) # Global‑e and Shopify Markets Source: https://docs.global-e.com/global-e-and-shopify-markets ## Introduction The Global‑e integration uses the Shopify Markets functionality to provide a localised experience. > [!WARNING] > > While some features can be safely customized, others **must be set to their default configuration**. Modifying features that must be left set to their default configuration can cause unpredictable system behavior. This page describes the settings you can configure in contrast to those that Global-e manages on your behalf. In addition, it delineates the best practices you should follow to ensure that your system is stable and shows accurate information. Note that a separate market is created for each country. > [!NOTE] > > Global-e fully supports the new version of Shopify's unified markets. ## Current System When the first country is operated by Global‑e, clicking Markets shows the following screen: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8e9444c7-aac3-58cc-1166-bcdc9559d611.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=700838d8a2d9b41d662fad19ade15794) The screen above is displayed for merchants whose configurations are managed by Global-e. The next section describes the updated platform, which lets users manage certain configurations on their own. ## Global-e's Interaction with Unified Markets The updated Global‑e integration uses the Shopify Markets functionality to provide a localised experience, giving merchants direct access to the Markets section in their Shopify admin. Shopify's evolution toward an increasingly unified approach to international, B2B, and POS (Point of Sale) retail operations under a single Market framework affects your configuration. This page describes how to maintain a compliant and seamless global marketing experience when configuring your settings. > [!WARNING] > > Modifying these configurations can impact the market strategy defined with Global-e, such as pricing or duties and taxes management. Each Market can have a localised subfolder, such as **/en-ca** for Canada. Make sure that your merchant site is compatible with this structure; otherwise, modify the structure as detailed in [Shopify's locale-aware URLs](https://shopify.dev/themes/internationalization/multiple-currencies-languages#locale-aware-urls). Shopify's Shop Pay is disabled for all markets operated by Global‑e. Global-e's Shopify integration streamlines cross-border sales by leveraging native Market features. Global-e manages the Market section on your behalf to operate each country according to its own setting and customization requirements. Each country must be configured with its own market as shown below. This facilitates accurate pricing, catalog control, and tax configurations that align with local cross-border requirements. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-425bcb82-6838-6362-a6f3-cdb67f1ce3da.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=da737d06b9afa61e581a6b7767846bd8) Our onboarding process includes the following conditions, without which the market remains managed by the merchant: * The merchant must have a GUID (Global-e unique identifier) * The merchant operates in one of the supporting countries (AS, FM, GU, MH, MP, PR, PW, VI) Both conditions above must be met to transfer ownership of your configurations to Global-e. Once we begin managing your market, if the merchant has not created a market, we create one a new one. If the merchant has created a market, we assume control over the existing single country market that includes that country. ## Market Hierarchy Shopify’s Markets framework uses a hierarchical structure, where markets inherit configurations, such as catalog, pricing, and theme from a defined parent market. This allows for streamlined configuration and a consistent experience across countries, enabling localized overrides where needed. Global-e leverages this structure by managing a dedicated market for each operated country, in addition to configuring the following key cross-border settings: * Currency * Duties and taxes * Catalog These configurations are always explicitly set at the market level to ensure compliance and accuracy. All other settings, such as theme, domain, languages, and metafields, can be inherited from a parent market configured by the merchant, supporting flexibility without interfering with Global-e’s core functionality. The following figure shows an example of country configurations inherited from the **South America All Theme** market level: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2df39239-cbba-e10e-0ca1-13375c55439b.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=188ce4baf051467787c923a84881c761) The following example shows the FR (France) market as a child country under the Europe parent market. The France market inherits general store configurations, such as Online store structure, domain/language, and business entity, from the parent. However, Global-e has set certain configurations explicitly customized for FR, such as the **currency** as Euro, a specific **catalog** ("GE FR"), and Taxes and Duties to be managed directly by Global-e. These overrides ensure that while FR benefits from Europe's shared infrastructure, its pricing, product feed, and tax handling are tailored to the French shopper experience according to Global-e requirements: ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-db1fb20f-a767-16d9-f31e-f94915f84401.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=8d56b5c26034e9dbdb25af6223c4de80) Merchants can also override inherited settings (such as theme or language) directly from the Country child market. Once customized, these settings are no longer inherited from the market and are treated as market-specific. The following table describes the operational domain of the operated market settings: | Setting | Controlled By | Merchant can Edit | | - | - | - | | **Market Settings** | | | | Name | Global-e | Yes | | Active / Draft | Global-e | No | | Country Assignment (Includes) | Global-e | Yes | | Currency | Global-e | No | | Price rounding | Global-e | No | | Exchange rate | Global-e | No | | Market Catalog Assignation | Global-e | No | | Price coefficient | Global-e | Only from the Global-e platform. | | Fixed prices | Global-e/ Merchant | Only when the specific Market’s prices are calculated by Shopify ([CBS](https://global-e.atlassian.net/wiki/spaces/PD/pages/3989536769)). | | Duties and import tax | Global-e | No | | Tax Display | Global-e | No | | Themes Customization (Online Store) | Merchant | Yes. Merchants should not remove the Global-e operators for the following **sensitive elements**: Free shipping banner Add to Cart button Hidden elements | | Domain / Language | Merchant | Yes | | Metafields | Global-e and Merchant | Merchants should not remove the Global-e metafield, but can add more. | | Business Entity | Merchant | No | | **Catalog Settings** | | | | Catalog Name | Global-e | No | | Catalog Status | Global-e | No | | Catalog Currency | Global-e | No | | Catalog Coefficient | Global-e | No | | Catalog Added | Global-e | No | | Catalog Removed | Global-e | No | ## Merchant Configuration Management While Global-e manages your core market setting for the operated countries, you can adjust certain visual and experiential aspects on your own. It is important to know the difference between settings that you can safely modify, and those that should be managed by Global-e. Incorrectly modifying certain settings can lead to configuration conflicts. The following table describes what settings you can safely configure, and what Global-e should manage: | Safe to Modify | Do Not Modify | | - | - | | Modifying language and translation settings. Creating hierarchies, including countries operated by Global-e in markets operated by merchants. Setting visual branding to match your design theme. Customizing theme according to store appearance per market or country. Managing localised URLS and multilingual content. Each market can have a localized folder. For example, **/en-ca** for Canada. Verify that your merchant site is compatible with this structure. If it isn't, modify the structure as detailed in [Shopify's locale-aware URLs](https://shopify.dev/themes/internationalization/multiple-currencies-languages#locale-aware-urls). | Deleting a market created and managed by Global-e. Assigning, adding, and removing countries. Disabling settings managed by Global-e on a Global-e market. | > [!WARNING] > > Modifying any of the Global-e managed settings can lead to unexpected behavior. If you need to modify these settings, contact Global-e to prevent disruptions to cross-border operations. > [!NOTE] > > We validate any configurations you modify that our administrators manage, and force replaces incorrect values with the correct ones. ## B2B Market Compatibility Global-e supports B2B that is managed by merchants, allowing them to operate their own B2B independently. This means that merchants are responsible for ensuring that their structure meets their needs according to the hierarchical structure and all inherited properties. # Global-e Checkout Language Source: https://docs.global-e.com/global-e-checkout-language By default, Global-e opens checkout in the shopper’s country language. If you'd like to customize or control the language shown in checkout, there are several ways to do it. This guide walks you through your options and what you need to do for each one. ## Supported Languages Global-e supports 32 languages out of the box, including: > [card] > > * English (US/UK) > * French (FR/CA) > * German > * Spanish (Spain/Mexico) > [card] > > * Hebrew > * Japanese > * Chinese (Simplified/Traditional) To see the full list, see [Supported Languages](/languages). ## Setting the Checkout Language from Your Website Code You have two different options when setting the behavior of your Global-e Checkout language, setting the Checkout language from your website code (described in this section), or always using the language of the shopper's selected country (described in the next section). If you want your Checkout page to open in a specific language based on your website settings (such as browser language or language selector), you can pass the language code from your site to Global-e. ### To set the Checkout language from your website code 1. Add the language code to location on your site that Global-e can read it from. 2. Select one of the following language code storage formats: * A cookie * An HTML attribute, such as `html lang="fr">` * Local or session storage * The URL > [!NOTE] > > Work with your developer or frontend team to expose this language value where needed. Make sure to let your Global-e integration engineer know where the language code is stored (such as cookie name or attribute name) so we can configure your Checkout page to read and use it automatically. > [!TIP] > > This is the flexible and preferred option if your website already has a language selector or multi-language structure. ## Always Using the Shopper Country's Default Language This method forces the Checkout page to load in the shopper country's default language independent of what browser or site language they use. You can do this by asking your Global-e contact to enable this configuration for your store. You can have this feature enabled without making any changes to your site. For example, if a shopper selects Germany as a shipping country, the Checkout page will always display in German. ## Setting the Checkout Language Directly via API Global-e lets you pass the preferred language code in your `getCheckoutCartInfo` API response. You can do this by adding a `"cultureCode"` field to your API response and setting it to a supported language code (such as `"it"`, `"es-MX"`, or `"ko-KR"`). # Global-e Checkout in Web-View Source: https://docs.global-e.com/global-e-checkout-via-web-view Global‑e SDK provides an `openCheckoutWebView` method that Merchants can use to open Global‑e checkout in the web-view. This method uses the following mandatory parameters: * `merchantCartToken`: basket/cart identifier in the Merchant’s system. * `countryCode`: code of the shipping country selected by the user in the switcher. * `currencyCode`: code of the currency selected by the customer in the switcher and some optional. * `clientIP` : IP Address of the client. * `webStoreCode`: value to identify the web store of the mobile app, part of the configuration. * `webStoreInstanceCode`: value to identify the web store instance of the mobile app, part of the configuration. * `preferedCultureCode`: culture code to specify Global-e checkout language. * `getCheckoutUrl`: can be used to get URLs. The URL of the page is part of the configuration of Global-e checkout in the web-view. * `getCartToken`: used to get a token value that must be a part of the web view checkout URL. # Global-e Enablement Platform Source: https://docs.global-e.com/global-e-enablement-platform ## Cross-Border Enablement Global-e is cross-border e-commerce enablement platform that helps brands and retailers to deliver purchase experiences to customers. Global-e's platform makes it simple for merchants to sell worldwide by managing all aspects of global e-commerce trading for you. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-aef99aba-7389-9e13-1963-ee826c985764.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=d3185ca011802f7154588296f2940c49) The customer journey starts with selected messaging to invite customers to engage and interact with your brand, store, and products in their preferred language and currency. From the [Welcome Pop-Up](/site-customization-storefront#configuring-your-welcome-popup-page) page, you can add customized location-specific notifications throughout the buying journey, promoting key [marketing messages](/marketing-banner#overview). Global-e's enablement platform lets shoppers browse and [buy](/supported-currencies) in their local currency. Merchants can use Global-e’s insights to set the optimal pricing strategy to drive conversions and optimize margins. We manage country restrictions and import processing, to keep your international e-commerce store compliant and up to date with local regulations in every market. Global-e provides currency fluctuation protection and international payments fraud prevention, reducing the risks involved in global online selling while maximizing payment acceptance rates. For more information on international payments, see [Payment Methods](/payment-methods). ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5a19402e-0f42-6cfd-c742-5cba1edd8d6a.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=9acca76d4c8b06f154b374bc4e954991) Global-e offers your global shoppers a variety of shipping methods at competitive rates and presents shoppers with a guaranteed final cost of their purchase, according to local best practices, preventing unexpected add-on fees upon delivery. Global-e’s platform covers all international logistics by leveraging our robust worldwide ecosystem, including global and local carriers, fulfilment services and PSPs. ## Merchant Portal Our [Merchant Portal](/merchant-portal) gives you a full view and control of your global e-commerce activity. Easily track your performance and manage your proposition in over 200 markets from one place. Leverage proprietary global insights to maximize your growth. You can leverage our exclusive and massive global dataset to optimize your performance in every market. Our data driven market know-how, generated from billions of transactions made through the Global-e platform, enable you to tailor your offering to local preferences and global market trends. ## Demand Generation Global-e equips you with industry benchmarks and performance analysis and recommends ways to improve your results. The Global-e platform constantly tracks global shopping trends, providing merchants with market intelligence to help them make informed decisions, boost ecommerce conversions and accelerate profitability. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-90a074cb-80b1-d87a-1638-f07c471f939c.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=08688771f0bbcec6c3afdb42b38fa820) # Global-e Environments Source: https://docs.global-e.com/global-e-environments-api-guides > [!NOTE] > > Consult your Global-e project team to determine the appropriate environments for your integration. | Environment | URL Endpoint | | - | - | | INT (Integration) | [https://connect.bglobale.com/](https://connect.bglobale.com/) | | PROD (Production) | [https://api.global-e.com/](https://api.global-e.com/) | # Global-e Environments Source: https://docs.global-e.com/global-e-environments-cross-platform > [!NOTE] > > Consult your Global-e project team to determine the appropriate environments for your integration. | Environment | URL Endpoint | | - | - | | INT (Integration) | [https://connect.bglobale.com/](https://connect.bglobale.com/) | | PROD (Production) | [https://api.global-e.com/](https://api.global-e.com/) | # Global-e First & Third Party Cookies Policy Source: https://docs.global-e.com/global-e-first---third-party-cookies-policy ## General Global-e (“**Global-e**”, “**we**”, “**our**” or “**us**”) wants to ensure that your use of our fulfillment Services, as further detailed below (“**Services**”), is smooth and reliable to you as possible. To help us do this, we use cookies and similar technologies, such as tags/beacons and Java Scripts (“**cookies**”), to make our Service relevant to your interests and needs. References to Global-e (or “**we**”, “**our**” or “**us**”) will refer to the Global-e group including the entities, subsidiaries, and affiliated companies, and will also include the site operating as [https://Borderfree.com](https://borderfree.com/) and the Services offered thereunder (which if offered, will form part of the Service) ## What are Cookies? **Cookies** are small text files, or similar technologies, for example, HTML5 local storage, Local Shared Objects, and fingerprinting techniques, that store information or provide access to information already stored on your device, including your computer, smartphone, or tablet. For this Policy, “cookies” include any technology that Global-e uses for storing information about your browsing on the website, or for accessing information already stored. Cookies contain basic information that helps you recognize your computer or mobile device. This is essential for providing the required Services and allows for improving your browsing and shopping experience in certain cases. After some time, Cookies expire. Typically, Cookies are either removed from your computer once you close your browser session (“Session Cookies”) or they expire after a specific period (“**_Persistent Cookies_”**_)._ ## Global-e Types of Cookies We use both **Session Cookies** and **Persistent Cookies** to track your preferences and improve our Service. Some cookies are strictly essential for the operation of our Service, while others help us improve the level of services provided to you. Global-e use First-Party and Third-Party Cookies: * **First-party cookies** – Controlled by Global-e. Set directly by the website that the user is visiting. * **Third-party cookies** – Controlled by other companies. Set by a domain other than the one visited by the user. For this policy, these cookies are set on the Global-e checkout page for providing and supporting our Services, to secure your checkout. We have created a detailed table, which is attached below. The table provides a clear and comprehensive image of the tracking technologies we use. When a cookie contains personal information for processing your order of products, our **Privacy Policy** applies as well. ## Disabling Cookies > [accordion] Show details > > Cookies will not be stored on your device without your consent. You can delete previously set cookies manually or configure the browser settings to disable or delete cookies, as explained below. > > When switching off cookies, depending on the cookies disabled, your browsing experience may change. The website and our Services may not operate properly, depending on the category of the cookie disabled (Essential/functional or not) as described below. If you choose to delete Global-e cookies, your access to some functionality and areas of our Service may be degraded or restricted. ## Managing Your Cookies ### Obtaining your consent for using tracking technologies > [accordion] Show details > > We need your consent to use all cookies which are not essential or functional. If you do not agree to accept our cookies or other tracking technologies, we will make commercially reasonable efforts to provide you with the same level of Services and experience without using such cookies. ### Withdrawing your consent > [accordion] Show details > > You can withdraw your consent to advertising marketing and social media cookies by contacting [dataprotection@global-e.com](mailto:dataprotection@global-e.com)/dataprotection\@global-e.com). ### Managing your cookie settings and deleting cookies > [accordion] Show details > > We only place cookies, including non-essential cookies, if you have given your consent. If you have given us your consent but would like the cookies to be removed, you can do this from the settings of your browser: > > * **For Microsoft Edge**: Choose Settings – then, under “Site Permissions” select “Cookies and Site Data” for set specific controls. > * **For Google Chrome**: Choose Settings – then under “Privacy and Security” click on “Content settings” and click “Cookies” > * **For Safari”**: Choose “Preferences”- then under “Privacy” click on “Remove all Website Data” > * **For Mozilla Firefox**: Choose “Tools” on the menu and click on “Options”, then select “Privacy” and choose “Cookie”. > > In addition, you can turn off certain third-party advertising cookies by visiting the following links: Network Advertising Initiative, the [Digital Advertising Alliance Consumer Choice,](https://www.aboutads.info/choices/) and [Your Online Choices](https://www.youronlinechoices.com/) pages. > > Some web browsers offer a “Do Not Track” (“DNT”) signal. A DNT signal is an HTTP header field indicating your preference for tracking your activities on our services or through cross-site user tracking. Global-e Services do not respond to DNT signals. ### Questions, comments, or additional help > [accordion] Show details > > We would be happy to assist if you have any questions or if we can help you with anything. Contact us at: [dataprotection@Global-e.com](mailto:dataprotection@Global-e.com)/dataprotection\@Global-e.com). ### Changes to this policy > [accordion] Show details > > We update this policy where needed and when new cookies are added. Every time we change this policy, we either send an email about it or post a notice on our Service. We will post a notice on our Service when our policy update includes substantial changes and obtain your consent once again, where required under applicable laws. ## Cookies Management ### Cookies Categories > [accordion] Show 4 rows > > | **Category** | **Purpose** | > | - | - | > | **Essential cookies** | Essential cookies are necessary and essential for the basic operations of our Service, for example, for your ability to complete your purchase with your chosen items. Without these cookies, you may not be able to use our Service and complete your purchase from the webstore. | > | **Functional Cookies** | Functional cookies allow us to provide a smooth and easy experience.  For example, they save you the trouble of having to change the language display every time you enter our Service by saving your preferred language.Without these cookies, our Service would not work properly, and you would skip important features of it. | > | **Analytics cookies** | Analytic cookies are used to help us understand how visitors reach our Service, how they experience it, and for how long.Analytic cookies provide us with anonymous information that enables carrying out statistical analysis of the Service. They help us understand which parts of our Service interest visitors and if they experience any errors. We use these cookies to test different designs and features for our sites. In the table provided below, you will find more information on how we use these cookies. We also use Google Analytics. We have set our Google Analytics to protect your privacy to the maximum extent. We have concluded a data processing agreement with Google to protect your data. We have also made sure that the last octet of your IP-address is invisible and have turned off the setting which allows sharing data with Google.Please review Google Privacy Policy available [here.](https://policies.google.com/privacy?hl=en)If you wish to opt out from Google Analytic, please follow this [link.](https://tools.google.com/dlpage/gaoptout/) | > | **Advertising, marketing and social media cookies** | We only place advertising, marketing, and social media cookies if you have given us your permission to do this by using our Services and accepting the cookies of the Store Owner. Advertisement and marketing cookies collect information about your browsing habits for displaying content and advertising relevant to your interests. These cookies are also used to help us measure the effectiveness of advertising campaigns by tracking the number of clicks. Most of the cookies under this category are placed by third-party advertising networks as social media platforms. They remember the websites you visit and use this information to give you access to interesting content on our Service and to show you more personalized adverts when you visit other websites. These cookies also help improve your browsing experience, for example by helping to prevent the same advertisement from continuously reappearing to you. Advertisement cookies are not controlled or stored on the Global-e domain. Social media platforms such as Facebook can use cookies to carry out their analysis and statistics, depending on your user account settings. If you would like to know more about how these social media platforms use data, please refer to the privacy notices of these platforms. | ## Global-e Cookies The list below includes all the cookies that Global-e uses to provide the Services. For your convenience, the list is divided according to the Cookies Categories and Hosting Party (First or Third Party). This is an extended list, and not all cookies are used for all websites and services. To identify the specific cookies relevant to you, press F12 on your browser. ### First Party Cookies #### First Party Essential Cookies > [accordion] Show 16 rows > > These cookies are strictly essential as they provide us with access to information that is the basis of our Service and enable your movement around it. This category of cookies cannot be disabled. > > | **Name** | **Category** | **Cookie Name** | **Purpose** | **Session Time** | **Session Starts** | **Domain** | **Platform** | > | - | - | - | - | - | - | - | - | > | **GlobalE_Data** | Essential | Browsing Information | This cookie holds user-selected country, currency, and language to provide correct localized pricing and checkout behavior in cross-border checkout. | 72 hours | Browsing | Merchant Global-e | All platforms | > | **GE_ESSENTIALS_ONLY** | Essential | Cookie Police Enforcer | This cookie disables/allows the user to disable non-essential cookies. | 1 year | Browsing | Merchant | All platforms | > | **GlobalE_Gem_Data** | Essential | GEM/DATA | This cookie stores the store identification and the user cart identifications for processing the order with the items. | 10 days | Browsing | Merchant | Global-e Module | > | **GlobalE_Full_Redirect** | Essential | Checkout Session ID | This cookie allows fluent browsing flow including skipping the sign-in page before checkout. | End of browsing Session | Browsing | Merchant | All platforms | > | **GlobalECartID** | Essential | Cart ID | This cookie is required to capture the user cart (specific order) by a unique identifier and validate it with the webstore. | Session expires when the webstore cart expires | Browsing | Merchant | Global-e Module | > | **GlobalE_Welcome_Data** | Essential | Welcome Information | This cookie displays the Welcome Popup. The Welcome Popup enables the user to change currency and shipping destination. | 72 hours | Browsing | Merchant | All platforms | > | **key** | Essential | Onboarding Wizard | This cookie is used to verify access for the new onboarding wizard. | 24 hours / 15 minutes | Browsing | Global-e | All platforms | > | **Merchantid** | Essential | Onboarding Wizard | This cookie is used to specify which merchant is currently working with the new onboarding wizard. | 24 hours | Browsing | Global-e | All platforms | > | **GlobalE_Consent** | Essential | GlobalE Consent | This cookie is used to define the consent chosen by the shopper for cookies. | End of browsing session | Browsing | Merchant | All platforms | > | **sso_flow** | Essential | Single Sign On flow Indicator | This cookie is used to identify single sign-on authentication. | End of browsing session | Merchant Portal | Global-e | All platforms | > | **GE_CSDK_CB** | Essential | Global-e Client SDK Cache Buster | Stores a timestamp to bypass browser cache when loading SDK resources (scripts, prefetcher, banners). Ensures users receive the latest version of resources within a session. | End of browsing Session | Webstore | Merchant | All platforms | > | **GE_CART_TOKEN** | Essential | Checkout Token | Stores Checkout Token received on Cart creation | End of browsing Session | Checkout | Merchant | Global-e Module | > | **GlobalE_CartToken_Before_Redirect** | Essential | Checkout Session ID | This cookie stores the cart token before redirecting the user to an external payment provider (e.g., PayPal, Klarna). It ensures the checkout session can be restored when the user returns, in case the platform fails to pass the token back. | End of browsing Session | Checkout | Merchant | All platforms | > | **GlobalE_UpdatePaymentMethod_FullRedirect** | Essential | Update Payment Method - Full Redirect Instruction | This cookie flags update-payment full-redirect flow (PaymentsController). | 2 hours | Checkout | Global-e | All platforms | > | **lpa** | Essential | Last Payment Attempt GUID | Last payment attempt GUID; cleared after status poll (change payment / checkout). | End of browsing session | Checkout | Global-e | All platforms | > | **GE_IsExpressFromCart** | Essential | Safari Private Mode workaround for Express-from-Cart payment flows | This cookie flags that express checkout was initiated from cart. | 20 minutes (default; configurable via ExpressFromCartCookieDurationInMinutes app setting). Removed after the gateway redirect round-trip completes. | Checkout | Global-e | All platforms | #### First Party Functional Cookies > [accordion] Show 11 rows > > These cookies are functional. > > | **Name** | **Category** | **Cookie Name** | **Purpose** | **Session Time** | **Session Starts** | **Domain** | **Platform** | > | - | - | - | - | - | - | - | - | > | **GlobalE_ShowStoreBanner** | Functional | Store Information/Offerings | This cookie controls the fluent display of the price conversion according to the user-chosen currency. | 1 year by default.  Can be configurable | Browsing | Merchant | Global-e Module | > | **GE_ISOPERATED** | Functional | Is Global-e Operated | This cookie determines whether the shipping destination is operated by Global-e, as the Merchant of Record. | End of browsing session | Browsing | Merchant | Global-e Module | > | **GE_Show_Switcher** | Functional | Switcher in Non-Blocking Mode | This cookie controls whether the country/currency switcher popup is displayed to the shopper during non-blocking browsing on Magento stores. Prevents the switcher from re-appearing on every page navigation within the same session, ensuring a smooth and uninterrupted browsing experience. | 3 days | Browsing | Merchant | Magento | > | **GlobalE_Locale** | Functional | Locale | This cookie allows fluent browsing flow by correcting the local information received from the webstore to the one identified by Global-e. | End of browsing session | Browsing | Merchant | Global-e Module | > | **GlobalE_SupportThirdPartcookies** | Functional | GEM/Third-Party cookies support | This cookie caches the result of a one-time third-party cookie support check performed when the shopper first loads the merchant site. Prevents repeated server-side verification calls on every page navigation. Ensures Global-e resources (CSS, scripts) load correctly in browsers that restrict third-party cookies, such as Chrome in Incognito mode. | End of browsing session | Browsing | Merchant | Global-e Module | > | **GE_Replacement** | Functional | Replacement Order | This cookie keeps information on the users’ country and currency. | 30 min | Merchant Portal | Merchant | Shopify Native | > | **GlobalE_Geo_Popup** | Functional | Switcher in Non-Blocking Mode | This cookie is used to define if the country switcher should be shown with a preselected Geo IP country. Does not store analytics identifiers. | 72 hours | Browsing | Merchant | SFCC | > | **GlobalE_CT_Tracked** | Functional | Do Not Track Flag | This cookie is used to indicate "Do not track." If it exists the user won’t be tracked, and only Essential data will be collected. | End of browsing session | Browsing | Merchant | All platforms | > | **GEMPUPS** | Functional | Global-e Mixpanel User Profile Setup | \[LEGACY/DEPRECATED - Will be removed] Flag indicating whether Mixpanel user profile setup is needed. Used to ensure user profile is configured only once per session for Mixpanel analytics integration. | End of browsing Session | Webstore | Merchant | All platforms | > | **currentSelectedCulture** | Functional | Current Selected Culture | Stores the merchant website's preferred language/culture to display Global-e popups (welcome popup, country switcher) in the correct language. Overrides GeoIP-based language detection. | End of browsing Session | Webstore | Merchant | All platforms | > | **GlobalE_USB_Data** | Functional | Unsupported Browser Flag | This cookie is used to track whether the "unsupported browser/platform" notification has been shown to the user. It expires after 1 day and prevents the popup from appearing repeatedly during that period. | 1 day | Webstore | Merchant | All platforms | #### First Party Analytic Cookies > [accordion] Show 14 rows > > | **Name** | **Category** | **Cookie Name** | **Purpose** | **Session Time** | **Session Starts** | **Domain** | **Platform** | > | - | - | - | - | - | - | - | - | > | **GlobalE_AB_Data** | Analytic | A/B Testing | This cookie, if configured, enables different types of A/B testing in the checkout. | 1 year | Checkout | Merchant | All platforms | > | **GlobalE_Ref** | Analytic | Tracking Referral Information | This cookie keeps information on the referrer of the user. | 30 min | Browsing | Merchant | All platforms | > | **GlobalE_sess_ID** | Analytic | Session ID | The unique identifier of the Session ID is used by the analytics engine for Shopify. | 2 years | Checkout | Merchant | Shopify Native | > | **GLBE_SESS_ID** | Analytic | Session ID | The unique identifier of the Session ID is used by the analytics engine for all platforms. | 1 year | Browsing | Merchant | All platforms | > | **ga_data** | Analytic | Temporary UTM Intra-Page Transfer Storage | The temporary storage of the UTM parameters is needed to transfer them between pages. | End of browsing session | Browsing | Global-e | All platforms | > | **GlobalE_Analytics_Borderfree** | Analytic | Client Information | This cookie is set by Borderfree and holds information about parameters provided by Borderfree | Minimum 3 days | Web Store | Merchant | All platforms | > | **GlobalE_Analytics_UTMs** | Analytic | Client Information | This cookie holds information about UTM params parsed from the request.. | End of browsing session | Web Store | Merchant | All platforms | > | **GE_C_HCOUNT** | Analytic | Global-e Client Hit Count | Tracks the number of page views/tracking events within a user session for analytics purposes. Incremented each time a tracking pixel fires successfully. | End of browsing Session | Webstore | Merchant | All platforms | > | **GE_UTM_PARAMS** | Analytic | UTM Attribution Parameters | This storage key (sessionStorage) preserves UTM marketing parameters from the landing page URL for attribution tracking. The parameters are passed to the checkout to enable accurate campaign performance analysis. | End of browsing Session | Webstore | Merchant | All platforms | > | **GlobalE_CT_Data** | Analytic | Client Information | This cookie holds a unique client identifier for a customer (per browser), which helps Global-e to provide information about the client behavior on a Global-e enabled website. | 2 years | Browsing | Merchant | All platforms | > | **GlobalE_Analytics** | Analytic | Client Information | This cookie holds the Analytics SDK data for a shopper (per browser), which helps Global-e to provide information about the client behaviour on a Global-e enabled website. | 2 years | Webstore | Merchant | All platforms | > | **GlobalE_Analytics_UseMixpanelMocks** | Analytic | Analytics - Use Mixpanel Mocks Flag | When present in sessionStorage, instructs the checkout iframe to use mock Mixpanel events instead of real ones, preventing test traffic from polluting production analytics. | End of browsing session | Checkout | Global-e | All platforms | > | **GE_CUSTOMER_DETAILS_STARTED** | Analytic | Customer Details Started Analytics Event | Deduplication guard for the "Customer Details Started" analytics event. Ensures the event is fired only once per merchantId+cartToken combination. | 30 days | Checkout | Global-e | All platforms | > | **GlobalE_Analytics_PreCheckoutExpress** | Analytic | Pre-Checkout Express Eligibility - Analytics Event Deduplication | Deduplication guard for the Pre-Checkout Express eligibility analytics event. | End of browsing session | Checkout | Global-e | All platforms | #### First Party Marketing Cookies > [accordion] Show 1 row > > | **Name** | **Category** | **Cookie Name** | **Purpose** | **Session Time** | **Session Starts** | **Domain** | **Platform** | > | - | - | - | - | - | - | - | - | > | **GlobalE_Analytics_GoogleAds** | Marketing | Client Information | This cookie is set by Google Ads. The cookie holds information about Google Ads parameters like `gclid` | 30 days | Web Store | Merchant | All platforms | ### Third Party Cookies #### Third Party Essential Cookies > [accordion] Show 14 rows > > | **Name** | Category | **Cookie Name** | **Purpose** | **Session Time** | > | - | - | - | - | - | > | **\_cflb** | Essential | Cloudflare Load Balancer | This cookie is by Cloudflare. It is required for secured browsing flow while detecting malicious visitors, including bots and the use of CAPTCHA. | The session can run up to 24 hours | > | **\_cf_bm** | Essential | Cloudflare bot products | This cookie is by Cloudflare. It is required for secured browsing flow while detecting malicious visitors, including bots and the use of CAPTCHA. | Expires after 30 min | > | **\_cfseq** | Essential | Cloudflare bot products | Sequence rules use cookies to track the order of requests a user has made and the time between requests and make them available via Cloudflare Rules. | Expires after 1 hour | > | **cb_ob_info** | Essential | Cloudflare Always Online | This cookie provides information on the HTTP Status Code returned by the origin web server; The Ray ID of the original failed request. | Expires after 30 seconds | > | **cf_use_ob** | Essential | Cloudflare Always Online | This cookie by Cloudflare is required for “Always Online” feature, used for security. | Expires after 30 seconds | > | **\_\_cfruid** | Essential | Cloudflare Rate Limiting | This cookie by Cloudflare is required to support “Rate Limiting” for managing the website traffic. | Cleared by a browser when user restarts their browser. | > | **\_cfuvid** | Essential | Rate Limiting Rules | This cookie by Cloudflare is required to support “Rate Limiting Rules” for managing the website traffic when multiple unique visitors share the same IP. | Cleared by a browser when user restarts their browser. | > | **cf_clearance** | Essential | Clearance cookie | This cookie stores the proof of challenge passed. It is used to indicate no further need to issue a challenge if present. It is required to reach an origin server. | 30 minutes | > | **ForterToken** | Essential | | This cookie is set by Forter. It is required for fraud detection. This cookie identifies the browser between browsing sessions. | Expires after 5 years | > | **Ftr_ncd** | Essential | | This cookie is set by Forter.  A flag is used to make sure data is not sent more than once per predefined timeframe. | 1 day | > | **AWSALBCORS\*\*\*\*AWSALB** | Essential | Accessibility feature | The functionality is to provide load-balancing functionality.**AWSALBCORS**: With cross-origin resource sharing (CORS) requests, some browsers require SameSite = None; Secure to enable stickiness. In this case, the load balancer generates a second stickiness cookie, AWSALBCORS, which includes the same information as the original stickiness cookie plus the SameSite attribute. Clients receive both cookies.**AWSALB**: When a load balancer first receives a request from a client, it routes the request to a target (based on the chosen algorithm) and generates the AWSALB cookie. It encodes information about the selected target, encrypts the cookie, and includes the cookie in the response to the client. The load balancer generated cookie expires in 7 days which is non-configurable. | 7 days | > | **.ASPXAUTH** | Essential | ASP authentication token | This cookie is used for user authentication on the Admin page. (Microsoft ASP.NET). | End of browsing session | > | **\_\_RequestVerificationToken** | Essential | ASP Forgery token | This cookie is set by ASP.NET and improves the security of the web site. It prevents Cross-Site Request Forgery-attacks and does not contain any user information. | End of browsing session | > | **CONSENTMGR** | Essential | Consent settings | The consent manager uses this cookie to save the consent settings of a visitor. | 1 year (can be overridden) | #### Third Party Non-Essential (Analytic) Cookies > [accordion] Show 7 rows > > | **Name** | Category | **Cookie Name** | **Purpose** | **Session Time** | > | - | - | - | - | - | > | **\_ga** | Analytic | Google Analytics | This cookie is set by Google Analytics and is used to identify the unique user. | 2 years | > | **\_gcl_au** | Marketing | Google Ads | This cookie is set by Google Ads. It is used for measuring campaign performance. | 3 months | > | **\_gid** | Analytic | Google Analytics | This cookie focuses specifically on user identification and session tracking within the realm of website analytics. Used to distinguish users and group page interactions into short-term analytics reports. | 24 hours | > | **\_cid** | Analytic | Google Analytics | This cookie is set by Google Analytics. It is used for saving the customer ID in the analytics. | 1 year | > | **\_VWO** | Analytic | VMO Cookie Jar | This is a “cookie Jar” and is set by [VWO](https://www.vwo.com). This cookie is a jar of all the cookies. It is currently created only for the Safari browser. In the future, it may replace all the cookies. | 1 year | > | **\_vwo_uuid_v2** | Analytic | VMO behavior testing | This cookie is set by VWO. It calculates the unique traffic on a website. | After 1 year | > | **\_vwo_ssm** | Analytic | VMO behavior testing | This cookie is set by VWO. This cookie is used for testing and is created only on sites that use the HTTP protocol. This is used to check if VWO can create cookies on them, post which this cookie is deleted. | 10 years | #### Third Party Analytic Cookies Placed as First > [accordion] Show 7 rows > > | **Name** | Category | **Cookie Name** | **Purpose** | **Session Time** | > | - | - | - | - | - | > | **fs_uid** | Analytic | Full Story | This cookie is set by Full Story and hosted on the Global-e domain. It is used for tracking the users across sessions and pages. This cookie can be thought of as the capture cookie. | After 1 year | > | **fs_cid** | Analytic | Full Story | This cookie is set by Full Story. It stores the consent state for this device. | After 1 year | > | fs_session | Analytic | Full Story | This cookie maintains an authenticated user's session. Specific only to admins and users of the Full Story application, not end users. | After 30 days | > | fs_csrftoken | Analytic | Full Story | Prevents cross-site request forgery. Specific only to admins and users of the Full Story application, not end users. | After 30 days | > | fs_trusted_device | Analytic | Full Story | This cookie is used for users so as not to require verifying a device on every login attempt. This is specific only to admins and users of the Full Story application, and not end users. | 60 Days | > | fs_last_activity | Analytic | Full Story | Records the timestamp of the last action the user took, within the web application. Specific only to admins and users of the Full Story application, not end users. | End of browsing session | > | \_fs_tab_id | Analytic | Full story | Support multi-tab playback. Provides a unique ID for each tab. | End of browsing session | #### Third Party Marketing Cookies > [accordion] Show 1 row > > | **Name** | Category | **Cookie Name** | **Purpose** | **Session Time** | > | - | - | - | - | - | > | **\_fbp** | Marketing | Facebook Parameter | This cookie is set by Facebook. It is used for marketing. | 3 months | # Global-e Merchant Portal Source: https://docs.global-e.com/global-e-merchant-portal Maximize efficiency with our user-friendly Merchant Portal, empowering you to streamline, manage, oversee, configure, and optimize every aspect of international order fulfillment. Features include: * **Site Customization Screens:** Tailor your site effortlessly to align with your brand identity. * **Merchant Menu**: Streamline Product Management, Reports, and Flash Sales. * **Order Menu**: Efficiently manage and fulfill orders. * **Configuration Menu**: Refine your marketing strategies and manage customer emails. * **Systems Menu**: Administrators can use the Users screen to configure user settings. * **Explore Store Orders** for seamless fulfillment of physical store orders. * **GlobaEPrinterAgent**: Install this printing utility to set up your printers and generate the necessary shipping documents during order fulfillment. For more information, see [Merchant Portal](/merchant-portal). # Global-e Mobile SDK Source: https://docs.global-e.com/global-e-mobile-sdk Global-e aims to streamline integration with the Global-e platform for iOS and Android native applications. The Global-e Mobile SDK offers a range of methods enabling Merchants to easily detect countries, convert prices, and open the Global-e Checkout. **Mobile SDK Features:** * Country / Currency detection * Country / Currency switcher * Price calculation * Global-e checkout via web-view * Cache data **In this section:** * [Prerequisites](/prerequisites-mobile-sdk) * [iOS Installation](/ios-installation) * [Android Installation](/android-installation) * [Usage of Global-e SDK](/usage-of-global-e-sdk) * [Global-e Checkout in Web View](/global-e-checkout-via-web-view) * [Cache Data](/cache-data) * [Global-e SDK Error List](/global-e-sdk-errors-list) # Global-e Orders in Shopify Source: https://docs.global-e.com/global-e-orders-in-shopify Whenever a checkout is triggered and a shopper clicks the ‘pay’ button, Global-e creates a matching cart on the Global-e side. Global-e processes the payment. Once the payment is authorised, an order is created automatically in Shopify. Global‑e creates an order in parallel on the Global‑e side using Shopify’s API. ## Downstream Data Flow from Shopify At Checkout, Global-e begins calculating the international prices, duties & taxes, and shipping methods. Orders are created by Shopify and per Shopify’s [multi-currency concepts](https://www.shopify.com/partners/blog/multi-currency-app-developers), in two currencies: * **Presentment money:** what international customers see on the storefront, cart, checkout, and transactional emails. * **Shop money:** The main currency of your Shopify store and the currency used for reporting and analytics. > [!NOTE] > > Shop money is what should be mapped downstream by your order management and accounting systems. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f41c4044-6c44-db10-4850-fb9fdadcf169.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=487f2e3c811cc01ce1b2d8187a3df9fd) **Fraud check** Global-e performs a fraud check for international orders. 1. Initial order creation has the payment status **PENDING** (financial_status property). **Important:** Merchants should not submit any orders for fulfilment at this time and wait on Global-e to complete the fraud check. 2. When the fraud check is completed, the payment status is updated to **PAID**. Orders may now be submitted for fulfilment. **WMS and operations** For Global-e to generate international shipping labels & customs documents, the warehouse pick-pack process must reference Shopify’s order name and SKU. Alternatively, the Shopify order number and/or Shopify EAN/barcode/variant ID may be used instead. Reach out to Global-e as additional configuration may be needed in those cases. **When a shopper places the order on the checkout page:** * Shopify creates an order. Shopify Order Status: `Paid` * Global‑e creates a matching order on the Global‑e Merchant Portal. Tag: `Globale::Pending` * Global‑e verifies the payment and customer fraud status. Order Status: `Paid` Tag: `Globale:: Approved` This tag indicates that you can fulfil the Global-e order. If for any reason, the order or the payment is not authorised, Global‑e can cancel the order, in which case, the Shopify status shows: `Cancelled`. ## End-to-End Order Flow Interfaces A general illustration of an order flow with Shopify to OMS to WMS and Global-e in the picture. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-51099735-9514-fd36-bd3d-3e4736b3871e.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=ff2f690162c227f82fa3234f2df3ad8b) **Outbound** * **Order creation**: created in Shopify with initial payment status 'PENDING’ and order tag ‘Globale::Pending’. * **Fraud check**: upon successful fraud check (asynchronous process), the payment status goes to ‘PAID’ and the order tag is replaced with ‘Globale::Approved’. * **Export to OMS/WMS qualified orders**: with ‘PAID’ status or tagged with Globale::Approved. * **Pick and pack**: used by the warehouse to identify orders via the Shopify order name/number and sku/upc. * **Label generation**: Global-e interface provides a final mile carrier label and a tracking number. * **End-of-day manifest:** signals to Global-e that the order is ready to be dispatched and generates an end-of-day document. * **Fulfilment update to Shopify**: in most scenarios, this event or the tracking number itself is provided by Globale. It is also expected for Shopify to send the shipment confirmation email when its fulfilment is created. ## Global‑e Order Information **To view the Global-e order information:** 1. In the Shopify Admin, navigate to Orders. The Orders screen opens, showing the list of orders (Global-e and non-Global-e Orders). 2. Click a Global‑e Order. The Global‑e order details screen opens. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cb9df94c-1094-f43b-dce8-8cfaa131c878.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=9d12613ef3e30cd59a0da89e76f09bde) The Global‑e details screen provides the following information: * The `Global‑e Order ID` (under Additional Details). The Global‑e Order ID starts with `GE` and ends with the merchant's country code. In this example, the Global‑e Order ID is **GE**175560204**GB**. * The price that the shopper paid in local (customer) currency. In this example, the price is €205.00 * The duties and taxes in merchant and shopper currencies * Customer Information * When fulfilling the order, this screen shows both tracking Information and a tracking link. In addition, the order shipment information shows the tracking number. * Global‑e order tag: `Globale::Approved`. * Order Status. See [Global-e Orders in Shopify](/global-e-orders-in-shopify) for more information on statuses. ### Shopify Order Data Examples This Shopify store belongs to a US merchant and the storefront currency is in USD. Below are two different order scenarios in which a single product is purchased: * Duties & taxes are paid by the customer – the checkout explicitly displays D\&T-related line items. * Duties & taxes are inclusive/baked into product prices – the merchant subsidizes the D\&T costs. **Scenario 1: Duties & taxes paid by the customer** Market: Israel. The customer pays separately for all the D\&T-related costs including the customs clearance fee (CCF) represented here in the “Additional Fee” field. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2c640c56-c777-b35b-d6a9-82aee717578a.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=fdb17ceeafe7c9404666a52510c42663) > [!NOTE] > > The **Additional Details** section is for information and is not required for data consumption. `CalculatedDutySubsidy` represents the total order level subsidy in storefront currency. In this example, there is no subsidy for this order, hence the \$0. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-758da67a-f2e0-2c65-0562-dd8da99161b0.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=1ab9012dc4e73e0beece6977b68c5776) > [!WARNING] > > The **Additional Fee** set is a new Shopify data line available in Shopify’s API release version 2023-04. See [https://shopify.dev/docs/api/admin-rest/2023-04/resources/order](https://shopify.dev/docs/api/admin-rest/2023-04/resources/order) for reference. **Scenario 2: Duties & taxes are included in the product price** Market: United Kingdom. Duties, taxes, and customs clearance fees are all-inclusive in the £500.00 product price in this example. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-31c91e07-29a8-5c53-3175-b1c8f4e4ae38.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=7f39ef508b814577c97e717b64da4676) `CalculatedDutySubsidy` 139.72 USD includes duties, VAT, and CCF. **Note**: the D\&T line items do not appear in the order details at all. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-4a893f7c-6aa7-c5a3-8449-346d9ee44f2e.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=894b82a343b48fb9c9480f0cf8dc9a97) **Conclusion** * Duty, tax, and customs clearance fees (CCF) are all part of the overall duties and taxes calculation. * When a customer’s checkout displays duty & tax-related fees, these costs appear as order line items. * Any subsidized costs, whether both duties and taxes or just duty or just taxes – appear in the note attributes `CalculatedDutySubsidy` field. ### Shopify Order JSON example A full example of an order JSON file can be downloaded here:[Shopify Order JSON example](https://globaleonline.sharepoint.com/sites/ExternalSharing/Shared%20Documents/Forms/AllItems.aspx?id=%2Fsites%2FExternalSharing%2FShared%20Documents%2FSolutions%2FPlatforms%2FShopify%20Native%20CrossBorder%20by%20Global%2De%2FExample%20JSON%2FExample%20Order%20%2D%20CR%20with%20additional%20fees%2Ejson\&parent=%2Fsites%2FExternalSharing%2FShared%20Documents%2FSolutions%2FPlatforms%2FShopify%20Native%20CrossBorder%20by%20Global%2De%2FExample%20JSON\&p=true\&ga=1). ## Accounting Perspective From a Shopify view, orders are created per customer as a B2C transaction with Global-e. From an accounting perspective, orders should be treated as domestic B2B orders booked against a Global-e account. You may book any order line items to calculate gross revenue while bearing in mind that in most scenarios Global-e is responsible for handling remittance and filing local VAT and other taxes. For estimated net revenue, you can subtract the`CalculatedDutySubsidy` field. For actual revenue, refer to the Global-e financial reconciliation report. ## Global‑e to Shopify Order Updates Global‑e updates Shopify when a customer places a new order, or when an order is fulfilled, cancelled, or refunded. ## Free Shipping on Orders Select one of the following methods to create orders with a zero shipping fee: **Method 1: Update the Shopify template** 1. Navigate to the **product-template.liquid** file in your Shopify theme. 2. within the **\{% form 'product' ... %}** block, insert the following code snippet adjusting the internal logic as needed for your implementation: ``` {% assign property='someValue' %} ``` 3. Add the product to the cart to submit the form. The property is now available on cart.js. **Method 2: Update the cart via API** Insert or update the cart with one of the following APIs: **Insert** ``` curl -X POST \ https://{store_name}.myshopify.com/api/2024-10/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \ -d '{ "query": "mutation cartLinesAdd($cartId: ID!, $lines: [CartLineInput!]!) { cartLinesAdd(cartId: $cartId, lines: $lines) { cart { # Cart fields } userErrors { field message } warnings { # CartWarning fields } } }", "variables": { "cartId": "gid://shopify/Cart/123", "lines": [ { "attributes": [ { "key": "", "value": "" } ], "merchandiseId": "gid://shopify/ProductVariant/123", "quantity": 1, "sellingPlanId": "gid://shopify/SellingPlan/123" } ] } }' ``` **Update** ``` curl -X POST \ https://{store_name}.myshopify.com/api/2024-10/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \ -d '{ "query": "mutation cartLinesUpdate($cartId: ID!, $lines: [CartLineUpdateInput!]!) { cartLinesUpdate(cartId: $cartId, lines: $lines) { cart { # Cart fields } userErrors { field message } warnings { # CartWarning fields } } }", "variables": { "cartId": "gid://shopify/Cart/123", "lines": [ { "attributes": [ { "key": "", "value": "" } ], "id": "gid://shopify/CartLine/111", "merchandiseId": "gid://shopify/ProductVariant/123", "quantity": 1, "sellingPlanId": "gid://shopify/SellingPlan/123" } ] } }' ``` ## Refund Orders are refunded directly through the Shopify Admin portal. **Important information for Merchants who charge customers for prepaid return labels on the Global-e Returns portal.** | When a customer uses a prepaid shipping label, Global-e deducts the cost of shipping from their refund, resulting in a lower refund amount than indicated in the notification email. Since Shopify does not support paid returns, this can cause discrepancies in Shopify's recorded refund data and the notifications sent to customers. | | - | | For example, if a customer returns a product that costs $95.30, with a $10 prepaid label generated on the Global‑e Returns portal, the notification email from Shopify indicates a refund amount of $95.30, when in reality the customer only receives $85.30. | | We recommend the following solutions: | | Continue to provide customers with prepaid labels but modify the refund notification email to not include the refund amount. Provide customers with prepaid labels and refund them through the Global-e Merchant Platform. (For more information: [Issuing a Refund](/refunds-orders#issuing-a-refund)) Provide customers with free returns instead of prepaid shipping labels. | To refund an order: 1. Navigate to the Shopify Admin screen. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ef0fde68-1f72-d315-04a4-f74cc0795916.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=4249b9b5764342c411c2a1d5179f53c0) 2. In the left navigation bar, click **Orders.** The list of orders is displayed. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cecbbfe7-054d-b406-6302-21ad57c3bf0b.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=3f503149438372a6c3a6f152f6b5ba59) 3. Select the order for which you want to perform a refund. The order page opens. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-473619af-de68-a018-1480-72a852def0da.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=89cd5861a5bc56e9c548f9281979a6d0) 4. At the top-right of the page click **Refund**. The Refund page opens. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-96862650-590d-1c4c-4344-f82a0f3f3300.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=865c64e2a55347d06e77670e6126e952) 5. Enter the number of items that you want to refund. If you don't want the item to be restocked, unselect the **Restock Item** option. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e0ad253f-c81d-bbb7-c4ae-1b2c45776b44.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=2fd77641948214d394c3a1b99a79d93f) The **Summary** section displays the refund amount. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-44dd36d3-21ec-9ff6-aed5-77b392f7e237.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=cac00262b22d109fcc96ab941be16306) At the bottom of the page, you may include a reason for the refund. 6. Click **Refund \$(amount)** to finalize the refund. The order is refunded and a refund notification email is sent to the customer. ## Cancel an Order Before an order is fulfilled, the merchant can initiate an order cancellation from Shopify. Orders are canceled directly through the Shopify Admin. > [!WARNING] > > * An order that has been fulfilled or shipped cannot be cancelled. > * Cancelled orders are not included in reports. > * An automatic refund is issued, for the full order amount or the captured amount, for every order cancelled. To cancel an order: 1. Navigate to the Shopify Admin screen. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-ba6282c2-2a6c-a015-5fb7-e20cf097e2c3.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=9677a97ca62dd83b300223d1d6fbfce3) 2. In the left navigation bar, click **Orders**. The list of orders is displayed. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cecbbfe7-054d-b406-6302-21ad57c3bf0b.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=3f503149438372a6c3a6f152f6b5ba59) 3. Select the order that you want to cancel. The order page opens. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a9b7ee7c-72a6-9625-c84d-f8de9e6ab269.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=5973fd8ab90195bb32d09c6c64ba877d) 4. At the top-right, select **More actions** > **Cancel Order**. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1fc5051e-f999-9ae1-9c7c-b1dbae7520b1.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=f1711fc78c0ab340bdf22556fa801598) A confirmation window opens. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-472d6e88-5a5a-9f29-c81d-203042cad117.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=8386892b6814ff7e0fa11b28454a17d9) 5. In the confirmation window, select a reason for the cancellation, and click **Cancel Order**. If you do not wish to restock the inventory or have a notification sent to the customer, unselect those boxes. The order is canceled and an email is automatically sent to the customer notifying them of the cancellation (unless you choose not to send a message). ## Amend an Order Shopify can support amending orders before an order is fulfilled, for example, when an item is out of stock or needs to be cancelled, however it is performed using the Shopify **Refund** process. Therefore, to make changes to an order you need to follow the same instructions as for processing a refund in Shopify. Note that although the Order Page menu does include an Edit option, you cannot use it to amend an order since the changes are not recognized by Global-e. To amend an order: 1. Navigate to the Shopify Admin screen. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ef0fde68-1f72-d315-04a4-f74cc0795916.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=4249b9b5764342c411c2a1d5179f53c0) 2. In the left navigation bar, click **Orders.** The list of orders is displayed. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cecbbfe7-054d-b406-6302-21ad57c3bf0b.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=3f503149438372a6c3a6f152f6b5ba59) 3. Select the order which you want to amend. The order page opens. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-473619af-de68-a018-1480-72a852def0da.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=89cd5861a5bc56e9c548f9281979a6d0) 4. At the top-right of the page click **Refund**. The Refund page opens. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-96862650-590d-1c4c-4344-f82a0f3f3300.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=865c64e2a55347d06e77670e6126e952) 5. Enter the number of items to remove from the order. If you don't want the item to be restocked, unselect the **Restock Item** option. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e0ad253f-c81d-bbb7-c4ae-1b2c45776b44.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=2fd77641948214d394c3a1b99a79d93f) The **Summary** section displays the change. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-44dd36d3-21ec-9ff6-aed5-77b392f7e237.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=cac00262b22d109fcc96ab941be16306) At the bottom of the page, you may include a reason for the refund. 6. Click **Refund \$(amount)** to finalize the amendment. The order is amended, and a notification email is sent to the customer. ## Draft Orders ### Overview You can use the Draft Orders functionality to initiate an order directly from the Shopify admin: * To [Placing a Draft Order](/global-e-orders-in-shopify#placing-a-draft-order) * To [Influencer Orders](/global-e-orders-in-shopify#orders_for_influencers) * To create Replacement Orders in Shopify. See [Replacements in Shopify](/global-e-orders-in-shopify#replacements-in-shopify). ### Placing a Draft Order Place an order over the phone or by email on behalf of a customer and send them the payment link. Customers can also purchase products that are not yet available on the website. You can create draft orders in either the Order or Drafts screens #### To place a draft order 1. From your Shopify admin, navigate to **Orders**. 2. Click **Create order**. The **Create order** screen is displayed: ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-bd5fd8e7-101a-bf81-97e1-440ce320dd6e.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=0c93719c8f2eee1281b8c568f4794116) 3. Enter the following information: 1. Add products and quantities. 2. Set one of the following: * Add a customer in the Customer section. All the customer information is populated and the Market reflects the customer's country and currency. * Change the destination country of the order: 1. Edit ( ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-14aab228-c068-e1be-465a-94a8edba968e.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=240b9b2fda5326ca643ca2a575c7040e)) the Market section. 2. In the pop-up, select the destination country for the order and click **Change market**, as shown in the following example: ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a4f3f8b6-c651-f314-6c22-89e1bc48cb9e.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=2d15fb8603602e1d783056950dcb5b67) 4. Do the following: 1. Click **Send invoice**. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-11241e55-f049-3403-e09b-7bf26ca7c52a.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=81d954ec6ef72976be850bbcca8b5380) In the pop-up, if you added the Customer (in step 2), the customer's e-mail address is pre-populated. Otherwise, add the email address manually and enter the required information. 2. Click **Review Invoice**. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2b30f093-c69e-cbfd-4298-c5ad66b8a581.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=0b18ea3000ba7ebe9810e6e09602c349) 3. Click **Send Invoice** again. > [!NOTE] > > Note that **Payment due later** is not supported: > [!WARNING] > > When placing a Draft Order that involves payment by the customer at checkout, do **not** use a custom shipping method. Custom shipping can leave the order stuck and stop it from being processed through Global-e. > > Also make sure none of the products are restricted for the destination country - a restricted product can prevent the order from being sent to Global-e. ### Influencer Orders This feature allows shipping free orders to influencers or customers through Global-e, free of payment from customers. Follow the steps below to set up influencer orders. 1. **Create an order** 1. On the top-left of the Shopify Admin page click **Orders** > **Drafts**. The Drafts page opens. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5aa8b568-0caa-fda5-7c90-710b49d4425d.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=6886acc8d88e44c48d3d3a41468262f2) 2. At the top-right click **Create Order**. The **Create Order** page opens. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d63c81ff-743b-54c1-2039-e5a74afbed2a.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=e8bd4fdc699902f886407a705c89db28) 2. **Add customer details** 1. In the **Customer** section, click the search bar to view a list of your customers. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3f5a6462-8f5e-f68c-769f-9343e0f987c1.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=b4e52a54d32342cc90dc40015d49f05b) 2. Select the name of the customer/influencer. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-49784c6f-4b83-5a1f-6030-c2f085f535ce.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=43e56d03c43bf06ffdbfef25c7627e6b) The customer details are displayed on the right. 3. **Add products** 1. Next to the **Products** search bar click **Browse**. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1ab62093-316d-24a5-1447-e88c168354df.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=712052d429f16d34d2952f7893402543) A window opens with a list of your products. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1c360b03-8f82-5503-3929-68bc1077c35f.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=31fc02bebd386aee9ce36f059ab7627e) 2. Select the desired product/s and click **Add**. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-956da260-c360-e5cb-64da-ea3a8a140258.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=aeab425c2475b0d5a3fe97027256c2c9) The products are added to the order. 4. **Add the discount** 1. In the **Payment** section click **Add discount**. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-90e20c82-be50-ff84-7a7d-0100f3ef7fa0.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=5b0ef405f663b1fb9d299316f25bdbaa) The **Add Discount** window opens displaying a list of available discount codes. 2. Select two discount codes, one for the order and the other for the shipping, and click **Apply**. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8e82a1bf-e7fd-593a-346f-324fb18857d9.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=9310ee186168ecb88f83844e6cada8a2) Both discount codes are applied to the order. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-51124f52-646c-44e6-cf75-2e211d9cd415.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=0b513264bd6314351277e52fbed95f00) 5. **Add the shipping method** 1. Click on **Add Shipping or delivery**. The **Shipping and delivery options** window opens. 2. Click on the **Shipping rates** drop-down menu and select the desired shipping option. 3. Click **Apply**. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-968b0ff3-7c27-c301-23b0-6ca9e5fc9a4a.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=eacabf7db808db9a5e2b6f1229585690) 6. **Create the order** 1. At the bottom of the order screen click **Collect Payment** > **Mark as Paid**. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1856bb26-78f9-4f5d-28df-6940037e6a73.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=66f3f60f4eaa4332b976d49f3dbad66d) The **Mark as Paid** window opens, confirming the creation of a free order. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4ea7d14b-1941-7870-4475-f21dcf152140.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=49c6d68c93dbd023dd4a03b8424d99b6) 2. Click **Create Order.** The order is finalized and can be viewed with the rest of your orders. This order can be processed in the exact same way as the other standard Global-e orders. This order can be processed in the exact same way as the other standard Global-e orders. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-effc89f3-f62f-1026-1e6d-4ff694d3d2d8.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=78fbe3779423f03e9adc46c5c0eb0447) ## Shopify's Multi-Currency Shopify's multi-currency feature enables customers to view prices in their local currency, make payments in their currency at checkout, and receive refunds in the same currency. Shopify's multi-currency orders include both the storefront base currency (usually USD) and the customer currency (€, £, ¥, and more). These currency values are stored as different fields in Shopify: * **Shop_money** – This field holds the storefront's base currency, which serves as the main currency for the Shopify store and is used for reporting and analytics. It is typically mapped downstream by order management systems (OMS) and accounting systems. * **Presentment_money** - This field stores the customer currency, visible to international customers in the storefront, cart, checkout, and transactional emails. ### FX Conversion and Shopify API Since Shopify’s multi-currency orders are created as the localised customer currency (*presentment_money*), Shopify converts the values using FX conversion to get the *shop_money* in the Shopify Admin and APIs. Shopify uses different rounding calculation functions for the *shop_money* value in the Transaction API and Order API: * **Order API** - This API retrieves the breakdown cost of individual line items in both *shop_money* and *presentment_money*. The total amount is calculated as the sum of these individual line items. * **Transaction API** - This API retrieves the total transacted amount in either *shop_money* or *presentment_money*. ### FX Rounding Discrepancy ### Introduction This document explores the FX considerations related to Shopify's API and order total calculations. When importing orders from Shopify into a third-party system, you can retrieve the order total: * Directly from Shopify’s **Transaction API** * OR - * By re-calculating all order line items (via the **Order API**) Mathematically, the order total from these two APIs would match without FX rounding. However, due to rounding, a decimal discrepancy may occur, as shown in the [Rounding Discrepancy Example](/global-e-orders-in-shopify#rounding-discrepancy-example). This has been verified by Shopify as expected behaviour; it applies to all multi-currency orders and it is not specific to Global‑e. For more info on Shopify multi-currency and API, see [Shopify's Multi-Currency](/global-e-orders-in-shopify#shopify-s-multi-currency). ### Rounding Discrepancy Example A customer places an order in Canada that costs \$395.50 CAD. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-183e1f87-7ded-7b7e-0a66-6cff3bd4e7bb.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=901989adc2d4a1ff630141a900e6ea36) The Order API provide the item cost, the shipping cost, the tax, and the sum of all these values. The Transaction API provides the transacted amount from the customer. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-efaf3a82-b85b-c1b7-ee47-1a9dc0409977.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=e41b6fb39f67295edf4947f434f04cf6) With the FX rate at 1.38726, there is a \$0.01 difference between the sum of individual line item prices and the total transacted amount. This discrepancy arises due to rounding when comparing the order component FX conversions and the FX conversion of the total itself, leading to a normal and expected mismatch when rounded to two decimal places. | | Presentment_money | Shop_money | Calculation | | - | - | - | - | | Order API | Line Item 1 = 350.00 CADTaxes = 45.50 CADTotal price = **395.50 CAD** | Line Item 1 = $252.30 USDTaxes = $  32.80 USDTotal price = **\$285.10 USD** | 252.30 USD + 32.80 USD = 285.10 USD | | Transaction API | Total Amount= **395.50 CAD** | Total Amount= **\$285.09 USD** | 395.50 CAD / 1.38726= 258.09 USD | This behaviour applies to all Shopify multi-currency orders. Shopify has confirmed that this is not a bug and no API changes will be made. ### Conclusion No mandatory actions are needed. If you are using both the Transaction API and the Order API to get the order total, anticipate that the totals will not match exactly for Shopify multi-currency orders. ## Replacements in Shopify ### Overview Global-e‑ supports product replacements directly through the Shopify Admin. ### Prerequisites Update the **Global-e Crossborder** application. 1. Navigate to the Global-e CrossBorder App * INT (integration): [https://admin.shopify.com/store/\{\{shopify-store}}/apps/global-e-crossborder-int](https://admin.shopify.com/store/\{\{shopify-store}}/apps/global-e-crossborder-int) * PROD (Production): [https://admin.shopify.com/store/\{\{shopify-store}}/apps/global-e-crossborder](https://admin.shopify.com/store/\{\{shopify-store}}/apps/global-e-crossborder) 2. Navigate to Settings > **Update Global-e Scopes**. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-56e0504a-e8c2-7fdc-eee0-5c7a9998d5f9.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=0f0a096d00268b9a480f7ee09fff6508) 3. Click **Update Access Scope**. The **Update** page opens. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e33df79c-adec-53e4-454b-edf13ee4d29f.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=8a9c2f96c945f1b060768d8b65a04278) 4. Click **Update App.** 5. Wait 10-15 minutes for the application to update before starting to create Shopify replacements. A message under the **Update Access Scope** button confirms that the app has been successfully updated. ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/uuid-028cc431-4c8d-055e-e266-a226683d35f8.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=5065fdc4ae11e5096d3ecb79a890ba89) > [!NOTE] > > Global‑e’s responsibility does not involve validating orders when creating replacement orders. ### Performing a Replacement in Shopify To perform a replacement in Shopify: 1. Navigate to the Shopify Admin screen. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ef0fde68-1f72-d315-04a4-f74cc0795916.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=4249b9b5764342c411c2a1d5179f53c0) 2. In the left navigation bar, click **Orders**. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f7bb8076-4fd8-2058-3e1a-e9a86af9b193.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=9d9fa99d810b16758dd92be46ab5c5bb) The list of orders is displayed. See Step 3, below. 3. Select the order that you want to replace. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5c9f8297-45df-832e-7114-4fc77f803673.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=e3dcedf0f53108af856dc294a3b6dd27) The original order opens. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-6a18f872-192c-8a4e-0211-4eaca21c5aac.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=dfee0f5b7b9e76764d9c6d51e323ed26) 4. At the top-right, select **More actions > Start Global‑e Replacement.** ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-545e38d7-f395-d273-833d-bd9adeda8716.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=a401d9a9da77d477a72b1a715a1d2106) An instruction page opens, explaining the process for replacing an order. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ef35ad58-db5f-04e4-f911-bc17247dd1e0.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=8d99dbcd87c16fa2ed0df7181f33da8d) 5. At the top of the Replacement Instructions page, select **Click Here**. The draft order opens. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e039b4b9-d181-8f75-1cd1-62a2a4278265.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=74fd05ab5adbba5e37d223b619de9fe2) > [!NOTE] > > Global‑e uses Shopify’s Draft Order feature to generate replacement orders. As part of the process, a placeholder product with a \$0 value is automatically added to the draft order. This product is deleted before the finalization of the replacement order. 6. Under Products, in the Search bar, type the replacement item's name. - OR - Click **Browse** to search through all the products. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-610a4f02-a414-7620-f98b-67888d58b4cc.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=e38919a43f2a88586b5d6261498456b3) You can use the filter to search for a product by a barcode, SKU, ID, or title. ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fe815c19-79d7-a7a2-d57c-7c9137f833f1.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=a22af18a02f3e40d9418f5edff00ca6b) 7. Select one or more replacement products and at the bottom-right click **Add**. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b2832a1f-07a2-e4b1-fd75-08a516c9516b.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=c0cdc18c836b0550712c47074bee69c7) The product/s are added to the draft order. The order screen displays: * The placeholder product * The replacement product ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b82fa28f-8fe7-b9d7-4946-2b75af59f416.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=ad3fb39e3a3efb3e608258f8a5de63d5) 8. Click the **Trash** icon to delete the placeholder product. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-6c6f86ea-6e58-d348-fb64-4991e956f177.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=423f3efc3197623d865610595ddc9a4c) Now, the draft order only includes the replacement product. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a02f7bee-b4f0-4b29-cd4f-5d95ff7cef0c.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=a7e6f2d81c64b7ab6c2f2b4f6435f41d) 9. On the right side of the draft order, ensure the customer's shipping address and contact details are correct. ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fb5d0de5-1ae6-80e4-5c40-44643f5bba6f.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=0acde112a149da9ecbf8ceb17f2e60d7) 10. At the bottom of the **Payment** section, select **Collect payment** > **Mark as paid** ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1da8d687-2210-87ae-cc11-fea404a5e7c8.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=3c1b800cdb0799c55913082b45240209) A pop-up appears confirming that an order is created and no payment is required. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-25cb7265-6584-3dce-0d7b-bfc2d1d07318.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=260e059a5144b58c8e565969002788dd) > [!NOTE] > > * The draft order automatically inputs the same shipping method used for the original order and a zero-value shipping fee. > > * A 100% order discount is automatically applied to the order, bringing the order total to zero. We recommend not changing these settings because it will affect the order's total. > > * The only time you may need to edit the shipping option is if you use a shipping line Code or Source as an identifier instead of the Title. In this situation, manually edit the shipping information, as detailed below. To edit the shipping rates: 1. Click **Edit shipping or delivery**. The Shipping and delivery options opens and the ustom rates option is selected by default. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-47e4d2b3-35f8-fb02-a434-c73bad623cd3.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=98ffc304bfc4aa83d973dd5850eeaa39) 2. Select **Shipping rates**. 3. Choose a shipping method and click **Apply**. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-aaab664a-9a72-2280-0a5c-e3ff16f2e615.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=b0d845b06260a742aca4fb89ae0dae07) The new shipping rate is added to the order total. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cf8d3f58-db88-a288-7226-0a7b118eae25.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=6ccba4816d71208a861b1ac50ab8a40c) 4. Click **Collect payment** > **Mark as paid**. The **Mark as paid** window opens. 5. Input a shipping rate of \$1.00 (or more) and click **Create order**. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-91557b08-6477-a569-cedd-fcbbfeeafab8.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=52dd696594916cd014b36acdb6fed025) A new order for the replacement item (Replacement order) is created. 11. In the pop-up, click **Create Order.** A new order for the replacement item (Replacement order) is created. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4f906a5b-8d71-d142-e4a7-340fb11eb6eb.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=a8415d68395a0428654c60cdaf86ddb2) 12. On the Global‑e Merchant Portal, view the Replacement order. a. From the Global‑e Merchant Portal, navigate to **Orders > View Orders**. b. Open the original order. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8037cfdc-bc99-af31-ac44-e717c7500a45.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=0ec188d2a60db9b689382b47ebcbfc20) The newly replaced order is added to your ecommerce platform as a new order. At the top of the order screen, the newly replaced order is flagged as a replacement order. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1cbf23a9-f21a-69d3-6e1f-6dc6cc91655c.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=dd6353f41a2025eed30898c48a6f34e2) If you do not wish to include replacement orders in your sales reports, you may need to perform modifications on your ecommerce platform to make sure that they are not included in the sales reports. ## Migrating Global-e to Native App If you are presently running live on the legacy version of Global-e’s Shopify integration, a.k.a the “hosted checkout”, you must migrate to the latest version where Global-e is natively integrated into Shopify’s checkout. These are the key changes to Shopify order data: * **Order transaction** is no longer per B2B transaction in a single currency, but per customer B2C transaction instead with presentment currency and shop currency. The B2B VAT is no longer reflected in Shopify. * **Order id** – Shopify order_name no longer starts with ‘GE’ (e.g, GE2034304US). Orders name is now assigned by Shopify same as for domestic orders (eg., #1234). The Global-e order id is available, see below “From the “Additional Details” section in order data” * **Shipping lines/code** is now standardized by Shopify as explained in the previous section. * **Shipment confirmation emails** no longer come from Global-e but instead are managed by Shopify/merchant. * **Fraud approval** no changes to this flow, still relying on the payment status “pending” (before fraud check) and a subsequent update to “paid” status upon fraud approval with the addition of an order tag “Globale::Approved” * **Payment gateway** no longer shows ‘globale’, instead: * **Global-e Payment (INT)** when installing the Global-e payment method in production mode. * **Global-e Payments** when installing the Global-e payment method in test mode. **From the “Additional Details” section in order data** The Global-e order is still available in Shopify, however not upon initial order creation and only as a note_attribute, which is updated by the Global-e Shopify app a few seconds post-order creation. **Example** ``` "order": { "id": 4525092405308, "name": "#1976", "note_attributes": [ { "name": "GEOrderId", "value": "GE10071428326US" } ``` # Global-e Purchase Examples Source: https://docs.global-e.com/global-e-purchase-examples The following two purchase examples offer a detailed look at the price conversion process. There are two types of price conversions: * **Dynamic pricing** - Global-e converts the customer currency on the website for the Merchant. * **Fixed pricing** - The Merchant gives Global-e the customer's price in the customer's currency and that information is fed into the website. **Dutch Merchant - EU Customer** Example of dynamic pricing ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-54c8d5d6-cf7f-f2ff-3b35-a3baac1afa92.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=770ebe699b47c9736a976e12467aa781) **Dutch Merchant - Swedish Customer** Example of fixed pricing ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8d56c0d7-b199-d2ec-e9bf-caeb40b21d27.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=c00cc38daf087d2aa3715189ec5afb4d) # Global-e Purchase Examples Source: https://docs.global-e.com/global-e-purchase-examples-au The following purchase examples offer a detailed look at the price conversion process. There are two types of conversions: * **Dynamic pricing** - Global-e converts the customer currency on the website for the Merchant. * **Fixed pricing** - The Merchant gives Global-e the customer's price in the customer's currency and that information is fed into the website. **Australian Merchant – Japanese Customer** Example of dynamic pricing ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9ecf248e-286c-f92a-1c0f-660d7253bb7a.svg?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=facb9465173c56ac486221ccc2c31299) **Australian Merchant – UK Customer** Example of dynamic pricing ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b4f732e7-515a-9576-453e-f1fcb509bdf2.svg?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=bc54b851ac5d438c230ed272d395b8c8) **Australian Merchant – US Customer** Example of fixed pricing ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b0712754-ae24-ded3-322d-97c18fd9a17c.svg?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=0573063a91f01bd0a4b8374736942d88) # Global-e Purchase Examples Source: https://docs.global-e.com/global-e-purchase-examples-uk The following two purchase examples offer a detailed look at the price conversion process. There are two types of price conversions: * **Dynamic pricing** - Global-e converts the customer currency on the website for the Merchant. * **Fixed pricing** - The Merchant gives Global-e the customer's price in the customer's currency and that information is fed into the website. **British Merchant – Non-UK Customer** Example of dynamic pricing ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-66ef37b9-93cb-42d1-1df5-c45f6a4dbe7b.svg?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=8c3b724e2f55067df9767762bfa9e020) **British Merchant – Non-UK Customer** Example of fixed pricing ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d1a8c530-c53f-4d16-25bc-7887a72d655d.svg?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=314add448e8b090f3b87aa480654883f) # Global-e Purchase Examples Source: https://docs.global-e.com/global-e-purchase-examples-us The following two purchase examples offer a detailed look at the price conversion process. There are two types of price conversions: * **Dynamic pricing** - Global-e converts the customer currency on the website for the Merchant. * **Fixed pricing** - The Merchant gives Global-e the customer's price in the customer's currency and that information is fed into the website. **US Merchant – Japanese Customer** ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a1a2dc3f-e5ac-6dd9-ec65-18845b689c38.svg?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=17bc910729dfd613a290f822f5f55318) **US Merchant – Australian Customer** ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fee3bda1-90b8-56c7-5cfe-e3c719ef48f4.svg?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=094fa60d77d17547ec2f2ceb1d3aa964) # Global-e Roles and Features Source: https://docs.global-e.com/global-e-roles-and-features This page describes the user's roles and permissions, and the authorized operations allowed on each permission level. The tables on this page are useful for understanding what features and activities you have access to based on your assigned role(s). For example, **Admins** typically have access to a larger range of activities, while **Customer Service representative** and **Hub Operators** have access only to activities based on their set of responsibilities. The table below describes the department, user type, and common role combinations in relation to business activity: * **Department**: the scope of business activity related to the user type and common role combinations commonly found in each department. In other words, it's the most basic grouping of business activities according to work scope. * **User type**: a further breakdown of the types of users responsible for activities in each department. * **Common role combinations**: maps between user types and Global-e's role types. This column shows the most common combination of roles in the field in relation to the user type. Roles are applied by admins to users from the Global-e platform on an individual basis. | Department | User Type | Common Role Combinations | | - | - | - | | Merchant Management | Full Merchant Permissions | Merchant Admin | | Merchant Management | Full Merchant Permissions | Merchant Customer Service Admin | | Merchant Management | Full Merchant Permissions | Hub Admin ( + Store Roles if applicable) | | Merchant Management | Full Merchant Permissions | Merchant Report Admin | | Customer Service | Customer Service Lead | Merchant Admin | | Customer Service | Customer Service Lead | Merchant Customer Service Admin | | Customer Service | Customer Service Lead | Merchant Report Admin | | Customer Service | Customer Service Team | Merchant Admin | | Customer Service | Customer Service Team | Merchant Customer Service | | Customer Service | Customer Service Team | Merchant Report User | | Operations | Hub Operators (Merchant's warehouse team) | Merchant Admin | | Operations | Hub Operators (Merchant's warehouse team) | Hub Admin | | Operations | Hub Operators (Merchant's warehouse team) | Merchant Report User | | Operations | Hub Operator (3PL team lead) | Hub Admin | | Operations | Hub Operator (3PL team) | Hub Operator | Each user type has access to different areas of the Global-e platform. This section shows the relationship between these departments and their permissions: * **Department**: The name of the department * **Menu level 1**: Menus on the platform with one level * **Menu level 2**: Menus on the platform with two levels. ## Merchant Admin Menu Functionality The following table shows the **merchant admin menu functionality**: | Merchant CS | Merchant Admin | Merchant CS Admin | | - | - | - | | **Orders**: Returns View Order Same Day Dispatch Orders | **Merchants**: Merchant ID Product Management:   – Product Price Feed   – Products Bundle Mapping Reports:   – Dashboard **Configuration**: Customization Marketing Proposition Email Management | **Merchants**: Product Management:   – Restricted Products   – Produce Price Feed   – Products Bundle Mapping Reports:   – Dashboards **Orders**: Returns Merchant Hub:   – Process Order: Non-GE Carriers   – Failed Transfer to Merchant   – Pickup Request View Orders Same Day Dispatch Orders | ## Hub Menu Functionality The following table shows the **hub menu functionality**: | Hub Operator | Hub Admin | | - | - | | **Orders**: Global-e Hub   – Process Orders   – Process Returns   – Process EOD   – Process PUDO EOD   – Process Stores EOD   – Process Returns EOD   – PUDO Distribution   – Stores Distribution Merchant Hub:   – Process Orders   – Process EOD   – Pickup Request Same Day Dispatch Orders | **Orders**: Global-E Hub:   – Process Orders   – Process Return   – Process EOD   – Process PUDO EDO   – Process Stores EOD   – Process Returns EOD   – PUDO Distribution   – Stores Distribution Merchant Hub:   – Process Orders   – Process EOD   – Process Orders: Non-GE Carriers   – View Processed Orders   – Canceled Orders   – Failed Transfer to Merchant   – Failed Orders   – Pickup Request Same Day Dispatch Orders | ## Merchant Report Functionality The following table shows the **merchant report menu functionality**: | Merchant Report Admin | Merchant Report User | | - | - | | **Analytics:** Live View Sales & Funnel Products Finance | **Analytics**: Live View (if access granted) Sales & Funnel (if access granted) Products Performance (if access granted) Order Level - Reconciliation Data (if access granted) | ## Role Action Mapping This table shows the **actions** relevant to each feature or tool based on your role. In other words, this table shows the range of activity available to you:
FeatureMerchant CSMerchant AdminMerchant CS AdminHub OperatorHub AdminMerchant Report AdminMerchant Report User
AnalyticsNoNoNoNoNoYesYes
Live ViewNoNoNoNoNoYesYes - if access is granted
Sales & FunnelNoNoNoNoNoYesYes - if access is granted
ProductsNoNoNoNoNoYesYes - if access is granted
FinanceNoNoNoNoNoYesYes - if access is granted
MerchantsNoYesYesNoNoNoNo
Merchant IDNoYesNoNoNoNoNo
Product ManagementNoYesYesNoNoNoNo
Product Price FeedNoYesYesNoNoNoNo
Restricted ProductsNoNoYesNoNoNoNo
Products Bundle MappingNoYesYesNoNoNoNo
ReportsNoYesYesNoNoNoNo
OrdersYesNoYesYesYesNoNo
ReturnsNoNoYesNoNoNoNo
Global-E HubNoNoNoYesNoNoNo
Process OrdersNoNoNoYesNoNoNo
Process ReturnNoNoNoYesNoNoNo
Process EODNoNoNoYesNoNoNo
Process PUDO EODNoNoNoYesNoNoNo
Process Stores EODNoNoNoYesNoNoNo
Process Returns EODNoNoNoYesNoNoNo
PUDO DistributionNoNoNoYesNoNoNo
Stores DistributionNoNoNoYesNoNoNo
Merchant HubNoNoYesYesNoNoNo
Process OrdersNoNoNoYesNoNoNo
Process EODNoNoNoYesNoNoNo
Pickup RequestNoNoYesYesNoNoNo
Process Orders: Non-GE CarriersNoNoYesNoYesNoNo
Canceled OrdersNoNoNoNoYesNoNo
Failed Transfer to MerchantNoNoYesNoYesNoNo
Failed OrdersNoNoNoNoYesNoNo
Pickup RequestNoNoYesNoYesNoNo
View OrdersYesNoYesNoNoNoNo
Same Day Dispatch OrdersYesNoYesYesYesNoNo
ConfigurationNoYesNoNoNoNoNo
CustomizationNoYesNoNoNoNoNo
Marketing PropositionNoYesNoNoNoNoNo
Email ManagementNoYesNoNoNoNoNo
SystemNoNoYesNoYesNoNo
UsersNoNoYesNoYesNoNo
# Global-e Routes Source: https://docs.global-e.com/global-e-routes If a full page cache requires a whitelist of dynamic URLs, the following patterns should be whitelisted to support Global-e integration The following shows the dynamic URLs for the frontend area: * `/international-ge/*` * `/international/*` The following is the dynamic URLs for the Admin area: `/globale/*` Additionally, Global-e uses Magento2’s REST APIs. Make sure to enable them. Verify that you have not cached them, such as removing them from varnish or any other cache mechanism. # Global-e SDK Errors List Source: https://docs.global-e.com/global-e-sdk-errors-list List of error codes and error descriptions: * 110 - Merchant not found (Merchant token invalid) * 120 - The field Country is invalid * 130 - The field Currency is invalid * 140 - Internal server error * 150 - Unsupported server response * 160 - Unknown currency code * 180 - Unknown country code # Global‑e Storefront Functionality Source: https://docs.global-e.com/global-e-storefront-functionality This section provides an overview of the main features and functionality resulting from the Global-e add-on installation. Global‑e handles: * The currency conversion – See [Converted Prices](/global-e-storefront-functionality#converted-prices) and [Prices and Price Conversion](/prices-and-price-conversion). * The checkout for countries managed by Global‑e – See [Global‑e Managed Checkout](/global-e-storefront-functionality#global-e-managed-checkout) and [Cart and Checkout](/cart-and-checkout). * Order notifications for orders managed by Global-d. See [Global‑e Notifications](/global-e-storefront-functionality#global-e-notifications). Global‑e manages the following main website components: * The welcome pop-up: See [Welcome Pop-up](/site-customization-storefront#configuring-your-welcome-popup-page). * The country switcher: See [Configuring Your Switcher Popup Page](/site-customization-storefront#configuring-your-switcher-popup-page). * The checkout iframe: See [Global‑e Managed Checkout](/global-e-storefront-functionality#global-e-managed-checkout), [Global‑e iFrame Checkout (Example)](/cart-and-checkout#global-e-iframe-checkout-example) and Order Creation. **Checkout** During the checkout, the Global‑e add-on posts the following to the Global‑e system via the API: [https://connect2.bglobale.com/Checkout/SendCartV2?merchantGUID=\{merchantGUID}](https://connect2.bglobale.com/Checkout/SendCartV2?merchantGUID=%7bmerchantGUID%7d). The customer is redirected to a checkout page `checkoutDisplay.jsp`, in which Global‑e injects HTML via an iframe. **Backoffice** Use Backoffice to set up and manage pricing and Global-e Orders. **Additional Functionality: Custom Add-on Functionality** If required, customize the Global‑e extensions for additional functionality. * `globaleaddon` is used for front-end changes. * `globalecore` and `globalefacades` are used to communicate with the Global‑e API. * `globaleendpoint` is used to receive order update notifications. * `globalepromotions` is used for custom Global‑e promotions. * `globalebackoffice` is used for Backoffice modifications. For details and custom Global‑e add-on functionality, see [In Depth: Global‑e Add-on, Extensions, and Custom Functionality](/add-on-extensions-and-custom-functionality). ## Shipping Country and Currency Indication The shopper can view the localized Shipping country and currency indication. For example, Ship to £GB (GBP). ## Converted Prices The customer can view prices in local currency including current conversion rates, country coefficients, rounding rules, and currency symbols. The `GlobaleSwitcherFindPriceStrategy` is an element of the price determination and conversion that delegates to `GlobaleFindPriceStrategy`. `GlobaleFindPriceStrategy` delegates to `GlobaleConvertingPriceValueConverter`, `GlobaleConvertingPriceValueConverter` delegates to `GlobalePriceConverter`. To convert an existing OOTB SCC price row to another currency, the Global-e add-on asks Global-e for the conversion rate of the price row (without VAT) to the customer's selected currency; for example, GBP to EUR has a rate of around 1.18. The add-on also requests a coefficient rate and tax rate. Once converted into the customer's chosen currency, Global‑e applies rounding rules (improving the appearance of customer-facing price values). ## Global‑e Managed Checkout When the shopper adds items to the cart and clicks the checkout button, the extension redirects from the native environment to the Global-e checkout (iFrame). The Global-e Add-on implements a Global-e API method that uses the Platform API to load the contents of the user's cart and passes it securely to the Global-e checkout through a server-to-server API call. During the checkout, the Global‑e add-on posts the following to the Global‑e system via the `SendCartV2` API: ``` https://[Globl-e API domain]/Checkout/SendCartV2?merchantGUID={merchantGUID} ``` The customer is redirected to a checkout page `checkoutDisplay.jsp`, in which Global‑e injects HTML via an iframe. The Global‑e iframe is implemented as its own WCMS ContentPage (`globalecheckout`). For more information, see: [Cart and Checkout](/cart-and-checkout) [Checkout Flow (Technical)](/add-on-extensions-and-custom-functionality#checkout-flow-technical) ## Global‑e Notifications Once the customer has been through the Global‑e checkout and finished the order - Global‑e will communicate with the merchant at a few points: 1. **Order creation:** As soon as the order is accepted on the Global‑e side, it is processed and delivered to the hybrid system. * Endpoint: ``` /globalerest/order-update-create-url ``` * Order Status: `“Pending“` 2. **Payment creation:** After the order passes the fraud analysis successfully, Global‑e updates the order: * Endpoint: ``` /globalerest/order-payment-only-url ``` * Order Status: “`Processing`“ 3. **Shipping creation:** Once the products are shipped to the customer, Global‑e sends the shipping call to the app: * Endpoint: ``` /globalerest/order-shipping-info-update-only-url ``` * Order Status: `“Processing“` 4. **Cancel order:** If Global‑e cancels the order (for any reason), Global‑e also sends the status update to the app: * Endpoint: ``` /globalerest/order-status-update-only-url ``` * Order Status: `“canceled“` Global‑e sends an email to the customer confirming that the order was placed. ## My Account Orders created by logged-in customers are assigned to the relevant account in your merchant store and the order history section. Global‑e displays the order prices paid by the customer, in their currency. **Example in SAP Hybris:** ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-049e7ac2-3e30-44bc-a5e7-4b8ac1a02abb.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=4f880582f829c31ffb1e0aec62f45ed4) ## Transactional Emails All transactional emails are sent by Global‑e. # GlobaleCatalogFeed Source: https://docs.global-e.com/globale-catalog-feed-sfcc This job is part of the default Global-e SFCC cartridge functionality. **GlobaleCatalogFeed** generates a product catalog CSV from SFCC catalog data and uploads it to an SFTP folder configured in site preferences. Global-e pulls the file from that location for product classification and restriction processing. See also: [Jobs overview](/jobs-sfcc), [GlobaleProducts](/globale-products-sfcc) (restriction import), [Restricted / forbidden products](/restricted-products-sfcc), [Configuration](/configuration-sfcc). ## Overview Global-e requires periodic catalog exports for product classification and restrictions. The job has two steps: | Step | Step type | Description | | - | - | - | | GenerateCatalogFeed | `custom.GlobaleGenerateCatalogFeed` | Builds the catalog CSV from `geCatalogFeedConfig` and writes it to the IMPEX folder | | UploadCatalogFeed | `custom.GlobaleUploadCatalogFeed` | Uploads the generated file to the SFTP location configured in site preferences | 1. **GenerateCatalogFeed** — builds the CSV from site preference **Catalog Feed Configuration** (`geCatalogFeedConfig`) and writes it under IMPEX. 2. **UploadCatalogFeed** — uploads that file from IMPEX to the configured SFTP folder so Global-e can import it. Note the following about **GlobaleCatalogFeed** behavior: * It iterates all products in the configured storefront catalog (`feedData.catalogId`). By default it **skips** product sets, master products, and variation-group products — enable `addMasterProducts` / `addVariationGroupProducts` to include them. (As a special case, when a variation group's master product has no categories, its variants are exported.) * It exports products to a newly generated CSV file (not in-place catalog updates). Information and error messages are written to the **GLOBALE** custom log (logger category `GLOBALE`) when catalog data or upload configuration issues occur. Configure it under **Administration → Site Development → Development Setup → Custom Log Settings**. ## High-level flow The job picks up products created or modified since the last run and writes them to a CSV file. That file is pushed to a pre-defined SFTP folder hosted by the merchant or Global-e. A Global-e service watches the SFTP folder, classifies new and updated products, and returns classification and restriction data through the Global-e API. **GlobaleProducts** imports that data back into SFCC product custom attributes (`geRestrictedCountries`, `geIsForbidden`, `geVatRates`). Flow: SFCC catalog → **GlobaleCatalogFeed** CSV → SFTP → Global-e classification → API → **GlobaleProducts** → SFCC product attributes. ## Installation and scheduling After [Installation](/installation-sfcc), schedule **GlobaleCatalogFeed** to run periodically (typically once daily; adjust to your catalog update frequency). The job is **disabled by default** in `metadata/jobs.xml`. Assign job flows only to Global-e operated sites. Replace the sample site ID (`RefArchGlobal`) with your site IDs during deployment. ## Mandatory catalog fields Global-e expects these fields in the catalog CSV (configure columns in `geCatalogFeedConfig`): * SKU * Display Name * Product Description * Country Of Origin * Image URL * Kids products ## When product data is not in SFCC If mandatory fields live in another backend system, you can disable **GlobaleCatalogFeed** and export the catalog from your product management system instead. Global-e can process CSV files and native SFCC XML exports. ## Catalog feed columns The table below lists standard catalog feed columns. Include optional columns when the data is available — Global-e recommends populating as many as possible. | # | Column Name | Type | Description | Sample Value | Comments | | - | - | - | - | - | - | | 1 | Id | String | SKU | 22398003 | | | 2 | ParentProductID | String | Master product ID when applicable | P22398003 | | | 3 | HS Code (Commodity code) | String | Product commodity code | 62052000 | | | 4 | Product Category | String | Product category | Ladies Shoes | | | 5 | DisplayName | String | Product name on the website | Diamond Quilted Cushion | | | 6 | LongDescription | String | Long description | A stylish cushion brings added comfort to your bed. | | | 7 | Height | Number | Product height (default: cm) | 1 | | | 8 | Width | Number | Product width (default: cm) | 5 | | | 9 | Length | Number | Product length (default: cm) | 3 | | | 10 | Volume | Number | Volumetric weight (default: cubic cm) | NULL | | | 11 | Weight | Number | Product weight (default: gr) | 460 | | | 12 | OriginCountry (ISO3) | String | Country of manufacture | GB | | | 13 | IsBlocked | Number | Block product in all Global-e operated countries | 0 | | | 14 | IsVirtual | Number | Non-physical product (courses, memberships, vouchers) | 0 | | | 15 | VATRate | Number | VAT rate to apply | 20 | | | 16 | Price | Number | Product price in merchant currency | 12.99 | | | 17 | Keywords | String | Product keywords | shirt | | | 18 | Size | String | Product size | S | | | 19 | Color | String | Product color | Blue | | | 20 | IsKidsProduct | Number | Kids clothing flag (required for correct VAT) | 0 | | | 21 | ProductURL | String | Product page URL | [https://www.merchant.com/product/](https://www.merchant.com/product/) | | | 22 | ImageURL | String | Product image URL | [https://www.merchant.com/product/image.png](https://www.merchant.com/product/image.png) | Often populated on full export only; in delta mode you may emit empty values — see column type `static` below. | | 23 | IS DG | Number | Dangerous goods flag (DHL via Global-e) | 0 | `IsDangerousGoods = 1` is blocked automatically for DHL dangerous goods. | ## Configuration Feed settings are stored in site preference **Catalog Feed Configuration** (`geCatalogFeedConfig`): **Merchant Tools → Site Preferences → Custom Site Preference Groups → Global-e Catalog Jobs** Example configuration: ```javascript theme={null} { "impex": { "folderPath": "/src/globale/catalog/", "archiveFolderPath": "/src/globale/catalog/archive/" }, "sftpCredentialIDs": [ "Globale-SFTPCatalogFeedUpload" ], "file": { "name": "globale_catalog_feed_{datetime}", "columns": [ { "header": "Id (* mandatory field)", "type": "product", "attr": "ID" }, { "header": "ParentProductID", "type": "product", "attr": "masterProduct.ID" }, { "header": "HS Code (Commodity code)", "type": "product", "attr": "custom.hsCode", "fallback": { "type": "static", "attr": "" } }, { "header": "Product Category", "type": "category", "attr": "displayName", "categoriesSeparator": "," }, { "header": "DisplayName (*)", "type": "product", "attr": "name", "fallback": { "type": "product", "attr": "ID" } }, { "header": "LongDescription(*)", "type": "product", "attr": "longDescription.markup" }, { "header": "Height", "type": "product", "attr": "custom.geHeight", "fallback": { "type": "static", "attr": "" } }, { "header": "Width", "type": "product", "attr": "custom.geWidth", "fallback": { "type": "static", "attr": "" } }, { "header": "Length", "type": "product", "attr": "custom.geLength", "fallback": { "type": "static", "attr": "" } }, { "header": "Volume", "type": "product", "attr": "custom.geVolume", "fallback": { "type": "static", "attr": "" } }, { "header": "Weight (*)", "type": "weight", "attr": "custom.geWeight", "unit": "kg", "fallback": { "type": "static", "attr": "" } }, { "header": "OriginCountry (ISO3) (*)", "type": "product", "attr": "custom.manufacturerCountryCode", "fallback": { "type": "static", "attr": "" } }, { "header": "IsBlocked (*)", "type": "product", "attr": "custom.geIsBlocked", "fallback": { "type": "static", "attr": "" } }, { "header": "IsVirtual", "type": "product", "attr": "custom.geIsVirtual", "fallback": { "type": "static", "attr": "0" } }, { "header": "VATRate", "type": "tax" }, { "header": "Price", "type": "price", "attr": "gbp-sale-prices", "fallback": { "type": "product", "attr": "priceModel.price.value", "fallback": { "type": "static", "attr": "0" } } }, { "header": "Keywords", "type": "static", "attr": "" }, { "header": "Size", "type": "variationAttribute", "attr": "size", "value": "value" }, { "header": "Color", "type": "variationAttribute", "attr": "color", "value": "value" }, { "header": "ProductURL", "type": "productUrl", "attr": "pid", "controller": "Product-Show", "host": "www.example.com" }, { "header": "ImageURL", "type": "imageUrl" } ] }, "feedData": { "localeId": "default", "catalogId": "storefront-catalog-m-non-en", "processOnlyModifiedProducts": true } } ``` The `impex`, `sftpCredentialIDs`, `file`, `file.name`, `file.columns`, `feedData`, and `feedData.localeId` keys are required. Other keys (such as `file.type`, `file.separator`, `file.quote`, and most `feedData.*` flags) are optional and fall back to defaults — see the tables below. ### Top-level settings | Field | Type | Description | Mandatory | Sample | | - | - | - | - | - | | impex | object | IMPEX folder settings | yes | — | | impex.folderPath | string | Folder under IMPEX where generated files are stored | yes | `/globale/catalog/` | | impex.archiveFolderPath | string | Folder where uploaded files are archived | yes | `/globale/catalog/archive/` | | sftpCredentialIDs | array | Service credential IDs for SFTP upload | yes | `["Globale-SFTPCatalogFeedUpload"]` | | file | object | Output file settings | yes | — | | file.name | string | Generated file name pattern | yes | `globale_catalog_feed_{datetime}` | | file.type | string | File format | no | `csv` | | file.separator | string | Column delimiter | no | `,` | | file.quote | string | Quote character | no | `"` | | file.columns | array | Column definitions | yes | `[]` | | feedData | object | Catalog extraction settings | yes | — | | feedData.catalogId | string | Catalog ID for product extraction | no | `{{site-catalog-id}}` | | feedData.localeId | string | Locale for generated content | yes | `default` | | feedData.processOnlyModifiedProducts | boolean | Delta mode — only modified products since last run | yes | `false` | | feedData.processProductsPerRunCount | number | Products processed per run | no | `0` | | feedData.processOnlyOnlineProducts | boolean | Online products only | no | `false` | | feedData.addMasterProducts | boolean | Include master products | no | `false` | | feedData.addVariationGroupProducts | boolean | Include variation group products | no | `false` | ### Column types Each CSV column is built from a `type` entry in `file.columns`: | Type | Description | Example | | - | - | - | | product | Value from a product attribute (`attr`) | `{"type": "product", "attr": "custom.hsCode"}` | | weight | Product weight with unit conversion (`unit`: `kg` → grams in output) | `{"type": "weight", "attr": "custom.geWeight", "unit": "kg"}` | | category | Value from product category attribute | `{"type": "category", "attr": "displayName"}` | | tax | Product tax rate | `{"type": "tax"}` | | price | Price from price book ID in `attr` | `{"type": "price", "attr": "gbp-sale-prices"}` | | variationAttribute | Variation attribute value | `{"type": "variationAttribute", "attr": "size", "value": "value"}` | | productUrl | Product URL from controller and host | `{"type": "productUrl", "attr": "pid", "controller": "Product-Show", "host": "www.example.com"}` | | imageUrl | Product image URL | `{"type": "imageUrl"}` | | preference | Site preference value | `{"type": "preference", "attr": "geClientJsMerchantId"}` | | static | Literal value from `attr` | `{"type": "static", "attr": ""}` — use for empty ImageURL in delta mode | | custom | Value from a custom handler **module path** (the module exports `getValue(product)`) | `{"type": "custom", "handler": "*/cartridge/scripts/globale/customHandler"}` | | code | **Inline** handler expression evaluated against `column` and `product` | `{"type": "code", "handler": "return (product.custom.product_online_patina ? '1' : '')"}` | The `product`, `price`, and `weight` types support nested `fallback` chains; the `custom` and `code` types fall back to their configured `fallback` only if the handler throws. ### Nested fallback example Look up a GBP price book first; if missing, use the product default price; otherwise `0`: ```javascript theme={null} { "type": "price", "attr": "gbp-sale-prices", "fallback": { "type": "product", "attr": "priceModel.price.value", "fallback": { "type": "static", "attr": "0" } } } ``` ## SFTP service credential Set SFTP credentials from Global-e in service credential **Globale-SFTPCatalogFeedUpload** (the credential ID referenced by `sftpCredentialIDs` in `geCatalogFeedConfig`). At runtime the upload step uses the generic **Globale-SFTPUpload** service with this credential ID. **Administration → Operations → Services → Service Credentials → Globale-SFTPCatalogFeedUpload** Set URL, username, and password from Global-e on that credential (URL empty is not used for SFTP host — use the credential host/user/password fields as provided). ## Testing 1. Confirm **Catalog Feed Configuration** (`geCatalogFeedConfig`) is set under **Merchant Tools → Site Preferences → Custom Site Preference Groups → Global-e Catalog Jobs**. 2. Open **Administration → Operations → Jobs → GlobaleCatalogFeed**. 3. Run **GlobaleCatalogFeed** (Run Now or wait for the schedule). 4. After the job completes, verify the CSV file appears on the configured SFTP location. # GlobaleCouponRedemptions Source: https://docs.global-e.com/globale-coupon-redemptions-sfcc This optional job updates coupon redemption status when coupons are applied during Global-e order failover. It is **not** included in the default `metadata/jobs.xml`; import and schedule it when coupon verification during failover is required. See also: [Jobs overview](/jobs-sfcc), [Promotions](/promotions-sfcc), [Failover and recovery](/failover-sfcc). ## Use case A merchant has coupon codes with redemption limits (per code, customer, or time frame) assigned to a specific SFCC customer group (not **Everyone**) or a source code. If the OrderCreate API fails, Global-e recreates the order using a fallback scenario (SendOrderToMerchant payload). In that scenario there is no customer session, so customer-group-based coupon redemption cannot run on the new basket. Global-e applies the discount via custom price adjustments and creates `GLOBALE_COUPON_REDEMPTIONS` custom objects (order number, customer email, coupon code, coupon ID). **GlobaleCouponRedemptions** reads those custom objects, writes an XML file with redemption records, and imports it using the standard **ImportCouponCodeRedemptions** step (`MERGE` mode). After a successful import, the custom objects are deleted. ## Overview Typical setup that needs this job: * Coupon codes with redemption limits (per code, customer, or time frame). * Coupon assigned to a campaign/promotion scoped to a specific customer group (not **Everyone**) with Required Qualifiers **All**. ## Job steps | Step | Step type | Description | | - | - | - | | GlobaleGenerateCouponRedemptionsXML | `custom.GlobaleGenerateCouponRedemptionsXML` | Queries `GLOBALE_COUPON_REDEMPTIONS` custom objects and writes redemption XML to IMPEX | | ImportCouponCodeRedemptions | `ImportCouponCodeRedemptions` | Imports the generated XML with merge mode | ## Creating the job This job is not shipped in `metadata/jobs.xml`; only the step type is provided by the cartridge. In Business Manager, create a new job with the ID **GlobaleCouponRedemptions** and add the two steps above in order: * **GlobaleGenerateCouponRedemptionsXML** — add custom step `custom.GlobaleGenerateCouponRedemptionsXML`. * **ImportCouponCodeRedemptions** — add the standard SFCC step and point it at the file written by the previous step, with import mode **MERGE**. Assign the job flow only to Global-e operated sites. See [Configuration → Scheduled Jobs](/configuration-sfcc#scheduled-jobs-administration--operations--jobs) for Business Manager setup. ## Configuration 1. Set site preference **Enable Coupon Verification** (`geEnableCouponVerification`) to **Yes** under **Merchant Tools → Site Preferences → Custom Site Preference Groups → Global-e Settings**. 2. Configure the **GlobaleCouponRedemptions** job steps in Business Manager as described above. ## Notes Creating coupon redemption records via this import path does not appear in SFCC Business Reports and Dashboards. It does record the redemption so the platform can enforce limits on subsequent redemption attempts with the same code. ## External references * [Import external coupon redemptions](https://help.salesforce.com/s/articleView?id=sf.b2c_rn_import_external_coupon_redemptions.htm\&type=5) (Salesforce B2C Commerce documentation) * [Coupon redemption IML schema](https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/xsd/couponredemption.xsd) # GlobaleOrderNotifications Source: https://docs.global-e.com/globale-order-notifications-sfcc This job is part of the default Global-e SFCC cartridge functionality. **GlobaleOrderNotifications** sends order update notifications from SFCC to Global-e when such notifications are in the integration scope. Each job step processes notification custom objects created when the corresponding outbound hook is invoked. Schedule the job to run every 15 minutes when outbound notifications are enabled. See also: [Jobs overview](/jobs-sfcc), [Order lifecycle](/order-lifecycle-sfcc), [Hooks](/hooks-sfcc). ## Job steps | Step | Step type | Default in `jobs.xml` | Description | | - | - | - | - | | UpdateOrderStatus | `custom.GlobaleUpdateOrderStatus` | Enabled | Sends order status updates (for example, cancellation) to Global-e | | UpdateOrderDispatch | `custom.GlobaleUpdateOrderDispatch` | Enabled | Sends `UpdateOrderDispatchV2` notifications | | CreateOrderRefund | `custom.GlobaleCreateOrderRefund` | Enabled | Sends `CreateOrderRefund` notifications | | UpdateRMA | `custom.GlobaleUpdateRMA` | Disabled (`geDisableJobStep: true`) | Sends RMA update notifications | | UpdateParcelStatus | `custom.GlobaleUpdateParcelStatus` | Not in default `jobs.xml` | Sends parcel status updates (add to job definition when required) | Payload formats for each notification type are defined in the corresponding Global-e API documentation (UOS, UODv2, COR, UpdateRMA, UpdateParcelStatus), which is not included in the cartridge package. ## UpdateOrderStatus When an order is cancelled on the SFCC side, send an order status update notification to Global-e (depending on integration scope). ### How it works 1. Trigger the custom hook `globale.outboundOrderStatusUpdate` when an order is cancelled, using `globaleHooksHelper`: ```javascript theme={null} var globaleHooksHelper = require('*/cartridge/scripts/helpers/globaleHooksHelper'); var globaleHelpers = require('*/cartridge/scripts/helpers/globaleHelpers'); globaleHooksHelper.invokeCustomHook( globaleHelpers.hooks.jobs.outboundOrderStatusUpdate, 'GE10080871180GB', { OrderId: 'GE10080871180GB', OrderStatus: { OrderStatusCode: 'CANCELLED', Name: 'CANCELLED' }, OrderStatusReason: { OrderStatusReasonCode: 'CANCELLED', Name: 'CANCELLED' } } ); ``` 2. The hook creates a notification custom object that this job step sends to the Global-e API. ### Required customization Trigger `globale.outboundOrderStatusUpdate` with the correct order number and payload when an order is cancelled on the SFCC side. ## UpdateOrderDispatch When an order is dispatched, send an order dispatch notification to Global-e. ### How it works Trigger `globale.outboundOrderDispatchUpdate`: ```javascript theme={null} var globaleHooksHelper = require('*/cartridge/scripts/helpers/globaleHooksHelper'); var globaleHelpers = require('*/cartridge/scripts/helpers/globaleHelpers'); globaleHooksHelper.invokeCustomHook( globaleHelpers.hooks.jobs.outboundOrderDispatchUpdate, 'GE10083988760GB', { OrderId: 'GE10083988760GB', IsCompleted: true, Parcels: [{ ParcelCode: 'GE10083988760GB', Products: [{ DeliveryQuantity: 1, ProductCode: '793775370033M' }] }] } ); ``` ### Required customization Trigger `globale.outboundOrderDispatchUpdate` when a dispatch notification should be sent. ## CreateOrderRefund When an order refund should be issued, send a refund notification to Global-e. ### How it works Trigger `globale.outboundOrderRefundUpdate`. The payload must include `header` and `body` properties: ```javascript theme={null} var globaleHooksHelper = require('*/cartridge/scripts/helpers/globaleHooksHelper'); var globaleHelpers = require('*/cartridge/scripts/helpers/globaleHelpers'); globaleHooksHelper.invokeCustomHook( globaleHelpers.hooks.jobs.outboundOrderRefundUpdate, 'GE10083988760GB', { header: { OrderId: 'GE10083988760GB' }, body: [{ CartItemId: 1, RefundQuantity: 1 }] } ); ``` ### Required customization Trigger `globale.outboundOrderRefundUpdate` when a refund notification should be sent. ## UpdateRMA Sends RMA update notifications to Global-e. Use case: provide the merchant internal RMA number instead of the Global-e RMA number. Additional context may be available in your Global-e RMA integration documentation. ### How it works Trigger `globale.outboundOrderRMAUpdate`: ```javascript theme={null} var globaleHooksHelper = require('*/cartridge/scripts/helpers/globaleHooksHelper'); var globaleHelpers = require('*/cartridge/scripts/helpers/globaleHelpers'); globaleHooksHelper.invokeCustomHook( globaleHelpers.hooks.jobs.outboundOrderRMAUpdate, 'GE10084013107GB', { OrderId: 'GE10084013107GB', MerchantOrderId: '00042703', RMANumber: '277145', MerchantRMANumber: 'RMA277145' } ); ``` Enable the **UpdateRMA** step in Business Manager (set `geDisableJobStep` to `false`) when this notification type is in scope. ### Required customization Trigger `globale.outboundOrderRMAUpdate` when an RMA notification should be sent. ## UpdateParcelStatus Sends parcel status update notifications to Global-e. Use case: update asynchronous parcel status when live API calls fail (for example, due to network issues). This step type is defined in the cartridge (`custom.GlobaleUpdateParcelStatus`) but is not included in the default `jobs.xml`. Add it to the **GlobaleOrderNotifications** job definition when required. ### How it works Trigger `globale.outboundParcelStatusUpdate`: ```javascript theme={null} var HookMgr = require('dw/system/HookMgr'); var orderId = 'GE101860768GB'; var parcelCode = 'someParcelCode'; var payload = { merchantParcelStatusCode: 'Delivered' }; var hookCallResult = HookMgr.callHook( 'globale.outboundParcelStatusUpdate', 'outboundParcelStatusUpdate', orderId, parcelCode, payload ); return hookCallResult; ``` If the live Global-e API call fails, a notification custom object is created for the job step to retry. ### Required customization Trigger `globale.outboundParcelStatusUpdate` when a parcel status notification should be sent. # GlobaleOrderStatusFallback Source: https://docs.global-e.com/globale-order-status-fallback-sfcc > [!NOTE] > > **Optional feature.** This job ships with the Global-e SFCC cartridges but is **disabled by default** and must **not** be turned on until Global-e has enabled SFTP order-status export for the merchant. See [Order status SFTP fallback](/order-status-sftp-fallback-sfcc). **GlobaleOrderStatusFallback** is a durable fallback for inbound Global-e → SFCC order status updates when the live webhook (`Globale-OrderUpdateStatus`) is unavailable or delayed. Global-e writes status-update JSON files to a shared SFTP folder. Each SFCC site flow downloads only files whose name starts with that site’s ID (`{SiteID}_…`), enqueues them as custom objects, then applies the same status-update logic used by the webhook. Already-applied updates are skipped using the `OrderStatusUpdateTime` token stored on the order. See also: [Optional feature overview](/order-status-sftp-fallback-sfcc), [Jobs overview](/jobs-sfcc), [Order lifecycle](/order-lifecycle-sfcc), [Metadata](/metadata-sfcc). ## When to use it Use this job only when: 1. Global-e has **enabled** SFTP export of failed/offline `UpdateOrderStatus` notifications for the merchant, and 2. SFTP host/credentials and remote folder have been agreed with Global-e, and 3. SFCC metadata/code for this feature is deployed and validated on a non-production instance. Keep the schedule **disabled** until those conditions are met. The live webhook remains the primary channel; this job is complementary and must not re-apply status updates the webhook already processed (deduplication is built in). ## Job steps | Step | Step type | Description | | - | - | - | | DownloadOrderStatusFiles | `custom.GlobaleDownloadOrderStatusFiles` | Lists the remote SFTP directory, downloads configured `{WebStoreCode}_*.json` files (bounded batch), then deletes or archives each remote file | | EnqueueOrderStatusFiles | `custom.GlobaleEnqueueOrderStatusFiles` | Parses local JSON files into `GLOBALE_INBOUND_ORDER_FALLBACK` custom objects; deletes local files after enqueue (or after logging invalid JSON) | | ProcessOrderStatusFallbackQueue | `custom.GlobaleProcessOrderStatusFallbackQueue` | Drains the CO queue in key order, applies each status update, removes the CO on success/dedup-skip/maxAttempts/invalid JSON; retains on retryable failure | Default site context in `metadata/jobs.xml` is `RefArchGlobal`. Replace it with your Global-e site ID(s). Add one job flow per SFCC site that should consume the feed. When Global-e `WebStoreCode` values differ from the SFCC site ID (or several codes map to one site), set the **`webStoreCodes`** step parameter. ## High-level flow 1. Global-e drops files named `{WebStoreCode}_{…}_{OrderStatusUpdateTime}.json` on SFTP (shared folder). 2. **Download** — for the current site context, only files whose name starts with a configured WebStoreCode prefix are downloaded to IMPEX. By default the prefix is the SFCC site ID; override with `webStoreCodes` when needed. Other prefixes stay on SFTP for their own flows. 3. **Enqueue** — each valid payload becomes a site-scoped `GLOBALE_INBOUND_ORDER_FALLBACK` custom object (key = file name). 4. **Process** — COs are applied in ascending key order (lexicographic = time order for fixed-width `OrderStatusUpdateTime`). Per-order short-circuit: if an earlier event for an order fails, later events for that same order are skipped this run so sequence is preserved. 5. On successful apply **or** dedup skip, SFCC best-effort calls Global-e **CreateOrderLog** (type `365`, `IsSuccess: true`). On apply failure (or invalid CO JSON), SFCC also best-effort logs with the same type (`IsSuccess: false`, `LogLevelId: 4`). ## Business Manager setup ### 1. Import metadata Import job, service, and custom-object metadata from the cartridge package (`metadata/jobs.xml`, `metadata/services.xml`, `metadata/meta/*`). Confirm: * Job **GlobaleOrderStatusFallback** exists under **Administration → Operations → Jobs** * Service **Globale-SFTPDownload** (SFTP) and **Globale-CreateOrderLog** (HTTP) exist under **Administration → Operations → Services** * Custom object type **GLOBALE_INBOUND_ORDER_FALLBACK** exists * Order attribute **geAppliedStatusOperationIds** exists (CSV of already-applied `OrderStatusUpdateTime` values) ### 2. Configure SFTP download credentials Open **Globale-SFTPDownload** credentials in Business Manager and set host, user, password (and path if required by your SFTP layout). The job step parameter `sftpCredentialID` defaults to `Globale-SFTPDownload`. ### 3. Configure CreateOrderLog (optional but recommended) Set the HTTP service base URL / credential for **Globale-CreateOrderLog** (`/GEPI/CreateOrderLog`) so fallback applies and apply failures can notify Global-e. Failures of this HTTP call never block status application. Keep **mock-mode** off in environments where you want real feedback to Global-e. ### 4. Configure the job step parameters On **DownloadOrderStatusFiles**: | Parameter | Default | Notes | | - | - | - | | `sftpCredentialID` | `Globale-SFTPDownload` | Must match a configured SFTP credential | | `remoteDir` | `/catalog/order-status` | Shared remote folder from Global-e | | `remoteFileHandling` | `Delete` | `Delete` (default) or `Archive` after successful download | | `remoteArchiveDir` | `/catalog/order-status/archive` | Used only when `remoteFileHandling` = `Archive` | | `maxFilesPerRun` | `100` | Caps files processed per run | | `webStoreCodes` | *(empty → current site ID)* | Comma-separated Global-e WebStoreCode prefixes for this flow (e.g. `RefArchGlobal,MyBrand-GBP`). Use when codes differ from the SFCC site ID or several codes belong to one site | | `geDisableJobStep` | `false` | Set `true` to skip a step without removing it | On **ProcessOrderStatusFallbackQueue**: | Parameter | Default | Notes | | - | - | - | | `maxAttempts` | `5` | Failed apply attempts per CO before the CO is removed (CreateOrderLog still sent). Platform retention (5 days) is a safety net if the job is off | | `geDisableJobStep` | `false` | Set `true` to skip a step without removing it | ### 5. Site flows and schedule * Assign each flow’s **site context** to the SFCC site that should apply the updates. * Set **`webStoreCodes`** when file prefixes are not identical to that site ID (supports multiple codes per site). * Recurring trigger is **disabled by default** (every 15 minutes when enabled), same pattern as **GlobaleOrderNotifications**. * Enable the trigger only after a successful manual run. ## IMPEX folder layout Per merchant / site: ```text theme={null} IMPEX/src/globale/orderStatusFallback/{merchantId}/{SiteID}/ └── *.json # inbound only (deleted after enqueue or on invalid JSON) ``` `merchantId` comes from site preference **Client JS Merchant Id** (`geClientJsMerchantId`). ## Custom object queue | Item | Value | | - | - | | Type | `GLOBALE_INBOUND_ORDER_FALLBACK` | | Scope | Site | | Retention | 5 days | | Key (`ID`) | Source file name | | Payload | `geNotificationPayload` (JSON text, webhook-equivalent body) | | Attempts | `geAttemptCount` (failed apply count; removed at `maxAttempts`) | ### CO lifecycle | Outcome | CO action | | - | - | | Status applied successfully | Removed; CreateOrderLog success | | Dedup skip (`OrderStatusUpdateTime` already on the order) | Removed; CreateOrderLog success | | Apply failed (attempt \< `maxAttempts`) | Retained; `geAttemptCount` incremented; later events for the same order short-circuited this run | | Apply failed (attempt ≥ `maxAttempts`) | Removed; failure CreateOrderLog; later events for the same order may proceed | | Invalid JSON in CO | Removed immediately; failure CreateOrderLog | ## Deduplication Both the webhook and this job record applied `OrderStatusUpdateTime` values in order custom attribute **geAppliedStatusOperationIds** (comma-separated). If the same token arrives again on either channel, the update is skipped and an order note is written. ## Logging and troubleshooting | Symptom | What to check | | - | - | | No files downloaded | `webStoreCodes` / site ID vs file names; `remoteDir`; SFTP credential; `maxFilesPerRun` | | Other site’s files left on SFTP | Expected — only configured WebStoreCode prefixes are downloaded | | Invalid / unparseable JSON | File deleted after error log; inspect **GLOBALE** logs (`GE_SFTP_FALLBACK_EnqueueOrderStatusFiles`); encoding should be UTF-8 | | CO retained across runs | Order missing in SFCC, MerchantGUID mismatch, or apply error in **GLOBALE** logs (`GE_SFTP_FALLBACK_*`); check `geAttemptCount` vs `maxAttempts` | | CO removed after repeated failures | Expected when `geAttemptCount` reaches `maxAttempts` — check CreateOrderLog / job log `exhausted` count | | Status not changing on duplicate file | Expected dedup — check `geAppliedStatusOperationIds` and order notes | | CreateOrderLog missing in Global-e | Service enabled, mock mode off, API host/cred; apply still succeeds without it | Configure the **GLOBALE** custom log under **Administration → Site Development → Development Setup → Custom Log Settings**. # GlobaleProducts Source: https://docs.global-e.com/globale-products-sfcc This job is part of the default Global-e SFCC cartridge functionality. **GlobaleProducts** pulls product restrictions and end-customer country product VAT rates (when configured on the Global-e side) and stores them in product custom attributes: * **Global-e RestrictedCountries** (`geRestrictedCountries`) * **Global-e Is Forbidden** (`geIsForbidden`) * **Global-e VAT Rates** (`geVatRates`) For how restrictions affect the storefront, see [Restricted / forbidden products](/restricted-products-sfcc). See also: [Jobs overview](/jobs-sfcc), [GlobaleCatalogFeed](/globale-catalog-feed-sfcc) (catalog export flow). ## Job steps | Step | Step type | Description | | - | - | - | | LoadRecentProductCountryData | `custom.GlobaleLoadRecentProductCountryS` | Loads product data from Global-e API `/Browsing/RecentProductCountryS` (delta mode); writes CSV feeds to IMPEX | | ImportRecentProductCountryData | `custom.GlobaleImportRecentProductCountryS` | Imports CSV feeds and updates `geRestrictedCountries`, `geIsForbidden`, and `geVatRates` on products | | ArchiveRecentProductCountryData | `custom.GlobaleArchiveRecentProductCountryS` | Moves processed CSV feeds to the archive folder | ## Configuration ### SFCC staging 1. Navigate to **Administration → Operations → Services → Service Credentials**. 2. Update the service credential with ID **Globale-RecentProductCountryS**: | Preference | Value | | - | - | | URL | `https://api.global-e.com/Browsing/RecentProductCountryS` | | User | Empty | | Password | Global-e **production** Merchant GUID | ### SFCC development No change to the default credential configuration is required. **Important:** schedule this job on **staging and development instances only**. Configure staging to pull from the Global-e production account; product attribute data is replicated to production during SFCC catalog replication. ### Multi-account service credentials When multiple Global-e merchant accounts are used across SFCC sites, add site-specific service credentials. The cartridge resolves the credential automatically: for any Global-e service it first tries `[BaseServiceID]-[geClientJsMerchantId]` (the **Client JS Merchant ID** site preference for the current site) and falls back to the base credential ID if the suffixed one does not exist. Add credentials using the pattern `[BaseServiceID]-[geClientJsMerchantId]`, for example (where `123`/`456` are the `geClientJsMerchantId` values configured on each site): * `Globale-RecentProductCountryS-123` * `Globale-RecentProductCountryS-456` Set the correct **Client JS Merchant ID** (`geClientJsMerchantId`) per site. Coordinate with the Global-e integration team to validate SFCC site ↔ Global-e merchant mappings. # GlobaleRestrictedItemsFeed Source: https://docs.global-e.com/globale-restricted-items-feed-sfcc **GlobaleRestrictedItemsFeed** generates a restricted-items CSV from SFCC catalog data and uploads it to an SFTP folder configured in site preferences. Global-e retrieves the file from that location, classifies the restrictions, and returns the resulting product classification and restriction information to SFCC (imported by [GlobaleProducts](/globale-products-sfcc)). This job is **not** part of `metadata/jobs.xml`; create it manually in Business Manager (see [Creating the job](#creating-the-job)). See also: [Jobs overview](/jobs-sfcc), [GlobaleCatalogFeed](/globale-catalog-feed-sfcc) (catalog export), [GlobaleProducts](/globale-products-sfcc) (restriction import), [Restricted / forbidden products](/restricted-products-sfcc), [Configuration](/configuration-sfcc). ## Overview The job processes each product created or modified since the last run and writes restriction details to a CSV file. That file is uploaded to a pre-defined SFTP folder hosted by the merchant or Global-e. A Global-e service watches the SFTP folder and processes each new and updated restricted item through its classification procedures. A separate Global-e job then queries the Global-e API to return product classification and restriction information to SFCC. The job has two steps: | Step | Step type | Description | | - | - | - | | GenerateRestrictedItemsFeed | `custom.GlobaleGenerateRestrictedItemsFeed` | Builds the restricted-items CSV from `geRestrictedItemsFeedConfig` and writes it to the IMPEX folder | | UploadRestrictedItemsFeed | `custom.GlobaleUploadRestrictedItemsFeed` | Uploads the generated file from IMPEX to the SFTP location configured in site preferences | 1. **GenerateRestrictedItemsFeed** — builds the CSV from site preference **Restricted Items Feed Configuration** (`geRestrictedItemsFeedConfig`) and writes it under IMPEX. 2. **UploadRestrictedItemsFeed** — uploads that file from IMPEX to the configured SFTP folder so Global-e can retrieve it. ## Creating the job In Business Manager, create a new job with the ID **GlobaleRestrictedItemsFeed** and add the two custom steps above: * **GenerateRestrictedItemsFeed** — add custom step `custom.GlobaleGenerateRestrictedItemsFeed`. * **UploadRestrictedItemsFeed** — add custom step `custom.GlobaleUploadRestrictedItemsFeed`. Assign the job flow only to Global-e operated sites. See [Configuration → Scheduled Jobs](/configuration-sfcc#scheduled-jobs-administration--operations--jobs) for Business Manager setup. ### Run in full export mode When delta mode is enabled, the generate step processes only products whose **lastModified** system attribute changed since the last run. Price changes are stored on the **PriceBook**, not the **Product**, so products with updated prices are *not* picked up in delta mode. If your restriction logic depends on price-related conditions (see the [Source Handler](#source-handler)), always run the job in full export mode (`deltaMode.processOnlyModifiedProducts = false`). ## Report requirements | Requirement | Value | | - | - | | File name | `{MerchantName}Restrictions_ddmmyyyyhhmm.csv` (merchant name from Global-e merchant settings) — e.g. `MyToysStoreRestrictions_100220151738.csv` | | Schedule | May run at any time | | Format | CSV | | Upload target | Global-e SFTP, **or** the merchant's SFTP. For a merchant-hosted SFTP, Global-e requires write permissions to the manifest folder, and that folder must contain an `archive` sub-folder. | The number of lines in the feed equals the number of SKUs, brands, or categories restricted *per country*: * One SKU restricted in one country → one line. * One SKU restricted in ten countries → ten lines. * Five SKUs, one brand, and one category restricted in two countries → twelve lines (two lines each). ## Feed structure The generated CSV has **no header row**. Columns are described below as spreadsheet columns (A, B, C, …) for clarity only. | Column | Field | Required | Accepted values | | - | - | - | - | | A | SKU | Optional | Product code (SKU) provided by the merchant. Leave empty to not restrict by SKU. | | B | Brand | Optional | Brand code as provided in the product catalog. Leave empty to not restrict by brand. | | C | Category | Optional | Category code as provided in the product catalog. Leave empty to not restrict by category. | | D | Restriction Flag | **Mandatory** | `1` to enforce a restriction, `0` to remove a restriction. | | E | Country | **Mandatory** | Country ISO code (Alpha-2 or Alpha-3), or `ALL` for every country currently operated by Global-e. | | F | State | Optional | Relevant state code. | **Exactly one** of columns A, B, or C must be populated per line. In a mixed feed, restrict each product by only one type per line — e.g. SKU restrictions populate column A (B and C empty), category restrictions populate column C (A and B empty). ### Variations (variation masters) For configurable products (variation masters): * To restrict only some variations, list the SKUs of those variations. * To restrict all variations, list the SKUs of all variations **and** the master product SKU. ### Restriction precedence If at least one rule applies to a product (by SKU, brand, or category), the product is restricted: * If brand `NIKE` is restricted for all countries and SKU0001 (a Nike product) is *not* restricted in France, the brand rule wins — SKU0001 stays restricted everywhere, including France. * If brand `NIKE` is *not* restricted anywhere but SKU0001 is restricted in France, SKU0001 is restricted only in France. * If brand `NIKE` is restricted for all countries and category `girl's shoes` is *not* restricted anywhere, all girl's-shoes products are unrestricted except those also in the Nike brand, which stay restricted everywhere. * If category `girl's shoes` is restricted for all countries and SKU0001 (a girl's shoe) is *not* restricted in France, SKU0001 stays restricted everywhere, including France. If a product is prohibited from being sold via Global-e, removing a per-country restriction for it has no effect — it remains restricted. ## Examples ### Standard SKU, brand, and category restrictions Restrict SKU001 in China, Cuba, Denmark; SKU002 in China, Cuba; Brand001 in China, Cuba; Category001 in China, Cuba, Denmark, France; and remove the restriction of SKU003 in Brazil: | A | B | C | D | E | | - | - | - | - | - | | SKU001 | | | 1 | CHN | | SKU001 | | | 1 | CUB | | SKU001 | | | 1 | DNK | | SKU002 | | | 1 | CHN | | SKU002 | | | 1 | CUB | | | Brand001 | | 1 | CHN | | | Brand001 | | 1 | CUB | | | | Category001 | 1 | CHN | | | | Category001 | 1 | CUB | | | | Category001 | 1 | DNK | | | | Category001 | 1 | FRA | | SKU003 | | | 0 | BRA | ### Configurable product restriction A golf glove (master SKU0001) with size (S/M/L) and hand (L/R) variations: `SKU0001SLH`, `SKU0001MLH`, `SKU0001LLH`, `SKU0001SRH`, `SKU0001MRH`, `SKU0001LRH`. Restrict only left-hand gloves in China (3 variation SKUs): | A | B | C | D | E | | - | - | - | - | - | | SKU0001SLH | | | 1 | CHN | | SKU0001MLH | | | 1 | CHN | | SKU0001LLH | | | 1 | CHN | Restrict all golf gloves in China (6 variation SKUs **plus** the master SKU): | A | B | C | D | E | | - | - | - | - | - | | SKU0001SLH | | | 1 | CHN | | SKU0001MLH | | | 1 | CHN | | SKU0001LLH | | | 1 | CHN | | SKU0001SRH | | | 1 | CHN | | SKU0001MRH | | | 1 | CHN | | SKU0001LRH | | | 1 | CHN | | SKU0001 | | | 1 | CHN | ### Country / state restrictions Restrict SKU001 in all US states and SKU002 in NY and CA; remove the restriction for SKU003 in all US states and SKU004 in NY and CA: | A | B | C | D | E | F | | - | - | - | - | - | - | | SKU001 | | | 1 | US | | | SKU002 | | | 1 | US | NY | | SKU002 | | | 1 | US | CA | | SKU003 | | | 0 | US | | | SKU004 | | | 0 | US | NY | | SKU004 | | | 0 | US | CA | ## Configuration Feed settings are stored in site preference **Restricted Items Feed Configuration** (`geRestrictedItemsFeedConfig`) under **Merchant Tools → Site Preferences → Custom Site Preference Groups → Global-e Catalog Jobs**. Example configuration: ```javascript theme={null} { "impex": { "folderPath": "/src/globale/restrictions", "archiveFolderPath": "/src/globale/restrictions/archive", "fileName": "SFCCRestrictions_{datetime}", "fileType": "csv" }, "sftpCredentialIDs": ["Globale-SFTPRestrictionsFeedUpload"], "file": { "catalogId": "storefront-catalog-m-non-en", "separator": ",", "quote": "\"", "locale": "default" }, "deltaMode": { "processOnlyModifiedProducts": true, "productsCountPerOneRun": 0, "productsStartPosition": 0 }, "scenarios": { "enabledBrandsScenario": true, "enabledCategoriesScenario": true, "enabledProductsScenario": true }, "countriesExclusions": { "brands": { "brand1": "DE", "brand2": "EN,US,CN" }, "categories": { "category1": "EN,CN", "category2": "DE,CN" } } } ``` | Field | Type | Description | Mandatory | | - | - | - | - | | impex | object | IMPEX configuration | Yes | | impex.folderPath | string | Directory where generated restriction files are stored | Yes | | impex.archiveFolderPath | string | Directory where archived restriction files are stored | No | | impex.fileName | string | Generated file name pattern | Yes | | impex.fileType | string | Restriction file type | No | | sftpCredentialIDs | array | SFCC service credential IDs used to upload the feed (e.g. `["Globale-SFTPRestrictionsFeedUpload"]`) | Yes | | file | object | Generated file configuration | Yes | | file.catalogId | string | Catalog ID iterated to generate the product information; defaults to all products assigned to the site | No | | file.separator | string | Column separator | No | | file.quote | string | Quote character | No | | file.locale | string | SFCC locale used during generation | No | | deltaMode | object | Delta-mode configuration | No | | deltaMode.processOnlyModifiedProducts | boolean | Process only products modified since the last run (see the [full-export note](#run-in-full-export-mode)) | No | | deltaMode.productsCountPerOneRun | number | Number of products to process per run (`0` = no limit) | No | | deltaMode.productsStartPosition | number | Starting position for processing products | No | | scenarios | object | Scenario configuration | Yes | | scenarios.enabledBrandsScenario | boolean | Enable the brands scenario | Yes | | scenarios.enabledCategoriesScenario | boolean | Enable the categories scenario | Yes | | scenarios.enabledProductsScenario | boolean | Enable the products scenario | Yes | | countriesExclusions | object | Previous restricted-country values for brands/categories (auto-populated; see below) | No | | countriesExclusions.brands | object | Restricted countries for specific brands | No | | countriesExclusions.categories | object | Restricted countries for specific categories | No | ## SFTP service credential Set the SFTP credentials provided by Global-e in service credential **Globale-SFTPRestrictionsFeedUpload** (the credential ID referenced by `sftpCredentialIDs`): **Administration → Operations → Services → Service Credentials → Globale-SFTPRestrictionsFeedUpload** Contact Global-e for the URL, username, and password values. ## Custom object `GLOBALE_RESTRICTED_ITEMS` The custom object `GLOBALE_RESTRICTED_ITEMS` holds the configuration used to manage the brands, categories, and products scenarios. Import `demo.customobjects.restricteditems.xml` from the `metadata` folder to create three entities: * `brands` * `categories` * `products` Each entity has two custom attributes: ### Source Handler `Source Handler (sourceHandler)` is used exclusively by the **products** scenario to resolve the list of country codes that should be restricted for a product. It must **return a single comma-separated string of country codes**, or `ALL` when all countries are restricted — for example `"US,GB"`, `"ALL"`, or `"US_NY,US_CA"` for state restrictions. Configure it on the `GLOBALE_RESTRICTED_ITEMS` custom object entity for the products scenario (**Merchant Tools → Custom Objects → GLOBALE_RESTRICTED_ITEMS**). For example, if the restricted countries are stored in a product custom attribute `restrictedCountries`, the Source Handler reads that attribute and returns the formatted string. If restrictions are stored in a different format, the Source Handler must convert them to the expected country-code string. > [!NOTE] > > **Price-related conditions.** If the Source Handler uses price-related conditions, run the job in **full export mode** — price updates occur on the PriceBook (not the Product), so price-affected products are skipped in delta mode. See [Run in full export mode](#run-in-full-export-mode). ### Countries Exclusions `Countries Exclusions (countriesExclusions)` is used by the **brands** and **categories** scenarios and stores the previous restricted-country values. **You do not set this manually** — the code populates it automatically once brand and category restrictions are applied to the generated file. ## Hidden metadata The job also uses these system object definitions, which are not assigned to any attribute group: * **Restricted Items Last Run (`geRestrictedItemsFeedLastRun`)** — site preference holding the timestamp of the last `GlobaleRestrictedItemsFeed` run. * **Countries Exclusions (`geCountriesExclusions`)** — product custom attribute holding the previous restricted-country values for the product (format `"US,GB"`, `"ALL"`, or `"US_NY,US_CA"` for state restrictions). # GlobaleSettings Source: https://docs.global-e.com/globale-settings-sfcc This job is part of the default Global-e SFCC cartridge functionality. **GlobaleSettings** pulls data from Global-e browsing APIs and stores it in SFCC custom objects used by pricing, checkout, and storefront logic. Run this job after metadata import and whenever Global-e configuration changes. It is the only Global-e job enabled by default in `metadata/jobs.xml`. After you complete the mandatory [Data API](/configuration-sfcc#data-api-mandatory-for-new-integrations) OCAPI setup, Global-e can also start this sync over OCAPI when configuration changes. See also: [Jobs overview](/jobs-sfcc), [Configuration](/configuration-sfcc), [Metadata → Scheduled jobs](/metadata-sfcc#scheduled-jobs). ## Job steps | Step | Step type | Description | | - | - | - | | AppSettings | `custom.GlobaleAppSettings` | Loads cached data from Global-e API `/Browsing/AppSettings` and `/Browsing/AppVersion` | | Countries | `custom.GlobaleCountries` | Loads cached data from Global-e API `/Browsing/Countries` | | CountryCoefficients | `custom.GlobaleCountryCoefficients` | Loads cached data from Global-e API `/Browsing/CountryCoefficients` | | Cultures | `custom.GlobaleCultures` | Loads cached data from Global-e API `/Browsing/LocationsDefaultCulturesList` | | Currencies | `custom.GlobaleCurrencies` | Loads cached data from Global-e API `/Browsing/Currencies` | | CurrencyRates | `custom.GlobaleCurrencyRates` | Loads cached data from Global-e API `/Browsing/CurrencyRates` | | RoundingRules | `custom.GlobaleRoundingRules` | Loads cached data from Global-e API `/Browsing/RoundingRules` | | ActiveHubDetails | `custom.GlobaleActiveHubDetails` | Loads cached data from Global-e API `/Browsing/ActiveHubDetails` | | GlobaleGenerateCachePriceBooksXML | `custom.GlobaleGenerateCachePriceBooksXML` | Seeds org preference `geCachePriceBooksConfiguration` for the site base currency, then generates cache price books IMPEX when cache price books are enabled | | GlobaleImportPriceBook | `ImportPriceBook` | Imports generated cache price book XML from IMPEX (`globale/pricebooks`) | | GlobaleUpdateCachePriceBooksConfigHash | `custom.GlobaleUpdateCachePriceBooksConfigHash` | Updates per-currency config hashes in `geCachePriceBooksConfiguration` after a successful import | | GlobaleSyncCachePriceBookCombinations | `custom.GlobaleSyncCachePriceBookCombinations` | Syncs country/currency → cache price book combinations into `GLOBALE_CACHE_PRICE_BOOK_COMBINATION` | | InvalidatePageCache | `InvalidateCache` | Invalidates SFCC page cache after settings refresh | ## Site context Assign **GlobaleSettings** job flows only to sites operated by Global-e. The sample `jobs.xml` uses a placeholder site ID (`RefArchGlobal`); replace it with your site IDs during deployment. If cache price books are enabled, the generate → import → update-hash → sync-combinations steps run as part of this job (in that order). See [Price calculation](/price-calculation-sfcc) for how cache price books affect browse-time pricing. ## Organization context (Business Manager cartridge path) Steps with `` (`GlobaleImportPriceBook`, `GlobaleUpdateCachePriceBooksConfigHash`) run in **organization** context. Custom steps resolve scripts from the **Business Manager** cartridge path (`Sites-Site`), not from storefront site cartridge paths. Ensure **`int_globale`** is on the BM cartridge path before running this job — configure manually in Business Manager or via `b2c sites cartridges add int_globale --bm --position first`. See [Cartridges](/cartridges-sfcc) § Business Manager cartridge path. # GlobalE.UpdatePaymentMethod Source: https://docs.global-e.com/globale-updatepaymentmethod > [!NOTE] > > This is a **client-side JavaScript SDK method**, not a REST endpoint. It has no OpenAPI spec and no request playground; the contract is documented here. ## Summary GlobalE.UpdatePaymentMethod starts the update-payment-method flow for a subscription. It loads a dynamic script, injects an iframe into a DOM container that you provide, and runs callbacks when the flow succeeds, is cancelled by the user, or fails. API source: `globale.merchant.client.js` (GEClient instance exposed as `GlobalE`). ## Signature ```js theme={null} GlobalE.UpdatePaymentMethod(subscriptionId, cultureCode, currencyCode, container, onSuccess, onCancelation, onFailure, merchantReturnUrl) ``` ## Parameters | Parameter | Location | Type | Required | Description | | - | - | - | - | - | | `subscriptionId` | Argument | string | Yes | Subscription ID to update the payment method for. | | `cultureCode` | Argument | string | No | Culture code (e.g., en-US). Default is base culture. | | `currencyCode` | Argument | string | No | Currency code (e.g., USD). Default is base currency. | | `container` | Argument | string | Yes | DOM element ID or selector where iframe will be injected. | | `onSuccess` | Argument | function | Yes | Callback when payment method updated successfully. | | `onCancelation` | Argument | function | Yes | Callback when user cancels the flow. | | `onFailure` | Argument | function | Yes | Callback when an error occurs. | | `merchantReturnUrl` | Argument | String | No | Absolute HTTPS URL where the customer should land after 3DS or payment-gateway redirect. If provided, Global‑e stores it for this subscription update and uses it for the post-redirect return (before the app-setting fallback). Must be a valid absolute URL. | ## Callbacks * `onSuccess(data)` – After the customer returns from redirect, when the flow completes successfully: * `data` is usually an object: `{ statusCode, subscriptionId }` — e.g. `{ statusCode: "Settled", subscriptionId: "your-subscription-id" }`. * In some cases `data` may still be a status string only (e.g. `"Settled"`). Integrators should support both: if `typeof data === "object" && data !== null && data.statusCode`, use `data.statusCode` and `data.subscriptionId`; otherwise treat `data` as the status string. * `onCancelation(info)` – `info` may be a status string (e.g. `'UserCanceled'`). * `onFailure(error)` – `error` usually contains `error.error` or `error.message` and possibly `error.details`. ## Callback responses | Result Code | Callback Invoked | Argument Passed | Description | | - | - | - | - | | Settled | onSuccess | Subscription id | The payment method was updated successfully and the transaction settled. | | PaymentDeclined | onFailure | `{ error: "PaymentDeclined" }` | The payment was declined by the provider (includes a failed fraud check / not-approved result). | | GeneralException | onFailure | `{ error: "GeneralException" }` | An unexpected error occurred while processing the update (catch-all server error). | | BillingCountryValidationFailed | onFailure | `{ error: "BillingCountryValidationFailed" }` | The billing country provided failed validation, so the payment method could not be updated. | | UserCanceled | onCancelation | `"UserCanceled"` | The shopper canceled the update flow before completing it. | ## Return from redirect * On a final status, the matching callback runs (onSuccess, onCancelation, or onFailure) * Global‑e then redirects the customer to your return URL (`merchantReturnUrl` if you supplied one, otherwise the default return URL set for your account) ## Clearing the flow `GlobalE.ClearUpdatePaymentMethod()` – removes the iframe and resets the state. Use when closing the flow or switching containers. ## Common errors * `'subscriptionId is required'` – subscriptionId was not provided. * Invalid `cultureCode` or `currencyCode` – must be non‑empty strings if provided. * Failed to initialize/execute UpdatePaymentMethod – script load or runtime error. # Google Pay Express Source: https://docs.global-e.com/google-pay-express ## Introduction Google Pay Express streamlines the checkout process, allowing shoppers to complete their purchases quickly and securely. ## How it Works When shoppers click the Google Pay Express button on the checkout page, they are redirected to the Google Pay wallet widget. Here, they can confirm their billing and shipping addresses, and contact details, and view the total amount, including shipping and taxes. In the case of Optional DDP, the customer pays D\&T on checkout. ## The Customer Journey Follow the steps below to pay with Google Pay Express. | 1. Select Google Pay from Checkout page. | 2. Confirm Google Pay. | 3. Enter/Select your payment method and shipping address. | 4. And that’s it! Your order is confirmed. | | - | - | - | - | | ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-972c4e6c-edaa-318c-d8e4-85e9e2d903fb.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=775ae9d895d9731d86f520f48b59442b) | ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e4e90c34-2437-ed17-65ae-1673d6d8684c.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=2f2a7e891ba8d36b2da9e3e40ded2700) | ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3d4c2c4e-21a1-b0d6-e97e-36892a6f744f.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=f131560b9f5597113bae7190a17b853f) | ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-83fa4df0-2382-89a8-1409-7abaeb771277.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=b6c74b7a929f8675739600f40ff2a933) | ## Supported Regions Google Pay Express is only available in countries with languages with Latin characters: > [card] > > * Armenia > * Australia > * Austria > * Azerbaijan > * Belgium > * Bulgaria > * Canada > * Croatia > * Cyprus > * Czechia > * Denmark > * Estonia > * Faroe Islands > * Finland > * France > * Georgia > * Germany > [card] > > * Greece > * Greenland > * Guernsey > * Hungary > * Iceland > * Ireland > * Isle of Man > * Italy > * Kazakhstan > * Latvia > * Liechtenstein > * Lithuania > * Luxembourg > * Malta > * Moldova > * Monaco > * Montenegro > [card] > > * Netherlands > * New Zealand > * Norway > * Poland > * Portugal > * Romania > * San Marino > * Serbia > * Slovakia > * Slovenia > * Spain > * Sweden > * Switzerland > * Ukraine > * United Kingdom > * United States ## Limitations Note the following limitations: * **Shipping Options**: "Pick from store"/ “Store Collection” is not supported. * **Additional Requirements:** If additional consent or ID information is required on the checkout page, Google Pay Express will not be available as this data cannot be collected from the wallet widget. ## Test Payments with Google Pay To test payments using Google Pay see [Test card suite | Google Pay API forAndroid | Google for Developers](https://developers.google.com/pay/api/android/guides/resources/test-card-suite). ### To test Payments with Google Pay 1. Click [Google Pay API Test Cards Allowlist - Google Groups](https://groups.google.com/g/googlepay-test-mode-stub-data?utm_source=chatgpt.com). 2. Login to your email account (does not have to be Gmail). 3. Click to join the group. 4. Simulate a payment with Google Pay: 1. Navigate to your online store. 2. Fill your cart. 3. Navigate to the **Checkout** page. 4. Select **Google Pay**. 5. Select the test credit card type and simulate transactions: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-31538583-aedb-13e6-db0a-62ddd818a185.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=60df50482c3f1740cc81089c43478c2e) > [!NOTE] > > To simulate 3DS flow, use American Express and Discover cards. # GST in Australia Source: https://docs.global-e.com/gst-in-australia As of 1 July 2018, an Australian **Goods and Services Tax (GST)** of 10% is applied to sales of low-value goods imported by customers into Australia (under AU\$ 1000). GST will also apply to any shipping or insurance costs associated with the purchase. As part of our service, Global‑e handles all GST regulation issues (registration with the Australian Taxation Office, applying necessary changes to commercial invoices, etc.) regarding sales to Australia. The GST on your sale will be calculated as 10% of the price that the customer pays. If the amount paid includes fees for shipping or insurance, these are included in the price of the goods when calculating the GST. For **EU merchants** who don’t deduct local VAT on sales outside of the EU, the margin for Australia is lower due to GST applied. For example, for UK merchants selling to Australia, instead of the 20% margin they are receiving from non-EU sales, the margin to Australia will be just 10%. To increase your margins on sales to Australia (or other countries) you can use our country coefficient tool. For **non-EU merchants** who don’t want to absorb the 10% GST to Australia, we advise using the country coefficient tool and applying a 10% increase in price for products in this country. # Headless Source: https://docs.global-e.com/headless-integration If you have a headless website, configure it as detailed in this section. Implement the following elements on your custom front end. ## Localised Checkout When building the checkout object, make sure to add the object's relevant attributes to prevent the price and locale of the customer from falling back to domestic. It is important to pass the correct `buyerIdentity` otherwise the checkout experience of the merchant remains the default country and default currency of the website. See: [https://shopify.dev/api/examples/international-pricing#create-a-checkout](https://shopify.dev/api/examples/international-pricing#create-a-checkout) ## Geo-Detection and Redirection - Headless Storefronts You must implement geo-detection and redirection features using a custom or 3rd party solution that works with your headless storefront. See [Geo-Detection and Redirection](/geo-detection-and-redirection) for how this differs from Liquid storefronts. ## Marketing Banner The **Marketing Banner** shows the amount customers need to spend to get free shipping (in their own currency). For more information, please see [Marketing Banner](/marketing-banner). The following procedure lets you load the shipping banner to the front end. This procedure assumes that you have the required technical knowledge to implement this solution. **To add the marketing banner script to your website's front end:** 1. Create GLBE_PARAMS JavaScript variable on the site as follows: ``` GLBE_PARAMS = {   countryCode: "", // 2 letter country code selected by the customer   currencyCode: "", // 3 letter currency code   isExternal: true } ``` **Example:** ``` GLBE_PARAMS = {  countryCode: "CA",    currencyCode: "CAD",   isExternal: true} ``` 2. ONLY after GLBE_PARAMS variable is set, call Global-e script available as follows: **Production** ``` https://crossborder-integration.global-e.com/resources/js/app?shop= ``` **QA-INT** ``` https://crossborder-integration-qa-int.bglobale.com/resources/js/app?shop= ``` **Positioning the Marketing Banner** The [Marketing Banner](/marketing-banner) is inserted as the first element on your storefront. However, if this does not suit your store, Global-e can place the banner in a different location using the ID of an element. To insert the Marketing Banner in your preferred location on your storefront, add a new DIV element with a unique ID into your chosen location and share that ID with Global-e. This gives you complete control of the location of the banner and its position. **Example** ```
``` ## Website Adjustments (Headless Storefronts) ### Step 1. Price Conversion API Shopify converts the price base. To set up international prices on your local headless website and build your catalogue, get the relevant prices in the relevant currencies: extract the prices by calling the `productVariantByIdAndCountry` API. **Description:** This API passes the country code `variant Id` and returns the relevant price. You can extract more than one variant in a call. See [https://shopify.dev/api/examples/international-pricing#query-product-prices](https://shopify.dev/api/examples/international-pricing#query-product-prices) for more information. **Query:** ``` query productVariantByIdAndCountry($productVariantId: ID!, $countryCode: CountryCode!){ productVariant(id: $productVariantId) { contextualPricing(context: { country: $countryCode }) { price { amount currencyCode } } } } ``` **Variable:** ``` { "productVariantId": "gid://shopify/ProductVariant/000000000000", "countryCode": "GB" } ``` **Example Return Body:** ``` { "data": { "productVariant": { "contextualPricing": { "price": { "amount": "16.0", "currencyCode": "GBP" } } } } } ``` **Explicit Price Formatting** To prevent shopper confusion and increase international order conversion, use explicit price formatting where appropriate, according to [Shopify recommendations](https://polaris.shopify.com/foundations/formatting-localized-currency). This means displaying the currency code in addition to the currency symbol on collections pages, PDPs, search results, and order subtotals on the cart and mini-cart. ### Step 2. Country Selector If you have not done so yet, add a Country Selector to enable the customer to choose the preferred country. See [https://shopify.dev/api/examples/international-pricing#query-product-prices](https://shopify.dev/api/examples/international-pricing#query-product-prices) and [Step 3. Add a Country Selector](/storefront-modifications-liquid-storefronts#step-3--add-a-country-selector). To get the list of all countries available for the selector, place a GraphQL API call (See [https://shopify.dev/api/examples/international-pricing#query-available-countries-and-currencies](https://shopify.dev/api/examples/international-pricing#query-available-countries-and-currencies)). ### Step 3. Gift Card Tagging To prevent gift cards from receiving an inflated price due to country coefficients, you must add the product tag **`pc-glbe-giftcard`** to all your gift card products. Make sure to add this tag in both the sandbox and production environments. Please let your Global-e project team or CSM know when this is done so Global-e may complete the configuration on our side. ### Step 4. Gifts With Purchase and Free Sample Support To allow gifts with purchase and free samples to have international duties and taxes calculated correctly and prevent other downstream issues, there are two approaches: * The free products must be assigned a non-zero price and have a `100%` discount applied to them. * Alternatively, the free product can have a price of `zero ("0")` if the configured “**Cost per item**” is non-zero. This method requires additional configuration from Global-e so please reach out to your Global-e project manager or CSM to enable it. Additionally, for either method the free products must be present inside the cart to ensure that they are transferred to Global-e's services. ### Step 5. Customer Privacy and Cookie Consent As an international merchant, protecting your customers' privacy is essential. Shoppers in many countries prioritize their privacy, often looking for features like cookie banners as indicators of trust before engaging with a store or making purchases. Shopify offers robust tools to safeguard customer privacy and obtain consent before collecting analytical data. These tools are fully compatible with the Global-e Shopify Native solution, ensuring seamless integration. It is important to note that if cookie consent is not collected, Shopify does not provide you with analytical data for the shopper’s session. Therefore, proper configuration is essential for tracking your storefront analytics. To implement a custom cookie banner or use Shopify's default banner for collecting analytical data from international customers, refer to the instructions in Shopify’s [Customer Privacy API](https://shopify.dev/docs/api/customer-privacy) documentation. Additionally, Global-e can integrate with your cookie consent solution to ensure that Global-e cookies comply with your customers' privacy choices. Reach out to your Global-e contact to discuss enabling this feature. ## Email Notifications Adjustments ### Include Duties in Your Email Templates The following templates are located under **Shopify Admin > Settings > Notifications**. * Order Confirmation * Order Cancellation * Pending Payment Success * Order Refund To include duties in your email templates, use the following code: ``` {% if current_total_duties or total_landed_cost_additional_fees %} {% assign total_duties_line = 0 %} {% if current_total_duties %} {% assign total_duties_line = total_duties_line | plus: current_total_duties %} {% endif %} {% if total_landed_cost_additional_fees %} {% assign total_duties_line = total_duties_line | plus: total_landed_cost_additional_fees %} {% endif %}

Duties

{{ total_duties_line | money }} {% endif %} ``` To exclude the Taxes line when the amount is 0, adjust your template as shown below: ``` {% if tax_price > 0 %}

Taxes

{{ tax_price | money }} {% endif %} ``` ## Customizable Products If you sell customizable products (e.g., monogramming, etching, or embroidering names) for which you do not wish to accept returns, you can use a Global-e feature to indicate those products as non-returnable. To implement this feature: 1. Decide on a product tag to indicate a product is non-returnable. For example: **nonreturnable** or **finalsale**. 2. Tag your customizable products with your chosen tag by following the instructions [here.](https://help.shopify.com/en/manual/shopify-admin/productivity-tools/using-tags) 3. Inform Global-e of the tag you have chosen so that Global-e can configure the same tag in our system. Customers can now see your non-returnable tag when they view your items and they are prevented from returning the item after purchase. ## Shopping / Marketing Feeds (Headless) **Domestic Feeds** If you have implemented automatic Geo IP redirection on your storefront, you can update your domestic product links to include a country parameter to prevent Google feed violations. This requires that you add logic to your storefront to set the shopper’s session to match the country specified in the parameter and prevent Geo IP from firing. Example: [\{base_url}/\{product_url}?country=US](https://\{base_url}/\{product_url}?country=US) **International Feeds** If you plan to submit international product feeds, make sure to update your links to your products and your storefront logic so that when the shopper clicks the links, the country in the shopper’s session reflects the parameter or the country code embedded in the product path. Examples of product pages for Germany: * [https://merchant_url/collections/products/t-shirt?country=DE](https://merchant_url/collections/products/t-shirt?country=DE) * [https://merchant_url/en-de/collections/products/t-shirt](https://merchant_url/en-de/collections/products/t-shirt) * [https://merchant_url/de/collections/products/t-shirt](https://merchant_url/en-de/collections/products/t-shirt) ## Storefront Attribute Script The storefront attributes script is needed for Forter fraud and device detection features. To implement the storefront attributes script: 1. Add the following script tag to the head element of all storefront pages. Preferably, to the top of the HTML head section. Example for PROD. ``` ``` Use the following parameter values: | Parameter | Description | | - | - | | data-env | Global-e environment identifier. Can be one of the following values: "int" - Integration "prd" - Production | | data-mid | Encoded value of Global-e merchant ID. Note: You can get the encoded value from the mid-value in Global-e Admin, using Administrator credentials, from here: **Admin > System > Encode/Decode > Encode Number**.**Global-e can provide this value in case of any issue with user permissions accessing the admin page.** | | data-store | The Global-e merchant store identifier for merchants with multiple production stores. Optional. | | src | Environment URI. Can be one of the following: Integration: [https://bglobale.com/Scripts/Merchants/globale.merchant.storefront.js](https://bglobale.com/Scripts/Merchants/globale.merchant.storefront.js) Production: [https://web.global-e.com/Scripts/Merchants/globale.merchant.storefront.js](https://web.global-e.com/Scripts/Merchants/globale.merchant.storefront.js) | 2. Add listener to `geCartAttributes` event (sample code provided below). When `geCartAttributes` event is triggered, use [Shopify Storefront API](https://shopify.dev/docs/api/storefront/2024-07/mutations/cartAttributesUpdate) `cartAttributesUpdate` to update the Shopify cart with the same attributes provided by the `geCartAttributes` event. **GeCartAttributes event data structure** ``` { eventId:string, attributes:[ {key:string, value:string} ] } ``` **Sample event** ``` { "eventId": "23lkj4lk32j4" "attributes": [ { "key": "key1", "value": "value" }, { "key": "key2", "value": "value" } ] } ``` **Sample event handling code** ``` document.addEventListener( "geCartAttributes", (event) => { // use event.detail.attributes to set Shopify cart attributes - i.e. with GraphQL storefront API https://shopify.dev/docs/api/storefront/2023-07/mutations/cartAttributesUpdate }, false, ); ``` **Example** The storefront attributes script provides the following attributes which need to be updated on the Shopify cart. This allows Forter to relate the checkout with your cart token, and based on the customer’s activity before the transaction, Forter's fraud analysis is more accurate. ``` [ { "key": "frtToken", "value": "9cc7e27f99084f52803d0369256c4342_1725451213641__UDF43_9ck__tt" }, { "key": "isApplePay", "value": "false" }, { "key": "cartToken", "value": "Z2NwLWV1cm9wZS13ZXN0MTowMUo2WUFSUkQxTjk0V0FXNjI5VE1ZQzkxWA" }, { "key": "storeType", "value": "headless" } ] ``` > [!NOTE] > > Trigger the Global-e event `geMerchantSession` following any changes in event attribute values during the cart lifecycle, or on each page load. These event identifiers are used for Forter fraud detection and are shared with payment fraud service providers. 3. On Windows object, set the event message as global variable `geMerchantSession`. This ensures that Global-e can read the event in case `geMerchantSession` is fired before the Global-e script is loaded. **geMerchantSession event data structure** ``` { platformCartId: string, //shopify cart token cartId: string, //merchant managed cart id, can be same as Shopify cart token if no other card Id used by merchant sessionId:string //merchant managed customer session id } ``` **Sample event** ``` { "platformCartId": "234kn234io23j4", "cartId": "jkh324kj5h324jk5", "sessionId":"nssdfg09usdf0gklm43" } ``` **Sample event handling code** ``` window.geMerchantSession = { "platformCartId": "234kn234io23j4", "cartId": "jkh324kj5h324jk5", "sessionId":"nssdfg09usdf0gklm43" } document.dispatchEvent(new CustomEvent("geMerchantSession" , { bubbles: true, detail: window.geMerchantSession }); ``` # Hooks Source: https://docs.global-e.com/hooks-sfcc Global-e registers **platform hooks** (SFCC `dw.*` / `app.*`) in storefront cartridges and **custom hooks** (`globale.*`) invoked from `int_globale`. Storefront cartridges declare custom hooks in their `hooks.json` when an OOTB handler ships with the cartridge; all other `globale.*` hooks are extension points you implement in a project cartridge. See also: [Failover and recovery](/failover-sfcc) (fallback / SOTM), [Configuration](/configuration-sfcc) (`geCAPIType`: OCAPI vs SCAPI). > [!NOTE] > > Platform hook tables below are generated from cartridge `hooks.json` files. Regenerate: `node documentation-process/integration-guide/scripts/generate-hooks-md.mjs`. ## Platform hooks ### SiteGenesis (`int_globale_sitegenesis`) Registration: `int_globale_sitegenesis/package.json`, `int_globale_sitegenesis/cartridge/scripts/hooks.json` | Hook Name | Hook Script | Description | | - | - | - | | dw\.system.request.onRequest | int_globale_sitegenesis/cartridge/scripts/request/OnRequest | Performs main Global-e initialization on every storefront request | | dw\.order.calculate | int_globale_sitegenesis/cartridge/scripts/cart/calculate.js | Performs cart/basket price recalculation (when called from `int_globale`) | | dw\.order.createOrderNo | int_globale_sitegenesis/cartridge/scripts/hooks/order | Returns the SFCC order number to use during order creation | | dw\.ocapi.shop.order.beforePOST | int_globale_sitegenesis/cartridge/scripts/hooks/order | Called before an order is created from the basket | | dw\.ocapi.shop.order.afterPOST | int_globale_sitegenesis/cartridge/scripts/hooks/order | Called after an order was created from the basket | ### SiteGenesis Popups (`int_globale_sitegenesis_popups`) Registration: `int_globale_sitegenesis_popups/package.json`, `int_globale_sitegenesis_popups/cartridge/scripts/hooks.json` Optional popups-only cartridge. It registers its own `dw.system.request.onRequest` to perform Global-e initialization when the standard storefront cartridge is not deployed (welcome/shipping-switcher popups). Layer above the matching storefront cartridge. | Hook Name | Hook Script | Description | | - | - | - | | dw\.system.request.onRequest | int_globale_sitegenesis_popups/cartridge/scripts/request/OnRequest | Performs main Global-e initialization on every storefront request | ### SFRA (`int_globale_sfra`) Registration: `int_globale_sfra/package.json`, `int_globale_sfra/hooks.json` | Hook Name | Hook Script | Description | | - | - | - | | app.server.registerRoute | int_globale_sfra/cartridge/scripts/hooks/route | Registers SFRA routes used by Global-e controllers | | dw\.system.request.onRequest | int_globale_sfra/cartridge/scripts/hooks/request/OnRequest | Performs main Global-e initialization on every storefront request | | dw\.order.calculate | int_globale_sfra/cartridge/scripts/hooks/cart/calculate.js | Performs cart/basket price recalculation | | dw\.order.createOrderNo | int_globale_sfra/cartridge/scripts/hooks/order | Returns the SFCC order number to use during order creation | | dw\.ocapi.shop.order.beforePOST | int_globale_sfra/cartridge/scripts/hooks/order | Called before an order is created from the basket | | dw\.ocapi.shop.order.afterPOST | int_globale_sfra/cartridge/scripts/hooks/order | Called after an order was created from the basket | ### SFRA Popups (`int_globale_sfra_popups`) Registration: `int_globale_sfra_popups/package.json`, `int_globale_sfra_popups/hooks.json` Optional popups-only cartridge. It registers its own `dw.system.request.onRequest` to perform Global-e initialization when the standard storefront cartridge is not deployed (welcome/shipping-switcher popups). Layer above the matching storefront cartridge. | Hook Name | Hook Script | Description | | - | - | - | | dw\.system.request.onRequest | int_globale_sfra_popups/cartridge/scripts/hooks/request/OnRequest | Performs main Global-e initialization on every storefront request | ### Headless (`int_globale_headless`) Registration: `int_globale_headless/package.json`, `int_globale_headless/hooks.json` Use with `int_globale` for PWA, mobile, or other headless clients that consume Shop OCAPI. Pair with site preference `geCAPIType` = OCAPI (or SCAPI where applicable). | Hook Name | Hook Script | Description | | - | - | - | | dw\.order.createOrderNo | int_globale_headless/cartridge/scripts/hooks/order | Returns the SFCC order number to use during order creation | | dw\.ocapi.shop.customer.baskets.beforeGET | int_globale_headless/cartridge/scripts/hooks/customer/customerBasket | Called before customer baskets are retrieved | | dw\.ocapi.shop.customer.baskets.modifyGETResponse_v2 | int_globale_headless/cartridge/scripts/hooks/customer/customerBasket | Modifies the customer baskets GET response | | dw\.ocapi.shop.basket.beforeGET | int_globale_headless/cartridge/scripts/hooks/basket | Called before a basket is retrieved | | dw\.ocapi.shop.basket.modifyGETResponse | int_globale_headless/cartridge/scripts/hooks/basket | Modifies the basket GET response (Global-e session/pricing context) | | dw\.ocapi.shop.basket.beforePOST | int_globale_headless/cartridge/scripts/hooks/basket | Called before a basket is created | | dw\.ocapi.shop.basket.beforePOST_v2 | int_globale_headless/cartridge/scripts/hooks/basket | Called before a basket is created (v2) | | dw\.ocapi.shop.basket.modifyPOSTResponse | int_globale_headless/cartridge/scripts/hooks/basket | Modifies the basket POST response | | dw\.ocapi.shop.basket.beforePATCH | int_globale_headless/cartridge/scripts/hooks/basket | Called before a basket is updated | | dw\.ocapi.shop.basket.afterPATCH | int_globale_headless/cartridge/scripts/hooks/basket | Called after a basket is updated; sends the cart to Global-e when `c_geGetCartToken=true` | | dw\.ocapi.shop.basket.modifyPATCHResponse | int_globale_headless/cartridge/scripts/hooks/basket | Modifies the basket PATCH response | | dw\.ocapi.shop.basket.items.beforePOST | int_globale_headless/cartridge/scripts/hooks/basket/productItems | Called before product line items are added | | dw\.ocapi.shop.basket.items.modifyPOSTResponse | int_globale_headless/cartridge/scripts/hooks/basket/productItems | Modifies the product items POST response | | dw\.ocapi.shop.basket.item.beforePATCH | int_globale_headless/cartridge/scripts/hooks/basket/productItems | Called before a product line item is updated | | dw\.ocapi.shop.basket.item.modifyPATCHResponse | int_globale_headless/cartridge/scripts/hooks/basket/productItems | Modifies the product item PATCH response | | dw\.ocapi.shop.basket.item.beforeDELETE | int_globale_headless/cartridge/scripts/hooks/basket/productItems | Called before a product line item is removed | | dw\.ocapi.shop.basket.item.modifyDELETEResponse | int_globale_headless/cartridge/scripts/hooks/basket/productItems | Modifies the product item DELETE response | | dw\.ocapi.shop.basket.coupon.beforePOST | int_globale_headless/cartridge/scripts/hooks/basket/coupon | Called before a coupon is added to a basket | | dw\.ocapi.shop.basket.coupon.modifyPOSTResponse | int_globale_headless/cartridge/scripts/hooks/basket/coupon | Modifies the OCAPI response after adding a coupon | | dw\.ocapi.shop.basket.coupon.beforeDELETE | int_globale_headless/cartridge/scripts/hooks/basket/coupon | Called before a coupon is removed from a basket | | dw\.ocapi.shop.basket.coupon.modifyDELETEResponse | int_globale_headless/cartridge/scripts/hooks/basket/coupon | Modifies the OCAPI response after removing a coupon | | dw\.ocapi.shop.order.beforePOST | int_globale_headless/cartridge/scripts/hooks/order | Called before an order is created from the basket | | dw\.ocapi.shop.order.afterPOST | int_globale_headless/cartridge/scripts/hooks/order | Called after an order was created from the basket | | dw\.ocapi.shop.product.beforeGET | int_globale_headless/cartridge/scripts/hooks/product.js | Called before a product is retrieved | | dw\.ocapi.shop.product.modifyGETResponse | int_globale_headless/cartridge/scripts/hooks/product.js | Modifies the product GET response (Global-e pricing/availability) | | dw\.ocapi.shop.product_search.beforeGET | int_globale_headless/cartridge/scripts/hooks/productSearch.js | Called before a product search is executed | | dw\.ocapi.shop.product_search.modifyGETResponse | int_globale_headless/cartridge/scripts/hooks/productSearch.js | Modifies the product search GET response | | dw\.ocapi.shop.custom_object.modifyGETResponse | int_globale_headless/cartridge/scripts/hooks/customObject.js | Modifies custom object GET responses used by Global-e data feeds | ## Custom hooks Custom hooks use the `globale.*` namespace. They are invoked from `int_globale` via `HookMgr`. Register handlers in your project cartridge `hooks.json` (or in the storefront cartridge when extending OOTB behavior). **Registered in `int_globale/hooks.json` (core):** `globale.calculateBaseProductPrices`, `globale.calculateProductPrices`, `globale.calculateTax`, `globale.onBeforeCalculate`, `globale.onGetCountry`, `globale.onGetMerchantGuid`, `globale.onGetSendCartData`, `globale.onInitApplication`, `globale.outboundOrderDispatchUpdate`, `globale.outboundOrderRMAUpdate`, `globale.outboundOrderRefundUpdate`, `globale.outboundOrderStatusUpdate`, `globale.outboundParcelStatusUpdate`. **Registered in SFRA / SiteGenesis `hooks.json` (OOTB handlers):** `globale.customerRegistration`, `globale.customerVerification`, `globale.getAllowDirectCommunicationFromMerchant`, `globale.getAllowMailsFromMerchant`, `globale.getCookieConsent`, `globale.getGuestEmail`, `globale.getHubId`, `globale.getPliHubCode`, `globale.getProductImageUrl`, `globale.getProductInventoryListId`, `globale.getSendCartProductOriginalMerchantPriceForDuties`, `globale.getUrlParameters`, `globale.onBeforePlaceOrder`, `globale.onInit`, `globale.resetPriceBooks`, `globale.validateCart`. ### globale.onInit **Description** The custom hook is invoked after the integration initialization (on the first customer visit or when the country/currency is changed). OOTB it’s used to recalculate basket prices for the SGJC (SiteGenesis) architecture; the SFRA handler only stores the values on the session. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | initData | Object | Initialization data: `geEnabled`, `geCountry`, `geCurrency`, `geCulture`, `geLocale`, `geIsOperated`, `gePriceStrategy` | **Returns** Void. The hook handler result is not used further. ### globale.getGuestEmail **Description** The custom hook is invoked before the SendCart request and should be used to pre-populate the customer’s email field in the Global-e checkout (guest checkout scenario).\ OOTB the custom hook handler returns null. **Custom hooks handler arguments** No arguments are submitted to the hook handler. **Returns** The hook handler must return the guest customer email address if it was filled in by the customer before proceeding to the Global-e checkout or null. ### globale.getCustomerAddresses **Description** The custom hook is invoked before the SendCart request and should be used to return all the customer’s addresses (logged-in checkout scenario).\ OOTB the custom hook handler returns all the addresses stored in the SFCC customer’s address book and, if the address book is empty, falls back to the address stored on the customer profile. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | basket | dw\.order.Basket | The customer’s basket | **Returns** The hook handler must return null or the array of all customer’s addresses. ### globale.getUrlParameters **Description** The custom hook is invoked before the SendCart request and could be used to extend the Global-e UrlParameters SendCart payload property.\ It might be helpful in case some additional basket-related data should be restored if Global-e invokes the fallback order creation scenario (an order is created from a new basket and all the original basket custom attributes are lost in this case).\ OOTB the custom hook handler returns an empty object. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | basket | dw\.order.Basket | The customer’s basket | **Returns** The hook handler must return null or the object (e.g., \{ key1: `value1`, key2: `value2` }). ### globale.getPLICustomMetadata **Description** The custom hook is invoked before the SendCart request for each product line item in the basket and could be used to extend the Global-e ProductLineItem Metadata property in the SendCart payload.\ It might be helpful in case some additional product line item-related data should be restored if Global-e invokes the fallback order creation scenario (an order is created from a new basket and all the original product line item custom attributes are lost in this case) or in the case if it’s required to pass additional metadata (flash sale products, etc.).\ OOTB the custom hook handler returns an empty object. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | productLineItem | dw\.order.ProductLineItem | Product line item | **Returns** The hook handler must return null or the object (e.g., \{ key1: `value1`, key2: `value2` }). ### globale.getPliEstimatedDeliveryDate **Description** The custom hook is invoked before the SendCart request for each product line item in the basket and could be used to return the estimated delivery date value.\ Allows displaying a new template for delivery date estimation (preorder/backorder products). The notification will be displayed next to the product, like product attributes.\ OOTB the custom hook handler returns null. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | productLineItem | dw\.order.ProductLineItem | Product line item | **Returns** The hook handler must return null or the string value using the format `YYYY-MM-DD` (e.g., 2022-05-15). ### globale.getPliIsBackOrdered **Description** The custom hook is invoked before the SendCart request for each product line item in the basket and could be used to return the IsBackOrdered value.\ OOTB the custom hook handler returns false. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | productLineItem | dw\.order.ProductLineItem | Product line item | **Returns** The hook handler must return boolean value. ### globale.getCookieConsent **Description** The custom hook is invoked before the SendCart request and could be used to return the customer cookie consent.\ OOTB the custom hook handler returns 1 or 0 depending on whether the customer has accepted the cookie consent. **Returns** The hook handler must return integer value. The possible values are: *  0 - No consent * 1 - Consent to all cookies * 2 - Consent to the essential cookies only ### globale.getAllowMailsFromMerchant **Description** The custom hook is invoked before the SendCart request and could be used to return the AllowMailsFromMerchant value.\ OOTB the custom hook handler returns false. **Returns** The hook handler must return boolean value. ### globale.getAllowDirectCommunicationFromMerchant **Description** The custom hook is invoked before the SendCart request and could be used to return the AllowDirectCommunicationFromMerchant value.\ OOTB the custom hook handler returns false. **Returns** The hook handler must return boolean value. ### globale.beforeSendCartRequest **Description** The custom hook is invoked before the SendCart request.\ OOTB the custom hook handler is not defined.\ **Note:** be careful with the hook handler since it allows modifying the payload object before the SendCart request which might lead to the SendCart API error (in this case the Global-e checkout is not loaded). **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | basket | dw\.order.Basket | The customer’s basket | | payload | Object | SendCart payload object | **Returns** Void. ### globale.getPlatformURLs **Description** The custom hook is invoked before the SendCart request to populate the `PlatformURLs` property (SiteURL, RedirectToCartURL, PaymentCallbackURL).\ OOTB the custom hook handler is not defined. **Returns** The hook handler must return an object (e.g., `{ SiteURL: '...', RedirectToCartURL: '...', PaymentCallbackURL: '...' }`) or `null`. ### globale.getSendCartProductOriginalMerchantPriceForDuties **Description** This hook is intended to supply the original merchant wholesale price used for duties calculation when building the SendCart product payload. It is **registered** as an extension point (SFRA/SiteGenesis handlers delegate to the `int_globale` fallback), but core 24.6.0 does not currently invoke it during SendCart payload build — treat it as a reserved extension point. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | target | Object | SendCart product object being built | | source | dw\.catalog.Product | SFCC product | **Returns** Number (wholesale price) or `null`. ### globale.getPliHubCode **Description** The custom hook is invoked for setting hub code on the product level of the SendCart request body.\ OOTB the custom hook handler is registered and returns `null`. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | productLineItem | dw\.order.ProductLineItem | Product line item | **Returns** The hook handler must return string value. ### globale.validateCart **Description** The custom hook is invoked on the ValidateCart request that is sent by Global-e once a customer clicks the “Place Order“ CTA to check if all the products are still in stock.\ OOTB the custom hook handler logic can check product availability using the SFCC inventory lists. Depending on the configuration can check the product availability using ProductMgr or in the OCAPI basket context. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | payload | Object | ValidateCart payload object | | isPayByLinkScenario | Boolean | True when the request is part of a pay-by-link scenario | **Returns** The hook handler must return the object that contains these properties: errorCode, errorMessage, amendedProducts, reservationRequestId (e.g., \{ errorCode: null, errorMessage: null, amendedProducts: \[], reservationRequestId: null }). ### globale.onBeforeApplyCouponCode **Description** The custom hook is invoked before the Apply Coupon Code SFCC OCAPI request (the feature requires additional configuration on both Global-e and SFCC sides).\ OOTB the custom hook handler is not implemented. Could be used to add additional payload data or the request headers. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | service | dw\.svc.Service | SFCC service | | payload | Object | The Apply Coupon Code SFCC OCAPI request payload | **Returns** Void. ### globale.onBeforeRemoveCouponCode **Description** The custom hook is invoked before the Remove Coupon Code SFCC OCAPI request (the feature requires additional configuration on both Global-e and SFCC sides).\ OOTB the custom hook handler is not implemented. Could be used to add additional payload data or the request headers. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | service | dw\.svc.Service | SFCC service | | payload | Object | The Remove Coupon Code SFCC OCAPI request payload | **Returns** Void. ### globale.onGenerateBasketFromPayload **Description** The custom hook is invoked right after the basket is recreated on the SFCC side.\ OOTB the custom hook handler is not implemented. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | basket | dw\.order.Basket | The basket recreated from the payload | | payload | Object | The request payload (could have different structure depending on if it’s the default or fallback order creation scenario) | **Returns** Void. ### globale.onAfterCreateOrder **Description** The custom hook is invoked right after an order is created on the SFCC side (could be triggered not only on the OrderClientCreate request but also on the SendOrderToMerchant request if the fallback order creation scenario is applied).\ OOTB the custom hook handler is not implemented. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC Order | | payload | Object | The request payload (could have different structure depending on if it’s the default or fallback order creation scenario) | **Returns** Void. ### globale.onAfterCreateMixedOrder **Description** The custom hook is invoked only if “Mixed Orders“ feature is used and right after processing on Global-e “Order Create“ request on the SFCC side\ OOTB the custom hook handler is not implemented. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | isBasketExist | Boolean | The flag which indicates the state of SFCC basket. | | payload | Object | The request payload (could have different structure depending on if it’s the default or fallback order creation scenario) | **Returns** Void. ### globale.onBeforePlaceOrder **Description** The custom hook is invoked right before an order is placed on the SFCC side.\ OOTB the SFRA/SiteGenesis handler sets `session.setTrackingAllowed(true)` when the order payload `CookieConsent` is `1` or `2`. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC Order | | payload | Object | The request payload (could have different structure depending on if it’s the default or fallback order creation scenario) | **Returns** Void. ### globale.onAfterPlaceOrder **Description** The custom hook is invoked right after an order is placed on the SFCC side.\ OOTB the custom hook handler is not implemented. Implement in a project cartridge when post-place-order logic is required. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC Order | | payload | Object | The request payload (could have different structure depending on if it’s the default or fallback order creation scenario) | **Returns** Void. ### globale.onAfterUpdateOrder **Description** The custom hook is invoked right after an order is updated on the SFCC side (SendOrderToMerchant request).\ OOTB the custom hook handler is not implemented. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC Order | | payload | Object | The request payload | **Returns** Void. ### globale.onSetCustomerComments **Description** The custom hook is invoked during SendOrderToMerchant processing to set customer comments on the order.\ OOTB the custom hook handler is not implemented. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC order | | payload | Object | SendOrderToMerchant request payload | **Returns** Void. ### globale.modifyCreateUpdateOrderResponse **Description** The custom hook is invoked to modify the order create/update API response returned to Global-e.\ OOTB the custom hook handler is not implemented. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC order | | response | Object | Response object to be returned | **Returns** The modified response object. ### globale.onAfterUpdateMixedOrders **Description** The custom hook is invoked right after mixed orders are updated on the SFCC side (SendOrderToMerchant request).\ OOTB the custom hook handler is not implemented. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | orders | dw\.util.ArrayList | Array of orders(main and sub orders) | | payload | Object | The request payload | **Returns** Void. ### globale.onAfterPaymentUpdate **Description** The custom hook is invoked right after an order payment status is updated on the SFCC side (PaymentNotification request).\ OOTB the custom hook handler is not implemented. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC Order | | payload | Object | The request payload | **Returns** Void. ### globale.onAfterPaymentUpdateMixedOrders **Description** The custom hook is invoked right after mixed orders payment statuses are updated on the SFCC side (PaymentNotification request).\ OOTB the custom hook handler is not implemented. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | orders | dw\.util.ArrayList | Array of orders(main and sub orders) | | payload | Object | The request payload | **Returns** Void. ### globale.onAfterStatusUpdate **Description** The custom hook is invoked right after the order status is updated on the SFCC side (OrderStatusUpdate request).\ OOTB the custom hook handler is not implemented. Could be used to apply any required custom logic when Global-e sends order status update request. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC Order | | payload | Object | The request payload | **Returns** Void. ### globale.onAfterStatusUpdateMixedOrders **Description** The custom hook is invoked right after the mixed orders statuses are updated on the SFCC side (OrderStatusUpdate request).\ OOTB the custom hook handler is not implemented. Could be used to apply any required custom logic when Global-e sends order status update request. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | orders | dw\.util.ArrayList | Array of orders(main and sub orders) | | payload | Object | The request payload | **Returns** Void. ### globale.onAfterShippingUpdate **Description** The custom hook is invoked right after the order shipping information is updated on the SFCC side (OrderShippingInfoUpdate request).\ OOTB the custom hook handler is not implemented. Could be used to apply any required custom logic when Global-e sends order shipping information update request. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC Order | | payload | Object | The request payload | **Returns** Void. ### globale.onAfterRefund **Description** The custom hook is invoked right after the order refund information is updated on the SFCC side (OrderRefund request).\ OOTB the custom hook handler is not implemented. Could be used to apply any required custom logic when Global-e sends an order refund request. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC Order | | payload | Object | The request payload | **Returns** Void. ### globale.onAfterGeRmaUpdate **Description** The custom hook is invoked right after the order RMA information is updated on the SFCC side (RMA request).\ OOTB the custom hook handler is not implemented. Could be used to apply any required custom logic when Global-e sends an order RMA request. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC Order | | payload | Object | The request payload | **Returns** Void. ### globale.customerVerification **Description** The custom hook is invoked once Global-e sends a customer verification request (additional configuration is required on the Global-e side for this feature).\ OOTB the custom hook handler checks if a customer has the SFCC account. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | payload | Object | The request payload | **Returns** Returns customer verification status (e.g., \{ success: true, registered: false, errorCode: null, eventName: 'status' }). ### globale.customerRegistration **Description** The custom hook is invoked once Global-e sends a customer registration request (additional configuration is required on the Global-e side for this feature).\ OOTB the custom hook handler creates the SFCC account, assigns the last order to the customer and creates addresses in the SFCC address book. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | payload | Object | The request payload | **Returns** Returns customer registration status (e.g., \{ success: true, registered: true, errorCode: null, eventName: 'register' }). ### globale.outboundOrderStatusUpdate **Description** The custom hook is not invoked OOTB, instead should be used to initiate OrderStatusUpdate notification from SFCC to Global-e (if the feature is in the integration scope).\ OOTB the custom hook handler creates a notification custom object that is processed by the GlobaleOrderNotifications job further. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | orderId | String | The notification order number | | payload | Object | The notification payload | **Returns** Returns the notification creation status (dw\.system.Status). ### globale.outboundOrderDispatchUpdate **Description** The custom hook is not invoked OOTB, instead should be used to initiate OrderDispatchUpdate notification from SFCC to Global-e (if the feature is in the integration scope).\ OOTB the custom hook handler creates a notification custom object that is processed by the GlobaleOrderNotifications job further. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | orderId | String | The notification order number | | payload | Object | The notification payload | **Returns** Returns the notification creation status (dw\.system.Status). ### globale.outboundOrderRefundUpdate **Description** The custom hook is not invoked OOTB, instead should be used to initiate OrderRefundUpdate notification from SFCC to Global-e (if the feature is in the integration scope).\ OOTB the custom hook handler creates a notification custom object that is processed by the GlobaleOrderNotifications job further. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | orderId | String | The notification order number | | payload | Object | The notification payload | **Returns** Returns the notification creation status (dw\.system.Status). ### globale.outboundOrderRMAUpdate **Description** The custom hook is not invoked OOTB, instead should be used to initiate OrderRMAUpdate notification from SFCC to Global-e (if the feature is in the integration scope).\ OOTB the custom hook handler creates a notification custom object that is processed by the GlobaleOrderNotifications job further. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | orderId | String | The notification order number | | payload | Object | The notification payload | **Returns** Returns the notification creation status (dw\.system.Status). ### globale.outboundParcelStatusUpdate **Description** The custom hook is not invoked OOTB; use it to initiate a parcel status update notification from SFCC to Global-e (when parcel tracking is in scope).\ Registered in `int_globale/hooks.json`. OOTB the handler calls the Global-e parcel API and may create a `GLOBALE_ORDER_NOTIFICATION` custom object for async processing. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | orderId | String | SFCC or Global-e order ID | | parcelCode | String | Parcel identifier | | payload | Object | Notification payload | **Returns** Returns the notification creation status (`dw.system.Status`). ### globale.getProductInventoryListId **Description** The custom hook is invoked **only when** the site preference “Use Custom Product Inventory Lists” (`geUseCustomProductInventoryLists`) is enabled; otherwise the cartridge returns `null` without calling the hook.\ OOTB the custom hook handler returns null value. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | product | dw\.catalog.Product | SFCC product | **Returns** Returns the ID of the inventory list or null. ### globale.getProductImageUrl **Description** The custom hook is invoked when it needs to get the product’s image URL (before the `SendCart` request and on run of SFCC job `GlobaleCatalogFeed`)\ OOTB the custom hook handler returns a null value. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | product | dw\.catalog.Product | SFCC product | **Returns** Returns the URL of the product or null. ### globale.getHubId **Description** The custom hook is invoked before the SendCart request and could be used to return the HubId value.\ OOTB the custom hook handler returns `null` or the active Global-e Hub ID when AppSettings `sfccSendCartSendHubId` is enabled. **Returns** The hook handler must return a string (Hub ID) or `null`. ### globale.resetPriceBooks **Description** The custom hook is invoked when Global-e resets price books (for example on country or currency change).\ OOTB the SFRA/SiteGenesis handler aligns session currency with the current locale country configuration. **Returns** Void. ### globale.onAfterVoidReservation **Description** The custom hook is invoked when Global-e VoidReservation notification is received on the platform side.\ OOTB there is no custom hook handler. **Returns** The hook handler must return boolean value. ### globale.getLineItemDeliveryType **Description** The custom hook is invoked before the SendCart request and could be used to return the LineItemDeliveryType value (relevant only for BOPIS orders).\ OOTB the custom hook handler returns null. **Returns** The hook handler must return string value (Enum: BOPIS, DelayBOPIS, BOSS, ShipIt). ### globale.getLineItemShipToStoreCode **Description** The custom hook is invoked before the SendCart request and could be used to return the ShipToStoreCode value (relevant only for BOPIS orders).\ OOTB the custom hook handler returns null. **Returns** The hook handler must return string value. ### globale.getEstimatedDeliveryTimeMessage **Description** The custom hook is invoked before the SendCart request and could be used to return the EstimatedDeliveryTimeMessage value (relevant only for BOPIS orders).\ OOTB the custom hook handler returns null. **Returns** The hook handler must return string value. ### globale.webStore.getWebStoreCode **Description** The custom hook is invoked before the SendCart request and should be used in case if OOTB logic should be replaced with a custom one.\ OOTB the fallback returns the current site ID (`Site.current.ID`). **Returns** The hook handler must return string value. ### globale.webStore.getWebStoreInstanceCode **Description** The custom hook is invoked before the SendCart request and should be used in case if OOTB logic should be replaced with a custom one. **Returns** The hook handler must return string value. ### globale.onGetSendCartData **Description** The custom hook returns checkout/SendCart preparation data for headless and express checkout flows.\ Registered in `int_globale/hooks.json`. OOTB the handler returns the result of the checkout show operation. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | basket | dw\.order.Basket | Current basket | **Returns** SendCart operation result object. ### globale.onInitApplication **Description** The custom hook initializes the Global-e application context for a country/currency pair.\ Registered in `int_globale/hooks.json`. OOTB the handler runs `globaleInit`. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | countryCode | String | ISO country code | | currencyCode | String | ISO currency code | **Returns** Void. ### globale.onGetMerchantGuid **Description** The custom hook returns the Global-e merchant GUID.\ Registered in `int_globale/hooks.json`. OOTB the handler returns the merchant GUID from service credentials via `globaleHelpers.getMerchantGuid()`. **Returns** String (merchant GUID). ### globale.onGetCountry **Description** The custom hook returns the Global-e country object for a country code.\ Registered in `int_globale/hooks.json`. OOTB the handler uses `geCountryMgr.getByCountryCode`. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | countryCode | String | ISO country code | **Returns** Global-e country object. ### globale.webStore.getWebStoreInstanceCodeInJobContext **Description** The custom hook returns the WebStore instance code when Global-e settings jobs run.\ OOTB the custom hook handler is not implemented. **Returns** String (WebStore instance code) or `null`. ### globale.onAfterGiftCertificateRefund **Description** The custom hook is invoked after a Global-e gift certificate refund is processed.\ OOTB the custom hook handler is not implemented. **Returns** Void. ### globale.onAfterGiftCertificateRedeem **Description** The custom hook is invoked after a Global-e gift certificate is redeemed.\ OOTB the custom hook handler is not implemented. **Returns** Void. ### globale.onAfterGiftCertificateCreate **Description** The custom hook is invoked after a Global-e gift certificate is created.\ OOTB the custom hook handler is not implemented. **Returns** Void. ### onAfterGiftCertificateOrderCreate **Description** The custom hook is invoked after an order containing a gift certificate is created.\ **Note:** registered in code as `onAfterGiftCertificateOrderCreate` (without the `globale.` prefix). OOTB the custom hook handler is not implemented. **Returns** Void. ### globale.onPayByLinkAfterCreateOrder **Description** The custom hook is invoked after an order is created in a Pay-by-Link scenario.\ OOTB the custom hook handler is not implemented. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC order | **Returns** Void. ### globale.onPayByLinkAfterPlaceOrder **Description** The custom hook is invoked after an order is placed in a Pay-by-Link scenario.\ OOTB the custom hook handler is not implemented. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC order | **Returns** Void. ### globale.onBeforeOrderValidate **Description** The custom hook is invoked before Pay-by-Link order validation.\ OOTB the custom hook handler is not implemented. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC order | **Returns** Void. ### globale.onAfterOrderValidate **Description** The custom hook is invoked after Pay-by-Link order validation.\ OOTB the custom hook handler is not implemented. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | order | dw\.order.Order | SFCC order | **Returns** Void. ### globale.onBeforeCalculate **Description** The custom hook is called right before the original calculate is called. It enables customizations for the calculation of the basket. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | basket | dw\.order.Basket | SFCC basket | **Returns** The hook handler must return system Status with custom code.\ | Custom Code | **Description** | | - | - | | geContinueBaseCalculate | returned when the basket is **not** a Global-e basket — **only base calculate is executed**. | | geStopCalculate | returned when the calculate flow should be interrupted and base calculate must not run, for the custom cases: pay-by-link scenario or CAPI order-create request. | | geContinueGECalculate | returned for a Global-e basket in an operated country — **both the custom Global-e calculate and base calculate run**. | ### globale.calculateProductPrices **Description** The custom hook is called to reset product prices and calculate prices for all product line items in the basket. This hook is called in the calculate hook and is used to calculate prices for product line items. It handles bonus product line items and updates totals. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | basket | dw\.order.Basket | SFCC basket | **Returns** Void (the OOTB handler updates the basket in place). ### globale.calculateBaseProductPrices **Description** The custom hook is called to calculate prices for all product line items in the basket. **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | basket | dw\.order.Basket | SFCC basket | **Returns** Void (the OOTB handler updates the basket in place). ### globale.calculateTax **Description** Determines tax rates for all line items of the basket. Uses the shipping addresses associated with the basket shipments to determine the appropriate tax jurisdiction. Uses the tax class assigned to products and shipping methods to lookup tax rates. Sets the tax-related fields of the line items. Handles gift certificates, which aren't taxable. Note that the function implements a fallback to the default tax jurisdiction if no other jurisdiction matches the specified shipping location/shipping address. Note that the function implements a fallback to the default tax class if a product or a shipping method does explicitly define a tax class.\ **Custom hooks handler arguments** | **Argument Name** | **Argument Type** | **Description** | | - | - | - | | basket | dw\.order.Basket | SFCC basket | *** ## See also * [Metadata](/metadata-sfcc) — `ge*` custom attributes and BM object definitions * [Configuration](/configuration-sfcc) — site preferences and BM setup * [Customization](/customization-sfcc) — implementing custom hook handlers * [Checkout flow](/checkout-flow-sfcc) and [Failover](/failover-sfcc) — order lifecycle and fallback (SOTM) # SAP Hybris Source: https://docs.global-e.com/hybris The Global‑e Add-on for SAP COMMERCE CLOUD (SAP Hybris) accelerates the integration of an SCC-based Storefront with Global‑e. **In this section:** * [Installation](/installation-sap-hybris) * [Integration](/integration-sap-hybris) * [Global-e Storefront Functionality](/global-e-storefront-functionality) * [Prices and Price Conversion](/prices-and-price-conversion) * [Merchandising](/merchandising) * [Orders](/orders) * [Cart and Checkout](/cart-and-checkout) * [Add-on, Extensions, and Custom Functionality](/add-on-extensions-and-custom-functionality) **INTEGRATION FEATURES** | Feature | Description | | - | - | | Country and Currency Switcher | Choose over 200 countries with default or free currencies (which can be replaced by a custom implementation) | | Currency Conversion | View prices in local currency with up-to-date conversion rates, country coefficients, rounding rules, and currency symbols | | Duty and Tax Calculations | Country and continent-specific duty and tax calculations | | Delivery Cost | Dynamic delivery cost calculations based on country | | Multiple Shipping Options | Country-specific shipping options from standard to express | | Local Payment Methods | Choose from the most popular payment methods for each country | | Promotions | Manage promotions for Global‑e operated countries | | Customer Service | View and manage Global-e Orders through the Customer Services Tool | # Installation Source: https://docs.global-e.com/installation-bigcommerce ## Prerequisites * An administrator account for your Platform * A Global‑e Merchant account * Your Global-e Merchant ID and Merchant GUID (provided to you by Global-e) To integrate your BigCommerce Store with Global-e, install and configure the Global-e Application. **To install the Global-e Application:** 1. Click the relevant link: * [Sandbox/Development](https://apps.bigcommerce.com/details/42496) * [Production](https://www.bigcommerce.com/apps/global-e) Alternatively, navigate to the BigCommerce store, and find and open the Global-e app. Note that only the production app is available at the Big Commerce store. 2. Click **Get this app**. The Global-e Account Info screen is displayed, prompting you to fill in your merchant information. This information is provided to you when you sign up with Global-e. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-416a1835-0c5f-e653-9a37-88637764d6ac.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=bb974af333609a2ef922db34e58948ac) 3. In the **ACCOUNT INFO**, fill in: | Merchant ID | Your Merchant Account ID, as recorded in the Global-e system. Example: 899 | | - | - | | Merchant GUID | The private key of your Merchant Account ID in the Global-e system. Example: F978DFEB-FF8C-4EE1-BFDA-68FB1B78E217 | This information is provided to you when you sign up with Global-e. 4. Click **INSTALL APP**. 5. The Global-e Application is now installed. After installation, configure the app to complete the integration. # Installation Source: https://docs.global-e.com/installation-magento2-lite You can install the Global-e Magento2 Extension packages in one of two ways: * [Extract the Zip file](/installing-global-e-modules-using-a-zip-file) provided to you by Global-e that includes the two packages. * [Run the composer-based installation](/composer-based-installation) directly from the Global-e repositories. ## Activating the Extension The Global‑e Magento2 Lite extension provides a configuration screen that allows actual activation of Global‑e Integration on the website along with other settings: Stores -> Configuration -> Services -> Global-E Integration Lite: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-82982324-a3d5-9d02-e445-2125148b988c.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=487fe800c63e0791c1de7831073389d8) All configuration details will be provided by Global‑e during the integration step. ## Headless Installation If a full page cache requires a whitelist of dynamic URLs, the following patterns should be whitelisted to support Global-e integration Frontend area: `/international-ge/*` `/international/*` Admin area: `/globale/*` Additionally, Global-e uses Magento2’s REST APIs. Make sure to enable them. Make sure not to cache them (remove them from varnish or any other cache mechanism). # Installation Source: https://docs.global-e.com/installation-prestashop Global‑e provides you with a zipped file of the PrestaShop plug-in. Make sure you have your Merchant information handy to perform this installation. **To integrate the Global-e plug-in with your store:** 1. [Install the Global‑e Module](/installation-prestashop#install-the-global‑e-module). 2. [Configure the Module](/installation-prestashop#configure-the-module). ## Prepare your Environment ### Prerequisites * An administrator account for your Platform * A Global‑e Merchant account * Your Global-e Merchant ID and Merchant GUID (provided to you by Global-e) ### Supported Versions The Global‑e plugin setup supports PrestaShop version 1.6.0 and up to 9 ### Third-Party Support * [All-in-one Rewards](https://addons.prestashop.com/en/referral-loyalty-programs/4414-all-in-one-rewards-loyalty-referral-affiliation.html#overview). Partially supported for generating coupons with specific cart rules (generated by the module only). * [JPresta – Refreshes the cache of the store for greater efficiency. Page Cache Ultimate](https://addons.prestashop.com/en/website-performance/7939-page-cache-ultimate.html#overview).). Supported since 0.4.20. See [PrestaShop | JPresta Page Cache Ultimate](https://addons.prestashop.com/en/website-performance/7939-page-cache-ultimate.html). ### APIs / URLs The following endpoints can be accessed to review the existing hooks: **Order Shipment:** This endpoint updates the fulfilment status. `/index.php?module=prestashop_globale&controller=UpdateParcelDispatch&fc=module` **Cart Validation**: This endpoint returns the cart validation result. It is called by the Bespoke Global-e Module before the order is placed to prevent cart modifications. `/index.php?module=prestashop_globale&controller=ValidateCart&fc=module` **Coupon Validation:** This endpoint returns the cart coupon validation result. It is used on Global-e checkout. `/index.php?module=prestashop_globale&controller=ValidateCartVoucher&fc=module` **Gift Card endpoints:** `/index.php?module=prestashop_globale&controller=GiftCardValidate&fc=module` `/index.php?module=prestashop_globale&controller=GiftCardRedeem&fc=module` `/index.php?module=prestashop_globale&controller=GiftCardRefund&fc=module` ### About This endpoint shows the PrestaShop and Global-e versions and returns a list of registered hooks related to the Global-e module. `/index.php?module=prestashop_globale&controller=AboutInfo&fc=module [&hooks]` ### Global-e Module **Clear Cart**: This endpoint clears the cart after order confirmation. \[POST] `/index.php?module=prestashop_globale&controller=ClearCart&fc=module` ``` 1curl--location--request POST '[your domain URL]/index.php?module=prestashop_globale&controller=ClearCart&fc=module' \ 2--header 'Content-Type: application/x-www-form-urlencoded' \ 3--data - urlencode 'MerchantGUID=[your Merchant GUID]' ``` **Cart Info:** This endpoint returns the cart content. `/index.php?module=prestashop_globale&controller=CartInfo&fc=module` **Order Create:** This endpoint creates orders in the platform. `/index.php?module=prestashop_globale&controller=OrderCreate&fc=module` **Order Payment:** This endpoint updates the order payment status. `/index.php?module=prestashop_globale&controller=OrderPayment&fc=module` **Order Status**: This endpoint updates the order status. `/index.php?module=prestashop_globale&controller=OrderStatus&fc=module` **Order Shipment:** This endpoint updates the shipment status. `/index.php?module=prestashop_globale&controller=OrderShipment&fc=module` ### Checkout **Checkout**: The Global‑e checkout iFrame location. `/module/prestashop_globale/Checkout` ### Examples of Global‑e Server Environments URLs ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-41d005c7-eca2-e2ce-868f-65a028f507bf.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=9b059cf901c9d9e5a3737c13dc4399e1) ## Install the Global‑e Module The Global-e module for PrestaShop can be provided to you by Global-e as a zip file. Follow one of the methods below to install the module. **Option 1.Install the module from the server** If you received the zip file from Global-e you can download it to the server on which PrestaShop is installed and unzip it. 1. Extract the zip file. 2. Navigate to the location where you extracted the file. 3. Copy: **prestashop_globale/.** to **\/modules/prestashop_globale/**. **Option 2. Upload the module's zip file to PrestaShop admin** 1. Log in to PrestaShop admin. 2. Navigate to **Modules** → **Module Manager** and click **Upload a module**. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-17364ed0-610a-a556-13b2-14cf9c265d06.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=ffad2fbc9d98a96103ef96ba37f753f1) A file upload window opens. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a80c1bd1-38ee-b505-a7f2-558b14b9f594.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=330bdac009a70d0002d041b536182491) 3. Click **select file** and choose the zip file to upload. Once the file is uploaded the module is installed. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-38d27613-6642-128b-fcd9-47d84d7ccd88.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=08b0415007145696359b1e7afd3b30df) ## Configure the Module **To configure the Global-e module:** 1. Log in to the PrestaShop Admin with your PrestaShop Admin user credentials. 2. Navigate to **Modules → Module Manager**. The Module Manager opens. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-44356333-9b31-0d1f-dc65-668a333790c5.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=8b35945eb22c8c8ac60a4ed98138a1c4) 3. Scroll down to the Global‑e module and click **Configure**. The Configure screen opens. This is where you configure the Global‑e settings in PrestaShop. This screen is divided as follows and detailed in the relevant sections of this document: [Configure Global‑e](/configuration-prestashop#configure-global-e) - Required. [Configure Orders](/configuration-prestashop#configure-orders) [Configure Products](/configuration-prestashop#configure-products) [Configure the Checkout for Analytics](/configuration-prestashop#configure-the-checkout-for-analytics) [Examples of Global‑e Server Environments URLs](/installation-prestashop#examples-of-global-e-server-environments-urls) # Installation Source: https://docs.global-e.com/installation-sap-hybris Global‑e offers two installation scripts: **Global‑e Accelerator Recipe Installation:** Run the automatic Global‑e Accelerator Recipe on your Hybris Test Site when installing the Global‑e Add-on for the first time. This allows Global‑e to identify potential overlaps with your current customization. **Manual Installation:** Run the manual installation to start the integration with an existing Hybris project: Pull the Global‑e extensions, include them in the project repository, and then configure the Global‑e Add-on. ## Prerequisites The Global‑e add-on setup requires a Global‑e merchant account. Supported Versions: Supported SAP Hybris version: 2211.3. ## Global‑e Accelerator Recipe Installation The Global‑e accelerator lets you discover the functionality of the platform. **Recipe** automates the platform code build and initializes the accelerator sites. The **Recipe** installation procedure is only performed when installing the add-on the first time (generally, in the testing environment). **To install the Global-e Add-on with Recipe:** 1. Configure the database, user, and permissions: ``` mysql> create database globale; mysql> create user 'globale'; mysql> grant all on globale.* to 'globale'@'%' identified by 'globale'; ``` 2. Unzip the SAP Commerce distribution ZIP archive. 3. Copy the mysql db driver to: ``` /hybris/bin/platform/lib/dbdriver ``` 4. Copy `globale recipe` to the SAP Commerce installer: ``` cp -r ${PATH_TO_GLOBALE_REPO}/y-config/installer/recipes/* ${PATH_TO_HYBRIS_UNPACKED}/installer/recipes" ``` 5. Create symlinks: ``` ln -sfn ${PATH_TO_GLOBALE_REPO}/y-ext ${PATH_TO_HYBRIS_UNPACKED}/hybris/bin/globale" ``` Now, the source code is linked to the SAP commerce suite ready to build. 6. Build and initialize: ``` cd ${PATH_TO_HYBRIS_UNPACKED}/hybris/bin/platform ./setantenv.sh ant clean -Dinput.template=develop ${PATH_TO_HYBRIS_UNPACKED}/installer/install.sh -r globale initialize ``` 7. Configure the Global‑e Add-on. See [Configure the Global‑e Add-on](/installation-sap-hybris#configure-the-global-e-add-on). ## Manual Installation For an existing Hybris integration, use the manual Global‑e Add-on installation. **To place a call manually (without a recipe):** 1. Open the `localextensions.xml` file and add the following Global‑e extensions: ``` ``` 2. Install the `globaleaddon`: ``` ant addoninstall -Daddonnames=globaleaddon - DaddonStorefront.yacceleratorstorefront=STOREFRONTNAME ``` 3. Configure the Global‑e Add-on. See [Configure the Global‑e Add-on](/installation-sap-hybris#configure-the-global-e-add-on). ## Configure the Global‑e Add-on The Global‑e Add-on deploys these main configuration files. * `hybris/config/local.properties` - the file containing all the configuration properties (UID, GUID, feature toggles) * `hybris/config/localextensions.xml` - the file containing the list of modules and extensions (`globalecore`, `globalefacades`, `globaleaddon`, and so on). **To configure the Global-e Add-on:** 1. Open the `local.properties` configuration file. 2. Add your Global‑e Merchant credentials: | `ID` | Your Global-e Merchant ID.**Template:**`globale.merchant.id.=<#>`Example: `globale.merchant.id.electronics=193` | | - | - | | `GUID` | Your Global-e Merchant GUID.Note that you receive a different GUID for staging and production. Make sure to use the correct GUID.**Template:**`globale.merchant.guid.=`Example: `globale.merchant.guid.electronics='8521f759-a239-4231-80a3-1efda984a723'` | ## Additional Settings ### Client ``` globale.client.js.domain = 'https://www2.bglobale.com' globale.client.js.path = '/scripts/merchants/globale.merchant.client.js' ``` ### Global‑e Enabled ``` globale.enabled = true globale.enabled.initial.product.call = false ``` ### Global‑e Cookie ``` globale.cookie.name = 'GlobalE_Data' globale.cookie.expiration = '259200' ``` ### API Call Timeout ``` globale.api.call.timeout = '6000' ``` ### API Connections ``` globale.api.connect.timeout = '1000' globale.api.call.max.connections.host = '100' globale.api.call.max.total.connections = '200' ``` ### Send Products ``` globale.send.products.batch.size = '10' ``` ### Country Code ``` globale.default.country.code = 'GB' ``` ### Language ``` globale.store.multilanguage = 'true' globale.store.english = 'en' ``` # Installation Source: https://docs.global-e.com/installation-sfcc Installation has two main steps: upload cartridges to the active code version, then import Global-e metadata. Business Manager configuration is covered in [Configuration](/configuration-sfcc). See [Cartridges](/cartridges-sfcc) to choose the right cartridge set for your storefront (SFRA, SiteGenesis, headless, or popups-only) and for `b2c code deploy` examples per architecture. ## Upload cartridges Upload **`int_globale`** and the storefront cartridge for your architecture: | Architecture | Upload | | - | - | | SFRA | `int_globale` + `int_globale_sfra` | | SiteGenesis | `int_globale` + `int_globale_sitegenesis` | | Headless / PWA | `int_globale` + `int_globale_headless` (add `int_globale_sfra` or `int_globale_sitegenesis` if the site also serves a traditional storefront) | | Country Switcher only | `int_globale` + `int_globale_sfra_popups` or `int_globale_sitegenesis_popups` | Upload to the active code version on your Salesforce B2C Commerce instance using the [`b2c` CLI](https://salesforcecommercecloud.github.io/b2c-developer-tooling/). If you build client assets from source, run the compile scripts in the repository `package.json` before deploy. Example (SFRA): ```bash theme={null} b2c code deploy ./cartridges -c int_globale -c int_globale_sfra --server your-sandbox-hostname.demandware.net --reload ``` ## Import metadata Import Global-e metadata **before** using cartridge functionality. Import in this order (all in **MERGE** mode): | Order | Content | Repo path | Business Manager | | - | - | - | - | | 1 | System object Global-e custom attributes | `metadata/meta/system-objecttype-extensions.xml` | Administration → Site Development → Import & Export | | 2 | Global-e custom object definitions | `metadata/meta/custom-objecttype-definitions.xml` | Administration → Site Development → Import & Export | | 3 | Global-e services | `metadata/services.xml` | Administration → Operations → Import & Export | | 4 | Global-e jobs | `metadata/jobs.xml` | Administration → Operations → Import & Export | | 5 | Global-e payment method | `metadata/site/paymentmethod.xml` | Merchant Tools → Ordering → Import & Export | | 6 | Global-e shipping methods | `metadata/site/shippingmethods.xml` | Merchant Tools → Ordering → Import & Export | Optional demo data under `metadata/demo/` is for **sandbox examples only** — do not import to production without review. Demo custom object types (`DEMO_GLOBALE_*`) are described in [Metadata](/metadata-sfcc); do not rely on demo data or demo object records in production. OCAPI templates live in `metadata/ocapi-settings/`: * `wapi_shop_config.json` — Shop API (headless / Commerce API) * `wapi_data_config.json` — Data API for Global-e configuration sync and read access (**mandatory** for new integrations) Apply equivalent permissions in Business Manager — see [Configuration](/configuration-sfcc) § Open Commerce API Settings. ## After import **Step 1** Create the **GLOBALE** payment processor manually (not included in metadata) — see [Configuration](/configuration-sfcc) § Payment Processor\\ **Step 2** Configure site preferences and cartridge path — [Configuration](/configuration-sfcc)\\ **Step 3** **Create merchant GUID credentials** (`Globale-{merchantId}`) in Business Manager — **required** for every Global-e account used on the instance; see [Configuration → Merchant GUID credentials](/configuration-sfcc#merchant-guid-credentials-required)\\ **Step 4** Create a **dedicated** Account Manager API client and apply **Data** OCAPI settings — [Configuration → Data API](/configuration-sfcc#data-api-mandatory-for-new-integrations); also required per [Requirements](/requirements-sfcc#account-manager--ocapi-data-api-new-integrations)\\ **Step 5** Run the **GlobaleSettings** job — [Configuration](/configuration-sfcc) § Scheduled Jobs; see [Jobs](/jobs-sfcc) for all cartridge jobs.\\ **Step 6** Site preference reference — [Metadata](/metadata-sfcc) # Installation Source: https://docs.global-e.com/installation-shopify-native The following Global-e applications are installed as part of the Shopify integration: * CrossBorder app * Offsite Payment app * Onsite Payment app **Note:** These applications are interdependent and cannot be implemented or used separately. > [!WARNING] > > We highly recommend allowing Global-e to perform the installations for you. > > To have Global-e perform the installations, provide your project manager with the URL, password, and permissions to your sandbox and live store. If you don't have, or prefer not to use, a sandbox, provide the details just for the live store. To perform the app installations yourself, follow the steps below. Installing the applications is a two-part process: install the three applications (CrossBorder App, Onsite Payment app, and Offsite Payment app), then enable each of them. It is very important to follow the precise order in which each app is installed and enabled. You also need to be in regular contact with your project manager during the process so Global-e can implement the required settings and configurations. ## Step 1. Install the CrossBorder app * Click the relevant Global‑e CrossBorder installation link and run the installation. **INT (Integration environment)** - Integration link: [https://apps.shopify.com/global-e-crossborder-int](https://apps.shopify.com/global-e-crossborder-int) **PROD (Production)** - Production link: [https://apps.shopify.com/global-e-crossborder](https://apps.shopify.com/global-e-crossborder) The installation screen opens showing the Global‑e CrossBorder application icon. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a822d21b-5644-263f-fd8c-7303d17132ba.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=af7bf2a3fe976e3d3443a92ed56c5c3f) * Click **Install app**. A screen opens showing Setup Instructions and Account Settings. > [!WARNING] > > **AT THIS STAGE, DO NOT TOGGLE THE GLOBAL-E ENABLED BUTTON.** > > This button is disabled by default and should only be enabled upon Global-e's confirmation. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b033218c-5110-6969-e911-897fde5ca551.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=4c3a2cc0c29c3e26bd453825020fa789) * Exit the page. ## Step 2. Install the Global-e Onsite Payment app * Click the relevant Global‑e Payments installation link and run the installation. **INT** (Integration environment) - Integration link: [https://apps.shopify.com/global-e-onsite-payments-int](https://apps.shopify.com/global-e-onsite-payments-int) **PROD** (Production) - Production link: [https://apps.shopify.com/global-e-onsite-payments](https://apps.shopify.com/global-e-onsite-payments) The Global-e Onsite Payments (INT) screen opens. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-0fec0897-0b46-9244-4fff-760ea499358b.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=e2f2f4de014b09046977e698551da843) * At the top of the screen, click **Install.** The installation screen opens showing the Global‑e Onsite Payment icon. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b58cf2bf-38a2-8b98-4b0a-63a1891658af.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=15a7ac4671cfe9438a315918dec2f2d5) * At the top of the screen, click **Install app.** The Global‑e Payments App installation is complete, and the Configuration page opens. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-ae5261db-6f8a-63d1-c2c8-1a9a89600d8c.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=f5547c499f4fa2b7b9378a5635c1cbe1) * Exit the configuration page. ## Step 3. Install the Global-e Offsite Payment app * Click the relevant Global‑e Payments installation link and run the installation. **INT** (Integration environment) - Integration link: [https://apps.shopify.com/global-e-payment-int](https://apps.shopify.com/global-e-payment-int) **PROD** (Production) - Production link: [https://apps.shopify.com/global-e-payments](https://apps.shopify.com/global-e-payments) The installation screen opens showing the Global‑e Payment icon. ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fdb8e783-cb29-6385-c09b-47a761b6074a.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=4fd9e3606f6615e6be0b2a071cae17d1) * At the bottom of the screen click **Install app.** The Global‑e Payments App installation is complete, and the Configuration page opens. * Exit the configuration page. ## Step 4. Notify your Project Manager that you have installed the applications After Global-e incorporates the additional settings, you receive a notification to proceed to step 5. ## Step 5. Enable the CrossBorder app * Make sure you have your Merchant ID and Merchant GUID. > [!NOTE] > > If you are unable to retrieve your Merchant credentials, contact your Global‑e Project Manager. * Under Account Settings, enter your account information as detailed below and click **Save**. | Account Information | Description | | - | - | | Merchant ID | Your Merchant Account ID, as recorded on the Global-e Merchant Portal. Example: 899 | | Merchant GUID | The private key of your Merchant Account ID on the Global-e Merchant Portal. Example: F978DFEB-FF8C-4EE1-BFDA-68FB1B78E217 **Note:** Currently, Global‑e does not support multiple stores under the same Global‑e Merchant GUID. | * Notify your Project Manager that you have set up your account. Global-e prepares your Merchant environment, which includes uploading your catalogue and configuring shipping methods. Once these configurations are completed, your project manager notifies you that the app can be enabled * Toggle **Global-e Enabled** and click Save. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b4d87fed-4182-e255-b819-b5d5af513b41.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=a3667609ddbd12413d37f160ddb1d9e9) The Configuration screen confirms that your Global‑e account configuration is complete. The CrossBorder app is now enabled and Global-e implements the following settings: * Global-e extensions are automatically added to your Checkout. * Global‑e adds the shipping zones (for countries operated by Global‑e) and the carrier service to your store > [!WARNING] > > The CrossBorder app **MUST** be enabled before you can enable the Payment app. * Enable the Global‑e storefront app embed in your Shopify theme. See [Global‑e JavaScript](#global‑e-javascript). * Wait for your Project Manager to confirm that the configurations are complete before you enable the payment apps. This process takes about 1-2 business days, during which time Global-e performs several validations. ### Global‑e JavaScript Global‑e JavaScript runs on all the pages of your store through the **Global‑e storefront** app embed. You must enable this app embed on every installation. **To enable the Global‑e storefront app embed:** * In the theme editor, navigate to **Apps**. * Enable **Global‑e storefront** on the published theme. * Click **Save**. The following figure shows the **App embeds** panel in the theme editor: ![Shopify theme editor with the App embeds panel open, the Global‑e storefront toggle turned on, and the Save button](https://mintcdn.com/globale-enterprise/2oUGPO3ui32szCCH/images/installation-shopify-native-app-embeds-toggle.png?fit=max\&auto=format\&n=2oUGPO3ui32szCCH\&q=85\&s=fb51facaae4891d995afb6f94a093cdd) > [!WARNING] > > App embeds are enabled per theme. If you publish a new theme, turn on **Global‑e storefront** on that theme as well. Until you do, Global‑e JavaScript does not run on your storefront. **Global‑e JavaScript main functionality:** * Restricted products * Handles the replacement flow * Adds the marketing banner * Supports the payment flow on the checkout page. ## Step 6. Enable the Global-e Onsite Payment app * Click on the relevant link to return to the Onsite Payment app page. * Integration (INT) environment: [https://apps.shopify.com/global-e-onsite-payments-int](https://apps.shopify.com/global-e-onsite-payments-int) * Production environment: [https://apps.shopify.com/global-e-onsite-payments](https://apps.shopify.com/global-e-onsite-payments) ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a77f49d3-00d2-522d-6502-b844091fab6b.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=81a641c99072d4d189c1698a7bfbc96a) * Click **Manage Account**. The Onsite Payment App Configuration page opens. * Click **Enable**. A message displays confirming that the app is enabled. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a0dcb922-82ac-2379-ca88-07552ac1a726.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=f36087d45d943ffd69473c92e0a91e49) * Click **Open payment gateway settings** to return to the Onsite Payments page. The Payment Methods screen opens, featuring a partial list of payment methods supported by Global-e. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b7bb1aaf-8695-87e1-1150-31e9a0434e7b.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=9252fecb6643b417411798c9f3b81040) > [!NOTE] > > * The checkboxes in front of the payment methods are not functional. Selecting or clearing them has no impact on the payment methods displayed on the checkout page. > * The Payment Methods screen features only a partial list of Payment Methods supported by Global-e. * In the integration (INT) environment, enable test mode. In production, leave test mode disabled (the default). * On the bottom right, click **Activate**. ## Step 7. Enable the Global-e Offsite Payment app * Click on the relevant link to return to the Offsite Payment app page. * Integration (INT) environment: [https://apps.shopify.com/global-e-payment-int](https://apps.shopify.com/global-e-payment-int) * Production environment: [https://apps.shopify.com/global-e-payments](https://apps.shopify.com/global-e-payments) * Click **Enable** to enable the Offsite Payment app. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ecc77de2-bae3-dc13-15fb-a631786ed7c7.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=5eabab84a29859ba2096616aa4f7b9af) * Click **Open payment gateway settings** to activate the Offsite Payment app. The Payment Methods screen opens, featuring a partial list of payment methods supported by Global-e. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4d40e0c7-129e-421a-0c95-566758400eba.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=97b221ddfdfd6a4bc359f8cf5d7c5f58) The notes about the Payment Methods screen in [Step 6](/installation-shopify-native#step-6-enable-the-global-e-onsite-payment-app) apply here too. * In the integration (INT) environment, select **Enable test mode**. In production, leave it disabled (the default). * Click **Activate Global-e Payment** The Payment Methods supported by Global‑e in Shopify are enabled. * Notify your Project Manager that the apps are enabled. ## Check the Installation You can view the Global-e CrossBorder App installation listed with other apps previously installed. **To view the installation:** * In your Shopify admin, click on **> Apps**. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c84ea7a5-5212-a8cc-281d-e325010b230f.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=f1fb691bf43756d07c514da7148e4a80) A window opens with a list of all the installed apps. ## Export your Catalogue Global-e uses your catalogue to perform the product classification. **To export your product catalogue from your Shopify Production site:** 1. Log in to your Shopify Production site. 2. Navigate to **Products**. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-73a07a30-5271-6ef1-496a-0deea791127a.jpg?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=93243e92c4a32dfdf65caeee680aa4f4) 3. Click **Export**. The Export products dialogue box opens. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-59dcfa27-e734-93ea-ea62-c3e9267b6d0e.jpg?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=548df5d50c73c16a03b89e5371c7e866) 4. Select **All products** and **Plain CSV file**. 5. Click **Export Products**. A CSV file containing your product catalogue is downloaded. 6. Zip the CSV file and email it to your Global-e Project Manager and to your Global-e Team. ## Shopify Store Settings **To configure your Shopify store:** * Set the Customer contact method to Email (only). From your Shopify admin, navigate to Settings > Checkout and Accounts. ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/uuid-0300d39c-746e-204a-5bdc-1f993ca9f2cc.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=6adb49f894610581463bd60f5ec00d1a) * The phone number field must appear on the checkout page. Please set **Shipping address phone** number to **Required**. To complete the checkout, the Global-e CrossBorder solution requires that customers enter their phone number as part of the shipping address on the Shopify checkout page. * Optionally, you can enable/disable the setting to review your order. * From your Shopify Admin, navigate to Settings > General > Order processing. * The **Require a confirmation step** is supported by Global-e. If you do not see the option, you can skip it. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f25584ea-9d31-7d21-0ba8-cc33529021af.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=f93cfcc6cd590669e90fd76797105cbe) * Set customer information: * From your Shopify Admin, navigate to Settings > Checkout > Customer Information > Full Name. * Adjust the setting to **Require first and last name.** ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5e50cf4d-e291-fbb8-6465-9a1cf0593f20.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=a9bd9964f389a400f45847d0afcd2108) # Installation Source: https://docs.global-e.com/installation-shopware ## Install the Global‑e Module Follow one of the methods below to install the Global-e module for Shopware. **Method 1. Install the module from the server** 1. Install the source code. 1. Get the installation zip file, GlobalEShopware6-x.x.x.zip, from Global-e. 2. Extract the zip file to custom/plugins/directory. 2. Enable the Plugin. 1. Navigate to **Extensions → My extensions** 2. Click **Install app**. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-67f696bf-f15f-8293-3b19-eabce4f757e3.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=35770e50fa4bedd9177bd8c25361a1ec) 3. Enable the Global-e plugin. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-bf37d205-f881-7264-25b2-b2c8dbff637c.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=b01d609214a722e8ab6f1540abe07516) 3. Configure the plugin: 1. To the right of the Global-e plugin click the three dots → **Configuration** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8a340fff-bbd3-3e2f-9128-91a2b3518769.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=d6dcce8a74bb8548def305152502a01d) 2. Set the merchant configuration values. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-07b53885-b480-18bf-239d-d137a575300e.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=b1a370c6c4fc3b7cafd956949fd6768d) **Method 2. Upload the module's zip file to Shopware admin** 1. Navigate to **Extensions → My extensions**. 2. Click **Upload extensions** and select the zip file. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-657fadb6-aba9-1230-b117-953774521a2a.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=46ae0c75ea38810d3cc306358d405459) The Global-e plugin is added to the My Extensions page. 3. On the right side of the Global-e plugin click **Install app.** ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-eb5ff1b7-f271-fbff-a18f-a623cb2f13f6.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=648ea67e44742a0003fdfeb26391a0ea) 4. Enable the Global-e plugin. ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/uuid-01ccd3db-c506-ca67-591b-6e4740aacf9e.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=dc18d79273ceef0d52d3e41125b9824a) ## Global‑e Shopware Plugin > [card] > > * SendOrderToMerchant – to transfer new orders from Global‑e to Shopware > * PerformOrderPayment – to notify the merchant that payment was authorised > * UpdateOrderStatus – to notify the merchant of any change made to an order (e.g. cancellation, status change…) > * NotifyOrderRefund – to notify the merchant of a full order refund > [card] > [card] > > ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-4606b50f-7522-07b1-3c88-6ff4124fff02.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=ed37dffd5141a2be8e7141d4d1a9cc27) > > In Shopware, the order is created as a standard Shopware order, following the native Shopware creation flow. # Installation Source: https://docs.global-e.com/installation-wix ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-808e2d5c-ab27-3947-571f-14174d7e6a7a.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=2b1174ab939d0c143c8e7f00331f7c1b) ## Prerequisites The Global-e Wix application requires: * A Wix store account. * A Global-e Merchant account. * A Global-e Merchant ID and a Merchant GUID (provided to you by Global-e). * An administrator account for the Platform’s back-office of the store. **Store Access** If you need assistance from Global-e with your store, you must provide your CSM with store access by adding them to the Global-e Team in Wix. 1. Navigate to Settings > Team Management. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-30449dfe-2ce3-c2ea-88f2-93d6a7dbc967.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=d54b3dbdbf7f8bfc899298a10a87764d) 2. Click Invite Teammates. The Invite Teammates page opens. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b693d003-cb65-f616-c317-fd912f520ac5.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=725dad594336e4a0735d4aad4ec50fb4) 3. Input your CSM's email address. 4. Click Send Invite. ## Back-Office Installation 1. Click the relevant installation link: * QA-INT Application - [https://wix.to/KcmB081](https://wix.to/KcmB081) * Production Application - [https://wix.to/yURrd21](https://wix.to/yURrd21) (Integration is tested in Global-e Module hidden mode) A message opens asking you to install the application on your site. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8603dc30-553e-c3d7-fec4-ea83f24d83b1.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=9352d7063ea99f477d93e4419e1e0dd5) 2. Click **Install App**. 3. Select the store where you wish to install the application. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-78d4ee31-f695-48c9-228b-9e2f4bd175d0.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=ae8458db6978d4d9a419ba2b6a32ef3a) A message opens asking you to approve the application permissions. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1be8b064-7f48-facc-a42c-b63f3b4332ba.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=5a878e48f8f35d39415f75d46ff00135) 4. Click **Agree & Add**. You are automatically redirected to the editor section of your site. ## Editor Installation 1. Navigate to **Custom Apps** > **Installed Apps**. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-860049ca-7148-c74b-ac01-90a714ca1466.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=cd50ba721d489776448e0126d2df7fa6) 2. Select Global-e App Production and click **Install App**. 3. At the top-right click the + sign. 4. Select App Widget 5. Select the Country Switcher widget and drag it to the section where you want it to be located (this is usually the header). 6. Click **Publish** to save the changes. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-173114ee-9751-63b2-4747-e49b46354b9b.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=b3747506f70c153ce3be492d37fd314a) **App Configuration** Add your merchant ID and GUID to your account settings to complete the installation. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e744c4ec-c44f-7bf8-b5b7-90052dbdc552.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=867c07aa2232015273c4d1c1ad439a9e) ## To Uninstall the App Follow the steps below to uninstall the Global-e app from your website. 1. Navigate to Apps > Manage Apps. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-89be1319-fe05-bc36-d3dc-3f2755563639.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=65d113370049a8b87df9ae7b64409973) 2. Navigate to **Global-E App INT** and click on the three dots. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8229745f-dac1-55f0-ee2e-a86f61d5c392.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=876d4b8f887601b7dfb5b2373e339ee6) 3. Click **Delete**. A message pops up confirming your request to delete the app. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8337b95f-c7ae-617b-f579-0ff8a8028f33.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=09ab1bc7ee45fe744c5733ed562a66a8) 4. Click **Go to Editor**. A second confirmation message opens asking for your reason for installing the app. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4cbf35f4-804f-a559-45f3-5b6ecc6471da.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=e0a0c0a22ef22df6f40d1a72135a68c6) 5. Complete the mandatory fields and click **Delete App**. 6. Publish to save the changes. # Installing Global-e Modules Using a Zip File Source: https://docs.global-e.com/installing-global-e-modules-using-a-zip-file You can also install the Global-e modules by extracting the Zip file from Global-e, following the instructions below. ## To install Global-e modules using a zip file 1. Extract the zip file to the app/code directory. 2. Run the standard Magento2 deploy scripts. 3. Ensure that the Global-e modules are enabled: * Globale_BrowsingLite * Globale_OrderLite # Installing Global-e’s New Returns Solution Source: https://docs.global-e.com/installing-global-e-s-new-returns-solution ## To install the ReturnGO App 1. Find the ReturnGO app at the **Shopify App Store**. 2. Click **Install**. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-77337d5b-4f02-717d-e74c-0a05e751015c.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=001626ff080dc1ce3ef88dcf4c5ea9a6) 3. **Accept** the data permissions confirmation from Shopify. 4. Once installed, the ReturnGO app is displayed in **Shopify Admin > Apps** under the *Installed Apps* section. > [!NOTE] > > **Note:** Installing the ReturnGO app preserves all your existing Global-e functionalities and does not affect platform behavior. The new Returns solution goes into effect only on the date of your planned upgrade. # Integration Source: https://docs.global-e.com/integration-sap-hybris When you sign up with Global-e, Global-e creates a Merchant account in the Global-e system and sends you your Global-e Merchant credentials. * Global‑e Merchant ID: The ID of your Global‑e account * Global‑e Merchant GUID: A GUID number for your Global‑e account. Note that Global‑e sends you a different GUID for staging and production. Make sure to use the correct GUID. * In addition, Global‑e sends you a URL to download the installation files via Bitbucket. **Before Getting Started** If you have not done so yet, make sure to share the following with Global‑e: * Your Bitbucket account. * The features you want Global‑e to support: the list of countries and special features such as Fixed Prices, multiple sites, and more. **Integration Steps** | | **Description** | **Responsibility** | | - | - | - | | **Step 1** | **Sandbox:** Prepare a sandbox with your site for testing purposes. Send us the URL of your sandbox. Send us Admin permissions and credentials for:   – Your Sandbox   – Your site   – Your Backoffice: Products, Orders, and Promotions. Note: You may need to whitelist Global‑e IPs. **Notifications** Whitelist your network notifications: Obtain Global-e's IP range and use it to configure your network security settings to accept the Global-e notifications. For each merchant website, request that Global‑e configures where notifications should be sent.Note that Global‑e calls: `/globalerest/*` (multiple endpoints) | Merchant | | **Step 2** | **Install and configure the Global‑e Add-on:** Download the Global‑e Add-on and install it in your sandbox using Recipe or by performing the installation manually. See [Installation](/installation-sap-hybris). Open the `local.properties` file and add your merchant credentials (GUID and Merchant ID). See [Configure the Global‑e Add-on](/installation-sap-hybris#configure-the-global-e-add-on). Configure additional settings, as required. See [Additional Settings](/installation-sap-hybris#additional-settings). | Merchant | | **Step 3** | **Storefront settings:** Make sure that the order history (My Account page) displays Global‑e’s international prices correctly to customers. See [My Account](/global-e-storefront-functionality#my-account). | Merchant | | **Step 4** | Solve possible issues arising after installation. | Global‑e and Merchant | | **Step 5** | Global‑e enables and manages Global‑e countries, price conversion, and Global‑e checkout. The Add-on runs the following APIs automatically when the relevant action is triggered: **`SendOrderToMerchant`**: transfers new orders from Global‑e to SAP/Hybris. **`PerformOrderPayment`**: Notifies the merchant that the payment was authorised. **`UpdateOrderShippingInfo`**: Updates the order status and status history and updates the shipping addresses. **`UpdateOrderStatus`**: Updates the Hybris order status according to data from Global-e to notify the merchant of any change made to an order (such as cancellation, status change, and more…) You can create listeners for these events. | Global‑e | **What's Next:** * Discover the Bespoke Functionality. * Price Settings and Price Conversion * Merchandising: Promotions, Restricted and Forbidden Products. * Managing Orders * Cart and Checkout * [In-Depth: Discover the Global‑e Add-on extensions and implement custom functionality](/add-on-extensions-and-custom-functionality) * Known Limitations ## Integration Flows ### End-to-end Flows (High-Level) ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-4b391b2d-d986-db54-5786-6853dce9b6b6.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=dc997b6b7ef7bd20d1195f06cad0ec31) ### Global‑e Hybris Order and Checkout Flow ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-acc99c59-ae7b-3e95-8c5f-063c870e3b33.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=f01ef9b33b1fc695cff19469e7d61064) 1. When a customer proceeds to checkout (1), Global-e verifies if the selected shipping country is operated by Global-e. 2. If operated by Global‑e, the SentCart API is used to send all relevant information about the products and customer details to Global‑e (2). 3. Subsequently, Global‑e creates a cart on the Global‑e side and returns the cart token to SAP Commerce (Hybris). 4. Global‑e uses this cart token to initiate the checkout process (3). 5. Global‑e then makes a server-to-server API call to SAP, triggering the creation of an order on the SAP Ecommerce (Hybris) side (4,5). ### Scripts The following Global‑e scripts are installed. * Global‑e CSS * The JavaScript code is installed on all site pages and the Checkout Page. # Integration Source: https://docs.global-e.com/integration-shopify-native ## Integration Overview ### Integration ### Shopify Admin - Order Details > [card] > > ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-db0ae466-4cec-b0cb-598e-f09db61f0740.jpg?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=88de43055f7bc54cd5ccd8eeb5c5a603) > [card] > > ✓ Order created as per customer transaction > > ✓ Custom properties: Global-e order id > > ✓ “Global-e Carrier Service” shipping source with the actual shipper > > ✓ Global-e payment gateway > > ✓ Fraud approval order tag > > ✓ End-customer billing and shipping ### Integration Overview: With Global‑e ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-76cc277e-d3b5-e3c8-63ce-8966fee49ddb.svg?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=c7eeb5d7b5c0997ca42a010be947606c) ### Limitations * Available on Shopify Advanced and Plus plans. * Refund an order using a gift card only in Shopify Plus plan. ### Integration Details Before beginning the setup, ensure the following conditions are met: 1. A Shopify Sandbox is available for pilot testing and rollout preparation. 2. Fraud approval for export from Shopify must be fulfilled based on the order tag, not the “PAID” status. 3. Install the following Global‑e Apps: 1. CrossBorder app 2. Payment app 4. Set up Alternative Payment Methods: Enable Shopify Payments. > [!NOTE] > > Scripts tags and theme includes (e.g. checkout) automatically added. This only applies to checkout for headless setups ### Downstream Flow Behind Shopify ### Order Flow Adjustments | Item | Requirements | | - | - | | **Order export from Shopify** | Fraud approval order tag “Globale::Approved” | | **Order identification – Finance** | **Shopify Order payment gateway** "Global‑e Payments" | | **Order identification – Shipping** | **Shopify Order shipping_lines** “code“ contains “GLOBALE”: e.g. *“123_GLOBALE_HIDDEN_DDP“* *Or* “title” will be service level such as “Standard Courier” *Or* "source": "Global‑e Carrier Service“ | | **Order Processing - Shipping** | **Shopify order number** required (not order name or id) for processing on GE PortalGlobal‑e order id stored as order note attribute “GEOrderId” **Using SKU or UPC Shopify Product field for fulfilment?** | | **Disable OMS updates to Shopify** | If using GE Admin : Fulfilment updates **– will be fed back by Global‑e** Refund updates **– will be fed back by Global‑e** | ### Update Product Details from Shopify to Global-e This section described the Global-e flow for updating product details from Shopify to Global-e. **To update product details from Shopify to Global-e:** 1. Each time a product is added or updated in Shopify, Global-e gets the `ProductUpdated` webhook from Shopify. 2. Global-e writes the message to Kafka. 3. A Global-e service reads the message from Kafka. 4. Kafka calls the following Shopify APIs: `GraphGetInventoryItems` `GetProductService` 5. For each variant, Global-e creates a product based on Webhook Data (`apiProduct`). 6. After validation, the Global-e service calls the internal Global-e API `SaveProductListAPI` (`updatedProducts` is the list of variants that was just created). ### Shopify-to-Global-e Field Mapping When performing an update, Global-e reviews the following fields. This process applies to all products. | Shopify Field | GE System Field | Description | | - | - | - | | Title | Name | The name of the product. | | BodyHtml (HTML removed) | Description | Product description in plain text. | | Variant ID | ProductCode | Unique identifier for each product variant. | | Variant SKU or Variant Barcode | ProductCodeSecondary | Secondary identifier, often the SKU or Barcode, depending on the configuration on the Global-e side. | | Product ID | ProductGroupCode | Identifier for the product group. | | Variant Price | OriginalSalePrice | The sale price of the product. | | Variant CompareAtPrice | OriginalListPrice | The original list price of the product. | | Product Images | ImageURL | URL of the product's primary image. | | https\://\{AdminDomain}/products/\{Product Handle}?variant=\{Variant ID} | URL | URL to the product page in your Shopify store. | | Tags | Categories, ProductClassCode | Product categorization based on tags. | | InventoryItem CountryCodeOfOrigin | OriginCountryCode | The country of origin of the product. | | InventoryItem RequiresShipping | IsVirtual | Determines if the product is a virtual good. | | InventoryItem HarmonizedSystemCode | GenericHSCode | Harmonized System Code for international shipping. | | Options | Attributes | The product attribute. The product can have up to three attributes, for example, size + colour + material. | | Title | productNameEnglish | When using translation, the Shopify title is translated to productNameEnglish. | | BodyHtml (HTML removed) | productDescriptionEnglish | When using translation, the Shopify Product Description is translated to productDescriptionEnglish | | Tags | IsBlockedForGlobalE | Global-e has blocked the product based on Global-e's MAS internal parameter and Shopify tags. | ## Integration Summary 1. Global‑e creates an account for the merchant in the Global‑e system. 2. Global‑e requests user access and permissions to the merchant's site. 3. The merchant [installs the Global-e CrossBorder application](/installation-shopify-native). 4. The merchant [installs the Global-e Payment application](/installation-shopify-native). 5. Optional: The merchant installs the required 3rd party applications (geolocation, search, analytics, and more). 6. The merchant performs the required [website adjustments](/storefront-modifications-liquid-storefronts#storefront-modifications--liquid-storefronts-) (country selector, geolocation, and more). 7. The merchant and Global-e gradually enable Global-e countries, first by validating the functionality of a few operated countries, and then adding the remaining countries. ## Additional Integration Features ### Alternative payment methods in Shopify Checkout On Shopify Checkout, Global-e can show alternative payment method icons on the Payment step. When enabled for your store, the icon row appears in one of two positions relative to the card payment section. #### Placement options **Below the card section** - Alternative payment icons appear **below** the card payment section (for example under **More payment options** or in a **Payment options** row at the bottom of the Payment step). Shoppers complete or skip the card section first, then see the icon row. ![Shopify Checkout Payment step with Payment options icons below the card form](https://mintcdn.com/globale-enterprise/Lh5MiIfGrbLzRzM2/images/integration-shopify-native-apm-placement-below.png?fit=max\&auto=format\&n=Lh5MiIfGrbLzRzM2\&q=85\&s=cad9039ffc46ab3c139483b7706c43e9) **Above the card section** - A labeled row with alternative payment icons (for example PayPal, Klarna, Apple Pay) appears **above** credit or debit card fields. Shoppers see which methods are available before they enter card details. In this layout, short text can point shoppers to **More payment options** when they need to choose an alternative method. ![Shopify Checkout Payment step with alternative payment icons above the card section](https://mintcdn.com/globale-enterprise/Lh5MiIfGrbLzRzM2/images/integration-shopify-native-apm-placement-above.png?fit=max\&auto=format\&n=Lh5MiIfGrbLzRzM2\&q=85\&s=a4803e4ac5c52741c19bfee299e52036) #### What stays the same * Only payment methods already offered for the shopper's destination can appear. * Icons reflect methods enabled for your Global-e checkout; the set can differ by country. * Placement does not add or remove payment methods. It only changes where the icon row appears on the Payment step. To request **above** or **below** placement for your store, contact your Customer Success Manager. ### Analytics Use the Shopify checkout object to map Shopify data to any Analytics party. **Example of GA4 Mapping** | Shopify Native | Google Analytics 4 | Description | | - | - | - | | `checkout.line_items[line_item_count].product_id` | Item_id | Product SKU | | `checkout.line_items[line_item_count].title` | Item_name | Product name | | `checkout.presentment_currency` | Currency | Local currency | | `checkout.line_items[line_item_count].price –` `checkout.line_items[line_item_count] –` `.discount_allocations[line_item_count].amount` | Price | Product price in local currency.You must add the logic to deduct discounts from the product price. | | `checkout.line_items[line_item_count].quantity` | Quantity | Product quantity | | `checkout.order_id` | transaction_id | Order ID | | `checkout.subtotal_price` | Value | Order value (excluding shipping and tax) in local currency. | | `checkout.total_tax` | Tax | The customer paid the tax in local currency. | | `checkout.shipping_rate.price` | Shipping | The customer paid the shipping cost in local currency. | ### Marketing Feeds (Liquid Storefronts) **Domestic Feeds** To prevent price mismatches between the feed and the prices appearing on the storefront due to automatic geo-IP detection and redirection features, you must update the product links in their domestic feeds. All domestic product links should append the country parameter with the 2-letter country code of their domestic market. **Example**: For a US merchant: [https://www.mystore.com/products/red-shirt?country=US](https://www.mystore.com/products/red-shirt?country=US) Failure to do this may result in warnings from Google, after which they will prevent your from submitting marketing feeds. **International feeds** There are 3 main methods you can use to generate an international Marketing feed: * Using supported Shopify apps (recommended). * Manually generating the feed yourself by writing a custom script or program, or creating an Excel sheet. * Using a 3rd party service such as [Feedonomics](https://feedonomics.com/) or [Channel Advisor](https://go.channeladvisor.com/BigCommerce-ChannelAdvisor.html). **Supported Shopify apps** The following apps are compatible with Shopify Markets' multi-currency features: * [Multifeed Google Shopping Feed](https://apps.shopify.com/multiple-google-shopping-feeds?show_store_picker=1) * [GoDataFeed](https://apps.shopify.com/godatafeed?show_store_picker=1) * [Mulwi](https://apps.shopify.com/omega-shopping-feeds?show_store_picker=1) **Pricing in the feed** International prices in marketing feeds must be retrieved from the Shopify platform to ensure they are correct. Due to the complexity of doing this via the APIs, most merchants use a compatible app, which can easily generate the feeds with the correct localized prices. Alternatively, if you are using a 3rd party vendor such as Feedonomics, they will handle this for you. Feedonomics will have you create a custom app and share the API key with them.  This will allow them to retrieve the international prices directly from the Shopify contextualized price API **Shopify Markets API for product price retrieval:** * [https://shopify.dev/custom-storefronts/internationalization/international-pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * [https://shopify.dev/api/admin-graphql/2022-01/queries/priceList](https://shopify.dev/api/admin-graphql/2022-01/queries/priceList) **Retrieving Prices Manually** To generate your own marketing feed you need to generate the prices manually in one of the following ways: * Get the price data via Shopify Product Feeds feature. This is likely the most efficient method to retrieve all product pricing data. For more information see [Developer Changelog](https://shopify.dev/changelog/contextual-product-feeds-are-generally-available), [Product Feeds,](https://shopify.dev/docs/api/admin-graphql/2023-07/queries/productFeeds) and [Unidirectional Product Synchronization](https://shopify.dev/docs/marketplaces/shops/product-sync#product-feeds) * Get the price data via Shopify storefront API. For more information see [Query Product Prices.](https://shopify.dev/docs/custom-storefronts/building-with-the-storefront-api/markets/international-pricing#query-product-prices) * Get the price data via Shopify Admin API. * Option 1: * Step 1: Get the price ID for each market. For example, CA Price, AU Price etc. See [Pricelists API](https://shopify.dev/docs/api/admin-graphql/2023-07/queries/priceLists). * Step 2: Get the localized price for each product, using the price IDs. See [Pricelist API](https://shopify.dev/docs/api/admin-graphql/2023-07/queries/priceList) * Option 2: use the `contextualPricing` request to retrieve the price for each variant and country combination. For example, replacing `ProductVariant` and country with each request: ``` { productVariant(id:"gid://shopify/ProductVariant/39999460245576") { id product{id} contextualPricing(context:{country:CA}) { price{amount, currencyCode} compareAtPrice{amount, currencyCode} } } } ``` > [!NOTE] > > These queries can be set up as [bulk operation](https://shopify.dev/docs/api/usage/bulk-operations/queries)s which do not count against rate limits but may take significantly longer to complete. **Country and language considerations** If you have subfolders enabled, you can use the subfolders in your product URLs. **Example**: [https://mystore.com/\*\*en-ca\*\*/product/shoes](https://mystore.com/**en-ca**/product/shoes) You can also use the country parameter, regardless of the subfolder settings. If you do have subfolders enabled, this link will redirect the customer to the appropriate subfolder. **Example:** [https://mystore.com/product/shoes](https://mystore.com/product/shoes) **?country=CA** You can use the subfolder and country parameter together, but this is redundant and not recommended. **Example:** [https://mystore.com/\*\*en-ca\*\*/product/shoes?\*\*country=CA](https://mystore.com/**en-ca**/product/shoes?**country=CA)\*\* Note: If the countries do not match, the country parameter takes precedence. If you have translations for a country’s default language, you can use subfolders to indicate that in the product URL. **Example**: [https://mystore.com/\*\*es-es\*\*/product/shoes](https://mystore.com/**es-es**/product/shoes) **Timing** * Merchants in PCE countries: You should generate your feeds at 5:00 AM UTC to ensure the daily FX price updates are completed. This configured time may shift to an hour earlier during daylight savings time. * Merchants in CBS countries: You should generate your feed at 1AM UTC to ensure the updated country FX rate is in Shopify. **Updating product links** The following methods allow you to update your product links to include the targeted international country by leveraging: * Shopify’s Deep Linking feature: Include a country parameter in your product links ([https://help.shopify.com/en/manual/markets/international-domains/directing-customers/deep-links](https://help.shopify.com/en/manual/markets/international-domains/directing-customers/deep-links)) Example: \[https\://merchant_url/products/t-shirt?country=DE]\(https\:// https\://merchant_url/products/t-shirt?country=DE) \[Product page for Germany] * Shopify’s subfolder feature. This feature is required if you plan to use the Shopify translation features and requires additional configuration by Global‑e. Example: * [https://merchant_url/en-de/collections/products/t-shirt](https://merchant_url/en-de/collections/products/t-shirt) \[Product page for Germany] * [https://merchant_url/en-ca/collections/products/t-shirt](https://merchant_url/en-ca/collections/products/t-shirt) \[Product page for Canada] > [!NOTE] > > For headless merchants: Any country-specific URL logic for your Shopping feeds must be implemented by your development team, as the above-documented methods only work for Liquid-based storefronts out of the box. For more information, see the [Headless](/headless-integration) section under Shopping / Marketing Feeds. ### Fixed Price Management ### Overview The **Fixed Price Management** feature lets you manage your local market prices by uploading a file describing the fixed prices for specific products and territories. Note that these prices override Shopify pricelists set via API, ignoring country or currency restrictions. In the past you could only submit new prices to update immediately. Now you can select a date and time for your price submissions to go into effect. The following figure shows the Fixed Price Management screen: ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-542c5fdd-b48c-f72e-50f7-646030fb90e8.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=b7bb90f8041b5332e522f37c3182f465) ### Uploaded File Table The following figure shows the uploaded file table: ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-732bbda3-d56f-56bf-ed34-5339c3b8ad10.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=9519587f479f440392e23642c59d3dee) The table above shows the file, status, submission date, effective date, and user. ### Accessing Fixed Price Management **To access the Fixed Price Management feature** 1. Navigate to Merchants > Product Management > Fixed Price Management from the top menu. 2. Select a merchant from merchant menu located at the top of the page. ### Setting Up Your Price Sheet Price sheets you submit must be in CSV format, and you can download a sample CSV format to use as the basis for your submissions by clicking **Download Sample**. The sample file includes an example and explanation of each value. Price sheets require the following information: | **Header** | **Description** | **Example** | | - | - | - | | sku | Enter the Product SKU as it appears in your product catalogue. The SKU may not include spaces.If you are using barcodes instead of SKU, this field must contain the barcode. However, leave the column name as “SKU”. | AD-01-white-6 | | variant_id | Enter the Product Variant ID, as assigned in your product catalogue.If this field is empty, the SKU field must be populated. | 36485954240671 | | country_code | Enter the ISO-2 country code to indicate the country relevant to this price.For instance, DE (Germany), US (USA).If this field is empty, the currency_code field must be populated. | DE | | currency_code | Enter the 3-char currency code (ISO-4271) to indicate the currency relevant for this change.For instance, USD (US dollar), AUD (Australian dollar), EUR (Euro), CHF (Swiss franc), and more.This field is required. | EUR | | price | Enter the fixed price value for the product. This value can only contain numbers.CautionDo not include commas in the prices you list in the CSV file as the prices will not parse correctly.Keep empty to remove a previously set fixed price without setting a new one. In this case, the dynamic price conversion rules set for the current country apply. | 29.95 | | compare_at_price | Enter the fixed price value of the product before the discount. This value can only contain numbers.CautionDo not include commas in the prices you list in the CSV file as the prices will not parse correctly.Keep empty to remove a previously set fixed price without setting a new one. In this case, the dynamic price conversion rules set for the current country apply. | 49.95 | ### Populating Your File Once you’ve set up your file, you can populate it. > [!NOTE] > > Global-e does not support uploading XLS files. Enabling **Editing** in your CSV file may cause your security settings to change the CSV file format to XLS. Before uploading a file, verify that you’ve saved it in the CSV format. > [!NOTE] > > Including commas in your file will not upload. **To populate your file** 1. Add a list of products with one product per row. 2. Save your file in CSV format. ### Submitting Price Sheets **To submit price sheets** 1. Select one of the following: * **Submit Now** – Skip to **Step 2**. * **Schedule Upload** – Set your start date and time. 2. Upload your csv file by clicking **Upload CSV File.** 3. Click **Submit**. The file is added to the table showing all the uploaded price sheets. 4. (Optional) If your file fails uploading, resolve the issue and continue with Step 5. See [Fixing Validation Errors](/integration-shopify-native#fixing-validation-errors) to identify and resolve the cause of your failed upload. 5. Provide an email address. > [!NOTE] > > You can sort the uploaded price sheets by date using the **From Date** and **To Date** fields to the right of the email field. Global‑e will send you a notification email when you upload a list and a follow-up email when the upload is completed. Note that you can dragdown the email address field from the arrows to see previously entered email addresses. ### Rescheduling Your Upload Date You can edit your upload schedule as long as your file in the **Ready for upload** stage and has not completed uploading. **To reschedule your upload date** 1. Click ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-391bb5f7-621a-b5a2-59ea-25369cfb2184.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=294411f9e513f3b0270fbdd5ab04011a) located at the far right in a row. 2. Reschedule your upload and click **Update**. ### Cancelling a Publish You can cancel a publish as long as your file has not completely unloaded. You can do by this by clicking ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-3410c76d-fb17-d4ad-487e-ac5f69791dda.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=1820817a7efff6993ca215e294619e77) located at the far right in a row. ### Reviewing Current Fixed Prices You can review your current fixed prices by downloading a CSV file containing the current fixed prices. To this, click ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2c804b8b-22d6-e99b-39b9-f85d4a481fd2.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=6c1533d752156a6584655097826f1bf4) located near the upper right corner of the table. ### Tracking File Status The Fixed Price Management feature displays the **file upload** and **file validation** statuses when you upload your files. This section describes these statuses. ### File Upload Statuses The file upload status describes whether your file has uploaded or not, due to an error. The file upload statuses are shown in the table below: | **Status** | **Description** | | - | - | | Ready for Upload | A submitted file containing some valid prices ready for upload on the scheduled date. | | Uploading | A submitted file in the process of being uploaded. | | Uploaded | An uploaded file with successfully updated prices. | | Partially Uploaded | An uploaded file with a combination of successfully updated and invalid prices. | | Failed | A completely invalid file. Invalid files are not uploaded. | | Canceled | A submitted file that a user manually canceled. | For more information on fixing validation errors, see [Fixing Validation Errors](/integration-shopify-native#fixing-validation-errors). ### File Validation Statuses The file validation status describes whether your file has been validated or not. The file validation statuses are shown in the table below: | **Indicator** | **Status** | **Description** | | - | - | - | | ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-992cc210-36dd-badc-75d5-2e2fc8d563be.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=5892e1fc231cc4e76cfedc2206394e29) | Valid | File validated | | ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-6a705964-c4be-a9b5-70a8-9618f7e6463b.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=b3cacb58f72b06debeaa8059844d6591) | Partially Valid | Some validation errors were found | | ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-92a7da1a-c74d-ebbe-7a91-27bd7e31a3ee.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=2ef1f2503384f271cb6352cdbefe9f48) | Invalid | No prices were accepted | You can click on the indicators displayed in the table, which opens a csv sheet containing only the valid or invalid rows respectively. All invalid files must be corrected and uploaded separately. For information on fixing validation errors, see [Fixing Validation Errors](/integration-shopify-native#fixing-validation-errors). ### Fixing Validation Errors This section describes the validation errors that may occur when you upload your price lists. | Error | Error Message | Resolution | | - | - | - | | Too many rowshave the same group key. Duplicates of \{Sku}\_\{VariantId} exceeded max allowed - 500 (near double size of countries count in the database). | The same SKU and Variant ID appear more than once for the same country on line \[Line Number]. Delete duplicate rows and retry. | | | Invalid SKU - SKU contains whitespace. | Invalid SKUs found in line: \[Line Number]. The SKU contains whitespace. Amend the SKU and retry. | Make sure to use unique names for the Product Code and Secondary Product Code. If the file contains an SKU and not a variant_id and the SKU is duplicate, the row is skipped. If the file contains both, an SKU and a variant_id , and the SKU is duplicate or does not exist, the row is skipped. We recommend uploading a file with either the SKU or the variant_id, not both. It is best to use variant_id and not an SKU since variant_id is unique in the Global‑e database whereas SKU is not unique (can be a duplicate SKU). | | Empty SKU and Variant ID - Both SKU and variant ID are missing. | Both SKU and Variant ID are missing in line: \[Line Number]. provide at least one to proceed. | See **Invalid SKU - SKU contains whitespace**. | | Empty Country and Currency Code - Missing country or currency code. | Both Country and Currency codes are missing in line: \[Line Number]. Please provide at least one to proceed. | See **Invalid SKU - SKU contains whitespace**. | | Invalid country code | Invalid or not operated country code: \[Line Number]. Provide a valid ISO-2 code (e.g., DE for Germany, US for USA) and make sure the country is operated by Global-e, then retry. | If the country, currency, or prices are empty, the entire CSV file fails. Make sure the file contains the correct information. | | Invalid currency code | Invalid currency code: \[Line Number]. Provide a valid ISO-4217 code (e.g., USD, EUR) and retry. | If the country, currency, or prices are empty, the entire CSV file fails. Make sure the file contains the correct information. | | Invalid price | Invalid price in line: \[Line Number]. Prices must be numeric. Delete the field content to remove the previously fixed price stored and type the new value. | | | Price cannot be set to zero (X2 for ListPrice/ SalePrice) - the price is zero. | Price cannot be zero, in line: \[Line Number]. Ensure the price is greater than 0 or leave the field empty and retry | | | Country-currency mismatch | Currency mismatch, in line: \[Line Number]. The currency code does not match the country. Use the correct currency for that country and retry. | | | Non-numeric product code | Non-numeric product code in line: \[Line Number]. Provide a numeric product code and retry. | | | Duplicated SKU | Duplicated SKU in line: \[Line Number]. Remove the duplicate SKU and retry. | See **Invalid SKU - SKU contains whitespace**. | | No matching SKU and variant product found in the database. | Missing SKU or Variant ID in line: \[Line Number]. No matching product was found in the database. Check the SKU and Variant ID and retry. | Make sure that the SKU / variant_id exists in Shopify before uploading the CSV file to Global‑e. (Make sure you have uploaded the product to Shopify before uploading the CSV file to Global‑e). | | Product code or secondary product code is not unique. | NA | See Invalid SKU - SKU contains whitespace. | | The file is not in CSV format. | | Make sure to save your file in CSV format. | | Wrong header | NA | Make sure the header is set as follows: sku,variant_id,country_code,currency_code,price,compare_at_price | | Spaces in the data | NA | Make sure that the data and header in the file do not contain spaces. | ### Fixed Prices Upload via API The Upload Fixed Prices API lets you upload your list of fixed prices to Global-e. In addition, you can check the upload status and retrieve the error file. ### Prerequisites Prepare your CSV file containing your list of fixed prices and populate it. Each column in your CSV file must have the following headers, respectively: * SKU * Variant_id * Country-code * Price * Compare_at_price Do not use commas as part of the values in the following fields: price and compare-at-price For more information, see [Set Up a New Price List](/integration-shopify-native#set-up-a-new-price-list). ### Authentication: MerchantGUID To implement API calls with Global-e the only required information is the `merchantGUID` provided by Global-e. For authentication, make sure to include your Merchant GUID as part of each call or as part of the header so that Global-e can verify your identity. Make sure to use the appropriate merchantGUID, depending on the Global‑e integration environment used for development or production purposes. See [Global-e Environments](/shipping-with-non-global-e-carriers#global-e-environments). **MerchantGUID in URL** Add your MerchantGUID as part of each API URL. **MerchantGUID as part of the header** Add your MerchantGUID as part of the header as illustrated below. ``` curl --location 'https://[globale domain]/[API]' \ --header 'MerchantGUID: ' \ --header 'Content-Type: application/json' \ --data-raw ' ``` ### Flow 1. Call the [UploadFile](/integration-shopify-native#uploadfile) endpoint to upload your Fixed Prices CSV file to Global-e. 2. Call the [GetUploadedFileDetails](/integration-shopify-native#getuploadedfiledetails) to get the details of the file you uploaded and verify the Upload status. 3. Call [GetFileWithValidationErrors](/integration-shopify-native#getfilewithvalidationerrors) to retrieve the file containing the errors. If previously configured, you can retrieve your configuration file, modify your price list, and re-upload it. However, note that the prices (data) are overwritten and a new `RunId` (Global-e ID) is created. ### UploadFile Upload your Fixed Price CSV File to Global-e. **MethodURL** ``` POST https:///PCE/UploadFile?merchantGUID= ``` **Request** `` (from data) **Response** ``` 200 OK: { "RunId": "03fb441b-55ec-4392-b0ae-2e1805c6f492" } ``` **Errors** | HTTP Status Code | Message | Description | | - | - | - | | `400` | \{ "Message": "CSV file contains rows with invalid  data. Make sure the file has the correct format and contains the correct information.", "Errors": \[ ",43416058200314,,PLN,201,201,400", ",43416058200314,FR,EUR,301,401,400"   ] } | This file has the wrong column format and/or values. Check the rows that returned the error. | | `400` | "Only one file should be uploaded. Make sure to upload only one file." | This endpoint expects only one file per request. | | `400` | "The uploaded file is empty and cannot be processed. Make sure to populate the file correctly." | The file is empty or did not load correctly. | | `400` | "The format of the uploaded file is incorrect. Please upload a CSV file. Make sure to save your file to .csv format." | The uploaded file had the wrong extension. | | `500` | "Failed to upload the file. Please contact Support." | This is an internal error. If it appears, please contact Support. | **CUrl EXAMPLE:** ``` curl--location--request POST 'https://.com/PCE/UploadFile?merchantGUID=' \ --form '=@"/.csv"' ``` ### GetUploadedFileDetails This endpoint returns the details of the uploaded file, including the upload completion status. **PATH:** \[https\://\ /PCE/GetUploadedFileDetails?merchantGUID=\\&runId=\]\(https\://\ /PCE/GetUploadedFileDetails?merchantGUID=\\&runId=\) **TYPE:** `GET` **RESPONSE:** ``` 200 OK: { "RunId": "84f9929c-1ea1-4edd-bc56-c4ef73a92e88", "FileName": "[Ecommerce_Platform_Name]_QA_Artem_01.08.2023_06_all_valid.csv", "DateCreated": "2023-08-11T10:04:57.462022+00:00", "Status": "Completed", "HasErrors": false, "CompletionPercentage": 100 } ``` **PARAMETERS:** | Parameter | Type | Description | | - | - | - | | `RunId` | string | The Global-e file IdSample UID format: `84f9929c-1ea1-4edd-bc56-c4ef73a92e88` | | `FileName` | string | The file name given by the merchant in CSV format | | `DateCreated` | string | The file upload date. | | `Status` | string | Statuses:`Submitted`: When the file is first uploaded, the status is set to "Submitted". (Submitted: 0%)`Processing`: As the file is being uploaded, the status changes to Processing. (Example: Processing: 64%)`Completed`: If the upload finishes without errors, the status changes to Complete. (Completed: 100%)`Failed`: If the upload fails due to an error, the status changes to Failed. See Errors to troubleshoot the issues. (Failed: 0%) | | `HasErrors` | bool | Whether the file upload has errors. | | `CompletionPercentage` | Integer | Shows the progress of the file upload completion in per cent.Note: The integer value is a number without the per cent symbol.Example: "CompletionPercentage": 100 | **ERRORS:** | HTTP Status Code | Message | Description | | - | - | - | | `400` | "Cannot find the information for the current runId!" | The application cannot find the upload with this `RunId`.This can happen if the file did not upload correctly, the `RunId` is empty, or if the `RunId` has been modified.Verify that your file has uploaded correctly and returns a valid `RunId`. | | `500` | "Failed to get the uploaded file’s \{runId} for PCE.” | Unexpected internal error during file upload. Please contact Support.PCE: Price Calculation Engine | ### GetFileWithValidationErrors This endpoint always returns a CSV file with the headers. If there are errors, the file contains the rows where errors were identified. **PATH:** \[https\://\ /PCE/GetFileWithValidationErrors?merchantGUID=\\&runId=\]\(https\://\ /PCE/GetFileWithValidationErrors?merchantGUID=\\&runId=\) **TYPE:** `GET` **RESPONSE:** ``` 200 OK: File (application/octet-stream) ``` **ERRORS:** | HTTP Status Code | Message | Description | | - | - | - | | `400` | "Cannot find the information for the current runId!" | The application cannot find the upload with this `RunId`.This can happen if the file did not upload correctly, the `RunId` is empty, or if the `RunId` has been modified.Verify that your file has uploaded correctly and returns a valid `RunId`. | | `400` | "Failed to get the validated file containing the rows with errors for PCE." | Unexpected internal error during file upload. Please contact Support.PCE: Price Calculation Engine | ### Set up a New Price List The following procedure details the steps required to set up a new list of fixed prices and upload it to Global‑e. ### Step 1. Prepare your Price List in CSV Format In your CSV file, make sure to name the columns headers A through F, as shown below: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-265aeb52-f5eb-c8cc-6037-6ef7b33921d0.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=29dfcc6f7228773c440684ce19fa0d17) ### Field Descriptions and Requirements | **Headers / Fields** | **Description** | | - | - | | **SKU** | Enter the Product SKU as it appears in your product catalogue . The SKU may not include spaces.If this field is empty, the `Variant ID` field must be populated. | | **Variant ID** | Enter the Product Variant ID, as assigned in your product catalogue .If this field is empty, the `SKU` field must be populated. | | **country_code** | Enter the ISO-2 country code to indicate the country relevant to this price.For instance, DE (Germany), US (USA).If this field is empty, the `currency_code` field must be populated. | | **currency_code** | Enter the 3-char currency code (ISO-4271) to indicate the currency relevant for this change.For instance, USD (US dollar), AUD (Australian dollar), EUR (Euro), CHF (Swiss franc), and more.If this field is empty, the `country_code` field must be populated. | | **price** | Enter the fixed price value for the product. This value can only contain numbers.CautionDo not include commas in the prices you list in the CSV file as the prices will not parse correctly.Keep empty to remove a previously set fixed price without setting a new one. In this case, the dynamic price conversion rules set for the current country apply. | | **compare_at_price** | Enter the fixed price value of the product before the discount. This value can only contain numbers.CautionDo not include commas in the prices you list in the CSV file as the prices will not parse correctly.Keep empty to remove a previously set fixed price without setting a new one. In this case, the dynamic price conversion rules set for the current country apply. | ### Step 2. Populate your CSV File > [!NOTE] > > When enabling editing in your CSV file, your security settings may change the CSV file format to Excel. Make sure to save your file back to CSV before uploading it to Global-e. **To populate your CSV file:** 1. Add your list of products, one product per row with the relevant information in the relevant column, according to the *Field Descriptions and Requirements* detailed in [Field Descriptions and Requirements](#field-descriptions-and-requirements). To ensure optimal accuracy, make sure to use the following values when populating fixed price data in your CSV file. > [!WARNING] > > Do not include commas in the prices you list in the CSV file as the prices will not parse correctly. * **Price per country and currency:** ``` Header: sku,variant_id,country_code,currency_code,price,compare_at_price Value: {{sku}},{{variant_id}},DE,EUR,6,6     ``` OR (based on `variant_id`): ``` Header: sku,variant_id,country_code,currency_code,price,compare_at_price Value: ,{{variant_id}},DE,EUR,6,6 ``` * **Price per currency (affects all countries with the same currency):** ``` Header: sku,variant_id,country_code,currency_code,price,compare_at_price Value: {{sku}},{{variant_id}},,EUR,6,6        ``` OR (based on `variant_id`): ``` Header: sku,variant_id,country_code,currency_code,price,compare_at_price Value: ,{{variant_id}},,EUR,6,6   ``` 2. When done, make sure to save your file as CSV. ### Multi-Hubs **Shipping from Multiple Countries using a Single Store** ### Overview You can use more hubs in various countries alongside your primary hub. This approach enables faster delivery times to customers and cost reduction for the merchant (Shipping, D\&T). You can operate hubs from different Shopify stores, but this only allows a fixed setup (one hub per destination) and adds the overhead of managing multiple stores. ### Multi Hub Models The Global-e Multi-hub solution for Shopify allows brands to fulfil orders to Global‑e operated markets from different locations worldwide. The following operational models are supported (depending on brand requirements). | Fixed model | Each warehouse serves only specific countries | | - | - | | Fallback model | Order fulfilment is performed at the local/regional warehouse used to serve specific countries but when stock is not available, order fulfilment falls back to the main warehouse. | | Fully Dynamic model | Each warehouse can be used to fulfil orders to any country | > [!NOTE] > > Currently, the Shopify routing logic prioritises the location based on the distance between the hub and the customer shipping address. Therefore, currently, orders must ship in their entirety from a single location. **Key Considerations** The following * Operations Countries to be served from each hub Options available for outbound and inbound shipping * Technical Order routing from checkout decision * Legal & Finance The Merchant and Global-e both have a local entity or registration in the country Goods are owned by the merchant at the point of sale to Global-e  Reconciliation and invoicing between the new contracting parties ### Scenarios | **Title** | **Description** | **Known issues / limitations** | | - | - | - | | **Multi storefronts with multi merchants** | Separate GE merchants, each configured on separate site/storewhen the origin is identified user is redirected to relevant store to complete checkoutCart and order history typically not maintained between sites which makes it a poor solution or create additional effort | catalog and restrictions configurations duplication | | **Single merchant no split** | Single merchant on one site with relevant checkout and billing rules loaded based on the cart hub country. | dual setups with EU only currently 1 reconciliation currency for all orders | ### Prerequisites Make sure you have the Shopify new order flow configured. Provide the following information to Global-e: | Topic | Notes | | - | - | | Logistics map - origins and destinations | Countries with hubs/stores ship from: Mapping of destinations to ship to from each origin All locations are serving the same products With fallback from the central warehouse if not available locally Note that currently, Shopify does not support ship-to-store or pick-up API/Admin coverage or requirements from each new location (same usual rules regarding API / fully shipping with your own carriers) | | Carriers | The list of carriers for outbound and returns logistics | | Storefront architecture | using one or multiple websites | | Stock decision logic | Make sure to choose the country from which to ship the stock before checkout, except for locations within the EU. | | Settlement Currency | Full order multi-hub:  For a single site, the reconciliation currency must be the same as your default Merchant currency. | | Legal/Commercial | Legal : The local entity or registration to be used for reconciliation Local stores and warehouses must be brand-owned; they may not be partners distributors, or franchises. | ### Integration Flow and Responsibilities This section details the activities that the Merchant and Global-e need to perform to prepare the setup for the feature. **To prepare the setup for this feature:** 1. The Merchant: 1. Sets up Shopify locations with product inventory in Shopify. 2. Sets up Shipping Profiles in Shopify. 3. Sets up Order Routing Rules in Shopify. See [Shopify Settings](/integration-shopify-native#shopify-settings). 2. Global-e configures the feature for you on the Global-e side. 3. The Merchant and Global-e collaborate to align and address the financial and operational requirements. ### Shopify Settings ### Set up the Location of Each Hub Create a location for each local hub. **Setup Locations (Settings → Locations)** ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c248453f-71f2-dbc2-5e63-e1e7e39bf4fc.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=26184b8d8ec3b00066b29a0ed9b282c7) ### Set up Product Availability in Each Location Define the stock availability of each product or variant per location. **Products → For Each Product Variant** ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-92d1c1d7-49e5-f0af-59c1-00ffebbeac08.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=b43bc12f25a0c08a984b02f8741619d6) You can hide products from markets where there are no hubs available for fulfilment. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-93a91836-3766-d9ff-6845-0c2945caba4b.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=b493de1e27c4c223d023572f4a4e4e3e) ### Set up Shipping Profiles Assign the shipping profile to each location. * Define the markets to be fulfilled from the location * Rate set a ‘Global-e Carrier Service’ (the relevant shipping services are configured on the Global-e side) **Settings → Shipping and delivery** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-899f175f-b472-8090-dbda-e1cd6a6966cf.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=b4666fba5f54267d30c69ad8a7645770) ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-ac4bd251-18f3-7d8f-9a06-e79f1a0641f8.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=9873b834854aee8d047aef940c8c0086) For fixed multi-hubs, set up each shipping origin only for the relevant destinations. For dynamic multi-hubs, set up shipping origins for all destinations. (Prerequisite - Shopify order routing is enabled for the store) ### Set up Order Routing Rules Define the order routing logic for the different locations as configured in your Shopify store, based on the selected operation model (fixed, fallback, or fully dynamic). Note that Global-e can request for this feature to be enabled if it is not already available in your store, **Settings → Shipping and delivery → Order routing** > [!NOTE] > > Since this is still an Early access feature, it requires that Shopify adds it to the merchant store. Shopify documentation: [https://help.shopify.com/en/manual/shipping/setting-up-and-managing-your-shipping/order-routing](https://help.shopify.com/en/manual/shipping/setting-up-and-managing-your-shipping/order-routing) ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e6b6b9ba-6147-d20f-1599-2e3a8eff5df2.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=e168b881407d7a6315ea624fe4a398d7) ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-809701d7-2929-113f-aa98-638e9f7f5664.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=105aa52ef8cdb915332f5808027170bb) * Select **Ship from the closest location** OR **Stay within the destination market** ### Set up Stock Availability for Each Hub To make sure that the Shopify routing logic can decide based on the stock available in each hub, clear the option “Continue selling when out of stock”. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-39b1e11f-015a-4573-62b2-b22d09d93199.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=11a4c8bd32e69c02084391e567940a1a) Make sure that all products have the same location settings in all shipping profiles. ### Taxes and Duties Global-e configures the taxes and duties for Merchants with domestic sales in the US or Canada. ### Mapping Orders to 3rd Party Systems ### Introduction This guide provides instructions on how to import Global-e orders from Shopify to systems such as an OMS/ERP, WMS or middleware. Key Shopify order data and high-level downstream order flow are illustrated for mapping purposes. If you are currently running live Global‑e’s previous Shopify integration and upgrading to the new version integrated natively into Shopify’s checkout, see [Migrating Global‑e to the Native App](/integration-shopify-native#migrating-global-e-to-the-native-app). ### Downstream Data Flow from Shopify Starting with the checkout, international prices, duties & taxes, and shipping methods are calculated by Global‑e. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-aa7080f4-4734-1d36-6fbf-f3ecc6b394ca.svg?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=a5191e6daf8f0ff89a9ab19803aea042) **Order Creation** Orders are created by Shopify, per Shopify’s [multi-currency concepts](https://www.shopify.com/partners/blog/multi-currency-app-developers) in two currencies: * **Presentment money:** This is the currency that the international customer sees on the storefront, cart, checkout, and transactional emails. * **Shop money:** This is the main currency of your Shopify store; this currency is also used for reporting and analytics. > [!NOTE] > > Shop money is what should be mapped downstream by your order management and accounting systems. **Fraud Check** Fraud check is managed by Global‑e for international orders, as follows: 1. Initial order creation has the payment status **PENDING** (financial_status property) > [!WARNING] > > **Do not submit any orders for fulfilment at this time and wait for Global‑e to complete the fraud check.** 2. When completed, the payment status gets updated to **PAID** . You can now submit orders for fulfilment. > [!NOTE] > > For merchants who have configured Shopify to capture payment at fulfilment or manually, the "AUTHORISED" status assigned by Shopify at order validation will be updated automatically to "PAID" by Global-e after a few minutes. **WMS and Operations** For Global‑e to generate international shipping labels and customs documents, the warehouse pick-pack process must reference the **Shopify order name** and **Shopify SKU**. Alternatively, you can use the Shopify order number. EAN, barcode, and variant ID. Contact Global‑e as an additional configuration may be needed in those cases. See [End-to-End Order Flow Interfaces](/integration-shopify-native#end-to-end-order-flow-interfaces) for an illustration of end-to-end interfaces between Shopify, OMS/ERP, and WMS. ### Shopify Order Data For illustration, this Shopify store is from a US merchant and the storefront currency is based on USD. A single product was purchased. Let’s examine two different order scenarios: * [Duties & taxes paid by the customer](/integration-shopify-native#duties---taxes-paid-by-the-customer) – the checkout explicitly displays D\&T-related line items. * [Duties & taxes inclusive/baked in the product prices](/integration-shopify-native#duties---taxes-included-in-the-product-price) – the merchant subsidizes the D\&T costs. ### Duties & Taxes Paid by the Customer Market: Israel. The customer pays separately for all the D\&T-related costs, including the customs clearance fee (CCF) represented here in the **Additional Fee** field. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-efccd0f5-f276-7505-5f40-3f127590d7eb.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=33191d32f1fec54c21b892cf95efe71f) > [!NOTE] > > The **Additional Details** section provides information; it is not required for data consumption. `CalculatedDutySubsidy` represents the total order level subsidy in storefront currency. In this example, there is no subsidy for this order, hence the \$0. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-390a003b-109a-4fcd-f302-67220474b0c0.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=745e477f99387cee46c9468506cdcd8f) **Total** ``` {"total_line_items_price_set":    {"shop_money":{"amount":"992.51","currency_code":"USD"},     "presentment_money":{"amount":"3650.00","currency_code":"ILS"}}} ``` **Current Subtotal Price** ``` "current_subtotal_price": "886.17", "current_subtotal_price_set": { "shop_money": { "amount": "886.17", "currency_code": "USD" }, ``` **Discount** ``` {"current_total_discounts_set":    {"shop_money":{"amount":"99.25","currency_code":"USD"},     "presentment_money":{"amount":"365.00","currency_code":"ILS"}}} ``` **Shipping** ``` {"total_shipping_price_set":    {"shop_money":{"amount":"10.00","currency_code":"USD"},     "presentment_money":{"amount":"36.78","currency_code":"ILS"}}} ``` **Duties** ``` {"current_total_duties_set": {"shop_money":{"amount":"0.00","currency_code":"USD"}, "presentment_money":{"amount":"0.00","currency_code":"ILS"}}} ``` **Tax** ``` {"current_total_tax_set":    {"shop money":{"amount":"172.33","currency_code":"USD"},     "presentment_money":{"amount":"633.74","currency_code":"ILS"}}} ``` **Additional Fee** ``` {"current_total_additional_fees_set":    {"shop_money":{"amount":"2.70","currency_code":"USD"},     "presentment_money":{"amount":"9.93","currency_code":"ILS"}}} ``` **Total** ``` {"current_total_price_set":    {"shop_money":{"amount":"1078.29","currency_code":"USD"},     "presentment_money":{"amount":"3965.45","currency_code":"ILS"}}} ``` > [!WARNING] > > The **Additional Fee** set is a new Shopify data line available in Shopify’s API release version 2023-04. See [https://shopify.dev/docs/api/admin-rest/2023-04/resources/order](https://shopify.dev/docs/api/admin-rest/2023-04/resources/order). ### Duties & Taxes Included in the Product Price Market: United Kingdom. Duties, taxes, and customs clearance fees are all-inclusive in the £500.00 product price in this example. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-58aafbdd-9122-82ca-086d-2d2a429856e8.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=2eb6ee3c83a0bd4501a83de89d618830) CalculatedDutySubsidy: 139.72 USD includes duties, VAT, and CCF. Notice here that the D\&T line items do not appear in the order details at all. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2b53a137-f974-080e-c63d-d75947982fcd.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=04e1373cea7ae8589eb5bbd4e2e54681) **Subtotal** ``` {"total_line_items_price_set":     {"shop_money":{"amount":"620.95","currency_code":"USD"},      "presentment_money":{"amount":"500.00","currency_code":"GBP"}}} ``` **Discount** ``` {"current_total_discounts_set":    {"shop_money":{"amount":"62.09","currency_code":"USD"},     "presentment_money":{"amount":"365.00","currency_code":"GBP"}}} ``` **Shipping** ``` {"total_shipping_price_set":    {"shop_money":{"amount":"12.42","currency_code":"USD"},     "presentment_money":{"amount":"15.00","currency_code":"GBP"}}} ``` **Total** ``` {"current_total_price_set":    {"shop_money":{"amount":"577.48","currency_code":"USD"},     "presentment_money":{"amount":"465.00","currency_code":"GBP"}}} ``` **Conclusion** * Duty, tax, and customs clearance fees (CCF) are all part of the overall duties and taxes calculation. * When a customer’s checkout displays duty & tax-related fees, these costs will appear as order line items. * Any subsidized costs, whether both duties and taxes or just duty or just taxes – will appear in the note attributes `CalculatedDutySubsidy` field. ### Accounting Perspective From a Shopify view, orders are created per customer B2C transaction with Global‑e. From an accounting perspective, orders should be treated as domestic B2B orders booked against a Global‑e account. You may book any order line items to calculate gross revenue, and of course, bear in mind that Global-e is responsible for handling remittance and filing of local VAT and other taxes in most scenarios. For estimated net revenue, you can subtract the `CalculatedDutySubsidy` field. For actual revenue, refer to the Global‑e financial reconciliation report. ### Shipping Lines When the Global-e CrossBorder app gets installed in Shopify, a shipping zone with Global-e operated countries is automatically added. The order shipping line data is standardized by Shopify and cannot be changed. ``` "shipping_lines": [{        "id": 4525092405308,        "code": "EXPRESS_GLOBALE_DDP",        "source": "Global‑e Carrier Service",        "title": "Express Courier (Air)" ``` **Field Description:** * Source: fixed value `Global‑e Carrier Service` * Title: For shipping from the US, two possible values only: `Express Courier (Air)` or `Standard Courier`. For other countries, several possible values, depending on the suggested shipping service levels: * Standard Courier * Express Courier (Air) * Tracked Post * Standard Delivery * Virtual Goods * Express Courier * Untracked Post * Store Collection * Standard Post * Express Shipping * Standard Shipping * Collection Point * Tracked Standard * Express Plus * Premium Standard * Tracked Post to Pickup location * Code: multiple permutations, depending on the service type. > [!WARNING] > > **The code always contains GLOBALE**. **Notes:** * For services in use for specific stores, contact a Project Manager. * When shipping from the US, note that only Express Courier (Air) and Standard Courier mappings are applicable. **Service Values**: | Express Courier (Air) | 5 possible permutations: `EXPRESS_GLOBALE_DDU` `EXPRESS_GLOBALE_OPT_DDP` `EXPRESS_GLOBALE_DDP` `EXPRESS_GLOBALE_HIDDEN_DDP` `EXPRESS_GLOBALE_TAX` | | - | - | | Standard Courier | 5 possible permutations: `STANDARD_GLOBALE_DDU` `STANDARD_GLOBALE_OPT_DDP` `STANDARD_GLOBALE_DDP` `STANDARD_GLOBALE_HIDDEN_DDP` `STANDARD_GLOBALE_TAX` | | Tracked Post | 5 possible permutations: `PRIORITYPOST_GLOBALE_DDU` `PRIORITYPOST_GLOBALE_OPT_DDP` `PRIORITYPOST_GLOBALE_DDP` `PRIORITYPOST_GLOBALE_HIDDEN_DDP` `PRIORITYPOST_GLOBALE_TAX` | | Standard Delivery | 5 possible permutations: `AIRMAIL_GLOBALE_DDU` `AIRMAIL_GLOBALE_OPT_DDP` `AIRMAIL_GLOBALE_DDP` `AIRMAIL_GLOBALE_HIDDEN_DDP` `AIRMAIL_GLOBALE_TAX` | | Virtual Goods | 5 possible permutations: `VIRTUALGOODS_GLOBALE_DDU` `VIRTUALGOODS_GLOBALE_OPT_DDP` `VIRTUALGOODS_GLOBALE_DDP` `VIRTUALGOODS_GLOBALE_HIDDEN_DDP` `VIRTUALGOODS_GLOBALE_TAX` | | Express Courier | 5 possible permutations: `EXPRESSCOURIERWITHOUTSAMEDAY_GLOBALE_DDU` `EXPRESSCOURIERWITHOUTSAMEDAY_GLOBALE_OPT_DDP` `EXPRESSCOURIERWITHOUTSAMEDAY_GLOBALE_DDP` `EXPRESSCOURIERWITHOUTSAMEDAY_GLOBALE_HIDDEN_DDP` `EXPRESSCOURIERWITHOUTSAMEDAY_GLOBALE_TAX` | | Untracked Post | 5 possible permutations: `UNTRACKEDPOST_GLOBALE_DDU` `UNTRACKEDPOST_GLOBALE_OPT_DDP` `UNTRACKEDPOST_GLOBALE_DDP` `UNTRACKEDPOST_GLOBALE_HIDDEN_DDP` `UNTRACKEDPOST_GLOBALE_TAX` | | Store Collection | 5 possible permutations: `STORECOLLECTION_GLOBALE_DDU` `STORECOLLECTION_GLOBALE_OPT_DDP` `STORECOLLECTION_GLOBALE_DDP` `STORECOLLECTION_GLOBALE_HIDDEN_DDP` `STORECOLLECTION_GLOBALE_TAX` | | Standard Post | 5 possible permutations: `STANDARDPOST_GLOBALE_DDU` `STANDARDPOST_GLOBALE_OPT_DDP` `STANDARDPOST_GLOBALE_DDP` `STANDARDPOST_GLOBALE_HIDDEN_DDP` `STANDARDPOST_GLOBALE_TAX` | | Express Shipping | 5 possible permutations: `EXPRESSSHIPPING_GLOBALE_DDU` `EXPRESSSHIPPING_GLOBALE_OPT_DDP` `EXPRESSSHIPPING_GLOBALE_DDP` `EXPRESSSHIPPING_GLOBALE_HIDDEN_DDP` `EXPRESSSHIPPING_GLOBALE_TAX` | | Standard Shipping | 5 possible permutations: `STANDARDSHIPPING_GLOBALE_DDU` `STANDARDSHIPPING_GLOBALE_OPT_DDP` `STANDARDSHIPPING_GLOBALE_DDP` `STANDARDSHIPPING_GLOBALE_HIDDEN_DDP` `STANDARDSHIPPING_GLOBALE_TAX` | | Collection Point | 5 possible permutations: `COLLECTIONPOINT_GLOBALE_DDU` `COLLECTIONPOINT_GLOBALE_OPT_DDP` `COLLECTIONPOINT_GLOBALE_DDP` `COLLECTIONPOINT_GLOBALE_HIDDEN_DDP` `COLLECTIONPOINT_GLOBALE_TAX` | | Tracked Standard | 5 possible permutations: `TRACKEDSTANDARD_GLOBALE_DDU` `TRACKEDSTANDARD_GLOBALE_OPT_DDP` `TRACKEDSTANDARD_GLOBALE_DDP` `TRACKEDSTANDARD_GLOBALE_HIDDEN_DDP` `TRACKEDSTANDARD_GLOBALE_TAX` | | Express Plus | 5 possible permutations: `EXPRESSPLUS_GLOBALE_DDU` `EXPRESSPLUS_GLOBALE_OPT_DDP` `EXPRESSPLUS_GLOBALE_DDP` `EXPRESSPLUS_GLOBALE_HIDDEN_DDP` `EXPRESSPLUS_GLOBALE_TAX` | | Premium Standard | 5 possible permutations: `PREMIUMSTANDARD_GLOBALE_DDU` `PREMIUMSTANDARD_GLOBALE_OPT_DDP` `PREMIUMSTANDARD_GLOBALE_DDP` `PREMIUMSTANDARD_GLOBALE_HIDDEN_DDP` `PREMIUMSTANDARD_GLOBALE_TAX` | | Tracked Post to Pickup location | 5 possible permutations: `TRACKEDPOSTTOPICKUPLOCATION_GLOBALE_DDU` `TRACKEDPOSTTOPICKUPLOCATION_GLOBALE_OPT_DDP` `TRACKEDPOSTTOPICKUPLOCATION_GLOBALE_DDP` `TRACKEDPOSTTOPICKUPLOCATION_GLOBALE_HIDDEN_DDP` `TRACKEDPOSTTOPICKUPLOCATION_GLOBALE_TAX` | ### Migrating Global‑e to the Native App If you are currently running live on the legacy version of the Global‑e integration with Shopify, a.k.a the “hosted checkout”, you must migrate to the latest version where Global‑e is natively integrated into Shopify’s checkout, as detailed in this section. The key differences for the Shopify order data are as follows: * **Order transaction** is no longer per B2B transaction in a single currency; instead, it is per customer B2C transaction with presentment currency and shop currency. The B2B VAT is no longer reflected in Shopify. * **Order id** - the Shopify `order_name` no longer starts with ‘GE’ (e.g., GE2034304US). The Order name is now assigned by Shopify as done for domestic orders (e.g., #1234). The Global‑e order id is available. * **Shipping lines/code** is now standardized by Shopify as explained in the previous section. * **Shipment confirmation emails** no longer come from Global‑e; instead, they are managed by Shopify and the merchant. * **Fraud approval** no changes to this flow. This flow is still relying on the payment status **`pending`** (before the fraud check) and a subsequent update to **`paid`** status upon fraud approval with the addition of an order tag **`Globale::Approved`**. * **Payment gateway** no longer shows **`globale`**; instead, it shows: * **`Global‑e Payment (INT)`** when installing the Global‑e payment method in the sandbox/staging mode. * **`Global‑e Payments`** when installing the Global‑e payment method in production mode. **Additional Details Section in Order Data** The Global‑e order is still available in Shopify but not upon initial order creation and only as a `note_attribute`, which is updated by the Global‑e Shopify app a few seconds after post-order creation. Example: ``` "order": { "id": 4525092405308, "name": "#1976", "note_attributes": [{ "name": "GEOrderId", "value": "GE10071428326US" } ``` ### Shopify Order JSON Example Below is an example of an order JSON file. Alternatively, you can download this example from [here](https://globaleonline.sharepoint.com/:u:/s/ExternalSharing/EV6nxR5uCvNMqn1FJ3q0UG8Bgk1zFUxg0mQonYXFyvauwA?e=qPguLL). ``` { "orders": [{ "id": 5288094433599, "admin_graphql_api_id": "gid://shopify/Order/5288094433599", "app_id": 580111, "browser_ip": "207.122.133.98", "buyer_accepts_marketing": false, "cancel_reason": null, "cancelled_at": null, "cart_token": "dca8943832f868ed5e6084c8f97a9d29", "checkout_id": 36643575464255, "checkout_token": "d9f4127c78947546efc15845cf0a0a0b", "client_details": { "accept_language": "en-GB,en-US;q=0.9,en;q=0.8", "browser_height": 802, "browser_ip": "207.122.133.98", "browser_width": 1688, "session_hash": null, "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36" }, "closed_at": null, "company": null, "confirmed": true, "contact_email": "email@testing.com", "created_at": "2023-03-31T03:46:56-04:00", "currency": "USD", "current_subtotal_price": "886.17", "current_subtotal_price_set": { "shop_money": { "amount": "886.17", "currency_code": "USD" }, "presentment_money": { "amount": "493020.00", "currency_code": "CRC" } }, "current_total_additional_fees_set": { "shop_money": { "amount": "2.70", "currency_code": "USD" }, "presentment_money": { "amount": "1502.00", "currency_code": "CRC" } }, "current_total_discounts": "98.46", "current_total_discounts_set": { "shop_money": { "amount": "98.46", "currency_code": "USD" }, "presentment_money": { "amount": "54780.00", "currency_code": "CRC" } }, "current_total_duties_set": { "shop_money": { "amount": "125.84", "currency_code": "USD" }, "presentment_money": { "amount": "70012.00", "currency_code": "CRC" } }, "current_total_price": "1169.56", "current_total_price_set": { "shop_money": { "amount": "1169.56", "currency_code": "USD" }, "presentment_money": { "amount": "650685.00", "currency_code": "CRC" } }, "current_total_tax": "144.85", "current_total_tax_set": { "shop_money": { "amount": "144.85", "currency_code": "USD" }, "presentment_money": { "amount": "80587.00", "currency_code": "CRC" } }, "customer_locale": "en-CN", "device_id": null, "discount_codes": [{ "code": "STGDISCOUNTTEST", "amount": "98.46", "type": "percentage" } ], "email": "email@testing.com", "estimated_taxes": false, "financial_status": "paid", "fulfillment_status": null, "landing_site": "/", "landing_site_ref": null, "location_id": null, "merchant_of_record_app_id": null, "name": "#TEST1057", "note": "", "note_attributes": [{ "name": "ftkn", "value": "9c73a8ad0f5c46e2bc74b295703f2ef3_1680248630954__UDF43_9ck" }, { "name": "GEOrderId", "value": "GE40705954US" }, { "name": "CalculatedDutiesSubsidy", "value": "0" }, { "name": "PaymentMethodName", "value": "PayPal" }, { "name": "InternationalOrderProductsForCustoms", "value": "{\"132522\":493020}" }, { "name": "DutiesPrePaid", "value": "True" } ], "number": 57, "order_number": 1057, "order_status_url": "https://demosite.myshopify.com/68893344063/orders/ 536686a3998499ce9916d052c5016ac3/ authenticate?key=68da9939c8b9dbed005fd7c26fef6ded", "original_total_additional_fees_set": { "shop_money": { "amount": "2.70", "currency_code": "USD" }, "presentment_money": { "amount": "1502.00", "currency_code": "CRC" } }, "original_total_duties_set": { "shop_money": { "amount": "125.84", "currency_code": "USD" }, "presentment_money": { "amount": "70012.00", "currency_code": "CRC" } }, "payment_gateway_names": [ "Global‑e Payment (INT)" ], "phone": null, "presentment_currency": "CRC", "processed_at": "2023-03-31T03:46:54-04:00", "reference": null, "referring_site": "", "source_identifier": null, "source_name": "web", "source_url": null, "subtotal_price": "886.17", "subtotal_price_set": { "shop_money": { "amount": "886.17", "currency_code": "USD" }, "presentment_money": { "amount": "493020.00", "currency_code": "CRC" } }, "tags": "Globale::Approved", "tax_lines": [{ "price": "144.85", "rate": 0.1611, "title": "GST", "price_set": { "shop_money": { "amount": "144.85", "currency_code": "USD" }, "presentment_money": { "amount": "80587.00", "currency_code": "CRC" } }, "channel_liable": false } ], "taxes_included": false, "test": false, "token": "536686a3998499ce9916d052c5016ac3", "total_discounts": "98.46", "total_discounts_set": { "shop_money": { "amount": "98.46", "currency_code": "USD" }, "presentment_money": { "amount": "54780.00", "currency_code": "CRC" } }, "total_line_items_price": "984.63", "total_line_items_price_set": { "shop_money": { "amount": "984.63", "currency_code": "USD" }, "presentment_money": { "amount": "547800.00", "currency_code": "CRC" } }, "total_outstanding": "0.00", "total_price": "1169.56", "total_price_set": { "shop_money": { "amount": "1169.56", "currency_code": "USD" }, "presentment_money": { "amount": "650685.00", "currency_code": "CRC" } }, "total_shipping_price_set": { "shop_money": { "amount": "10.00", "currency_code": "USD" }, "presentment_money": { "amount": "5564.00", "currency_code": "CRC" } }, "total_tax": "144.85", "total_tax_set": { "shop_money": { "amount": "144.85", "currency_code": "USD" }, "presentment_money": { "amount": "80587.00", "currency_code": "CRC" } }, "total_tip_received": "0.00", "total_weight": 0, "updated_at": "2023-03-31T03:47:56-04:00", "user_id": null, "billing_address": { "first_name": "Pura", "address1": "7 calle 40", "phone": "0000000000", "city": "San Jose", "zip": "10108", "province": "San José", "country": "Costa Rica", "last_name": "Vida", "address2": "", "company": null, "latitude": null, "longitude": null, "name": "Pura Vida", "country_code": "CR", "province_code": "CR-SJ" }, "customer": { "id": 6879453479231, "email": "email@testing.com", "accepts_marketing": false, "created_at": "2023-03-31T03:41:33-04:00", "updated_at": "2023-03-31T03:46:56-04:00", "first_name": "Pura", "last_name": "Vida", "state": "disabled", "note": null, "verified_email": true, "multipass_identifier": null, "tax_exempt": false, "phone": null, "email_marketing_consent": { "state": "not_subscribed", "opt_in_level": "single_opt_in", "consent_updated_at": null }, "sms_marketing_consent": null, "tags": "", "currency": "CRC", "accepts_marketing_updated_at": "2023-03-31T03:41:33-04:00", "marketing_opt_in_level": null, "tax_exemptions": [], "admin_graphql_api_id": "gid://shopify/Customer/6879453479231", "default_address": { "id": 9118520377663, "customer_id": 6879453479231, "first_name": "Pura", "last_name": "Vida", "company": null, "address1": "7 calle 40", "address2": "", "city": "San Jose", "province": "San José", "country": "Costa Rica", "zip": "10108", "phone": "0000000000", "name": "Pura Vida", "province_code": "CR-SJ", "country_code": "CR", "country_name": "Costa Rica", "default": true } }, "discount_applications": [{ "target_type": "line_item", "type": "discount_code", "value": "10.0", "value_type": "percentage", "allocation_method": "across", "target_selection": "all", "code": "STGDISCOUNTTEST" } ], "fulfillments": [], "line_items": [{ "id": 13786226262335, "admin_graphql_api_id": "gid://shopify/LineItem/13786226262335", "fulfillable_quantity": 1, "fulfillment_service": "manual", "fulfillment_status": null, "gift_card": false, "grams": 0, "name": "Top - Jacket / S / Cotton Knit", "pre_tax_price": "886.17", "pre_tax_price_set": { "shop_money": { "amount": "886.17", "currency_code": "USD" }, "presentment_money": { "amount": "493020.00", "currency_code": "CRC" } }, "price": "984.63", "price_set": { "shop_money": { "amount": "984.63", "currency_code": "USD" }, "presentment_money": { "amount": "547800.00", "currency_code": "CRC" } }, "product_exists": true, "product_id": 8090466287935, "properties": [], "quantity": 1, "requires_shipping": true, "sku": "132522", "taxable": true, "title": "Albion Top", "total_discount": "0.00", "total_discount_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "CRC" } }, "variant_id": 44134508134719, "variant_inventory_management": "shopify", "variant_title": "Jacket / S / Cotton Knit", "vendor": "Demo Site", "tax_lines": [{ "channel_liable": false, "price": "144.85", "price_set": { "shop_money": { "amount": "144.85", "currency_code": "USD" }, "presentment_money": { "amount": "80587.00", "currency_code": "CRC" } }, "rate": 0.1611, "title": "GST" } ], "duties": [{ "id": 94738514239, "admin_graphql_api_id": "gid://shopify/Duty/94738514239", "country_code_of_origin": "US", "harmonized_system_code": "620469", "price_set": { "shop_money": { "amount": "125.84", "currency_code": "USD" }, "presentment_money": { "amount": "70012.00", "currency_code": "CRC" } }, "tax_lines": [] } ], "discount_allocations": [{ "amount": "98.46", "amount_set": { "shop_money": { "amount": "98.46", "currency_code": "USD" }, "presentment_money": { "amount": "54780.00", "currency_code": "CRC" } }, "discount_application_index": 0 } ] } ], "payment_terms": null, "refunds": [], "shipping_address": { "first_name": "Pura", "address1": "7 calle 40", "phone": "0000000000", "city": "San Jose", "zip": "10108", "province": "San José", "country": "Costa Rica", "last_name": "Vida", "address2": "", "company": null, "latitude": null, "longitude": null, "name": "Pura Vida", "country_code": "CR", "province_code": "CR-SJ" }, "shipping_lines": [{ "id": 4328148566335, "carrier_identifier": "ddee56dd66ac115cce1900b8a4549ffb", "code": "EXPRESS_GLOBALE_OPT_DDP", "delivery_category": null, "discounted_price": "10.00", "discounted_price_set": { "shop_money": { "amount": "10.00", "currency_code": "USD" }, "presentment_money": { "amount": "5564.00", "currency_code": "CRC" } }, "phone": null, "price": "10.00", "price_set": { "shop_money": { "amount": "10.00", "currency_code": "USD" }, "presentment_money": { "amount": "5564.00", "currency_code": "CRC" } }, "requested_fulfillment_service_id": null, "source": "Global‑e Carrier Service", "title": "Express Courier (Air)", "tax_lines": [], "discount_allocations": [] } ] } ] } ``` ### End-to-End Order Flow Interfaces The following figure presents a general illustration of an order flow with Shopify to OMS to WMS and Global‑e. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2aa3022d-dc6c-2fa0-31a5-f7588bc77383.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=d4a4d5644ee112a9ab933772d5d28d1a) **Outbound** 1. **Order creation:** created in Shopify with the initial payment status '`PENDING`’ and order tag `Globale::Pending`. 2. **Fraud check:** upon successful fraud check (asynchronous process), the payment status is set to ‘`PAID`’ and the order tag is replaced with `Globale::Approved`. 3. **Export to OMS/WMS qualified orders:** with `PAID` status or tagged with `Globale::Approved`. 4. **Pick and pack:** the warehouse identifies orders via the Shopify order name/number and SKU/UPC. 5. **Label generation:** Global‑e interface provides the final mile carrier label + tracking # 6. **End-of-day manifest:** signals to Global‑e that the order is ready to be dispatched and generates an end-of-day document. 7. **Fulfilment update to Shopify:** in most scenarios, this event or the tracking # itself is provided by Global‑e. It is also expected for Shopify to send the shipment confirmation email when its fulfilment is created. # Integration Source: https://docs.global-e.com/integration-shopware ## Prerequisites Before getting started, make sure that you have the following: * An administrator account for your Platform. * A Global‑e Merchant account. * Your Global-e Merchant ID and Merchant GUID (provided to you by Global-e). ## Configuration Manual **Global-E API Settings** Configure the following settings to ensure seamless communication with Global-e. | Setting | Default | Description | | - | - | - | | Enable integration | Off | Allows enabling/disabling integration per sales channel. | | Enable included js/css | Off | Allows the enabling/disabling of external Global-e JavaScript and CSS includes. For headless integration, the setting should be disabled. | | Merchant ID | | The Merchant Identifier which allows identifying JavaScript and CSS includes. | | Merchant GUID | | The API key used for communication to and from Global-e. | | Environment | Integration | Determines the Global-e environment with which to establish communication. Integration or Staging are usually used for testing purposes. The Production Environment is used for live shop only. | You can also test your API configuration with the provided button. **Products** Configure these settings to synchronize specific product attributes with Global-e | Setting | Default | Description | | - | - | - | | Brand Attribute | | A technical name of a product custom field which is used as an extra product brand attribute. | | HS Code Attribute | | A technical name of a product custom field which is used as an extra product HS Code attribute. | | Description Attribute | | A technical name of a product custom field which is used as an extra product description attribute. | | Country of origin attribute | | A technical name of a product custom field which is used as an extra product country of origin attribute. | | Weight Attribute | | A technical name of a product custom field which is used as an extra product weight attribute. | **Checkout / Order** | Setting | Default | Description | | - | - | - | | JavaScript code that should run on the checkout page. | var glegem = glegem \|\| function()\{(window\["glegem"].q = window\["glegem"].q \|\| \[]).push(arguments)}; glegem("OnCheckoutStepLoaded",function(data)\{ console.log('OnCheckoutStepLoaded') switch(data.StepId)\{ case data.Steps.LOADED: console.log('OnCheckoutStepLoaded:LOADED') break; case data.Steps.CONFIRMATION: console.log('OnCheckoutStepLoaded:CONFIRMATION') } if (data.IsSuccess \&\& !data.IsPageReload)\{ // send some statistic } }); | JavaScript code snippet used to collect analytics info when Global-e checkout is shown and when a Global-e order is placed.For example snippets, see [Client Analytics](/client-analytics). | | Skip Cart Validation | Yes | Enables/disables cart validation on order create notification | | Enable refund request from platform | No | Allows the enabling/disabling of sending order refunds to Global-e. | | Update Global-E Order Addresses in Address Book | No | Allows the enabling/disabling of saving addresses used in Global-e orders. | | Move International Customer To Group | No | Allows the enabling/disabling of moving a customer-placed Global-e order to a customer group. | | International Customer Group name | | A customer group name used for international customers. | | Store Code | | A store code used by Global-e to distinguish sales channels on own domains and/or subfolders. | | Store Instance Code | | A store instance code used by Global-e to distinguish sales channels on our own domains and/or subfolders. | | Global-e Cookie Group | Required | A section of the Shopware cookie contest banner where Global-e cookies are registered. | ## Shopware Orders List ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e030c521-ba5f-f04d-aab1-516a6c2fe3ee.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=2dcbdaa409b1b2f2a8d9f744a714c6c0) ## Shopware Order Details ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5f665f7b-57f2-c19a-7315-b671c8a927d4.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=e02082cb763b0a8106f831fdc0d13509) ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-649b3124-e070-7f17-a9da-50be74c99b47.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=42b3b6a0d458ccece1f2f7c9185df086) International details stored on the order details page: * Global‑e Order ID * Total price in customer currency * Order created as **domestic** * Global‑e **payment** method * Global‑e **shipping** method * Customer international **billing** & **shipping** details > [!NOTE] > > The screenshots above are for a transaction in Polish złoty on a Shopware 5 instance using Euro as the base currency. # Integration Summary Source: https://docs.global-e.com/integration-summary-bespoke-module 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 1** | Prepare a sandbox storefront (close to production) for integration purposes, and share the URL with your Global-e Project Manager. | | **Step 2** | Customise 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](/storefront-implementation#the-global-e-module-javascript) and [The Global-e Module CSS](/storefront-implementation#the-global-e-module-css).2.Customise the following to match your brand: [Welcome Pop-Up](/site-customization-storefront#configuring-your-welcome-popup-page), [Country Switcher](/site-customization-storefront#configuring-your-switcher-popup-page), [Checkout Page](/site-customization-storefront#configuring-your-checkout-page), and [Marketing Banner](/marketing-banner).3.Tag your storefront prices with `data-ge-price` as documented [here](/storefront-attributes#general-price).4.Tag calculated prices on your cart page as documented [here](/storefront-attributes#basket---mini-basket).5.Tag your checkout button and the international Checkout container as documented [here](/storefront-attributes#checkout).6.Tag any elements that should be hidden or shown for international countries as [required.](/storefront-attributes#element-visibility) | | **Step 3** | Add a cart token for Global-e to retrieve the shopper’s cart via the [GetCheckoutCartInfo](/checkout-cart-info--from-global-e-) API you developed. This step must be completed before implementing [GetCheckoutCartInfo](/checkout-cart-info--from-global-e-) (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 4** | Prepare 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. | | **Step 5** | Implement 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.[GetCheckoutCartInfo](/checkout-cart-info--from-global-e-)**Important:** 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.[SendOrderToMerchant](/orders---placement-history)This API is required to create the customer order in your system, clear the user’s basket, and optionally reserve the inventory.[PerformOrderPayment](/orders---placement-history)This API is required to mark the order as confirmed as part of the fulfilment process in your system.[UpdateOrderStatus](/api-reference/update-order-status-from-globale)This 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 [Order Status Updates (Global-e to Merchant)](/order-status-updates--ge-to-m-).Share your endpoint URLs with Global-e.To implement additional non-essential APIs, see [Global-e API Reference](/api-reference/overview) and [API Integration Guides](/api-integration-guides). | | **Step 6** | Clear the cart after a successful international transaction. See [Clearing the Cart](/storefront-implementation#clearing-the-cart). | | **Step 7** | Implement client-side checkout and transaction analytics, see [Marketing Pixels](/client-analytics#marketing-pixels). | | **Step 8** | On 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 9** | [Prepare and Upload](/catalog-management#prepare-and-upload) as a CSV file to the Global-e server via SFTP.Continuously upload deltas. | | **Step 10** | Fulfillment and Dispatch Process.Use the [Global‑e Merchant Portal](/merchant-portal) for international order management and fulfillment, and other essential eCommerce operations. | Implement the four mandatory merchant endpoints listed in Step 5 above. This Implementation is mandatory. We recommend exposing API methods via HTTPS. Optionally, you can implement additional merchant APIs and APIs on the Global‑e Side. ## Special Features and Requirements * If some of your products have reduced VAT rates (for example, you are a UK merchant with children's clothing), set the relevant reduced VAT rates for these products in the HTML data attribute. See [Reduced VAT Rate Support](/storefront-attributes#reduced-vat-rate-support). * If you require support for product country exceptions (for example, restrict browsing before reaching the Global‑e checkout), set the relevant `data-countries` for these products in the HTML data attribute. See [Product-Specific VAT Rates in the EU and Restrictions](/storefront-attributes#product-specific-vat-rates-in-the-eu-and-restrictions). * If you require the application of price coefficients to specific product classes (for example, on premium items in specific territories), set the relevant data-pc for these products in the HTML data attribute and the `ProductClassCode` in the [GetCheckoutCartInfo (Global-e to Merchant)](/checkout-cart-info--from-global-e-) API. * If you require support for existing logistics accounts, call a Global‑e API method to download the international commercial invoice for the specified order. ## Integration Features | Feature | Description | | - | - | | Country and Currency Switcher | Select over 200 countries with default or free currencies (can be replaced by custom implementations). | | Currency Conversion | View prices in local currency with up-to-date conversion rates, country coefficients, rounding rules, and currency symbols. | | Duty and Tax Calculations | Select country and continent-specific duty and tax calculations. | | Shipping Options Engine | Select country-specific shipping options from standard to express with a tailored pricing policy. | | Local Payment Methods | Select from the most popular payment methods for each country. | | Promotions | Manage promotions for the Global-e operated countries. | | Customer Service | Manage Global-e Orders through the Customer Services Tool. | ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a590ce6c-584b-719a-debb-52ae9be43a66.jpg?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=a0600f08995fb1f67fb2c59d83680cdc) ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-4ac8a130-cbb6-b312-5468-02f876a2a338.jpg?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=e4754679e8e9d3d0caa94e5c3d7bd775) ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-eaa0f59c-3a31-82bd-3583-2522055efa1a.jpg?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=532af3a09f490bcc4ad2ec0b4cb27f6c) ## 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 ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-92a7a386-b757-7e22-7f4c-5c3a5fba85b0.svg?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=f0269de72ea6baec05590a31ab9f5f8c) ## High-Level Flow ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9a347d24-f4d9-3cc8-26e6-0eb55931b6a9.svg?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=f7818dd0d0037efeed9c9e4809fa945c) ## End-to-end Flows ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-dfcf918d-fdc5-17c2-88b2-fe49970a957c.svg?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=ad04fc7dc5170a58484fde10dde76af7) ## Customer Journey (Technical) ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-eaa3eafe-1832-a796-6127-104c6e241069.svg?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=128a1d5d5d395b732ad7dbadb1762e4e) ## End-to-End Conversion Tracking Continuity ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-ab557c6c-22b4-10cc-3706-ab35a2deb785.svg?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=8d31e584e0ddbd40de41893747e1787b) ## 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: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-18c32022-9d44-7fb3-3de3-492ba6df1970.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=4470aac060f918c18c737d7654b5d667) 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)](/checkout-cart-info--from-global-e-)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: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-28ebcf5e-f2af-7c88-6fe5-5a5b4968858f.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=5d9fccbdcb4c4242aa25cc28c04ab399) 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`. # Integration Summary Source: https://docs.global-e.com/integration-summary-configuration This section describes how to integrate Global-e with a Magento storefront. When you sign up with Global-e, a Merchant account is created in the Global-e system and sends you your Global-e merchant credentials: * Global‑e Merchant ID: The ID of your Global‑e account. * Global‑e Merchant GUID: A GUID number for your Global‑e account. Note that Global‑e sends you a different GUID for each applicable Global-e environment. * For the composer-based installation, Global-e provides repository details to add to your composer.json file, along with installation instructions. * Ensure you have shared with Global‑e the features you want Global‑e to support, including the list of countries and special features such as Fixed Prices, multiple sites, and more. ## To integrate Global-e with a Magento storefront 1. Prepare a sandbox storefront (as close to production) for integration purposes and send us the URL. For Base Authorization, share your username and password, along with your Magento Admin credentials (Admin URL, username, and password). 2. Install the Global-e module using Composer. See [Installation instructions.](/installation-magento2-lite) 3. Navigate to the Magento **Admin > Stores > Configuration > Services > Global-E Integration Lite** and fill in your Merchant ID, Merchant GUID, and the Global-e Environment. 4. Customise the [Welcome pop-up](/site-customization-storefront#configuring-your-welcome-popup-page), [Country Switcher](/site-customization-storefront#configuring-your-switcher-popup-page), *[Checkout Page](/site-customization-storefront#configuring-your-checkout-page),* and [Marketing Banner](/marketing-banner#overview) to match your brand. 5. [Prepare and Upload](/catalog-management#prepare-and-upload) as a CSV file to the Global-e server via SFTP. . Continuously upload deltas. # Integration tools Source: https://docs.global-e.com/integration-tools Leverage the Global-e API Section and the General API Reference for seamless integration of the Global-e solution. Explore our Integration Guides for guidance and samples for implementing APIs across all aspects of international order fulfillment. Refer to the SDK Section for details on Checkout In Cart Express Payment Methods, Events Summary, Client Analytics, Server Analytics, Marketing feeds, and more. For more information see, [SDK and API](/sdk-and-api). # Integration Source: https://docs.global-e.com/integration-wix **Browsing** **Bespoke Global-e Module Attributes** Global-e Module Attributes have been implemented into some of the UI elements of the store to automate the merchant integration process within the Global-e Module selectors needed in the browsing. These attributes should be configured in the Global-e Admin. We cover the following list of attributes: **Cart Settings:** * data-wix-item-total-price * data-wix-line-item-price * data-wix-cart-total-price * data-wix-line-item-id * data-wix-line-full-item-price * data-wix-product-compare-price **Shipping Switcher Settings:** The switcher is always located at the “global-e-ce-switcher” element. **Checkout Settings:** * data-wix-checkout-button **Price selectors:** * data-wix-price * data-wix-original-price **Elements to hide:** * data-wix-hideable > [!NOTE] > > The TS tool is used to manually hide an element that is not preselected with an attribute and which needs to be hidden. ## Automatic Catalogue Update The initial catalogue should be uploaded manually. To avoid the need for constantly updating the merchant’s catalogue in the Global-e database, we have added support for CORE’s API `SaveProductList` which is triggered by the relevant Wix webhooks (listed below) to update any changes the merchant has made on the catalogcatalogue from the platform. The following fields are sent to Global-e with each update: * Name * Description * Weight * `ProductCode` (from SKU) * `ProductCodeSecondary` (from variant id) * `ProductGroupCode` (from product id) * `OriginalListPrice` (from price) * `OriginalSalePrice` (from discounted price) * URL * IsVirtual (from product type different than physical) ## Cart and Checkout **GetCart** **Example:** ``` { "CartToken":null, "ClientIP":"54.76.161.209", "CountryCode":"IL", "Culture":{ "CultureCode":"he", "InputDataCultureCode":null, "PreferedCultureCode":null }, "Currency":{ "CurrencyCode":"ILS", "OriginalCurrencyCode":"GBP" }, "Discounts":[ { "Name":"10%All2", "DiscountCode":"40819d8c-1ad8-46e0-8b86-e3159487fd72", "OriginalDiscountValue":6.9, "DiscountValue":34.5, "ProductCartItemId":null, "LocalVATRate":20.000000000000000000000000000, "VATRate":20.000000000000000000000000000, "DiscountType":1, "CouponCode":"15%All2", "Description":null, "IsFreeShipping":false, "CalculationMode":1, "DiscountSource":1, "BenefitExternalId":null }], "FreeShipping":null, "HubId":null, "LocalShippingOptions":[ { "Carrier":"globaleintegration_standard", "CarrierName":"globaleintegration_standard", "CarrierTitle":"globaleintegration_standard", "Code":"globaleintegration_standard", "IsPreferred":true, "Method":"globaleintegration_standard", "MethodDescription":"globaleintegration_standard", "MethodTitle":"globaleintegration_standard", "Price":0.0 }], "LoyaltyData":null, "LoyaltyPoints":null, "Benefits":null, "MerchantCartHash":"EA9BFCB402065D2B93118B4D0F49203C", "MerchantCartToken":"e35774a9-7284-4296-b6c4-9ed1f14e1b03", "PaymentInstallments":null, "PriceModification":{ "IncludeVAT":null, "PriceCoefficientRate":1.000000, "RoundingRuleId":11220 }, "Products":[ { "ProductCode":"0006", "ProductCodeSecondary":null, "OrderedQuantity":1, "OriginalSalePrice":22.0, "OriginalListPrice":22.0, "OriginalMerchantPriceForDuties":null, "OriginalMerchantUnitSalePrice":22.0, "ListPrice":110.0000, "SalePrice":110.0000, "SalePriceBeforeRounding":107.848145823000000000, "MerchantPriceForDuties":null, "CartItemId":"00000000-0000-0000-0000-000000000001", "Name":"I'm a product", "ImageURL":"https://static.wixstatic.com/media/c837a6_dff384ebdb954fd9a5903b028ce213c7~mv2.jpg", "IsFixedPrice":false, "VATRateType":{ "VATRateTypeCode":"vatRateType_GB_20.0", "Name":"vatRateType_GB_20.0", "Rate":20.0, "InternalVATRateTypeId":0 }, "LocalVATRateType":{ "VATRateTypeCode":"vatRateType_GB_20.0", "Name":"vatRateType_GB_20.0", "Rate":20.0, "InternalVATRateTypeId":0 }, "Description":null, "ProductVatRate":null, "Keywords":null, "URL":null, "OriginCountryCode":"", "IsBlockedForGlobalE":false, "Attributes":[ ], "ProductGroupCode":"1a2d7e83-4bef-31d5-09e1-3326ee271c09", "ProductGroupCodeSecondary":null, "ParentCartItemId":null, "CartItemOptionId":null, "ProductClass":null, "Weight":null, "NameEnglish":"", "DescriptionEnglish":"", "AttributesEnglish":[ ], "Categories":[ ], "Brand":null, "IsVirtual":false, "IsBundle":false, "BundleId":null, "IsBackOrdered":false, "BackOrderDate":null, "PriceCoefficientRate":null, "MetaData":{ "Attributes":[ { "AttributeKey":"CatalogItemId", "AttributeValue":"1a2d7e83-4bef-31d5-09e1-3326ee271c09" }, { "AttributeKey":"AppId", "AttributeValue":"215238eb-22a5-4c36-9e7b-e7c08025e04e" }, { "AttributeKey":"Options", "AttributeValue":"{\"variantId\":\"00000000-0000-0000-0000-000000000000\",\"options\":{}}" }, { "AttributeKey":"ProductName", "AttributeValue":"I'm a product" }] }, "DiscountPercentage":null, "IsGiftCard":false, "GiftCardId":null, "GenericHSCode":null }, { "ProductCode":"0014", "ProductCodeSecondary":null, "OrderedQuantity":1, "OriginalSalePrice":24.0, "OriginalListPrice":24.0, "OriginalMerchantPriceForDuties":null, "OriginalMerchantUnitSalePrice":24.0, "ListPrice":120.0000, "SalePrice":120.0000, "SalePriceBeforeRounding":117.652522716000000000, "MerchantPriceForDuties":null, "CartItemId":"00000000-0000-0000-0000-000000000002", "Name":"I'm a product", "ImageURL":"https://static.wixstatic.com/media/c837a6_8ea5cc0a06664ef6a3c1cf64e1cb5a27~mv2.jpg", "IsFixedPrice":false, "VATRateType":{ "VATRateTypeCode":"vatRateType_GB_20.0", "Name":"vatRateType_GB_20.0", "Rate":20.0, "InternalVATRateTypeId":0 }, "LocalVATRateType":{ "VATRateTypeCode":"vatRateType_GB_20.0", "Name":"vatRateType_GB_20.0", "Rate":20.0, "InternalVATRateTypeId":0 }, "Description":null, "ProductVatRate":null, "Keywords":null, "URL":null, "OriginCountryCode":"", "IsBlockedForGlobalE":false, "Attributes":[ ], "ProductGroupCode":"bc1da057-a5df-4b2f-9f8e-b37036b09524", "ProductGroupCodeSecondary":null, "ParentCartItemId":null, "CartItemOptionId":null, "ProductClass":null, "Weight":null, "NameEnglish":"", "DescriptionEnglish":"", "AttributesEnglish":[ ], "Categories":[ ], "Brand":null, "IsVirtual":false, "IsBundle":false, "BundleId":null, "IsBackOrdered":false, "BackOrderDate":null, "PriceCoefficientRate":null, "MetaData":{ "Attributes":[ { "AttributeKey":"CatalogItemId", "AttributeValue":"bc1da057-a5df-4b2f-9f8e-b37036b09524" }, { "AttributeKey":"AppId", "AttributeValue":"215238eb-22a5-4c36-9e7b-e7c08025e04e" }, { "AttributeKey":"Options", "AttributeValue":"{\"variantId\":\"00000000-0000-0000-0000-000000000000\",\"options\":{}}" }, { "AttributeKey":"ProductName", "AttributeValue":"I'm a product" }] }, "DiscountPercentage":null, "IsGiftCard":false, "GiftCardId":null, "GenericHSCode":null }], "rateData":"ZEN99zm71Xg2IYEeJVY5bQcKOSee8Xg98MCdPj2%2bQSU%3d", "UrlParameters":null, "UseIpv6":false, "UserDetails":{ "AddressDetails":[ ], "UserId":null, "IsB2B":null }, "VATRegistration":null, "VoucherData":null, "WebStoreCode":null, "WebStoreInstanceCode":null, "CartId":null, "IsFreeShipping":null, "FreeShippingCouponCode":null, "AllowMailsFromMerchant":false, "AllowSMSFromMerchant":false, "CookieConsent":0, "IsMOTO":0 } ``` **SendCart** **Example:** ``` { "id":"e35774a9-7284-4296-b6c4-9ed1f14e1b03", "userDetails":null, "productsList":[ { "productCode":"0006", "productCodeSecondary":null, "orderedQuantity":1, "originalSalePrice":22, "originalListPrice":22, "originalMerchantPriceForDuties":null, "originalMerchantUnitSalePrice":0, "listPrice":0, "salePrice":0, "salePriceBeforeRounding":0, "merchantPriceForDuties":null, "cartItemId":"00000000-0000-0000-0000-000000000001", "name":"I'm a product", "imageURL":"https://static.wixstatic.com/media/c837a6_dff384ebdb954fd9a5903b028ce213c7~mv2.jpg", "imageWidth":"4213", "imageHeight":"5197", "isFixedPrice":false, "vatRateType":null, "localVATRateType":null, "description":null, "productVatRate":null, "keywords":null, "url":"https://www.m123m123.shop/product-page/im-a-product-6", "originCountryCode":null, "isBlockedForGlobalE":false, "attributes":null, "productGroupCode":"1a2d7e83-4bef-31d5-09e1-3326ee271c09", "parentCartItemId":null, "cartItemOptionId":null, "productClass":null, "weight":0.00000, "nameEnglish":null, "descriptionEnglish":null, "attributesEnglish":null, "categories":null, "brand":null, "isVirtual":false, "isBundle":false, "bundleId":null, "isBackOrdered":false, "backOrderDate":null, "priceCoefficientRate":null, "metaData":{ "attributes":[ { "attributeKey":"CatalogItemId", "attributeValue":"1a2d7e83-4bef-31d5-09e1-3326ee271c09" }, { "attributeKey":"AppId", "attributeValue":"215238eb-22a5-4c36-9e7b-e7c08025e04e" }, { "attributeKey":"Options", "attributeValue":"{\"variantId\":\"00000000-0000-0000-0000-000000000000\",\"options\":{}}" }, { "attributeKey":"ProductName", "attributeValue":"I'm a product" }] }, "discountPercentage":null, "isGiftCard":false, "giftCardId":null, "genericHSCode":null }, { "productCode":"0014", "productCodeSecondary":null, "orderedQuantity":1, "originalSalePrice":24, "originalListPrice":24, "originalMerchantPriceForDuties":null, "originalMerchantUnitSalePrice":0, "listPrice":0, "salePrice":0, "salePriceBeforeRounding":0, "merchantPriceForDuties":null, "cartItemId":"00000000-0000-0000-0000-000000000002", "name":"I'm a product", "imageURL":"https://static.wixstatic.com/media/c837a6_8ea5cc0a06664ef6a3c1cf64e1cb5a27~mv2.jpg", "imageWidth":"4213", "imageHeight":"5197", "isFixedPrice":false, "vatRateType":null, "localVATRateType":null, "description":null, "productVatRate":null, "keywords":null, "url":"https://www.m123m123.shop/product-page/im-a-product-14", "originCountryCode":null, "isBlockedForGlobalE":false, "attributes":null, "productGroupCode":"bc1da057-a5df-4b2f-9f8e-b37036b09524", "parentCartItemId":null, "cartItemOptionId":null, "productClass":null, "weight":0.00000, "nameEnglish":null, "descriptionEnglish":null, "attributesEnglish":null, "categories":null, "brand":null, "isVirtual":false, "isBundle":false, "bundleId":null, "isBackOrdered":false, "backOrderDate":null, "priceCoefficientRate":null, "metaData":{ "attributes":[ { "attributeKey":"CatalogItemId", "attributeValue":"bc1da057-a5df-4b2f-9f8e-b37036b09524" }, { "attributeKey":"AppId", "attributeValue":"215238eb-22a5-4c36-9e7b-e7c08025e04e" }, { "attributeKey":"Options", "attributeValue":"{\"variantId\":\"00000000-0000-0000-0000-000000000000\",\"options\":{}}" }, { "attributeKey":"ProductName", "attributeValue":"I'm a product" }] }, "discountPercentage":null, "isGiftCard":false, "giftCardId":null, "genericHSCode":null }], "discountsList":[ { "originalDiscountValue":"6.9", "couponCode":"15%All2", "name":"10%All2", "discountType":1, "discountValue":0, "calculationMode":1, "productCartItemId":null, "discountCode":"40819d8c-1ad8-46e0-8b86-e3159487fd72", "isFreeShipping":null }], "merchantCartHash":null } ``` **Checkout** When the shopper adds items to the cart and clicks the checkout button, the extension redirects from the native environment to the Global-e checkout. The Global-e Application implements a Global-e API method that uses the Platform API to load the contents of the user's cart and pass it securely to the Global-e checkout by means of a server-to-server API call. **Clear Cart** To clear the cart, once an order has been placed on the Global-e checkout, we use Wix’s API “Mark checkout as completed” to inform of the order creation of a cart and as a result clear the cart in the front-end and back-end of the store. **Stock Validation** To prevent inventory issues such as out-of-stock items in Global-e orders, we conduct a stock validation call before processing new orders. Each item in the cart is validated and checked to ensure it is in stock before creating the order in Global-e. When there is an item with missing stock, it is communicated to the consumer in a popup as follows: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-355b15e7-02f3-76ef-aecc-698dfb55ac27.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=6ca39d663133f76fc125c36ac6e9dd50) This functionality has been implemented in case we may want to activate additional logic beyond Stock Validation at the moment the customer places the order. For this validation we use Wix’s APIs [Create Checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/create-checkout) and [Get Checkout.](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/get-checkout) **Cart Discount** Discounts in this integration are currently only supported from the cart. The merchant can use all of the available online discounts the platform offers. These include: * Coupons (Cart & Item level) * $Discount: Offer a fixed price discount (e.g.$10 off). * % Discount: Offer a discount as a percentage (e.g. 20% off) The discount could be 100% on the item. * Free Shipping: Reward customers with free shipping. * Sale Price: Offer products at a specific price (e.g. Buy t-shirts for only \$12). * Buy X get Y * Automatic Discounts (Item level) * Percentage off (e.g. 20% off). * Amount off (e.g. \$20 off). * Sale price (e.g. all hats are just \$20). ## Order Flow **Order Creation** After an order is completed in the Global-e checkout the order information is sent to the WIX platform so you can review your Global-e orders from your store's back-office. Wix’s API Create Order is used to support order creation in WIX’s back-office after the required data of the orders is received through the SOTM API. Note: The main currency stored and displayed on WIX’s back-office is the merchant reconciliation currency. Only the product reconciliation price is reflected in Wix. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e7018edf-c82c-29b5-3192-c03f948596b3.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=0fe92e9d70e42203c8df9fa2f35d5c59) Once the order is created in the platform you can find it in the list of orders in the back office. **Order details in the back office** * Shipping and Taxes values are not stored or displayed on the platform. * The order is marked as a Global-e order and displays a Global-e order ID. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8fefa126-428a-bcf3-5f28-e099c1e1759d.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=7f291f7bd40b07fd2fc97c98bb7e130e) * The order totals in customer currency are stored in the buyer notes of the order ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b57e0d88-dc0b-a969-4a88-c4a5550a2f4d.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=a6e4c2503e19bf92151714ee9a8d9804) **Payment Verification** In order to successfully complete the update of an order in WIX back-office, we change the payment status of the order from UNPAID to PAID, once the fraud check on our end is completed. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a6f21c89-aaa4-5511-04b8-7645598e99f3.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=f0e6d9ccc96945b2363581c18f7ba219) ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a17eefd2-a7b3-f260-53b5-2561310ac4d3.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=7eb687fa157c2a12197d41ed0eaa42b8) To complete this update, use Global-e's `PerformPayment` API and communicate with Wix’s end-point Bulk [Update Payment Statuses.](https://dev.wix.com/api/rest/drafts/order-payments/add-payments?branch=order-payments) **OrderFulfilment** Since the fulfilment process occurs on the Global- side, we notify Wix and create the fulfilment of the parcel so that the order status is synced to the actual fulfilment status. Once a fulfilment is done in the Global-e Admin, Wix is notified and updated with the tracking number and the tracking URL of the parcel. This number and URL appear under the status of each parcel. Partial fulfilment ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-99fdd3e1-416f-b6c4-c6e8-91be26742c2f.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=b48ca3b4c4ce65b96ec86e2a7d771289) Fulfilment ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f4e0e486-99c7-5aa3-92a5-0d1537b59ab6.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=45cbaacb92f7d7eb9c75f2af46dc5826) To create fulfilment for a parcel in Wix we use Global-e's API Update Parcel Dispatch to send the relevant order information to Wix and communicate with the end-point Create Fulfilment **Order cancellation** Cancellations are managed through the Global-e Merchant admin. Users can cancel orders, select the reason for cancellation, and automatically create a refund once the order is canceled. Once the order is canceled, the order status is updated in Wix’s back office so you can see the actual status of the orders. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-7d587693-ac8e-ae11-b1d5-602351df1ac4.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=b2903bc9bbe061907fb5fa321d7a952c) When an order is canceled, Wix is notified through Global-e's Update Order Status API and Wix’s end-point [Cancel Order.](https://dev.wix.com/api/rest/wix-ecommerce/orders/cancel-order?branch=orders) **Order refund** Refunds are also managed through the Global-e Merchant admin. There you can create full and partial refunds. To keep track of the payment status of an order from Wix’s back-office, Global-e notifies the platform each time a new refund is created. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cda92e13-c39a-ab64-651e-831d858e3341.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=64de62b9c219258437efd124b0c9bef7) The only refund values that are stored and displayed on the platform are for the line items and the discounts. The notification and status updates are completed using Global-e's Notify Order Refund API and communication with Wix’s end-point \[Add Refund]\([https://Notify](https://Notify) Order Refund API and communicate with Wix’s end-point Add Refund.). The items will be restocked. **Returns** If you support returns via Global‑e, the shopper can use the Returns Portal to return goods or a dedicated merchant role can use the Merchant Portal to support the shopper. For more information on the Returns Portal see [Returns Portal](/returns-portal). **The following are not supported:** * Replacements * Pre-orders * Cart abandonment * Analytics \&Market Feeds # Internally Creating RMAs Source: https://docs.global-e.com/internally-creating-rmas Internally creating RMAs refers to creating RMAs directly from the Dashboard. This lets you submit return requests on behalf of your customers. Only refunds are currently supported. Exchanges, refunds to bank accounts, and order cancellations cannot be processed through the Dashboard. See [Limitations](/limitations-702685) for the full list before you start. First, choose an operation mode. This decides how much freedom your team has when creating a return: * [Operation Modes](/operation-modes) — the two modes, side by side. * [Unlimited Mode](/unlimited-mode) — create RMAs unrestricted by policy rules. * [Enforced Policy Eligibility Mode](/enforced-policy-eligibility-mode) — require a policy rule on every RMA, so the return method, resolution, automations and fees all come from that rule. Then control what your team can select, and what is filled in for them: * [Policy Rule Visibility](/policy-rule-visibility) — define who can use each policy rule, and whether it appears in the Returns Portal, the Dashboard, or both. * [Configuring Return Reasons](/configuring-return-reasons) — choose which return reasons are available internally, including reasons customers never see. * [Configuring Default RMA Values](/configuring-default-rma-values) — set default values so RMAs are created consistently. * [Allowing Customer Returns Outside Policy](/allowing-customer-returns-outside-policy) — let customers return out-of-policy items through the Returns Portal. # Internally Creating RMAs Source: https://docs.global-e.com/internally-creating-rmas-702645 Internally creating RMAs refers to creating RMAs directly from the Dashboard. This lets you submit return requests on behalf of your customers. Only refunds are currently supported. Exchanges, refunds to bank accounts, and order cancellations cannot be processed through the Dashboard. See [Limitations](/limitations-702685) for the full list before you start. First, choose an operation mode. This decides how much freedom your team has when creating a return: * [Operation Modes](/operation-modes) — the two modes, side by side. * [Unlimited Mode](/unlimited-mode) — create RMAs unrestricted by policy rules. * [Enforced Policy Eligibility Mode](/enforced-policy-eligibility-mode) — require a policy rule on every RMA, so the return method, resolution, automations and fees all come from that rule. Then control what your team can select, and what is filled in for them: * [Policy Rule Visibility](/policy-rule-visibility) — define who can use each policy rule, and whether it appears in the Returns Portal, the Dashboard, or both. * [Configuring Return Reasons](/configuring-return-reasons) — choose which return reasons are available internally, including reasons customers never see. * [Configuring Default RMA Values](/configuring-default-rma-values) — set default values so RMAs are created consistently. * [Allowing Customer Returns Outside Policy](/allowing-customer-returns-outside-policy) — let customers return out-of-policy items through the Returns Portal. # International Marketing Feeds (Non-Shopify) Source: https://docs.global-e.com/international-marketing-feeds--non-shopify- There are several methods to retrieve the Global-e international product prices for inclusion in marketing feeds. This section outlines relevant methods. ## Product Price per Currency Feed Tool If you have a small number of SKUs you can use the Product Price per Currency Feed Tool inside the Global-e admin to retrieve your international prices. The limitation is 1,000 SKUs. The **Product Price per Currency Feed** enables you to create a feed of your products with their prices in the foreign currencies of your choice. This feed can be used for your marketing needs, whenever international prices are required, for example, Google shopping feed. **To prepare your Product Price file:** 1. From the Global‑e Merchant Portal, navigate to **Merchants > Product Management > Product Price Feed**. The Product Price per Currency Feed screen opens. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-416b030b-9013-a658-c733-e4edda9486b3.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=c5384d9a045ca07ba7478edabeb58f7c) 2. Download the SKU Sample File by clicking the File Format Example (next to the browse button). 3. Populate the file with the following values: * **SKU** - Your product SKU as it appears in your product catalogue. * **Product Price** - Your product price in the original merchant currency (including VAT). * **Price Original Currency** - 3-char currency code of your products. * **VAT Rate** - The VAT rate in your country that is applicable to your product in per cent (without the % sign). > [!NOTE] > > You can list the values on separate rows or separate the values with commas; the file can contain up to 1000 SKUs. 4. Save your file in one of the following formats: Excel, CSV, or txt. ### Generating Your Feed **To upload and generate your file:** 1. In the Product Price per Currency Feed screen, upload your SKU file: Click **Browse** to retrieve and select the file you have prepared. 2. Choose currencies by country: Click **List of Currencies** OR **Choose**, The Select Currencies screen opens. 3. Select one or multiple currencies to use for your product price conversions. You can choose up to 10 different currencies. To search for or filter currencies, use the *Search country* field. The selected currencies are selected and saved. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-07a11b23-6c20-7e7e-401a-50535c7b9793.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=89dd6a41a8d67532e9f91a85c69dd53d) To remove a currency, clear the box next to the currency. 4. Choose output file destination, selecting the way you prefer receiving your file containing the converted product prices: | Send a daily file to this email address | Enter your email address. The process runs daily, generates the file every 24 hours (with updated prices), and sends the file to the requested email destination you provided. | | - | - | | Send a daily file to this SFTP site | Enter the server address: **sftp.merchantdoamin.com** Enter the folder name. Enter your username Select **Use Password** or **Use Private Key**   – If you select **Use Password**, enter a password.   – If you select **Use Private key**, click **Browse** to upload your key file. The process runs daily, generates the file every 24 hours (with the converted prices), and sends the file to the requested SFTP server destination you provided. | 5. Click **Generate Feed** to convert your products to the selected currency prices. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8a7da1f4-dda6-d9a4-cc52-8495ef3e7e6b.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=c020e75646f9303cf263d39f38e37876) If you have chosen to receive the file daily option, when you next log in to this screen, you can stop the process and generate a new file with different SKUs. ## GetCatalogPrices API If you have more currencies or products to support, use the GetCatalogPrices API. Limitations: 10000 SKUs per request ### Introduction The **GetCatalogPrices** API provides merchants with the most updated international prices of their products in different territories operated by Global‑e. These prices can be used for marketing needs (for example, in the Google Shopping Feed or in email marketing campaigns). The recommended frequency of usage of this API call is 1 call per day, as currency rates are updated in the Global-e system once a day. The maximum number of currency results (i.e. product count multiplied by requested countries count) cannot exceed 10,000. It means that if a merchant wishes to get prices of 10 currencies, the maximum number of products that can be sent via this API is 1000. If the API call exceeds this number, a failure message is sent back as a response, and no international prices are retrieved. > [!NOTE] > > Merchants implementing the Price feeds API (`GetCatalogPrices API` ) to show correct international prices in the Google Shopping feed must ensure that the correct product landing page URL is set to show the price for a country that the feed was generated for. > > For example, for Bespoke Global-e Module merchants, the URL should have an additional query string parameter: `glCountry`, so that the URL for the UK looks like this: > > `?glCountry=gb` > > In addition, if the `glCountry` parameter has been specified, make sure to change the Link of Global‑e CSS by adding the same parameter, so that it looks like this: > > `//gepi.global-e.com/proxy/css/<MerchantID>?glCountry=gb` This document is intended for Global-e merchants wishing to retrieve updated international prices for their products, as calculated by the Global-e platform. This document describes relevant API methods and provides implementation examples. For details on the Global-e API, see the [General API Reference](/api-reference/overview) documentation. ### GetCatalogPrices API > [!NOTE] > > This API endpoint is used to pull the catalogue prices for international markets. If the merchant wishes it to be fully automated for new products, we need to make sure that they also upload catalogues through SFTP, otherwise, some new products may not exist in the Global-e Database. **Request sent by the merchant:** * A list of countries - two letters country codes (ISO2), for which international prices product feed is required. * A list of products for which international prices product feed is required, with the following details for each product: * **ProductCode (SKU) -** ProductCode (SKU) for the product. * **OriginalCurrencyCode -** Optional. Currency code for the received product. If left empty, then the default merchant currency will be assumed. * **OriginalSalePrice per product -** Price in original currency. * **VATRate -** Local VAT rate of the product in the merchant country. * **ProductClassCode -** Optional. Product class code used by the merchant to overwrite country coefficient rate. * **IsPriceIncludeVAT-** Optional. The default value is True. Indicates whether the price includes the merchant country's local VAT rate. **Response sent by Global‑e:** The Merchant receives back a list of SKUs and related prices in the countries that were sent in the request. ## Marketing Feed via SFTP If you have a very large number of SKUs and it would be too resource intensive to leverage the GetCatalogPrices API, we have an option to generate pricing feeds and send them to you via sFTP. Limitations: * Filename and file contents must follow requirements. * Feed will only generate once a day. Please reach to your Customer Success Manager (or Global-e Project team while onboarding) to enable this feature. ## Marketing Feeds and Tax/Shipping Rates When international customers visit your store, the prices are adjusted to their country's currency. Due to country price coefficient, and/or different VAT policies, the prices your customers see may be different from those shown to customers in other countries with the same currency. Therefore, the feed platforms in use need to be adjusted to support the price localization. **Domestic feeds** Due to automatic IP redirection, it is recommended that you update your domestic product links to include a country and currency parameter to prevent Google price violations. To do this, add the Global-e `glCountry` and `glCurrency` parameters to the product page URL in your generated feeds. Example: ``` https://storefront.domain/nice-shoes?glCountry=US&glCurrency=USD ``` **International feeds** When generating international marketing feeds, ensure you are doing the following: * Append the `glCountry` and `glCurrency` parameters to the product page URL in the feed's platform. ``` Example: https://storefront.domain/nice-shoes?glCountry=FR&glCurrency=EUR ``` * For countries where prices are being calculated by Global-e, the prices in the feed must be retrieved from the Global-e `getCatalogPrices` API. Feeds should be re-generated daily to update prices that may have changed due to foreign exchange rate updates. **Shipping rates** To ensure a smooth experience, you'll want to define your shipping rates in the **Google Merchant Center (GMC)** using the **range-based** option. These rates should match what you've set up in the **Flat Shipping Rates** section of your **Global-e admin**. Most of our merchants simply copy the shipping rate settings from Global-e into GMC, which helps prevent any mismatches or errors. If you’re not currently using flat rates, we recommend reaching out to your **Customer Success Manager**\*\*(CSM)\*\* to discuss switching to flat rates for the countries you’re marketing to. **Tax rates (US Shipping Only)** If you're shipping to the **United States** through Global-e, here are some important notes regarding **sales tax settings** in GMC. If you're considering building **state-specific tax rates into your product feed**, please note that this is not something we currently support directly. You’d need to manage those configurations yourself. Google requires you to enable sales tax settings based on your tax obligations. If this setting is **not enabled**, Google will assume a 0% tax rate across the board, which could create mismatches at checkout and trigger warnings in your account. Here are a few options for how you can manage US tax rates in GMC: 1. **Include tax rates per item** in your product feed – This is a more complex setup and may require more ongoing maintenance. 2. **Set a state-level rate** in GMC: * Choose a **specific rate** if your products all fall under the same classification. * Or use the **maximum rate for each state** to avoid potential mismatches. 3. **Let Google automatically calculate the tax rate** – this is the easiest option, and we’ve seen many brands use it successfully. Google will check that the correct rate is applied when validating your feed. Please refer to Google’s help page on instructions on how to configure these settings: [Set up tax settings (US only) - Google Merchant Center Help](https://support.google.com/merchants/answer/160162?hl=en). At Global-e, we use **Avalara** to calculate sales tax in the US, so all tax rates applied at checkout are based on product classifications and align with state guidelines provided on Avalara’s [State Sales Tax Rates](https://www.avalara.com/taxrates/en/state-rates.html) page. # International Prices Source: https://docs.global-e.com/international-prices Retrieve updated international prices for your products across the territories operated by Global-e — as a ready-calculated price feed (GetCatalogPrices) or as the parameters you apply yourself to calculate prices in the destination currency (GetMerchantPriceDetails). ## Overview The International Prices APIs provide merchants with the most updated international prices of their products in the territories operated by Global‑e. Two methods are available, depending on how you consume the prices. ### GetCatalogPrices The **GetCatalogPrices** API provides merchants with the most updated international prices of their products in different territories operated by Global‑e. These prices can be used for marketing needs (for example, in the Google Shopping Feed or in email marketing campaigns). The recommended frequency of usage of this API call is 1 call per day, as currency rates are updated in the Global-e system once a day. The maximum number of currency results (i.e. product count multiplied by requested countries count) cannot exceed 10,000. It means that if a merchant wishes to get prices of 10 currencies, the maximum number of products that can be sent via this API is 1000. If the API call exceeds this number, a failure message is sent back as a response, and no international prices are retrieved. > [!NOTE] > > Merchants implementing the Price feeds API (GetCatalogPrices API) to show correct international prices in the Google Shopping feed must ensure that the correct product landing page URL is set to show the price for a country that the feed was generated for. > > For example, for Bespoke Global-e Module merchants, the URL should have an additional query string parameter: `glCountry`, so that the URL for the UK looks like this: > > `?glCountry=gb` > > In addition, if the `glCountry` parameter has been specified, make sure to change the Link of Global‑e CSS by adding the same parameter, so that it looks like this: > > `//gepi.global-e.com/proxy/css/?glCountry=gb` This document is intended for Global-e merchants wishing to retrieve updated international prices for their products, as calculated by the Global-e platform. This document describes relevant API methods and provides implementation examples. For details on the Global-e API, see the General API Reference documentation. > [!NOTE] > > This API endpoint is used to pull the catalogue prices for international markets. If the merchant wishes it to be fully automated for new products, we need to make sure that they also upload catalogues through SFTP, otherwise, some new products may not exist in the Global-e Database. ### GetMerchantPriceDetails This Global-e `GetMerchantPriceDetails` REST API enables merchants to obtain the parameters required to calculate product prices in a destination country currency. This document provides details about the GetMerchantPriceDetails API, a flow and explanations on how to implement the logic, and a sample implementation in JavaScript. This document is intended for the developer in charge of evaluating and integrating the solution with the merchant's ecommerce platform and assumes familiarity with the Global-e technology, concepts, and terminology. ## API reference > [card] [Get Catalog Prices — full request & response](/api-reference/get-catalog-prices) > > Parameters, schema, examples for `POST /Browsing/GetCatalogPrices`. > [card] [Get Merchant Price Details — full request & response](/api-reference/get-merchant-price-details) > > Query parameters, response schema, examples for `GET /externalapi/GetMerchantPriceDetails`. ## Calculating Prices: Logic and Flow This section provides the logic and flow required to calculate product prices as they will be displayed to shoppers in their country's local currency on the merchant's website. The following flow is affected by the various rules, regulations, and specific price factors. Make sure to keep these in consideration when implementing the calculations. The field properties are detailed in Parameters, VAT Settings, and Applying Rounding Rules. ![Calculate product price flow](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/pricing/calculate-product-price-flow.svg?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=8058023a1cbdc684391d5b061e554bfa) **To implement the Product Price Logic and Flow:** 1. Call the GetMerchantPriceDetails REST API to get the set of price calculation rules for the relevant territory. 2. Fixed prices: Check if at least some of the products have fixes prices. If true, these products are configured as fixed prices in the merchant's database. Fixed prices do not require additional calculation. Therefore, skip this entire flow. However, make sure to show the fixed prices for the products as set in your database. For non-fixed prices, proceed as detailed below. **⇾ For each product, perform the following steps:** 3. VAT settings: If you are a merchant from the European Union, proceed as follows. If you are a non-EU merchant, skip to step 4. There are two VAT scenarios, depending on how you manage pricing in the e‑commerce platform. **Scenario 1** — The price of the product in the merchant's system includes the local VAT. 1. Get the merchant's product price (including the local VAT). 2. Deduct the local VAT from the base price of the product if you selected one of the following VAT options: `VATTypeId = 0` (hide/deduct the VAT) *or* `VATTypeID = 6` *and* `useDistanceSellingVAT = true` (This means that the product is shipped to a destination country where the distance selling regulation applies (within the EU)) Formula: ``` [price] = [price before VAT] / (1 + [VAT] / 100) ``` 3. Add the destination country VAT to the base price of the product if: `VATTypeID = 6` (force VAT). Formula: ``` [price] = [price without VAT] * (1 + [VAT]/ 100) ``` Otherwise, if the `VATTypeID` is not 0 or 6 and the rate of the destination country is not applicable, `(useDistanceSellingVAT = False)`, proceed to step 4. **Scenario 2** — The price of the product in the merchant's country does not include the local VAT. 1. Get the merchant's product price (without the local VAT). 2. Depending on the VAT options you choose, add the destination or local VAT to the base price of the product if the product is shipped to a destination country where the distance selling regulation applies (within the EU): * if `VATTypeId = 0` (hide/deduct the VAT), proceed to step 4. * Add the **destination** VAT to the base price of the product if: `VATTypeID = 4` (pocket VAT) *or* `VATTypeID = 6` *and* `useDistanceSellingVAT = true` (This means that the product is shipped to a destination country where the distance selling regulation applies (within the EU)). Formula: ``` [price] = [price before VAT] * (1 + [destination VAT] / 100) ``` * Add the **local** VAT to the base price of the product if: `VATTypeID = 4` (pocket VAT) *or* `VATTypeID = 6` *and* `useDistanceSellingVAT = false` (This means that the product is shipped to a destination country where the distance selling regulation does not apply). Formula: ``` [price] = [price before VAT] * (1 + [VAT] / 100) ``` See [VAT Settings](#vat-settings) for field and option descriptions. 4. Apply the `currencyConversionRate`. 5. Apply the `countryCoefficientRate` or apply the correct rate from the `productClassCoefficients` list, according to the following: * If the `countryCoefficientRate` is not defined and the `productClassCoefficient` is not defined, no coefficient is applied. * If the `countryCoefficientRate` is not defined and the `productClassCoefficient` is defined, the `productCoefficient` is applied. * If the `countryCoefficientRate` is defined and the `productClassCoefficient` is not defined, the `countryCoefficientRate` is applied. * If the `countryCoefficientRate` is defined and the `productClassCoefficient` is defined, the `productClassCoefficient` is applied. 6. Perform the arithmetic rounding: Round up the currency's decimal places, leaving the same number of decimals defined in `currencyDecimalPlaces`. **Example:** If `currencyDecimalPlaces` = 2 And your currency = 223.0234512 Round up the number after the decimal =223.02 7. Calculate and apply the marketing rounding. See [Applying Rounding Rules](#applying-rounding-rules). > [!TIP] > > **Basic rule for arithmetic rounding** > > If the number you are rounding is followed by a decimal and digits containing 5, 6, 7, 8, or 9, round the number up. Example: .29 rounded up to the nearest ten is .30 > > If the number you are rounding is followed by a decimal and digits containing 0, 1, 2, 3, or 4, round the number down. Example: .24 rounded down to the nearest ten is .20. ## VAT Settings This section lists the VAT properties and provides an example on how to calculate the VAT based on the selected VATTypeId option. **VatTypeID Descriptions** | VATTypeID | Description | | - | - | | 0 | Hide VAT (default) | | 4 | "Pocket" VAT (increase the original price by the value of the respective product's VAT) | | 6 | Force VAT (used to support trade agreements between the countries such as EEA, when the customer in the destination country must pay VAT; for simplicity assuming UseCountryVAT=false) | **Example of Price Calculation Based on the VATTypeID** The following table is the list of VATTypeID values and descriptions and the expected results for a sample product with an original cost in UK = 100 GBP before VAT to be shipped to Germany (with a country coefficient Rate=1 and the user selected currency=GBP, for simplicity). For this sample product UK VAT=20%, DE Duties Total=17%: | Include VAT Option Value | Description | Price in Browsing | Price in Checkout | Price Paid to Merchant (incl. VAT) | Checkout Duties Total | Checkout Total | | - | - | - | - | - | - | - | | 0 | Hide VAT (default) | 100 | 100 | 120 | 17 | 117 | | 4 | "Pocket" VAT (increase the original price by the value of the respective product's VAT) | 120 | 120 | 144 | 20.4 (17%) | 140.4 | | 6 | Force VAT (used to support trade agreements between the countries such as EEA, when end customer must pay VAT; for simplicity assuming UseCountryVAT=false) | 120 | 120 | 120 | 0 | 120 | ## Applying Rounding Rules After calculating the price of the product, you must apply the arithmetic and marketing rounding rules. The arithmetic rounding rule is detailed in section Calculating Prices: Logic and Flow. The following tables provide the list of properties required to implement the remaining rounding rules. **RangeBehaviors Enumeration** | RangeBehavior Option Value | Name | Behavior Description | | - | - | - | | 1 | Absolute target | All the values within the specified range (`LowerTarget`, `UpperTarget`, `Threshold` and `RoundingExceptions`) denote the values themselves as is, without the need for additional mathematical operations. To get rounding result (R) for the source number (S): If (S = Exception) then R = Exception; If (S \< Threshold) then R = LowerTarget; If (S >= Threshold) then R = UpperTarget. | | 2 | Relative Decimal target | All the values within the specified range represent floating point numbers between 0 (inclusive) and 1 (inclusive). Relative to the calculation base (B = whole part of S): LA = B – 1 + LowerTarget; UA = B + UpperTarget; TA = B + Threshold; EA = B + Exception. If (S = EA) then R = EA; If (S \< TA) then R = LA; If (S >= TA) then R = UA. | | 3 | Relative Whole target | All the values within the specified range represent non-negative whole numbers. `TargetBehaviorHelperValue` (V) determines the calculation base (B); V must be a power of 10 (10, 100, 1000, etc.). B = S rounded down to the closest multiple of V. LA = B – V + LowerTarget; UA = B + UpperTarget; TA = B + Threshold; EA = B + Exception. If (S = EA) then R = EA; If (S \< TA) then R = LA; If (S >= TA) then R = UA. | | 4 | Nearest target | `LowerTarget` and `UpperTarget` represent non-negative floating point numbers. `TargetBehaviorHelperValue` (V) must be a whole divisor of any power of 10 (5, 10, 25, 50, 100, 250, 500, 1000, etc.). `Threshold` must be any floating point number between 0 (inclusive) and V (exclusive). B = S rounded down to the closest multiple of V. LA = B – 1 + LowerTarget; UA = B – 1 + V + UpperTarget; TA = B + Threshold; EA = B + Exception. If (S = EA) then R = EA; If (S \< TA) then R = LA; If (S >= TA) then R = UA. | > [!WARNING] > > **Important.** For any rounding behavior defined in the table above, if the rounding result is a negative number, it must be set to zero. > > If either the `LowerTarget` or `UpperTarget` value violates the `MaxDecimalPlaces` setting for the respective currency, this value must be truncated. > > For example, if `UpperTarget` is set to 0.999 for USD, it must be truncated to 0.99 before performing further calculations. ## Use Cases ### Rounding Rules Samples The following samples indicate how rounding X to Y (X → Y) is implemented using the respective settings. | Property | 0.25 → 0; 3 → 0; 1.5 → 1.5; 2 → 2 | 22.47 → 21.95; 22.48 → 22.99; 22.50 → 22.50; 33.75 → 33.75 | 2047 → 1995; 2048 → 2100 | 122.26 → 124.99; 122.25 → 119.99; 127.26 → 129.99; 121.50 → 121.50; 127.50 → 127.50; 123 → 123; 128 → 128 | 2047 → 1999; 2048 → 2100 | | - | - | - | - | - | - | | From | 0 | 1 | 1000 | 100 | 1000 | | To | 3 | 250 | 10000 | 1000 | 10000 | | Threshold | 3.01 | 0.48 | 48 | 2.26 | 48 | | LowerTarget | 0 | 0.95 | 95 | 0.99 | 0 | | UpperTarget | 0 | 0.99 | 100 | 0.99 | 1 | | RangeBehavior | 1 (Absolute) | 2 (Relative Decimal) | 3 (Relative Whole) | 4 (Nearest) | 4 (Nearest) | | TargetBehaviorHelperValue | | | 100 | 5 | 100 | | RoundingExceptions | 1.5; 2 | 0.50; 0.75 | | 1.50; 2.50; 3 | | ### Price Conversion and Rounding Rule Implementation in JavaScript This section shows an example of price conversion and rounding implementation in JavaScript. Use this example to write the APIs required for your specific environment and implement them. ```js theme={null} function CalculatePrice(value, fxRate, vatRateTypes, productLocalVatRate, isGrossPrices, currencyDecimalPlaces, quantity, productClassCoefficient, priceCoefficient, productCountryVatRate, roundingRules) { if (value == 0) return (0).toFixed(currencyDecimalPlaces); var merchantVatRate = vatRateTypes.LocalVATRateType.Rate / 100; if (productLocalVatRate !== null) { if (productLocalVatRate == 0) { merchantVatRate = 0; } else { merchantVatRate = productLocalVatRate / 100; } } var countryVatRate = vatRateTypes.VATRateType.Rate / 100; if (productCountryVatRate || productCountryVatRate === 0) { if (productCountryVatRate == 0) { countryVatRate = 0; } else { countryVatRate = productCountryVatRate / 100; } } if (isGrossPrices) { if (vatRateTypes.IncludeVATTypeId == 0 || vatRateTypes.IncludeVATTypeId == 8 || (vatRateTypes.IncludeVATTypeId == 6 && vatRateTypes.UseCountryVAT)) { value = value / (1 + merchantVatRate); if (vatRateTypes.IncludeVATTypeId == 6) { value += value * countryVatRate; } } } else { if (vatRateTypes.IncludeVATTypeId == 2 || vatRateTypes.IncludeVATTypeId == 4 || vatRateTypes.IncludeVATTypeId == 6) { if (vatRateTypes.UseCountryVAT) { value += value * countryVatRate; } else { value += value * merchantVatRate; } } } value = value * fxRate; if (productClassCoefficient) { value = value / priceCoefficient * productClassCoefficient; } value = value.toFixed(currencyDecimalPlaces); if (skipRounding || roundingRules == null) { value = value * quantity; } else { var ranges = roundingRules.RoundingRanges; var range = null; for (var r in ranges) { var rg = ranges[r]; if (rg.From < value && value <= rg.To) { range = rg; break; } } if (range != null) { // convert range to form of absolute range = ConvertRoundingRangeToAbsolute(value, range); // apply logic of absolute range rounding value = AbsoluteRounding(value, range) * quantity; if (value < 0) { value = 0; } } } return value; }; function ConvertRoundingRangeToAbsolute(price, range) { var result = null; if (range.RangeBehavior == 1) { // range already has absolute behavior result = range; } else { result = new Object(); result.RangeBehavior = range.RangeBehavior; result.RoundingExceptions = []; result.From = range.From; result.To = range.To; var int_part = Math.floor(price); if (range.RangeBehavior == 2) { //Relative Decimal result.LowerTarget = int_part - 1 + range.LowerTarget; result.UpperTarget = int_part + range.UpperTarget; result.Threshold = int_part + range.Threshold; for (var ex in range.RoundingExceptions) { range.RoundingExceptions[ex].ExceptionValue += int_part; result.RoundingExceptions.push(range.RoundingExceptions[ex]); } } else if (range.RangeBehavior == 3) { // Relative Whole if (range.TargetBehaviorHelperValue == 0) { range.TargetBehaviorHelperValue = 10; } var base = Math.floor(price / range.TargetBehaviorHelperValue) * range.TargetBehaviorHelperValue; result.LowerTarget = base - range.TargetBehaviorHelperValue + range.LowerTarget; result.UpperTarget = base + range.UpperTarget; result.Threshold = base + range.Threshold; for (var ex in range.RoundingExceptions) { range.RoundingExceptions[ex].ExceptionValue += base; result.RoundingExceptions.push(range.RoundingExceptions[ex]); } } else if (range.RangeBehavior == 4) { // Nearest target if (range.TargetBehaviorHelperValue == 0) { range.TargetBehaviorHelperValue = 5; } var base = Math.floor(price / range.TargetBehaviorHelperValue) * range.TargetBehaviorHelperValue; result.LowerTarget = base - 1 + range.LowerTarget; result.UpperTarget = base - 1 + range.TargetBehaviorHelperValue + range.UpperTarget; result.Threshold = base + range.Threshold; for (var ex in range.RoundingExceptions) { range.RoundingExceptions[ex].ExceptionValue += base; result.RoundingExceptions.push(range.RoundingExceptions[ex]); } } } return result; }; function AbsoluteRounding(price, range) { var result = null; // check exceptions if (range.RoundingExceptions.length > 0) { for (var e in range.RoundingExceptions) { ex = range.RoundingExceptions[e]; if (price == ex.ExceptionValue) { result = price; } } } // no exception was found if (!result) { // check threshold if (price < range.Threshold) { result = range.LowerTarget; } else { result = range.UpperTarget; } } return result; }; ``` # Invoicing Source: https://docs.global-e.com/invoicing When the Reconciliation Report is generated, Global-e also provides Merchants with two invoices: * A self-billing invoice for sales-less refunds. * An invoice for Global-e’s services, fees, and any shipping subsidies. To view the invoice navigate to the Global-e Merchant Portal > Merchants > Reports > Reconciliation Reports. Invoice for Service and Fees ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8b4c9600-ae8a-064b-bcc8-4ccc7e0dad88.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=02469124ea9724e109e7aa3a5adac283) Credit Note for Net Sales ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a7fb7d38-e6e5-fffa-9950-d5a17ac09eae.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=127299c7dde4357039fb1c4c7191aa80) # Invoicing Source: https://docs.global-e.com/invoicing--au- When the Reconciliation Report is generated, Global-e also provides Merchants with two invoices: * A self-billing invoice for sales-less refunds. * An invoice for Global-e’s services, fees, and any shipping subsidies. To view the invoice navigate to the Global-e Merchant Portal > Merchants > Reports > Reconciliation Reports. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c65c554e-8e1b-d4d5-9965-a34fd0f5e06b.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=1335c0270fc315f270845d244ed060ce) ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a7ba2b27-ee89-1fe4-865d-c0b928bd4b1d.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=aee51d716dc1832fd97018e57889205e) # Invoicing Source: https://docs.global-e.com/invoicing--uk- When the Reconciliation Report is generated, Global-e also provides Merchants with two invoices: * A self-billing invoice for sales less refunds. * An invoice for Global-e’s services, fees, and any shipping subsidies. To view the invoice navigate to the Global-e Merchant Portal > Merchants > Reports > Reconciliation Reports. **Invoice for Service and Fees** ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ebdccc7f-24e2-14a9-0df6-c32f96546133.jpg?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=046761eadb8d44348fcc32b7c0eaf3af) **Credit Note for Net Sales** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8c58ba10-8b42-ece3-8ec8-78718083f6a8.jpg?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=0c7eb2bc93920a8c4d749a95a9acbe0d) # Invoicing Source: https://docs.global-e.com/invoicing--us- When the Reconciliation Report is generated, Global-e also provides Merchants with two invoices: * A self-billing invoice for sales-less refunds. * An invoice for Global-e’s services, fees, and any shipping subsidies. To view the invoice navigate to the Global-e Merchant Portal > Merchants > Reports > Reconciliation Reports. **Invoice for Service and Fees** ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c65c554e-8e1b-d4d5-9965-a34fd0f5e06b.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=1335c0270fc315f270845d244ed060ce) **Credit Note for Net Sales** ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a7ba2b27-ee89-1fe4-865d-c0b928bd4b1d.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=aee51d716dc1832fd97018e57889205e) # iOS Installation Source: https://docs.global-e.com/ios-installation To Integrate GlobalEMobileSDK.framework into your Xcode project. 1. In the project navigator, right-click on your project and select **New Group**. 2. Name the new group **GlobalEMobileSDK**. 3. Drag and drop **GlobalEMobileSDK** from Finder into the **GlobalEMobileSDK** folder. Ensure the following options for adding files are selected: * Copy items if needed * Create Groups 4. Click **Finish**. 5. In the Project **Navigatoranager**, navigate to your project settings. 6. Select **Embed & Sign** for the newly added **GlobalEMobileSDK**. 7. Navigate to the Build Phases tab and expand the **Link Binary With Libraries** list to check that your framework is included. # Jobs Source: https://docs.global-e.com/jobs-sfcc The Global-e SFCC cartridges ship scheduled jobs that synchronize configuration, catalog data, product restrictions, outbound order notifications, and inbound order-status fallback between SFCC and Global-e. Job definitions are imported from `metadata/jobs.xml`; step implementations live in the `int_globale` cartridge. After [Installation](/installation-sfcc), import job schedules and run **GlobaleSettings** manually before enabling other jobs. New integrations must also complete [Data API](/configuration-sfcc#data-api-mandatory-for-new-integrations) OCAPI setup so Global-e can start configuration sync over OCAPI when needed. See [Configuration → Scheduled Jobs](/configuration-sfcc#scheduled-jobs-administration--operations--jobs) for Business Manager setup. For job IDs, step types, and triggers as shipped in metadata, see [Metadata → Scheduled jobs](/metadata-sfcc#scheduled-jobs). ## Cartridge jobs at a glance | Job | Purpose | Shipped schedule | Documentation | | - | - | - | - | | **GlobaleSettings** | Pull Global-e browsing configuration (countries, currencies, cultures, rounding rules, and related data) into `GLOBALE_*` custom objects; generate and import cache price books | Daily recurring (enabled) | [GlobaleSettings](/globale-settings-sfcc) | | **GlobaleProducts** | Import product restrictions and destination-country VAT rates from Global-e into product custom attributes | Every 15 minutes (disabled) | [GlobaleProducts](/globale-products-sfcc) | | **GlobaleCatalogFeed** | Generate a catalog CSV and upload it to SFTP for Global-e product classification | Daily (disabled) | [GlobaleCatalogFeed](/globale-catalog-feed-sfcc) | | **GlobaleOrderNotifications** | Send outbound order status, dispatch, refund, RMA, and parcel notifications from SFCC to Global-e | Every 15 minutes (disabled) | [GlobaleOrderNotifications](/globale-order-notifications-sfcc) | | **GlobaleOrderStatusFallback** | Optional: download Global-e order status JSON from SFTP and apply updates when the live webhook cannot deliver (**requires Global-e enablement**) | Every 15 minutes (disabled) | [GlobaleOrderStatusFallback](/globale-order-status-fallback-sfcc) · [Optional feature](/order-status-sftp-fallback-sfcc) | | **GlobaleCouponRedemptions** | Import coupon redemption records created during order failover (optional; not in default `jobs.xml`) | Project-specific | [GlobaleCouponRedemptions](/globale-coupon-redemptions-sfcc) | | **GlobaleRestrictedItemsFeed** | Generate a restricted-items CSV (by SKU, brand, or category per country) and upload it to SFTP for Global-e classification (optional; not in default `jobs.xml`) | Project-specific | [GlobaleRestrictedItemsFeed](/globale-restricted-items-feed-sfcc) | ## Typical setup order **Step 1** Import `metadata/jobs.xml` and assign **GlobaleSettings** flows to each Global-e site context. **Step 2** Run **GlobaleSettings** manually and confirm `GLOBALE_*` custom objects are populated. **Step 3** Enable **GlobaleCatalogFeed** on a schedule that matches your catalog update frequency (see [GlobaleCatalogFeed](/globale-catalog-feed-sfcc)). **Step 4** Enable **GlobaleProducts** on staging/development only; replicate product attribute data to production via SFCC catalog replication (see [GlobaleProducts](/globale-products-sfcc)). **Step 5** Enable **GlobaleOrderNotifications** when outbound order notifications are in scope; wire the required [hooks](/hooks-sfcc) in your order flows (see [GlobaleOrderNotifications](/globale-order-notifications-sfcc)). **Step 6** Configure SFTP credentials and enable **GlobaleOrderStatusFallback** only when Global-e has enabled the inbound order-status SFTP feed for the merchant (optional — see [Order status SFTP fallback](/order-status-sftp-fallback-sfcc) and [GlobaleOrderStatusFallback](/globale-order-status-fallback-sfcc)). **Step 7** Add **GlobaleCouponRedemptions** only when coupon verification during failover is required (see [GlobaleCouponRedemptions](/globale-coupon-redemptions-sfcc)). **Step 8** Add **GlobaleRestrictedItemsFeed** when you push product restrictions to Global-e by SKU, brand, or category; create the job manually in Business Manager (see [GlobaleRestrictedItemsFeed](/globale-restricted-items-feed-sfcc)). ## Related topics | Topic | Section | | - | - | | Product restrictions and forbidden products | [Restricted / forbidden products](/restricted-products-sfcc) | | Inventory reservation release (`custom.GlobaleInventoryVoidReservation`) | [Checkout flow → Releasing a reservation](/checkout-flow-sfcc#releasing-a-reservation) | | Expired Pay By Link order cancellation (`custom.GlobaleCancelExpiredPayByLinkOrders`) | [Pay By Link](/pay-by-link-sfcc) | | Cache price books (GlobaleSettings steps) | [Price calculation](/price-calculation-sfcc) | | Order lifecycle and outbound notifications | [Order lifecycle](/order-lifecycle-sfcc) | | Custom hooks for job-triggered notifications | [Hooks](/hooks-sfcc) | # Klarna: A Guide Source: https://docs.global-e.com/klarna--a-guide **Klarna** is a Swedish fintech company that provides **Buy Now, Pay Later (BNPL)** services and various other payment options. By integrating Klarna, merchants can offer customers flexible payment solutions, increasing conversion rates and customer satisfaction. Klarna’s payment methods cater to different consumer preferences, making it a popular alternative to traditional credit cards. For more information about Klarna's services, see [Klarna](https://www.klarna.com/uk/). For details about on-site messaging implementation, see [Klarna OSM Integration](/klarna-on-site-messaging-integration). ## How Klarna Works as a BNPL and Payment Solution Klarna provides shoppers with multiple payment options to offer at checkout: 1. **Pay in 4 (Interest-Free Installments)** * Shoppers split the total purchase amount into **four equal** payments. * The **first payment is made at checkout**, with the remaining three deducted every **two weeks**. * **No interest or fees** if payments are made on time. 2. **Pay Later (Invoice-Based Payment)** * Shoppers receive the product **before making a payment**. * They have **14–30 days** to complete the payment. * Interest-free if paid within the set period. 3. **Pay Now (Instant Full Payment)** * Shoppers pay the full amount immediately using a **linked debit card, credit card, or bank transfer**. * This is Klarna’s simplest payment method, functioning similarly to standard checkout transactions. 4. **Financing (Long-Term Payment Plans)** * Shoppers can spread the cost of a purchase over **6 to 36 months**. * This works like a **personal loan**, with interest rates depending on Klarna’s assessment. * Requires a **hard credit check**, which may impact the customer’s credit score. ## Benefits and Considerations Integration with Klarna can offer the following advantages: * **Higher Conversion Rates** – Offering BNPL options reduces cart abandonment and increases completed sales. * **Increased Average Order Value (AOV)** – Shoppers tend to **spend more per transaction** when given flexible payment options. * **Risk-Free Payments for Merchants** – Klarna assumes **full financial risk**, ensuring that merchants receive payment upfront. * **No Interest on Short-Term Plans** – "Pay in 4" and "Pay Later" options are interest-free, making them attractive to customers. * **No Hard Credit Checks for Short-Term BNPL** – Klarna conducts **only soft credit checks** for short-term options, making it more accessible. * **Global Availability** – Klarna operates in multiple markets, including the **U.S., U.K., Sweden, Germany, Australia**, and more. * **Mobile & In-App Shopping** – Shoppers can shop and manage their payments directly through Klarna’s mobile app. * **Buyer Protection & Dispute Resolution** – Klarna offers protection against fraud and **resolves disputes** on behalf of merchants and consumers. While Klarna provides benefits, merchants should also be aware of potential drawbacks: **Potential Considerations** * **Late Fees for Shoppers** – If a Shoppers misses a payment, Klarna may **charge late fees** or **restrict their account**. * **Risk of Debt Accumulation** – BNPL services can encourage **overspending**, leading to financial difficulties for some consumers. * **Hard Credit Checks for Financing** – Long-term financing requires a **hard credit check**, which may deter some shoppers. Klarna is available in the following countries: > [card] > > * [Australia](/klarna--a-guide) > * [Austria](/klarna--a-guide) > * [Belgium](/klarna--a-guide) > * [Canada](/klarna--a-guide) > * [Denmark](/klarna--a-guide) > * [Finland](/klarna--a-guide) > * [France](/klarna--a-guide) > * [Germany](/klarna--a-guide) > [card] > > * [Italy](/klarna--a-guide) > * [Netherlands](/klarna--a-guide) > * [Norway](/klarna--a-guide) > * [Spain](/klarna--a-guide) > * [Sweden](/klarna--a-guide) > * [United Kingdom](/klarna--a-guide) > * [United States](/klarna--a-guide) ## Payment Methods per Country Klarna is available in the following countries, and offers different payment methods per country: | Country | Klarna Category | Payment Method | | - | - | - | | Australia | Pay later | Pay in 4 | | Australia | Pay now | Card | | Austria | Pay later | Pay 30 days later | | Austria | Financing | Term loan financing 6, 12, 24, 36 m | | Austria | Pay now | Pay by card | | Austria | Pay now | Klarna bank transfer | | Austria | Pay now | Direct debit | | Austria | Pay now | Klarna bank account | | Belgium | Pay later | Pay 30 days later | | Belgium | Pay now | Klarna bank transfer | | Belgium | Pay now | Pay by card | | Canada | Pay later | Pay in 4 | | Canada | Financing | Term loan financing 6 | | Canada | Pay now | Pay by card | | Denmark | Pay later | Pay 30 days later | | Denmark | Pay later | Pay in 3 | | Denmark | Pay now | Pay by card | | Finland | Pay later | Pay 30 days later | | Finland | Financing | Term loan financing 6, 12, 24, 36 m | | Finland | Financing | Installments 6, 12, 24, 36 m | | Finland | Pay now | Pay by card | | Finland | Pay now | Klarna bank transfer | | France | Pay later | Pay 30 days later | | France | Pay later | Pay in 3 | | France | Pay now | Pay by card | | France | Pay now | Klarna bank account | | Germany | Pay later | Pay 30 days later | | Germany | Financing | Term loan financing 6, 12, 24, 36 m | | Germany | Pay now | Pay by card | | Germany | Pay now | Klarna bank transfer | | Germany | Pay now | Klarna bank account | | Germany | Pay now | Direct debit | | Italy | Pay later | Pay 30 days later | | Italy | Pay later | Pay in 3 | | Italy | Pay now | Pay by card | | Italy | Pay now | Klarna bank account | | Netherlands | Pay later | Pay 30 days later | | Netherlands | Pay later | Pay in 3 | | Netherlands | Pay now | Pay by card | | Netherlands | Pay now | Klarna bank transfer | | Netherlands | Pay now | Direct debit | | Norway | Pay later | Pay 30 days later | | Norway | Financing | Term loan financing 6, 12, 24, 36 m | | Norway | Pay now | Pay by card | | Spain | Pay later | Pay 30 days later | | Spain | Pay later | Pay in 3 | | Spain | Pay now | Pay by card | | Spain | Pay now | Klarna bank account | | Sweden | Pay later | Pay 30 days later | | Sweden | Pay later | Pay Later 60 days | | Sweden | Financing | Installments 3, 6, 12, 24, 36 m | | Sweden | Financing | Term loan financing 6, 12, 24, 36 m | | Sweden | Pay now | Pay by card | | Sweden | Pay now | Klarna bank transfer | | Sweden | Pay now | Direct debit | | Sweden | Pay now | Swish | | United Kingdom | Pay later | Pay 30 days later | | United Kingdom | Pay later | Pay in 3 | | United Kingdom | Pay now | Pay by card | | United Kingdom | Pay now | Klarna bank transfer | | United States | Pay later | Pay in 4 | | United States | Pay later | Pay 30 days later | | United States | Financing | Term loan financing 3, 6, 12, 18, 24 m | | United States | Pay now | Pay by card | | United States | Pay now | Card | ## Transaction Limits Klarna has different transaction limits per country as described in the following table. | **Country** | **Payment Method** | **Limit** | | - | - | - | | Australia | Pay in 4 | $35 - $1500 | | Austria | Pay in 14 days | €1 - €5,000 | | Austria | Direct Bank Transfer | €1 - €10,000 | | Belgium | Pay Later (30 days) | €1 - €5,000 | | Belgium | Direct Bank Transfer | €1 - €15,000 | | Canada | Pay in 4 | 35 CAD – 2500 CAD | | Denmark | Pay Later (30 days) | 1 DKK - 5,000 DKK | | Denmark | Pay in x months | 39 EUR - 30,000 DKK | | Finland | Pay Later (30 days) | €1 - €5,000 | | Finland | Pay in x months | €5 - €3,000 | | Finland | Direct Bank Transfer | €1 - €10,000 | | Germany | Pay Later (30 days) | €1 - €1,000 | | Germany | Pay in x months | €35 - €3,000 | | Germany | Direct Bank Transfer | €1 - €10,000 | | Italy | Pay in 3 | €1 - €1,500 | | Italy | Direct Bank Transfer | €1 - €10,000 | | Netherland | Pay Later (30 days) | €1 - €5,000 | | Netherland | Direct Bank Transfer | €1 - €15,000 | | Norway | Pay Later (30 days) | 1 NOK - 75,000 NOK | | Norway | Pay in x months | 1 NOK - 75,000 NOK | | Spain | Pay in 3 | €35 - €1,000 | | Spain | Direct Bank Transfer | €1 - €10,000 | | Sweden | Pay Later (30 days) | 1 SEK - 100,000 SEK | | Sweden | Pay in x months | 39 SEK - 100,000 SEK | | Sweden | Direct Bank Transfer | 1 SEK - 100,000 SEK | | United Kingdom | Pay Later (30 days) | £1 - £600 | | United Kingdom | Pay in 3 | £1 - £2,000 | | United States | Pay in 4 | $0 - $2500 | # Klarna On-Site Messaging Integration Source: https://docs.global-e.com/klarna-on-site-messaging-integration ## Background Global-e offers a checkout solution for e-commerce retailers looking to expand internationally, partnered with Klarna to enable pay later, slice it, or pay now across the e-stores (“merchants”) where their checkout is displayed. Global-e owns all claims and liabilities on behalf of their merchants, so Klarna has signed them as a Merchant of Record and not as a partner. Each of the three Klarna regions (EU, US, and OC) has a single MID and credentials managed by Global-e. These credentials have been implemented in Global-e Checkout and are used across all Global-e merchants. As Global-e only offers the checkout solution, merchants use their platform to manage other pages in the e-stores, this means that Global-e has no direct control over the implementation of Klarna **On-Site Messaging (OSM)** for the merchants. The purpose of this section is to provide support for Global-e when working with merchants implementing Klarna OSM in their e-stores. The following guidelines describe the key considerations and best practices for implementation, especially when implementing OSM in multiple markets. For more information about Klarna's services, see [Klarna](https://www.klarna.com/uk/). ## Best Practices To maximize the performance of the OSM integration merchants should perform the following: * Include the JavaScript Library in the code as early as possible. Add it before any content in the html, right after opening the body tag. * Load the JavaScript Library “asynchronously”. Make sure that the script has the async attribute set. * Avoid using a tag manager. * If the merchants' solution relies on templates, make changes in a central file to ensure placements added to other pages will render. * If it is a Shopify merchant, other apps may influence the performance of On-Site Messaging. Review installed apps to verify they are all still necessary and review all the resources loaded for the page, such as using the browser’s developer tools. > [!NOTE] > > Klarna Shopify OSM app is not supported with Global-e for On-site messaging Shopify merchants should [integrate directly](https://docs.klarna.com/conversion-boosters/on-site-messaging/integrate-on-site-messaging/integrate-using-klarna-web-sdk/). Check out our [FAQ](https://docs.klarna.com/on-site-messaging/faq/) page for further information ## Global-e Considerations There are several considerations for merchants integrating via Global-e, including but not limited to: * If the merchant is integrated locally through another partner, make sure to continue using this script for installation in the appropriate local market, and use the Global-e scripts above, for other locations. * The merchant has to handle the site language, by setting the country, currency and locale from the Global-e cookie - **GlobalE_Data**. * Global-e provides price conversions. it is possible to set the converted price in the DOM instead of the native price and set the attributes of its parent element: `ge-data-converted-price` and `ge-data-converted-full-price`. If the price has to be converted beforehand, then there is also an option to use Global-e JS external method to retrieve the converted price on client side. If support is required on this issue, merchants should discuss this with Global-e. ## The Workflow > [card] > > **Homepage** > > Inform shoppers about Klarna as early as possible. > > Use the top-strip promotion and banners to inform customers about available payment methods. > [card] > > ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-346cf09a-5688-ad6d-37fc-0e4dfcdaa0a8.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=47516b59714593d1499a2fa3fcbc3b63) > [card] > > **Product page** > > Show customers that they can shop now and pay later with Klarna. > > Use the payment messaging and let the shoppers calculate their budget before purchasing. > [card] > > ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1c548935-30a2-0fb7-10f6-2f7f76178466.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=4d75305d54e170266e9a81cd8de0d1fd) > [card] > > **Cart & Checkout** > > Give the customers the purchase power to finalize the purchase. > > Inform customer of their purchase power with messaging tailored to the final order amount. > [card] > > ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-40099632-1430-5e0d-dab7-b519cc1d872c.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=6f5e2d7869ff3ba13954c3455d667bfd) ## Klarna JavaScript Library The On-Site Messaging (OSM) will only work by adding the JavaScript Library code snippet to all website pages along with the placements in specific places where you want messaging to appear. Although the exact way merchants edit their e-store may differ depending on the e-commerce solution, the steps described below apply for all websites. * Merchants will need access and editing privileges to the source code of your e-store. This is a good point in time to involve a developer in the process. * Merchants will also need to know where on the e-store they would like the messaging to appear. The JavaScript Library is the core part of On-Site Messaging integration. This library is used to communicate between the sub-merchants e-store and On-Site Messaging, and will render the content in the placements tags and not adding it to the merchants site will mean placements are not loaded. The On-Site JavaScript library delivers the core functionality of the On-Site Messaging: * Communicating with the On-Site Messaging to deliver messaging for placements. * Optimizing the user experience by leveraging a cache layer. * Setting cookies in order to assure consistency in delivered messaging. * Handling interstitial operations to allow user interaction without affecting the website. More about how the On-Site JavaScript library works can be read [here](https://docs.klarna.com/on-site-messaging/faq/#what-is-the-on-site-messaging-javascript-library?). The JavaScript library contains three key attributes, these are: | Attribute | Description | | - | - | | src | Klarna OSM script URL | | async | Makes loading the script non-blocking | | data-client-id | OSM identifier for merchant configuration | Klarna provides three different Javascript libraries, one of each of the regions that are supported: * EU - Europe * NA - North America * OC - Oceania ## Supported Countries The countries currently supported in each region are listed in the below table: | **Region** | **Country** | **Country Code** | **Locales** | | - | - | - | - | | EU | United Kingdom | GB | en-GB | | EU | Ireland | IE | en-IE | | EU | Sweden | SE | sv-SE; en-SV | | EU | Finland | FI | fi-FI; en-FI | | EU | Norway | NO | no-NO; en-NO | | EU | Denmark | DK | da-DK; en-DK | | EU | Austria | AT | de-AT; fr-AT; it-AT; en-AT | | EU | Germany | DE | de-DE; en-DE | | EU | Netherlands | NL | nl-NL; de-NL; en-NL | | EU | Belgium | BE | fr-BE; nl-BE; en-BE | | EU | Italy | IT | it-IT; en-IT | | EU | Spain | ES | es-ES; en-ES | | EU | France | FR | fr-FR; en-FR | | NA | United States | US | en-US | | NA | Canada | CA | en-CA; fr-CA | | OC | Australia | AU | en-AU | If merchants are offering Klarna in different markets then they need to handle this in the OSM implementation by using the correct JavaScript library for the consumer. Below are the snippets for the integration of Global-e with Klarna: * **EU (single MID)** ``` ``` * **US (single MID)** ``` ``` * **CA (single MID)** ``` ``` * **OC (single MID)** ``` ``` > [!NOTE] > > If the merchant is integrated locally through another partner, they will need to make sure to continue to use this script for installation in the appropriate local market, and use the Global-e scripts above for other locales. To refresh placements we need to push an event into the data layer to inform the JavaScript Library the placements on the page have been altered. This should be triggered in the code after a change. **Example** ``` ``` ## Placements Placement tags are the HTML tags that decide where to display messaging to visitors on your website. Placements require basic configurations to adjust them for your needs. Some attributes are required and others are optional. | Attribute | Mandatory or Optional | Description | | - | - | - | | data-key | Mandatory | Identifier for the placemen, uniquely identifies a placement type and size. | | data-locale | Optional | Locale of the ad. If not defined, use default locale for country. | | data-purchase-amount | Optional | The amount of money in micro units (\$120.00 = 12000), used for amount-based credit promotions. | | data-inline=”true” | Optional | The attribute will render placements inline in cases where content has been configured for this. | | data-preloaded=”true” | Optional | Set when a placement is preloaded. Read more about in Pre-loading placements | | data-theme=”default” | Optional | Set a theme to override the default or customized content. | **Example of the attributes used in a placement** ``` 10.0 ``` ### Minimal XML snippet — free shipping ```xml theme={null} true FREE false 4 1 ``` **See also:** [Price Calculation](/price-calculation-sfcc) · [Customer Groups](/customer-groups-sfcc) · [Checkout discount vouchers](/checkout-discount-vouchers-sfcc) · [Metadata → Promotion](/metadata-sfcc#promotion) · [Configuration](/configuration-sfcc) # Q&A Duties, Taxes, Distance Selling Source: https://docs.global-e.com/q-a-duties-taxes-distance-selling ## What is the threshold of D\&T in the EU and the US? The duty threshold in the EU is 150 EUR. The D\&T rate is determined by several parameters like outbound, destination, HS code (product classification), product origin country, value, and more. For the USA there is a threshold above \$800, and also US Sales Tax, which varies based on the state. US Sales Tax has been collected since January 1st, 2020  following a Supreme Court decision in 2018 that rules that remote sellers with no physical presence in a state must collect and remit the sales tax for each state where they do business which applies also for cross-border sales into the US market.  The tax is different for each state. ## How is D\&T Calculated? Global‑e calculates the duties and taxes due on each relevant order depending on the shipping address, the product tax code, the country of origin of products, value, and more, and presents it to the customer on the checkout page, with an option to prepay to guarantee the landed cost. For some countries (like the EU, UK, Australia, New Zealand, Norway, and Switzerland) we use Hidden Forced DDP, which means the customer does not see the D\&T when completing the purchase. You may absorb the cost or include D\&T in product cost using the pricing coefficient. ## Can Duties and Taxes be Included in the Product Price? Duties and taxes can be included in product prices when selling internationally and applied to specific countries. In this case, the customer will only see total product prices at checkout and be informed that all duties and taxes are included. In order to compensate for this extra cost, it is possible for merchants to charge customers for shipping and/or increase the prices of products from the local product price by using the country coefficient. Currently, this is available for countries that require mandatory Duties and Taxes. # Q&A Fraud Source: https://docs.global-e.com/q-a-fraud ## 1. How Global-e Fraud Prevention Works ### Can merchants disable Global-e's fraud service to handle fraudulent activity internally? No. Global-e is the Merchant of Record and therefore takes full fraud liability. Fraud prevention is part of Global-e's overall solution and cannot be removed. More importantly - Global-e operates one of the most advanced fraud prevention processes in cross-border e-commerce, combining top industry tools with the knowhow of a fully managed in-house fraud analyst team. This is significantly more effective than any merchant managing fraud independently, and it is one of the key advantages of the Global-e solution. ### What does Global-e cover in terms of fraud? Merchants working with Global-e have zero fraud risk on cross-border orders. Global-e is fully covering all fraud chargebacks reported as fraudulent chargeback codes through the payment provider - this is not an independent interpretation, but follows the code reported by the payment service provider. Note that any service chargeback or other service/product-related chargebacks (e.g., item not as described, delivery dispute, subscription dispute) are NOT considered fraud chargebacks and are not covered by Global-e. ### Who is the Merchant of Record (MoR) on cross-border orders? Global-e acts as the Merchant of Record for any order that goes through the Global-e checkout, as determined by the operated countries setup. As the MoR, Global-e handles the direct relationship with the Payment Service Providers, is liable for fraud chargebacks, and manages the full lifecycle of transaction processing. The merchant's brand is preserved in the customer experience, but the legal and financial counterparty to the end customer is Global-e. ### Which fraud engine does Global-e use? Global-e operates a best-in-class fraud prevention process that combines top industry tools with the deep knowhow of a fully managed in-house fraud analyst team. Our multi-layered approach includes automated risk scoring, continuous model tuning, and dedicated expert manual review - giving merchants a level of protection that is not achievable independently. Signals are aggregated across ALL merchants on Global-e's platform, so cross-brand history is factored into every decision. ## 2. Why Orders Get Cancelled For Fraud ### What does it mean when an order is cancelled because of a stolen card? If a card is reported stolen to its issuing bank, that signal reaches Global-e. All orders attempting to use that card are cancelled and we cannot approve future orders from that customer using the same card or related identifiers. If the customer insists the card is theirs, they must contact their issuing bank directly to clear the fraud report - Global-e cannot override a bank-confirmed stolen-card flag. ### Why does the customer say they're legitimate but their orders keep getting cancelled? Three common causes: 1. Network-level fraud history at other merchants on our platform. 2. Bank-confirmed stolen card overriding customer's belief. 3. Merchant policy rule (velocity), not a fraud-score decision. The fraud team will share the specific reason internally, and the customer should not be told specifics. ### Why are we seeing a sudden spike in fraud cancellations from one country? A spike can be a fraud campaign or bot attack targeting that geography, a payment-related issue, a model recalibration, or a merchant promotion. If you're also seeing a drop in payment success rates, the issue should be escalated to the payments team first. Otherwise, escalate via the CSM for analyst review. ## 3. Blocking And Unblocking Customers ### Can merchants ask to block a user for fraud reasons? Yes. If the merchant has valid information that the customer is fraudulent, they can share it with their CSM who will pass it to the Global-e fraud team. The fraud team will add negative feedback for the user in our fraud engine and future orders by that user should be rejected. Include if possible: customer email/ID, order numbers involved, reason for the block, and supporting evidence. ### Can merchants request to unblock a customer? Yes. The CSM should send a request to [fraudteam@global-e.com](mailto:fraudteam@global-e.com). The fraud team will check for any known risk ratings and if the customer/IP can be unblocked, will add this to our fraud engine. Note: our fraud engine is AI-based, so updates can take a few days to propagate after approval. The request should explain why the merchant believes the customer should be re-evaluated - positive history, a direct/known relationship, etc. - preferably with more than 6 months of history, since older claims carry lower risk. Include: customer email / ID / IP to unblock, reason for the request, whether one-time release or ongoing allowlist, and any context contradicting the fraud signal. Global-e has cross-merchant visibility - the justification helps weigh the trade-off. ### Can we allowlist or block specific payment methods for a customer? No. The fraud engine cannot block or allowlist a specific payment method for an individual customer. We can: block a customer entirely, unblock from blocklist, maintain a global blocklist at the catalogue level. Payment-method preferences for risk reasons are a configuration discussion with the CSM, not a fraud-team request. ### How long does an unblock take to apply? After approval, the change is added to our fraud engine immediately, but because the engine is AI-based, it can take a few days for the updated signal to fully propagate. Recommend the customer wait 48-72 hours after notification before retrying. ### Can we allowlist an IP address (e.g., merchant's office for telephone orders)? Yes. CSM emails [fraudteam@global-e.com](mailto:fraudteam@global-e.com) with IP address, business justification, and merchant ID. Caveat: IP allowlisting only reduces the IP-based signal - if an order shows other strong fraud indicators, it can still be cancelled. ### Can we set up a fraud-engine exception for a pre-event situation (in-store activation, VIP launch, pop-up)? Yes, with 1–2 weeks planning. Fraud team needs: event dates/hours, eligible SKUs, coupon/promo code, IP address or range used at venue, staff device details, venue address. Caveat: without a strong technical identifier, the fraud team cannot guarantee automatic approval - orders are still risk-assessed individually. ## 4. Reporting And Visibility ### Can we send a fraud report? Yes. Report setup is handled through the BI team, with the fraud team CC'd on the request. Contact [fraudteam@global-e.com](mailto:fraudteam@global-e.com) via the CSM. Options: weekly (Mondays at 22:05 UTC) or daily (each morning). The report is a fixed format and includes: order numbers, cancellation timestamps, and reason categories. Custom report formats are not available - the report content is standardised to ensure consistency. ### How do I find all of the orders cancelled by fraud? Merchants can view Canceled orders directly in the merchant portal. Additionally: review the fraud cancellation report (if subscribed), or contact CSM for an ad-hoc pull or report setup. ### If requested, will the fraud team notify a Merchant via email when they cancel an order due to fraud risk? No. Per-order email notifications aren't scalable. Order status is visible to the merchant directly on the portal. Other options: automated daily/weekly fraud report, ad-hoc lookups via CSM, or the order-status webhook feed. Note: in sensitive cases (e.g. high-value orders or VIP customers), the fraud team may proactively reach out to the CSM by email. ### How can I see my merchant's fraud KPIs (approval rate, rejection rate, fraud savings)? Fraud KPIs are available in Global-e's BI/Insights platform. Standard metrics include: Fraud Approval Rate, Fraud Rejection Rate, Fraud Team Approval Rate, and Fraud Savings (orders saved by manual review). CSM can pull on request. We are also exploring adding these metrics directly to the merchant admin portal under Analytics (via BI). ### What's a 'normal' fraud rejection rate? There is no single "normal" rate - it depends heavily on the merchant's product category, target markets, average order value, geography, whether the catalogue includes rare/limited-edition items, social media trends and activity around the merchant's products, and sale periods or discount campaigns. What matters is that Global-e's fraud prevention process is designed to maximise approvals while minimising fraud exposure - continuously optimised by our in-house team. If a merchant is concerned about their rejection rate, the CSM can request a fraud analyst review of their specific profile. ## 5. Customer Communication ### What message do customers receive when their order is cancelled for fraud? Customers receive an automated email notification when their order is cancelled for fraud risk. **Non-Shopify email:** "Dear \[customer name], Your order has been cancelled because we are unable to verify your information. Please note that any amount debited to us will be refunded." **Shopify email:** "Dear \[customer name], Your order has been cancelled." The message intentionally does not reveal the fraud check. ### Why is the customer message so vague? Can we tell the customer the specific reason? The fraud team shares as much context as it can with merchant/CS/CSM, but not the specific signals or detection methods behind a decision - and this should not be passed on to the customer either. 1. Security: revealing how detection works would let fraudsters adjust their behaviour to get around it. 2. Liability: sharing signals with a potentially fraudulent customer exposes Global-e and the merchant to social-engineering attempts. ### What should we tell a customer whose order keeps getting cancelled even after retrying? Try a different payment method (Apple/Google Pay, Alipay), try from a different network if on VPN/hotspot, wait 24h before retrying (resets velocity rules), ensure billing address exactly matches card issuer. If retries still fail, cancellation is likely network-level or bank-confirmed - escalate to CSM. ## 6. Operational Process For Merchant CS Teams ### Do I need to contact the fraud team every time an order is cancelled? No. Most cancellations are routine. Standard customer guidance resolves the majority of legitimate cases. Escalate only when: long-history customer is repeatedly cancelled, VIP needs urgent assistance, customer's bank has reported confirmed fraud, unusual pattern (volume spike, single geography, single product), customer has tried 3+ times with different payment methods. ### How does the Shopify ↔ Global-e fraud check relationship work? For Shopify merchants on Global-e for cross-border: Global-e is MoR on the cross-border order and does the fraud check. Shopify's own fraud signals (Shopify Fraud Protect, Shop Pay) are NOT applied to Global-e orders - they apply only to Shopify's direct (domestic) flow. Cancellation messages are abbreviated because Shopify envelope handles the rest. A customer cancelled at Global-e layer who passed Shopify's checks is expected behaviour. ### What's the SLA on a fraud team escalation ticket? The SLA for fraud escalation tickets depends on volume and urgency. If something is genuinely urgent, flag it to the fraud team directly ([fraudteam@global-e.com](mailto:fraudteam@global-e.com)) so it can be prioritized accordingly. ## 7. Edge Cases And Special Situations ### There's a country/region threshold (e.g., 'over \$X to China') that's blocking large orders. Can we adjust it? The fraud team cannot adjust a country's customs laws or thresholds. What we can do is exclude a specific merchant from the threshold - only with a formal agreement between the CSM, CS and the merchant, and only after the merchant understands the implications (including impact on fulfillment liability). The CSM opens a ticket with merchant ID, country and business justification. ## Appendix A | Question / cue | Goes to section | | - | - | | Are we covered for chargebacks? | 1 - How Global-e fraud works | | Why was THIS specific order cancelled? | 2 - Why orders get cancelled | | Stolen card / bank report | 2 + 3 - bank-reported | | How do I block/unblock a customer? | 3 - Blocking and unblocking | | Pre-event / VIP exception | 3 - Event exception | | Can we send a fraud report? | 4 - Reporting and visibility | | What does the customer see? | 5 - Customer communication | | How does Shopify integration work? | 6 - Operational process | | Country threshold question | 7 - Edge cases | # Q&A Orders Source: https://docs.global-e.com/q-a-orders ## According to tracking, the parcel has arrived but my customer has confirmed that it has not arrived. What can I do? Please ask the customer to fill in this document and send it to you, then submit it to us via the [Merchant Support Portal](/merchant-support-portal), which only you as the merchant can access. We will reach out to the carrier and keep you updated. ## The carrier's investigation has determined no compensation is due. Can anything else be done? Unfortunately, once a carrier’s investigation has determined that no compensation is due, nothing else can be done. Once the package has been handed over to the carrier, it becomes the carrier’s responsibility; therefore, if lost and a claim is accepted by the carrier, the carrier will reimburse according to their policy. If after the carrier’s investigation, a claim is approved you will receive the compensation via the weekly reconciliation. ## If a claim is approved, how do I get paid? If, after the carrier’s investigation a claim is approved you will receive the compensation via the weekly reconciliation. ## How long does an investigation with a carrier take? The length of an investigation depends on the carriers and can take up to a few weeks. When the investigation is complete the carriers update Global‑e and we then update you. ## The order is delayed or missing. What is the procedure? If an order is delayed or missing, please reach out to Customer support via the [Global-e Merchant Support Portal](/merchant-support-portal) (merchants only) with all relevant details, the order number, and an explanation of the issue. Please remember that non-express transit times are an estimate. Please allow at least an additional five days before contacting our customer support. When CS (customer service) receive a ticket regarding missing, delayed orders, or questions they reach out to our OPS team to investigate. Most of the time OPS needs to reach out to the carrier and wait for their response. Often an investigation will be opened by the carrier to determine if compensation is warranted. The carrier’s response time can vary in general DHL is quicker than the tracked standard carriers. We do our utmost to chase the carriers, however often it’s not in our hands. Once the package has been handed over to the carrier it’s the carrier’s responsibility, and therefore if lost and a claim is accepted by the carrier, the carrier will reimburse according to their policy. ## Where can I see the transit times shown to the customer in the checkout page? 1. Navigate to **Orders > View Orders >**. 2. Find the specific order. 3. Select the **> Delivery** tab. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-38f6a375-88fd-017f-5d57-5bf73124265b.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=a17dad3f50d6df399213c85eeb259d41) ## Where is my customer's order? You can track the customer’s order by clicking on the tracking number within the relevant order. 1. Navigate to **Orders > View Orders >** 2. Find the specific order. 3. Click the **Tracking No.**. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cf344ac6-48f0-ffe4-0015-0a5e6171aa7c.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=f717e4b4cddf355f9c839899a0e8a88f) The relevant carrier tracking opens. # Production readiness Source: https://docs.global-e.com/readiness-assessment Use this checklist when promoting a working Global-e integration from **SFCC Staging** to **SFCC Production**. It assumes [Installation](/installation-sfcc) and [Configuration](/configuration-sfcc) are complete and tested on Staging, and walks through what to verify before replication, what replication does and does not carry, and what to finish by hand on Production before enabling Global-e for shoppers. See also: [Installation](/installation-sfcc), [Configuration](/configuration-sfcc), [Cartridges](/cartridges-sfcc), [Requirements](/requirements-sfcc), [Jobs](/jobs-sfcc), [Failover and recovery](/failover-sfcc). ## Overview A production rollout has four phases: 1. **Verify Staging** — every Global-e artifact is present, and instance-specific values are entered in the **Production** context. 2. **Replicate** — code replication first, then data replication. 3. **Complete Production by hand** — the items Salesforce B2C Commerce does not replicate. 4. **Go live** — run **GlobaleSettings**, enable Global-e, clear caches, and smoke-test. ### What replication carries Plan the manual steps around what Salesforce B2C Commerce data replication does **not** move between instances: | Artifact | Carried by replication | What to do on Production | | - | - | - | | Cartridges (code version) | **Code** replication | Activate the replicated code version; confirm Global-e cartridges are inside it | | System object attributes, custom object definitions | Data replication (global metadata) | Verify after replication | | Site preferences (`ge*`), order preferences, URL rules, payment and shipping methods | Data replication (site) | Verify values in the **Production** context | | Price books, promotions, customer groups | Data replication (global / site) | Verify | | Site and Business Manager cartridge paths | Data replication (site settings) | Verify; fix on Staging and re-replicate rather than editing Production directly | | **Job schedules** | **Not replicated** | Import `metadata/jobs.xml` on Production and assign flows to Production site IDs | | **Service definitions, profiles, and credentials** | **Not replicated** — passwords are stripped from any export | Import `metadata/services.xml` on Production; create `Globale-{merchantId}` and any SFTP credentials by hand | | **Custom Log Settings** | **Not replicated** | Configure the `GLOBALE` custom log on Production | | `GLOBALE_*` custom object **records** | Optional (site Custom Objects task) | Prefer populating them on Production by running **GlobaleSettings** — see [Custom objects](#custom-objects) | Salesforce reference: [Data Replication Processes in B2C Commerce](https://help.salesforce.com/s/articleView?id=cc.b2c_data_replication_processes.htm\&language=en_US\&type=5). ## Before you start Coordinate the following with **Global-e Merchant Support** before touching Production: | Item | Why | | - | - | | Production merchant account is enabled on the Global-e platform | Platform-side behaviour (countries, payment methods, checkout settings) must be enabled by Global-e **before** the SFCC steps below | | Production **API base URL** (`geApiUrl`), **Client JS SDK base URL** (`geClientJsBaseUrl`), **Client JS Merchant ID** (`geClientJsMerchantId`), and **Merchant GUID** | Production values differ from the QA / integration environment used on Staging | | Your Production storefront hostname(s) | Global-e calls the `Globale-*` storefront endpoints on your Production domain for cart validation, order creation, and order updates | | Production **OCAPI Data API** client ID, secret, base URL, and OCAPI version | Required for new integrations — see [Configuration → Data API](/configuration-sfcc#data-api-mandatory-for-new-integrations) | | A test order plan (test country, payment method, refund) | Agree who places, confirms, and refunds the go-live test orders | Also confirm that **every** instance — Staging and Production included — runs SFCC Compatibility Mode **17.7 or newer** ([Requirements](/requirements-sfcc#sfcc-compatibility-mode)). ## Staging checklist Work through this list on Staging. Where a value is instance-specific, enter it in the **Production** instance-type context on Staging so it is replicated with the correct value. ### Code | Check | Expected | | - | - | | Global-e cartridges are in the **active** code version on Staging | `int_globale` plus the storefront cartridge for your architecture — see [Cartridges](/cartridges-sfcc) | | The build is a tagged release, not a development snapshot | Use a release from the [SFCC-Releases](https://gitlab.com/global-e/platforms/sfcc/SFCC-Releases) mirror or a tagged SFCC-certified build | | Client assets are compiled | If you build from source, run the compile scripts in `package.json` before upload — see [Installation](/installation-sfcc) | | No QA, mock, or sandbox-only cartridges are in the cartridge path | Only cartridges intended for shoppers | ### Cartridge paths **Administration → Sites → Manage Sites → (Your Site) → Settings** | Check | Expected | | - | - | | Storefront site path | Global-e cartridges in the position documented in [Configuration](/configuration-sfcc#add-global-e-cartridges-to-the-site-cartridge-path) — SFRA: brand cartridges : `int_globale_sfra` : `int_globale` : `app_storefront_base`; SiteGenesis: `int_globale_sitegenesis` : `int_globale` : brand cartridges; headless: `int_globale_headless` before `int_globale` | | Business Manager path | `int_globale` on the **Business Manager** site path so organization-context **GlobaleSettings** steps resolve — see [Cartridges → Business Manager cartridge path](/cartridges-sfcc#business-manager-cartridge-path) | | Sites not operated by Global-e | No Global-e storefront cartridge, unless the site uses a popups-only cartridge for the Country Switcher | ### Metadata | Check | Where | Expected | | - | - | - | | System object custom attributes (`ge*`) | **Administration → Site Development → System Object Types** | Present on Site Preferences, Product, Order, Basket, Price Book, Shipping Method, and the other objects listed in [Metadata](/metadata-sfcc) | | Custom object definitions | **Administration → Site Development → Custom Object Types** | Every `GLOBALE_*` type from `metadata/meta/custom-objecttype-definitions.xml` | | Demo data | — | Nothing from `metadata/demo/` (including `DEMO_GLOBALE_*` types and demo customer groups) is destined for Production | If anything is missing, re-import from `metadata/` in **MERGE** mode in the order given in [Installation → Import metadata](/installation-sfcc#import-metadata). ### Site preferences **Merchant Tools → Site Preferences → Custom Site Preference Groups** Select the **Production** instance type before editing so the value replicates to Production. | Preference | Production value | | - | - | | **Global-e Enabled** (`geEnabled`) | **No** until go-live; you enable it on Production as the last step | | **Global-e API Base URL** (`geApiUrl`) | Production API base URL from Global-e (for example `https://connect.bglobale.com`) | | **Global-e Client JS SDK Base URL** (`geClientJsBaseUrl`) | Production SDK base URL from Global-e | | **Client JS Merchant ID** (`geClientJsMerchantId`) | Production merchant account ID (for example `10001`) | | **Service Endpoint Config** (`geServiceEndpointConfig`) | Empty unless you intentionally override a service; remove any QA-only overrides — see [Services configuration](/services-configuration-sfcc) | | **Used SFCC CAPI Type** (`geCAPIType`) and the OCAPI / SCAPI groups | Production client IDs, domain, and versions for headless / Commerce API integrations — see [Commerce API support](/commerce-api-sfcc) | | **Global-e Product Settings** (`GLOBALE-PRODUCT` group) | Same as Staging (image view type, attribute keys) | | **Global-e Catalog Jobs** (`geCatalogFeedConfig`, `geRestrictedItemsFeedConfig`) | Production SFTP and feed settings if these jobs are in scope | Full descriptions are in [Metadata → Site Preferences](/metadata-sfcc#site-preferences). ### Order preferences **Merchant Tools → Site Preferences → Order** | Preference | Expected | | - | - | | **Limit Storefront Order Access** | **Allow List** containing every `Globale-*` endpoint listed in [Configuration → Order Preferences](/configuration-sfcc#order-preferences-merchant-tools--site-preferences--order) | | **Filter Storefront Orders by Customer Session** | **No** | | **Auto-Fail Orders** | Set (not empty). Use **4320** minutes by default; **20160** when your Global-e account is configured to place orders on payment update — see [Configuration](/configuration-sfcc#failed-orders-settings) | ### Payment and shipping | Check | Where | Expected | | - | - | - | | Payment processor **GLOBALE** | **Merchant Tools → Ordering → Payment Processors** | Exists (metadata does not create it — see [Configuration → Payment Processor](/configuration-sfcc#payment-processor-merchant-tools--ordering--payment-processors)) | | Payment method **GLOBALE** | **Merchant Tools → Ordering → Payment Methods** | Enabled and assigned to processor **GLOBALE** | | Shipping methods | **Merchant Tools → Ordering → Shipping Methods** | All seven present and online: `GLOBALE`, `GLOBALE_STANDARD`, `GLOBALE_EXPRESS`, `GLOBALE_STORE_COLLECTION`, `GLOBALE_HUB`, `GLOBALE_DIRECT`, `GLOBALE_WYOL` | | Shipping method **Tax Class** | Each Global-e method | **Standard** or a valid custom tax class — never **Undefined** (a fresh import can reset it) — see [Configuration → Shipping methods](/configuration-sfcc#shipping-methods-merchant-tools--ordering--shipping-methods) | | Default currency | **Administration → Sites → Manage Sites → (Your Site) → General** | The merchant base currency — see [Configuration → Default Currency Settings](/configuration-sfcc#default-currency-settings) | ### URL rules **Merchant Tools → SEO → URL Rules → Pipeline URLs** | Alias | Pipeline | | - | - | | `globale/checkout/pspredirect` | `Globale-PaymentRedirect` | ### Price books and promotions | Check | Expected | | - | - | | Base price book(s) | `geBasePricebook` = true, online, correct `geApplicableToDynamicCountries` scope | | Fixed price book(s), if any | `geFixedPricebook` = true, online, non-empty `geApplicableToFixedCountries`, currency matches each fixed country | | Cache price books | Leave to **GlobaleSettings** — the job generates and imports them on each instance when **Enable Cache Price Books** (`geEnableCachePriceBooks`) is on | | Promotions and customer groups that use `session.custom.ge*` attributes | Present and scheduled for Production — see [Promotions](/promotions-sfcc) and [Customer groups](/customer-groups-sfcc) | Configuration detail and the post-change checklist are in [Price calculation](/price-calculation-sfcc#post-change-operations). ### Services **Administration → Operations → Services** | Check | Expected | | - | - | | Service instances | Every `Globale-*` service from `metadata/services.xml` is present and **enabled** | | Service profiles | `GLOBALE-*` profiles present with **Enable Rate Limit** unchecked (as shipped), in particular `GLOBALE-SENDCART` used by `Globale-SendCartV2` | | Mock mode | Disabled on every Global-e service | | Communication log | Enabled on Global-e services for at least the first weeks after launch | | Merchant GUID credential | `Globale-{geClientJsMerchantId}` (for example `Globale-10001`) exists with an **empty URL** and the Merchant GUID as **password** — see [Configuration → Merchant GUID credentials](/configuration-sfcc#merchant-guid-credentials-required) | | SFTP credentials | `Globale-SFTPCatalogFeedUpload`, `Globale-SFTPRestrictionsFeedUpload`, `Globale-SFTPDownload` filled in only for the feeds in scope | Service definitions and credentials are **not** replicated. Treat this section as a preview of what you will re-create on Production; the Staging Merchant GUID is typically **not** the Production one. ### Jobs **Administration → Operations → Jobs** | Check | Expected | | - | - | | Job definitions | `GlobaleSettings`, `GlobaleProducts`, `GlobaleOrderNotifications`, `GlobaleCatalogFeed`, `GlobaleOrderStatusFallback` imported from `metadata/jobs.xml` | | Site assignment | Flows assigned to the Global-e operated site IDs — replace the sample `RefArchGlobal` — see [GlobaleSettings → Site context](/globale-settings-sfcc#site-context) | | Enabled jobs | Only the jobs in your integration scope; **GlobaleProducts** stays on Staging / development only ([GlobaleProducts](/globale-products-sfcc#sfcc-staging)) and product attributes reach Production through catalog replication | Job schedules are **not** replicated; you repeat the import on Production. ### Open Commerce API settings **Administration → Site Development → Open Commerce API Settings** | Check | Expected | | - | - | | **Data** API, context **Global** | The dedicated Global-e client with the resources from `metadata/ocapi-settings/wapi_data_config.json` — see [Configuration → Data API](/configuration-sfcc#data-api-mandatory-for-new-integrations) | | **Shop** API (headless / Commerce API only) | Your headless client with the resources from `metadata/ocapi-settings/wapi_shop_config.json` | | Account Manager API client | Assigned to the **Production** instance as well as Staging; enabled | ### Custom objects **Merchant Tools → Custom Objects** On Staging, confirm `GLOBALE_APP_SETTINGS`, `GLOBALE_COUNTRIES`, `GLOBALE_CURRENCIES`, `GLOBALE_CULTURES`, `GLOBALE_CURRENCY_RATES`, `GLOBALE_ROUNDING_RULES`, `GLOBALE_COUNTRY_COEFFICIENTS`, and `GLOBALE_HUB_DETAILS` hold records after a **GlobaleSettings** run — this proves the merchant account, GUID, and API base URL are correct. Do not rely on replicating these records to Production. Run **GlobaleSettings** on Production instead, so the data reflects the Production merchant account. The queue objects `GLOBALE_ORDER_NOTIFICATION`, `GLOBALE_INBOUND_ORDER_FALLBACK`, `GLOBALE_INVENTORY_NOTIFICATION`, `GLOBALE_COUPON_REDEMPTIONS`, and `GLOBALE_LOCAL_STORAGE` are created on Production during operation and must not be overwritten by Staging records. ## Replicate to Production 1. **Code replication first.** Replicate the code version that contains the Global-e cartridges and activate it on Production. If the cartridge path reaches Production before the cartridges do, storefront requests fail. 2. **Data replication second.** Include the tasks that cover the artifacts above: global metadata (system object types, custom object types), global preferences and OCAPI settings, sites (site preferences, cartridge paths, URL rules, payment and shipping methods), price books, promotions, and customer groups. 3. Follow Salesforce guidance during the run: no Business Manager edits on either instance, no jobs running on the target, one replication process at a time, and do not clear caches by hand immediately after — replication clears them as its last step. 4. Use the replication **Undo** only as an emergency rollback of the data step; it does not touch code. If your organization does not use data replication, perform every item in the [Staging checklist](#staging-checklist) directly on Production with the same import files. ## Production checklist Complete these on Production after replication. Everything here is either not replicated or is instance-specific. | Step | Where | Detail | | - | - | - | | Activate the code version | **Administration → Site Development → Code Deployment** | Global-e cartridges are inside the active version | | Verify cartridge paths | **Administration → Sites → Manage Sites** | Storefront site path and Business Manager path as on Staging. If wrong, fix on Staging and re-replicate | | Import services | **Administration → Operations → Import & Export** | Import `metadata/services.xml` in MERGE mode | | Create the Merchant GUID credential | **Administration → Operations → Services → Credentials** | `Globale-{geClientJsMerchantId}` with the **Production** Merchant GUID as password, URL empty. One credential per merchant account ID used on the instance | | Create SFTP credentials | Same screen | Only for feeds in scope (`Globale-SFTPCatalogFeedUpload`, `Globale-SFTPRestrictionsFeedUpload`, `Globale-SFTPDownload`) | | Check service settings | **Administration → Operations → Services** | All `Globale-*` services enabled, mock mode off, rate limit off on `GLOBALE-*` profiles, communication log on | | Import jobs | **Administration → Operations → Import & Export** | Import `metadata/jobs.xml`; assign flows to Production site IDs; keep every job **disabled** for now | | Configure custom logging | **Administration → Site Development → Development Setup → Custom Log Settings** | Add the `GLOBALE` category (at least **INFO** for launch week) so `GLOBALE_*` custom logs are written | | Verify site preferences | **Merchant Tools → Site Preferences → Custom Site Preference Groups** | Production values for `geApiUrl`, `geClientJsBaseUrl`, `geClientJsMerchantId`, `geCAPIType` and related groups; `geEnabled` still **No** | | Verify order preferences | **Merchant Tools → Site Preferences → Order** | Allow list, session filter **No**, Auto-Fail Orders set | | Verify payment and shipping | **Merchant Tools → Ordering** | Processor **GLOBALE** exists; method **GLOBALE** enabled; seven `GLOBALE*` shipping methods online with a valid Tax Class | | Verify URL rule | **Merchant Tools → SEO → URL Rules** | `globale/checkout/pspredirect` → `Globale-PaymentRedirect` | | Verify OCAPI settings | **Administration → Site Development → Open Commerce API Settings** | Data (and Shop, if headless) client JSON present; settings can take a few minutes to become effective | | Verify metadata | **Administration → Site Development** | `ge*` attributes and `GLOBALE_*` custom object types present | | Check edge security | eCDN / WAF / bot management | Server-to-server calls from Global-e to the `Globale-*` endpoints on your Production hostname must not be blocked by storefront password protection, IP allow lists, or bot rules. Ask **Global-e Merchant Support** for what you need to allow-list | | Share Production details with Global-e | Secure channel | Production storefront URL(s), OCAPI Data client ID and secret, OCAPI version — see [Configuration → Data API](/configuration-sfcc#data-api-mandatory-for-new-integrations) | ## Go-live Run these in order on Production: 1. **Run GlobaleSettings manually** and wait for it to finish with status **OK**. Check that `GLOBALE_APP_SETTINGS`, `GLOBALE_COUNTRIES`, `GLOBALE_CURRENCIES`, and the other configuration custom objects now contain records, and that the `GLOBALE` custom log and the job log show no errors. A failure here almost always means a wrong `geApiUrl`, `geClientJsMerchantId`, or Merchant GUID. 2. **Enable the GlobaleSettings schedule** — daily at an off-peak time (the shipped trigger is 02:00 UTC). Enable the other Global-e jobs only as their scope is confirmed: **GlobaleCatalogFeed**, **GlobaleOrderNotifications**, and **GlobaleOrderStatusFallback** (the last only once Global-e has enabled the SFTP feed for your account) — see [Jobs → Typical setup order](/jobs-sfcc#typical-setup-order). 3. **Set Global-e Enabled (`geEnabled`) to Yes** on each Global-e operated site. 4. **Invalidate the page cache** for each site (**Administration → Sites → Manage Sites → (Your Site) → Cache**) and the Business Manager site, so cached pages pick up Global-e pricing and the Client JS SDK. 5. **Smoke-test the storefront** (below) with **Global-e Merchant Support** on the call. ### Smoke test | Area | What to verify | | - | - | | Client JS SDK | Welcome pop-up / Country Switcher loads on a Production page and lists your operated countries | | Pricing | One **dynamic** country and one **fixed** country (if any) show the expected prices on PDP, PLP, and cart; one non-operated country is unaffected — see [Price calculation → Storefront Validation Checklist](/price-calculation-sfcc#storefront-validation-checklist) | | Checkout hand-off | Proceeding to checkout from an operated country opens Global-e checkout; `Globale-SendCartV2` shows a successful call in the service communication log | | Order creation | A test order creates an SFCC order with payment method **GLOBALE** and a `GLOBALE*` shipping method, and the order carries Global-e order attributes — see [Order lifecycle](/order-lifecycle-sfcc) | | Order updates | Status, dispatch, or refund updates arrive as expected (Global-e → SFCC via `Globale-OrderUpdateStatus`; SFCC → Global-e via **GlobaleOrderNotifications** if in scope) | | Domestic flow | Domestic shoppers still see native SFCC pricing and checkout | | Logs | No errors in the `GLOBALE` custom log or in service communication logs | If fixed-price countries show prices that look dynamically converted, see [Limitations → Storefront Request Cache](/limitations-sfcc#storefront-request-cache) before changing configuration. ## Rollback | Situation | Action | | - | - | | Global-e checkout or pricing misbehaves after go-live | Set **Global-e Enabled** (`geEnabled`) to **No** on the affected site and invalidate the page cache. Domestic checkout continues; operated-country shoppers stay on SFCC — see [Failover and recovery](/failover-sfcc#disable-global-e-integration-manual-failover) | | The new code version breaks the storefront | Re-activate the previous code version on Production. Remove Global-e cartridges from the cartridge path only if the previous code version does not contain them | | Data replication introduced wrong configuration | Use the replication **Undo** on the last process, or correct the value on Staging and re-replicate | Disabling `geEnabled` does not replay orders that were already in progress; orders paid on Global-e are still delivered through the fallback flow described in [Failover and recovery](/failover-sfcc). # Receiving Notification Copies Source: https://docs.global-e.com/receiving-notification-copies You can choose to receive a copy of customer-facing notifications about RMA status updates when they are sent to customers. > [!NOTE] > > This is only relevant for customer-facing email notifications. ## To receive notification BCC copies of notifications: 1. Navigate to *Settings > Emails > Notifications*. 2. In the **Get a Notification Copy** section, enter a destination email address. 3. Toggle which RMA status updates you would like to receive copies of. 4. Click the save icon to save your changes. > [!NOTE] > > By default, you do not receive copies of customer-facing notification emails. However, you can enable an option to receive them as BCCs if needed. # Receiving Notification Copies Source: https://docs.global-e.com/receiving-notification-copies-701361 You can choose to receive a copy of customer-facing notifications about RMA status updates when they are sent to customers. > [!NOTE] > > This is only relevant for customer-facing email notifications. ## To receive notification BCC copies of notifications: 1. Navigate to *Settings > Emails > Notifications*. 2. In the **Get a Notification Copy** section, enter a destination email address. 3. Toggle which RMA status updates you would like to receive copies of. 4. Click the save icon to save your changes. > [!NOTE] > > By default, you do not receive copies of customer-facing notification emails. However, you can enable an option to receive them as BCCs if needed. # Reconciliation Source: https://docs.global-e.com/reconciliation ## General Principles * Reconciliation is performed per parcel * Each parcel is assigned to a Global-e entity based on its origin hub ## Key Behaviors * A single Global-e order ID may appear in multiple reconciliation reports * Reports are generated based on hub, not entity ## Virtual Products * Virtual products are grouped into a dedicated virtual parcel * Payments are included in the next reconciliation cycle after an order is received ## B2B VAT (Local VAT) * If merchant VAT configuration is 0% → VAT = 0 * If the destination country and hub country are both in the EU, are not the same country, and the shipment ships with a non-Global-e carrier → VAT = 0 * Canada → Based on hub province * Otherwise based on HS Code or hub country default rate ## Reconciliation Eligibility Orders are only eligible for reconciliation when all products are assigned to parcels. Changing order status alone is insufficient. ## Shipping Costs * Shipping costs are reconciled with the entity of the parcel’s products * The shopper-paid shipping cost is attributed to the first parcel ## Returns Return shipping costs and prepaid return costs are assigned to the entity of the first returned product’s parcel. ## Refunds * Refunds for products are added to the same reconciliation report as the parcel from which the product was fulfilled * Duties and taxes refunds are prorated across relevant entities and apply only to products where D\&T was paid * Shipping refunds are assigned to the entity of the first parcel * Service gesture refunds are assigned to one of the order’s entities ## Additional Notes * One refund transaction may impact multiple reconciliation reports * D\&T refund mechanisms follow standard handling rules # Reconciliation Report Source: https://docs.global-e.com/reconciliation-report-au Below is a sample Reconciliation Report with a breakdown of the services and fees for that week. To understand the reconciliation report when you use your own carriers, [click here.](/aus-merchants-with-non-global-e-carriers) For a list of all the report fields and their definitions, see [Reconciliation Report](/reconciliation-report-overview). For a video describing the Reconciliation Report, see [Video Overviews: Financial Flow & Weekly Reconciliation Report](/video-overviews-financial-flow-au). | | Amount GST | GST | Amount Inc GST | | | - | - | - | - | - | | Sales Total | \$23528.85 | \$2352.89 | \$25881.74 | [Sales Example](/reconciliation-report-au#sales-total) | | Refunds Total | (\$2106.68) | (\$210.67) | (\$2317.35) | [Refunds Example](/reconciliation-report-au#refunds-total) | | **Amount to Invoice** | **\$21422.17** | **\$2142.22** | **\$23564.39** | | | Service Fee | \$1724.12 | \$172.41 | \$1896.53 | 7.0% of Sales Total | | Service Fee Adjustment | \$0.00 | £0.00 | \$0.00 | | | Shipping Subsidies | \$3649.75 | \$364.98 | \$4014.73 | [Shipping Example](/reconciliation-report-au#shipping-subsidies) | | Taxes Subsidization | \$1114.45 | \$0.00 | \$1114.45 | | | Handling Fee | \$140.00 | \$14.00 | \$154.00 | | | Returns | \$14.97 | \$1.50 | \$16.47 | [Returns Example](/reconciliation-report-au#returns) | | **Services and Fees** | **\$6643.29** | **\$552.89** | **\$7196.18** | | ## Sales Total **Order Level** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8055631c-6784-9694-1a46-6b4b5deb1277.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=e58d8b152c0d96f013517d7b2eee241d) *Sales Total on the Order Level* **Product Level** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-45681d01-bd95-88f8-8a91-a4015eb83f8a.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=1be61bd8b24d7f88a06be1b3d18e8169) *Sales total on the Product Level* ## Refunds Total ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8e3f4862-8bdd-de90-b8c3-889781e2033e.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=5b25f3000ba3d6255d9acd2807bf922e) *Lists all the refunds that were issued through Global‑e during the relevant period.* ## Shipping Subsidies Shipping prices are based on the actual weight that we received from the shipper or measured at our hub. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4d2681d9-bced-ae9f-66d1-9de10cf606f7.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=acc2911aab96eacdd5a41be998d8ad6d) *shipping costs are reconciled based on the date of the shipment.* ## Returns ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-dbd30617-2b13-e2e3-3364-73e6835dc0f1.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=2915affa7d985a178cb7a69643851f1a) *Includes the details of each returned parcel.* # Reconciliation Report Source: https://docs.global-e.com/reconciliation-report-eu Below is a sample Reconciliation Report with a breakdown of the services and fees for that week. To understand the reconciliation report when you use your own carriers, [click here](/eur-merchants-with-non-global-e-carriers). For a list of all the report fields and their definitions, see [Reconciliation Report](/reconciliation-report-overview). | | Amount Excl. VAT | VAT | Amount Incl. VAT | | | - | - | - | - | - | | Sales Total | €17108.55 | €3592.80 | €20701.35 | [Sales Example](/reconciliation-report-eu#sales-total) | | Refunds Total | (€625.40) | (€131.33) | (€756.73) | [Refunds Example](/reconciliation-report-eu#refunds-total) | | **Amount to Invoice** | **€16483.15** | **£€3461.47** | **€19944.62** | | | Service Fee | €1323.39 | €277.91 | €1601.30 | 7% of Total Order Value | | Shipping Subsidies (EU) | €1171.25 | €245.96 | €1417.21 | [Shipping Example](/reconciliation-report-eu#shipping-subsidies) | | Shipping Subsidies (Non-EU) | €1215.29 | €0.00 | €1215.29 | | | Taxes Subsidization | €132.30 | £0.00 | €132.30 | | | Handling Fee | €76.50 | €16.07 | €92.57 | | | Returns | €4.00 | €0.84 | €4.84 | [Returns Example](/reconciliation-report-eu#returns) | | **Services and Fees** | **€3922.73** | **€540.78** | **€4463.51** | | ## Sales Total **Order Level** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8055631c-6784-9694-1a46-6b4b5deb1277.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=e58d8b152c0d96f013517d7b2eee241d) *Sales Total on the Order Level* **Product Level** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-45681d01-bd95-88f8-8a91-a4015eb83f8a.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=1be61bd8b24d7f88a06be1b3d18e8169) *Sales total on the Product Level* ## Refunds Total ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8e3f4862-8bdd-de90-b8c3-889781e2033e.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=5b25f3000ba3d6255d9acd2807bf922e) *Lists all the refunds that were issued through Global‑e during the relevant period* ## Shipping Subsidies Shipping prices are based on the actual weight that we received from the shipper or measured at our hub. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4d2681d9-bced-ae9f-66d1-9de10cf606f7.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=acc2911aab96eacdd5a41be998d8ad6d) *shipping costs are reconciled based on the date of the shipment* ## Returns **Returns** ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-dbd30617-2b13-e2e3-3364-73e6835dc0f1.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=2915affa7d985a178cb7a69643851f1a) *Includes the details of each returned parcel* # Reconciliation Report Source: https://docs.global-e.com/reconciliation-report-overview The **Reconciliation Report** is a structured financial data file provided by Global-e to merchants. It offers comprehensive details of all your sales. The report is generated automatically once a week and the Global-e Finance team is available for any questions regarding the files or data. The report is delivered once a week to the registered **Distribution List (DL)**. Starting in 2026, an updated layout of the report was introduced. This documentation covers both the original and the updated layouts. To receive the updated report layout instead of the original layout, please contact your CSM. The Reconciliation Report includes the following sections, which you can view by selecting the relevant tab: * [Summary](/reconciliation-report-overview#summary) * [Products and Orders](/reconciliation-report-overview#products-and-orders) * [Shipping per Parcel](/reconciliation-report-overview#shipping-per-parcel) * [Refunds and Refund Components](/reconciliation-report-overview#refunds-and-refund-components) * [Returns](/reconciliation-report-overview#returns) * [Service Fee](/reconciliation-report-overview#service-fee) * [Gift Cards](/reconciliation-report-overview#gift-cards) > [!NOTE] > > * The Reconciliation Report is presented in your local currency, and all information is aligned with your country’s specific rules and regulations. > * Orders are included in the reconciliation according to their **Received in Hub date**, while refunds are included based on their **Creation date**. > * Verify that you review the status of your orders on a regular basis, to ensure that all orders dispatched have progressed to **Received In Hub**. Orders not received in the hub may delay payment of said orders. > * For guidance regarding the current status of any order, or to progress orders dispatched which have not yet progressed to **Received In Hub**, contact your CSM. For more information, see the [original layout](https://www.youtube.com/watch?v=ZCClXC6xBEc\&embeds_referring_euri=https%3A%2F%2Fdocs.global-e.com%2F\&source_ve_path=OTY3MTQ) video. For more information about the Reconciliation process, see [The Reconciliation Process (Finance)](/financial-processes#the-reconciliation-process--finance-). ## Summary This section is an overview of all the fields displayed in the Summary tab. It describes both the original and updated layouts, and includes important details of each. **Original Layout** The following image shows the original layout: ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9a481e3b-11fa-580d-fb24-10732ab68258.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=e5b042aae16828e38ed2156fc5e79197) | Section | Field Name | Description | | - | - | - | | Invoice | Sales Total | Total of all sales from the period. | | Invoice | Refunds Total | Refunds processed during the period. | | Invoice | Amount to Invoice | The total of all sales from the period, including discounts (Sales Total), minus the refunds processed during the period (Refunds Total). | | Services and Fees | Service Fee | A fee based on the percentage per contract. | | Services and Fees | Base for Reconciliation Fee | A calculation based on the Total Order Value paid by the customer | | Services and Fees | Reconciliation Fee Percentage | The fee percentage noted in the contract. | | Services and Fees | Reconciliation Fee | Percentage per contract of the base for Reconciliation Fee noted above | | Services and Fees | Shipping Subsidies | The difference between the total cost of shipping and the fixed price paid by the customer. This is also according to your configuration. | | Services and Fees | Taxes Recoup | Duties & Taxes that you have chosen to subsidise for the client. | | Services and Fees | Handling Fee | The handling fees for each order which are processed through the Global-e Merchant hub. | | Services and Fees | Minimum Service Fee Completion | Refers to the monthly minimum amount defined in the contract. At the end of each month, if the total service fee and reconciliation fee collected do not reach the contractual minimum, we charge the merchant the difference to complete the minimum fee. The amount is calculated as: the contractual minimum fee minus the service fee for the month, minus the reconciliation fee for the month. The breakdown will appear at the bottom of the Summary Tab. | | Services and Fees | Returns | The shipping cost for each return shipped back during the period. | | Services and Fees | Amount Paid in Gift Cards | Total amount of all orders paid by Gift Card upon purchase. | | Minimum Service Fee Completion | Minimum Fee Amount | Refers to the monthly minimum amount defined in the contract. | | Minimum Service Fee Completion | Service Fee Charged | Total Service Fee charged over the course of the calendar month. | | Minimum Service Fee Completion | Reconciliation Fee Charged | Total Reconciliation Fee charged over the course of the calendar month. | **Updated Layout** The following figure shows the updated layout: ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d193a1d7-90b1-f589-7098-d0042ff6d1a8.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=2337afaa94b9f66069937581cc443ab1) | Section | Field Name | Description | | - | - | - | | Date | Date Period | The report period is always from the initial date up to midnight of the cutoff date (UTC). For example, a report for the 01.01.2025-08.01.2025 includes all orders from the 1st up to and including the 7th; the final date is just the cutoff. | | Net Sales | Total Product Price Before Refunds | Total product for orders marked received in hub (dispatch date when orders are shipped direct; date received in Global-e's hub when shipped via Global-e hub) during the period. | | Refunds | Total Refunds | Total of refunds and adjustments issued against the account within the period. | | Fees | Service Fee | The amount paid for Global-e's Service Fee according to your contract (noted as Platform Fee in the contract). | | Fees | Reconciliation Fee | The amount paid for Global-e's Reconciliation Fee according to your contract. | | Fees | Service Fee Adjustment | Adjustment of Service and Reconciliation Fees upon purchase of a product using a gift card which was itself purchased through Global-e. | | Fees | Minimum Fee Completion | “Minimum fee completion” refers to the monthly minimum amount defined in the contract. At the end of each month, if the total service fee and reconciliation fee collected do not reach the contractual minimum, we charge the merchant the difference to complete the minimum fee. The amount is calculated as: the contractual minimum fee minus the service fee for the month, minus the reconciliation fee for the month. The breakdown will appear at the bottom of the Summary Tab. | | Fees | Total Fees | Total of the above fees, including Service Fee, Reconciliation Fee, Service Fee Adjustment, Minimum Fee Completion and Borderfree.com Affiliation, as applicable. | | Gift Cards | Total Amount Paid In Gift Cards | Total amount of all orders paid by Gift Card upon purchase. | | Transactional Costs | Shipping Charges To Merchant | Includes (for breakdown of the below, see Shipping Per Parcel tab for 1 and 2, see Returns tab for 3): | | Transactional Costs | Shipping Charges To Merchant | **Shipping Charges to Merchant**: the difference between the shipping fee paid by the Customer on the outbound sale and the actual cost of outbound shipping. **Handling Fee**: the crossdock fee for orders shipped via Global-e hubs. **Return Shipping costs**: the difference between the shipping fee paid by the Customer for the return of goods and the actual cost of shipping for the inbound return. | | Transactional Costs | D\&Ts Charges To Merchant | Deduction of Duties & Taxes built into the product price as part of the business proposition - refer to models: Hidden Forced DDP and Partial Forced DDP. | | Transactional Costs | Total Transactional Costs | Total of Shipping Charges To Merchant and D\&Ts Charges To Merchant | | Margin | **Estimated Additional Margin From International Pricing** (Included In The Product Price) | **Dynamic Pricing** - Margin built into the product price usually to cover the estimated average duties and taxes and/or shipping costs per destination country/product category. **Fixed Pricing** - For orders that include countries or products set as Fixed Price, the estimated margin amount is calculated based on a virtual coefficient rate defined per country. | | Margin | Total Transactional Costs with margin deduction | Total value of Total Transactional Costs less Estimated Additional Margin From International Pricing | | Invoicing Totals | Merchant Invoice (Net Sales Less Refunds) | Total amount to be invoiced for sales and refunds either by the merchant or on their behalf by Global-e (Self-Billing Invoicing). | | Invoicing Totals | Global-e Invoice (Fees, Gift Cards And Transactional Costs) | Total amount to be invoiced by Global-e for Total Fees, Total Transactional Costs and Total Gift Cards. | | Invoicing Totals | Net Amount Due | The final amount due after deducting the Global-e Invoice from the Merchant invoice. | | Minimum Service Fee Completion | Minimum Fee Amount | Refers to the monthly minimum amount defined in the contract. | | Minimum Service Fee Completion | Service Fee Charged (for 01/**/20** - 01/**/20**) | Total Service Fee charged over the course of the calendar month. | | Minimum Service Fee Completion | Reconciliation Fee Charged (for 01/**/20** - 01/**/20**) | Total Reconciliation Fee charged over the course of the calendar month. | | Minimum Service Fee Completion | Total Minimum Fee Completion | Refers to the final fee due after deducting Service Fee and Reconciliation Fee Charged from the Minimum Fee Amount. | ## Products and Orders This section provides an overview of all the fields displayed in the **Products** and **Orders** tabs: The following figure shows the **Products** tab layout: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-275bfc65-9a35-f1e5-0681-1739f72d9702.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=8421fde7bae5ef66851cb0509259dae7) The following figure shows the **Orders** tab layout: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-311d476d-27e1-cd84-d241-a9607ea3f117.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=bf9e9f249e2673c6e1e9486dcb925cb8) | # | Field Name | Description | | - | - | - | | 1 | GE Order# | This is a unique Global-e ID which is created for each order in the our system - for example, GE7733229GB | | 2 | Date Created | The date on which the order is created in Global-e's system. | | 3 | Date Received In Hub | This date can have two meanings. If you are you shipping through Global-e's hub, this will be the day the order is scanned into our hub. If you are shipping directly to the end customer, this will be the same as the date of shipment. | | 4 | Merchant Order# | Your ID number for the order, normally taken from your platform. | | 5 | Destination Country | The destination country to which the order was shipped. | | 6 | EU / Non EU | For “EU” merchants: This flag is to indicate whether the destination country is in the EU. For “NON-EU” merchants: not applicable | | 7 | Delivery Method | The shipping method selected by the customer at checkout. | | 8 | Product, SKU, Product Reference and Quantity | These columns contain all of the identification numbers, descriptions, and also quantities of each product. | | 9 | Gross Item Price/Gross Item Price Ex VAT | The price of each product excluding merchant VAT and before the deduction of discounts. | | 10 | Total Product Discount | The discount value against each product or order excluding merchant VAT. | | 11 | Net Item Price/Net Item Price Ex VAT | The price of each product or total of the order excluding merchant VAT and after the deduction of discounts. | | 12 | VAT % (Merchant) | The percentage of VAT which applies on the product price or order total. | | 13 | VAT Amount (Merchant) | The VAT amount which applies on the product price or order total. | | 14 | Net Item Price Incl VAT | The product price or order total, including merchant VAT. | | 15 | Extra Margin Amount | Will appear only in the “orders” tab.**Dynamic Pricing** - Margin built into the product price usually to cover the estimated average duties and taxes and/or shipping costs per destination country/product category.**Fixed Pricing** - For orders that include countries or products set as Fixed Price, the estimated margin amount is calculated based on a virtual coefficient rate defined per country. | ## Shipping per Parcel The following figure shows the **ShippingPerParcel** table: ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5af36de3-c1d4-f240-cff9-5fe1203f754b.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=b79e7a2e65706135ac2eba1cac6a9883) This section provides an overview of all the fields displayed in the ShippingPerParcel tab. | # | Field Name | Description | | - | - | - | | 1 | GE Order# | GE Order# This is a unique Global-e ID which is created for each order in the our system - for example, GE7733229GB | | 2 | Parcel Codes | An unique identifier for each parcel - it is possible that there will be more than one parcel per order. | | 3 | Date Created | Date Created The date on which the order is created in Global-e's system. | | 4 | Date Received In Hub | This date can have two meanings. If you are you shipping through Global-e's hub, this will be the day the order is scanned into our hub. If you are shipping directly to the end customer, this will be the same as the date of shipment. | | 5 | Merchant Order# | Merchant Order# Your ID number for the order, normally taken from your platform. | | 6 | Destination Country | Destination Country The destination country to which the order was shipped. | | 7 | EU / Non EU | For “EU” merchants: This flag is to indicate whether the destination country is in the EU. For “NON-EU” merchants: not applicable | | 8 | Delivery Method | Delivery Method The shipping method selected by the customer at checkout. | | 9 | Is Replacement Order | Is Replacement Order Is this parcel for a replacement order, yes or no. | | 10 | Tracking Number | Tracking Number Tracking number for each parcel. | | 11 | Count Parcels | Count Parcels The number of parcels attributed to a single line. | | 12 | Weight Kg | Weight Kg The total weight of the parcels attributed to this line. | | 13 | Shipping Paid By Customer | The shipping cost paid by the customer - a fixed rate according to configuration. | | 14 | Shipping Cost | Total actual shipping cost | | 15 | Shipping Subsidies/ Shipping Subsidies -Excl VAT | Subsidisation of shipping cost - the difference between the amount paid by customer and the total shipping cost. | | 16 | Shipping Subsidies - VAT | The VAT of the subsidisation, set according to merchant VAT settings. | | 17 | Shipping Subsidies - Inc VAT | Subsidisation of shipping cost, including VAT. | | 18 | Total Duties and Taxes | Total duties & taxes related to all parcels included in each line. | | 19 | Taxes Recoup/Taxes Subsidization | Subsidisation of duties & taxes, if you have chosen to subsidise duties & taxes, either fully or partially. | | 20 | Duties Paid By Customer | Portion of duties and taxes paid by customer separately to product and shipping. | | 21 | Handling Fee | Handling Fee These are the handling fees for each order which is processed through Global-e's hub. | ## Refunds and Refund Components The following figure shows the **RefundsComponents** table: ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-79c676f1-3cfb-aaed-b54c-4d9841a252dc.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=65161508fef956884cf96b12197d7726) This section provides an overview of all the fields displayed in the **Refunds and RefundsComponents** tabs. | # | Field Name | Description | | - | - | - | | 1 | Refund Id | This is a unique Global-e ID which is created for each refund or adjustment in the our system. | | 2 | Refund Date Created | Creation date of the refund or adjustment in Global-e's system. | | 3 | GE Order# | This is a unique Global-e ID which is created for each order in the our system - for example, GE7733229GB | | 4 | Order Date Created | The date on which the order is created in Global-e's system. | | 5 | Merchant Order# | Your ID number for the order, normally taken from your platform. | | 6 | Destination Country | The destination country to which the order was shipped. | | 7 | EU / Non EU | For “EU” merchants: This flag is to indicate whether the destination country is in the EU. For “NON-EU” merchants: not applicable | | 8 | Refund Reason | The reason selected when the refund or adjustment was created in Global-e's system. | | 9 | Refund Status | The status of the refund or adjustment - for example, completed or manual. | | 10 | Refund Products | All products included in the refund or adjustment. | | 11 | Refund Components, SKU & Product Reference | Refund Components, SKU and Product Reference of products reimbursed or adjusted by line. | | 12 | Refund Quantity | Refund Quantity of each product refunded or included in the adjustment. | | 13 | Refund Notes | Notes added when the refund or adjustment was created in Global-e's system. | | 14 | Refund Amount/ Refund Amount Ex VAT | Total of the refund or adjustment, excluding VAT. | | 15 | VAT | VAT relevant for the refund or adjustment. | | 16 | Refund Amount Incl VAT | Total of the refund or adjustment, including VAT. | ## Returns The following figure shows the **Returns** table: ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-462f5134-869d-c3a0-46da-274e918532ec.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=a254053e4bc697140614b9f660d66177) This section provides an overview of all the fields displayed in the **Returns** tab. | # | Field Name | Description | | - | - | - | | 1 | GE Order# | This is a unique Global-e ID which is created for each order in the our system - for example, GE7733229GB | | 2 | Date Created | The date on which the order is created in Global-e's system. | | 3 | RMA Number | Unique ID number created for each return label - RMA. | | 4 | Tracking Number | Tracking number for each parcel. | | 5 | Merchant Order# | Your ID number for the order, normally taken from your platform. | | 6 | Destination Country | The destination country to which the order was shipped. | | 7 | Shipping Method | Delivery method used for the return shipment. | | 8 | Return Weight (gr) | Actual weight of the return in kilos. | | 9 | Customer Payment Merchant Currency | Return shipping costs paid by customer - a fixed rate according to configuration. | | 10 | Total Return Cost Merchant Currency/ Total Return Cost Merchant Currency excl. VAT | The total return costs, excluding VAT. | | 11 | Total Merchant Cost Merchant Currency/ Total Merchant Cost Merchant Currency excl VAT | This is the difference between the amount paid by customer and the total actual return cost. | | 12 | Total Merchant Cost - VAT | VAT relevant to the return subsidy. | | 13 | Total Merchant Cost Merchant Currency incl VAT | The total cost to merchant, including VAT. | ## Service Fee This section provides an overview of all the fields displayed in the **Service Fee** tab, according to your contract. | # | Field Name | Description | | - | - | - | | 1 | Product Paid by Customer | Total product paid by customers at checkout | | 2 | Shipping Paid by Customer | Total of the shipping paid by customers at checkout | | 3 | D\&T Paid by Customer | Total of all duties and taxes paid separately from the product and shipping amounts at checkout | | 4 | Total Order Value | Total of the previous three fields, being the total order value paid at checkout including product and shipping, as well as duties and taxes | | 5 | Base for Service Fee | The base for the service fee, being the total order value listed under the Total Order Value field | | 6 | Service Fee Percentage | Service fee percentage as agreed in the merchant's contract | | 7 | Service Fee | A percentage of the total order value paid by customers, calculated as Total Order Value \* Service Fee Percentage | | 8 | Base for Reconciliation Fee | The base for the reconciliation fee, being the total order value listed under the Total Order Value field | | 9 | Reconciliation Fee Percentage | Reconciliation fee percentage as agreed in the merchant's contract | | 10 | Reconciliation Fee | A percentage of the total order value paid by customers, calculated as Total Order Value \* Reconciliation Fee Percentage | ## Gift Cards The following figure shows the **Gift Cards** table: ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-55c9f9f9-9c36-38b7-cb45-b68389bcb722.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=71e758e2d911ca0a46d06c7bce82ee14) This section provides an overview of all the fields displayed in the **GiftCards** tab. | # | Field Name | Description | | - | - | - | | 1 | GE Order# | This is a unique Global-e ID which is created for each order in Global-e system - for example, GE7733229GB | | 2 | Date Created | The date on which the order is created in Global-e's system. | | 3 | Date Received In Hub | This date can have two meanings. If you are you shipping through Global-e's hub, this will be the day the order is scanned into our hub. If you are shipping directly to the end customer, this will be the same as the date of shipment. | | 4 | Merchant Order# | Your ID number for the order, normally taken from your platform. | | 5 | Destination Country | The destination country to which the order was shipped. | | 6 | EU / Non EU | For “EU” merchants: This flag is to indicate whether the destination country is in the EU. For “NON-EU” merchants: not applicable. | | 7 | Delivery Method | The shipping method selected by the customer at checkout. | | 8 | Gift Card Used Value | Total portion of the order value paid by gift card at checkout. | # Reconciliation Report Source: https://docs.global-e.com/reconciliation-report-uk Below is a sample Reconciliation Report with a breakdown of the services and fees for that week. To understand the reconciliation report when you use your own carriers, [click here](/uk-merchants-with-non-global-e-carriers). For a list of all the report fields and their definitions, see [Reconciliation Report](/reconciliation-report-overview). For a video describing the Reconciliation Report, see [Video Overviews: Financial Flow & Weekly Reconciliation Report](/video-overviews-financial-flow-uk). ## Sales Total **Order Level** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8055631c-6784-9694-1a46-6b4b5deb1277.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=e58d8b152c0d96f013517d7b2eee241d) *Sales Total on the Order Level* **Product Level** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-45681d01-bd95-88f8-8a91-a4015eb83f8a.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=1be61bd8b24d7f88a06be1b3d18e8169) *Sales total on the Product Level* ## Refunds Total ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8e3f4862-8bdd-de90-b8c3-889781e2033e.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=5b25f3000ba3d6255d9acd2807bf922e) *Lists all the refunds that were issued through Global‑e during the relevant period* ## Shipping Subsidies Shipping prices are based on the actual weight that we received from the shipper or measured at our hub. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4d2681d9-bced-ae9f-66d1-9de10cf606f7.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=acc2911aab96eacdd5a41be998d8ad6d) *shipping costs are reconciled based on the date of the shipment* ## Returns ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-dbd30617-2b13-e2e3-3364-73e6835dc0f1.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=2915affa7d985a178cb7a69643851f1a) *Includes the details of each returned parcel* # Reconciliation Report Source: https://docs.global-e.com/reconciliation-report-us Below is a sample Reconciliation Report with a breakdown of the services and fees for that week. To understand the reconciliation report when you use your own carriers, [click here](/us-merchants-with-non-global-e-carriers). For a list of all the report fields and their definitions, see [Reconciliation Report](/reconciliation-report-overview). For a video describing the Reconciliation Report, see [Video Overviews: Financial Flow & Weekly Reconciliation Report](/video-overviews-financial-flow-us). | | Amount Exc. VAT | | | - | - | - | | Sales Total | \$54993.70 | [Sales Example](/reconciliation-report-us#sales-total) | | Refunds Total | (\$12581.17) | [Refunds Example](/reconciliation-report-us#refunds-total) | | **Amount to Invoice** | **\$42412.53** | | | Service Fee | \$4731.35 | 7.0% of Total Order Value | | Payment Processing Fee | \$0.00 | | | Service Fee Adjustment | \$0.00 | | | Shipping Subsidies | \$2776.66 | [Shipping Example](/reconciliation-report-us#shipping-subsidies) | | Taxes Subsidization | \$152.07 | | | Handling Fee | \$0.00 | | | Returns | (\$6.26) | [Returns Example](/reconciliation-report-us#returns) | | **Services and Fees** | **\$7653.82** | | ## Sales Total **Order Level** ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-17297204-72cc-056b-0040-c5cd251bbbf0.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=3028ed8e3e69f412eed1a73397a0533f) Sales Total on the Order Level **Product Level** ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-be4d2367-4d4c-3604-2aaf-d50bfaad19c0.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=6f7607c811a1741fd66561ba9f101afd) Sales total on the Product Level ## Refunds Total ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fc889469-1152-7767-a357-c0ba9a069dc6.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=c1273b0769998e79de3cca7fb429a008) Lists all the refunds issued through Global‑e during the relevant period. ## Shipping Subsidies Shipping prices are based on the weight that we receive from the shipper or measurements calculated at our hub. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4d2681d9-bced-ae9f-66d1-9de10cf606f7.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=acc2911aab96eacdd5a41be998d8ad6d) shipping costs are reconciled based on the date of the shipment. ## Returns ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-13739a24-b609-822b-46e6-b15754cb7f66.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=071f7bc393f7d3ddbf9830eb9d222dd9) Includes the details of each returned parcel. # Refunds Notifications (Global-e to Merchant) Source: https://docs.global-e.com/refunds-notifications--from-global-e- The NotifyOrderRefund API notifies the merchant about Global-e initiated refund issued to the end customer. The NotifyOrderRefund method notifies the merchant about Global-e initiated refunds issued to the shopper. If implemented on the merchant's site, the Global-e servers post the information about customer refunds, in cases where such refunds are initiated on the Global-e side. > [card] [Notify order refund](/api-reference/notify-order-refund) > > POST /order-refund-url # Refunds Source: https://docs.global-e.com/refunds-orders > [!NOTE] > > **For details about refunding an order in Shopify, refer to the Shopify Native [Refund](/global-e-orders-in-shopify#refund) section.** ## Overview Users with Merchant CS Admin permissions can create refunds. > [!WARNING] > > Use the Refunds feature for orders that have already been dispatched to the customer. > > To cancel a settlement or a refund of stock items, amend the order before the order can be processed on the Global-e Merchant Portal and shipped to the customer. See [Amending Order Products](/managing-orders#amending-order-products). Global‑e monitors and rectifies all refunds that failed or are in pending status. ## Issuing a Refund **To refund an order:** 1. From the Global‑e Merchant Admin, navigate to **Orders** **> View Orders**. 2. Find the relevant order (enter the order information and click **Find and View**) and open it. 3. Make sure the order is in Dispatched Status. 4. On the Order Details screen, click the **Refunds** tab. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c7da389c-d732-f1db-e688-4fd7f0b67b0c.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=044bf9439351e9a2e9fbf3c276d4cfc5) 5. Click **Add Refund**. The Refunds screen opens. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-86384b15-ea18-b83c-5b1e-9e4f97359e9b.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=91ede5c663f3c901458eeea906f2f09f) The following information is displayed: | Field | Description | | - | - | | Order Total | The total amount that the customer paid for the order | | Paid Total | The amount of the order that was paid | | Loyalty Points Total | The value of the loyalty credit used to pay for the order, in the customer's currency | | Available amount to refund | The amount that can be refunded. If previous refunds were performed for that order, the amount to be refunded will be lower than the order total. | | Total Shipping Price | The total shipping price paid by the customer | | Duties & Taxes | The duties paid by the customer | | CCF | The customs clearance fees paid by the customer | 6. Select the type of refund: Full Refund or Partial Refund. 7. Click **Approve Refund**. ## Full Refund If you select Full Refund, all the fields in the Refunds screen are automatically populated. ## Partial Refund To perform a Partial Refund, enter the following information. | Field | Steps | | - | - | | Products Refund | Create a refund for products: in the products list, select the Refunded Qty and the Refund Reason. The Products Refund field is populated according to the chosen quantities. | | Shipping Refund | To create a full or partial refund for shipping, enter the amount in this field. | | Service Gesture | Use this field to refund customers amounts that are not associated with products, shipping fees, or duties & taxes. | | Duties and Taxes + CCF | To refund duties & taxes, enter the amount in the Duties & Taxes + CCF field. Generally, customs authorities do not refund duties and taxes that have been paid. Refunding these fees to customers is at the merchant’s sole discretion and expense. | | Refund Components total | This field calculates automatically and shows all refund components listed above. | | Prepaid Shipping | To deduct the cost of prepaid return shipping, enter the amount here. The refund cost shown to the customer on the Returns Portal is also listed under Return Requests: Merchant Portal **> Orders > Returns**. | | Loyalty Points Refund | | | Money Refund | | | Total Refund | This field shows the total refund amount to be transferred to the customer’s original payment method | | Refund Reason | Use this drop-down to define the reason for the refund | | Notes | Enter refund note if applicable | # Refunds Source: https://docs.global-e.com/refunds-via-api Process customer refunds through Global-e — full or partial, products, shipping, Duties & Taxes, service gestures, and return-shipping deductions — via the CreateOrderRefund API. ## Overview The Refund API lets you refund customers through Global-e and entails the following refund use cases: * Full order * Full product * Partial product * Shipping * Duties & Taxes * Service gestures and appeasements * Deduction of return shipping * Any combination of the above Depending on the use case, refunds can be requested in either merchant or customer currency values, eg. products have a valuation in both currencies when service gestures or duties do not. Customer currency amounts are overall preferred for implementation and allow coverage of all use cases. ## Prerequisites The following system attributes are required: * Global‑e order number (not the ecommerce platform order ID) * Product `cartItemId` or `SKU` as specified in the cart shared between Global‑e and the ecommerce platform > [card] [Create Order Refund — reference & playground](/api-reference/create-order-refund) > > The `orderRefund` query parameter, the `refundProductsList` request body (`RefundProduct` fields), the `OrderRefundInfo` response (with `Merchant.OrderRefund` notification details), the `ErrorInfo` / `ResponseInfo` error shapes, examples, and the interactive playground for `POST /Order/CreateOrderRefund`. ## Request CreateOrderRefund is a **mixed request**: * **`orderRefund`** — the order-level refund details, passed as a **URL-encoded, JSON-serialized object in the query string** (`?orderRefund={…}`), **not** in the body. Its fields are listed below. * **`refundProductsList`** — the products to refund, sent as the **JSON request body** (an array of `RefundProduct`; its fields render on the [reference page](/api-reference/create-order-refund)). Provide an empty array (`[]`) for full-order and component-only refunds. Only `orderRefund.OrderId` is required. ### `orderRefund` object (`OrderRefundDetails`) | Field | Type | Description | | - | - | - | | `OrderId` | string | Global-e Order id | | `FullRefund` | boolean | The refund of the entire order (product, shipping, and taxes). | | `TotalRefundAmount` | string | The total amount of the order level refund (product and components) in customer currency (taken from the SendOrderToMerchant (Global-e to Merchant) values). | | `OriginalTotalRefundAmount` | string | The total amount of the order level refund (product and components) in merchant currency (taken from the SendOrderToMerchant (Global-e to Merchant) values). | | `ProductsDutiesRefund` | boolean | For products to be refunded also refunds the associated duties to the customer (auto-calculated, thus incompatible with DutiesAmount, TotalRefundAmount or OriginalTotalRefundAmount). | | `ShippingRefund` | boolean | The customer paid refund shipping on the initial order | | `RefundReason` | object | Add the reason for the refund of the order level (for logging on to the Global-e side). Requires mapping on the Global-e side. If the RefundReason is not provided, the refund email will be in a generic format, and will not include the product details and image. Fields: `OrderRefundReasonCode`, `Name`. | | `ServiceGestureAmount` | string | This amount denotes the additional funds to be refunded to the customer on top of the other components in customer currency. | | `ShippingAmount` | string | This amount denotes the funds to be refunded for shipping costs in customer currency. | | `DutiesAmount` | string | This amount denotes funds to be refunded for Duties, Taxes, and CCF costs in customer currency. | | `RefundComments` | string | Add comments about the refund. | | `externalReference` | string | Optional. If the externalReference is provided upon successful refund creation, it will be saved in the OrderRefunds table and included in the Refunds Components report. Max length: 255. | | `ProviderCode` | string | Identifies the return provider that initiated the refund (for example, RGO for ReturnGO). Note: When a recognized provider code is supplied, Global-e sends a refund notification to the merchant. See the introduction for details. | | `CustomerPrepaidRefundAmount` | string | The amount deducted from the refund, in the customer's currency. | | `OriginalCustomerPrepaidRefundAmount` | string | The amount deducted from the refund, in the original/merchant's currency. | ## Full Refunds and Total Amount Logic ``` CreateOrderRefund (OrderRefundDetails orderRefund, List refundProductsList) ``` Issues refund for the order specified in `orderRefund` argument. Optionally may include the list of RefundProducts or components (service gesture, shipping or duties & taxes) to refund for. **Lacking Total Refund Amount** If `orderRefund.TotalRefundAmount` is not specified, it will be converted to the end customer's currency based on `RefundAmount` or `OriginalRefundAmount` values for the RefundProducts in `refundProductsList` and their respective Product VAT rates. **For Full Order refunds** If `orderRefund.FullRefund` is specified as true: * A full refund will be created * `refundProductsList` should not be provided, otherwise, the call will fail with the "Full refund requested but list of RefundProduct is not empty." error. * `orderRefund.TotalRefundAmount` and `orderRefund.OriginalTotalRefundAmount` values (if provided) in the call will be ignored. * Amounts will be recalculated based on the order details. **For Partial Order refunds** If `product.RefundAmount` AND `product.OriginalRefundAmount` are not specified then: * `product.RefundAmount` AND `product.OriginalRefundAmount` will be calculated based on the order products' price * `orderRefund.TotalRefundAmount` is recalculated based on the product's refund amount plus `orderRefund.ServiceGestureAmount` **For Gift Cards** If an order is paid for with gift card (either fully or partially): On the Returns side, Global-e refunds back to the original payment method (such as credit card or APM) first, before the remainder of the refund returns to the gift card. Global-e calculates if there is any amount to return to the gift card, and if so, Global-e will show that refund component in the CreateOrderRefund API. ## Merchant Refund Notifications When the request includes a `ProviderCode` value, Global-e checks whether that code is recognized as a return provider configured to notify the merchant on refunds. If it is, Global-e automatically sends a refund notification to the merchant after the refund is created. If `ProviderCode` is omitted, empty, null, or not recognized as a notification-enabled provider, no notification is sent, and the existing behavior is preserved for callers that do not use this parameter. ## Refund Input Validation * At least one component must exist in the request (Shipping, Duties, Service Gesture or Products) * If a product was provided, the requested quantity to refund is `> 0` * Verify that the sum of all requested refund components equals the requested total refund amount * For "Full Refund" requests, the system will verify that no amounts were provided in the request * If a refund was requested in both merchant currency (i.e. Original Currency) and customer currency, the amount provided in the merchant currency will be ignored. The system will recalculate the amount in merchant currency based on the amount provided in the customer currency ## Use Cases Each scenario shows the `OrderRefund` object (the `orderRefund` argument) and the `RefundProductList` (the product array). ### Full Order Refund For full order refunds, no refund value is required. Global‑e will establish it from order. This will include Shipping as well as Duties & Taxes. ```json OrderRefund theme={null} { "OrderId": "GE95135467GB", "FullRefund": true } ``` ```json RefundProductList theme={null} [] ``` ### Full Product Refund For full product refunds, no refund value is required. Global‑e will establish it from order. #### Single product ```json OrderRefund theme={null} { "OrderId": "GE95135467GB" } ``` ```json RefundProductList theme={null} [ { "CartItemId": "1381109", "RefundQuantity": 1 } ] ``` #### Multiple Products ```json OrderRefund theme={null} { "OrderId": "GE95135467GB" } ``` ```json RefundProductList theme={null} [ { "CartItemId": "1381109", "RefundQuantity": 2 }, { "CartItemId": "2371567", "RefundQuantity": 1 } ] ``` ### Products with associated duties paid by the customer ```json OrderRefund theme={null} { "OrderId": "GE95135467GB", "ProductsDutiesRefund": true } ``` ```json RefundProductList theme={null} [ { "CartItemId": "1381109", "RefundQuantity": 1 }, { "CartItemId": "2371567", "RefundQuantity": 1 } ] ``` ### Product with shipping ```json OrderRefund theme={null} { "OrderId": "GE95135467GB", "ShippingRefund": true } ``` ```json RefundProductList theme={null} [ { "CartItemId": "1381109", "RefundQuantity": 1 } ] ``` ### Shipping Only ```json OrderRefund theme={null} { "OrderId": "GE95135467GB", "ShippingRefund": true } ``` ```json RefundProductList theme={null} [] ``` ### Partial Product Refunds For partial product refunds, a refund value is required. It should be provided: * in customer currency value ideally ("Amount" attributes) * or as percentage * or failing that merchant currency value can be accepted to be reused as a prorated calculation ("OriginalAmount" attributes) The total amount of refund is expected in parameters if amounts are provided. #### Using Customer Currency Example: Customer order placed in Australian dollars. Refunding 320 AUD of the product value. ```json OrderRefund theme={null} { "OrderId": "GE95135467GB", "TotalRefundAmount": "320" } ``` ```json RefundProductList theme={null} [ { "CartItemId": "1381109", "RefundQuantity": null, "RefundAmount": "320" } ] ``` #### Using Percentage Example: Customer order placed in Australian dollars. Refunding 50% of product value for a product not being returned. ```json OrderRefund theme={null} { "OrderId": "GE95135467GB" } ``` ```json RefundProductList theme={null} [ { "CartItemId": "1381109", "RefundQuantity": null, "RefundAmountPercent": "50" } ] ``` ### Components Refunds For components refunds, customer currency value is required. The total amount of refund is expected in the parameters for input control. #### Shipping Refund Example: Customer order placed in Australian dollars. Refunding 10 AUD for shipping cost. ```json OrderRefund theme={null} { "OrderId": "GE95135467GB", "ShippingAmount": "10", "TotalRefundAmount": "10" } ``` ```json RefundProductList theme={null} [] ``` #### Service gesture Example: Customer order placed in Australian dollars. Refunding 50 AUD as a service gesture because of a delay in dispatch. ```json OrderRefund theme={null} { "OrderId": "GE95135467GB", "ServiceGestureAmount": "50", "TotalRefundAmount": "50" } ``` ```json RefundProductList theme={null} [] ``` #### Duties Refund ```json OrderRefund theme={null} { "OrderId": "GE95135467GB", "DutiesAmount": "60", "TotalRefundAmount": "60" } ``` ```json RefundProductList theme={null} [] ``` ### Product Return Refund with Shipping In such a scenario, the Duties\&Taxes would not necessarily be expected to be refunded, in which the refund must not be triggered as a full order refund (which would include D\&T). Example order for these sections goes as follows: * 1 product at 500 CNY * Shipping at 40 CNY * Pre-paid duties of 60 CNY * Item is refunded in full thus amount is not required, only for shipping. ```json OrderRefund theme={null} { "OrderId": "GE95135467GB", "ShippingAmount": "40" } ``` ```json RefundProductList theme={null} [ { "CartItemId": "1381109", "RefundQuantity": 2 } ] ``` ### Deduction of Return Shipping Example: A German shopper is returning an item to a US merchant. The return shipping cost is €5.00 so the merchant deducts €5.00 from the refund. ```json OrderRefund theme={null} { "OrderId": "#4999", "CustomerPrepaidRefundAmount": 5 } ``` ```json RefundProductList theme={null} [ { "CartItemId": "12935475658836", "RefundQuantity": "1", "RefundComments": "02-Wrong Product" } ] ``` ## Error Codes Reference When calling the API, the following error codes may be returned. ### Generic Validation Errors | # | Context | HTTP status | ErrorInfo | | - | - | - | - | | 1 | Validation – refundProductsList is not null or empty | 400 | `{ Code = "NullParameter", Error = string.Format("Parameter {0} was null", parameterName), Description = string.Format("Please provide a valid value for the {0} parameter", parameterName) }` | | 2 | Validation – orderRefundObj is not null | 400 | `{ Code = "NullParameter", Error = string.Format("Parameter {0} was null", parameterName), Description = string.Format("Please provide a valid value for the {0} parameter", parameterName) }` | | 3 | Validation – orderId is not null | 400 | `{ Code = "NullParameter", Error = string.Format("Parameter {0} was null", parameterName), Description = string.Format("Please provide a valid value for the {0} parameter", parameterName) }` | | 4 | Validation – Multiple refunds | 400 | `{Code = "MULTI_REFUND_DISALLOWED", Error = "Multiple refund requests are disallowed for this order and reason", Description = "This refund request is rejected because multiple refunds are disallowed for the same order and the same reason code"}` | For the validations below, we do not return an ErrorInfo object but a different object – ResponseInfo. | # | Context | HTTP status | ResponseInfo | | - | - | - | - | | 1 | Validation – Order was not found | 400 | `{ Success = false, Reason = string.Format("Order {0} could not be found"}` | | 2 | Validation – The order does not belong to the merchant | 400 | `{ Success = false, Reason = string.Format("Order {0} doesn't belong to this merchant", order.OrderId) }` | The full request and response classes, with success and failure examples, are rendered on the [API Reference page](/api-reference/create-order-refund). # Replacements Source: https://docs.global-e.com/replacements ## Processing Replacements > [!NOTE] > > \*\*This section does not apply to Shopify.\*\***For information about Shopify, see [The section on Replacements under Shopify](/global-e-orders-in-shopify#-271831-2).** | | | | - | - | | If you wish to replace an item, instead of refunding the customer, you can use the Global‑e replacement functionality. **Prerequisites** Before you can use the Replacement feature: Verify that Global-e has set up the necessary configurations on the Global-e side. Ensure that Users have Merchant CS permissions and credentials. Contact your Success Manager if you need assistance in accessing the Global‑e Merchant Portal. | [▶ Watch video](https://www.youtube.com/embed/VIyfll15sZQ) | | **Criteria** To perform a replacement the order must have the following status: Dispatched to Customer Delivered to Customer Delivered to Store Part dispatched and part refunded Part dispatched (rest to follow) and payment received Returned to Merchant Lost by Shipper Damaged Returned to Store Returned by Shipper To be replaced Returned by customer Lost by Merchant Lost by Hub Note A replacement request cannot be made for an order in "Pending" status. | | ### Step 1. On the Global‑e Merchant Portal, create a replacement order. 1. Navigate to **Orders > View Orders**. 2. Find and select the order that contains the items to be replaced. 3. Scroll down to the bottom of the Order Details screen (General tab). 4. Under Items Ordered, click **Replace Order Products**. Note that this button is only available for orders in certain statuses — for example, once the order has been dispatched, delivered, returned or reported lost. See [Order Workflow (Order Statuses)](/order-workflow--order-statuses-). ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c3572115-776f-d6b8-d1fa-4a37541a54ae.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=5920a941c59f1691d32ba6c16d957b6d) 5. Select one or multiple items to replace. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b8622396-300b-b468-a3ae-bac5104e953c.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=44d8f1dedfc3379cb0aa8f4d1db61cac) 6. Click **Create Replacement** to create a new replacement order. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-11928ea6-9710-d731-aafb-736d3a8fb424.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=bed5382c1bbb4539406611d1e6f565c6) Your website opens. ### Step 2. On your eCommerce website, replace the items. When you click **Create Replacement**, your Merchant's website opens: * By default, your website shows the page of the product you wish to replace. * If the product URL is not configured correctly, the home page opens instead. Search for the item you want to send as a replacement. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a45a2529-9755-c7bc-4d5f-92fde5984b11.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=eaf15e0c0c9cea82aa28b3a19dd5bd6b) **To replace an item:** 1. Replace the item in one of the following ways: **Modify the attributes of the current item** 1. Modify the current item's attributes. Select the relevant product attributes according to their exact specification (size, colour, and more). 2. Add the replacement item to the cart. You can add multiple items to the replacement order. **Replace the current item with another product** 1. Manually search for the replacement item and select it. Select the relevant product attributes according to their exact specification (size, colour, and more). 2. Add the replacement item to the cart. You can add multiple items to the replacement order. ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cab606cc-485c-9aa7-a6b3-506a94a15f86.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=5848e8b0188363bd5564fdf573616733) 2. Click **Checkout** to proceed to your **Ecommerce Platform Checkout** page. 3. Click the Global‑e Replacement Order button to access the Global‑e Checkout. > [!NOTE] > > The Global‑e replacement order button name and location vary for each merchant. The **Global‑e Checkout** page opens. ### Step 3. Global‑e checkout (ecommerce platform). > [!NOTE] > > The Global‑e checkout page is similar to the checkout page of your ecommerce platform, with the following differences: > > ➽ The customer's personal and address details are prefilled according to the details in the original order. If required, you can modify these details. > > ➽ You do not need to enter payment information. > > ➽ The Global-e page includes a **Place Replacement Order** button instead of the ecommerce platform **pay/submit** button. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3d89cf23-8d0b-7d6d-7d4f-0c968c53adfd.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=ece662a9347a113ac74cd1fc3f54f4d4) ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1fe13680-052a-a2ab-feb5-1638d9400675.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=51bb63a18ade06696e5012a7720788e1) **To complete the replacement order in the Global-e Checkout Page (example above):** 1. Review the customer's personal details; modify them, if required. 2. Select the shipping method to send the replacement order (It can be different from that used to ship the original order). 3. Choose to prepay duties and taxes when applicable. > [!NOTE] > > DDU destinations can create expenses for customers and should be avoided if not intended. If Duties and Taxes are required and not prepaid, the customer may be requested to pay them to the shipper. 4. Click **Place Replacement Order** to create the replacement order. The order confirmation page confirms the creation of the replacement order. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-938fc0a8-cf39-9724-4b57-e94f8b75ec16.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=1b0a9bf9b5e320eb9e82e4d0974006c1) At this stage, the customer receives an email stating that the replacement order was created. The order is added to your ecommerce platform as a new order, indicating that this is a replacement order and not a regular order. If you do not wish to include replacement orders in your sales reports, you may need to perform modifications on your ecommerce platform to make sure that they are not included in the sales reports. 5. To view the original order or to cancel a replacement, click **Back to order in admin** to go back to the Global-e Merchant Portal. ### Step 4. On the Global‑e Merchant Portal, view replaced items. **To view the original order and replaced items:** 1. From the Global‑e Merchant Portal, navigate to **Orders > View Orders** 2. Open the original order. Note that in the Items Ordered section, the replaced items are flagged and linked to the replacement order for this item. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a5bea742-079d-d64d-8fdb-3ebe44dfb10b.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=3906f5cdf5ad3a1082ee19d717210dff) Note that at the top of the order screen, the newly replaced order is flagged as a replacement order. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-18ca815b-7a52-d46f-3d12-ce305521ab3b.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=ac559a3c6b943b62b27fcd5655674384) ### Step 5. On the Global‑e Merchant Portal, cancel the replacement (Optional). **To cancel the replacement:** * Click **Cancel Replacement.** ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b783c62c-f0e3-c28b-58af-2eec822094fb.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=3bbf7f09f09654b01935d4c064480018) Note: If a replacement order is in progress or it has been cancelled, you cannot create additional replacements. Notice the replacement indication next to the replacement orders. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7279c4b2-10b0-0285-3f19-a2f349e03d85.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=5dd4d478096ed9a1aa9602abd21daa79) # Replacing the Global-e Country Switcher Source: https://docs.global-e.com/replacing-the-global-e-country-switcher It is possible to replace the Global-e Country Switcher (also referred to as the "Shipping Switcher") with your own. This article explains the requirements and options available for doing so. ## GlobalE_Data Cookie Using your own Country Switcher requires that the `GlobalE_Data` cookie is set correctly. > [!NOTE] > > The `GlobalE_Data` cookie is used to determine which country is currently selected and to change the currently selected country. ### Structure ``` { "countryISO": "US", "currencyCode": "USD", "cultureCode": "en-US" } ``` | Field | Meaning | Examples | | - | - | - | | `countryISO` | The two-character [ISO 3166-1 Alpha-2 Country Code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) for the currently selected country | United States: `US` United Kingdom: `GB` Germany: `DE` | | `currencyCode` | The three-character [ISO 4217 Currency Code](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) for the currently selected currency | US Dollar: `USD` Pound Sterling: `GBP` Euro: `EUR` | | `cultureCode`(Optional) If you choose not to set the `cultureCode`, it is set automatically by Global-e scripts.) | A combination of: The [ISO 639-1 two-letter lowercase culture code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) associated with a language (optional) The [ISO 3166-1 two-letter uppercase subculture code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) associated with a country or region | English/United States: `en-US` English/United Kingdom: `en-GB` Germany: `de` | ### Reading the Cookie The first time a shopper arrives at your site, the cookie may not be set (as Global-e has not yet identified them). This is the point at which you can use your own [GeoIP detection](/replacing-the-global-e-country-switcher#geo-ip--optional-) and set the GlobalE_Data cookie yourself. ### Writing the Cookie * If you choose to set the cookie on the **server side**, ensure that the value hasn't already been set (to avoid overriding changes the shopper has made). * If you choose to set the cookie on the **client side**, make sure to refresh the page after setting the cookie (so that the Global-e scripts pick up the new value, serve the correct CSS file, and convert the prices correctly). ### Cookie Domain When setting the cookie: * Prefix the domain with a dot (to maintain compatibility with older browsers). * Ensure the cookie is **not** `http` only. See the following examples: | Storefront URL | Cookie Domain | | - | - | | [https://example.com](https://example.com) | .example.com | | [https://store.myclothing.co.uk](https://store.myclothing.co.uk) | .store.myclothing.co.uk | ## User Localization External Methods Instead of reading and setting the `GlobalE_Data` cookie directly, you can use our User Localization external methods. For detailed specifications and usage of the `GetUserLocalization` and `SetUserLocalization` methods, please refer to the [External Methods](/external-methods) documentation applicable for PRO, NCE, and Enterprise hubs. ## Geo IP (optional) You can choose to identify the shopper’s location via your own GeoIP logic. **Important!** If you do so, ensure the following: * The `GlobalE_Data` cookie is not already set. * If it is already set, do not identify the location of the customer and use the cookie value instead. * You set the `GlobalE_Data` cookie from the server side in the initial page request. Otherwise, you risk conflicting with Global-e's GeoIP detection. You can use our endpoint to geo-locate an IP address: **Request (POST)** ``` {GeoIPDomain}/Browsing/LocationByIP?merchantGUID={MerchantGuid}&IP={IP_ADDRESS}&useIpv6=true ``` **Description** Returns GeoIP information for the provided `{IP_ADDRESS}`. **Notes** In the above request: * `{GeoIPDomain}` is one of the following two values, depending on the environment: | **Environment** | **GeoIPDomain** | | - | - | | Production | `api.global-e.com` | | Sandbox | `connect.bglobale.com` | * `{IP_ADDRESS}` can be in either IPv4 or IPv6 format. * If you don't know your Global-e `{MerchantGuid}`, contact your Global-e support representative. **Example Response** ``` { "Country": { "Code": "IE", "Name": "Ireland (Republic of)", "DefaultCurrencyCode": "EUR", "DefaultCultureCode": "en-GB" }, "Region": { "Code": "", "Name": "", "CountryCode": "" }, "City": { "Code": "", "Name": "" }, "IPRange": { "From": 281471592431616, "To": 281471592890367, "Type": "IPV4" } } ``` ## List of Countries For a list of countries, you can use a static list of countries, or you can use the Global-e `GetCountries` API: **Request** ``` {Domain}/externalapi/GetCountries?merchantToken={MerchantToken} ``` **Notes** In the above request,`{Domain}` is one of the following values, depending on the environment: | **Environment** | **Domain** | | - | - | | Production | `gepi.global-e.com` | | Sandbox | `intgepi.bglobale.com` | **Example Response** ``` { "countryCode": "US", "countryCodeISO3": "USA", "countryName": "United States", "isOperatedByGlobale": true, "defaultCurrencyCode": "USD", "isFixedPricesSupported": true } ``` # Report Schedule Source: https://docs.global-e.com/report-schedule The report should be sent once the pick and pack in the Merchant warehouse is completed for the day and before the orders arrive at the Global-e hub or before the orders are prepared for international shipping by Merchants fulfilling from their own warehouse. # Requirements Source: https://docs.global-e.com/requirements-sfcc ## SFCC Compatibility Mode Global-e cartridges **require** SFCC Digital Compatibility Mode **17.7 or newer**. Current cartridges rely on CommonJS features available only from 17.7 onward: * `wildcard` imports — `require('*/...')` * `module.superModule` for cartridge extension Upgrade **all** environments (sandbox, development, staging, and production) to Compatibility Mode 17.7 before installing or upgrading Global-e cartridges. ### Older compatibility modes If your instance runs a compatibility mode **older than 17.7** (including versions between 15.5 and 17.6), contact **Global-e Merchant Support**. Global-e may provide additional materials for legacy integration modes. ## Account Manager / OCAPI Data API (new integrations) New Global-e SFCC integrations must provision a **dedicated** Account Manager API client and grant it **Data** OCAPI permissions so Global-e can keep SFCC configuration aligned (including starting configuration sync such as **GlobaleSettings**, and reading Global-e custom objects, related site preference groups, and product information). Do not reuse a Shop / headless OCAPI client for this purpose. Setup steps, the required resource JSON, and what to share with Global-e are in [Configuration → Data API](/configuration-sfcc#data-api-mandatory-for-new-integrations). The repository template is `metadata/ocapi-settings/wapi_data_config.json`. ## Development tooling When building or uploading cartridges from the repository (not required for BM-only configuration): | Tool | Requirement | | - | - | | Node.js | 18.20.0 or newer (see repository `package.json` `engines`) | | [`b2c` CLI](https://salesforcecommercecloud.github.io/b2c-developer-tooling/) | Used for cartridge upload, cartridge path management, and related tooling — see [Installation](/installation-sfcc) | Cartridge upload and metadata import steps are described in [Installation](/installation-sfcc). # Resetting Your Password Source: https://docs.global-e.com/resetting-your-password If you forgot your password, you can reset it from the login page. ## To reset your password: 1. Navigate to the [ReturnGO login page](https://app.returngo.ai/login). 2. Under **Forgot your password?** click **Reset it here**. 3. Enter your email address. 4. Click **RESET PASSWORD**.You will receive an email with a password reset link. # Resetting Your Password Source: https://docs.global-e.com/resetting-your-password-703405 If you forgot your password, you can reset it from the login page. ## To reset your password: 1. Navigate to the [ReturnGO login page](https://app.returngo.ai/login). 2. Under **Forgot your password?** click **Reset it here**. 3. Enter your email address. 4. Click **RESET PASSWORD**.You will receive an email with a password reset link. # Restricting Products Source: https://docs.global-e.com/restrict-product ## Restricting Products There are several methods for restricting products in Shopify and blocking them from checkout. * **Restrict Shopify Markets** ([Shopify Markets Method](/restrict-product#restricting-shopify-markets--shopify-markets-method-)) - Un-publish the product for international markets in the Shopify Product Editor. * **Use Product Tags** ([Global-e Tagging Method](/restrict-product#using-product-tags--global-e-tagging-method-)) - Restrict the product from being sold in all Global-e operated countries using Shopify product tags. * **Use Global-e Merchant Portal** ([Merchant Portal Method](/restrict-product#merchant-portal-method)) - Restrict the product for selected Global-e operated countries inside the Global-e Merchant Portal. ## Which Method Should be Used? Select the method according to relevant condition: | Condition | Method to use | **Notes** | | - | - | - | | Should restricted products continue to appear on the storefront for countries they are blocked in? | **Yes** - [Global-e Tagging Method](/restrict-product#using-product-tags--global-e-tagging-method-) or [Merchant Portal Method](/merchant-portal) **No** - [Shopify Markets Method](/restrict-product#restricting-shopify-markets--shopify-markets-method-) | The Global-e method will only block the product from being added to cart or being checked out with. It will still appear on the storefront in search results and PLP pages, and the PDP is still visible. The Shopify method prevents the product from appearing on the storefront in restricted markets *entirely*. | | Is merchant non-US and sensitive to SEO results? (i.e. their products not appearing on Google results) | **Yes** - [Global-e Tagging Method](/restrict-product#using-product-tags--global-e-tagging-method-) or [Merchant Portal Method](/merchant-portal) **No** - [Shopify Markets Method](/restrict-product#restricting-shopify-markets--shopify-markets-method-) | Shopify’s method of unpublishing a product from the storefront may result in the products not being indexed by Google bots, since it will display a “`404 Page not found`” for unpublished markets. This may lead to SEO issues, as the product will not be indexed by Google. | | Does the merchant need to restrict products for specific countries only? | **Yes** - [Merchant Portal Method](/restrict-product#merchant-portal-method) or [Shopify Markets Method](/restrict-product#restricting-shopify-markets--shopify-markets-method-) | The Shopify Markets and Global-e Admin Portal methods allow you to block products for specific countries. The Global-e tagging method will block the product for all countries. | ## Restricting Shopify Markets (Shopify Markets Method) In Shopify, use the **[Publishing Products with Markets](https://help.shopify.com/en/manual/markets/publishing-products-with-markets)** feature to specify in which markets to sell products. Markets that are not selected will be blocked for the product. This step can be performed using the product editor, bulk editor, or via CSV import. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-bb50527b-b02d-b51a-2dfc-a909596f64b9.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=482657c6b2a2ce66bee066ea1f9098e8) The product will not appear on Liquid storefronts and will be blocked at checkout if the country is switched. The product restriction is indicated in the Checkout page and the item will be removed when clicking the **Continue** button. **Limitations** Using the Shopify method will result in the product pages for blocked countries returning a `404 - Not found` error. This can create the following issues. * The product might not be browsable from unpublished countries. * This may cause issues with SEO. Google crawler will receive `404` error on the product link, so that the product will not be indexed for search. Therefore, use this method with caution outside of the United States. Even merchants within the United States may have issues if the Google crawler originates outside the United States. Considering these issues, [using product tags](/restrict-product#using-product-tags--global-e-tagging-method-) might be the preferred approach. ## Using Product Tags (Global-e Tagging Method) **Restrict a product tag for all countries** This process applies to all Global-e operated markets. 1. Tag restricted products with either `isBlockedForGlobale` tag, or a custom tag of your choice. If a custom tag is used, Global-e will need to configure the same tag in the Global-e system. 2. The product appears on the merchant site but will be prevented from being added to cart and will be blocked at checkout. 3. Restriction removal is done through the Global-e Merchant Portal. ### Limitations * If a product restriction tag is added to a new product, the product must be added to the cart and reach checkout before the restriction is applied on the Global-e side. To work around this, the merchant can send a CSV file of the restricted products to Global-e for a manual update, or simulate a checkout as soon as applying the tag. * If a merchant has restrictions applied in the Merchant Portal only for a few variants of a product, Global-e scripts will restrict all variants on the Product Details Page (PDP). ## Merchant Portal Method You can configure restrictions by variant using the Global-e [Merchant Portal](/merchant-portal). ## Headless Merchants For headless implementations, both Global-e and Shopify restriction methods will **only prevent checkout**. It is up to the merchant whether to display the restricted products on their storefront. The merchant can query the product using the Shopify Admin GraphQL API (see [Shopify API](https://shopify.dev/api/examples/international-pricing#query-available-countries-and-currencies)) to determine if the product is published or unpublished for the market in Shopify. Example query: ``` query GetProduct($id:ID!, $country:CountryCode){ product(id:$id) { id title description bodyHtml isGiftCard publishedInContext ( context: { country: $country} ) } } Variables { "id": "gid://shopify/Product/9532092317987", "country": "AU" } ``` The merchant can also query whether a product is restricted by Global-e using the [ProductCountryS API](/api-reference/product-countries). Please reach out to your **Customer Success Manager** to discuss your options. ## What the Shopper Sees When browsing products that are restricted for the customer country, Shopify shows a notification both on the product page and on the cart page, as shown in the following example. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5cebf63f-0bcd-8db1-d26e-4ad49cf7e459.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=af2fe935635a8bda6e3df73135790b85) # Restricted and forbidden products Source: https://docs.global-e.com/restricted-products-sfcc Global-e supports country-level **restricted** and **forbidden** products. Depending on configuration, you can: * Exclude restricted or forbidden products from search results and suggestions. * Prevent shoppers from purchasing restricted or forbidden products for the selected shipping country. Restriction data is imported from Global-e through the **GlobaleProducts** job (`/Browsing/RecentProductCountryS`) and stored on each product: | Custom attribute | Meaning | | - | - | | `geIsForbidden` | Product is forbidden (`true` / `false`) | | `geRestrictedCountries` | Comma-separated ISO country codes where the product is restricted (for example `AU,UA`) | See [GlobaleProducts](/globale-products-sfcc) for job setup and [Metadata](/metadata-sfcc) for attribute definitions. By default, restricted and forbidden products are **not** excluded from search results or suggestions. To exclude them from search, configure a dedicated promotion in Business Manager (below). For best performance on suggestions, set the promotion ID and use **Product Search Model** promotion product type. ## Search exclusion implementation Search filtering is implemented in `int_globale/cartridge/scripts/globale/helpers/searchHelpers.js`: ```javascript theme={null} /** * Returns Searchable Products Promotion * @returns {dw.campaign.Promotion|null} - Searchable Products Promotion * @example * In the example below, the exclusion will be done by using the Promotion ID, * for example SearchableProducts_AU - will be applied only for Australia, * where all Restricted or Forbidden products will be added in 'Qualifying Products' => 'Excluding products', * so the promotion will have qualifying products but won't have any discounted products, * thus we can filter the search results but the promotional callout message won't be displayed on storefront. */ function getSearchableProductsPromotion() { var globaleHelpers = require('*/cartridge/scripts/helpers/globaleHelpers'); var geAppContext = require('*/cartridge/scripts/factories/globale/geAppContextMgr').getAppContext(); var searchableProductsPromotionId = globaleHelpers.getPreference(globaleHelpers.preferenceKeys.geSearchableProductsPromotionId); var searchableProductsPromotion = null; // Check if the current country is operated by Global-e if (geAppContext.country.isOperated() && searchableProductsPromotionId) { var PromotionMgr = require('dw/campaign/PromotionMgr'); var collections = require('*/cartridge/scripts/util/globale/collections'); searchableProductsPromotionId = searchableProductsPromotionId .replace(/\{country\}/ig, geAppContext.country.getCode()) .replace(/\{currency\}/ig, geAppContext.currency.getCode()); var applicablePromotions = PromotionMgr.getActiveCustomerPromotions().getProductPromotions(); if (applicablePromotions && applicablePromotions.length > 0) { searchableProductsPromotion = collections.find(applicablePromotions, function (promotion) { return (promotion.ID === searchableProductsPromotionId); }); } } return searchableProductsPromotion; } /** * Apply searchable products promotion. * This function applies a promotion to the given product search model. * If the promotion is available, it sets the promotion ID and product type. * * @param {dw.catalog.SearchModel} apiProductSearch - The search model to apply the promotion to. * @returns {dw.catalog.SearchModel} The updated search model with the promotion applied. */ function applySearchableProductsPromotion(apiProductSearch) { // Retrieve the searchable products promotion var searchableProductsPromotion = getSearchableProductsPromotion(); // If a promotion is available, apply it to the search model if (searchableProductsPromotion) { var ProductSearchModel = require('dw/catalog/ProductSearchModel'); // Set the promotion ID and product type apiProductSearch.setPromotionID(searchableProductsPromotion.ID); apiProductSearch.setPromotionProductType(ProductSearchModel.PROMOTION_PRODUCT_TYPE_QUALIFYING); } // Return search model return apiProductSearch; } ``` ### SFRA SFRA search uses `int_globale_sfra/cartridge/scripts/helpers/searchHelpers.js`, which delegates to the core helper above. **searchHelpers** ```javascript theme={null} /** * Set search configuration values * * @param {dw.catalog.ProductSearchModel} apiProductSearch - API search instance * @param {Object} params - Provided HTTP query parameters * @return {dw.catalog.ProductSearchModel} - API search instance * @param {Object} httpParameterMap - Query params */ function setupSearch(apiProductSearch, params, httpParameterMap) { var searchHelpers = require('*/cartridge/scripts/globale/helpers/searchHelpers'); var originalApiProductSearch = originalSetupSearch(apiProductSearch, params, httpParameterMap); return searchHelpers.applySearchableProductsPromotion(originalApiProductSearch); // apply searchable products promotion } ``` In SFRA, product suggestions are filtered in `int_globale_sfra/cartridge/models/search/suggestions/product.js` when a searchable-products promotion is active: ```javascript theme={null} /** * Get Image URL * * @param {dw.catalog.Product} product - Suggested product * @return {string} - Image URL */ function getImageUrl(product) { var imageProduct = product; if (product.master) { imageProduct = product.variationModel.defaultVariant; } return imageProduct.getImage(IMAGE_SIZE).URL.toString(); } /** * Compile a list of relevant suggested products * * @param {dw.util.Iterator.} suggestedProducts - Iterator to retrieve * SuggestedProducts * @param {number} maxItems - Maximum number of products to retrieve * @return {Object[]} - Array of suggested products */ function getProductsWithRestrictions(suggestedProducts, maxItems) { var product = null; var products = []; while (suggestedProducts.hasNext() && products.length < maxItems) { product = suggestedProducts.next().productSearchHit.product; var geProduct = geProductMgr.get(product); if (!geProduct.isGeRestricted(geAppContext.country.getCode())) { products.push({ name: product.name, imageUrl: getImageUrl(product), url: URLUtils.url(ACTION_ENDPOINT, 'pid', product.ID) }); } } return products; } /** * @constructor * @classdesc ProductSuggestions class * * @param {dw.suggest.SuggestModel} suggestions - Suggest Model * @param {number} maxItems - Maximum number of items to retrieve */ function ProductSuggestions(suggestions, maxItems) { base.call(this, suggestions, maxItems); if (getSearchableProductsPromotion()) { var productSuggestions = suggestions.productSuggestions; this.products = getProductsWithRestrictions(productSuggestions.suggestedProducts, maxItems); } } ``` ### SiteGenesis SiteGenesis search uses `int_globale_sitegenesis/cartridge/scripts/models/SearchModel.js`: ```javascript theme={null} initializeProductSearchModel: { value: function () { var searchHelpers = require('*/cartridge/scripts/globale/helpers/searchHelpers'); var apiProductSearch = this.super.initializeProductSearchModel.apply(this.super, Array.prototype.slice.call(arguments)); // apply searchable products promotion apiProductSearch = searchHelpers.applySearchableProductsPromotion(apiProductSearch); return apiProductSearch; } } ``` SiteGenesis suggestions are filtered in `int_globale_sitegenesis/cartridge/scripts/search/SearchSuggest.js`: ```javascript theme={null} /** * Compile a list of relevant suggested products * * @param {dw.util.Iterator.} suggestedProducts - Iterator to retrieve * SuggestedProducts * @param {number} maxItems - Maximum number of products to retrieve * @return {Object[]} - Array of suggested products */ function getProductsWithRestrictions(suggestedProducts, maxItems) { var suggestedProduct = null; var restrictedSuggestedProducts = []; while (suggestedProducts.hasNext() && restrictedSuggestedProducts.length < maxItems) { suggestedProduct = suggestedProducts.next(); var geProduct = geProductMgr.get(suggestedProduct.productSearchHit.product); if (!geProduct.isGeRestricted(geAppContext.country.getCode())) { restrictedSuggestedProducts.push(suggestedProduct); } } return restrictedSuggestedProducts; } module.exports = function (searchPhrase, maxSuggestions) { var baseSuggesteModel = base(searchPhrase, maxSuggestions); if (baseSuggesteModel && baseSuggesteModel.product && baseSuggesteModel.product.available && getSearchableProductsPromotion()) { // Initialize the suggest model var suggestModel = new SuggestModel(); // Set the search phrase and maximum number of suggestions to retrieve suggestModel.setSearchPhrase(searchPhrase); suggestModel.setMaxSuggestions(maxSuggestions); // Retrieve the productSearchHita if (suggestModel) { baseSuggesteModel.product.products = getProductsWithRestrictions(suggestModel.getProductSuggestions().suggestedProducts, maxSuggestions); } } return baseSuggesteModel; }; ``` ## Site preference Configure **Searchable Products Promotion ID** (`geSearchableProductsPromotionId`) in **Merchant Tools → Site Preferences → Custom Site Preference Groups → Global-e Settings**. Use `{country}` and `{currency}` placeholders in the promotion ID — the cartridge resolves them from `geAppContext` at runtime (for example `SearchableProducts_{country}_{currency}`). ## Promotion and campaign setup The example below targets Australia via customer groups. Restricted and forbidden products are excluded from search for that market only. You can also scope one promotion to multiple Global-e operated countries using campaign customer groups. 1. Create a promotion in Business Manager (**Merchant Tools → Online Marketing → Promotions**). Use a **Product** promotion type; ID should match `geSearchableProductsPromotionId` (with or without placeholders). 2. Set **Qualifying products**: add all products to **Included Products 1**. In **Excluded Products 1**, choose the **Global-e RestrictedCountries** product custom attribute (`geRestrictedCountries`) and the country codes to exclude (for example `AU` for Australia). To also exclude **forbidden** products, add a second excluded-products condition on the **Global-e Is Forbidden** attribute (`geIsForbidden` = `true`) — `geRestrictedCountries` alone does not cover forbidden products. In this example, products with `AU` in `geRestrictedCountries` (plus any product with `geIsForbidden = true`) are excluded from search results for Australia. 3. Set **Discounted products**: remove **Included Products 1** and add all products to **Excluded Products 1** so no products receive a discount — this keeps PLP, PDP, and basket prices correct while filtering search. 4. Rebuild search indexes in Business Manager (**Merchant Tools → Search → Search Indexes** → rebuild product index). Salesforce B2C Commerce ignores campaign configuration for promotions used with `ProductSearchModel.setPromotionID()`. Assign the promotion to a Global-e campaign and customer group (for example an Australian group) so filtering applies only in Global-e operated countries. When the promotion ID contains `{country}` and `{currency}` placeholders, the cartridge resolves them automatically — a dynamic customer group on the campaign is not required: ```javascript theme={null} searchableProductsPromotionId = searchableProductsPromotionId .replace(/\{country\}/ig, geAppContext.country.getCode()) .replace(/\{currency\}/ig, geAppContext.currency.getCode()); ``` If the promotion ID has no placeholders, use a dynamic customer group on the campaign instead. ## Disable purchase on PDP By default, restricted or forbidden products appear on the PDP with an availability message. You can hide them or redirect shoppers — for example to the home page — using the Global-e product wrapper's `isGeRestricted(countryCode)` / `getGeRestrictionMessage(countryCode)` methods (from `int_globale/cartridge/models/globale/dw/product/decorators/geRestrictions.js`) in your Product controller. ### SFRA Add customization in the SFRA Product controller route: **Redirect to Home Page for Restricted and/or Forbidden products** ```javascript theme={null} /** * Global-e Product Show * * Merchant Customization: Add custom code to this route if you need custom behavior for * Restricted or Forbidden product on PDP page. For example, you could redirect international * customers to home page if they click on a restricted or forbidden product as shown in * the example below. * @example * var URLUtils = require('dw/web/URLUtils'); * var ProductMgr = require('dw/catalog/ProductMgr'); * var geProductMgr = require('{@literal *}/cartridge/scripts/factories/globale/dw/product'); * var geAppContext = require('{@literal *}/cartridge/scripts/factories/globale/geAppContextMgr').getAppContext(); * var apiProduct = ProductMgr.getProduct(req.querystring.pid); * var geProduct = geProductMgr.get(apiProduct); * // Restricted and Forbidden Products (the message function auto-selects the forbidden vs restricted text) * if (geAppContext.country.isOperated() && geProduct.isGeRestricted(geAppContext.country.getCode())) { * res.redirect(URLUtils.url('Home-Show')); // redirect to home page * next(); * } */ ``` ### SiteGenesis Add the same pattern in the SiteGenesis Product controller or pipeline: **Redirect to Home Page for Restricted and/or Forbidden products** ```javascript theme={null} /** * Global-e Product Show * * Merchant Customization: Add custom code to this route if you need custom behavior for * Restricted or Forbidden product on PDP page. For example, you could redirect international * customers to home page if they click on a restricted or forbidden product as shown in * the example below. * @example * var URLUtils = require('dw/web/URLUtils'); * var ProductMgr = require('dw/catalog/ProductMgr'); * var geProductMgr = require('{@literal *}/cartridge/scripts/factories/globale/dw/product'); * var geAppContext = require('{@literal *}/cartridge/scripts/factories/globale/geAppContextMgr').getAppContext(); * var apiProduct = ProductMgr.getProduct(params.pid.stringValue); * var geProduct = geProductMgr.get(apiProduct); * // Restricted and Forbidden Products (the message function auto-selects the forbidden vs restricted text) * if (geAppContext.country.isOperated() && geProduct.isGeRestricted(geAppContext.country.getCode())) { * response.redirect(URLUtils.https('Home-Show')); // redirect to home page * } */ ``` ## Einstein product recommendations If a shopper opens a recommended restricted or forbidden product, they see the restriction message on the PDP (or your custom redirect behavior) and cannot add the product to the basket. ### SFRA and SiteGenesis To hide restricted or forbidden products from Einstein recommendations, update the templates that render recommendation slots per [SFCC product recommendations guidance](https://documentation.b2c.commercecloud.salesforce.com/DOC1/topic/com.demandware.dochelp/content/b2c_commerce/topics/einstein/b2c_dev_considerations_for_prod_recs.html?cp=0_9_3_9). Example ISML fragment: ```xml theme={null} should not be cached, the tiles are cached individually.

${slotcontent.calloutMsg}

``` ## Global-e checkout with restricted products If a shopper reaches Global-e checkout with restricted or forbidden products in the basket, Global-e displays a restriction message and blocks checkout completion. # Returns Source: https://docs.global-e.com/returns-mixed-orders To shoppers, a mixed order return functions like a standard return: * Shoppers ship all returned items to a **single address per destination country** regardless of which hubs the products originated from. * In the Returns Portal, shoppers can see the entire mixed order products, allowing them to select items across the entire order. * Shoppers are not required to separate items into different packages based on origin. # Returns Source: https://docs.global-e.com/returns-orders > [!NOTE] > > This article describes how a shopper or customer support representative uses the Merchant Portal to search for a return that has already been started. For information about starting a return and creating an RMA/return shipping documents, see [Returns Portal](/returns-portal). **To search for returns:** 1. From the Merchant Portal, navigate to **Orders > Returns**. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-366a5c20-42ed-b36a-9af5-8a8de2bb12bc.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=7081c4fefd57f644f8e6f2d4706330a5) 2. You can search for returns by setting the following filters. * Select an option: * RMA Number (selected by default) * Tracking Number (shipper’s tracking number) * Order Number (Global‑e order ID - beginning with GE) * Delivery Reference Number * You can also set additional search filters (see details in the Additional Search Filters section further below). * To search for a specific return, enter the relevant return number in the search field, then click **Find and View**. * To list all returns based on the default RMA selection or on your selection, click **Filter Returns**. The search results are displayed in the lower section of the screen, under **Return Requests**. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-41845d45-4150-ebc9-1ad9-737654312567.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=6d4f4083528cf2d59e7a16349967969b) **Additional Search Filters** You can perform an advanced search by setting additional filters detailed in the following table. | Search by | Description | | - | - | | Shipping Service | Search by shipping service | | Return Status | Search by return status: Approved Arrived at Destination Authorized Closed Dispatched by customer Dispatch by Returns operator Dispatched from hub to merchant Received by Global‑e Received by Returns operator Received in Hub Refused Requested | | Customer name | Search by the name of the customer who performed the return | | Return creator | Search by the person who created the return: Customer Global‑e Representative Merchant Representative | | Merchant | Search by merchant name (only relevant for merchants with multiple brands managed by the same user) | | Email | Search by customer email | | From Date / To Date | Search for returns within a date range: Select the From Date and To Date from the calendars | | Shipping Countries | Search by shipping country | | Return Type | Search by return type: Consolidated return Local Prepaid Local Prepaid Courier Prepaid Standard Undefined | # Returns Portal Source: https://docs.global-e.com/returns-portal ### Overview > [!NOTE] > > This article describes how a shopper or customer support representative starts a return and creates an RMA/return shipping documents. For information about using the **Merchant Portal** to search for returns that have already been started, see [Returns](/returns-orders). Global-e provides you with 2 different methods to support shopper returns: * [**Self-service:**](/returns-portal#shopper-procedure) If you support self-service returns, the shopper uses the **Returns Portal** to access their order, initiate a return, and create an RMA and required shipping documents. * [**Merchant-assisted:**](/returns-portal#cs-rep-procedure) A customer support representative (“CS rep”) uses the Global-e [Merchant Portal](/merchant-portal) to access the order and initiate a return. They are then automatically forwarded to the **Returns Portal** to create an RMA and required shipping documents. * The CS rep must have the appropriate [user role](/global-e-roles-and-features) and permissions for initiating returns (Merchant CS or Merchant CS Admin). In most respects, the returns process is the same whether initiated by the shopper or the CS rep; only the process of accessing the order is different. However, the CS rep does have a few options that the customer doesn’t have (for example, arranging free return shipping). ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-40d167fe-dc9e-2a1a-d7c6-23d656f7aa55.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=2af2bd5e5569954cd7947041062be95d) ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-af14372b-27ff-bd1d-ad88-f9a6116acbdb.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=309a9a402ae15510b20b52082cc9e47d) ### Returns Portal Design As part of the integration process, Global‑e provides you a branded **Returns Portal** and a unique URL for your shoppers to access it. You can choose one of 4 customizable templates for your **Returns Portal**: > [!NOTE] > > If your **Returns Portal** doesn’t yet look like one of these, it’s easy to make that happen! Just contact the Global-e Customer Success team. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b4ee051c-6f53-c628-6bf7-71854c8a1c6d.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=799bc0b10af437a2b614b3fba110cb51) ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-45aa3349-a8f4-b08f-0bcd-0c40bcab47cb.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=fba638ca8b2efbe244824fbd31f1c584) ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c89ad286-5ea2-20c6-13e0-459fd81455a6.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=9cb73224365184fcecbf5bc08b109e2c) ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3a2b344f-6e84-d817-34ba-e3f6eed7ea88.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=85868fe60d5e50b0aa8ed0c3f7cb8a0c) You also have the option to customize the following design elements: * Button and text color * Text font and size * CTA text * Header text > [!NOTE] > > **Returns Portal Translation** > > * The **Returns Portal** and return instructions are fully translated and support multiple languages. > * The [Standard Shipping Label](/returns-portal#standard-shipping-label) (self-postage) supports English only. > * The [Return Note](/returns-portal#return-note) is partially translated. ### Returns Process The following instructions detail the steps for initiating a return and creating an RMA, shipping label, and required shipping documents. #### Access the Order The returns process begins with finding and accessing the order. This step is different for shoppers ([self-service returns](/returns-portal#shopper-procedure)) and CS reps ([merchant-assisted returns](/returns-portal#cs-rep-procedure)). #### Shopper Procedure > [accordion] Show details > > **The shopper accesses their order as follows:** > > 1. The shopper goes to your **Returns Portal** link. > > * As a merchant, it’s up to you to share this URL with shoppers. > 2. \[Optional] If the shopper wants to continue in a language other than English, they can select it here. > > * By default, the language is set to English (regardless of the language in which they made their purchase). > 3. The shopper enters the **Global‑e Order ID** or **Merchant Order ID** and the email address used to place the order, then clicks **Start return.** > > ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-ad26adf6-51e2-7ebe-f59c-dc56392b260d.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=ef3debe71caef50095ee3059b32398f1) #### CS Rep Procedure > [accordion] Show details > > **To access the shopper’s order:** > > 1. From the Global-e **[Merchant Portal](/merchant-portal),** navigate to **Orders > View Orders.** > > The **Merchant Orders** screen opens. > 2. Search for and open the order with items to be returned. (For additional details about how to search for and view orders, see [View Orders](/view-orders).) > > The **Order Details** screen opens. > 3. At the bottom of the screen, under **Items Ordered**, click **Create Return.** > > ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-41b40a31-d6c3-e773-1ef7-fce7e5bd61e6.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=6804903f4118b4737f07d1f51836149e) > 4. The **Returns Portal** homepage opens with the Order ID and Email prefilled, so just click **Start return.** #### Complete the Returns Process on the Returns Portal From this point on, the returns process is essentially the same for both shoppers and CS reps, with the **Returns Portal** leading them step-by step through the process: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2e00b5b9-6f4d-4843-4b63-8385b6581e1a.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=f7e3d407f611d817c589aae2dc644e04) > [!NOTE] > > **For the remainder of this article:** > > * Instructions are written as if speaking directly to the shopper or CS rep. > * Any options available to CS reps but not to shoppers are identified. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8533be61-dab3-1292-97ba-447edccb91f0.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=0ac150687b960a07c9b65ef73b0eea93) ### Step 1: Select Return Items > [accordion] Show details > > **To complete Step 1:** > > 1. For each item you want to return, select the number to return and the return reason. > > 2. **\[CS reps only]** At the bottom of this screen, you see an option that shoppers don’t see: **Make this return free shipping for customers.** Tick this box to grant the shopper a free prepaid return. > > 3. Click **Next** to continue to Step 2. > > > [!NOTE] > > > > **Additional information** > > > > 1. **Return requirements:** If the order does not meet the following requirements, you will receive an error message, and you won’t be able to continue the returns process: > > > > * **Return policy:** The order must meet the merchant’s return policy. (In certain cases, the CS rep may be able to create a return after the return period has expired.) For more details, see [Return Policy](/returns-portal#return-policy). > > * **Parcel status:** The parcel status must be **Delivered to customer, Delivered to Store, or Dispatched.** For more details, see [Order Status](/returns-portal#order-status). > > 2. **Multiple shipments:** If the order was shipped in multiple shipments: > > > > * Items are displayed separated by shipment. > > * Items from different shipments must be returned in separate packaging with separate shipping labels/documents; therefore, you can select items from only one shipment at a time. > > * After completing the returns process for items from one shipment, you can create an additional return for items from a different shipment. > > 3. **Non-returnable items:** In most cases, non-returnable items are also displayed, but you cannot select them. For more details, see [Non-returnable Items](/returns-portal#non-returnable-items). > > 4. **\[Merchants] List of return reasons:** For more details about the default list of return reasons and how to customize them, see [Return Reasons](/returns-portal#return-reasons). > > ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ec83711b-329b-fe89-0b36-d919daa68cd9.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=f4a319d3b1bc55be84b57d54be7c5f93) ### Step 2: Select Return Method > [accordion] Show details > > **To complete Step 2:** > > 1. Select the return shipping method to use. For more details about available methods, see [Return Shipping Methods](/returns-portal#return-shipping-methods). > 2. If there is a disclaimer relevant to the selected return method, tick the box to acknowledge it. > 3. Click **Next** to continue to Step 3. > > ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c958bb1e-be4a-909c-a78e-1ca2f4f3fb43.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=5df06469c54a90a419a03d945f7b66e9) ### Step 3: Create Return Label > [accordion] Show details > > Once you proceed to Step 3: > > * The RMA number and return instructions relevant to the selected return method are displayed. > * An RMA email is sent directly to the email address used when placing the order. > > * This email includes the RMA number, return instructions, and the return label and the required documents for the selected return method. For example documents, see [Example Return Shipping Labels/Documents](/returns-portal#example-return-shipping-labels-documents). > > * You also have the option to download the return label/documents by clicking **Print label.** > > > [!NOTE] > > > > A shopper can create only one **prepaid** return label per shipment. A CS rep can create additional prepaid return labels if necessary (for example, if a shopper wants to change the prepaid return method after creating the label). ### Reference #### Return Policy > [accordion] Show details > > The returns process can be initiated only for orders that meet the merchant’s return policy. > > > [!NOTE] > > > > **Merchant settings customized during integration:** > > > > * Number of days during which a return is permitted (calculated from the time a parcel is placed in **Dispatched** status). > > * Ability of a CS rep to create a return after the return period has expired. > > > > * By default, this is not permitted ### Order Status > [accordion] Show details > > An order or parcel must have one of the following statuses to execute returns: > > **Order Status** > > * Delivered to customer > * Delivered to store > * Dispatched to customer > * Returned to store > * \[Split orders only] Part dispatched (rest to follow) and payment received > * \[Split orders only] Part dispatched and part refunded > > **Parcel status** > > * Delivered to customer > * Delivered to store > * Dispatched ### Non-returnable Items > [accordion] Show details > > **Displayed Items** > > Products that have been marked as non-returnable by the merchant (in merchant-provided product attribute/metadata) **are** displayed in the Returns Portal. These items cannot be selected for return and are labeled accordingly. > > ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-f7ca25cc-3e94-f8f3-3934-e28093b716c4.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=8ef4b0271c5c0a7912f8afd0f09ef02a) > > **Non-displayed Items** > > The following item types are **not** displayed in the **Returns Portal:** > > * Dangerous goods > > * **\[Merchants]** Global-e can change this setting at your request. When dangerous goods are displayed, they **cannot be selected for return** and are displayed with an exclamation mark ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-29b655c6-9bd7-9382-eaf6-e366ad69ac8e.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=4c84c768edf4c388e7409f3d859e86ba) icon. > * Items with a price of 0 before discount > * Virtual products > > * These are products that are delivered electronically, without the need for physical shipping (for example, gift cards and vouchers). ### Return Reasons > [accordion] Show details > > > [!NOTE] > > > > At merchant request, Global‑e can customize the return reasons and the order in which they are displayed. > > For each item to be returned, a return reason must be selected. > > **Default Return Reasons** > > * Arrived too late > * Wrong Size > * Wrong Product > * Damaged on arrival > * Changed my mind > * Faulty item > * Too big > * Too small > * Ordered more for choice > * Not as photo > * Not as described > * Undeliverable > * Replacement > * Does not fit what I saw on the web > * I don’t like > * It does not suit me > * Item is defective > * The item is wrong, I did not request it > * The size is wrong > * Other ### Return Shipping Methods > [accordion] Show details > > > [!NOTE] > > > > During integration, return shipping methods are customized per merchant requirements. > > Available return shipping methods vary based on merchant settings and shopper address. Return methods generally include one or more of the following: > > * **Standard Return (self-postage):** The shopper creates a return label/documents and ships the returned items with the **carrier of their choice at their expense.** > > * **\[Merchants]** This option is available by default unless you request that Global-e remove it. > * **Prepaid Return:** The shopper creates a prepaid return label/documents for the carrier designated by the merchant’s settings. The return cost is deducted from the shopper's refund. > * **Prepaid Dropoff:** The shopper selects a local drop-off point, creates a prepaid return label/documents, and drops the package off at the selected location. The return cost is deducted from the shopper's refund. > * **Express Prepaid**: The shopper creates a prepaid return label/shipping documents for the express carrier designated by the merchant’s settings. The return cost is deducted from the shopper's refund. ## Example Return Shipping Labels/Documents The following images are examples of common return shipping labels and documents: ### Prepaid Shipping Labels > [accordion] Show details > > | Example 1 | Example 2 | > | - | - | > | ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-67fc71ed-b32b-7f30-feae-0f80b40731be.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=658c8d67928ecbeeeb9a28f189272077) | ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-72b6b371-91fd-12e5-829f-a54ff50577a3.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=fef71db3efab974b58969dbab42986b4) | ### Standard Shipping Label > [accordion] Show details > > ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1312dbf8-1d5d-5066-995e-a3a52e00c8e6.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=fe38c0acac090b6ab2c35d785335063e) ### Return Note > [accordion] Show details > > ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-bf778741-5aa6-e5a6-eb8e-3d99594dc91d.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=484b0e89ee1daca09e649fbd8c5fbc3d) # Returns Provider Integration - Checklist Source: https://docs.global-e.com/returns-provider-integration---checklist The **Returns Provider Integration - Checklist** outlines the required steps and validations for return solution providers integrating with Global-e’s returns, refunds, and exchange flows on Shopify. ## Prerequisite | Task | Details | Comments | Provider Reply | Done | | - | - | - | - | - | | Contact Global-e | Contact GE either by subscribing in our partners portal: [Our Global Ecosystem of Partners - Global-e](https://www.global-e.com/partners-lobby/) or by contacting your merchant’s CSM. | | | \[ ] | ## Merchant Specific | Task | Details | Comments | Provider Reply | Done | | - | - | - | - | - | | Obtain the Merchant GUID | Required for API headers/calls | Get from merchant | | \[ ] | | One shipping option | If only one return shipping option is supported, inform the merchant and ensure correct setup | Per lane in Global-e | | \[ ] | | emails | If provider sends shopper emails, coordinate with merchant to disable Global-e notifications | Open support ticket if needed | | \[ ] | ## Communication to Global-e | Task | Details | Comments | Provider Reply | Done | | - | - | - | - | - | | Provider Code | Communicate your Provider Code identifier | Must be recognized for API calls | | \[ ] | | Merchant GUID | Use Merchant GUID for each API call to Global-e | | | \[ ] | ## Implementation | Task | Details | Comments | Provider Reply | Done | | - | - | - | - | - | | Order is operated by Global-e | Implement Shopify order checks to verify that the order is Global-e operated | Before offering returns/exchanges | | \[ ] | | Tracking Number | Save TrackingNumber returned from GetReturnDocument API call for tracking events | Required for event calls | | \[ ] | | Create Return | Create the return in Shopify after receiving Global-e documents. Include ReturnShippingFee in presentment_currency | | | \[ ] | | Implement needed APIs | [GetReturnShippingOptions](/returns-via-api#getreturnshippingoptions--merchant-to-global-e-) [GetReturnDocuments](/returns-via-api#getreturndocuments--merchant-to-global-e-) [GetTrackingEvents](/api-reference/get-tracking-events) | | | \[ ] | | Perform final checks | Ensure all systems function as expected before launch | Final readiness | | \[ ] | | Task | Details | Comments | Provider Reply | Done | | - | - | - | - | - | | Order is operated by Global-e | Implement Shopify order checks to verify the order is Global-e operated **before** offering Global-e returns/exchanges | | | \[ ] | | Obtain the Merchant GUID for each merchant you onboard | This is required in API headers for Global-e calls. | Get it from the Merchant | | \[ ] | | Provider Code | Provider name or initials that identifies the source of the request. Examples: Loop, Redo, ParcelLab | Communicate your Provider Code identifier to Global-e so it’s recognized in API calls. | | \[ ] | | emails | If you will send shopper emails, coordinate with merchant to disable Global-e notifications via a merchant support ticket. | | | \[ ] | | One shipping option | If your portal supports only one return shipping option, you must: Inform the merchant Ensure they configure the correct method per lane in Global-e | | | \[ ] | | Tracking Number | `TrackingNumber` is return from the API call GetReturnDocument It must be saved for tracking events calls | | | \[ ] | | Create Return | **Create the return in Shopify** after receiving Global-e documents. Include **ReturnShippingFee in presentment_currency**. | | | \[ ] | | Perform final checks | Ensure all systems are functioning as expected before launch. | | | \[ ] | # Returns Provider Integration Guide Source: https://docs.global-e.com/returns-provider-integration-guide ## Introduction This guide is designed for Returns solution providers operating on Shopify who wish to integrate with Global-e’s returns, refunds and exchange flows for Global-e operated orders. * **Audience:** Product & Engineering teams at return solution providers, integrating with Global-e over Shopify. * **Purpose:** Enable seamless connectivity to Global-e’s comprehensive suite of operations for managing returns, exchanges and refunds. **Why integrate:** * **Expand market reach** by connecting with Global-e’s global network of Shopify merchants. * **Drive adoption** by enabling localized, seamless and consistent returns and exchanges experience cross domestic and cross border transactions. * **Add strategic value** with support for complex cross-border return flows and stronger merchant partnerships. ## Roles and Responsibilities **Merchant** * **Defines** merchant policies in the **Return Provider’s admin** (product/order eligibility, return reasons, return windows, refund rules). * **Defines** shipping options and flat shipping costs in **Global-e admin**. * Reviews and approves RMAs and refunds when set to manual approval. **Return Provider** * Serves as the shopper-facing portal for initiating returns/exchanges. * Fetches order data from Shopify and verifies whether Global-e operates the order. * **Manages** merchant return/exchange policies and RMA logic. * Communicates with Global-e the “Provider Name” identifier which will be sent on the API calls. * Obtains the merchant’s GUID from the merchant, for each merchant they wish to onboard. * Calls Global-e APIs to: * Get return shipping options (Carrier, service, PrePaid return cost) * Get return documents (label, invoice, shipping instructions, tracking number) * Get tracking events (for notification and refund automation) * Delivers RMA documents, shipping labels, and instructions to the shopper. * Creates exchange orders on Shopify when applicable. * Supports refund automation based on tracking events (e.g., auto-refunds). **Global-e** * Acts as **Merchant of Record** for Global-e-operated orders. * Assumes full liability for cross-border compliance * Owns or manages logistics flows * Issues shopper refunds * Provides and manages: * Return addresses, carrier restrictions, and cross-border compliance. * Shipping options, prepaid labels, and shipping instructions. * Tracking events. **Shopify** * Acts as the central commerce platform linking Merchant, Global-e, and Return Provider. * Stores and exposes order data for Return Provider validation. * Handles stock reservations and order creation for exchange flows. ## Before You Start * Contact GE either by subscribing in our partners portal: [Our Global Ecosystem of Partners - Global-e](https://www.global-e.com/partners-lobby/) or by contacting your merchant’s CSM. * See this [CheckList](/returns-provider-integration---checklist) document and make sure you fill in everything while working on the integration implementation. API Referenced in this Document * [GetReturnShippingOptions](/returns-via-api#getreturnshippingoptions--merchant-to-global-e-) * [GetReturnDocuments](/returns-via-api#getreturndocuments--merchant-to-global-e-) * [GetTrackingEvents](/api-reference/get-tracking-events) ## High-Level Flows * [Return flow](/returns-provider-integration-guide#return-flow) * [Refund flow](/returns-provider-integration-guide#refund-flow) * [Even exchanges](/returns-provider-integration-guide#even-exchanges) ### Return Flow ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-be48dace-3dfa-92e0-4668-e6e6229f4e4d.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=79facb36c54e7780a29743774e70ec9a) 1. **Shopper initiates return** 1. Shopper initiates a return in the returns provider’s portal, usually by entering an **Order ID** and **Email**. 2. The return provider fetches order details from Shopify and validates whether the order is Global-e operated. 3. Global-e order can be recognized by the following attributes: * `"merchant_of_record_app_id": 5806573` > [!NOTE] > > For testing environment use `“merchant_of_record_app_id": 5806443)` * If you do not have the `"merchant_of_record_app_id"` attribute, you can fallback to using Global-e OrderID. Each `OrderId`, string, has prefix GE followed by numbers, in the format `GE1234`. 4. The `merchant_of_record_app_id": 5806573` attribute is used to recognize the Global-e order. Example: ``` "note_attributes": [ { "name": "GEOrderId", "value": "GE137255874US" } ] ``` 2. **Shopper chooses item(s) to return** 1. Product return eligibility is managed by: 1. Returns provider: order, product, and RMA eligibility rules. 2. Global-e: carrier and cross-border regulation restrictions (e.g., dangerous goods, import limitations, product restrictions per shipping method). > [!NOTE] > > * Global-e validations occur during the GetReturnShippingOptions API call and may disqualify the return. > * The return provider fetches product prices from Shopify in the presentment currency and displays them in their portal to the shopper in this form. > * Multiple RMA requests are supported per order for different products, but customers cannot create multiple RMAs for the same product. 3. **Shopper provides return reasons:** 1. Return reasons are managed by the return provider 2. Shopper selects item(s) to return and provides reasons in the return provider’s portal. 3. Return provider to send return reason description to Global-e via the GetReturnDocuments API later in the flow. > [!NOTE] > > * Global-e does not support multiple return reasons for items with the same SKU. If a customer returns several units of the same SKU (for example, three t-shirts of the same model), only one return reason applies to the entire group. Assigning different return reasons to individual items within the same SKU is unsupported. > * Multiple items with the same SKU, must be sent as one object in the ReturnedProducts array, with ReturnQuantity > 1. > * When calling GetReturnDocuments API make sure to NOT send the return reason code, just the return reason description. > * If you manage return reasons hierarchically, note that Global-e accepts only one return reason description per item. 4. Shopper selects Return Method 1. The return address is managed and stored by Global-e. 2. Call Global-e’s [GetReturnShippingOptions](/returns-via-api#getreturnshippingoptions--merchant-to-global-e-) API to get available shipping carriers, services, and rates. 1. [API authentication](/api-authentication) is done via Merchant GUID- a unique key provided to the Merchant, by Global-e. The Merchant GUID key should be passed in the API header. 2. In order to obtain the Merchant GUID please contact your Merchant 3. Obtain Unique Global-e Order ID: Note: each `OrderId`, string, has prefix `GE`followed by numbers, in the format `GE1234`. 4. Mandatory request fields: | Field | Description | | - | - | | `OrderId` (string) | Unique Global-e Order ID. Maximum: 100 characters. | | `ProviderCode` (string) | Provider name or initials that identifies the source of the request. Examples: Loop, Redo, ParcelLab. | | `CurrencyCode`(string) | CurrencyCode should be passed as per Shopify `order.presentment_currency` code on the order. | | `ReturnedProducts`(Array of `Products`) | The following fields should be populated: `CartItemID`→ corresponds to Shopify field LineItemId `ReturnQuantity` | 3. Shopper views available shipping options with corresponding rates and selects one. > [!NOTE] > > * Shipping options and prepaid shipping rates are managed by Global-e. > * Global-e returns multiple shipping options as configured by the merchant (e.g., express, standard, self-postage). > * If the return provider supports only one shipping method, they must inform the merchant and ensure the correct return method is selected for each shipping lane. > * Carrier restrictions are managed and validated by Global-e (e.g., dangerous goods, import limitations, product restrictions per shipping method). > * Returns can only be done from the country where the order was initially delivered. 5. **Shopper indicates refund method** 1. Refund can be issued as: 1. Original payment method - initiated by the returns provider and issued by Global-e 2. Shopify Gift Card - managed by the returns provider 2. More information on refunds is available in the refund flow section below. 6. **Shopper confirms return** 1. Call Global-e’s [GetReturnDocuments](/returns-via-api#getreturndocuments--merchant-to-global-e-) API to initiate an RMA and get return documents. 1. Mandatory fields: | Field | Description | | - | - | | `OrderId`(string) | Unique Global-e Order ID or Merchant Order ID. Maximum: 100 characters. | | `ProviderCode`(string) | Provider name or initials that identifies the source of the request. Examples: Loop, Redo, ParcelLab | | `ReturnedProducts` (Array of [ReturnedProduct](/returns-via-api)) | An array containing the returned products' details. MerchantReturnReasonDescription `CartItemID` - corresponds to Shopify field LineItemId `ReturnQuantity` | 2. The API shall return the following: * Global-e RMA number * Return shipping label * Shipping instructions * Commercial Invoice - Optional * Tracking Details - an array which includes the **TrackingNumber** - this number should be saved in order to later use the GetTrackingEvents API. 2. The return provider creates the return in Shopify, including the ReturnShippingFee, and provides the return label and instructions to the shopper. * Shopper is sent a return confirmation with the return documents. > [!NOTE] > > When migrating from Global-e’s returns solution to a 3rd party returns provider, it’s important to note that Global-e can manage all returns-related customer emails (such as RMA notifications). If the third-party provider will handle these communications instead, the email notifications on Global-e’s side must be disabled to prevent duplicate messages. 7. **Get label and ship product back** 1. Shopper downloads label and instructions. 2. Shopper sends parcel. 3. Optional: Global-e provides a tracking events API for its carriers: 1. call [GetTrackingEvents](/api-reference/get-tracking-events) API for tracking updates. ### Refund Flow This section defines how refunds are initiated, communicated, and processed between the **Return Provider**, **Global-** e, and **Shopify** after a refund is approved. **Refund Initiation** Although the refund is initiated in Shopify, the actual payment to the shopper is done by Global-e. In order to make sure that we won’t have double refunds or incorrect refunds, it is very important to follow the guidelines below which defines the proper way to initiate the refund via Shopify. **Handling Return Shipping Fees** 1. When creating a refund in Shopify, the return provider, should specify what is the deducted shipping fee for the return by declaring the prepaid amount in presentment_currency in the Shopify Native ReturnShippingFee return property. 2. Shipping fees are managed by Global-e and available via the [GetReturnShippingOptions](/returns-via-api#getreturnshippingoptions--merchant-to-global-e-)API. 3. Shopify will deduct the shipping cost from the refund amount, Global-e will get this information from Shopify and will refund the shopper with the correct amount. 4. If the return provider does not specify the shipping fee, GE will refund the shopper with the full amount which was sent from Shopify and will charge the shipping fee from merchant. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5f762573-8526-e488-e4c6-6d9ea7c89c1d.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=dd10388dc95cee3cf37f988ccfbc065e) 5. Refund logic: * The Return Provider must **create a return** and specify the return shipping fee. * The Return Provider needs to refund the return and call the Shopify API: [returnRefund](https://shopify.dev/docs/api/admin-graphql/latest/mutations/returnrefund) to connect the refund to the return. **Refund Execution** * Global-e receives the refund request from Shopify (via webhook). * Global-e checks if the refund amount includes the return shipping fee deduction. * The relevant amount is refunded to the shopper by **Global-e** and details are logged. * **Shopify’s declared return shipping fee determines what the shopper pays.** Global-e’s shipping flat fee represents the agreed-upon amount that must always be fully accounted for, either by the shopper, the merchant, or a combination of both. * During reconciliation, Global-e ensures the flat fee is fully covered: * If Shopify undercharges (Return provider declares a lower fee), the merchant is fully responsible for covering the remaining balance between Shopify’s declared fee and the Global-e shipping flat fee. * If Shopify overcharges (Return provider declares a higher fee), the merchant receives the difference between the higher shopper charge and the Global-e shipping flat fee. In other words, the merchant remains fully responsible for any financial difference between Shopify’s declared return shipping fee and the Global-e shipping flat fee they configured. **Reconciliation and Reporting** 1. Details about refund, items, and shipping fees are included in finance/merchant reconciliation. 2. Refund status and data is synchronized between Shopify and Global-e for full order lifecycle tracking. > [!WARNING] > > * The Return Provider should include all adjustments (shipping, duties, etc.) in the corresponding fields in Shopify. > * The **net refund amount** sent to Global-e from Shopify must reflect any deductions or additional charges. > * Global-e will handle financial reconciliation with the merchant for these adjustments. **Alternative Refund Methods** If the shopper selects a **Shopify Gift Card** instead of an original payment refund: * The refund is processed entirely within Shopify by the Return Provider. * The Return Provider should record the transaction internally and update the RMA status to "Refunded (Gift Card)". > [!WARNING] > > * Global-e **does not** support currently “**Shopify Store Credit**”. Shopper will not be able to use this type of payment. > * When a refund is made to a **Gift Card**, Global-e cannot see that transaction. To avoid double refunds, ensure that **no “Auto Refund” automation is enabled on Global-e side**. **Refund Automation and Tracking** * Refund automation enables **seamless refund initiation** based on parcel tracking events or internal system rules. * Automation can be owned by either by Global-e or by the return provider. * The **Return Provider** can monitor tracking statuses via the [GetTrackingEvents](/api-reference/get-tracking-events) API to trigger the refund programmatically. **Automation Ownership** There are two possible automation configurations: 1. **Refund automation managed by Global-e** * Refunds are triggered automatically once the tracking event matches the configured rule (e.g., *in transit or delivered*). * The Return Provider **should not** issue a separate refund to avoid duplication. 2. **Refund automation managed by the Return Provider** * Refunds are triggered within the provider’s system. * In this case, **Global-e’s automation must be turned off** to prevent double refunds. * To disable automation on Global-e’s side, the merchant must **submit a support ticket** to Global-e. **Tracking Events API** * The **Return Provider** can monitor parcel progress via the [GetTrackingEvents](/api-reference/get-tracking-events) API. * The TrackingNumber is received as part of the response of the GetReturnDocuments API and should be saved by the return provider in order to be used in calling the GetTrackingEvents API. | Parameter Name | Type | Description | Mandatory | | - | - | - | - | | `OrderIds` | List of Strings | List of Global‑e Order IDs. Up to 100 in each request. Max length:100 chars. | One of either `OrderIds` or `TrackingNumbers` is mandatory. | | `TrackingNumbers` | List of Strings | List of Global-e tracking numbers. Up to 100 in each request. | Conditional | | `Type` | String | The shipment direction: **inbound** | Yes | * Supported tracking states include *in transit, delivered, returned to sender*, etc. * Merchants can configure automated refund triggers based on these statuses. **Double Refund Prevention** If both Global-e and the Return Provider (or the merchant directly in Shopify) trigger refunds, a **double refund** may occur. To prevent this: * Refund automation should exist **only on one side** (Global-e or Return Provider). * Coordination between Global-e, the Return Provider, and the merchant is required before enabling automated refunds. **Notifications and Emails** Refund and RMA-related email notifications can be sent either by Global-e or by the Return Provider, depending on merchant preference. **Global-e Notifications** * Global-e can automatically send RMA confirmation emails to shoppers. * If the merchant prefers Global-e to send these, no additional configuration is required. **Return Provider Notifications** * If the Return Provider manages customer communication, to avoid duplicate notifications, **Global-e’s email notifications must be disabled**. **Disabling Global-e Notifications** To disable email notifications on Global-e’s side: 1. The merchant (or partner) must open a **support ticket** with Global-e. 2. **Specify** which notifications should be disabled (refund configuration, RMA confirmation, etc). 3. Global-e will update the merchant configuration accordingly. ### Even Exchanges **Supported Exchange Scenario** Global-e supports **even exchanges (Variant-exchange) only**: * No refunds or additional charges are allowed. * Shipping fees cannot be collected or refunded. * All shipping costs and any duty/tax adjustments are absorbed by the merchant as part of the service. **Exchange Flow** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-48fba259-d9ec-9936-b088-78d18082c4b3.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=3993aeed180c4965528c913a35e5e5f4) 1. **Shopper initiates an exchange** 1. Shopper enters order details in the return provider’s portal. 2. After fetching order details from Shopify, the return provider validates whether the order is **Global-e operated.** * `"merchant_of_record_app_id": 5806573` > [!NOTE] > > For testing environment use `“merchant_of_record_app_id": 5806443)` * If you do not have the `"merchant_of_record_app_id"` attribute, you can fallback to using Global-e OrderID. Each `OrderId`, string, has prefix `GE` followed by numbers, in the format `GE1234`. 2. **Shopper selects items to be replaced** * Shopper selects the items to be replaced and provides return reasons in the return provider’s portal. 3. **Return shipping options** * The return provider calls [GetReturnShippingOptions](/returns-via-api#getreturnshippingoptions--merchant-to-global-e-) API to fetch available shipping options (free shipping / self postage only). * Shopper selects the return method. * The return provider provides the return label and shipping documents. > [!NOTE] > > For prepaid shipping rates, the shopper will not be charged for return shipping; it will be settled by the merchant as part of the Global-e merchant reconciliation process. 4. **Shopper selects replacement items** * The return provider queries Shopify to fetch the available replacement variants (ensuring stock availability). * The return provider displays the eligible replacement catalog to the shopper. * Shopper selects the desired replacement item/variant. * The shipping option for the exchange order will be assigned by Global-e based on the merchant’s preference. > [!NOTE] > > The shopper will not be charged this rate; it will be settled by the merchant as part of the Global-e merchant reconciliation process. 5. **Shopper confirm exchange** * Shopper confirms the exchange in the return provider’s portal. * The return provider calls [GetReturnsDocument API](/returns-via-api#getreturndocuments--merchant-to-global-e-) to fetch the return shipping documents. * The return provider creates the RMA and provides the return label and instructions to the shopper. * Shopper is sent an exchange confirmation with the return documents (this notification can also be triggered directly by Global-e and is configurable). 6. **Draft Exchange Order creation in Shopify** * The return provider creates an exchange draft order in Shopify and reserves stock if applicable. * Shopify exchange order recognition by Global-e: * Order **must not have** `"ReplacementForOrder"` note. This field will be filled by Global-e after creating the replacement order. * The order **must include** `OriginalShopifyOrderId` in `note_attributes`: ``` "note_attributes": [ { "name": "OriginalShopifyOrderId", "value": "123456789" } ] ``` 7. **RMA approval** * RMA approval logic for exchange orders is managed by the return provider. * On the return provider’s side, RMA can be approved manually (the merchant reviews and approves), or automatically in specified cases (e.g., low-value returns), or using tracking event logic. * Global-e offers a [tracking events API](/api-reference/get-tracking-events) for its carriers to support tracking-events-based RMA approval. * Once the RMA is approved, the draft exchange order needs to be converted to a regular Shopify order by the return provider. 8. **Exchange order processing** * The Shopify exchange order is recognized and processed as a Global-e replacement order. * Once the Global-e replacement order is created, Global-e updates the `ReplacementForOrder` field on the replacement order. * Replacement order is fulfilled and shipped using the recommended shipping logic. > [!WARNING] > > * Before integrating, contact your Global-e representative to ensure the merchant is properly configured in Global-e Admin. > * **Shipping recommendations** > > * **Incoming (return):** for exchanges ONLY free shipping / self-postage options should be available. > * **Outgoing (replacement):** The merchant can reuse original shipping line or use the standard shipping method. > * **Merchant responsibility** > > * Return providers must inform merchants that Global-e supports only even-value exchanges with free shipping, with any shipping or duty/tax costs covered by the merchant. # Returns Source: https://docs.global-e.com/returns-via-api Integrate Global-e return shipping options, return documents (RMA), and tracking into your own or a third-party Returns Portal. ## Overview As part of Global-e's comprehensive solution, Global-e delivers a Returns Portal branded with the merchant logo and theme as well as a unique URL to access your Returns Portal. Merchants who have their own returns portal and third-party return portals can use Global-e Return APIs to integrate functionality for Global-e return shipping options, as well as to obtain required return documents and manage tracking information. Global-e Return APIs are designed to provide a comprehensive solution for the return flow: * **GetReturnShippingOptions API** — Used to receive a list of return shipping methods available for a specific order and its associated costs. * **GetReturnDocuments API** — Used to receive return documents and related information, including the label, the tracking number, the tracking URL, the shipper's name, the commercial invoice (if relevant), the RMA number, and the return note. * **GetTrackingEvents API** — Used to receive status events on the delivery status of an order/return. For a new third-party integration please contact your representative at Global-e. ## High-level flow Following is the recommended high-level workflow for the product(s) return process. 1. Shopper initiates a return, usually using an Order ID and an Email. 2. Shopper selects the return product(s) and the reason(s) for his return. 3. Returns Portal calls **GetReturnShippingOptions** API to receive a list of available return shipping methods and their associated prices configured on Global-e. 4. Returns Portal displays the available return shipping methods. The return shipping price received from Global-e via the API can be overridden by the Returns Portal. 5. Additional refund/credit methods, such as store credit, can be offered to the shopper. 6. Once the shopper selects the desired return shipping method, the Returns Portal calls **GetReturnDocuments** API to generate a Global-e RMA and receive all the required return documents. Global-e returns all the required documents as a single PDF file including tracking information, if relevant. 7. Returns Portal shows a confirmation page indicating the return was issued with the documents available for download. 8. Global-e sends an RMA email — a return request confirmation email — to the shopper with the relevant documents attached. The RMA email can be disabled on the Global-e side and managed by the Returns Portal. To disable it please refer to your Global-e representative. 9. Shopper ships the return package using the return documents. 10. Optional: the Returns Portal calls the Tracking Events API to get all the tracking events for a given tracking number. (Not all returns are trackable.) 11. Based on the merchant policy, the shopper should be refunded for the returned items (after shipping cost deduction). The merchant portal can use standard Global-e functionality with web portal, pre-integrated webhooks, or Refund APIs. ## Integrated Returns Portal Following is a list of pre-integrated third party returns providers. | Returns Provider | Integrated APIs | Supported Functionalities | Further Information | | - | - | - | - | | BabackVision | GetReturnDocuments API | Returns with a single shipping method per country; free shipping cost | | | ChapsVision | GetReturnDocuments API | Returns with a single shipping method per country; free shipping cost | | | EasyCom | GetReturnDocuments API | Returns with a single shipping method per country; free shipping cost | | | Loop | GetReturnShippingOptions API, GetReturnDocuments API | Exclusive to Shopify; returns with a single shipping method per country | Loop/Global-e Integration | | ParcelLab | GetReturnDocuments API | Returns with a single shipping method per country; free shipping cost | | ## Reference > [card] [GetReturnShippingOptions](/api-reference/get-return-shipping-options) > [card] [GetReturnDocuments](/api-reference/get-return-documents) > [!NOTE] > > The GetReturnShippingOptions page also documents several standard Global-e object definitions ([`Attributes`](/api-reference/objects/attributes), [`BillingDetails`](/api-reference/objects/billing-details), [`Brand`](/api-reference/objects/brand), [`Category`](/api-reference/objects/category), [`DiscountsList`](/api-reference/objects/discounts-list), [`ShippingDetails`](/api-reference/objects/shipping-details), [`UserIdNumberType`](/api-reference/objects/user-id-number-type), [`VATRateType`](/api-reference/objects/vat-rate-type)). These are **shared, cross-endpoint objects** — they are **not** part of the GetReturnShippingOptions request. See the **Shared Objects** section of the API reference for their definitions. ## Use Cases A typical portal integration is a two-call flow: first **GetReturnShippingOptions** to present the available methods and costs, then **GetReturnDocuments** to generate the RMA and documents for the method the shopper chose. ### 1. Get the available return shipping options Request the shipping methods available for the order and the products being returned. ```json Request theme={null} { "ProviderCode": "ExampleProvider", "OrderId": "EUQA6215359", "Email": "shopper@example.com", "ReturnedProducts": [ { "ProductCode": "433117270672", "ReturnQuantity": 1 } ] } ``` ```json Response theme={null} { "IsSuccess": true, "Data": { "OrderId": "GE10470948238NL", "MerchantOrderId": "EUQA6215359", "ReturnShippingMethods": [ { "ShippingMethodId": 40044878, "ShippingMethodDescription": "DHL-GlobalE", "ShippingMethodType": "Express Courier (Air)", "ReturnShippingTypeId": 2, "ShipperName": "DHL", "IsQrLabel": false, "IsTrackable": true, "Cost": 0.0, "Currency": "EUR" } ], "ReturnShippingDestinationDetails": { "Country": "Netherlands", "City": "Amsterdam", "Address": "Ood 5", "Zip": "4751XK", "StateOrProvince": "", "Email": "shopper@example.com", "Phone": "310610887191" } } } ``` ### 2. Generate the RMA and return documents Once the shopper selects a method, call GetReturnDocuments (passing the chosen `ReturnShippingMethodId` / `ReturnShippingTypeId`) to generate the Global-e RMA and receive the documents. ```json Request theme={null} { "ProviderCode": "Loop", "OrderId": "GE314856569TS", "Email": "shopper@example.com", "MerchantRMANumber": "RM132", "ShippingCost": 10.0, "CurrencyCode": "USD", "ReturnShippingTypeId": 2, "ReturnShippingMethodId": null, "ReturnedProducts": [ { "ProductCode": "DKB500680.M8", "CartItemId": null, "ReturnQuantity": 1, "MerchantReturnReasonCode": "", "MerchantReturnReasonDescription": "Return Reason from GRD request for product 1" }, { "ProductCode": "B7ECS.C8", "CartItemId": 1, "ReturnQuantity": 1, "MerchantReturnReasonCode": "TTT", "MerchantReturnReasonDescription": "Return Reason from GRD request for product 2" } ] } ``` ```json Response theme={null} { "IsSuccess": true, "Data": { "OrderId": "GE314856569TS", "MerchantOrderId": "314856569", "GlobaleRmaNumber": "371104", "ReturnTrackingDetails": { "TrackingNumber": "1ZXXXXXXXXXXXXXXXX", "TrackingURL": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1ZX&requester=ST/", "IsQrLabel": "false", "IsTrackable": true }, "ReturnDocuments": [ { "DocumentTypeCode": "ShippingLabel", "DocumentTypeName": "Shipping Label", "DocumentData": "AQCkosNhECNeAACYzH/NIA5NgtHU2QAAAABJRU5ErkJggg==", "URL": "https://[MerchantDomain]/url" } ] } } ``` ## Error Codes When calling the APIs, the following error codes may be returned. ### GetReturnShippingOptions — Error Codes | Code | Message | | - | - | | `E01` | Could not find an available shipping method (No shipping method was found for the submitted products and quantities) | | `E02` | Return is not allowed due to order status %Order Status% (Relates to Allowed Return Statuses) | | `E03` | Order ID not found (Returned if the provided OrderId cannot be found for the merchant) | | `E04` | Currency is not valid | | `E05` | There are multiple orders with this orderID %orderID% | | `E06` | The ReturnShippingMethodId %ReturnShippingMethodId% is not valid | | `ME01` | Input value for ProductCode is not valid | | `ME02` | Input value for CartItemId is not valid | | `ME03` | Input value for ReturnQuantity is not valid | | `ME06` | Input value for OrderId is not valid | | `ME07` | Input value for Email is not valid | | `ME09` | Input value for ReturnedProducts is not valid | | `ME10` | Input value for CultureCode is not valid | | `ME12` | Input value for CurrencyCode is not valid | | `ME13` | Input value for ProviderCode is not valid | | `SME15` | Input value for ReturnShippingMethodId is not valid | ### GetReturnShippingOptions — Product Errors | Code | Message | | - | - | | `PE01` | Unable to process this request as the returns period has expired for product %Product% (Global-e can enable the PE01 error, and whether to enable validation for expired return periods, through configuration) | | `PE02` | Return product %Product% was not found for order | | `PE03` | Product %Product% is not returnable | | `PE04` | Requested return product quantity was not delivered to customer %Customer% | | `PE05` | Requested return product is virtual (\{0}) | | `PE06` | Requested return product contains dangerous goods (\{0}) | | `PE07` | Requested return product quantity is zero (\{0}) | | `PE08` | OrderProduct was not found for requested return product (\{0}) | | `PE09` | Child return product was requested without parent product (\{0}) | | `PE10` | Order product delivery quantity is zero (\{0}) | | `PE11` | Order product unit sale price is zero (\{0}) | | `PE13` | Return products collection has duplication | | `PE14` | Return products collection is empty | ### GetReturnDocuments — Error Codes | Code | Message | | - | - | | `E01` | Could not create the shipping label. (Note: Not applicable to the self-postage option.) | | `E02` | The return is not allowed due to the order status (\{0}) (Global-e can enable the E02 error code and validate the order status through configuration.) | | `E03` | The Order ID was not found | | `E04` | There is already an RMA request for this order (\{0}) | | `E07` | The return is not allowed due to the parcel status (\{0}). | | `E08` | Unable to find the shipping method for the provided return shipping method Id (\{0}) | | `E09` | The provided ReturnShippingTypeId is not valid (\{0}) | | `E10` | There are multiple orders with this Order ID (\{0}) | | `E11` | No shipping options were found for the order return (\{0}) | | `E12` | The return shipping address was not found for order (\{0}) | | `E13` | Invalid currency code for the provided shipping cost for order (\{0}) | | `E14` | The return shipping cost cannot be a negative number | | `E15` | The return shipping cost is greater than the return product price | | `E16` | Return address country code is not valid | | `E17` | Return address state code is not valid or does not belong to the country | | `E18` | Return address country is not allowed for given order | | `E19` | MerchantRMANumber is required | | `E20` | ReturnShippingMethodId is required for provider (\{0}) | ### GetReturnDocuments — Product Errors | Code | Message | | - | - | | `PE01` | Unable to process this request as the returns period has expired for product %Product% (Global-e can enable the PE01 error, and whether to enable validation for expired return periods, through configuration) | | `PE02` | Return product %Product% was not found for order | | `PE03` | Product %Product% is not returnable | | `PE04` | Requested return product quantity was not delivered to customer %Customer% | | `PE05` | Requested return product is virtual (\{0}) | | `PE06` | Requested return product contains dangerous goods (\{0}) | | `PE07` | Requested return product quantity is zero (\{0}) | | `PE08` | OrderProduct was not found for requested return product (\{0}) | | `PE09` | Child return product was requested without parent product (\{0}) | | `PE10` | Order product delivery quantity is zero (\{0}) | | `PE11` | Order product unit sale price is zero (\{0}) | | `PE13` | Return products collection has duplication | | `PE14` | Return products collection is empty | ### GetReturnDocuments — Model Validation Errors | Code | Message | | - | - | | `ME01` | The input value for ProductCode is Invalid | | `ME02` | The input value for CartItemId is Invalid | | `ME03` | The input value for ReturnQuantity is Invalid | | `ME04` | The input value for MerchantReturnReasonCode is Invalid | | `ME05` | The input value for MerchantReturnReasonDescription is Invalid | | `ME06` | The input value for OrderId is Invalid | | `ME07` | The input value for Email is Invalid | | `ME08` | The input value for ReturnShippingTypeId is Invalid | | `ME09` | The input value for ReturnedProducts is Invalid | | `ME10` | The input value for CultureCode is Invalid | | `ME11` | The input value for MerchantRMANumber is Invalid | | `ME12` | The input value for CurrencyCode is Invalid | | `ME13` | The input value for ProviderCode is Invalid | | `ME14` | The input value for ShippingCost is Invalid | | `ME15` | The input value for ReturnShippingMethodId is Invalid | | `ME16` | Input value for ReturnAddress.CompanyName is required | | `ME17` | Input value for ReturnAddress.FirstName is required | | `ME19` | Input value for ReturnAddress.City is required | | `ME20` | Input value for ReturnAddress.PostalCode is required | | `ME21` | Input value for ReturnAddress.CountryCode is required | | `ME22` | Input value for ReturnAddress.CompanyName exceeds the 100-character limit | | `ME23` | Input value for ReturnAddress.FirstName exceeds the 500-character limit | | `ME24` | Input value for ReturnAddress.LastName exceeds the 500-character limit | | `ME25` | Input value for ReturnAddress.Email exceeds the 500-character limit | | `ME26` | Input value for ReturnAddress.Phone1 exceeds the 50-character limit | | `ME27` | Input value for ReturnAddress.Phone2 exceeds the 50-character limit | | `ME28` | Input value for ReturnAddress.Fax exceeds the 50-character limit | | `ME29` | Input value for ReturnAddress.City exceeds the 100-character limit | | `ME30` | Input value for ReturnAddress.StateOrProvince exceeds the 100-character limit | | `ME31` | Input value for ReturnAddress.StateCode exceeds the 10-character limit | | `ME32` | Input value for ReturnAddress.PostalCode exceeds the 50-character limit | | `ME33` | Input value for ReturnAddress.CountryCode exceeds the 2-character limit | # RMA Notifications (Global-e to Merchant) Source: https://docs.global-e.com/rma-notifications--from-global-e- Global-e sends the RMA number and return details to the merchant via the SendRMAInfoMerchant API. Send Return Merchandise Authorization (RMA) to the merchant. Global‑e calls this API after a customer generates a label from the Return Portal. This API streamlines the refund process for merchants. Merchants can initiate refunds directly from the Shopify Admin. Supports Shopify's ability to get the return shipping fee when creating a return in their system. ## Reference > [card] [Send RMA Info Merchant — full request & response](/api-reference/send-rma-info-merchant) > > Parameters, schema, examples for `POST /rma-info-to-merchant-url` (merchant-hosted). # RMA Variables & Events Source: https://docs.global-e.com/rma-variables---events The Returns portal uses RMA events and variables to automate and personalize email and SMS notifications. You can trigger notifications based on actions, such as request approved or shipment received, and personalize the content using variables such as RMA ID, order status, and rejection reason. You can open the Variables and Events page by clicking the lighting bolt icon on the email content page. From here you can view all available options. If you have a marketing integration such as Klaviyo, RMA events can also be used to trigger notifications sent through the third-party platform. ## Events The Returns portal events can be used as triggers to automatically send certain notifications when a specific event happens, such as when a request is approved or a shipment is received. ### Returns Events Supported return events include: > [card] > > * **Pending Approval** - The return request is pending approval on the Returns portal. > * **Request Approved** - The return request has been approved. > * **Request Rejected** - The return request has been rejected. > * **Request Canceled** - The return request has been canceled. > * **Request Reopened** - The return request was canceled and has been reopened. > [card] > > * **Order Canceled** - The order has been canceled. > * **Shipment Received** - The return shipment has been received. > * **Shipment In-Transit** - The return shipment is on its way. > * **Manual Credit** - Store credit has been issued to the customer. > * **Manual Gift Card** - A gift card has been issued to the customer. ### Tracking Events Supported tracking events include: > [card] > > * **Order In transit** - Order is in transit. > * **Order waiting for pickup** - Order is waiting for pickup. > * **Order out for delivery** - Order is out for delivery. > [card] > > * **Order ready for collection** - Order is ready for collection. > * **Order delivered** - Order was delivered. > * **Order failure to deliver** - Order failed to deliver. ## Variables Adding variables to your notifications personalizes the information provided, such as adding the RMA ID or reject reason directly into the message. ### Returns Variables | `rma_id` | The ID number of the customer's return request. | | - | - | | `payment_authorization_expiration_date` | Date of charge of authorized amount. | | `rma_created_at` | RMA created date. | | `rma_status` | The status of the return request. | | `order_name` | The ID number of the customer's order. | | `first_name` | The customer's first name. | | `last_name` | The customer's last name. | | `full_name` | The customer's full name. | | `store_name` | The name of your online store. | | `store_url` | The link to your online store. | | `reject_reason` | The reason the return request was rejected. | | `cancel_reason` | The reason the return request was canceled. | | `expire` | The remaining time before a gift card or store credit expires. | | `credits` | The amount of store credit the customer has in their balance. | | `payment_currency_code` | The currency used to pay for the order. | | `customer_support_url` | The link for contacting your customer support. | | `carrier_location_name` | The name of the drop-off location. | | `refund_provider` | The entity that issues the refund. | | `tracking_number` | The number used to track the return shipment. | | `tracking_link` | Shipment tracking URL. | | `expected_delivery_date` | The date the delivery is expected to arrive. | | `shipping_date` | The date the shipping label was created. | | `return_label_url` | Shipping label URL. | | `packing_slip_url` | Packing slip URL. | | `qr_code_link` | QR code URL. | | `return_method` | Return method name (internal). | | `return_type` | Return type (Return / Exchange / Mixed). | | `gift_card_code` | Generated gift card code, when applicable. | | `portal_name` | The name of the relevant portal, as it appears in the portal selector. | ### Tracking Variables | `order_name` | The ID number of the customer's order. | | - | - | | `first_name` | The customer's first name. | | `last_name` | The customer's last name. | | `full_name` | The customer's full name. | | `store_name` | The name of your online store. | | `store_url` | The link to your online store. | | `customer_support_url` | The link for contacting your customer support. | | `order_tracking_number` | Order tracking number. | | `portal_tracking_url` | Portal tracking URL. | | `unsubscribe_link` | Tracking unsubscribe link. | | `status_description` | Description of the main tracking status sub-status. | | `estimated_delivery_date` | Order estimated delivery date. | | `carrier_name` | Carrier for this delivery. | # RMA Variables & Events Source: https://docs.global-e.com/rma-variables---events-702385 The Returns portal uses RMA events and variables to automate and personalize email and SMS notifications. You can trigger notifications based on actions, such as request approved or shipment received, and personalize the content using variables such as RMA ID, order status, and rejection reason. You can open the Variables and Events page by clicking the lighting bolt icon on the email content page. From here you can view all available options. If you have a marketing integration such as Klaviyo, RMA events can also be used to trigger notifications sent through the third-party platform. ## Events The Returns portal events can be used as triggers to automatically send certain notifications when a specific event happens, such as when a request is approved or a shipment is received. ### Returns Events Supported return events include: > [card] > > * **Pending Approval** - The return request is pending approval on the Returns portal. > * **Request Approved** - The return request has been approved. > * **Request Rejected** - The return request has been rejected. > * **Request Canceled** - The return request has been canceled. > * **Request Reopened** - The return request was canceled and has been reopened. > [card] > > * **Order Canceled** - The order has been canceled. > * **Shipment Received** - The return shipment has been received. > * **Shipment In-Transit** - The return shipment is on its way. > * **Manual Credit** - Store credit has been issued to the customer. > * **Manual Gift Card** - A gift card has been issued to the customer. ### Tracking Events Supported tracking events include: > [card] > > * **Order In transit** - Order is in transit. > * **Order waiting for pickup** - Order is waiting for pickup. > * **Order out for delivery** - Order is out for delivery. > [card] > > * **Order ready for collection** - Order is ready for collection. > * **Order delivered** - Order was delivered. > * **Order failure to deliver** - Order failed to deliver. ## Variables Adding variables to your notifications personalizes the information provided, such as adding the RMA ID or reject reason directly into the message. ### Returns Variables | `rma_id` | The ID number of the customer's return request. | | - | - | | `payment_authorization_expiration_date` | Date of charge of authorized amount. | | `rma_created_at` | RMA created date. | | `rma_status` | The status of the return request. | | `order_name` | The ID number of the customer's order. | | `first_name` | The customer's first name. | | `last_name` | The customer's last name. | | `full_name` | The customer's full name. | | `store_name` | The name of your online store. | | `store_url` | The link to your online store. | | `reject_reason` | The reason the return request was rejected. | | `cancel_reason` | The reason the return request was canceled. | | `expire` | The remaining time before a gift card or store credit expires. | | `credits` | The amount of store credit the customer has in their balance. | | `payment_currency_code` | The currency used to pay for the order. | | `customer_support_url` | The link for contacting your customer support. | | `carrier_location_name` | The name of the drop-off location. | | `refund_provider` | The entity that issues the refund. | | `tracking_number` | The number used to track the return shipment. | | `tracking_link` | Shipment tracking URL. | | `expected_delivery_date` | The date the delivery is expected to arrive. | | `shipping_date` | The date the shipping label was created. | | `return_label_url` | Shipping label URL. | | `packing_slip_url` | Packing slip URL. | | `qr_code_link` | QR code URL. | | `return_method` | Return method name (internal). | | `return_type` | Return type (Return / Exchange / Mixed). | | `gift_card_code` | Generated gift card code, when applicable. | | `portal_name` | The name of the relevant portal, as it appears in the portal selector. | ### Tracking Variables | `order_name` | The ID number of the customer's order. | | - | - | | `first_name` | The customer's first name. | | `last_name` | The customer's last name. | | `full_name` | The customer's full name. | | `store_name` | The name of your online store. | | `store_url` | The link to your online store. | | `customer_support_url` | The link for contacting your customer support. | | `order_tracking_number` | Order tracking number. | | `portal_tracking_url` | Portal tracking URL. | | `unsubscribe_link` | Tracking unsubscribe link. | | `status_description` | Description of the main tracking status sub-status. | | `estimated_delivery_date` | Order estimated delivery date. | | `carrier_name` | Carrier for this delivery. | # Rotating Your Merchant GUID Source: https://docs.global-e.com/rotate-merchant-guid-bigcommerce Follow these steps to rotate your Merchant GUID on BigCommerce. All steps start in your store admin. > [!NOTE] > > **Before you start** > > * Have your new Merchant GUID to hand. > * Your Merchant ID does not change. > * Questions? Contact your Global-e account manager. ## Steps **1. Open your store admin** Navigate to your store admin. **2. Open the Global-e app** Navigate to **Apps → Global-e**. **3. Change the GUID** On the **Global-e Configuration** screen, change to your new GUID. ## Need help? Contact your Global-e account manager. See also [API Authentication](/api-authentication). # Rotating Your Merchant GUID Source: https://docs.global-e.com/rotate-merchant-guid-magento2-lite Follow these steps to rotate your Merchant GUID on Magento 2 (M2L). All steps start in your store admin. > [!NOTE] > > **Before you start** > > * Have your new Merchant GUID to hand. > * Your Merchant ID does not change. > * Questions? Contact your Global-e account manager. ## Steps **1. Open your store admin** Navigate to your store admin. **2. Open the Services configuration** Navigate to **Stores → Configuration → Services**. **3. Switch the GUID** Under **Global-e Cross-Border**, open **Global-e API Settings** and switch your GUID. ## Need help? Contact your Global-e account manager. See also [API Authentication](/api-authentication). # Rotating Your Merchant GUID Source: https://docs.global-e.com/rotate-merchant-guid-sfcc Follow these steps to rotate your Merchant GUID on SFCC. Production and Staging are rotated separately, and Staging has additional steps. > [!NOTE] > > **Before you start** > > * Have your new Merchant GUID to hand. > * Your Merchant ID does not change. > * Questions? Contact your Global-e account manager. ## Production **1. Open the Global-e site preferences** Open **Merchant Tools > Site Preferences > Custom Preferences > GLOBALE**. **2. Update the Merchant GUID** Update **Merchant GUID** (`geMerchantGuid`) with the new GUID. **3. Save** Save. **4. Repeat per site** Repeat for **every Global-e-operated site** on the instance — Site Preferences are set per site. The following figure shows the **Merchant GUID** (`geMerchantGuid`) field under **Custom Site Preference Groups**: ![SFCC Global-e Settings page, showing the Merchant GUID (geMerchantGuid) field in the Custom Site Preference Groups list, with the Instance Type set to Production.](https://mintcdn.com/globale-enterprise/Vszw84pzA-THld0t/images/knowledge-hub/rotate-guid/sfcc-01-site-preferences-gemerchantguid.png?fit=max\&auto=format\&n=Vszw84pzA-THld0t\&q=85\&s=0290d1b06fdf1e0e46eb6241410c3d72) ## Staging Follow the same process as Production, then complete the additional steps below. **1. Check the GlobaleProducts job** Open **Administration → Operations → Jobs** and check whether the `GlobaleProducts` job exists and is enabled. **2. Follow the branch that matches what you found** Use the decision list below. ### If the job exists and is enabled Which of the two locations holds the GUID depends on your cartridge version. **Old versions of the Global-e SFCC cartridges** — open the job's **step configuration** and update the **Merchant GUID** parameter with the new GUID. The following figure shows the `LoadRecentProductCountryS` step configuration, with the `geMerchantGuid` parameter: ![The GlobaleProducts job in SFCC, on the Job Steps tab, with the LoadRecentProductCountryS step open and its geMerchantGuid parameter highlighted.](https://mintcdn.com/globale-enterprise/Vszw84pzA-THld0t/images/knowledge-hub/rotate-guid/sfcc-02-job-steps-loadrecentproductcountrys.png?fit=max\&auto=format\&n=Vszw84pzA-THld0t\&q=85\&s=549ddade678a6a36d60120d260a64c7d) **New versions of the Global-e SFCC cartridges** — check whether the SFCC service credential with ID `Globale-RecentProductCountryS` exists. If it does, open it and update the **Password** field with the new Merchant GUID. The following figure shows the `Globale-RecentProductCountryS` row under **Service Credentials**: ![SFCC Service Credentials list, showing the Globale-RecentProductCountryS row and its URL.](https://mintcdn.com/globale-enterprise/Vszw84pzA-THld0t/images/knowledge-hub/rotate-guid/sfcc-03-service-credentials-list.png?fit=max\&auto=format\&n=Vszw84pzA-THld0t\&q=85\&s=9b8dcb03ad4e336cc1b09dcd3e141d11) The following figure shows the **Password** field on that credential: ![The Globale-RecentProductCountryS credential detail page, showing the Password field that holds the Merchant GUID.](https://mintcdn.com/globale-enterprise/Vszw84pzA-THld0t/images/knowledge-hub/rotate-guid/sfcc-04-credential-password-field.png?fit=max\&auto=format\&n=Vszw84pzA-THld0t\&q=85\&s=05ed82b55654e5b228081d6c3707cb64) > [!TIP] > > If the job is enabled, one of the two locations above will contain the current Production GUID. Update it accordingly. It is also recommended to verify whether the `GlobaleProducts` job is enabled in **SFCC Production**, as some older merchants have this job enabled in Production. ### If the job is missing or disabled No changes to the `GlobaleProducts` job are required. ## Need help? Contact your Global-e account manager. See also [API Authentication](/api-authentication). # Rotating Your Merchant GUID Source: https://docs.global-e.com/rotate-merchant-guid-shopify-native Follow these steps to rotate your Merchant GUID on Shopify Native. All steps start in your store admin. > [!NOTE] > > **Before you start** > > * Have your new Merchant GUID to hand. > * Your Merchant ID does not change. > * Questions? Contact your Global-e account manager. ## Steps **1. Open the Global-e app** Navigate to **Apps → Global-e CrossBorder** on your store admin. **2. Find your current details** Under **Account Settings**, find your **Merchant ID** and **Merchant GUID**. **3. Switch the GUID** Switch the **Merchant GUID** to your new GUID. **4. Save** Save the app and wait for approval. **5. Force a cache refresh** Under **Global-e CrossBorder**, navigate to **Settings**. Search for **Invalidate Cache** and select **Force cache refresh**. ## Need help? Contact your Global-e account manager. See also [API Authentication](/api-authentication). # Rotating Your Merchant GUID Source: https://docs.global-e.com/rotate-merchant-guid-shopware Follow these steps to rotate your Merchant GUID on ShopWare. All steps start in your store admin. > [!NOTE] > > **Before you start** > > * Have your new Merchant GUID to hand. > * Your Merchant ID does not change. > * Questions? Contact your Global-e account manager. ## Steps **1. Open your store admin** Navigate to your store admin. **2. Open your extensions** Navigate to **Extensions → My Extensions**. **3. Configure the extension** Find **Global-e Cross-Border** and press **Configure**. **4. Update the GUID** Under **Global-e API Settings**, update the **Merchant GUID**. ## Need help? Contact your Global-e account manager. See also [API Authentication](/api-authentication). # Rotating Your Merchant GUID Source: https://docs.global-e.com/rotate-merchant-guid-woocommerce Follow these steps to rotate your Merchant GUID on WooCommerce. All steps start in your store admin. > [!NOTE] > > **Before you start** > > * Have your new Merchant GUID to hand. > * Your Merchant ID does not change. > * Questions? Contact your Global-e account manager. ## Steps **1. Open your store admin** Navigate to your store admin. **2. Open the Integration settings** Navigate to **WooCommerce → Settings**, then open the **Integration** section. **3. Set the new GUID** Under **Global-e Cross-Border Integration**, set the **GUID** field to your new GUID. ## Need help? Contact your Global-e account manager. See also [API Authentication](/api-authentication). # Sales & Funnel Source: https://docs.global-e.com/sales---funnel In the **Sales & Funnel** platform each of these dashboards is designated its own separate sheet. The Sales & Funnel documentation is divided as follows: * **[Sales](/sales---funnel#sales)** - functionality unique to Sales * **[Funnel Analytics](/sales---funnel#funnel-analytics)** - functionality unique to Funnel Analytics Importantly, you can easily switch between sheets using the sheet toggle arrows: ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-71661530-75d3-f747-6953-3314ff9548c9.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=abbb5a46f39fb613815495157eb00479) Any settings or selections you used are automatically saved in each sheet, so you can toggle back and forth between sheets. The platform restores sheets to their default settings when you exit or refresh the screen, so make sure to create bookmarks to save your page settings. You can also toggle between sheets by clicking Sheets and selecting a sheet, as follows: ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-f806de7c-e32c-7389-1735-04313a0baaf6.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=a69592de2f395b4d6fe029a1d83949ba) ## Sales The **Sales** sheet displays sales-related metrics. The Sales sheet includes the following main areas, each discussed in greater detail in its own section: > [card] > > * [Business Metrics panel](/sales---funnel#business-metrics-panel) > * [Net Sales by Destination Country](/sales---funnel#net-sales-by-destination-country) > * [% Orders by AOV Class graph](/sales---funnel#percentage-of-orders-by-aov-class) > [card] > > * [Historical Trend graph](/sales---funnel#historical-trend-graph) > * [Chart Exploration table](/sales---funnel#chart-exploration-table---net-sales) ### Business Metrics Panel The following figure shows the Business Metrics Panel for Sales: ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d30a4c88-6d2c-c35b-97c1-f94733e6087f.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=58a26b3de0250ac15ea597cd5ba96f9d) All of the business metrics correspond to the selected country and date range. The default date range selection is year-to-date. The Business Metrics panel shows the following metrics (hovering over each business metrics shows its description): * **Net sales** - Total products sales price excludes discounts. The **% change of net sales** value is located under Net sales. This value indicates the change in percentage of net sales between the previous and current period. Green text indicates positive change, while red indicates negative. * **Checkout sessions** - Total number of Checkout sessions. * **Site CVR% (Conversion Rates)** - Total transactions divided by browsing sessions. * **AOV (Average Order Value**) - Net sales divided by number of approved orders. The **% change of AOV** value is located under AOV. This value indicates the change in AOV percentage between the previous and current period. Green text indicates positive change, while red indicates negative. * **Orders** - Total number of approved orders. The **% change orders** value is located under Orders. This value indicates the change in percentage of orders between the previous and current period. Green text indicates positive change, while red indicates negative. ### Net Sales by Destination Country The **Net Sales by Destination Country** is a scrollable, zoomable map. The following figure shows the Net Sales by Destination Country: ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3d71bd50-b090-2a66-da4c-18f3b6397dc6.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=2f54c1180268b370b867136b94275c0d) From here you can select a country or countries from the map. Hovering over countries displays a pop-up tooltip with additional country information according to your selection. ### Percentage of Orders by AOV Class The **Orders by AOV Class** is a histogram that shows the percentage of orders according to **Average Order Value (AOV)** class. You can change the AOV interval by selecting the AOV interval filter within the chart area. The following figure shows the Orders by AOV Class graph: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2e9e0a6d-7bed-9035-eff8-d681e80fa7e1.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=3349225a3f5df2fbef171a73e1c393a6) ### Historical Trend Graph The Historical Trend Graph shows the trend of *net sales*, *orders*, or *AOV* for the current period. You can change the resolution, set to **Monthly** by default, from the menu located at the bottom of the graph. You can also switch the measure between these three by clicking one of the toggles located at the top of the graph. In addition, you can show or hide the previous year comparison by clicking Hide/Show Comparison in the top right corner of the graph. Regardless, hovering over a data point shows the period and the amount. The following figure shows the Historical Trend Graph: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8bd4d433-cb55-c78f-b6f3-5b76a0d52069.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=2eb47ed4cf7351902eb99cfbc6b86695) Clicking a specific data point, such as **February 1** for example, filters the entire dashboard for that point, adding it to the Selection Panel. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-88c25aa3-b619-8712-ae1f-d46a78e59471.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=7326e7ec5637396cf98b66d7a3815fcf) You can also select a number of data points at a time using the Lasso option to draw a line around them. To show the lasso option, click any data point on the graph, which shows four additional functions in the top right corner of the graph: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8c9247f7-9923-f484-3526-1ea1ee30f5e3.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=dab610254af88e610ac2cef52b97ad5c) Using the lasso option calculates the sum of these points and displays their corresponding data in the **Chart Exploration table**, described in [Chart Exploration Table - Net Sales](#chart-exploration-table---net-sales). > [!NOTE] > > Once you've selected a number of points with the lasso option, separately adding more points *adds* their sum to the current selection, and *does not replace it* with the newly selected points. To cancel your current selection and start over, click the Cancel Selection button in the top right corner with the other features. You can clear the data you selected and draw a line around different points using Clear selection located directly to its right. You can cancel the lasso option and return to the default cumulative view by clicking Cancel selection to the right of that. Finally, you can isolate the selected points by clicking Confirm selection. When you've isolated points and want to restore the entire graph, close the Month tile in the Selection Panel: ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f570212e-10b7-eb91-c293-e671f8c50bf6.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=0fe10817c69402310b69073d75d587b6) ### Chart Exploration Table - Net Sales The **Chart Exploration Table** for Sales displays all sales business metrics broken down according to country: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-14da1d53-0051-7409-0689-2da7f9affc6b.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=4615c3a54aece8d850e4a7db0b6e1337) You can customize your table by selecting metrics or dimensions from the **Chart exploration** region located directly to the left of the chart region. ## Funnel Analytics The Funnel Analytics sheet includes the following main areas, each discussed in greater detail in its own section: > [card] > > * [Business Metrics Panel](/sales---funnel#business-metrics-panel-1) > * [Top Ten Destination Country by Net Sales](/sales---funnel#top-ten-destination-countries-by-net-sales) > * [Top Ten Destination Countries Graph](/sales---funnel#top-ten-destination-countries-graph) > [card] > > * [Conversion Trend Graph](/sales---funnel#conversion-trend-graph) > * [Chart Exploration Table - Conversions](/sales---funnel#chart-exploration-table---conversions) ### Business Metrics Panel The following figure shows the **Business Metrics Panel** for Funnel Analytics: ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f1eb46bc-1ea7-0f87-eddf-ead207277b38.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=e91b0e113d5fc7c8ac39ff0e8de06744) The Business Metrics panel shows the following metrics (hovering over each business metrics shows its definition or description): * **Site CVR** - Total transactions divided by browsing sessions * **Browsing to Checkout CVR** - Total checkout sessions divided by browsing sessions * **Checkout CVR%** - Total checkout transactions divided by checkout sessions * **Browsing Sessions** - Total number of Browsing Sessions * **Checkout Sessions** - Total number of Checkout Start events > [!NOTE] > > The full data set is available only to merchants that provide site event collection. For more information, contact your CSM. ### Top Ten Destination Countries by Net Sales The **Top 10 Destination Countries by Net Sales** bubble chart is a graph that shows the relationship between the **browsing to checkout CVR percentage** and the **checkout CVR percentage** for the top ten destination countries according to their net sales. The following figure shows the Top Ten Destination Countries by Net Sales: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-15ac60fb-934f-00a2-d463-bad34cac7ae8.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=c03b40cea8f944bd378aeb7fb0c9aa48) Hovering over a data point shows the following details: the total browsing to checkout CVR percentage, the checkout CVR, and the net sales. ### Top Ten Destination Countries Graph The Top Ten Destination Countries is a graph that shows all three CVR metrics for the top ten destination countries sorted by the selected metric. These graphs let you compare the top ten markets according to **Checkout CVR percentage,** **Site CVR percentage**, and **Browsing to Checkout CVR percentage**. You can toggle between these metrics by selecting one from the top row of the graph: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-303f4222-971b-7d90-e3dc-e475203a716f.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=c1a11ede714aaa7e73b9986d6ac4a4e5) Hovering over a bar shows the funnel tooltip, which indicates the percentage breakdown according to **browsing**, **checkout**, and **transactions** for the specific country in the graph: ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a4708c50-7303-a25c-e2e6-8aebcba1f4f4.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=8ce81e956fb7adf02c1af45de52c0651) ### Conversion Trend Graph The Conversion Trend Graph shows the trend of *checkout CVR percentage*, *site CVR percentage*, or *browsing to checkout CVR percentage* for the selected period. You can change the resolution, set to Monthly by default, from the menu located at the bottom of the graph. You can also switch the measure between these three by clicking one of the toggles located at the top of the graph. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4d43d360-e7a9-edb4-2ee7-5fa89248f501.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=671ea5caa00aa038de77718a887f2d4f) ### Chart Exploration Table - Conversions The **Chart Exploration Table for Funnel Analytics** displays all Funnel business metrics broken down by country: ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-590f696f-d2fe-e0fa-7be3-06f1f8b559d5.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=1ac8075f6fc780639241f352432a59a5) # SDK and API Source: https://docs.global-e.com/sdk-and-api The Global‑e API enables developers to connect their systems with Global‑e's infrastructure, facilitating various e-commerce functionalities. The API allows you to access and manage Global‑e's features, such as currency conversion, localized pricing, international shipping options, tax calculation, and duty estimation. It also provides tools for managing orders, tracking shipments, and handling returns and refunds. The Global‑e SDK, on the other hand, is a set of software development tools, libraries, and documentation that assists developers in integrating Global‑e's services into their applications more easily. The SDK typically includes pre-built functions and modules that abstract away the underlying complexities of the API integration, simplifying the development process. By leveraging the Global‑e API and SDK, retailers can expand their e-commerce reach to international markets, offering localized shopping experiences, streamlined shipping and logistics, and transparent pricing and taxation for customers around the world. > [!NOTE] > > For information about Shopify, see [**Shopify Native**](/shopify-native). ## Global-e Client SDK The Global-e Client SDK provides a range of features designed to enhance international checkout experiences for merchants. Here is a brief summary of its key features: * **Popup Management**: Handles welcome popups and shipping/currency switchers. * **Checkout Integration**: Manages the checkout iframe for seamless transactions. * **Analytics and Event Tracking**: Tracks customer activity and integrates with analytics frameworks like Google Analytics. * **Cookie and Consent Management**: Manages cookies and user consent to comply with privacy regulations. * **Settings Management**: Only exposes necessary client settings, ensuring security and performance. * **Express Payment Integration**: Supports express payment buttons and integrates with payment services like PayPal. (Platform specific) * **Dynamic Configuration**: Allows per country and merchant configurations, with feature flags for customization. (i.e.., Conversion settings: Rounding rules, fixed FX rates, fixed prices, etc.) # Sending Bulk Emails Source: https://docs.global-e.com/sending-bulk-emails Send CS (bulk) emails to multiple addressees in a single API call by providing order IDs, an email type, and optional placeholders. ## Sending Bulk Emails (Merchant to Global-e) Emails can now be sent to multiple addresses by issuing an API call providing order IDs and the email message type. Additionally, placeholders can be added to the mail message to dynamically add details to the email message content without code changes. This API provides the following: * Allow the merchant to send CS emails (Bulk Emails) on a single API by providing a list of order IDs * Allow the merchant to specify the email address for sending the processing report * Allow merchant the option to specify the return address, default as configured for CS/FinOps * Monitor and log merchant actions * Store the action results report for performance and success level measurements. * Customize the email message template for full merchant customizations and look & feel ## Prerequisites The following is to be prepared Before issuing the API: * Select the **email type** and verify its template, from the existing types, or ask your CSM to create a template. * Specify the **placeholders'** name and value, if you plan to add them to the email message. * List the **Order ID**s that are the addressees of this mail. > [!NOTE] > > A text resource value refers to predefined placeholders and their related values. The placeholders and their values are defined in the Admin platform, with the prefix `TR_`. A value can be a Global-e default value or merchant-specific value. Refer to your CSM for all predefined `TR_` placeholders, and for defining merchant-specific values. > [card] [Send Bulk Emails — full request & response](/api-reference/send-bulk-emails) > > Parameters, schema, examples, error codes for `POST /emails`. ## Use Cases ### Mail Message In the following example, the Order ID is integrated into the email template, by adding the `orderId` placeholder. ![Mail message example](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/emails/mail-message-example.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=7d98bfa686ff1e4388abab7a4cb4ea24) **Note**: When sending a list of Order IDs in the API request, each mail message will have the relevant ID for the mail recipient. ### Results Report Email The following report is received detailing the result of the bulk emails API, sent to inform of a delayed fulfillment of a single order ID. ![Results report email example](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/emails/results-report-example.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=ab4e5f4563a6ccaf94ddcc5324b1e288) ### Example Request: ```json theme={null} { "emailTypeName": "Delayedfulfillment", "senderEmailAddress": "globale@global-e.com", "reportToEmailAddress": "reports@example.com", "orderIds": [ "GE399999999GB" ], "placeholders": { "{DelayReason}": "TR_OverloadDelayReason", "{DelayDaysCount}": "2" } } ``` Response: ```json theme={null} "Processing is in progress. You will get an email after the process is complete." ``` # Services configuration Source: https://docs.global-e.com/services-configuration-sfcc The Global-e cartridges use SFCC services for all API data exchange with Global-e. Outbound URL and GUID resolution is driven by **site preferences** and **merchant GUID credentials** — not per-endpoint service credentials. For the standard service list and base setup, see [Configuration](/configuration-sfcc). ## Configuration model | What | Where | Example | | - | - | - | | API base URL (per site / env) | Site pref `geApiUrl` | `https://connect.bglobale.com` | | Merchant GUID (protected) | Credential `Globale-{merchantId}` **Password** only (URL empty) | `Globale-10001` | | Service path defaults | Cartridge (`serviceEndpoints.js`) | `/Browsing/AppSettings` | | Per-service URL / GUID override | Site pref `geServiceEndpointConfig` (JSON, GLOBALE group) | See below | | SDK bootstrap | Site pref `geClientJsBaseUrl` | Unchanged | `MerchantAccount.getApiBaseUrl()` reads `geApiUrl`. `MerchantAccount.getMerchantGuid()` reads the canonical credential password. Inbound validation (`guard.js`, payload validators) always uses the canonical GUID. ## Merchant GUID credentials (required) Metadata import provides **`Globale-MerchantAccount`** (empty stub linked to service instances). **Operators must create account ID credentials** in Business Manager: | Credential ID | URL | Password | | - | - | - | | `Globale-{geClientJsMerchantId}` | Empty | Merchant GUID | Create **one row per merchant account ID** used on the instance (for example `Globale-10001` and `Globale-10002`). Match **`geClientJsMerchantId`** on each site. Set **`geApiUrl`** per site for the API environment. Optional additional credentials (password only), referenced from **`geServiceEndpointConfig`**, for cross-environment GUID overrides (for example `Globale-10001-PROD`). ## Service endpoint overrides (`geServiceEndpointConfig`) Site preference in the **Global-e Settings** (`GLOBALE`) BM group. Keys are **SFCC service IDs** (for example `Globale-RecentProductCountryS`). Values: * **String** — relative path (appended to `geApiUrl`) or full `https://` URL. * **Object** — `{ "url": "/path or https://...", "credentialId": "Globale-10001-PROD" }` when the outbound call must use an alternate protected GUID credential. When the preference is empty, cartridge defaults apply with `geApiUrl`. Example — QA site calling Production product restrictions: ```json theme={null} { "Globale-RecentProductCountryS": { "url": "https://api.global-e.com/Browsing/RecentProductCountryS", "credentialId": "Globale-10001-PROD" } } ``` Example — alternate GUID for one service on a test sandbox: ```json theme={null} { "Globale-SendCartV2": { "url": "/Checkout/SendCartV2", "credentialId": "Globale-10001-SendCartOverride" } } ``` ## Multiple Global-e accounts Set `geClientJsMerchantId` per site and create matching **`Globale-{merchantId}`** credentials (GUID only). Use `geApiUrl` per site for environment targeting (INT, QA, HF, etc.). ## Merchant GUID on API calls By default the cartridge sends the resolved GUID as the **`MerchantGUID` HTTP header** only. To force query-parameter auth for a specific service, set **`geServiceMerchantGuidAuthConfig`** — a site preference in the **Global-e Settings** (`GLOBALE`) BM group. Keys are SFCC service IDs; any service not listed keeps the default header behavior: ```json theme={null} { "Globale-SendCartV2": { "mode": "query" } } ``` > [!WARNING] > > Inbound requests do not use `geServiceEndpointConfig` credential overrides — they always validate against the canonical `Globale-{merchantId}` GUID. ## SFTP and service profiles SFTP upload credentials (`Globale-SFTPDownload`, catalog/restrictions feeds) remain separate — they are not Global-e HTTP API credentials. Service **instances** in `metadata/services.xml` still define profiles (timeout, circuit breaker, comm-log, force-prd). HTTP services reference the stub credential `Globale-MerchantAccount`; runtime code selects `Globale-{merchantId}` for GUID resolution. ## See also * [Configuration](/configuration-sfcc) — site preferences and merchant GUID credentials * [Metadata](/metadata-sfcc) — `geApiUrl`, `geServiceEndpointConfig`, `geServiceMerchantGuidAuthConfig` * [Jobs overview](/jobs-sfcc) — services used by Global-e jobs # Session Custom Attributes Source: https://docs.global-e.com/session-attributes-sfcc Global-e stores localization and mode flags on the SFCC session. The storefront extension cartridges (`int_globale_sfra`, `int_globale_sitegenesis`) copy key values to **`session.custom`** during the `onInit` hook so you can use them in Business Manager customer groups, promotions, and ISML templates. > [!NOTE] > > **Scope:** the top-level `session.custom.ge*` attributes below are written by the `globale.onInit` handler registered in `int_globale_sfra` / `int_globale_sitegenesis`. Popups-only sites and headless-only sites do not register that handler, so they do not get these attributes out of the box — add a custom `globale.onInit` handler if you need them. See also: [Customer Groups](/customer-groups-sfcc), [Cookies](/cookies-sfcc), [Customization](/customization-sfcc), [Hooks — onInit](/hooks-sfcc). ## Attributes on `session.custom` (Business Manager rules) These attributes are set when Global-e (re)initializes — on the first visit and whenever the country, currency, culture, or locale changes (not on every request). Use **`session.custom.`** in Dynamic Customer Group membership rules (see demo groups in repo `metadata/demo/demo.customergroup.xml`). | Attribute | Type | Description | Default | Sample | | - | - | - | - | - | | geCountry | String | Selected or geo-identified country ISO2 code | — | GB | | geIsOperated | Boolean | Whether the selected country is operated by Global-e | false | true | | geCurrency | String | Selected currency ISO3 code | — | GBP | | gePriceStrategy | String | Country price strategy: `FIXED` or `DYNAMIC` | DYNAMIC | FIXED | ## Additional session keys (scripts and templates) | Attribute | Type | Description | | - | - | - | | geInited | Boolean | `true` after Global-e init completed for the session; `false` when Global-e is disabled | | geAppState | String (JSON) | Serialized app state — see nested fields below | | geAppScenario | String (JSON) | Application scenario (default type `storefront`) for advanced flows | ### Fields inside `geAppState` (JSON) Read with `require('*/cartridge/models/globale/session').getAppState()` — **not** available as top-level `session.custom` paths in BM rules. | Field | Type | Description | Sample | | - | - | - | - | | geEnabled | Boolean | Site preference Global-e Enabled | true | | geCountry | String | Same as `session.custom.geCountry` | GB | | geCurrency | String | Same as `session.custom.geCurrency` | GBP | | geCulture | String | Global-e culture code for the country/locale | en-GB | | geLocale | String | SFCC request locale | en_GB | Culture and locale are persisted in `geAppState` and mirrored to the [Global-e cookie](/cookies-sfcc); they are **not** copied to `session.custom.geCulture` or `session.custom.geLocale`. ## Checking operated country in templates For ISML, the cartridges typically use the app context factory (same logic as `geIsOperated`): ```xml theme={null} ``` Alternatively, `session.custom.geIsOperated` works when set (after init): ```xml theme={null} ``` See [Customization](/customization-sfcc) for a cart-page example. # Setting Auto-Mark as Done Source: https://docs.global-e.com/setting-auto-mark-as-done Auto-mark as done marks an RMA as Done when all customer requests in the RMA are fulfilled. ## To set Auto-Mark as done 1. Complete accessing your policy rules. 2. Set **Mark as Done** to **Automatic**. 3. Click the **save icon**. > [!NOTE] > > The save icon is only displayed when you change your Approval Process selection. 4. Verify that the auto-approval update worked: 1. Navigate to **Returns and Exchanges**. 2. Search or filter for an RMA processed under the policy rule in **Step 6** of Configuring Auto-Approvals. 3. Verify that the RMA status has changed to **Done** automatically when conditions are met. # Setting Mark as Done After Partial Validation Source: https://docs.global-e.com/setting-mark-as-done-after-partial-validation Setting Mark as Done After Partial Validation is an optional configuration that marks RMAs as Done after actions are completed, even if some items are negatively validated. This feature is activated only when all items have a validation status. > [!NOTE] > > This feature is limited to merchants with certain subscription plans. ## To set Mark as Done after Partial Validation 1. Complete accessing your policy rules. 2. Set **Mark as Done** to **Automatic**. 3. Select **Mark as Done After Partial Validation**. 4. Click the **save icon**. > [!NOTE] > > The **save** icon is only displayed when you change your **Approval Process** selection. # Setting the Look and Feel Source: https://docs.global-e.com/setting-the-look-and-feel ## Customizing Your Return Portal Look & Feel The **Look and Feel** settings let you configure the following: * Layout and margins * Fonts and colors * Behavior and display options * Background elements This guide describes how to access the Return portal and modify your page’s **background elements**, as shown in the following video: [Embedded media](https://player.vimeo.com/video/1164296915) ## Logging in to the Return Portal To begin modifying your background elements, you must log in to the Return portal. ### To log in to the Return portal: 1. Navigate to the Return Portal login page. 2. Enter your credentials and click **LOG IN**. The Home screen is displayed. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8b56b7c7-8ad2-008a-f75f-9845e464bf43.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=1d9cf5d3965d40ec5b4b130c8825608d) ## Accessing the Background Elements The **Background** settings let you customize various page background elements, such as color, font, and opacity. You can do this by selecting to use either a color or image as your background and then making all needed customizations. ### To access the Background elements: 1. Navigate to Settings > Portal > Look and Feel. 2. Click **Return Portal**. 3. Click **Backgrounds**. 4. Customize one of the following: * [Page background](/setting-the-look-and-feel#customizing-your-return-portal-look-&-feel) * [Portal background](/setting-the-look-and-feel#customizing-your-portal-background) * [Secondary background](/setting-the-look-and-feel#customize-your-secondary-background) * [Stroke lines](/setting-the-look-and-feel#customizing-your-stroke-lines) * [Shadows](/setting-the-look-and-feel#customizing-your-shadows) * [Cover image](/setting-the-look-and-feel#adding-a-cover-image) ## Customizing your Page Background The **Page background** section lets you customize your page background settings, which are applied to each page on your portal. A sample screen is displayed to the right of the customization menus, as shown in the figure below: ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b56ebf04-aab2-388e-42e3-748adfa6621d.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=99089423409d49782e4b2a5584751663) ### To customize your page background 1. Scroll to the **Backgrounds** section. 2. In the **Page backgrounds** region select one of the following: * Color * Image 3. If you selected **Color**, do the following: 1. Select **Color** from the Page background type menu. 2. Select a color from the Page background color menu. 4. If you selected **Image**, do the following: 1. Attach an image located on your hard drive from the Page background image field. 2. Set the Page background size. ## Customizing your Portal Background The **Portal Background** settings customize the primary background color and opacity of your entire portal. ### To customize your portal background 1. Scroll down to the **Portal Background** section. 2. In the **Portal background** menu, set a color. 3. In the **Portal background opacity** menu, set an opacity level. ## Customize your Secondary Background The **Secondary Background** settings customize the secondary background color and opacity of your entire portal. ### To customize your secondary background 1. Scroll down to the **Secondary Background** section. 2. In the **Secondary background** menu, set a color. 3. In the **Secondary background opacity** menu, set an opacity level. ## Customizing your Stroke Lines The **Stroke Lines** settings let you customize the stroke line colors. ### To customize your stroke lines 1. Scroll down to the **Stroke Lines** section. 2. In the **Stroke / line color** menu, set a color. ## Customizing your Shadows The **Shadows** settings customize the shadow settings. ### To customize your shadow settings 1. Scroll down to the **Shadows** section. 2. In the **Popup overlay** section, set a color. 3. In the **Popup overlay opacity** section, set an opacity level. 4. In the **Drop shadow** section, set a shadow color. 5. In the **Drop shadow opacity** section, set a shadow opacity level. ## Adding a Cover Image The **Cover Image** section lets you add a cover image. This is the image displayed on the main screen of the portal. ### To customize your cover image 1. Scroll down to the **Cover Image** section. 2. Upload an image from your hard drive. 3. The image preview is displayed. > [!NOTE] > > Follow these guidelines for optimal results: > > * **Minimum image size**: 500px width and 456px height > * **Maximum file size**: 400KB > * **Supported formats**: .jpg, .png, .WebP # Setting the Look and Feel Source: https://docs.global-e.com/setting-the-look-and-feel-469195 ## Customizing Your Return Portal Look & Feel The **Look and Feel** settings let you configure the following: * Layout and margins * Fonts and colors * Behavior and display options * Background elements This guide describes how to access the Return portal and modify your page’s **background elements**, as shown in the following video: [Embedded media](https://player.vimeo.com/video/1164296915) ## Logging in to the Return Portal To begin modifying your background elements, you must log in to the Return portal. ### To log in to the Return portal: 1. Navigate to the Return Portal login page. 2. Enter your credentials and click **LOG IN**. The Home screen is displayed. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8b56b7c7-8ad2-008a-f75f-9845e464bf43.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=1d9cf5d3965d40ec5b4b130c8825608d) ## Accessing the Background Elements The **Background** settings let you customize various page background elements, such as color, font, and opacity. You can do this by selecting to use either a color or image as your background and then making all needed customizations. ### To access the Background elements: 1. Navigate to Settings > Portal > Look and Feel. 2. Click **Return Portal**. 3. Click **Backgrounds**. 4. Customize one of the following: * [Page background](/setting-the-look-and-feel-469195#customizing-your-return-portal-look-&-feel) * [Portal background](/setting-the-look-and-feel-469195#customizing-your-portal-background) * [Secondary background](/setting-the-look-and-feel-469195#customize-your-secondary-background) * [Stroke lines](/setting-the-look-and-feel-469195#customizing-your-stroke-lines) * [Shadows](/setting-the-look-and-feel-469195#customizing-your-shadows) * [Cover image](/setting-the-look-and-feel-469195#adding-a-cover-image) ## Customizing your Page Background The **Page background** section lets you customize your page background settings, which are applied to each page on your portal. A sample screen is displayed to the right of the customization menus, as shown in the figure below: ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b56ebf04-aab2-388e-42e3-748adfa6621d.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=99089423409d49782e4b2a5584751663) ### To customize your page background 1. Scroll to the **Backgrounds** section. 2. In the **Page backgrounds** region select one of the following: * Color * Image 3. If you selected **Color**, do the following: 1. Select **Color** from the Page background type menu. 2. Select a color from the Page background color menu. 4. If you selected **Image**, do the following: 1. Attach an image located on your hard drive from the Page background image field. 2. Set the Page background size. ## Customizing your Portal Background The **Portal Background** settings customize the primary background color and opacity of your entire portal. ### To customize your portal background 1. Scroll down to the **Portal Background** section. 2. In the **Portal background** menu, set a color. 3. In the **Portal background opacity** menu, set an opacity level. ## Customize your Secondary Background The **Secondary Background** settings customize the secondary background color and opacity of your entire portal. ### To customize your secondary background 1. Scroll down to the **Secondary Background** section. 2. In the **Secondary background** menu, set a color. 3. In the **Secondary background opacity** menu, set an opacity level. ## Customizing your Stroke Lines The **Stroke Lines** settings let you customize the stroke line colors. ### To customize your stroke lines 1. Scroll down to the **Stroke Lines** section. 2. In the **Stroke / line color** menu, set a color. ## Customizing your Shadows The **Shadows** settings customize the shadow settings. ### To customize your shadow settings 1. Scroll down to the **Shadows** section. 2. In the **Popup overlay** section, set a color. 3. In the **Popup overlay opacity** section, set an opacity level. 4. In the **Drop shadow** section, set a shadow color. 5. In the **Drop shadow opacity** section, set a shadow opacity level. ## Adding a Cover Image The **Cover Image** section lets you add a cover image. This is the image displayed on the main screen of the portal. ### To customize your cover image 1. Scroll down to the **Cover Image** section. 2. Upload an image from your hard drive. 3. The image preview is displayed. > [!NOTE] > > Follow these guidelines for optimal results: > > * **Minimum image size**: 500px width and 456px height > * **Maximum file size**: 400KB > * **Supported formats**: .jpg, .png, .WebP # Settlement Report Source: https://docs.global-e.com/settlement-report The *Settlement CSV Report* is a structured financial data file provided by Global-e to merchants. It is designed to give merchants a transparent and detailed breakdown of all financial transactions related to their orders, refunds, adjustments, and associated costs or fees. This report can be subscribed to and delivered on a recurring basis, and its format enables multi-purpose data analysis. The following figure shows the Settlement CSV report: ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-face0f0a-e497-11b6-8a93-1b1646949454.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=c4e1633014e2f475e03cb478088f6d44) To subscribe to the Settlement Report (weekly and/or monthly), contact your CSM. ## Key Features * Provides a breakdown of all transaction types such as orders, refunds, adjustments, and returns. * *Complete Financial Visibility* - full breakdown of revenue, costs, fees, and payout amounts. The following table provides the field-by-field dictionary of the **New Settlement CSV Report**, outlining each column’s name, description, calculation (if applicable), example, and its reconciliation report mapping reference. The mapping reference column indicates how terms in this report correspond with terminology used in other Global-e financial reports. | | Field Name | Description | Formula | Example | Mapping Reference | | - | - | - | - | - | - | | A | GE reference | Global-e Order ID | | GE9248739996GB | GE Order# | | B | Order number | Merchant order ID, taken from the merchant's platform | | 3579632 | Merchant Order# | | C | Order Date | Order creation date | | 2025-07-29 00:00:00 | Date Created | | D | Fulfillment Date (Received in Hub) | If you are shipping through Global-e's hub, this will be the day the order is physically received at the hub. If shipping directly to the shopper, this will be the same as the dispatch date. Applies only to Order Transaction Type. | | 2025-08-04 00:00:00 | Date Received In Hub | | E | Destination Country | The country to which the order was shipped | | Germany | Destination Country | | F | Transaction Type | May include the following values: Order Refund Adjustment (financial transaction between GE and merchant) Returns (inbound shipping costs) UIC/Non Doc (shipping costs that are not associated to a specific order) | | Order | | | G | Total Sales/Refunds excl. B2B VAT | Product price for outbound sale / refund transaction | | 67.79 | Amount to Invoice | | H | Estimated Additional Margin from International Pricing (Included in the Product Price) | Dynamic Pricing- Margin built into the product price usually to cover the estimated average duties and taxes and/or shipping costs per destination country/product category. Fixed Pricing- For orders that include countries or products set as Fixed Price, the estimated margin amount is calculated based on a virtual coefficient rate defined per country. | | 12.41 | | | I | Total Costs excl. B2B VAT | Total amount of all the applicable costs that are related to the order such as: Shipping charges to merchant for outbound/inbound transactions, Handling fee, Duties and Taxes Charges to Merchant (if applicable and according to the merchant's setup) | Shipping Charges to Merchant excl. VAT + Returns Shipping Charges to Merchant excl. VAT + Handling Fee excl. VAT + Duties and Taxes Charges to Merchant | -11.02 | Shipping Subsidies + Taxes Subsidization + Handling Fee + Returns | | J | Total Fees excl. B2B VAT | Total amount of all the fees that are related to the order such as: Service fee, Reconciliation fee and Service Fee adjustments | Service Fee excl. VAT + Reconciliation Fee excl. VAT + Service Fee Adjustments excl. VAT | -3.69 | Service Fee + Reconciliation Fee + Service Fee Adjustments | | K | Total Payment excl. VAT | Net amount paid to the merchant after deducting costs and fees. | Net Sales less Refunds excl. B2C VAT + Amount Paid In Gift Cards excl. VAT + Service Fee excl. VAT + Reconciliation Fee excl. VAT + Service Fee Adjustments excl. VAT + Shipping Charges to Merchant excl. VAT + Returns Shipping Charges to Merchant excl. VAT + Handling Fee excl. VAT + Duties and Taxes Charges to Merchant | 53.08 | Amount to Invoice - Services and Fees | | L | Total Order Value (Service Fee Base) | Total amount paid by the shopper for products, shipping, duties and taxes. | Shipping Paid By Customer incl. B2C VAT + Total Duties and Taxes Paid By Customer + Customer Product Price incl. B2C VAT | 73.72 | | | M | Shipping Paid By Customer incl. B2C VAT | The shipping cost paid by the shopper including B2C VAT | | 5.93 | | | N | Total Duties and Taxes Paid By Customer | The Duties and Taxes paid by the shopper | | 0 | | | O | Customer Product Price incl. B2C VAT | The products price paid by the shopper including B2C VAT | | 67.79 | | | P | Net Sales less Refunds excl. B2C VAT | The value will be reflected according to the transaction type: **Order** - Item Price net of discounts. **Refund** - Refund amount to the shopper. **Adjustment** - The amount charged/ credited to the merchant. | | 67.79 | | | Q | Amount Paid In Gift Cards excl. VAT | The amount paid by the shopper via gift card | | 0 | Amount Paid In Gift Cards | | R | Service Fee excl. VAT | Global-e service/platform fee. | | -3.69 | Service Fee | | S | Reconciliation Fee excl. VAT | Global-e reconciliation fee. | | 0 | Reconciliation Fee | | T | Service Fee Adjustments excl. VAT | Credit adjustments applied to service fees previously charged if applicable | | 0 | Service Fee Adjustments | | U | Shipping Charges to Merchant excl. VAT | The difference between the total shipping costs and the shipping amount paid by the shopper | | 1.04 | Shipping Subsidies | | V | Returns Shipping Charges to Merchant excl. VAT | The difference between the return shipping costs and the return shipping amount paid by the shopper | | 0 | Returns | | W | Handling Fee excl. VAT | These are the cross-dock fees for each order which is processed through Global-e's hub | | 0 | Handling Fee | | X | Duties and Taxes Charges to Merchant | The difference between the Duties and taxes costs related to the order (built into the product price), and the Duties and Taxes amount paid by the shopper | | -12.06 | Taxes Subsidization | # Introduction Source: https://docs.global-e.com/sfcc Global-e provides cross-border checkout, localized pricing, and international order management for Salesforce B2C Commerce (SFCC) through certified cartridges. This guide covers installation, Business Manager configuration, storefront customization, pricing, promotions, checkout, and order flows for **SiteGenesis**, **SFRA**, and **headless / PWA** storefronts. ## At a glance | | | | - | - | | Cartridge version | [24.6.0](/version-sfcc) (see [Version](/version-sfcc) for SFRA baseline) | | SFCC Compatibility Mode | **17.7 or newer** required — see [Requirements](/requirements-sfcc) | | Storefront cartridges | `int_globale` + `int_globale_sfra`, `int_globale_sitegenesis`, or `int_globale_headless` — see [Cartridges](/cartridges-sfcc) | ## Read this section in order **Step 1** **[Requirements](/requirements-sfcc)** — confirm your SFCC instance meets compatibility mode and tooling prerequisites. **Step 2** **[Supported features](/supported-features-sfcc)** — capability overview grouped by topic, with links to implementation sections. **Step 3** **[Limitations](/limitations-sfcc)** — platform and integration constraints to plan for before build. **Step 4** **[Version](/version-sfcc)** — cartridge and SFRA baseline versions for this release. ## Where to go next | Your role | Start here after getting started | | - | - | | Implementer (cartridges + BM) | [Setup → Cartridges](/cartridges-sfcc) | | Frontend / SFCC developer | [Storefront → Customization](/customization-sfcc) | | Pricing / promotions admin | [Pricing and promotions](/price-calculation-sfcc) | | Checkout / QA | [Checkout and orders](/checkout-flow-sfcc) | | Operations / scheduled jobs | [Jobs](/jobs-sfcc) | | Hook or metadata lookup | [Hooks](/hooks-sfcc), [Metadata](/metadata-sfcc) | ## What Global-e adds to SFCC Through the cartridge integration, international shoppers get: * Localized pricing in 95+ currencies * 80+ payment methods and localized checkout * Duty, tax, and shipping options aligned to the destination country * Domestic returns and fraud management handled by Global-e International orders are created in SFCC using the standard order flow. Global-e checkout is embedded in your storefront so shoppers remain on your brand URL (some payment providers may still redirect to a hosted page briefly). For a full capability list, see [Supported features](/supported-features-sfcc). ## Terminology and conventions Terms used throughout this guide: | Term | Meaning | | - | - | | **Global-e / GE** | Global-e cross-border platform; the integration connects SFCC to GE checkout, pricing, and order services. | | **SFCC** | Salesforce B2C Commerce (formerly Demandware). | | **BM** | Business Manager — SFCC administration UI where site preferences and metadata are configured. | | **SendCart / SendCartV2** | GE API call that sends the SFCC basket to Global-e checkout and returns a cart token for the checkout iframe. | | **SOTM** | *Send Order To Merchant* — GE payload used when SFCC creates an order from a fallback scenario (see [Failover and recovery](/failover-sfcc)). | | **Operated country** | A destination country where Global-e runs checkout, pricing, and fulfillment; session flag `geIsOperated` reflects this. | | **Fixed / Dynamic pricing** | Country price strategy (`gePriceStrategy`): fixed uses country-specific price books; dynamic applies coefficients and FX at browse time. | | **`ge*` attributes** | Custom attributes on SFCC system objects (site preferences, product, order, basket, etc.) — see [Metadata](/metadata-sfcc). | | **`globale.*` hooks** | Extension hooks for customization — see [Hooks](/hooks-sfcc). | | **OCAPI / SCAPI** | SFCC Shop APIs; site preference `geCAPIType` selects which API the integration uses for cart validation and order flows. | | **Cartridge names** | `int_globale` plus a storefront cartridge (`int_globale_sfra`, `int_globale_sitegenesis`, or `int_globale_headless`) — see [Cartridges](/cartridges-sfcc). | # Shipping - Thresholds Source: https://docs.global-e.com/shipping---thresholds ## Free Shipping Threshold ### Overview Use the Global-e Free Shipping Threshold feature to offer enticing shipping incentives directly to customers, increasing sales and revenue while enhancing the shopping experience. During the shopping session, Global-e presents the free shipping threshold, highlighting the amount required to qualify for free shipping. This motivates customers to include additional items in their carts before proceeding to checkout, ensuring their active engagement. To implement this feature, you can choose to: * Use our convenient [Free Shipping Threshold Component](/shipping---thresholds#free-shipping-threshold-component) and customize the feature to match your brand and design. * Leverage your design expertise with the Global-e [GetFreeShippingThreshold](/shipping---thresholds#getfreeshippingthreshold) method implementation ### Free Shipping Threshold Component Use Global-e's Free Shipping Threshold Component to quickly and easily implement the Free Shipping Threshold functionality on your site. The component consists of a basic design that displays the Free Shipping Threshold to store visitors. It is configured by Global-e and inserted at the desired location on your site. Before getting started you need to provide Global-e with the following information: * Location on the site where the component should be placed * The text to be used (if you don't want the default text) * Special design requests regarding fonts, colours, or sizes as detailed in [Customizable Elements](/shipping---thresholds#customizable-elements) ### Customizable Elements This section provides details about the Free Shipping Threshold customizable elements. Review this section carefully and provide your customization requirements to the Global-e design team. **Basic Text** The Free Shipping Threshold includes a short sentence presenting the updated value of the threshold. Global-e can modify the text, font, and colour of the message. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-ab057d07-9d19-1570-3e69-5c0e38692cbc.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=e18fad1f84baf448bc45658568d1a138) **Progress Bar** A progress bar can serve as an additional graphic element to help incentivize customers. The progress bar structure: ``` <{OuterContainerHtmlTag} id='{OuterContainerId}' class='{OuterContainerClass}' style='{OuterContainerStyle}'> <{InnerContainerHtmlTag} id='{InnerContainerId}' class='{InnerContainerClass}' style='{InnerContainerStyle}'> ``` If you want to edit the style of the progress bar, provide Global-e with one of the following methods and your preferred colours: * Class: ``` .FSTBanner { background-color: black !important; } .FSTBanner_Yellow { background-color: yellow !important; ``` * Style: ``` OuterContainerStyle: "background-color: yellow;" InnerContainerStyle: "background-color: green;" ``` Global-e can set up the progress bar with or without numbers on either side of it. * The progress bar with numbers ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-d80e5503-bcb2-93f7-9fea-143512a6a486.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=c61867a420bcd8d261ebb506da7cf359) * The progress bar without numbers ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7c92079e-016d-7bc2-fa68-48923ce122d6.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=5a5890f2f00e33a8a622d9c4beafeea7) ### GetFreeShippingThreshold Use the `GetFreeShippigThreshold` method with or without GeoIP to get the amount that the shopper needs to reach to qualify for free shipping during the checkout process. **Prerequisite** This feature requires the Global-e Module TypeScript solution. ### Get Free Shipping Threshold By GeoIP The `GetFreeShippingThresholdByGeoIP` method retrieves the free shipping threshold value based on the shipping country stored in a cookie on the shopper's device. This method returns the threshold value that the shopper needs to reach to qualify for free shipping during the checkout process. In addition, it returns data such as the country code, currency code, and cart data. You do not need to define any parameters for this method as the country and currency are taken from the `GeoIP` (in the cookie). However, you need to set up a callback for this method, as described below. **Method Signature:** The method signature for `GetFreeShippingThresholdGeoIP` is as follows: ``` GEM_Components.ExternalMethodsComponent.GetFreeShippingThresholdByGeoIP(function (data) { console.log(data); }); ``` **Parameters**: The `GetFreeShippingThresholdByGeoIP` method does not require input parameters. **Return type**: The `GetFreeShippingThresholdByGeoIP` method returns the shipping threshold and data in the callback function in an object called `IGetFreeShippingThresholdResponse`. The `(function (data))` object returns the following properties. Make sure to set up the callback data to receive these properties. ``` { "ErrorMessage": "", "CountryCode": "GB", "CurrencyCode": "GBP", "ShippingThreshold": 40, "FreeShippingCarrier": "Tracked Post", "CartData": { "CartTotalPrice": null, "CountryCode": "GB", "CurrencyCode": "GBP", "CurrencySymbol": "£" } } ``` Description: | Property | Type | Description | | - | - | - | | `CountryCode` | String | The ISO 3166-1 alpha-2 country code is used to retrieve the shopper's free shipping threshold based on the GeoIP's country. | | `CurrencyCode` | String | The ISO 4217 currency code is used to retrieve the shopper's free shipping threshold based on the GeoIP's currency. | | `ErrorMessage` | String | Any error message that may occur during the method's execution. Example:`ErrorMessge: "Invalid country"`If there are no errors, this property is an empty string. Example: `ErrorMessage: ""` | | `ShippingThreshold` | Decimal | A number representing the free shipping threshold value for the customer's shipping country and currency. | | `FreeShippingCarrier` | String | The name of the carrier that offers free shipping for the customer's shipping country. | | `CartData` | Object | An object called IUserCartLocalizeSetting contains additional cart data for the customer. | **CartData Object Properties** The `CartData` object includes the following properties: | Property | Type | Description | | - | - | - | | `CountryCode` | String | The ISO 3166-1 alpha-2 country code is used to retrieve the shopper's free shipping threshold based on the GeoIP's country. | | `CurrencyCode` | String | The ISO 4217 currency code is used to retrieve the shopper's free shipping threshold based on the GeoIP's currency. | | `CartTotalPrice` | Decimal | A number representing the total price of the customer's cart. | | `CurrencySymbol` | String | A string representing the symbol used for the currency in the customer's cart. | The data must contain the result of the method's execution, including the free shipping threshold value and additional cart data for the customer. If an error occurs during the execution of the method, the `ErrorMessage` property of the `IGetFreeShippingThresholdResponseinterface` must contain a string value describing the error. **Callback**: Create a callback function and define the object data to match the properties in the method's return (`IGetFreeShippingThresholdResponse`). See the Return Type section. Here is an example of how to use the method: In this example, the `GetFreeShippingThresholdByGeIP` method is called with the default US country code and the USD currency code found in the `GeoIP` (cookie). The callback function is passed and it logs the result of the method's execution to the console. The result includes the free shipping threshold value based on the `GeoIP`, the name of the carrier that offers free shipping, and additional cart data for the customer. ``` GEM_Components.ExternalMethodsComponent.GetFreeShippingThresholdByGeoIP(function (data) { // Handle the result of the method's execution here. console.log(data); }); ``` **Best Practices**: Here are some tips and best practices for using `GetFreeShippingThresholdByGeoIP` effectively: * Make sure that the necessary Global‑e scripts are loaded before calling the method: use the `window['GlobalE_Localize_Set']` function to set the data parameter. This will ensure that the `GetFreeShippingThresholdByGeoIP` method has access to the necessary information to calculate the free shipping threshold value. * Call the method only when necessary. Since the method relies on the customer's location and cart data, avoid calling the method more often than necessary to conserve resources and minimize unnecessary requests. * Consider caching the result of the method's execution. To avoid making unnecessary requests to the server, you can cache the result of the `GetFreeShippingThresholdByGeoIP` method's execution and reuse it when appropriate. ### Get Free Shipping Threshold (Without GeoIP) Use the `GetFreeShippingThreshold` method to retrieve the shopper's free shipping threshold value for a specific country and currency that you define. This method returns the threshold value that the shopper needs to reach to qualify for free shipping during the checkout process. In addition, it returns data such as the country code, currency code, and cart data. In addition to defining the country and currency parameters, you need to set up a callback for this method, as described below. **Method Signature**: The method signature for `GetFreeShippingThreshold` is as follows: ``` GEM_Components.ExternalMethodsComponent.GetFreeShippingThreshold( { "CountryCode": "String", "CurrencyCode": "String" }, callback: (response: IGetFreeShippingThresholdResponse) => void ): void ``` **Parameters**: | Parameter | Type | Description | | - | - | - | | `CountryCode` | String | Set the ISO 3166-1 alpha-2 code for the country to retrieve the shopper's free shipping threshold. | | `CurrencyCode` | String | Set the ISO 4217 currency code for the currency to retrieve the shopper's free shipping threshold. | **Return Type:** The `GetFreeShippingThresholdByGeoIP` method returns the shipping threshold and data in the callback function in an object called `IGetFreeShippingThresholdResponse`.The `(function (data))` object returns the following properties. Make sure to set up the callback data to receive these properties. ``` export interface IGetFreeShippingThresholdResponse { CountryCode: string; CurrencyCode: string; ErrorMessage: string; ShippingThreshold: number; FreeShippingCarrier: string; CartData: IUserCartLocalizeSetting; } ``` Description: | Property | Type | Description | | - | - | - | | `CountryCode` | String | The ISO 3166-1 alpha-2 country code is used to retrieve the shopper's free shipping threshold based on the country you defined. | | `CurrencyCode` | String | The ISO 4217 currency code is used to retrieve the shopper's free shipping threshold based on the currency you defined. | | `ErrorMessage` | String | Any error message that may occur during the method's execution. Example:`ErrorMessge: "Invalid country"`If there are no errors, this property is an empty string. Example: `ErrorMessage: ""` | | `ShippingThreshold` | Decimal | A number representing the free shipping threshold value for the customer's shipping country and currency. | | `FreeShippingCarrier` | String | The name of the carrier that offers free shipping for the customer's shipping country. | | `CartData` | Object | An object called IUserCartLocalizeSetting contains additional cart data for the customer. | **CartData Object Properties** The `CartData` object includes the following properties: | Property | Type | Description | | - | - | - | | `CountryCode` | String | The ISO 3166-1 alpha-2 country code is used to retrieve the shopper's free shipping threshold based on the country selected by the shopper. | | `CurrencyCode` | String | The ISO 4217 currency code is used to retrieve the shopper's free shipping threshold based on the country and currency selected by the shopper. | | `CartTotalPrice` | Decimal | A number representing the total price of the customer's cart. | | `CurrencySymbol` | String | A string representing the symbol used for the currency in the customer's cart. | The data must contain the result of the method's execution, including the free shipping threshold value and additional cart data for the customer. If an error occurs during the execution of the method, the `ErrorMessage` property of the `IGetFreeShippingThresholdResponseinterface` must contain a string value describing the error. **Callback:** Create a callback function and define the object data to match the properties in the method's return (`IGetFreeShippingThresholdResponse`). See the Return Type section. Here is an example of how to use the method: In this example, the `GetFreeShippingThreshold` method is called with the US country code and the USD currency code. The callback function is passed and it logs the result of the method's execution to the console. The result includes the free shipping threshold value, the name of the carrier that offers free shipping, and additional cart data for the customer. ``` GEM_Components.ExternalMethodsComponent.GetFreeShippingThreshold( { "CountryCode": "US", "CurrencyCode": "USD" }, function (data) { // Handle the result of the method's execution here console.log(data); } ); ``` **Best Practices**: Here are some tips and best practices for using `GetFreeShippingThreshold` effectively: * Make sure to pass in the correct country code and currency code for the customer's location and cart data to ensure accurate results. * Call the method only when necessary. Since the method relies on the customer's location and cart data, merchants, avoid calling the method more often than necessary to conserve resources and minimize unnecessary requests. * Consider caching the result of the method's execution. To avoid making unnecessary requests to the server, you can cache the result of the `GetFreeShippingThreshold` method's execution and reuse it when appropriate. # Cancelling Declared Parcels Source: https://docs.global-e.com/shipping---void-parcel The Void Parcel API lets you take out a declared parcel if you do not intend to send it or if it needs to be updated due to changed shipment requirements. > [!NOTE] > > At least one order ID should be provided in the request — the Global-e `OrderId` or the merchant's `MerchantOrderId`. The endpoint is `POST /Parcel/VoidParcel`. Parameters: `OrderId` (mandatory) — order unique identifier; `ParcelCode` (mandatory) — code used to identify the ParcelCode to void; `MerchantOrderId` — the merchant's order unique identifier. > [card] [Void Parcel — full request & response](/api-reference/void-parcel) > > Parameters, schema, examples, and the interactive playground for `POST /Parcel/VoidParcel`. ## Error Handling | Error Code | Error Text | Additional Information | | - | - | - | | C100 | The parcel cannot be voided due to the status of the parcel. For a Global-e operated hub, only the following statuses can be voided: Failed Transfer To Shipping; Shipped By Merchant | This is the error in case the hub is operated by Global-e and the parcel has the wrong status. | | C101 | The parcel cannot be voided due to the status of the parcel. For merchant-operated hubs, only the following statuses can be voided: Failed Transfer To Shipping; Shipped By Merchant; Received In Hub | This is the error in case the hub is operated by the Merchant and the parcel has the wrong status. | | C102 (Log) | The parcel was voided, but the shipper's API to cancel the shipment failed. The following information is available from the shipper. Error code: ``; Error text: `` | The API succeeds (IsSuccess=True). Add it to the log and to the relevant field in the response | | C103 | Internal unknown failure | - | | C104 | The parcel code was not found, or the parcel was already voided | - | # Shipping Costs Source: https://docs.global-e.com/shipping-costs Some countries, charge the D\&T also on the Shipment Fee of the Parcel. * Countries that charge on Cost of Goods without the shipment are defined as “FOB” (Free on Board). * Countries that charge on Cost of Goods with shipment are defined as “CIF” (Cost, Insurance and Freight. # Shipping country change on checkout Source: https://docs.global-e.com/shipping-country-change-sfcc When a shopper changes **shipping country** on Global-e checkout, the storefront can reload in the **locale that is mapped to the new country** (URL, language, currency, and locale-specific configuration). Out of the box the cartridges send locale-aware **SendCartV2 `PlatformURLs`** and, when Global-e reports a country change, **302** the shopper back to SFCC checkout (`Checkout-Begin`) with `glCountry` and `glCurrency`. See also: [Checkout flow](/checkout-flow-sfcc), [Hooks → `globale.getPlatformURLs`](/hooks-sfcc#globalegetplatformurls), [Client JS SDK](/client-js-sdk-sfcc), [Metadata → GLOBALE_COUNTRIES](/metadata-sfcc#globale_countries) > [!WARNING] > > This is an **optional** feature. The SFCC cartridges include the storefront behaviour, but it is **not available in production** until Global-e enables shipping-country change for your merchant account. Contact **Global-e Merchant Support** to request enablement before go-live. There is **no** SFCC site preference to turn it on. ## Overview 1. SendCartV2 includes **`PlatformURLs`**: home (`Home-Show` / SEO home), cart (`Cart-Show` / SEO cart), and payment callback (`Globale-PaymentRedirect`), built in the **current request locale**. 2. If the shopper changes shipping country on Global-e checkout, Global-e calls **`Globale-PaymentRedirect`** with `shippingCountryChanged=true`, `glCountry`, and `glCurrency`. 3. SFCC resolves the destination from **`GLOBALE_COUNTRIES.siteUrl`** for that country (pipeline form `action|SiteID|locale`) and redirects to **`Checkout-Begin`** with `glCountry` / `glCurrency` so Global-e init and SendCart run again in the matching locale. `Globale-CheckoutPaymentRedirect` (the SFCC include used when checkout already has a cart token) does **not** issue this locale 302. ## Prerequisites | Side | Required | | - | - | | Global-e | Shipping-country change enabled for the merchant (including the query parameters Global-e sends on country change). Contact **Global-e Merchant Support** before SFCC go-live. | | SFCC | Cartridge version that includes locale-aware `PlatformURLs` and the PaymentRedirect country-change 302. Country records in **`GLOBALE_COUNTRIES`** (from **GlobaleSettings**) with **`siteUrl`** set when you need a locale (or site) other than the current request. | | Storefront | Operated Global-e country on SFRA or SiteGenesis for the OOTB 302. Headless storefronts must supply storefront URLs via **`globale.getPlatformURLs`** if they do not use SFCC pipeline URLs. | ## Configuration ### Global-e Contact **Global-e Merchant Support** to enable shipping-country change on your merchant account before configuring SFCC. ### Country site URL **Merchant Tools → Custom Objects → GLOBALE_COUNTRIES** (populated by the **GlobaleSettings** job) The **`siteUrl`** attribute controls where SFCC sends the shopper after a country change: | `siteUrl` value | Result | | - | - | | Empty or unknown country code | 302 still goes to **`Checkout-Begin`** on the **current** site and locale, with `glCountry` / `glCurrency` on the query string | | Pipe form `Home-Show\|YourSiteID\|fr_FR` | Locale (and optionally site / host) is taken from the pipe segments; the redirect **action** is still **`Checkout-Begin`** | | Absolute `https://…` URL | That URL is used as-is (no `Checkout-Begin` rewrite) | Example pipe values (same convention as the country switcher): ```text theme={null} Home-Show|RefArchGlobal|default Home-Show|RefArchGlobal|fr_FR Home-Show|RefArchGlobal|default|www.example.com ``` Keep **`siteUrl`** in sync with how you map operated countries to storefront locales. Run **GlobaleSettings** after Global-e country configuration changes. ### Custom PlatformURLs Register **`globale.getPlatformURLs`** only when the OOTB home / cart / `Globale-PaymentRedirect` URLs are wrong for your storefront (typical for **headless**). The handler must return `{ SiteURL, RedirectToCartURL, PaymentCallbackURL }` or `null`. See [Hooks → `globale.getPlatformURLs`](/hooks-sfcc#globalegetplatformurls). Do **not** put a literal `@@LOCALE@@` token in these URLs. Global-e does not substitute that token on MAS storefront URLs. ## Storefront architectures | Architecture | OOTB behaviour | | - | - | | SFRA | `Globale-PaymentRedirect` 302s to SFRA **`Checkout-Begin`**. Empty basket after the 302 follows the existing checkout prepend (redirect to cart). | | SiteGenesis | Same PaymentRedirect 302 to **`Checkout-Begin`**. SiteGenesis checkout (`COShipping-Start`) still sends an empty cart to **`Cart-Show`**. | | Headless | SendCart still fills `PlatformURLs` from the fallback or your hook. Implement **`globale.getPlatformURLs`** so home, cart, and payment-callback URLs match the headless storefront. | ## Limitations * If the **SFCC shopper session expires** before the shopper changes shipping country (the platform hard session timeout, typically **8 hours**), the country-change 302 still runs, then checkout finds **no basket** and sends the shopper to the **empty cart** page. * An **unknown or invalid** `glCountry` does not fail closed: SFCC still 302s to **`Checkout-Begin`** on the current locale. Global-e init ignores a country code that is not in **`GLOBALE_COUNTRIES`** (or not allowed for the site) and falls back to geo / default country. * The country-change 302 does **not** pass the cart token. SendCart on the following checkout request issues a new token. ## See also * [Checkout flow](/checkout-flow-sfcc) * [Client JS SDK](/client-js-sdk-sfcc) — country `siteUrl` on the country switcher * [Hooks → `globale.getPlatformURLs`](/hooks-sfcc#globalegetplatformurls) * [Metadata → GLOBALE_COUNTRIES](/metadata-sfcc#globale_countries) * [GlobaleSettings](/globale-settings-sfcc) # Generating Shipping Documents Source: https://docs.global-e.com/shipping-documents-api Global-e's Shipping API provides merchants with fully integrated shipping capabilities to get the relevant shipping labels and documentation to ship straight from their warehouses or through a 3PL. ## Introduction Global-e's Shipping API provides merchants with fully integrated shipping capabilities to get the relevant shipping labels and documentation to ship straight from their warehouses or through a 3PL. For this purpose, the integration is based on implementing the Global-e shipping solution akin to a simplified carrier integration. This API works seamlessly across Global-e direct integrations and Managed Markets merchants. This document describes the implementation of the API calls required to perform the necessary shipping activities. ## Shipping Model Scenarios To fulfil a cross-border order, use the Global-e APIs to generate shipping documents, including labels and commercial invoices. This ensures accurate and compliant documentation for the shipment, enabling a duty guarantee. Global-e supports the following document and document formats: * Shipping labels in 6x4 format, available in PDF/ZPL/EPL for specific UK carriers. * Commercial Invoices in 8.5x11 inch letter size or A4 format, provided only when a carrier and country do not support Paperless Trading (PLT). Global-e offers various shipping models to leverage our extended carrier network with specialised services through the Global-e facility. | Scenario | Documents Returned by the API | | - | - | | Direct dispatch from the warehouse with final mile carrier | Carrier label; PDF invoice(s); Additional documents (e.g. Dangerous Goods Note) | | Shipping via the Global-e Hub | 6x4 ZPL/PDF cross-docking label for the Global-e hub | ## Integration Overview Ensuring an accurate description of the shipment contents on both the label and Commercial Invoice (CI) is crucial to avoid potential overcharges for duties and taxes. The information declared in the API must align with the actual contents of the parcels being shipped. The shipping process and its integration are built based on the following logic: 1. Receive and identify Global-e operated orders. 2. Declare orders fulfilled and ready for dispatch in API call #1. 3. Retrieve shipping documents as a response to API call #1: * The carrier label * The commercial invoice (for non-paperless countries) * Other documents, such as the Dangerous Goods note 4. Declare effective dispatch of orders in API call #2. 5. Retrieve the carrier manifest for carrier sign-off as a response to API call #2. 6. Declare the fulfilment back to the eCommerce platform. The following diagrams illustrate the standard fulfilment and dispatch flow through the end-to-end API process. ### Declare Order Fulfilment and Retrieve Shipping Documents ![Declare Order Fulfilment and Retrieve Shipping Documents — flow diagram](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/shipping/declare-fulfilment-and-retrieve-documents-1.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=c81929cc4a594daef56ed7e21bf71952) ![Declare Order Fulfilment and Retrieve Shipping Documents — flow diagram](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/shipping/declare-fulfilment-and-retrieve-documents-2.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=22033b5cfe3a18014b74e77ecb721840) ### Orders Dispatch Notification ![Orders Dispatch Notification — flow diagram](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/shipping/orders-dispatch-notification.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=01ffd39d42f2cf43fc7a4fffc629a2da) ## Prerequisites The Merchant Order Management System (OMS) or Warehouse Management System (WMS) should be familiar with and support the following features, either directly or through an escalation process: * Display the complete list of items in the order * Enable the selection of items for dispatch After completing the pick & pack and necessary actions in the OMS/WMS, follow the integration steps outlined in this document to process orders for dispatch. ## Integration Steps ### Identify Orders Processed via the Global-e API You can receive orders directly on your eCommerce platform or via 3rd party integrations. Accordingly, the following scenarios should be supported to associate orders with the Global-e integration to generate shipping documentation: Shipping/Carrier code as provided in the order payload received: * In Shopify's context, such indication is available via the order `shipping_lines` code or title field. Mapping of values presented in these fields should allow mapping orders to the Global-e integration. * Outside Shopify, standard carrier mapping as currently performed should be used. Additionally when using a direct integration with Shopify to retrieve orders, for example, Managed Markets, the `merchant_of_record_app_id` field will be provided. When Global-e is responsible for an order, this value will be set to `2745565185`. However, if you are an independent merchant doing this integration, you may choose either of the methods above per your integration. The `merchant_of_record_app_id` field is available on Shopify webhooks, RESTful GET Orders calls or GraphQL queries. Version 2022-10 or later of the Shopify API is required for this field to be present. Both methods should be implemented to comply with different merchant setups in pushing orders to the WMS/3PL. Orders will arrive via the same channel as all other orders for a merchant. It's important to map such orders and prevent them from being shipped via means other than Global-e. ### Declare Order Fulfilment and Get Documents From the orders indicated as fulfilled, the GetShippingDocuments API (`POST /Order/GetShippingDocuments`) will return the required shipping documentation as a base64 encoded byte array and URL for printing. > [card] [GetShippingDocuments — full request & response](/api-reference/get-shipping-documents) > > Parameters, schema, examples, and the interactive playground for `POST /Order/GetShippingDocuments`. The response of the Get Shipping Documents API call (GSD) will include the tracking information of the shipment(s). Tracking information includes: * Shipper Name (order level) * Tracking Number (for each parcel and order level) * Tracking URL (for each parcel and order level) Tracking should always be stored from the `ParcelsTracking` array by matching the relevant parcel code tracking. If the tracking is done on the order level, the tracking information of the order (Tracking Number and URL) will be populated on the parcel level as well (with the same values). ### OrderDocument DocumentTypeCode list Use `DocumentTypeCode` to identify the type of document returned by the API and how to print it. **Labels for Zebra/Thermal Printer** | DocumentTypeCode | Description | Paper format | Notes | | - | - | - | - | | 4 | Carrier Label | 6x4 | For direct dispatch. Default configuration | | 7 | GELabel | 6x4 | Configurable. Use for solution-specific scenarios upon request | | 9 | ArchiveLabel | 6x4 | Only for specific | **A4 / Letter Size for Laser printer** | DocumentTypeCode | Description | Paper format | Notes | | - | - | - | - | | 1 | CommercialInvoice | A4 / Letter Size | Provided only for destinations not supporting electronic customs declarations | | 5 | VATInvoice | A4 / Letter Size | legacy | | 6 | DangerousGoods | A4 / Letter Size | Only for merchants shipping Dangerous Goods | | 10 | Delivery Advice | A4 / Letter Size | For specific UAE Free Trade Zones requirements | ### Notify Order Dispatch and Retrieve Carrier Manifest The DispatchOrders API (`POST /Order/DispatchOrders`) provides the necessary carrier manifest, encoded as a base64 byte array, and a printing URL for all orders with printed labels since the last DispatchOrders call. Non-Shopify orders are tagged as Dispatched to Customer and set up to send tracking notification emails. For example, for split shipments, you can dispatch selected parcels instead of the whole order. Send `ParcelCodes` or `TrackingNumbers` on the DispatchOrders request. Only the parcels you identify are dispatched; other parcels on the same order stay open until you dispatch them separately. If you send both parcel codes and tracking numbers in one request, parcel codes are used. See the DispatchOrders API reference for parameter rules and examples. > [card] [DispatchOrders — full request & response](/api-reference/dispatch-orders) > > Parameters, schema, examples, and the interactive playground for `POST /Order/DispatchOrders`. ### Mark the Order Fulfilled Once a label has been used to ship a set of goods, update the fulfilment state back to the merchant platform to complete the workflow. * **Status:** Success * **Tracking Company:** Use the `ShipperName` returned by the GetShippingDocuments call * **Tracking Number:** Use the `ParcelTrackingNumber` returned by the GetShippingDocuments call * **Items:** Only those items that have shipped with this label should be identified ## Use Cases Examples of request body as `UpdateOrderDispatchRequest`. Order description for this section: product-A in quantity 1, product-B in quantity 2. ### Single Parcel Shipping Single call: ```json theme={null} { "OrderId": "100018322", "Parcels": [ { "ParcelCode": "100018322-1", "Products": [ { "ProductCode": "product-A", "DeliveryQuantity": 1 }, { "ProductCode": "product-B", "DeliveryQuantity": 2 } ] } ] } ``` ### Multi Parcel Single call: ```json theme={null} { "OrderId": "100018322", "Parcels": [ { "ParcelCode": "100018322-1", "Products": [ { "ProductCode": "product-A", "DeliveryQuantity": 1 } ] }, { "ParcelCode": "100018322-2", "Products": [ { "ProductCode": "product-B", "DeliveryQuantity": 2 } ] } ] } ``` ### Split Parcels First call ("day 1"): ```json theme={null} { "OrderId": "100018322", "Parcels": [ { "ParcelCode": "100018322-1", "Products": [ { "ProductCode": "product-A", "DeliveryQuantity": 1 }, { "ProductCode": "product-B", "DeliveryQuantity": 1 } ] } ] } ``` Subsequent call ("day 2"): ```json theme={null} { "OrderId": "100018322", "Parcels": [ { "ParcelCode": "100018322-2", "Products": [ { "ProductCode": "product-B", "DeliveryQuantity": 1 } ] } ] } ``` ## Country Of Origin, Parcel Weight & Dimensions > [!NOTE] > > When using Global-e Enterprise services for shipping, consult with your account manager about the availability of this feature. You can send the product's country of origin, parcel weight, and parcel dimensions to DHL and Aramex via the ship request, according to the data you provided via GetShippingDocuments. If any of the following attributes are not specified, this information is taken from the default value provided in the product catalogue, as part of the ecommerce integration: * **Product Country of Origin** * **Parcel Weight:** For Global-e Enterprise, the weight of the products within the parcel is calculated according to the parcel weight with the simple average method. Example: for a parcel weighing 1000 Grams with two items, each item will weigh 500 Grams. The weight is always in Grams in GetShippingDocuments. * **Parcel Dimensions:** For Aramex, Global-e provides the parcel dimensions according to the first parcel even for consolidated shipment (in the current implementation, the dimensions exist at the shipment level and not per parcel). The dimensions are always in Centimetres in GetShippingDocuments. See the [GetShippingDocuments reference](/api-reference/get-shipping-documents) for where each of these values sits on the request. ## Error Handling ### Processing Exception Scenarios The following diagrams illustrate the processing-exception scenarios. ### Normal Operation – No issues ![Normal Operation – No issues — flow diagram](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/shipping/error-normal-operation.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=e9081bbeab613c95a753d08dc16fa37b) ### With Error Handling ![With Error Handling — flow diagram](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/shipping/error-with-error-handling.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=2da3cc6588cf2c84fbe32faedde04e2e) ### Scenario: Order to be Cancelled after a Failed API request ![Order to be Cancelled after a Failed API request — flow diagram](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/shipping/error-order-cancelled-after-failed-request.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=f2db22a7e6d1311231c4349eeb62e317) ### Scenario: End-of-day Manifesting ![End-of-day Manifesting — flow diagram](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/shipping/error-end-of-day-manifesting.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=2173b18346fc11ef536cde7ca010af2e) ### Scenario: End-of-day Manifesting with Possible Errors ![End-of-day Manifesting with Possible Errors — flow diagram](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/shipping/error-end-of-day-manifesting-with-errors.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=72798d14ebb6b91ed720f88084653f07) ### Scenario: End-of-day Manifesting with Possible Errors and Error Handling ![End-of-day Manifesting with Possible Errors and Error Handling — flow diagram](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/shipping/error-end-of-day-manifesting-with-errors-and-handling.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=65fb11171fb6e033caa107af00020c8f) ### GetShippingDocuments Error Codes | Error Code | Error Text in response | Description | | - | - | - | | A100 | Invalid information schema. | Relevant for technical errors. For example, wrong JSON object structure | | A200 | Could not retrieve documents and/or process orders. Either the order has the wrong status or partial information is provided. | Relevant for logical errors. For example, the order has the wrong status | | A300 | There is at least one SKU that was not part of the original order. Please use only SKUs which were originally ordered. | Relevant for cases in which the fulfilled SKUs contain an SKU not originally ordered (and SKU validation is turned on) | | A400 | Either there are no valid SKUs to place in parcels or parcels could not be created. | Relevant for cases in which ALL fulfilled SKUs were not originally ordered and if we were to amend there will be no item to put in parcels (and SKU validation is turned off) | | A500 | SMB API returns an error | There was an error generating a label via the Global-e SMB Bridge | | A018 | Failed to generate an AWB with `{shipper name}` | When a ship request fails | | A019 | The order was cancelled and cannot be shipped | When the order is in 'Cancelled' status | ### DispatchOrders Error Codes | Error Code | Error Text in response | Description | | - | - | - | | B100 | There are no orders valid for dispatch. | Relevant for dispatch requests that do not contain any valid order for dispatch | | B200 | Could not determine the destination hub. Either none or more than one hub was found. | Relevant for consolidated shipment dispatch requests that contain orders associated with more than one hub | | B300 | The number of outer boxes cannot be greater than the number of parcels. The total number of parcels is %Number of Parcels% and the number of outer boxes is %Number of outer boxes%. | | | B400 | Could not create the manifest | Relevant when the hub manifest cannot be created | | B401 | Parcel code(s) not found: \{parcel code} | | | B402 | Tracking number(s) not found: \{tracking number} | | | B403 | Parcel-level dispatch is not enabled for this merchant | | | B404 | At least one of ParcelCodes, TrackingNumbers, OrderIds, or MerchantOrderIds must be provided. | | | B500 | Could not create AWB | Relevant when the consolidated AWB cannot be created | | B600 | Configuration error. Cannot determine source hub. Please contact Global-e TechSupport | There is a configuration error on the Global-e side, more than one merchant hub is configured | | B700 | Unknown failure | Relevant for general errors and unhandled exceptions | | B800 | Hub Code is required | Merchant is configured to use multiple hubs per order but did not send hub code | | B001 | Order ID not found | Refers to Order ID provided by the merchants but it does not exist | | B002 | Order cannot be dispatched. Order and/or parcels have the wrong status. | Possible reasons: Order AWB generation has failed; Order yet to be processed with GetShippingDocuments; Order already dispatched | | B003 | Order must be dispatched as part of a consolidated shipment | For consolidated post orders | | B004 | Order must NOT be dispatched as part of a consolidated shipment | For NON-consolidated post orders | ## Void Parcel If you need to cancel a declared parcel — because you no longer intend to send it, or the shipment requirements changed — use the Void Parcel API. See the [Cancelling Declared Parcels](/shipping---void-parcel) page for the full flow, parameters, and error handling. ## Appendix – Shopify Managed Markets ### Testing Shopify Managed Markets Integration To do an end-to-end test for Managed Markets orders, you need to use a Shopify Shop that has Managed Markets enabled. We recommend you use a separate test shop. You can also reuse an existing test shop by simply enabling Managed Markets. #### Build a New Shopify Shop * A new developer shop should be created and connected to your software or warehouse management system. * This shop should have at least one physical product in its catalogue. * Set up the location of a USA-based warehouse and allocate products to it so that orders can be placed. * Enable Shopify Payments. * Be aware that sandbox shops cannot be promoted to production shops. #### Enable Managed Markets Contact Shopify support. Let them know you are testing an SMP shipping integration, what your shop's myshopify.com domain is, and some of your existing Shopify merchants. Make it clear you would like to make a sandbox integration — this will allow you to test using test credit cards and test carrier accounts. You should be given access to create an application for Managed Markets. Fill this out to the best of your ability. As this is a sandbox shop, accurate data is not required to be accepted. After creating an application, you will soon get an email indicating that your application has been accepted. Click the link in this email and you will be walked through the process of enabling Managed Markets. You will also receive a `merchantGUID` from Shopify. Adding a country picker to your shop template can help streamline the testing of international orders, but is not required. #### Testing Managed Markets * You must place an order via standard checkout and not a draft order, created through Shopify Admin. * Create a new Incognito window every time you submit a test order to avoid previous addresses being reused in the checkout. * If you added a country picker, you can select the country you want to test. * Any physical product may be purchased. * Provide an accurate country, city, state, and postal code at checkout; name and address can be anything. * Use the following test credit card data: Card Number `4111 1111 1111 1111`, Name: Any Name, Expiration `03/2030`, CVC `737`. You should see the order in Shopify Admin immediately. The order should also appear in your Warehouse Management system, correctly flagged as either a Managed Markets order (if it's an international order) or as a standard order (if it's domestic). #### Example Test Orders * **Destination France (75001, Paris):** This should be a Managed Markets order. Ensure that the label is correct and that a Commercial Invoice (CI) was recorded. The label should print at 4"x6". France allows Paperless Trading (PLT) and the CI need not be printed. * **Destination Brazil (Rio de Janeiro):** This should be a Managed Markets order. Ensure that the label is correct and that a Commercial Invoice (CI) was recorded. The label should print at 4"x6". Brazil is not a PLT country — the CI should be printed at 8.5"x11". * **Destination USA (Domestic):** This is not a Managed Markets order. Ensure that your standard operations for assigning carriers and printing labels still apply to this order. # Shipping and Logistics Source: https://docs.global-e.com/shipping-logistics Global-e offers a variety of shipping options, tailored to your specific requirements and operational set-ups. These range from international cross-docking at the Global-e Hub to direct dispatch to customers, leveraging existing integrations to serve various geographies. For more details on how Global-e's offerings and capabilities can benefit your business, contact your account manager. # Shipping Management Source: https://docs.global-e.com/shipping-management From the **Shipping Management** page you can view and manage shipping information and operations, including the following: * Issue a new merchant proposition * Add a shipping method * Export shipping methods to Excel * Import shipping methods in bulk * Update multiple configurations simultaneously * Upload rates for individual shipping methods * Adding shipping services to companies # Shipping Method Code Source: https://docs.global-e.com/shipping-method-code The Global-e extension creates a new shipping method in Magento to support international orders coming in via the Global-e API. The carrier code is named Globale and is titled International Shipping. Per the merchant’s request, additional mapping can be defined to enable different shipping methods in Magento (based on the shipping methods selected in the Global-e checkout). The Magento database stores the following default values in tables quote_shipping_rate: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-89a32410-8151-9425-efbc-5bdb0c017ff4.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=0808d05fa934a96aba05c7f07fa18a8a) The information is displayed in Magento Admin: ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-570fc93e-0d8f-3721-d55f-cb1c37c89a1a.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=7c09483eb124d99619d312b530936c77) ## Shipping Method Configurations In Magento Admin you can add mapping that changes the data for a specific carrier. ## To configure Global-e shipping methods to Magento shipping methods 1. In the Global-e admin add a `shippingMethodCode`. In the example below the code shippingMethodCodeis added. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-89a5a0b7-4c31-b697-1e5d-8557a5b5aea3.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=b4eeaded6b692b92bcae85a9d17f8c1c) 2. In Magento Admin Navigate to *Stores > Configuration > Services > Global-e Integration Lite > Shipment*. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b87739b3-2133-2ea8-7cf5-342fcd92a7c0.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=88e537f8033c167803e8e72c987ef757) 3. In **Map GlobalE shipping method to Merchant Shipping Methods** add mapping to change data for a specific carrier. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a4c9bf34-b2f6-3788-f8c2-7912361e2c1d.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=916be67c78f0564ae79822a128e9a6d0) ``` { "geShippingMethodCode":{ "newCarrierName":[ "methodCode", "methodName" ]} ``` **Example:** ``` { "mor_test":{ "globaleintegration":[ "SKYNET_EXPRESS_GLOBALE", "Skynet" ] } } ``` ``` { "mor_test":{ "globaleintegration":[ "SKYNET_EXPRESS_GLOBALE", "Skynet" ] } } ``` # Special Destination Cases Source: https://docs.global-e.com/shipping-non-globale-impl-special-destination-cases > [!WARNING] > > Please note that the commercial invoice examples below are for illustration purpose only, with the sole purpose to highlight the fields required for the given destination country. It does not, in any case, recommend using this specific format. Global-e is not providing guidance on the invoice format but only specifying the necessary fields to ensure the correct processing of the shipment. This example is for reference only. The 3PL or system generating the invoice should rely on their existing templates. ## Switzerland Shipments to Switzerland should be handled as business import and cleared using Global-e’s ZAZ account. It is important for the merchant / 3PL to confirm whether the selected carriers into Switzerland support delivery as Business Import, as not all carriers accommodate this model and whether they can clear goods with a ZAZ account. The invoice’s sold-to party (not the consignee) must be Global-E’s name and include Global-E’s local VAT registration number. Terms of Delivery to be decided with carrier. > [!WARNING] > > Global-e’s ZAZ account number must NOT be displayed on the Commercial Invoices. Also, only the taxes applicable to the clearance into Switzerland should be billed against Global-e’s ZAZ account. Any other fee charged by the carrier in relation to the clearance should be billed to the Shipper of Record (brand / 3PL) and NOT Global-e’s ZAZ account. Example: Order to Switzerland. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f68b6b0c-d176-144d-1d79-5068205c7837.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=d98cdbe48c07f18124366e0e3de669cb) ## Singapore In compliance with Singaporean regulations, the commercial invoice should include the following elements: * OVR GST Number. * GST payment indication for each line item: * "Y" – for orders below the threshold (SGD 400), taxes are paid by Global-E to the authorities. * "N" – for orders above the threshold (SGD 400), taxes are paid by the Shipper upon import. Example: Order to Singapore. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8990bfe2-4cac-4833-12c2-4f25fee20a30.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=79197cbf71a4a8bae09a5f0617a33fdd) ## Malaysia In accordance with Malaysian regulations, the commercial invoice should include the LRN Number. Tax application rules in Malaysia are as below: * **Orders below 500 MYR** – Full Tax Remitted: Global-e will handle tax remittance to the authorities. * **Orders above 500 MYR** – Partial Tax Remitted: * If each product is individually priced below 500 MYR: tax remitted to the authorities by Global-e; duties collected at the border by the carrier. * If the order includes products both above and below 500 MYR: tax for products below 500 MYR remitted by Global-e; duties collected at the border by the carrier. * If each product is individually priced above 500 MYR: both duties and taxes collected at the border by the carrier. Example: Order to Malaysia. # Implementation of the Solution Source: https://docs.global-e.com/shipping-non-globale-implementation ## Order API ![](https://mintcdn.com/globale-enterprise/Ro50zmdaNICCffP4/images/uuid-69bca73c-e02b-30a8-16c9-b1996d6a571c.png?fit=max\&auto=format\&n=Ro50zmdaNICCffP4\&q=85\&s=c50cbb6054f73fb2fa8b6f0ac78ff2b9) ## API Documentation For environment URL endpoints see [Global-e Environment Details](/global-e-environments-api-guides). **Fields mappings** The API method return a list of order details. In the context of producing shipping documentation, the below fields and associated logic must be considered:
Exporter detailsGlobal-e/Merchant
**Global-e local registration details**In specific destinations, such as Norway, the UK, the EU (Cross-border), Switzerland, Australia, New Zealand, Singapore, and Malaysia (the exact list of applicable countries will be confirmed during the project), Global-e is responsible for remitting taxes to local authorities. For orders below the threshold, Global-e’s local tax registration must be included on the commercial invoice and declared to the carrier, as Global-e will handle the direct filing of applicable taxes with the respective local authorities.\ **Merchant.Order.ExporterDetails.LocalRegistrationClearance** *– A Boolean value indicating whether Global-e will remit the tax locally for the order.*\ If TRUE, the following fields must be considered:\ **Merchant.Order.ExporterDetails.DestinationRegistrationNumber** *– GE local registration registration number in destination country*\ **Merchant.ExporterDetails.EORINumber** *– GE Entity EORI*\ **Merchant.Order.ExporterDetails.IOSSNumber** *– for shipments to the EU*\ ⚠️ **Important Note:**\ 🚨Global-e’s IOSS number **must NOT** be displayed on the Commercial Invoices🚨
**Importer and import type mention**If (**Merchant.ImporterDetails.ImporterType** = 0)\ “**Private Import Mention**” for B2C shipment\ **- Merchant.Order.ImportDetails.CustomerTaxId** - *Customer Tax number provided at checkout as required for clearance into certain markets (eg. Brazil, Turkey)*\ If (**Merchant.ImporterDetails.ImporterType** = 1)\ Importer details should have the Mention "**Business Importer**" – *only applicable for shipments to Switzerland.*\ **- Merchant.Order.ImporterDetails.Company** –*Global-e importer entity name for relevant markets (e.g. Switzerland)*\ **- Merchant.Order.ImporterDetails.VATRegistrationNumber** - *Global-e importer entity registration number for relevant markets (e.g. Switzerland)*\ **- Merchant.Order.ImporterDetails.Address -** *Global-e Importer entity*
**Shipper name/address**Should remain the same as today, e.g. the brand, 3PL, or other relevant party
**Currency****Merchant.Order.InternationalDetails.CurrencyCode**
**Incoterm**If **shipping country** **= “Switzerland”**\ Shipment to be cleared under Global-e’s ZAZ account / "Terms of Delivery" to be decided with carrier\ ⚠️ **Important Note:** Only the taxes applicable to the clearance into Switzerland should be billed against Global-e’s ZAZ account. Any other fee charged by the carrier in relation to the clearance should be billed to the Shipper of Record (brand/3PL)\ **Merchant.Order.InternationalDetails.DutiesGuaranteed :** true\ Shipment to be cleared as DDP or equivalent incoterm, to ensure no additional Duties and/or Taxes are requested to be paid at delivery by the customer.\ If **"Merchant.Order.InternationalDetails.DutiesGuaranteed"** : false and **"Merchant.Order.ExporterDetails.LocalRegistrationClearance”** : false\ Shipment to be cleared as DAP or equivalent incoterm, with applicable Duties and/or Taxes paid at delivery by the customer.\ If **"Merchant.Order.InternationalDetails.DutiesGuaranteed"** : false and **"Merchant.Order.ExporterDetails.LocalRegistrationClearance”** : true\ Global-e’s local tax registration to be provided to the carrier and presented on the clearance documents, considering that taxes will be filled by Global-e in the destination country (as mentioned in section “Global-e local tax registration number”)\ Shipment booking to be done following carrier requirements (process to be aligned by the brand with carrier)
**Products****\ Merchant.Order.Products**
·         COOn/a – to be taken from own systems
·         HS Coden/a – to be taken from own systems
**Price exclusive of D\&T****Merchant.Order.Products\[i].InternationalDiscountedPriceForCustoms**
**Shipping Cost****Merchant.Order.InternationalDetails.DiscountedShippingPrice**
**Destination Tax calculation rule****Merchant.Order.TaxCalculationRule -** determines how duties and taxes are calculated for an order. Possible values:\ **CIF** (Cost, Insurance, and Freight): This method calculates duties and taxes based on the total cost of goods, including insurance and freight charges.\ **FOB** (Free on Board): This method calculates duties and taxes based only on the value of the goods\ Tax calculation rules defined per country in Global-e system. Clearance documents to be aligned accordingly.
**Total shipment declarative value for customs****Merchant.Order.TotalValueForCustoms**
# Integration Flow Source: https://docs.global-e.com/shipping-non-globale-integration-flow There are two possible ways of implementing this model: * Retrieving the required information using details from the Global-e **order API**. * Extracting the required information from the platform directly, which can be obtained through "custom attributes" when orders are exported to downstream systems (OMS / ERP / WMS). ## Requirements The third party or system responsible for generating shipping and customs documentation must build custom logic to: * Clear the shipment according to the defined configuration and order model, including using the right incoterm based on whether Duties and/or Taxes are included in the order or must be paid at delivery. * Retrieve and apply the correct product prices for customs from Global-e, ensuring that the declared customs values align with the tax calculation rule model (FOB or CIF) to prevent discrepancies. * Ensure Global-e information is accurately declared to carriers and customs documents whenever required. > [!WARNING] > > Failure to implement these guidelines correctly may result in delays, tax liabilities, compliance and/or customer experience issues. ## Preferred Approach Using details from the order API is highly recommended because: * It ensures all required information is up to date and easily accessible. * It reduces dependency on the relevant data having to flow through multiple downstream systems, simplifying the integration process. > [!NOTE] > > Global-e registration details will not be available through platform-based integration and will instead be provided separately in a file. These will need to be pre-configured by the merchant / 3PL in their own system. ## Export Documentation Requirements Destination-specific export documentation requirements apply. The exact list of applicable countries and required documentation will be confirmed during the project scoping phase, in alignment with the Global-e project team and the merchant / 3PL responsible for shipment execution. # Overview Source: https://docs.global-e.com/shipping-non-globale-overview This guide is designed for merchants using their own carrier accounts and integration to ship Global-e orders. It provides the essential guidelines for creating the necessary clearance documents, including shipping labels and commercial invoices. ## Key Roles and Responsibilities The following roles and responsibilities apply: | Role | Party | | - | - | | Merchant of Record (MoR) | Global-e | | Exporter of Record (EOR) | Merchant | | Shipper of Record (SOR) | Merchant or 3PL | | Importer of Record (IOR) | Customer (except Switzerland, where IOR = Global-e Switzerland) | | Importer of Record (IOR) on Returns | Global-e / Merchant | ## Merchant of Record – Global-e Global-e acts as the Merchant of Record (seller) for all orders processed through Global-e. In certain destinations, Global-e is responsible for remitting taxes to local authorities. The system generating export documents must ensure that Global-e specific information is accurately transferred to carriers during shipment booking and correctly reflected on customs documents. ## Exporter of Record and Shipper of Record – Merchant / Third Party Logistics The merchant or 3PL acts as the Exporter of Record and Shipper of Record for outbound shipments. ## Importer of Record – Customer The customer is the Importer of Record, except in Switzerland, where the Importer of Record is Global-e Switzerland. ## Importer of Record on Returns – Merchant / Third Party Logistics The merchant or Third-Party Logistics acts as the Importer of Record on returns and is responsible for managing the return of goods to their country of origin. This includes: * Clearing the goods through customs and ensuring compliance with import regulations. * Applying Returned Goods Relief to qualify for duty exemption where applicable. # Shipping Options Source: https://docs.global-e.com/shipping-options ## Exact Delivery Date Merchants can choose to display an exact delivery date for an order in the Checkout and Confirmation pages, based on the selected shipping method. Customers no longer need to calculate delivery times from a range of business days, reducing confusion. Merchants can tailor delivery messages for specific campaigns or preferences. Showing precise dates helps to manage customer expectations during peak seasons. Shipping methods in the checkout now show exact delivery dates or a range based on the estimated delivery. The same dates display on the confirmation page, reflecting the selected shipping method. Merchants can customize delivery messages using placeholders for dynamic date information. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-7f9ab2e7-76ac-86a0-cde3-e82ea3df4002.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=ffd61d38f21fdc5565d9cc19d1007c7c) **Date Calculation Logic** * **Origin and Shipping Country Calendars**: Delivery dates are calculated using working days and non-working days for both the origin and destination countries. National holidays and weekends are accounted for to provide accurate delivery estimates. * **Dynamic Updates**: The formula dynamically adjusts to express shipping methods, time of order, and cut-off times for same-day processing. * **Express Shipping Cut-Off Time**: For express methods, the calculation considers a cut-off time of 13:00 (UTC), configurable per shipping method. **Customer Journey** 1. Checkout Page: Shipping methods display precise delivery dates or a clear range, tailored to the selected method. Customers can confidently select the option that best meets their needs. **Example of the delivery date on the Checkout page** . ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-20d0c408-481f-2a0d-922a-c622c4c4d0a8.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=e65a979f4af606130cc4d2c6dc15afb2) 2. Confirmation Page: The selected delivery date or range is displayed again for verification and peace of mind. **Example of the delivery date on the Confirmation page** ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c5416cd8-9d9f-d6c4-76b7-c0b33f74b588.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=341ec487ec1309073fbce01b7e4bf92e) . **Calculating delivery dates** The delivery date displayed in the Checkout and Confirmation pages is determined using a precise formula that accounts for working days, non-working days (weekends and holidays), and processing times in both the origin and destination countries. Here's how the calculation works: **Input Data for the Calculation** * **Calendars:** National calendars for 45 countries are stored in the database to identify holidays and weekends for both origin and destination countries. * **Key Variables:** * Order date * Hub fulfillment time * Carrier fulfillment times (in both origin and destination countries). * Carrier delivery estimates * Non-working days (holidays and weekends) **Calculation Breakdown** * **Origin Country Days Calculation**: The date when the parcel leaves the origin country is calculated using the following formulas. * **Lower Range Estimate:** Order Date + Hub Fulfillment Time + Carrier Fulfillment Time (low estimate) + Non-working Days (holidays + weekends). * **Higher Range Estimate:** Order Date + Hub Fulfillment Time + Carrier Fulfillment Time (high estimate) + Non-working Days (holidays + weekends). **Example:** For an order created on May 4th, 2022, in Israel: * Hub Fulfillment Time: 2 days * Carrier Fulfillment Time in Origin Country: 2–3 days * Weekends: 2 days * Low Estimate: 4.5 + (2 + 2) + 2 (weekend) = 9.5 * High Estimate: 4.5 + (2 + 3) + 2 (weekend) = 10.5 The parcel leaves the origin country between May 9th (low) and May 10th (high). * **Destination Country Days Calculation** The date the parcel arrives at the destination country is calculated as: * **Lower Range Estimate:** Parcel Departure Date + Carrier Delivery Days (low estimate) + Non-working Days (holidays + weekends). * **Higher Range Estimate:** Parcel Departure Date + Carrier Delivery Days (high estimate) + Non-working Days (holidays + weekends). **Note**: If the high estimate overlaps with a second weekend, the two additional weekend days are included. **Example:** For a shipment to Germany with: * Carrier Delivery Estimate: 5–7 days * Second Weekend Impact: 2 additional days * Low Estimate: 9.5 (departure date) + 3 = 12.5 (May 12th) * High Estimate: 10.5 (departure date) + 5 + 2 (second weekend) = 17.5 (May 17th) The expected delivery date range is May 12th–17th, 2022. **Working Hours and Cutoff Times** * If an order is placed after midnight (local time in the origin country), the calculation begins the following day. * For express shipping methods, a configurable cutoff time (default: 13:00 UTC) is applied. Orders placed after this time are processed the next day. **Resource placeholders** The message can contain various placeholders that update dynamically according to the order’s date. The following placeholders are supported: * \{OrdinalNumberDateFrom} - ordinal day format for low range. for example: 1st, 2nd, 15th * \{OrdinalNumberDateTo} - ordinal day format for high range. * \{DayOfWeekDateFrom} – The weekday name for low range. * \{DayOfWeekDateTo} – The weekday name for high range. * \{MonthNameDateFrom} – Month full name in text for low range. * \{MonthNameDateTo} – Month full name in text for high range. * \{MonthShortNameDateFrom} – the 3-letter abbreviation for the month name for low range. For example: JAN, FEB, MAR * \{MonthDateFrom} – in numbers, format is MM for low range. for example: 01, 05, 11 * \{MonthDateTo} – in numbers, format is MM for high range. * \{DaylowerRange} – numbered days, in DD format, of low range. * \{DayHighRange} - numbered days, in DD format, of low range. ## Delayed Delivery Date Merchants can now inform customers about products with delayed delivery dates directly within the checkout page. Customers receive clear information about delayed products, improving trust in the shopping experience. By notifying customers of delivery delays upfront, merchants reduce potential frustration or order cancellations. Clear communication minimizes customer service inquiries related to delivery timelines. Merchants offering pre-order items can display expected availability dates. Customers purchasing out-of-stock items are informed about anticipated delivery times. Clear messaging is available for delayed shipments during high-demand periods such as holidays. **How it Works** 1. **Identifying Delayed Products**: Merchants provide an estimated delivery date for delayed products during the checkout process. 2. **Displaying Notifications**: Checkout displays product-level messages for delays or consolidated messages in the shipping method section for orders with uniform delays. 3. **Shipping Method Updates**: The shipping ETA dynamically adjusts to reflect delayed delivery dates when applicable. 4. **Dynamic Message Customization**: Messages can include placeholders such as: * Ordinal dates (e.g., 1st, 2nd) * Day and month names **Customer Journey** 1. Customers selecting delayed products see clear messages about delivery expectations. 2. Post-purchase emails reinforce delayed delivery timelines, maintaining consistent communication. **Notifications** A notification is displayed next to delayed products in the checkout. If multiple products have the same delayed date, the message consolidates into the shipping method section. For products with differing dates, individual messages display. Notifications include placeholders to dynamically update with order-specific details such as dates, days of the week, and months. **Estimated Shipping Date** If all products in an order have the same delayed delivery date, the general shipping ETA updates to reflect the delayed date. If products have varying estimated shipping dates, the earliest date updates the shipping ETA, and individual product messages display for later dates. **Bundle Support** If only the parent product has a delayed date, it applies to the entire bundle. If child products have differing dates, the latest date displays for the parent. In cases where both parent and children have dates, the parent’s date takes precedence. **Email Notifications** * Delayed delivery notifications are included in key customer emails such as: * Order Confirmed * Order Received * Flash Sale Order Confirmed * Replacement Order Confirmed * Messages are dynamically updated based on product-specific delays. ## Restrict Shipping by Zip Code Merchants now have the capability to block shipping to specific regions based on zip codes. This feature ensures that customers are informed upfront about delivery restrictions, enhancing the overall checkout experience and avoiding logistical challenges. For areas where shipping carriers have limited or no service, merchants can restrict orders to ensure smooth operations. Merchants operating in regulated markets can restrict shipping to areas where fulfillment is legally or logistically constrained. This ensures that only serviceable addresses are accepted, reducing follow-up issues and cancellations. Customers are notified of restrictions upfront, reducing disappointment and support queries. This prevents orders from being placed for regions where shipping services are unavailable. It reduces the administrative burden of canceling or adjusting orders after they are placed. By providing clear, upfront communication about shipping limitations, it avoids frustration by allowing customers to update their shipping information during checkout. ### Customer Journey 1. **Checkout Process**: * A customer enters a shipping address. * If the zip code is part of a restricted region, an error message is displayed. * The customer is prompted to revise the shipping address to continue with their order. 2. **Customer Notification**: * Customers attempting to ship to a restricted region are immediately informed with a clear error message during checkout. * Orders cannot proceed until the shipping address is updated to a serviceable region ### How it Works * **Merchant Identifies Non-Serviceable Regions** * Shipping regions are identified based on zip codes or patterns. * Merchants can block areas such as: * **Spain**: Canary Islands, Ceuta, Melilla, Baleares. * **France**: Martinique, Mayotte, Reunion, Guadeloupe, DOM, TOM. * **Portugal**: Madeira and Azores. * **Italy**: Sardegna, Sicilia, Calabria, Campione d'Ítalia, Livigno. * **Error Notification** * Merchants can provide a clear, customizable message to customers, explaining why the shipping address is not supported. * **Customizable Settings** * Merchants can configure specific regions to block based on their business needs. * Shipping restrictions can be adjusted by zip codes or broader patterns. ## Shipments ### Preventing Shipments to PO Boxes and U.S. Army Bases Shipments to US Army bases can be prevented, and when the specified address is a post office box number. Note that most carriers, especially express ones, do not allow shipments to PO boxes and U.S. Army bases for security reasons, * The Address fields contain a validation that identifies addresses with a PO Box or an army base location. In such situations, a notification is displayed for the customer. * The validation is configured per carrier type. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-21ad893b-5464-69cd-74fa-06265f624808.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=fd0a7e52ec78dbb31fffaeb70236d481) # Estimated Shipping Rates Source: https://docs.global-e.com/shipping-options-api Retrieve estimated shipping rates and free-shipping thresholds for a destination — the cheapest rate per cart/product (GetShippingDetails) or all flat-rate thresholds for all services (GetShippingDetailsExtended). ## Overview The Shipping Options Details APIs retrieve estimated shipping rates for a destination, which you can present on the pre-checkout page, product page, or cart. * **GetShippingDetails** — Retrieves shipping details per cart or mini cart and product page. Returns up to two shipping-rate objects per destination: the cheapest estimated shipping cost for the submitted currency and amount, and the Free Shipping threshold range (where applicable). * **GetShippingDetailsExtended** — Extends GetShippingDetails to provide all flat shipping-rate thresholds for all shipping services related to a product. Use it to get all shipping rates available for a given country, get the rates for specific shipping service levels, or revert to all shipping rates available (for instance, when the request is passed with `amount = 0`). ## Prerequisites ### API Access Global‑e must enable and configure each API on the Global‑e side. Make sure that Global‑e has enabled this API. ### Permissions and Credentials * The **API UserName** header and the **Authorization** header, including the token retrieved via the GetAuthenticationToken API using merchant-specific credentials (provided to you by Global‑e). See the [Authentication](/authentication) section under Global-e Environments. * Your **merchantGUID**. The merchantGUID is provided to you by Global‑e during the initial setup. Note that the merchantGUID is different for test and live environments. ## Reference > [card] [Get shipping details — reference & playground](/api-reference/get-shipping-details) > > Request (`destinationCountry`, `currencyCode`, `amount`, `productCodes`), the per-destination response with the cheapest rate and free-shipping threshold, error shapes, examples, and the interactive playground for `POST /ShippingDetails/GetShippingDetails`. > [card] [Get shipping details extended — reference & playground](/api-reference/get-shipping-details-extended) > > Request (`amount`, `currencyCode`, `destinationCountry`, `productCodes`, `cultureCode`, `serviceLevel`), the per-country response with all flat-rate thresholds for all services, examples, and the interactive playground for `POST /ShippingDetails/GetShippingDetailsExtended`. ## Use Cases ### 1. Get the cheapest rate and free-shipping threshold Call **GetShippingDetails** with the destination, currency, and amount. The response can include up to two objects per destination: an object with the cheapest estimated shipping cost for the submitted currency and amount, and an object with the Free Shipping threshold range (where applicable). The returned data is determined by the submitted amount — the response only returns a shipping service for which the amount passed in the request is greater than or equal to the minimum flat shipping rate range, and lower than the maximum flat shipping rate range (`minimum flat shipping rate range ≤ product/cart amount < maximum flat shipping rate range`). ```json Request theme={null} { "destinationCountry": "USA", "amount": 50, "currencyCode": "USD", "productCodes": [] } ``` ```json Response theme={null} [ { "destinationCountry": "USA", "status": "active", "shippingRates": [ { "minOrderSubtotal": 0.0000, "maxOrderSubtotal": 100.0000, "shippingCost": 15.0000, "shippingCostCurrency": "USD", "shippingPriority": "Express Courier (Air)", "estimatedDeliveryDays": "1-3", "specialOfferExpiryDate": null }, { "minOrderSubtotal": 100.0000, "maxOrderSubtotal": 9999999.0000, "shippingCost": 0.0000, "shippingCostCurrency": "USD", "shippingPriority": "Express Courier (Air)", "estimatedDeliveryDays": "1-3", "specialOfferExpiryDate": null } ] } ] ``` ### 2. Get all rates for all services Call **GetShippingDetailsExtended** to return all available shipping rates by flat-rate shipping campaign. The example below returns all services for all countries with a localized name in Spanish (`cultureCode` = `es`). ```json Request theme={null} { "amount": 100, "currencyCode": "USD", "productCodes": null, "cultureCode": "es" } ``` ```json Response theme={null} [ { "destinationCountry": "FO", "status": "active", "shippingRates": [ { "shippingMethodLocalizedName": "Envío express", "shippingMethodName": "Express Courier (Air)", "rangeMinValue": 0.0000, "rangeMaxValue": 10000000000.0000, "shippingCost": 35.0000, "shippingCostCurrency": "USD", "estimatedDeliveryDays": "3-10", "specialOfferExpiryDate": null } ] }, { "destinationCountry": "FR", "status": "active", "shippingRates": [ { "shippingMethodLocalizedName": "Envío estándar", "shippingMethodName": "Standard Courier", "rangeMinValue": 40.0000, "rangeMaxValue": 440.0000, "shippingCost": 0.0000, "shippingCostCurrency": "EUR", "estimatedDeliveryDays": "2-10", "specialOfferExpiryDate": null }, { "shippingMethodLocalizedName": "Envío express", "shippingMethodName": "Express Courier (Air)", "rangeMinValue": 40.0000, "rangeMaxValue": 440.0000, "shippingCost": 15.0000, "shippingCostCurrency": "EUR", "estimatedDeliveryDays": "1-2", "specialOfferExpiryDate": null } ] } ] ``` > [!NOTE] > > The response is a JSON array of per-country objects, ordered by destination country. Additional countries in the source example (e.g. `GB`) are omitted here for brevity. ## Error Codes When calling **GetShippingDetails**, the following error codes may be returned. | Code | Description | | - | - | | `400` | Error. Problem with the data passed in the request payload. | | `401` | Error. The authorization has failed for this merchant GUID. Note: the merchantGUID is different for test and live environments. | | `500` | Issue with JWT authentication, such as wrong credentials or an expired token. | # Shipping Orders Source: https://docs.global-e.com/shipping-orders ## Shipping Lines When the Global-e CrossBorder app is installed in Shopify, a shipping zone with Global-e operated countries is automatically added. The order shipping lines data is standardized by Shopify and cannot be changed. ``` "shipping_lines": [{ "id": 4525092405308, "code": "EXPRESS_GLOBALE_DDP", "source": "Global-e Carrier Service", "title": "Express Courier (Air)" ``` See below for the list of possible values for the relevant fields. * **Source**: fixed value **Global-e Carrier Service**. * **Title**: two possible values, **Express Courier (Air)** or **Standard Courier**. * **Code**: multiple permutations depending on service type. Will always contain ‘GLOBALE’. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-877b1180-e087-706b-3238-e32e147d43a5.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=5922ab014ebce1ef395bbe0bf878d4e6) ## Shipping Information Shopify shows the carrier service level chosen by the customer in the checkout, as shown in the following figure. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-08b79c75-5122-e6f1-27f0-b1ad546dedea.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=e7187644a5ffc995d7df00f9a012721a) ## Shipping Technical Details To identify Global-e orders for shipping purposes, you can review the information provided by each order placed through Global-e services on our Native integration: | shipping_line | Value | Example | | - | - | - | | `“title”` | Service level | Standard courier | | `“source”` | The Global‑e carrier service | Globale carrier service | | `“code”` | Always contains `GLOBALE` | `123_GLOBALE_HIDDEN_DDP` | An exception to this rule is if an order is placed using Shopify backup rates, or only contains virtual items – the shipping_line will not contain a Global-e shipping method. **EXAMPLE** If a customer places an order on the checkout page and selects a \$10 Express Courier (Air) shipping rate on the checkout page, the order shipping lines will show: ``` "shipping_lines": [       {         "id": 3576851562671,         "code": "30022554_GLOBALE_OPT_DDP", //Always contains "GLOBALE"         "source": "Global‑e Carrier Service", //The Global‑e Carrier Service         "title": "Express Courier (Air)" //Service level }] ``` **Notes:** * If an order is fully paid using a gift card, the only payment gateway name will be “gift_card”. * If a free draft order is placed, the gateway name will be empty since there was no payment. * Under Checkout Extensibility, credit card orders will contain the string “Global-e Onsite Payment”, otherwise, the payment gateway name will be “Global-e Payments". Suppose these scenarios prevent you from relying on them to process Global-e orders immediately after being placed properly. In that case, you will instead need to check the shipping country to confirm whether it was a Global-e order. # Shipping with Non-Global-e Carriers Source: https://docs.global-e.com/shipping-with-non-global-e-carriers This guide explains how to ship Global-e orders using your own carrier accounts. It covers: * [Overview](/shipping-non-globale-overview) * [Integration Flow](/shipping-non-globale-integration-flow) * [Implementation of the Solution](/shipping-non-globale-implementation) * [Special Destination Cases](/shipping-non-globale-impl-special-destination-cases) * [Platform Mappings](/platform-mappings) # ShipStation Source: https://docs.global-e.com/shipstation The **ShipStation** page describes the following: * [Overview](/shipstation#overview) * [How it Works](/shipstation#how-it-works) * [Setting Up ShipStation](/shipstation#setting-up-shipstation) * [Third Party Systems](/shipstation#third-party-systems) * [Frequently Asked Questions](/shipstation#frequently-asked-questions) ## Overview ShipStation is an all-in-one platform that streamlines your warehouse, inventory and shipping workflows. The ShipStation and Global-e Integration helps merchants with the fulfilment and shipping of Global-e orders. This article will explain how the integration works, who can use it, setup steps, and common questions. ## How it Works ShipStation has built an integration using Global-e API's that enable users to easily print all shipping documents required for an order. It also allows users to mark orders as fulfilled and dispatched within Global-e's platform. ## Setting Up ShipStation Merchants wanting to take advantage of the ShipStation and Global-e integration must have an existing Global-e account. Please talk to the Global-e sales team if you would like to setup an account. **Pre-requisites** 1. Orders are imported into ShipStation directly using the ShipStation native app installed in your Shopify instance. This is the standard route. If you import orders from the Cin7 ERP or through middleware, see [Third Party Systems](/shipstation#third-party-systems). 2. Express service orders via Global-e, shipping them directly from your warehouse or store to customers. No crossdock via Global-e hub involved. **Global-e Configuration** Label format for shipping labels is configured as PDF. The Shopify order number is used as the order identifier and the SKU is used as the product identifier. **Printer Requirements** Global-e international orders require two printers: * Label printer (4x6 labels) * Laser printer Commercial invoices (8.5x11 / A4) - only for orders/markets that do not support electronic invoices **Setting Up a Global-e Carrier** To set up a Global-e carrier: 1. Navigate to your ShipStation account (*Shipping > Carriers*). 2. Add a Carrier Account and search for **Global-e**: ![](https://mintcdn.com/globale-enterprise/Y9kOYXcjhJOFS_VF/images/shipstation/shipstation-add-carrier-account.png?fit=max\&auto=format\&n=Y9kOYXcjhJOFS_VF\&q=85\&s=6a821095a5be492265ad6b03eff9ccaa) 3. Enter a production Merchant GUID in the window: ![](https://mintcdn.com/globale-enterprise/Y9kOYXcjhJOFS_VF/images/shipstation/shipstation-merchant-guid.png?fit=max\&auto=format\&n=Y9kOYXcjhJOFS_VF\&q=85\&s=4654ddbfcfc1ad1df4375670e2ec4c54) **Processing Orders** Once configured as described above, Global-e orders are automatically assigned to the Global-e carrier service. No additional service or package selection is required, and labels can be printed directly using the **Print Label** button. ![](https://mintcdn.com/globale-enterprise/Y9kOYXcjhJOFS_VF/images/shipstation/shipstation-print-label.png?fit=max\&auto=format\&n=Y9kOYXcjhJOFS_VF\&q=85\&s=f0e2ca6e3fa651105944415f936e1efa) When an order is processed, the **Shipments** tab shows the order associated with a Global-e service: ![](https://mintcdn.com/globale-enterprise/Y9kOYXcjhJOFS_VF/images/shipstation/shipstation-shipments-tab.png?fit=max\&auto=format\&n=Y9kOYXcjhJOFS_VF\&q=85\&s=d72c1542eeb127c8227c1070ef60a2f5) **Creating Split Parcels in ShipStation** Creating a split parcel via ShipStation is a simple process. When you view an order in a ShipStation environment that has multiple items, the **Split Ship** button is displayed: ![](https://mintcdn.com/globale-enterprise/Y9kOYXcjhJOFS_VF/images/shipstation/shipstation-split-ship-button.png?fit=max\&auto=format\&n=Y9kOYXcjhJOFS_VF\&q=85\&s=abd21b191a03e94b2597523f27caf6ce) Then you can select a shipment to associate the item with: ![](https://mintcdn.com/globale-enterprise/Y9kOYXcjhJOFS_VF/images/shipstation/shipstation-select-shipment.png?fit=max\&auto=format\&n=Y9kOYXcjhJOFS_VF\&q=85\&s=d04deb548611719dacdbe5b34d78a00c) When the new shipment is created, they are displayed on the original order screen. At this point you can print the labels for each shipment when ready. The Print Label button in the right side of the screen is enabled, indicating that a shipment is selected. The title of this section (**Configure Shipment 1 of 2**, for example), increases in number corresponding to the amount of shipments you select: ![](https://mintcdn.com/globale-enterprise/Y9kOYXcjhJOFS_VF/images/shipstation/shipstation-configure-shipment.png?fit=max\&auto=format\&n=Y9kOYXcjhJOFS_VF\&q=85\&s=b0fc186455f266e63396c15c39f2df8f) In the case of this split shipment example, two parcels would be created in the Global-e Admin portal. **Shipping Documents** The general rule for shipping documents is that you must print all documents provided through the Global-e service. In most cases, shipping and customs documentation is generated electronically and no printing is required. However, depending on the carrier and destination, certain documents, such as shipping labels or commercial invoices, may need to be printed. The following table describes the supported document types and their purpose.
Document TypePurpose
Final mile shipping label ![](https://mintcdn.com/globale-enterprise/Y9kOYXcjhJOFS_VF/images/shipstation/shipstation-final-mile-label.png?fit=max\&auto=format\&n=Y9kOYXcjhJOFS_VF\&q=85\&s=519bb7e607d5bfb673c648cdded8b1e2) Carrier final mile label. In the illustration here this is DHL Express. Note: for DHL Express, the "PLT" indication on the label means paperless-trade, in other words the commercial invoice for this shipment is electronic and no customs form is needed to print.
Global-e Commercial Invoice / Customs Document ![](https://mintcdn.com/globale-enterprise/Y9kOYXcjhJOFS_VF/images/shipstation/shipstation-commercial-invoice.png?fit=max\&auto=format\&n=Y9kOYXcjhJOFS_VF\&q=85\&s=f063e8cae326c07ecc4c461371367dfd) For most orders (at least 95%) it is electronically generated and there is nothing needed to print. However, the carrier may require a physical paperwork for your order/destination, in this case ShipStation will generate the Commercial Invoice to print. Two copies are provided for in such case and are required by carriers, one affixed to the box, and one handed to the carrier driver at pickup.
The Global-e Commercial Invoice is also reachable in ShipStation via **Print > Customs Form**. **Verifying an Order is Marked as Fulfilled in Shopify** You must check your order in Shopify to ensure that it has been fulfilled by ShipStation, and the shipment confirmation email was triggered from Shopify. This can be found in the Shopify order timeline. **Processing the End of Day Manifest** Global-e requires merchants to generate an End of Day (EOD) manifest once per day before the carrier collects the outgoing shipments. The EOD manifest is not processed from within ShipStation: log in to the Global-e Admin portal and process the EOD action there. See [EOD Manifest](/eod-manifest-sdk-api). **Configurations** The following table shows the configurations: | Configuration Setting | Value | | - | - | | Shipping Methods | Express | | Label Format | PDF (can support ZPL if necessary) | | Order ID | Shopify Order Number | | Product ID | SKU | ## Third Party Systems For merchants using the **ERP Cin7**, ShipStation includes a built-in connector for importing order data from Cin7. When importing orders into ShipStation, merchants can map the Global-e carrier to a shipping service within Cin7. In the screenshot below, 'Express Courier (Air)' is mapped to the shipping service 'Global-e Package'. This mapping is used to identify Global-e orders within ShipStation. ![](https://mintcdn.com/globale-enterprise/Y9kOYXcjhJOFS_VF/images/shipstation/shipstation-cin7-mapping.png?fit=max\&auto=format\&n=Y9kOYXcjhJOFS_VF\&q=85\&s=c9e98f2a836ba599cd5491f05374d26e) For merchants using a **middleware solution**, the ShipStation to Global-e connector can still be reused. However, orders will be imported from Shopify into ShipStation as a custom store integration rather than through the native Shopify integration. ## Frequently Asked Questions **Where can I get my Merchant GUID to connect to Global-e?** All Global-e merchants are given a unique ID which identifies them on our system. Once you setup an account with Global-e, your dedicated Customer Service Manager (CSM) will send you your Merchant GUID. Please reach out to your CSM if you have an account but don't know your GUID. **I would like to print my labels in ZPL format?** We will need to configure your account in our system in order to print labels in ZPL format. Please reach out to your Customer Service Manager in order to set this up. # Shop Pay on Global-e Source: https://docs.global-e.com/shop-pay-on-global-e ## Overview Shop Pay is now available for merchants in Global-e operated [countries](/countries-supported). It delivers a fast, one-tap checkout with saved details, while Global-e ensures secure processing, duties, taxes, and shipping are calculated correctly. * **Seamless experience:** Shoppers enjoy accelerated checkout with pre-filled details. * **Powered by Global-e:** Transactions are processed securely through Global-e Onsite Payments. * **Consistent flow:** Shop Pay buttons appear on product, cart, and checkout pages across domestic and cross-border purchases. ## Eligibility Merchants must have **Shopify Payments** enabled to access Shop Pay. ## Customer Checkout Flow * **First-time use:** Shopper selects Shop Pay, enters details once, and opts in for future accelerated checkout. * **Returning customers:** Shopper provides email/phone, receives a verification code, and checkout details are pre-filled for one-tap confirmation. * **Dynamic calculation:** Duties, taxes, and shipping are recalculated by Global-e with each address update. * **Payment processing:** The payment is routed via the Global-e gateway (e.g. Stripe, Adyen, Worldpay) using vaulted card data. * **Order completion:** Shopper is redirected to the confirmation page after successful payment. ## Entry Points for Shop Pay * **Checkout page:** Shop Pay appears in the accelerated checkout section. * **Cart page:** If enabled in the theme, Shop Pay appears alongside other accelerated checkout buttons. * **Product page:** “Buy with Shop Pay” button is displayed near the Add to Cart button. * **Shop App:** Customers can complete checkout natively within the Shop App. * **Email/session recognition:** Returning users may be automatically recognized and routed into Shop Pay. ## Shop App Support Once enabled, Shop Pay integrates seamlessly with the Shop App, allowing accelerated checkout and order tracking from Global-e operated countries. ## How to Enable Shop Pay > [!WARNING] > > Note that **both toggles** must be opened to open Shop Pay. ## To enable Shop Pay in Shopify Admin 1. Navigate to the Admin page. 2. Click **Settings** (lower left corner). ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-60296535-3c8d-73ab-f578-61da3e4fc1e7.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=5396f271b5e8ad4b23563f75e2a14d32) 3. Click **Payments**. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ef062085-66f8-4e2b-035c-7684906de38c.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=3a5f85c91239e4ea03ab40fe1f72ebf3) 4. Ensure Shopify Payments are installed. 5. Do one of the following: * **If Shopify Payments is already installed and enabled** - continue with Step 8. * **If Shopify Payments has not been installed** - complete this procedure with Account Owner privileges. 6. Click **Switch to Shopify Payments**. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9b89079b-3845-7646-09b1-09cedf31f30e.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=e61ad4856380d89ccac556a179939e7a) 7. Click **Set up Shopify Payments** popup. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-52482081-d8b0-b79a-8133-aafeb5e8bd92.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=21b98cfc9170a4d7ed4f37363c1e0d5e) Activating **Set up Shopify Payments** does not impact ongoing Global-e payments. 8. While in the **Payment** section, click **Global-e Onsite Payments**. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-63c89032-b023-86c4-083f-c69eca8fa629.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=fa06bcd5f002967c82333e712d32c82b) 9. Enable the **Shop Pay toggle** setting and click **Save**. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-88bd1397-a145-681e-940f-9d305e3f5376.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=e10b729cd09610a5b5071528bf9ed02d) 10. In **Shopify Admin**, navigate to **Apps > Global-e CrossBorder > Settings**. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-63bbf810-a9a5-a602-054f-b45770e895d8.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=0201efd7e182515c3a3798e3ccbc7b86) 11. Enable the **Global-e Shop Pay toggle** and click **Save**. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-15d95bf4-85a4-b2ff-cfbc-4eb4435eba7e.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=7959c39700342d9102d867111e244085) > [!NOTE] > > It may take up to 1 hour for the Shop Pay button to appear across product, cart, and checkout pages after enabling. To add Shop Pay buttons on product and cart pages, follow: [Shopify Help Center – Adding and removing accelerated checkout buttons](https://help.shopify.com/en/manual/online-store/dynamic-checkout/add-buttons). ## FAQ * **Q:** Can Shop Pay be enabled in Sandbox? **A:** Yes. The same configuration steps apply as in Production. * **Q:** Will Shop App be supported? **A:** Yes. Once Shop Pay is enabled, shoppers can complete purchases through the Shop App in Global-e operated countries. Merchant search will be available by EOY. * **Q:** Will Shop Pay add extra fees? **A:** No. Merchants pay the same Shopify Payments fees as before, with no additional charges. * **Q:** Can Shop Pay be added to cart and product pages? **A:** Yes. Merchants can enable accelerated checkout buttons in their Shopify Admin theme settings. * **Q:** Is Shop Cash supported on Global-e Shop Pay? **A:** No, at this stage we don’t support it. We are working to allow it in the coming weeks. * **Q:** Is shop Pay finance reconciliation done on Shopify? **A:** No, Shop Pay on Global-e is done like any other credit card order reconciliation via Global-e and not Shopify. The order is charged via Global-e Onsite Payments like any other order. # Shopify Native Source: https://docs.global-e.com/shopify-native The Global‑e integration with Shopify enables merchants to expand globally, process payments in multiple currencies, accurately calculate duties and taxes, streamline shipping, comply with regulations, and make data-driven optimizations. ## Integration Features Shopify's look, feel, and functionality, are enhanced with the Global‑e cross-border capabilities. | Feature | By | | - | - | | Browsing | Shopify | | Price calculation | **Global‑e** or Shopify | | Checkout flow | Shopify | | Shipping methods and pricing | **Global‑e** (embedded as a carrier service in Shopify checkout) | | Duties & Taxes calculation | **Global‑e** (embedded as a carrier service in Shopify checkout) | | Payment methods | **Global‑e** (embedded as a payment app in Shopify checkout) | | Merchant Of Record | **Global‑e** (embedded as a payment app in Shopify checkout) | | Customer communications | Shopify | | Gift cards, coupons, etc. | Shopify | | Product restrictions | Global‑e (embedded in Shopify browsing) | ## Native Product State * Available on Shopify Advanced and Plus plans * Out-of-stock refunds are available from the Global‑e Web Portal or the Shopify Admin with recalculation of Duties & Taxes * Returned product refunds done from Shopify include product tax paid by the customer - Using Global‑e Web Portal allows prepaid labels with the cost deducted from the refund * Draft Orders are supported * Refund an order using a gift card on Shopify Plus only ## Installation To install the Global-e apps, see [Installation](/installation-shopify-native). # Shopping / Marketing Feeds (Liquid Storefronts) Source: https://docs.global-e.com/shopping---marketing-feeds **Domestic Feeds** To prevent price mismatches between the feed and the prices appearing on the storefront due to automatic geo-IP detection and redirection features, you must update the product links in their domestic feeds. All domestic product links should append the country parameter with the 2-letter country code of their domestic market. **Example**: For a US merchant: [https://www.mystore.com/products/red-shirt?country=US](https://www.mystore.com/products/red-shirt?country=US) Failure to do this may result in warnings from Google, after which they will prevent your from submitting marketing feeds. **International feeds** There are 3 main methods you can use to generate an international Marketing feed: * Using supported Shopify apps (recommended). * Manually generating the feed yourself by writing a custom script or program, or creating an Excel sheet. * Using a 3rd party service such as [Feedonomics](https://feedonomics.com/) or [Channel Advisor](https://go.channeladvisor.com/BigCommerce-ChannelAdvisor.html). **Supported Shopify apps** The following apps are compatible with Shopify Markets' multi-currency features: * [Multifeed Google Shopping Feed](https://apps.shopify.com/multiple-google-shopping-feeds?show_store_picker=1) * [GoDataFeed](https://apps.shopify.com/godatafeed?show_store_picker=1) * [Mulwi](https://apps.shopify.com/omega-shopping-feeds?show_store_picker=1) **Pricing in the feed** International prices in marketing feeds must be retrieved from the Shopify platform to ensure they are correct. Due to the complexity of doing this via the APIs, most merchants use a compatible app, which can easily generate the feeds with the correct localized prices. Alternatively, if you are using a 3rd party vendor such as Feedonomics, they will handle this for you. Feedonomics will have you create a custom app and share the API key with them.  This will allow them to retrieve the international prices directly from the Shopify contextualized price API **Shopify Markets API for product price retrieval:** * [https://shopify.dev/custom-storefronts/internationalization/international-pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * [https://shopify.dev/api/admin-graphql/2022-01/queries/priceList](https://shopify.dev/api/admin-graphql/2022-01/queries/priceList) **Retrieving Prices Manually** To generate your own marketing feed you need to generate the prices manually in one of the following ways: * Get the price data via Shopify Product Feeds feature. This is the most efficient and thus preferred method to retrieve all product pricing data. For more information see [Developer Changelog](https://shopify.dev/changelog/contextual-product-feeds-are-generally-available), [Product Feeds,](https://shopify.dev/docs/api/admin-graphql/2023-07/queries/productFeeds) and [Contextual Product Feeds](https://shopify.dev/docs/apps/build/sales-channels/contextual-product-feeds) * Get the price data via Shopify storefront API. For more information see [Query Product Prices.](https://shopify.dev/docs/custom-storefronts/building-with-the-storefront-api/markets/international-pricing#query-product-prices) * Get the price data via Shopify Admin API. * Option 1: * Step 1: Get the price ID for each market. For example, CA Price, AU Price etc. See [Pricelists API](https://shopify.dev/docs/api/admin-graphql/2023-07/queries/priceLists). * Step 2: Get the localized price for each product, using the price IDs. See [Pricelist API](https://shopify.dev/docs/api/admin-graphql/2023-07/queries/priceList) * Option 2: use the `contextualPricing` request to retrieve the price for each variant and country combination. For example, replacing `ProductVariant` and country with each request: ``` { productVariant(id:"gid://shopify/ProductVariant/39999460245576") { id product{id} contextualPricing(context:{country:CA}) { price{amount, currencyCode} compareAtPrice{amount, currencyCode} } } } ``` > [!NOTE] > > These queries can be set up as [bulk operation](https://shopify.dev/docs/api/usage/bulk-operations/queries)s which do not count against rate limits but may take significantly longer to complete. **Updating product links** The following methods allow you to update your product links to include the targeted international country by leveraging: * Shopify’s Deep Linking feature: Include a country parameter in your product links ([https://help.shopify.com/en/manual/markets/international-domains/directing-customers/deep-links](https://help.shopify.com/en/manual/markets/international-domains/directing-customers/deep-links)) Example: \[https\://merchant_url/products/t-shirt?country=DE]\(https\:// https\://merchant_url/products/t-shirt?country=DE) \[Product page for Germany] * Shopify’s subfolder feature. This feature is required if you plan to use the Shopify translation features and requires additional configuration by Global‑e. Example: * [https://merchant_url/en-de/collections/products/t-shirt](https://merchant_url/en-de/collections/products/t-shirt) \[Product page for Germany] * [https://merchant_url/en-ca/collections/products/t-shirt](https://merchant_url/en-ca/collections/products/t-shirt) \[Product page for Canada] > [!NOTE] > > For headless merchants: Any country-specific URL logic for your Shopping feeds must be implemented by your development team, as the above-documented methods only work for Liquid-based storefronts out of the box. For more information, see [Headless section under Shopping / Marketing Feeds](/headless-integration#shopping-/-marketing-feeds-headless). **Country and language considerations** If you have subfolders enabled, you can use the subfolders in your product URLs. **Example**: [https://mystore.com/\*\*en-ca\*\*/product/shoes](https://mystore.com/**en-ca**/product/shoes) You can also use the country parameter, regardless of the subfolder settings. If you do have subfolders enabled, this link will redirect the customer to the appropriate subfolder. **Example:** [https://mystore.com/product/shoes](https://mystore.com/product/shoes) **?country=CA** You can use the subfolder and country parameter together, but this is redundant and not recommended. **Example:** [https://mystore.com/\*\*en-ca\*\*/product/shoes?\*\*country=CA](https://mystore.com/**en-ca**/product/shoes?**country=CA)\*\* Note: If the countries do not match, the country parameter takes precedence. If you have translations for a country’s default language, you can use subfolders to indicate that in the product URL. **Example**: [https://mystore.com/\*\*es-es\*\*/product/shoes](https://mystore.com/**es-es**/product/shoes) **Timing** * Merchants in PCE countries: You should generate your feeds at 5:00 AM UTC to ensure the daily FX price updates are completed. This configured time may shift to an hour earlier during daylight savings time. * Merchants in CBS countries: You should generate your feed at 1AM UTC to ensure the updated country FX rate is in Shopify. **Shipping rates** To ensure a smooth experience, you'll want to define your shipping rates in the **Google Merchant Center (GMC)** using the **range-based** option. These rates should match what you've set up in the **Flat Shipping Rates** section of your **Global-e admin**. Most of our merchants simply copy the shipping rate settings from Global-e into GMC, which helps prevent any mismatches or errors. If you’re not currently using flat rates, we recommend reaching out to your **Customer Success Manager**\*\*(CSM)\*\* to discuss switching to flat rates for the countries you’re marketing to. **Tax rates (US Shipping Only)** If you're shipping to the **United States** through Global-e, here are some important notes regarding **sales tax settings** in GMC. If you're considering building **state-specific tax rates into your product feed**, please note that this is not something we currently support directly. You’d need to manage those configurations yourself. Google requires you to enable sales tax settings based on your tax obligations. If this setting is **not enabled**, Google will assume a 0% tax rate across the board, which could create mismatches at checkout and trigger warnings in your account. Here are a few options for how you can manage US tax rates in GMC: 1. **Include tax rates per item** in your product feed – This is a more complex setup and may require more ongoing maintenance. 2. **Set a state-level rate** in GMC: * Choose a **specific rate** if your products all fall under the same classification. * Or use the **maximum rate for each state** to avoid potential mismatches. 3. **Let Google automatically calculate the tax rate** – this is the easiest option, and we’ve seen many brands use it successfully. Google will check that the correct rate is applied when validating your feed. Please refer to Google’s help page on instructions on how to configure these settings: [Set up tax settings (US only) - Google Merchant Center Help](https://support.google.com/merchants/answer/160162?hl=en). At Global-e, we use **Avalara** to calculate sales tax in the US, so all tax rates applied at checkout are based on product classifications and align with state guidelines provided on Avalara’s [State Sales Tax Rates](https://www.avalara.com/taxrates/en/state-rates.html) page. # Shopware Source: https://docs.global-e.com/shopware The Global‑e integration with Shopware 6 enables merchants to expand globally, process payments in multiple currencies, accurately calculate duties and taxes, streamline shipping, comply with regulations, and make data-driven optimizations. **In this section:** * [Installation](/installation-shopware) * [Integration](/integration-shopware) # Site Customization Source: https://docs.global-e.com/site-customization-merchants The **Site Customization** feature lets you set the look and feel and behavior of the following site usage stages: * [Desktop vs Mobile Dimensions](/site-customization-merchants#desktop-vs-mobile-dimensions) * [Accessing the Customization Page](/site-customization-merchants#accessing-the-customisation-page) * [Configuring Your Welcome Popup Page](/site-customization-merchants#configuring-your-welcome-popup-page) * [Configuring Your Switcher Popup Page](/site-customization-merchants#configuring-your-switcher-popup-page) * [Configuring Your Shipping Banner Page](/site-customization-merchants#configuring-your-shipping-banner-page) * [Configuring Your Checkout Page](/site-customization-merchants#configuring-your-checkout-page) * [Page Design](/site-customization-merchants#page-design) ## Desktop vs Mobile Dimensions ### Overview Global-e Site Customization screens may render differently on Desktop and Mobile devices. This section describes the Desktop versus Mobile differences for each of the four customizable screen types (Welcome Pop-Up, Country Switcher, Marketing Banner, and Checkout) including recommended dimensions, customization scope, and any mobile-specific behavior. All four screen types support 27 languages. Edits made to one language do not update the others. For consistency, apply translated changes manually across all language versions. Deliver your mock-up in one of the following formats: * PSD * XD * Online design (e.g., [Zeplin](https://zeplin.io/)) * Image (PNG or JPEG recommended; other formats supported) * PDF ### Tier Availability The Desktop versus Mobile distinction applies across all merchant tiers (Enterprise, Pro, and NCE). However, which screen types a merchant can edit depends on their tier: | Screen Type | Enterprise | Pro | NCE | | - | - | - | - | | Welcome Pop-Up | ✓ | ✓ | ✗ | | Country Switcher | ✓ | ✓ | ✗ | | Marketing Banner | ✓ | ✓ | ✓ | | Checkout | ✓ | ✓ | ✗ | NCE merchants are restricted to the Marketing Banner screen only. For Pro and Enterprise merchants, all four screen types are available, and the Desktop versus Mobile distinction described in this section fully applies. ### Welcome Pop-Up ### Pop-Up Types | Variant | Description | | - | - | | Desktop Welcome Pop-Up | Fully customizable pop-up supporting brand styling - fonts, images, background, and interactive elements. | | Mobile Welcome Pop-Up | Simplified pop-up with fixed dimensions, optimized for mobile devices. | ### Customization Scope | Aspect | Desktop | Mobile | | - | - | - | | Customization scope | Full customization of fonts, images, background, and interactive elements | Limited-only font size, style, and color are adjustable, provided that dimensions are correct | | Pop-up size | Configurable height and width | Fixed-cannot be resized | | Primary call-to-action | Standard action button | Action button is hidden; replaced by an inline text link | ### Customizable Elements (Desktop) The following figure shows the Welcome Pop-Up screen on **Desktop**: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2c4af10c-4321-8f59-f9de-987047cc253b.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=f3400c7601bef4242f1d2168b0990e7e) The following figure shows the Welcome Pop-Up screen on **Mobile**: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-10ac347e-79d6-edb8-be61-2b43b3283588.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=67a40f4335dc20fd60f08fcd92183548) | # | Element | What is Customizable | | - | - | - | | 1 | Logo | Image | | 2 | Title | Font style, font size, font color | | 3 | Message text | Font style, font size, font color | | 4 | Background | Background color, background image | | 5 | Action Button | Font style, size, color; button color; button width; button height; button location coordinates (left, top) | | 6 | Link | Font style, size, color; link location coordinates (left, top) | | 7 | Size | Pop-up height; pop-up width | > [!NOTE] > > If fonts are not Google Fonts, the merchant must provide the font files in .ttf or .otf format. ### Mobile-Specific Behavioral Note Following Google's 2017 Mobile Pop-Up Penalty, the mobile Welcome Pop-Up is disabled by default. Merchants who choose to enable it must comply with Google's "non-intrusive" mobile pop-up guidelines. ### Recommended Dimensions | Element | Full Client Screen Size | Element Size | | - | - | - | | Desktop | W: 1920 × H: 1080 px | W: 550 × H: 500 px | | Mobile | 375 px | W: 340 × H: 180 px (fixed) | ### Country Switcher Pop-Up ### Pop-Up Types The following table shows the pop-up types: | Variant | Description | | - | - | | Desktop Country Switcher Pop-Up | Fully customizable pop-up matching the look and feel of the website, with configurable dimensions and styling. | | Mobile Country Switcher Pop-Up | Simplified pop-up with reduced dimensions and a streamlined element set, optimized for mobile devices. | ### Customization Scope The following table shows the customization scope: | Aspect | Desktop | Mobile | | - | - | - | | Customization scope | Full customization of styling, fonts, and elements | Reduced-main content area is replaced with a mobile-specific variant; certain desktop-only elements are hidden | | Pop-up size | Configurable height and width | Adjusted dimensions optimized for mobile (see [Recommended Dimensions](#recommended-dimensions-1)) | | Title font size | 24 px (default) | 21 px (default) | | Content padding | Standard padding for desktop layout | Reduced padding for mobile layout | ### Recommended Dimensions The following table shows the recommended dimensions: | Element | Full Client Screen Size | Element Size | | - | - | - | | Desktop | W: 1920 × H: 1080 px | W: 550 × H: 500 px | | Mobile | 375 px | W: 340 x H: 285 px | > [!NOTE] > > The Mobile Country Switcher (340 × 285 px) is taller than the Mobile Welcome Pop-Up (340 × 180 px) to accommodate the country and currency selection content. ### Shipping Banner ### Rendering Across Devices The Shipping Banner renders identically on Desktop and Mobile. There is no separate Desktop or Mobile variant-the banner uses a fluid container that spans the full width of its parent element on every device. The same configuration (background color, height, font, and text color) applies to all viewports. ### Customization Scope The following tables shows the customization scope: | Element | What is Customizable | | - | - | | Background color | Color of the banner background | | Banner height | Specified in pixels by the merchant | | Font | Font family for the banner text | | Text color | Color of the banner text | All four customization options apply equally to Desktop and Mobile. ### Styling Precedence Note ### Styling Precedence Note If the container hosting the banner on the merchant's site includes its own CSS properties, the styling configured via the Site Customization editor may not take effect. In such cases, the merchant must adjust their container CSS to allow the banner styling to apply. The following tables shows the recommended dimensions: | Aspect | Value | | - | - | | Width | 100% of the container (fluid; not configurable) | | Height | Configurable in pixels by the merchant; no recommended fixed value | ### Checkout Page ### Page Variants | Variant | Description | | - | - | | Desktop Checkout | Standard checkout layout including Order Summary, Billing and Shipping Addresses, Shipping Method, and Billing Summary / Payment, with full express checkout payment buttons. | | Mobile Checkout | Same content as Desktop, arranged responsively for mobile screen widths, with mobile-optimized express checkout payment buttons. | ### Customization Scope All Checkout customization options apply equally to Desktop and Mobile. The same configuration is served to both viewports-there is no separate mobile customization layer. The following tables describes the customization scope elements: | # | Element | What is Customizable | | - | - | - | | 1 | Header Logo | Image / HTML | | 2 | Background | Background color | | 3 | Language Selector | Text font, drop-down input style | | 4 | Titles Area | Background color, text font, text color | | 5 | Order Summary Area | Product Name, Product Attributes, Qty/Price/Total, Items Total-each: font-face, size, color | | 6 | Forms Styles | Input text-font-face, size, drop-down style | | 7 | Billing Summary | Field titles and values-font-face, size, color (can differ for titles vs. values); Total title and value-same | | 8 | Pay Button | Button background, font-face, size, color | | 9 | Footer | Width, background, font-face, size, color | ### Layout Note The Checkout page layout is fixed and cannot be changed. This applies to both Desktop and Mobile. ### Mobile-Specific Behavioral Note On Mobile, the height of the Checkout screen adjusts dynamically to the contents of the checkout and confirmation screens for each device. The Checkout page typically contains more content than the Confirmation page, and the mobile height adjusts accordingly. For this reason, a fixed mobile height value is not required. ### Recommended Dimensions **Desktop:** | Element | Full Client Screen Size | Element Size | | - | - | - | | Checkout / Confirmation | W: 1920 × H: 1080 px | W: 1000 px-auto height | **Mobile:** | Aspect | Value | | - | - | | Width | Responsive-adapts to the mobile viewport (no fixed width) | | Height | Dynamic-adjusts to content (see [Mobile-Specific Behavioral Note](#mobile-specific-behavioral-note-1) above) | ## Accessing the Customisation Page To customize your page configurations, you must access the **Customization** page. ### To access the Customization page 1. Navigate to Configuration > Customization from the top menu: ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a899fa2b-72b7-cc6e-7841-916706a24ae9.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=3a9967f79f96d845ac337f792fe26e5a) 2. Select a merchant from the Merchant menu. The following page is displayed. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-53b29ad6-55af-2bda-edf0-525ee8924654.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=966269b546b879da63c88fdfce527efa) 3. Configure the elements above according to the table below: | No. | Element | Description | | - | - | - | | 1 | [Welcome Popup tab](/site-customization-storefront#configuring-your-welcome-popup-page) | View, modify, and manage elements related to your Welcome popup screen. | | 2 | [Switcher Popup tab](/site-customization-storefront#configuring-your-switcher-popup-page) | View, modify, and manage elements related to your Switcher Popup screen. | | 3 | [Free Shipping Banner tab](/site-customization-storefront#configuring-your-shipping-banner-page) | View and modify your shipping banner page configuration. | | 4 | [Checkout tab](/site-customization-storefront#configuring-your-checkout-page) | Configure your checkout page. | ## Configuring Your Welcome Popup Page The **Welcome Pop-Up** displays a localized message to shoppers when they land on your store, helping communicate delivery eligibility, duties and tax logic, and any free-shipping thresholds. It supports full branding customization on Desktop and limited, fixed-size customization on Mobile. From here, you can view, modify, and manage all elements related to your Welcome Pop-Up screen. The default language is English, with professionally translated versions available in twenty-seven languages to support your localization needs. This page includes a text editor preloaded with template content for your site’s pop-up message, along with a **Preview** panel located to the right of the editor. From here you can configure the following, described below: * Message text (body and title) * Automatic text * Design settings * Preview options The following figure shows the Welcome Pop-Up screen on **Desktop**: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2c4af10c-4321-8f59-f9de-987047cc253b.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=f3400c7601bef4242f1d2168b0990e7e) The following figure shows the Welcome Pop-Up screen on **Mobile**: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-10ac347e-79d6-edb8-be61-2b43b3283588.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=67a40f4335dc20fd60f08fcd92183548) The following table lists the customizable elements for Desktop and Mobile Welcome Pop-Ups. | # | Element | Customizable | | - | - | - | | 1 | Logo | Image | | 2 | Title | Font style, font size, font color | | 3 | Message text | Font style, font size, font color | | 4 | Background | Background color, background image | | 5 | Action Button | Font style, font size, font color; button color; button width; button height; button location coordinates (left, top) | | 6 | Link | Font style, font size, font colour; link location coordinates (left, top) | | 7 | Size | Pop-up height; Pop-up width | > [!WARNING] > > If you edit the text in one of the language versions, the text edits are only applied to that specific language version - the text in the other language versions remains unchanged. To avoid having language versions with inconsistent text, when you edit the text of a specific language, apply the same (translated) text edits to the remaining twenty-six languages. > > Three placeholders for automatic text (Country, Shipping message, and Duties payment message) are incorporated in the default text. We advise that you use our automatic text bullets to convey to your shoppers a clear message about their shipping options as well as tax and duty payment. 1. Follow steps 1 and 2 in [Accessing the Customisation Page](/site-customization-storefront#accessing-the-customisation-page). 2. Modify the following elements: * Default language setting menu located above the Preview panel. The English language version of the Welcome pop-up is viewed by site visitors from countries that do not have a localized (translated) version of the pop-up. * Automatic text (optional) to be used in your welcome popup message: * **\{Country} parameter**: Informs shoppers that the goods can be delivered to their country. * **\{Shipping message} parameter**: informs shoppers about the lowest cart range required to qualify for free shipping to their country. * **\{Duties payment message} parameter**: informs shoppers about the duties payment option required for their country during checkout. > [!NOTE] > > When a customer visits your store, Global-e detects their location and automatically inserts the country name, and displays the relevant messages regarding shipping and duties & taxes. * Design settings (show/hide your logo). * Preview options: * Free shipping: * **Available** - Minimum order required for free shipping. Default message: *Enjoy free shipping for all orders above \$x* * **Unavailable** - Free shipping not available. Default message: *Enjoy our great international shipping rates* * **To all** - Free shipping on all orders. Default message: *Free shipping to (your country) on all orders* * Duties at checkout: * **Payable** - Duties are displayed separately at checkout with the option to prepay. Default message: *Duties & Taxes calculated at checkout - choose to pay now or later* * **Hidden** - Duties are incorporated in the product price. Default message: *All Duties & Taxes are already included - no hidden fees* * **Partial** - Duties are incorporated in the product price, with taxes displayed separately at the checkout with the option to prepay. Default message: *All duties are already included. Taxes calculated at checkout* * Button message and formatting. * Normal and hover mode text, body, and border color settings. > [!NOTE] > > You can reset your settings to their default configurations by clicking Reset to default at the bottom of the page. ### Screen Dimensions for Desktop and Mobile The following table shows the recommended element dimensions for the **Desktop** screens or popup windows. The **Mobile** Welcome popup has a fixed size. | Element | Full Client Screen Size | Element Size | | - | - | - | | **Desktop** | | | | Checkout / Confirmation | W: 1920 X H: 1080px | W: 1000px - auto height | | Welcome / Switcher pop-ups | W: 1920 X H: 1080px | W: 550 X H: 500px | | **Mobile** | | | | Mobile Welcome Pop-Up | 375 px | 340 × 180 px (fixed) | The following are some examples of Welcome popup screens: > [card] > > ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-58d1729d-36fe-d3c0-b856-971f8d315ee3.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=a12cf5da44befb8193126147b8e582ce) > [card] > > ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7bda2dea-935f-5cb2-b8ac-06642de9138e.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=f5585bb5846356fe6fc696b13a2fd56c) > [card] > > ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8069038e-87b9-62c4-4d1a-bfa72633e156.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=7700d34b237a35c5611db60ebebaa764) > [card] > > ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c4440287-2308-5858-22fb-b6297d126c45.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=ec807745d508e3a0986ee4a142c8a307) > [!NOTE] > > Following Google’s 2017 Mobile Pop-Up Penalty, the mobile pop-up is disabled by default. Merchants who enable it must comply with Google’s “non-intrusive” guidelines. ## Configuring Your Switcher Popup Page From here you can view, modify, and manage elements related to your Switcher Popup screen. This page includes a text editor containing some default template text to display as your site’s popup message. It also includes a Preview panel located to the right of the text editor. ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fceb5eb0-1229-da2b-c586-6d703ac04275.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=1fc62354d8bb34f1162b4f17ff7ff1b3) ### Configure your switcher screen 1. Follow steps 1 and 2 in [Accessing the Customisation Page](/site-customization-storefront#accessing-the-customisation-page). 2. Click Switcher Popup. 3. Modify the following design elements as needed: * Text editor * Design settings 4. Click Save or Cancel. ## Configuring Your Shipping Banner Page From here you can view and modify your shipping banner page configuration. A live preview of your configurations is displayed on the right side of the page. Note that you can reset your settings to their default configurations by clicking Reset to default at the bottom of the page. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b7a572e2-a5ad-6d95-73c0-5e439c2721f0.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=b8fdb3249b869f78a51a1b773ede9368) ### Configure your Free Shipping Banner page 1. Follow steps 1 and 2 in [Accessing the Customisation Page](/site-customization-storefront#accessing-the-customisation-page). 2. Click Free Shipping Banner. 3. Click Show banner on website. 4. Modify the Design settings section as needed. 5. Modify your list of countries (optional): 1. Click list of countries. 2. Select all of the relevant countries. 3. Click OK. 6. Select a language from the language menu on the far right of the page. 7. Enter the text of your shipping banner message in the text field. > [!NOTE] > > The text in the curly brackets pulls information from the database. Available variables are `{COUNTRY}`, `{CURRENCY}`, and `{FREE_SHIPPING_MIN_AMOUNT}`. All variables must be written in **upper case** exactly as shown — they are case-sensitive. 8. Create an additional group of countries (optional): 1. Click Create additional group of countries. 2. Select a continent from the map. 3. Select your countries from the Create a new group of countries panel. 4. Click OK. 9. Click Save. ## Configuring Your Checkout Page This page describes how to configure your checkout page. A preview of your banner is displayed on the right side of the screen. Note that you can reset your settings to their default configurations by clicking Reset to default at the bottom of the page. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7672da28-c7bd-0620-d031-598b4da7318a.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=b276b8e163f1aa4add829b8b84b8750d) ### Configure your shipping banner screen 1. Follow steps 1 and 2 in [Accessing the Customisation Page](/site-customization-storefront#accessing-the-customisation-page). 2. Click Checkout. 3. Select a language from the language menu located at the far right of the page. 4. Modify the following design settings as needed: * **Logo** - Lets you resize and adjust the logo in all places where it appears, such as the Checkout page and customer facing notification emails. * **Title bars and footer** - Lets you set the background and text color of your title bars and footers. * **Text** - Lets you set the body text color. * **Payment button (Pay and place order)** - Lets you set the text, size, and text type of the Payment button * **Coupon button (Apply)** - Lets you set the text, size, and text type of the Apply button. * **Normal mode** - Lets you set the button text color, body color, and border color for the selected button (Pay and place order or Apply). * **Hover mode** - Lets you set the color shown when you hover over the selected button (Pay and place order or Apply). * **Total price** - Lets you set the color, font, size, and text type of the total price. 5. Click **Cancel**, **Save**, or **Reset to default**. For examples of the appearance of the Checkout page, see [Page Design](/page-design). ## Page Design ### Customizing the Checkout and Confirmation Pages This section details the items that are customisable on both the Checkout and Confirmation pages. * [Checkout page](/page-design#checkout-page) * [Confirmation page](/page-design#confirmation-page) You can use this [Figma page](https://www.figma.com/design/GxlxGPBTZb1D4x2fGXZgiS/Global-e-Classic-Checkout-Confirmation-Pages-for-merchants?node-id=0-1\&p=f\&t=ver2vtyaOIO1Yctn-0) to make any customizations that you require. Duplicate and modify the file as needed. > [!NOTE] > > The checkout page layout is fixed (it cannot be changed). For information about customizing your Checkout page, see [Configuring Your Checkout Page](/site-customization-storefront#configuring-your-checkout-page). # Site Customization Source: https://docs.global-e.com/site-customization-storefront > [!NOTE] > > **This section does not apply to Shopify. For information about Shopify, see [Shopify Native](/shopify-native).** The Site Customisation page describes the following: * [Desktop vs Mobile Dimensions](/site-customization-storefront#desktop-vs-mobile-dimensions) * [Accessing the Customization Page](/site-customization-storefront#accessing-the-customisation-page) * [Configuring Your Welcome Popup Page](/site-customization-storefront#configuring-your-welcome-popup-page) * [Configuring Your Switcher Popup Page](/site-customization-storefront#configuring-your-switcher-popup-page) * [Configuring Your Shipping Banner Page](/site-customization-storefront#configuring-your-shipping-banner-page) * [Configuring Your Checkout Page](/site-customization-storefront#configuring-your-checkout-page) ## Desktop vs Mobile Dimensions ### Overview Global-e Site Customization screens may render differently on Desktop and Mobile devices. This section describes the Desktop versus Mobile differences for each of the four customizable screen types (Welcome Pop-Up, Country Switcher, Marketing Banner, and Checkout) including recommended dimensions, customization scope, and any mobile-specific behavior. All four screen types support 27 languages. Edits made to one language do not update the others. For consistency, apply translated changes manually across all language versions. Deliver your mock-up in one of the following formats: * PSD * XD * Online design (e.g., [Zeplin](https://zeplin.io/)) * Image (PNG or JPEG recommended; other formats supported) * PDF ### Welcome Pop-Up ### Pop-Up Types | Variant | Description | | - | - | | Desktop Welcome Pop-Up | Fully customizable pop-up supporting brand styling - fonts, images, background, and interactive elements. | | Mobile Welcome Pop-Up | Simplified pop-up with fixed dimensions, optimized for mobile devices. | ### Customization Scope | Aspect | Desktop | Mobile | | - | - | - | | Customization scope | Full customization of fonts, images, background, and interactive elements | Limited-only font size, style, and color are adjustable, provided that dimensions are correct | | Pop-up size | Configurable height and width | Fixed-cannot be resized | | Primary call-to-action | Standard action button | Action button is hidden; replaced by an inline text link | ### Customizable Elements (Desktop) The following figure shows the Welcome Pop-Up screen on **Desktop**: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2c4af10c-4321-8f59-f9de-987047cc253b.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=f3400c7601bef4242f1d2168b0990e7e) The following figure shows the Welcome Pop-Up screen on **Mobile**: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-10ac347e-79d6-edb8-be61-2b43b3283588.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=67a40f4335dc20fd60f08fcd92183548) | # | Element | What is Customizable | | - | - | - | | 1 | Logo | Image | | 2 | Title | Font style, font size, font color | | 3 | Message text | Font style, font size, font color | | 4 | Background | Background color, background image | | 5 | Action Button | Font style, size, color; button color; button width; button height; button location coordinates (left, top) | | 6 | Link | Font style, size, color; link location coordinates (left, top) | | 7 | Size | Pop-up height; pop-up width | > [!NOTE] > > If fonts are not Google Fonts, the merchant must provide the font files in .ttf or .otf format. ### Mobile-Specific Behavioral Note Following Google's 2017 Mobile Pop-Up Penalty, the mobile Welcome Pop-Up is disabled by default. Merchants who choose to enable it must comply with Google's "non-intrusive" mobile pop-up guidelines. ### Recommended Dimensions | Element | Full Client Screen Size | Element Size | | - | - | - | | Desktop | W: 1920 × H: 1080 px | W: 550 × H: 500 px | | Mobile | 375 px | W: 340 × H: 180 px (fixed) | ### Country Switcher Pop-Up ### Pop-Up Types The following table shows the pop-up types: | Variant | Description | | - | - | | Desktop Country Switcher Pop-Up | Fully customizable pop-up matching the look and feel of the website, with configurable dimensions and styling. | | Mobile Country Switcher Pop-Up | Simplified pop-up with reduced dimensions and a streamlined element set, optimized for mobile devices. | ### Customization Scope The following table shows the customization scope: | Aspect | Desktop | Mobile | | - | - | - | | Customization scope | Full customization of styling, fonts, and elements | Reduced-main content area is replaced with a mobile-specific variant; certain desktop-only elements are hidden | | Pop-up size | Configurable height and width | Adjusted dimensions optimized for mobile (see [Recommended Dimensions](#recommended-dimensions-1)) | | Title font size | 24 px (default) | 21 px (default) | | Content padding | Standard padding for desktop layout | Reduced padding for mobile layout | ### Recommended Dimensions The following table shows the recommended dimensions: | Element | Full Client Screen Size | Element Size | | - | - | - | | Desktop | W: 1920 × H: 1080 px | W: 550 × H: 500 px | | Mobile | 375 px | W: 340 x H: 285 px | > [!NOTE] > > The Mobile Country Switcher (340 × 285 px) is taller than the Mobile Welcome Pop-Up (340 × 180 px) to accommodate the country and currency selection content. ### Shipping Banner ### Rendering Across Devices The Shipping Banner renders identically on Desktop and Mobile. There is no separate Desktop or Mobile variant-the banner uses a fluid container that spans the full width of its parent element on every device. The same configuration (background color, height, font, and text color) applies to all viewports. ### Customization Scope The following tables shows the customization scope: | Element | What is Customizable | | - | - | | Background color | Color of the banner background | | Banner height | Specified in pixels by the merchant | | Font | Font family for the banner text | | Text color | Color of the banner text | All four customization options apply equally to Desktop and Mobile. ### Styling Precedence Note ### Styling Precedence Note If the container hosting the banner on the merchant's site includes its own CSS properties, the styling configured via the Site Customization editor may not take effect. In such cases, the merchant must adjust their container CSS to allow the banner styling to apply. The following tables shows the recommended dimensions: | Aspect | Value | | - | - | | Width | 100% of the container (fluid; not configurable) | | Height | Configurable in pixels by the merchant; no recommended fixed value | ### Checkout Page ### Page Variants | Variant | Description | | - | - | | Desktop Checkout | Standard checkout layout including Order Summary, Billing and Shipping Addresses, Shipping Method, and Billing Summary / Payment, with full express checkout payment buttons. | | Mobile Checkout | Same content as Desktop, arranged responsively for mobile screen widths, with mobile-optimized express checkout payment buttons. | ### Customization Scope All Checkout customization options apply equally to Desktop and Mobile. The same configuration is served to both viewports-there is no separate mobile customization layer. The following tables describes the customization scope elements: | # | Element | What is Customizable | | - | - | - | | 1 | Header Logo | Image / HTML | | 2 | Background | Background color | | 3 | Language Selector | Text font, drop-down input style | | 4 | Titles Area | Background color, text font, text color | | 5 | Order Summary Area | Product Name, Product Attributes, Qty/Price/Total, Items Total-each: font-face, size, color | | 6 | Forms Styles | Input text-font-face, size, drop-down style | | 7 | Billing Summary | Field titles and values-font-face, size, color (can differ for titles vs. values); Total title and value-same | | 8 | Pay Button | Button background, font-face, size, color | | 9 | Footer | Width, background, font-face, size, color | ### Layout Note The Checkout page layout is fixed and cannot be changed. This applies to both Desktop and Mobile. ### Mobile-Specific Behavioral Note On Mobile, the height of the Checkout screen adjusts dynamically to the contents of the checkout and confirmation screens for each device. The Checkout page typically contains more content than the Confirmation page, and the mobile height adjusts accordingly. For this reason, a fixed mobile height value is not required. ### Recommended Dimensions **Desktop:** | Element | Full Client Screen Size | Element Size | | - | - | - | | Checkout / Confirmation | W: 1920 × H: 1080 px | W: 1000 px-auto height | **Mobile:** | Aspect | Value | | - | - | | Width | Responsive-adapts to the mobile viewport (no fixed width) | | Height | Dynamic-adjusts to content (see [Mobile-Specific Behavioral Note](#mobile-specific-behavioral-note-1) above) | ## Accessing the Customisation Page To customize your page configurations, you must access the **Customization** page. ### To access the Customization page 1. Navigate to Configuration > Customization from the top menu: ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a899fa2b-72b7-cc6e-7841-916706a24ae9.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=3a9967f79f96d845ac337f792fe26e5a) 2. Select a merchant from the Merchant menu. The following page is displayed. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-53b29ad6-55af-2bda-edf0-525ee8924654.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=966269b546b879da63c88fdfce527efa) 3. Configure the elements above according to the table below: | No. | Element | Description | | - | - | - | | 1 | [Welcome Popup tab](/site-customization-storefront#configuring-your-welcome-popup-page) | View, modify, and manage elements related to your Welcome popup screen. | | 2 | [Switcher Popup tab](/site-customization-storefront#configuring-your-switcher-popup-page) | View, modify, and manage elements related to your Switcher Popup screen. | | 3 | [Free Shipping Banner tab](/site-customization-storefront#configuring-your-shipping-banner-page) | View and modify your shipping banner page configuration. | | 4 | [Checkout tab](/site-customization-storefront#configuring-your-checkout-page) | Configure your checkout page. | ## Configuring Your Welcome Popup Page The **Welcome Pop-Up** displays a localized message to shoppers when they land on your store, helping communicate delivery eligibility, duties and tax logic, and any free-shipping thresholds. It supports full branding customization on Desktop and limited, fixed-size customization on Mobile. From here, you can view, modify, and manage all elements related to your Welcome Pop-Up screen. The default language is English, with professionally translated versions available in twenty-seven languages to support your localization needs. This page includes a text editor preloaded with template content for your site’s pop-up message, along with a **Preview** panel located to the right of the editor. From here you can configure the following, described below: * Message text (body and title) * Automatic text * Design settings * Preview options The following figure shows the Welcome Pop-Up screen on **Desktop**: ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2c4af10c-4321-8f59-f9de-987047cc253b.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=f3400c7601bef4242f1d2168b0990e7e) The following figure shows the Welcome Pop-Up screen on **Mobile**: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-10ac347e-79d6-edb8-be61-2b43b3283588.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=67a40f4335dc20fd60f08fcd92183548) The following table lists the customizable elements for Desktop and Mobile Welcome Pop-Ups. | # | Element | Customizable | | - | - | - | | 1 | Logo | Image | | 2 | Title | Font style, font size, font color | | 3 | Message text | Font style, font size, font color | | 4 | Background | Background color, background image | | 5 | Action Button | Font style, font size, font color; button color; button width; button height; button location coordinates (left, top) | | 6 | Link | Font style, font size, font colour; link location coordinates (left, top) | | 7 | Size | Pop-up height; Pop-up width | > [!WARNING] > > If you edit the text in one of the language versions, the text edits are only applied to that specific language version - the text in the other language versions remains unchanged. To avoid having language versions with inconsistent text, when you edit the text of a specific language, apply the same (translated) text edits to the remaining twenty-six languages. > > Three placeholders for automatic text (Country, Shipping message, and Duties payment message) are incorporated in the default text. We advise that you use our automatic text bullets to convey to your shoppers a clear message about their shipping options as well as tax and duty payment. 1. Follow steps 1 and 2 in [Accessing the Customisation Page](/site-customization-storefront#accessing-the-customisation-page). 2. Modify the following elements: * Default language setting menu located above the Preview panel. The English language version of the Welcome pop-up is viewed by site visitors from countries that do not have a localized (translated) version of the pop-up. * Automatic text (optional) to be used in your welcome popup message: * **\{Country} parameter**: Informs shoppers that the goods can be delivered to their country. * **\{Shipping message} parameter**: informs shoppers about the lowest cart range required to qualify for free shipping to their country. * **\{Duties payment message} parameter**: informs shoppers about the duties payment option required for their country during checkout. > [!NOTE] > > When a customer visits your store, Global-e detects their location and automatically inserts the country name, and displays the relevant messages regarding shipping and duties & taxes. * Design settings (show/hide your logo). * Preview options: * Free shipping: * **Available** - Minimum order required for free shipping. Default message: *Enjoy free shipping for all orders above \$x* * **Unavailable** - Free shipping not available. Default message: *Enjoy our great international shipping rates* * **To all** - Free shipping on all orders. Default message: *Free shipping to (your country) on all orders* * Duties at checkout: * **Payable** - Duties are displayed separately at checkout with the option to prepay. Default message: *Duties & Taxes calculated at checkout - choose to pay now or later* * **Hidden** - Duties are incorporated in the product price. Default message: *All Duties & Taxes are already included - no hidden fees* * **Partial** - Duties are incorporated in the product price, with taxes displayed separately at the checkout with the option to prepay. Default message: *All duties are already included. Taxes calculated at checkout* * Button message and formatting. * Normal and hover mode text, body, and border color settings. > [!NOTE] > > You can reset your settings to their default configurations by clicking Reset to default at the bottom of the page. ### Screen Dimensions for Desktop and Mobile The following table shows the recommended element dimensions for the **Desktop** screens or popup windows. The **Mobile** Welcome popup has a fixed size. | Element | Full Client Screen Size | Element Size | | - | - | - | | **Desktop** | | | | Checkout / Confirmation | W: 1920 X H: 1080px | W: 1000px - auto height | | Welcome / Switcher pop-ups | W: 1920 X H: 1080px | W: 550 X H: 500px | | **Mobile** | | | | Mobile Welcome Pop-Up | 375 px | 340 × 180 px (fixed) | The following are some examples of Welcome popup screens: > [card] > > ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-58d1729d-36fe-d3c0-b856-971f8d315ee3.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=a12cf5da44befb8193126147b8e582ce) > [card] > > ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7bda2dea-935f-5cb2-b8ac-06642de9138e.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=f5585bb5846356fe6fc696b13a2fd56c) > [card] > > ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8069038e-87b9-62c4-4d1a-bfa72633e156.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=7700d34b237a35c5611db60ebebaa764) > [card] > > ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c4440287-2308-5858-22fb-b6297d126c45.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=ec807745d508e3a0986ee4a142c8a307) > [!NOTE] > > Following Google’s 2017 Mobile Pop-Up Penalty, the mobile pop-up is disabled by default. Merchants who enable it must comply with Google’s “non-intrusive” guidelines. ## Configuring Your Switcher Popup Page From here you can view, modify, and manage elements related to your Switcher Popup screen. This page includes a text editor containing some default template text to display as your site’s popup message. It also includes a Preview panel located to the right of the text editor. ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fceb5eb0-1229-da2b-c586-6d703ac04275.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=1fc62354d8bb34f1162b4f17ff7ff1b3) ### Configure your switcher screen 1. Follow steps 1 and 2 in [Accessing the Customisation Page](/site-customization-storefront#accessing-the-customisation-page). 2. Click Switcher Popup. 3. Modify the following design elements as needed: * Text editor * Design settings 4. Click Save or Cancel. > [!NOTE] > > To enable the language selection dropdown in the switcher popup, please contact your CSM. ## Configuring Your Shipping Banner Page From here you can view and modify your shipping banner page configuration. A live preview of your configurations is displayed on the right side of the page. Note that you can reset your settings to their default configurations by clicking Reset to default at the bottom of the page. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b7a572e2-a5ad-6d95-73c0-5e439c2721f0.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=b8fdb3249b869f78a51a1b773ede9368) ### Configure your Free Shipping Banner page 1. Follow steps 1 and 2 in [Accessing the Customisation Page](/site-customization-storefront#accessing-the-customisation-page). 2. Click Free Shipping Banner. 3. Click Show banner on website. 4. Modify the Design settings section as needed. 5. Modify your list of countries (optional): 1. Click list of countries. 2. Select all of the relevant countries. 3. Click OK. 6. Select a language from the language menu on the far right of the page. 7. Enter the text of your shipping banner message in the text field. > [!NOTE] > > The text in the curly brackets pulls information from the database. Available variables are `{COUNTRY}`, `{CURRENCY}`, and `{FREE_SHIPPING_MIN_AMOUNT}`. All variables must be written in **upper case** exactly as shown — they are case-sensitive. 8. Create an additional group of countries (optional): 1. Click Create additional group of countries. 2. Select a continent from the map. 3. Select your countries from the Create a new group of countries panel. 4. Click OK. 9. Click Save. ## Configuring Your Checkout Page This page describes how to configure your checkout page. A preview of your banner is displayed on the right side of the screen. Note that you can reset your settings to their default configurations by clicking Reset to default at the bottom of the page. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-7672da28-c7bd-0620-d031-598b4da7318a.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=b276b8e163f1aa4add829b8b84b8750d) ### Configure your shipping banner screen 1. Follow steps 1 and 2 in [Accessing the Customisation Page](/site-customization-storefront#accessing-the-customisation-page). 2. Click Checkout. 3. Select a language from the language menu located at the far right of the page. 4. Modify the following design settings as needed: * **Logo** - Lets you resize and adjust the logo in all places where it appears, such as the Checkout page and customer facing notification emails. * **Title bars and footer** - Lets you set the background and text color of your title bars and footers. * **Text** - Lets you set the body text color. * **Payment button (Pay and place order)** - Lets you set the text, size, and text type of the Payment button * **Coupon button (Apply)** - Lets you set the text, size, and text type of the Apply button. * **Normal mode** - Lets you set the button text color, body color, and border color for the selected button (Pay and place order or Apply). * **Hover mode** - Lets you set the color shown when you hover over the selected button (Pay and place order or Apply). * **Total price** - Lets you set the color, font, size, and text type of the total price. 5. Click **Cancel**, **Save**, or **Reset to default**. For examples of the appearance of the Checkout page, see [Page Design](/page-design). ## Page Design ### Customizing the Checkout and Confirmation Pages This section details the items that are customisable on both the Checkout and Confirmation pages. * [Checkout page](/page-design#checkout-page) * [Confirmation page](/page-design#confirmation-page) You can use this [Figma page](https://www.figma.com/design/GxlxGPBTZb1D4x2fGXZgiS/Global-e-Classic-Checkout-Confirmation-Pages-for-merchants?node-id=0-1\&p=f\&t=ver2vtyaOIO1Yctn-0) to make any customizations that you require. Duplicate and modify the file as needed. > [!NOTE] > > The checkout page layout is fixed (it cannot be changed). For information about customizing your Checkout page, see [Configuring Your Checkout Page](/site-customization-storefront#configuring-your-checkout-page). # Split Cart Discount to Item Level Source: https://docs.global-e.com/split-cart-discount-to-item-level Before getting started you want to ensure that the **Split Cart Discount to Item Level** is set to **enabled**. This ensures that the discount is split up per item instead of being applied to the entire cart. **To enable the Split Cart Discount to Item Level:** 1. From the Magento dashboard navigate to **Stores** > **Configuration**. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-e8489d66-9e85-5933-f8c2-33e35d07543b.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=dd42e50ca6d79726e613ca5d687f24bb) The configuration page opens. 2. Scroll down the page to **Services** and select **Global-e Crossborder.** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-4bd02ac3-42f4-f1a9-56f1-db34bf728999.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=670d3cd80caf8dc5675b091830278974) 3. Scroll down the page to **Checkout/Order** > **Split Cart Discount to Item level**. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-50d887ff-16bf-51bf-18a1-ebe00b7cd400.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=31a1b6ce5cad5bde34b05b2504554095) Make sure the setting is set to **Yes**. 4. At the top-right click **Save Config** if any changes are made. # SSO Integration Source: https://docs.global-e.com/sso-integration-merchant-portal ## Introduction The **System** page describes system information related to user and role management and **Single Sign-On (SSO)** integration. The **Users** page includes the various user and merchant role types and their associated permission levels in easy-to-read tables. The **SSO integration** page provides a background of SSO integration and its components. As part of its solution, Global‑e supports single sign-on with SAML web authentication. Security Assertion Markup Language (SAML) is an open standard that allows identity providers (IdP) to pass authorisation credentials to service providers (SP). SAML is mostly used as a secured web-based authentication mechanism as it relies on using the browser agent to broker the authentication flow. Global‑e plays the role of Service Provider and implements the [ServiceProvider-initiated SSO SAML flow](#service-provider-initiated-flow). For more info on SAML, see: [https://developer.okta.com/docs/concepts/saml/](https://developer.okta.com/docs/concepts/saml/) This document targets the Merchant’s IT personnel or Integrator in charge of performing the SSO integration between the Merchant IdP system and Global-e Merchant Portal. > [!NOTE] > > The end-user (or user) represents the designated Merchant personnel with permission to use the Global‑e Merchant Portal. This could be, for example, a Merchant Admin, Store User, Store Admin, and more. ## General Information ### Service Provider Initiated Flow As the Service Provider (SP), Global‑e initiates the sign-on flow, as illustrated in the following Service Provider Initiated Flow figure. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-9371103e-c819-2b92-86ea-791cb78924c6.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=2c84c996973a38d7543222ac29252935) **Flow:** 1. The end-user accesses the Global‑e Merchant Portal and enters only their employee email address: * Global‑e Merchant Portal URL: [https://web.global-e.com/account/ssologin](https://web.global-e.com/account/ssologin) * Merchant employee email example: `merchantsso@merchantdomain.com` See [Screens: Accessing the Global‑e Service Provider](#accessing-the-global‑e-service-provider-global‑e-sp). Global‑e SP generates a SAML request together with the employee’s email included in `RelayState`. 2. The Global‑e SP initiates a SAML redirect to the end-user web browser. This means that when the user clicks login, the user is redirected to the Identity Provider sign-in page and prompted to enter the username and password. 3. The end-user browser relays the SAML request to the Identity Provider (IdP). 4. IdP identifies and authenticates the user: IdP parses the SAML request IdP stores the `RelayState` value (user email address). 5. IdP generates a SAML assertion (XML document containing the userauthorisation ) and returns it with the user's email address to the user's browser. The assertion document must include the required list of roles supported by the Global- Merchant Portal. See [Configuring User Roles](#configuring-user-roles). 6. The user browser returns the SAML assertion to the Global-e SP together with the user email. Global‑e SP validates the SAML response: * Decrypts the SAML response * Parses the `RelayState` * Parses the Role List (see Role List) * Checks if the user exists by searching for the user e-mail received in `RelayState` as part of the SAML response. * Checks the roles of the user * Creates the user if the user does not exist 7. If the user is validated, Global‑e SP creates an authentication token and passes it in a cookie to the user's browser. 8. The user is redirected to the Global-e Merchant Portal: [https://web.global-e.com/GlobaleAdmin](https://web.global-e.com/GlobaleAdmin). 9. Global‑e pages are accessible based on user role. ### User Interface The user accesses the Global-e Merchant Portal by entering only their employee email address (merchant domain). Example: `merchantsso@merchantdomain.com` ### Accessing the Global‑e Service Provider (Global‑e SP) ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-eda5f2d4-484e-0da9-00b7-421b18aadef9.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=d70066cd1e0e4a16f5a9c31a3695c177) When the user clicks **login**, Global-e redirects them to the IdP Sign-in page (see *IdP Sign-in and Authentication Example* below), where they enter user credentials (email and password). IdP identifies and authenticates the user before granting access to the Global-e Merchant Portal based on user role. ### IIdP Sign-in and Authentication (Example) ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8ec4a2be-fa90-d573-85b1-6ed74e49c238.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=520b4f4942e289885fffa51cf249fbf8) ### Accessing the Global‑e Merchant Portal ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3f55dcdf-1bf7-83f8-6002-4cc3740bf77b.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=72d6c60fbef12b1ad917480e00e1c4e0) ### Supported Binding Global‑e SP supports `HttpGet` and `HttpPost` binding for the single sign-on. ### Global‑e Identifier The Identifier allows the Merchant’s IdP to identify Global‑e as a Service Provider. This Global-e SP entity identifier is a fixed value represented as follows: **PROD (Production):** `9c41258e-0c9d-43b4-ba15-242b139011fd` **STG (Staging):** `0d1821aa-309a-4314-b5fe-b4a7c3debbe8` **INT (Internal):** `0d1821aa-309a-4314-b5fe-b4a7c3debbe8` **Example:** The following SAML request XML attribute specifies the Global‑e SP entity identifier: `entityID=https://wwww.global-e.com/9c41258e-0c9d-43b4-ba15-242b139011fd` ### Metadata SAML supports metadata endpoint link exchange between IdP and SP, where IdP provides the Global‑e SP with the link to the XML publicly available metadata and vice versa. This simplifies the setup process. One way to configure such a relationship is to exchange metadata files between the SP side and IdP via metadata links, where the SP side can receive an IdP metadata file and generate an SP metadata file for consumption by IdP. ### Global‑e Metadata Global‑e SP exposes SAML metadata either via a link or via a file that can be downloaded from the link. The Global‑e metadata includes the following parameters: * The SP entity id * An endpoint to redirect the end user for ***`HttpGet`*** binding: PROD (Production): [https://secure.global-e.com/account/externallogin](https://secure.global-e.com/account/externallogin) STG (Staging): [https://secure2.bglobale.com/account/externallogin](https://secure2.bglobale.com/account/externallogin) INT (Integration): [https://secure.bglobale.com/account/externallogin](https://secure.bglobale.com/account/externallogin) * An endpoint to redirect the end user for ***`HttpPost`*** binding: PROD (Production): [https://secure.global-e.com/account/externallogin](https://secure.global-e.com/account/externallogin) STG (Staging): [https://secure2.bglobale.com/account/externallogin](https://secure2.bglobale.com/account/externallogin) INT (Integration): [https://secure.bglobale.com/account/externallogin](https://secure.bglobale.com/account/externallogin) * A public certificate and signature for signing and encryption * Global‑e contact details > [!NOTE] > > Contact Global‑e if you are not sure whether to use the values for PROD, STG, or INT. ### IdP Metadata Global‑e gets the IdP metadata by accessing the link sent by IdP. The IdP metadata initiates a SAML request. **The IdP metadata includes:** * An IdP redirect URL (for SAML Request) * A IssuerID * An IdP logout endpoint link * A public certificate and a signature for signing and encryption ### Endpoints The Global‑e SP metadata is accessible either through the URL or via a file available for download. This metadata provides IdP with the necessary information to communicate with Global‑e. **To access the Global-e SP Metadata:** * Click: [https://web.global-e.com/account/ssometadata/5bd9136f-fcab-420e-8402-a1e5d2578649/FederationMetadata.xml](https://web.global-e.com/account/ssometadata/5bd9136f-fcab-420e-8402-a1e5d2578649/FederationMetadata.xml) **Example of Global‑e SP Metadata:** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-4a76ed40-f486-ffc7-2a4e-0d5d72bad9bf.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=18e20319333549af52d54c8e1998726e) **To Download the Global-e SP Metadata File:** * Click [https://web.global-e.com/account/ssometadata/5bd9136f-fcab-420e-8402-a1e5d2578649/FederationMetadata.xml?download=1](https://web.global-e.com/account/ssometadata/5bd9136f-fcab-420e-8402-a1e5d2578649/FederationMetadata.xml?download=1) **SAML Response** IdP transfers the SAML response to the Global‑e SP endpoint that supports both `HttpGet` and `HttpPost` SAML bindings: [https://secure.global-e.com/account/externallogin](https://secure.global-e.com/account/externallogin) ## Integrating Global‑e SP with IdP This section details the steps required to register Global-e as a trusted entity within IdP. **To integrate Global-e SP with IdP:** 1. Register the Global‑e SP entity in IdP using the metadata endpoint links exchange method. See [Metadata](#metadata). 2. In IdP, configure the list of user roles supported by Global‑e SP. See [Configuring User Roles](#configuring-user-roles). 3. Register IdP in Global‑e SP using the metadata endpoint links exchange method. See [Metadata](#metadata). 4. Global‑e maps the merchant user roles in the Global‑e system. ### Configuring User Roles **To configure the list of user roles:** 1. Prepare the list of employees (users) that should have permission to use the Global‑e Admin. 2. Associate each user to one or several roles supported by Global‑e SP (see list of supported roles further below). 3. Provide this list of SSO users and associated roles to the Identity Provider so that they can configure and include these roles in the SAML response to be sent to Global‑e. **Global‑e supports the following roles:** `1. HubAdmin` `2. HubOperator` `3. MerchantAdmin` `4. MerchantCS` `5. MerchantCSAdmin` `6. StoreAdmin` `7. StoreUser` `8. MerchantReportAdmin` `9. MerchantReportUser` In the IdP SAML response to Global‑e, Global‑e SP expects to get the list of SSO users associated with the roles supported by Global‑e SP, as illustrated in the following section. ### Role Permissions Global‑e can receive fine-grained permissions for roles in the SAML response. For any role that requires permissions (MerchantReportUser), the IdP must include a `rolepermission` SAML attribute. If a required permission is not provided for such a role, the SSO login will be rejected. By default, Global‑e expects the following SAML attribute name: `http://schemas.microsoft.com/ws/2008/06/identity/claims/rolepermission` Each value must use the following format: `SSORole:PermissionName` Example: ``` MerchantReportUser:LiveView MerchantReportUser:SalesAndFunnel MerchantReportUser:Finance MerchantReportUser:Products MerchantReportUser:Logistics ``` `SSORole` must match the role value sent by the IdP in the regular role attribute and configured in Global‑e SSO role mapping. Supported permissions currently include: * LiveView * SalesAndFunnel * Finance * Products * Logistics ### Configuring Merchant Domains If you have more than one domain, send us the list of addresses of all the domains for which you want SSO support so that Global‑e can set this up. ### Example of SAML Communication between Global‑e SP and IDP **Example of SAML Response with Linked Roles - Sent by IdP to Global‑e** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-441ec306-6a90-e9a7-4a19-4868a39ea923.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=a644dbb9e42ddfae7fd4cdbb553a2850) **Example of SAML Request - Sent by Global‑e SP to IdP** ``` https://wwww.global-e.com/5f4f1908-c9e8-4617-ace7-7d8f44e490d6 ``` **Example of SAML Response – Sent by IdP to Global‑e SP** ``` https://sts.windows.net/951e7c97-7cdd-4af6-a822-c9482cae5056/ https://sts.windows.net/951e7c97-7cdd-4af6-a822-c9482cae5056/ 4VWqR0pUrTvBE8FVoOO3D8VFUNAIRHLePqpePWZJxKU= YCCkRSk0UduDisy4oZxD3v0qGM1wgd36Fg5FXtiL5pENNIcisYdDRquvjy4fNURXhNBMt1HoAeN9jDY8hcamw517X3lJk3imGiDhKT9yIB7VSjPS4azLDqym+uL48vuoUSXfRoaA9TYrLQMhWTn8U0KTB6M/PZlh+2aUSRyxAJiW8zdTNGeDAJM6ICgecQ0Z+wx1BZW6VmBRtH74VpSq3OXcF/1igZnkNRljhr5oKdLdtjJsENhthH1cCGq9q6igZLwalCZesTXCOjK0zO+iJSk7i4kh21X8314x/a6u5tjLr2OkMKP9ChwI1d+cfDe3YLRNvR7ipFGEP6vMR1w/LQ== MIIC8DCCAdigAwIBAgIQEnS+YGZcgbxJ8hPIMskBvzANBgkqhkiG9w0BAQsFADA0MTIwMAYDVQQDEylNaWNyb3NvZnQgQXp1cmUgRmVkZXJhdGVkIFNTTyBDZXJ0aWZpY2F0ZTAeFw0yMDA0MjYxNTA4MDJaFw0yMzA0MjYxNTA4MDJaMDQxMjAwBgNVBAMTKU1pY3Jvc29mdCBBenVyZSBGZWRlcmF0ZWQgU1NPIENlcnRpZmljYXRlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1pukQAAW/qMeMMsD9LZiGwkRpv05y8GSuDx8hnkb5j2Ne+jL5DwAuZhpQAjVtLrMWww+CsScqOSRuXdZvQHzmPgxiD6ZoLxyZsG/EIcjTK80Sb3jruTW87x7Aci873STY0knfGoDfWnJF3QhRYXw0XJpT/1HMXBqnhVY/AzQZWkG70fQW4Hw1+RSTqSetY+Ju72/mR14JQg0eqXnYtpDyJV05JZHlpJ7mFpQVtLg2b9YhkGj/DItQAkvU8e9fuf3jNnPKAOVMPWfoWcbiq/Dyh5TnpNe/9zkruG46pS6eAyNOUyeYv3Vr5ZAw98/q9jJM/LaFn0KYVM5BMtcYDI6mQIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQC01f16JITMAbLwXyYNU8y41YoHcNBbETESKhOlP6zT/zxH2k2XCap4WyXwdrUqFIA0mP/HKgdDdN4KiFUj3nXPXYSZaxjXqlrLRYMTJE4LKZ8iBdAEJ3OjJOA48guNPU+rsoCPTUX+74YOQ3w3XyDhKOWhNjj2fzaFEU6aaGOnHh6s6PHPgQL8uoXYhg6pMQ10m9PtPK12PY6RL+v9HuuRGb+itW1rarlAVS5EPCVxntnDTCv9UUXnEwyQmYp9tmMpkFBpSwjZmwK1BTrUhieJRutwCAM/jQ5cGNAVozr4bx8OV0+25Gd5+f6PIdddyeHCwCIn6wPlV6gwmQCqBzKC C1Y5LlgRS2Ms1wmUwkA8W5zCu6Q30w93nuMb5rL06RY= https://wwww.global-e.com/5f4f1908-c9e8-4617-ace7-7d8f44e490d6 951e7c97-7cdd-4af6-a822-c9482cae5056 44036fae-af4f-4a18-bd14-dfc7de1487fd SSO01 https://sts.windows.net/951e7c97-7cdd-4af6-a822-c9482cae5056/ http://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/password HubAdmin HubOperator MerchantAdmin MerchantReportUser MerchantReportUser:LiveView MerchantReportUser:SalesAndFunnel SSO User SSO01@global-e.com urn:oasis:names:tc:SAML:2.0:ac:classes:Password ``` ## Checklist of Items to Send to Global‑e Make sure to send the following items to Global‑e to ensure adequate setup and support: * Identity provider metadata URL. * Example URL: [https://login.microsoftonline.com/38829821-e013-4e4e-a1bd-cddc47cc36dc/federationmetadata/2007-06/federationmetadata.xml?appid=f004905c-fdbd-40f3-97e9-42f516d9cafe](https://login.microsoftonline.com/38829821-e013-4e4e-a1bd-cddc47cc36dc/federationmetadata/2007-06/federationmetadata.xml?appid=f004905c-fdbd-40f3-97e9-42f516d9cafe) Note the `appid` parameter at the end of the URL. * SAML2 binding type - HttpPost or HttpRedirect * Allowed roles for SSO users. Only users with these roles are allowed to log in as SSO. Contact Global‑e if you require additional roles. * The list of all your domains that require SSO support. * A test user account and credentials for Global‑e for each email domain supporting SSO (for testing purposes). **Note** If you have a separate sandbox working with the Global‑e Staging environment, make sure to provide this information for both, your sandbox, and your production website. # Store Orders Source: https://docs.global-e.com/store-orders ## Overview The Global‑e Merchant Portal allows Merchants with stores in various countries to ship orders to stores, process deliveries to customers from these stores, process returns from customers to stores, and send back the returned items from the store to the Merchant This document provides the steps required to enable the appointed store personnel to receive and check in parcels, process returned items, consolidate returns, and send the parcels back to the Merchant. > [!NOTE] > > The colour scheme of the Global‑e Merchant Portal menu may either be grey or orange. > > All the screens and illustrations displayed in this document are provided as examples. **Terminology** The following terms are used in this document. | Term | Description | | - | - | | Merchant | The company for which you work | | Global‑e Merchant Portal | The Global-e interface to use to process store orders | | Store Admin (SA) | The Merchant's store employee in charge of creating users and handling standard order check-in and return procedures | | Store User (SU) | The Merchant's store employee in charge of processing and handling standard order check-in and return procedures | | Order ID | Also called Order Number: Unique Global‑e order identification number. Example: GE23311623GB. | | Store Label | The Store Label is attached to each parcel. It includes the **parcel code** (as a bar code and a number under the bar code). Example: 23311623-9-1. | | Shipping Label | The Shipping Label is attached to each parcel. It includes the **tracking number.** | | Return Shipping Label | The Return Shipping Label is created and attached to the parcel by the Store personnel before returning items to the Merchant. | ## Prerequisites Make sure you have the following items ready before getting started: * A username and password to access the Global‑e Merchant Portal. This is provided by the Global-e Admin. Global-e also prepared your initial Store Orders environment by: * Creating users Users are the store employees in charge of processing store orders and recording the store order information. **Store User:** in charge of performing the standard order check-in and return procedures. **Store Admin:** performs the same standard procedures implemented by the Store User. This user can also create additional Store Admins and Store Users. See Create and Edit Users for more information. * Associating each user with the relevant stores. * Important: to configure users for the Store Orders feature, you must be a Store Admin. * A regular printer to print labels and applicable documents. * For returns: Adequate packing materials including boxes, bags, scissors, tape, and more. * Recommended: A barcode scanner to process orders. You can also process it manually. > [!NOTE] > > This documentation assumes that you have the correct role permissions and credentials to perform the procedures on the Merchant Portal. # Storefront Attributes Source: https://docs.global-e.com/storefront-attributes The Global‑e integration relies internally on CSS selectors to locate various data points on your web store. This means that we may rely on a combination of: * The HTML structure of the page * Classes * Attributes (and their values) * Elements with specific IDs To ensure a robust and seamless workflow, we highly recommend implementing the storefront attributes outlined in this document. By doing so, our team can configure our internal CSS Selectors to target these specific attributes. This empowers you to make future updates to your web store without needing assistance from Global-e to adjust the selectors. Storefront attributes not only streamline our integration process but also significantly enhance the stability and efficiency of your integration. ## Country Switcher Flag The **Country Switcher flag** `(data-ge-shippingswitcher-flag)` lets you position your country switcher on your storefront. ### To position the country switcher 1. Insert an element. 2. Assign the corresponding attribute at the location you want the Country Switcher to be displayed on your storefront.Our design team can work with you to style the country switcher to match your brand, so please reach out if you have any specific requirements. Example ``` ``` For placement on desktop browsers: **\[data-ge-shippingswitcher-flag]** For placement on mobile browsers: **\[data-ge-mobile-shippingswitcher-flag]** ### Manipulating Page Content Merchants wishing to manipulate the page content based on the selected shipping country (for example to support promotional messages targeting), may use the data-manipulate data attribute. The data-manipulate data attribute’s value should be JSON having HTML and/or CSS attributes for each country ISO code key that requires manipulation. If specified, the HTML attribute should be set to any valid HTML that Bespoke will render as `innerHTML` of the respective node. If specified, the CSS attribute should be set to any valid CSS that Bespoke will apply to the respective node. In the example below, the “Free Shipping for all orders over €89” message will be shown only when the selected shipping country is The Netherlands: ```
``` ### Showing or Hiding Page Elements Merchants wishing to show or hide a page element only for Global‑e operated countries may use `globale-show` or `globale-hide` CSS classes respectively. For example: The following DIV element will be hidden only when one of the Global‑e-operated countries is selected: ```
``` The following DIV element will be shown only when one of the Global‑e-operated countries is selected: ``` ``` ## General Price Place the **Price** flag (`data-ge-price`) on any price element on the product details page and product list pages (search results, categories, and more). This does not need to be applied if another price attribute is also applied. Do not apply this attribute to Basket or Mini Basket prices. See the [Basket / Mini Basket](#basket-/-mini-basket) section for the attributes to apply to these prices. Example ```
$19.95
``` ## Custom Price Calculation These attributes are meant to be combined in order to accurately calculate more complex prices outside of the cart, for example, when advertising prices in a Product’s description. ### Base Price - \[data-bp="\{BasePrice}"] This attribute specifies the \{`BasePrice`} (or price-per-unit) to be used when doing price calculations. ### Quantity - \[data-quantity="\{Quantity}"] This attribute specified the \{Quantity} (or number of units) to be used when doing price calculations. If no quantity is specified (or the attribute is omitted), then the default value of 1 will be assumed. Example ```
Normally $10, Buy 10 at $5 each, Totaling $50
``` ### Product Classes Price Coefficients For merchants wishing to apply a different price coefficient to specific product classes (eg. Premium items for certain territories), the respective product class code can be indicated in the data-pc data attribute for these products. The actual coefficient rate should be defined in the Global‑e system for the respective product classes in the required countries. The Bespoke script will take the specified product class into consideration, combined with the associated configuration (if a coefficient rate applies to the respective shipping country) when calculating the price for the customer. Below is an example of how the product class data attribute should appear on the website: ```
...
``` The HTML attribute can be positioned on the DOM without country considerations as long as the Bespoke script establishes if the coefficient is applicable to the country. In addition to setting the data-pc HTML attribute, product class code should be returned in The `ProductClass` attribute for the respective Product in `GetCheckoutCartInfo` API. If needed, the applicable coefficients and associated countries can be recovered from Global‑e by calling the `CountryCoefficients` API mentioned in the separate “Global‑e API” document. ### Reduced VAT Rate Support For merchants having reduced VAT rate products in the catalogue(e.g. Children Clothing for the UK merchants), the applicable reduced VAT rate can be indicated in the data-product-vat data attribute for these products. The bespoke script will take the specified VAT rate into consideration when calculating the price for the customer. Below is an example of how the VAT rate data attribute should appear on the website: ``` ...
``` ``` ...
``` ### Product-Specific VAT Rates in the EU and Restrictions Bespoke can fully support the handling of product “country exceptions” that are applicable to a specific country. When shipping inside the EU and distance selling is applicable, by default Bespoke will enforce the respective shipping country’s standard (maximum) VAT rate when calculating product prices. However, in most EU countries, there are certain categories of products that allow a non-standard (reduced) VAT rate defined in this country to be applied. Another sample of a product “country exceptions” is product restrictions in a certain country. These can be either defined by the merchant for commercial reasons (e.g. brand or category restrictions) or by Global‑e for regulatory reasons (e.g. products containing some furs when shipping to Australia). By default, product restrictions will be enforced when the user gets to Global‑e checkout. In order to support product “exceptions”, such as reduced product VAT rates in the EU and restrictions applied when browsing the merchant’s site (before the user gets to Global‑e checkout), Bespoke needs to be able to read this information embedded within the DOM. The respective “exceptions” data can be indicated in the data-countries data attribute for these products. Below are 2 examples of how the “country exceptions” data attribute should appear on the website: ```
``` In the sample above, the product will be restricted in Italy and in the US and will have reduced VAT in Italy and Germany. ```
``` In the sample above, the product will be completely forbidden in all countries operated by Global‑e and will have reduced VAT in Germany. This information can be loaded by the merchant site’s back end from Global-e by periodically calling `RecentProductCountryS` API mentioned in the separate “Global-e API” document. Alternatively, the merchant may choose to render only commercial restrictions in the data-countries data attribute, in which case the default Global-e Module behaviour will still be preserved for the rest. ### Excluding Elements from Price Conversion By default, the Bespoke script converts all prices that are found on the page, to the selected end customer’s target currency, unless the certain element holding the price is explicitly excluded. The exclusion can be implemented either in the merchant-specific part of the Bespoke script as part of the integration scope on the Global‑e side, or by the merchant. For merchants wishing to exclude certain page elements from price conversion, the data-gem-ignore data attribute should be added to the respective HTML node. For example, for a merchant having original prices in British Pounds, Bespoke will skip the following element and will not convert £100 to the target customer currency: ```
Free Shipping for all orders over £100
``` ## Basket / Mini Basket Here are the most common basket selectors. We have **many** more, but these are the most common. Let us know if any price in the basket is not covered, including discounts, subtotals, product savings… anything at all… and we will look up the appropriate attribute for you. | Name | Attribute | Explanation | Example | | - | - | - | - | | Add to Cart Button | `[data-ge-add-to-cart]` | Place this attribute on any button on PDP that adds the item to the cart. This attribute can also be applied to any clickable element (`a`, `input`, `div`, `span`, etc.), not limited to buttons. | | | Basket SubTotal | `[data-ge-basket-subtotals]` | Total List Price for the Basket/Mini Basket. | | | Basket Total | `[data-ge-basket-totals]` | Total Sale Price for the Basket/Mini Basket. | | | Basket Total Discount | `[data-ge-basket-discounts]` | Total Discounts for the Basket/Mini Baskets (Basket `SubTotal` - Basket Total). | \ \ \ \ \ \ \ \ \ \\\ \ \
Future Shoe\x5\ $10
</td>
</tr>
<tr data-ge-basket-cartitemid="LKYHAT843">
<td>Lucky Sports Hat</td>
<td>x1</td>
<td data-ge-basket-productsaleprice>
$50 \
\Total: \ \\$100\ \
| | Product CartItemId | `[data-ge-basket-cartitemid="{CartItemId}"]` | Place this on the product "row" in the Basket/Mini Basket. The \{`CartItemId`} should be the SKU of the product. | | | Product ListPrice | `[data-ge-basket-productlistprice]` | The original list price of the product. | | | Product SalePrice | `[data-ge-basket-productsaleprice]` | The discounted sale price of the product. | | | Product SubTotal | `[data-ge-basket-productsubtotalprice]` | The total list price of the product (List Price \* Quantity). | | | Product Total | `[data-ge-basket-producttotalprice]` | The total sale price of the product (Sale Price \* Quantity). | | | Product Total Discount | `[data-ge-basket-productdiscountsprice]` | The total discount for this product (Total List Price - Total Sale Price). | | ## Checkout ### Checkout Button - \[data-ge-checkout-button] Place this attribute on any button that takes you to checkout. This can be applied to any clickable element (a, input, div, span, etc…), not just buttons. ### Checkout Container - \[data-ge-checkout] Place an element with this attribute where you would like our checkout to be injected on the /pages/international-checkout page. ## Element Visibility These attributes will hide & show elements when the customer is in a Global-e operated country. The two attributes can be used together to show one piece of information for domestic customers and a different piece of information for international customers. It is best to keep “Global‑e operated” in mind when thinking about if something should be hidden or shown. ### Hide - \[data-ge-hide] This attribute sets the property `display: none !important`; (via CSS) when the customer is in a Global-e-operated country and does nothing when in a non-operated country. This has the effect of hiding the element for international customers while keeping that element visible for non-operated customers. ### Show - \[data-ge-show] This attribute sets the property `display: block !important;` (via CSS) when the customer is in a Global-e-operated country, and sets it to `display: none;` when in a non-operated country. This has the effect of showing the element for international customers while keeping that element hidden for non-operated customers. This is only to be applied to elements you wish to be shown exclusively to international customers but remain hidden for domestic customers. ### Example This example shows how one message can be shown for domestic customers, while a different message is shown for international customers. ```
Free Shipping!
Shipping is calculated at checkout.
``` # Storefront Components Source: https://docs.global-e.com/storefront-components Thanks to the integration with Global-e, your website lets international customers enjoy a tailored and fully localized experience. This section describes the Global-e elements and tools available to your customers. ## Global-e Elements on your Merchant Storefront The following elements are available for your website: * [Welcome Pop-up](/site-customization-storefront#configuring-your-welcome-popup-page) * [Country Switcher Pop-up](/site-customization-storefront#country-switcher-pop-up) * [Marketing Banner](/marketing-banner) * [Checkout Page](/site-customization-storefront#configuring-your-checkout-page) **Site Customization** See the following for a description of the benefits provided by the following: * [Customer Experience](/customer-experience) - Easily and intuitively modify your site elements and behavior. * [Site Customization](/site-customization-storefront) - Review the design options for each feature and provide us with your design requirements. # Storefront Configuration Source: https://docs.global-e.com/storefront-configuration This page describes the following elements: * [Global-e Module Javascript](/storefront-configuration#global-e-module-javascript) * [Global-e Module CSS](/storefront-configuration#the-global-e-module-css) * [Configuring the Global-e Module](/plug-in-configuration#1-8-configuring-the-global-e-module) * [Mandatory developments](/storefront-configuration#mandatory-developments) * [Browsing](/storefront-configuration#browsing) * [Products](/storefront-configuration#products) * [Cart](/storefront-configuration#cart) * [Checkout](/storefront-configuration#checkout) ## Global-e Module Javascript Below is a suggested way of loading the Bespoke JavaScript library asynchronously on your site: **Integration Environment** ``` ``` **Production Environment** ``` ``` The above snippets will ensure that the Bespoke JavaScript module will load asynchronously and not block your current page rendering. > [!NOTE] > > Replace **\{merchant id}** at the end of the URL with the merchant ID provided to you by Global-e. ## The Global-e Module CSS You must place the Bespoke CSS on your site’s header. The following example is the Bespoke CSS you must use in your Integration environment: ``` ``` The following example is the Bespoke CSS you must use in your Production environment: ``` ``` > [!NOTE] > > Replace **\{merchant id}** at the end of the URL with the merchant ID that Global-e gave you. ## Mandatory Developments The following table shows the mandatory developments: | Feature | Description | | - | - | | Pricelist | You must be able to retrieve the country from the Global-e Module cookie to use the relevant pricelist on the front-end | | My account currency conversion | The following parameters are required to correctly convert currencies in the My Account or My Orders sections: **Customer ID**: dedicated cookie **Global-e order ID**: in the **Document Object Model (DOM)** of the relevant pages in the section | | Client analytics | See the Global-e Module client [snippet](/client-analytics#analytics-implementation-and-mapping-to-analytics). | | Google Shopping feed | See the [Marketing Feeds and Tax/Shipping Rates](/international-marketing-feeds--non-shopify-). | | Cookies | Global-e uses cookies in API requests between your client, our servers, and Centra. These cookies help identify the active cart and customer so that data stays consistent across the checkout flow: `token` – Identifies the shopping cart. It allows you to retrieve cart details on the client side (for showing prices on the cart page) and on the server side (when sending the cart to checkout). `Customer_id` – Identifies the logged-in customer. It is used on the **My Account** page to fetch their past orders and to display prices based on the international rates they paid. *Both* cookies should match the cart and customer identifiers stored in Centra. You can store them as one combined cookie or as two separate cookies, depending on your implementation. The cookie must follow this structure so Global-e can extract the token and customer_id: `ge_frontend_data = {“token”:”asfd444ggv44677870jhv”,”customer_id”:”123456”}` Requirements: The cookie must be classified as **Essential**. The cookie must not be set as **httpOnly** (Global-e's client-side scripts need to read it). | ## Browsing This section describes Centra's browsing elements. ### Global-e Browsing Elements Global-e supports the following browsing elements: * Welcome pop-up * Country switcher * Free shipping banner For more information, see [Site Customization](/site-customization-storefront). ### Global-e Storefront Attributes The Global-e storefront attributes are described on the [Storefront Attributes](/storefront-attributes) page. ### Calculating Prices Global-e supports calculating both dynamic prices and fixed prices. **Dynamic price calculations** are based on pricelists created by merchants using Centra's back-office. You must use this set of configurations to properly support price conversions: * All Global-e markets must be assigned to a pricelist. Global-e automatically assigns Centra's default pricelist for unassigned markets. * All pricelists used for Global-e markets must be set in your base currency. **Fixed price calculations** are supported per country and is based on Centra's native pricelist creation. You must follow these rules when setting their fixed prices: * Each country's fixed prices must be set with its respective currency as configured by Global-e. * The geolocation must be set according to the country's fixed prices. * All fixed prices must be set on the country's catalog. ## Products ### Product Restrictions As with other **Bespoke Global-e Module** integrations, we support merchants restricting purchases of checkout items to specific countries based on regulations or commercial restrictions. We support restrictions at the Checkout level. For more information on product restrictions, see [Restricted Products](/product-management#restricted-products). ### Pre-Ordering Items You can sell pre-order items if needed, and can enable them by selecting the stock section checkbox for the required item. Merchants must pass the pre-order attribute indication for the relevant products. Note the following: * We do not validate stock in the order stock validation phase for items identified as pre-order. * Items identified as pre-order must be marked in Centra as **PreOrder**. Items not marked as PreOrder will be a **Failed Transfer to Merchant (FTM)**. Merchants must mark pre-order items in both Global-e and Centra. ### Product Attributes Global-e supports the following product attributes: * Product name * HS code * Country of origin * Weight * Brand * Description > [!NOTE] > > We do not support custom fields. ## Cart ### Sending Language to Checkout Global-e supports sending language to Checkout with Global-e Module capabilities. For more information, see [Global-e Checkout Language](/global-e-checkout-language). ### Clearing Your Cart Global-e supports clearing your cart with Global-e Module capabilities. For more information, see [Clearing your Cart](/storefront-implementation#clearing-the-cart). ### Applying Discounts Centra supports several discount types that may include multiple rules and dependencies. You can specify these conditions while creating both vouchers and campaigns. ## Checkout ### Stock Validation When you place an order in Checkout, the Global-e plug-in runs a stock validation based on Centra's stock to see if the item is available. This process does not occur for pre-order items. ### Discounts The supported discount types described in [Applying Discounts](/storefront-configuration#applying-discounts) apply to the Checkout capabilities as well. Only voucher code discounts are available, and consumers use these codes during Checkout, and discounts are applied when the checkout is complete. # Storefront Implementation Source: https://docs.global-e.com/storefront-implementation To enable the Global-e Module's front-end functionality on your site, place the **Global-e Module Code Snippet**, a small JavaScript and CSS code snippet as part of your site's header as detailed in the following sections. ## The Global-e Module JavaScript Below is a suggested way of loading the Bespoke JavaScript library asynchronously on your site: **Integration Environment** ``` ``` **Production Environment** ``` ``` The above snippets will ensure that the Bespoke JavaScript module will load asynchronously and not block your current page rendering. > [!NOTE] > > Replace **\{merchant id}** at the end of the URL with the merchant ID provided to you by Global-e. ## The Global-e Module CSS As mentioned above, the Bespoke CSS should be placed on your site’s header, as shown below: **Integration Environment** ``` ``` **Production Environment** ``` ``` > [!NOTE] > > Replace **\{merchant id}** at the end of the URL with the merchant ID provided to you by Global-e. ## Alternative Methods Tag Managers – if your site uses a tag manager library, it is possible to load the Global-e Module JavaScript via your current tag manager. In doing so, please ensure that the Global-e Module JavaScript library is given the highest priority in your tag manager, for the reasons mentioned above. Note - The Global-e Module CSS link should not be loaded via a tag manager in any way. CSS on Site – The Global-e Module CSS logic may be implemented directly on your own server. The logic would then be as follows: when the Global‑e server identifies the customer browsing the CSS as coming from a Global‑e-operated country, the Global‑e server returns a valid CSS that contains the relevant CSS content for your site. Alternatively, when the Global‑e server identifies the customer as coming from a country not operated by Global‑e, then the CSS returns empty. This way, Global-e’s CSS does not affect customers browsing from countries not operated by Global-e, even in case the Global-e Module JavaScript was not loaded for some reason. For merchants wishing to implement such logic, Global‑e sends the CSS content to be placed on the merchant site. ## Clearing the Cart You should ensure your customer’s cart is cleared after a successful international checkout. Inside the client side analytics callback, you are able to insert the code to trigger a clear cart URL, delete a cookie or local storage value, or the combination of operations that your storefront requires. However, if it is not possible to detach the frontend cart from the backend such that clearing the cart on the frontend will cause the SendOrderToMerchantprocess to fail, you will be required to clear the cart as part of the SendOrderToMerchant request. If you **do not rely on the information received from Global-e in the** `SendOrderToMerchant` to create your orders, then clearing the cart on the front end should not result in the SendOrderToMerchant request failing, and the first option should be the preferred approach. # Storefront Modifications Source: https://docs.global-e.com/storefront-modifications-liquid-storefronts This section details additional features for Shopify Native integration. ## Storefront Modifications (Liquid Storefronts) ### Step 1. Use Shopify's Local Prices Shopify localises prices rendered via the liquid template. See [https://help.shopify.com/en/manual/markets/pricing/currency-formatting](https://help.shopify.com/en/manual/markets/pricing/currency-formatting). **Explicit Price Formatting** To prevent shopper confusion and increase international order conversion, use explicit price formatting where appropriate, according to [Shopify recommendations](https://polaris.shopify.com/foundations/formatting-localized-currency). This means displaying the currency code in addition to the currency symbol on collections pages, PDPs, search results, and order subtotals on the cart and mini-cart. To achieve this, use the **`money_with_currency`** filter. You may choose to display the currency code only for ambiguous currency symbols such as “`$`”. Example: ``` {% if cart.currency.symbol == '$’ %} {{ product.price | money_with_currency }} {% else %} {{ product.price| money }} {% if cart.currency.symbol == '$’ %} {{ compare_at_price | money_with_currency }} {% else %} {{ compare_at_price | money }} ``` ### Step 2. Use Shopify's Local-Aware URL (Optional) You may choose to use subfolders, int'l subdomains or int'l TLDs on your storefront.  If you choose to use this feature, you will need to ensure your link structure remains intact during the browsing session to prevent issues with links or when opening the cart. **To make sure that Shopify preserves the country selected by the customer:** * Avoid using absolute URLs * Replace `/cart` with `{{ routes.cart_url }}` See [Shopify's locale-aware URLs](https://shopify.dev/themes/internationalization/multiple-currencies-languages#locale-aware-urls). ### Step 3. Add a Country Selector There are two options for implementing a country selector: * There are 3rd party apps on the Shopify app store that can add a country selector to your store automatically. * You can build a custom country selector if you want to have more control over the look and feel. Shopify provides an example code for building a custom selector on their docs site: [https://shopify.dev/themes/internationalization/multiple-currencies-languages](https://shopify.dev/themes/internationalization/multiple-currencies-languages) If the country is operated by Global‑e, the country is automatically added to the list of countries in the country selector. The following example shows a country selector in Shopify. ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f18d504e-b466-6ab3-e1e7-26d89cdfb979.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=a9834c918fef79db8e4b7b08540fa312) ### Step 4. Adjust the Appearance of Duties and Taxes ### Order Details page If you are using Legacy Customer Accounts only – to display the correct duties amount on the order details page, use the following code snippet. ``` {% if order.current_total_duties or order.total_landed_cost_additional_fees %}  {% assign total_duties_line = 0 %}   {% if order.current_total_duties %}     {% assign total_duties_line = total_duties_line | plus: order.current_total_duties %}    {% endif %}   {% if order.total_landed_cost_additional_fees %}     {% assign total_duties_line = total_duties_line | plus: order.total_landed_cost_additional_fees %}    {% endif %}         Duties    {{ total_duties_line | money }} {{ order.currency }}      {% endif %} ``` ### Step 5. Optional: Hide Website Elements in Shopify You may want to hide certain elements on your storefront that are not relevant to international shoppers. Examples include free domestic shipping banners, domestic payment methods (e.g., Afterpay), and express checkout buttons on the PDP and other locations. You can hide these elements from displaying when the shopper chooses a Global-e supported country by adding certain CSS classes to those elements. **`ge-hide-display-none`**: Elements with the class `ge-hide-display-none` are hidden and do not take up space on the page. **`ge-hide`**: Elements with the class `ge-hide` are hidden from view. Example: ```
Free Shipping on all domestic orders over $150
``` ### Step 6. Gift Card Tagging To prevent gift cards from receiving an inflated price due to country coefficients, you must add the product tag **`pc-glbe-giftcard`** to all your gift card products. Make sure to add this tag in both the sandbox and production environments. Please let your Global-e project team or CSM know when this is done so Global-e may complete the configuration on our side. ### Step 7. Account Landing Page Fix For liquid storefronts, to resolve a known Shopify issue with the account landing page displaying order totals using the currency of the session instead of the currency the order was placed in, adjust the display of the order total to output without currency, and append the order currency separately. Before: `{{ order.total_price | money_with_currency }}` After: `{{ order.total_price | money_without_currency }} {{ order.currency }}` ### Step 8. Gifts With Purchase and Free Sample Support To allow gifts with purchase and free samples to have international duties and taxes calculated correctly and prevent other downstream issues, there are two approaches: * The free products must be assigned a non-zero price and have a `100%` discount applied to them. * Alternatively, the free product can have a price of `zero ("0")` if the configured “**Cost per item**” is non-zero. This method requires additional configuration from Global-e so please reach out to your Global-e project manager or CSM to enable it. Additionally, for either method the free products must be present inside the cart to ensure that they are transferred to Global-e's services. ### Step 9. Country-specific Messaging (Optional) You can include country-specific messaging on your PDP and other places on your storefront to make the shopping experience more relevant for your international customers. Including messaging that explains duty and tax-inclusive price strategies or free shipping thresholds may help increase conversion. This can be done by checking the customer's session and displaying the relevant message for that country. Example: ``` {% if localization.country.iso_code == ‘US' %} // show custom content only meant for US

$100 discount, etc.

{% elsif localization.country.iso_code == ‘CA’ %} // show custom content only meant for CA

Duties included!

{% else %} // show generic content {% endif %} ``` ### Step 10. Customer Privacy and Cookie Consent As an international merchant, protecting your customers' privacy is essential. Shoppers in many countries prioritize their privacy, often looking for features like cookie banners as indicators of trust before engaging with a store or making purchases. Shopify offers robust tools to safeguard customer privacy and obtain consent before collecting analytical data. These tools are fully compatible with the Global-e Shopify Native solution, ensuring seamless integration. It is important to note that if cookie consent is not collected, Shopify does not provide you with analytical data for the shopper’s session. Therefore, proper configuration is essential for tracking your storefront analytics. To implement a custom cookie banner or use the Shopify-provided banner and collect analytical data from international customers, refer to the detailed instructions available in Shopify’s documentation at the following links: * [Using the Shopify cookie banner](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings) * [Using a 3rd party cookie banner](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#configure-a-cookie-banner-using-a-third-party-cookie-banner-app) Additionally, Global-e can integrate with your cookie consent solution to ensure that Global-e cookies comply with your customer’s privacy choices. Reach out to your Global-e contact to discuss enabling this feature. # Subscription Connector (End-to-End) Source: https://docs.global-e.com/subscription-connector Part of the [Subscriptions Overview](/subscriptions) — see it for the end-to-end business flow, roles and responsibilities, and capabilities. ## Conceptual Overview **API Endpoints Summary** | Direction | Method | Endpoint | Purpose | | - | - | - | - | | Subscription Manager to Global-e | POST | `/subscriptions/notifications` [Endpoint contract](/api-reference/subscription-notifications) | This endpoint allows the Subscription Manager to inform Global-e about subscription lifecycle events, such as "SUBSCRIPTION_CREATED" | | Subscription Manager to Global-e | POST | `/subscriptions/billing-summary/calculate` [Endpoint contract](/api-reference/calculate-billing-summary) | This endpoint allows the Subscription Manager to request a billing summary calculation - the selected shipping option and duties and taxes - before processing recurring payments. | | Subscription Manager to Global-e | POST | `/subscriptions/recurringPayments` [Endpoint contract](/api-reference/create-recurring-payment) | This endpoint allows the Subscription Manager to trigger Global-e to process a recurring payment and subsequent order creation. | | Global-e to Subscription Manager | POST | `/subscriptions/recurringPayments/notifications` [Endpoint contract](/api-reference/recurring-payment-notifications) | Global-e calls this endpoint to notify Subscription Manager about the status of recurring payments. | | Subscription Manager to Global-e | PATCH | `/subscriptions/{subscriptionId}` [Endpoint contract](/api-reference/update-subscription) | This endpoint allows the Subscription Manager to update a subscription shipping (delivery) address, same country only. | | Merchant to Global-e | GET | `/Payments/Subscriptions/{merchantGuid}` [Endpoint contract](/api-reference/get-subscription-and-payment-reference-details) | Returns the current masked payment method and billing address per subscription ID, for display in the merchant portal. | | Merchant to Global-e | JS SDK | `GlobalE.UpdatePaymentMethod()` [See document](/globale-updatepaymentmethod) | Launches the Global-e update payment widget on the merchant page so the shopper can change the payment method on an active subscription. | ### Checkout (First Order) To initiate the subscription purchase behavior on checkout, the eCommerce platform passes product-level subscription attributes to Global-e on the cart. The attributes are passed per subscription product; multiple subscription products in one cart are supported, sharing one billing frequency. The required attributes are: | Key | Description | Example | Notes | | - | - | - | - | | ProductType | Subscription indication | 4 | 4 means a subscription product, 0 means a one-time sale product | | FreeTrialDays | Free trial duration in days | 7 | 0 or null means no trial | | RecurringPrice | Recurring charge amount | 14.99 | In shopper currency | | BillingFrequency | Frequency of recurring billing | Weekly | Possible values: Daily, Weekly, Monthly, Annually | Once the shopper decides to purchase the subscription, Global-e processes the first payment (or \$0 if a trial), securely tokenizes the payment details and creates the initial order on Global-e platform. The following shows the flow sequence **after first order completed**: ![](https://mintcdn.com/globale-enterprise/ZiykvHZPz1ojekrf/images/subscriptions/subscription-connector-first-order-flow.png?fit=max\&auto=format\&n=ZiykvHZPz1ojekrf\&q=85\&s=c5420c0ff8d41ce689aca2dc2a26ef04) ### Recurring Payment The following figure shows the Recurring Payment flow sequence: ![](https://mintcdn.com/globale-enterprise/ZiykvHZPz1ojekrf/images/subscriptions/subscription-connector-recurring-payment-flow.png?fit=max\&auto=format\&n=ZiykvHZPz1ojekrf\&q=85\&s=046b8a7e4ef26a81141dd51235362f52) ### Contract Management (Shopper Actions) **Update payment method** Subscribers can change the payment method on an active subscription. Global‑e provides a secure, hosted widget for the change itself. Credit cards and PayPal are supported, including switching between them. Shoppers can view and update stored payment methods via a Global‑e–hosted, PCI-compliant widget. Global‑e stores the new payment reference against the subscription, so future renewals use it. The widget also provides the ability to edit the billing address, within the same country. The merchant calls [Get subscription and payment reference details](/api-reference/get-subscription-and-payment-reference-details) on the Global‑e Web domain (for example web.global-e.com) to display the shopper's current masked payment method and billing address, then loads the Global‑e payment form as an iFrame on its own page. That call is server-to-server only — the `merchantGuid` it takes is a secret key that identifies the merchant and must not be exposed in browser-side code. > [!NOTE] > > Card details are entered inside the Global‑e hosted iFrame and never reach the merchant page or server, keeping the merchant out of PCI scope for this flow. The following figure shows the Update Payment flow sequence: ![](https://mintcdn.com/globale-enterprise/ZiykvHZPz1ojekrf/images/subscriptions/subscription-connector-update-payment-flow.png?fit=max\&auto=format\&n=ZiykvHZPz1ojekrf\&q=85\&s=3e22d322b0c2fc9c8cde8eec17c45339) Before calling the method: * `globale.merchant.client.js` must be loaded so that `GlobalE` is available globally. * The DOM element identified by `container` must exist before calling UpdatePaymentMethod. ```js theme={null} GlobalE.UpdatePaymentMethod( "subscription-123", "en-US", "USD", "updatePaymentMethodContainer", function (data) { console.log("Success", data); }, function (info) { console.log("Canceled", info); }, function (err) { console.log("Failure", err.error || err.message); }, "MerchantReturnUrl" ); ``` The signature, parameters, callbacks and result codes are documented on the [GlobalE.UpdatePaymentMethod](/globale-updatepaymentmethod) page. **Update delivery address** The Subscription Manager calls the subscription update API (PATCH `/subscriptions/{subscriptionId}`); Global-e validates the new address (same country only) and updates the subscription details, so all future recurring orders ship to the new address. See flow details [here](/subscription-connector#recurring-payment) ## Authentication and Security The endpoints the Subscription Manager calls accept either a JWT bearer token or an API key, both issued to the Subscription Manager by Global-e. For how to obtain and renew a JWT token, see [API Authentication](/api-authentication). To use the API key instead, pass it in the `x-api-key` header: ```http theme={null} x-api-key: {api key value} ``` Get subscription and payment reference details is the exception: the merchant calls it, not the Subscription Manager, and it identifies the merchant by the `merchantGuid` in its path rather than by either of these credentials. That value is a secret key — issue the call server-to-server and keep it off the browser. ## Idempotency Every endpoint in the Subscriptions set requires an `Idempotency-Key` header. It is a UUID that identifies the request, so that the operation is applied at most once however many times it arrives: ```http theme={null} Idempotency-Key: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ``` Send the same value again when you retry a request that timed out or failed in transit. Send a new value for a new operation: a key that has already been processed is rejected with `409`. ```json theme={null} { "error": "Idempotency key conflict", "code": "IDEMPOTENCY_KEY_CONFLICT", "description": "Request already in use. Use a different Idempotency-Key for new operation." } ``` ## API reference Every endpoint in the Subscriptions set, with its full request and response contract: > [card] [Subscription notifications](/api-reference/subscription-notifications) > > `POST /subscriptions/notifications` > [card] [Calculate billing summary](/api-reference/calculate-billing-summary) > > `POST /subscriptions/billing-summary/calculate` > [card] [Create recurring payment](/api-reference/create-recurring-payment) > > `POST /subscriptions/recurringPayments` > [card] [Recurring payment notifications](/api-reference/recurring-payment-notifications) > > `POST /subscriptions/recurringPayments/notifications` > [card] [Update a subscription](/api-reference/update-subscription) > > `PATCH /subscriptions/{subscriptionId}` > [card] [Get subscription and payment reference details](/api-reference/get-subscription-and-payment-reference-details) > > `GET /Payments/Subscriptions/{merchantGuid}` — called by the merchant, server-to-server # Subscriptions Overview Source: https://docs.global-e.com/subscriptions > [!NOTE] > > Subscriptions aren't available for Shopify stores yet. For the integration itself, see the [Subscription Connector (End-to-End)](/subscription-connector) — the API endpoints, request flows, authentication, and idempotency. ## Introduction The **Global-e Subscription Connector** enables merchants to sell **subscription products** with Global-e as the **Merchant of Record (MOR)**. It bridges the merchant's **subscription manager** with Global-e's **checkout, payment, and compliance capabilities**, allowing seamless recurring billing for digital, physical and hybrid goods - with full localization, shipping, and tax and duty management. Using the Subscription Connector, merchants can offer recurring purchases to shoppers globally, while maintaining the same localized checkout experience they already use for one-time orders. **Key Benefits:** * Seamless integration with third-party subscription managers * Support for recurring payments (including trials and discounts) * Full localization of pricing, shipping options, taxes, and duties * Secure tokenization and PCI-compliant storage * Automated fraud checks aligned with Global-e's payment risk controls * Simplified compliance and reporting under Global-e's MOR model * Support for digital, physical, and hybrid (physical + digital) subscriptions, including shipping, physical order documents, and hub-based fulfilment ## Integration Roles and Responsibilities To ensure a successful integration, it's important to understand the division of ownership between the **Merchant**, **Subscription Manager**, and **Global-e**. | Area | Global-e | Subscription Manager | Merchant | | - | - | - | - | | **Plan Management (setup and configuration)** | - | Manages plan creation, pricing, billing cadence, and trial configuration. | Defines available plans and links them to products in the eCommerce platform. | | **Checkout & Payment Processing** | Provides checkout, tokenization, payment execution, fraud checks, and order creation | Creates subscription contracts | Integrates Global-e checkout and ensures product subscription attributes are mapped correctly and triggers contract creation | | **Subscription Contract Lifecycle (renewals, upgrades, downgrades, cancellations)** | - | Owns full contract lifecycle — renewals, upgrades/downgrades, cancellations etc. | Provides shopper-facing interface (e.g., My Account) for managing subscriptions. | | **Update Payment Method** | Exposes an API to the merchant to retrieve current payment method for display. Provides a secure widget for shoppers to update stored payment details; | - | Authenticates the shopper, displays the current payment method, hosts the Global-e's update-payment widget. | | **Update Delivery Address** | Exposes API to validates and update the subscription shipping address | Calls Global-e subscription update API on shopper request. | Provides the shopper-facing interface for address changes. | | **Compliance, Tax & Duties** | Calculates and remits taxes and duties as Merchant of Record. Exposes a "Billing Summary calculation" API (shipping, duties and taxes) for recurring orders. | Calls Global-e "Billing Summary calculation" API **before triggering any recurring payment** to account for any change in the recurring transaction amount (e.g., upgrade, downgrade) | - | | **Recurring Payment Trigger** | Processes recurring transactions on trigger | Initiates recurring payment request to Global-e, provides the products list and associated charge amount. | - | | **Shipping & Fulfilment (physical subscriptions)** | Calculates shipping options and costs at checkout and on every recurring order; auto-selects the recurring shipping option; | Provides the shipping amount to charge on each recurring payment request. | Configures shipping policies and subsidies (e.g., free recurring shipping). | | **Dunning & Retry Logic** | Logs failure reason only | Handles retries, notifications, and cancellations | Defines retry policies & shopper communication | | **Shopper Communication** | - | Handles billing and retry notifications | Manages marketing and general subscription messaging | | **Reporting & Reconciliation** | Provides order-level reporting and reconciliation | Provides subscription lifecycle reporting | Oversees combined reporting for finance teams | **Summary:** * The Subscription Manager is the system of record for subscription lifecycle management. * Global-e handles all payment, fraud and compliance-related functions. * The Merchant oversees storefront setup, communication, and operational coordination. ## Core Capabilities The Global-e Subscription Connector combines Global-e's cross-border commerce expertise with third-party subscription management tools to enable recurring payments, shipping, compliance, and localization at scale. ### Payments & Tokenization * Shopper payment details are securely collected during the initial checkout and tokenized for future recurring charges (MIT – Merchant Initiated Transactions). * Tokenization is handled entirely by Global-e's PCI-compliant systems or, in the case of PayPal, via a vaulted payment reference. * Fraud screening is performed on every payment, including recurring transactions, with manual review for any challenged cases. * Subscribers can change the payment method on an active subscription: Global-e provides an API for the merchant to display the current method and a secure update widget. Credit cards and PayPal are supported, including switching between them. ### Localization, Tax & Duties * The checkout flow is fully localized for currency, language, and tax display - identical to the regular Global-e experience. * All duties and taxes are calculated and collected according to Global-e's configuration. Supported duty policies: Hidden Force DDP and Partial Force DDP; for physical-only subscriptions, also Force DDP and DDU are supported. * Global-e remains the **Merchant of Record (MOR)** for all subscription transactions, handling compliance, remittance, and reporting. * Global-e exposes a "Billing Summary calculation" API for recurring billing: before each renewal it recalculates shipping, tax, and duties against current pricing, shipping options, and regulations. The Subscription Manager uses it when creating renewal invoice. * For subscriptions, tax exemption is re-evaluated on every recurring order from the shopper's registered email address, so it applies only while the exemption is still valid. ### Shipping & Fulfilment * For physical/hybrid subscriptions, checkout captures the shipping address and displays the available shipping options with costs. * On every recurring order, shipping options are recalculated, and Global-e automatically selects the shipping option matching the shopper's first-order choice; if it's unavailable for the destination, a comparable option is used (see [Shipping option selection](/subscriptions#shipping-option-selection)). Product restrictions are re-checked on each recurring order. * Every order (first and recurring) is fulfilled from a single Global-e hub, resolved per order from its destination, with all physical order documents. * The recurring shipping amount charged to the shopper is provided by the Subscription Manager; merchant shipping subsidies (e.g., free recurring shipping) are reflected in the value sent. ### Subscription Manager Integration * External subscription platforms own the subscription lifecycle - plan setup, invoicing, renewals, and cancellations. * The **Subscription Connector** maps API/webhook communication between the subscription manager and Global-e. * Each subscription contract ID received from the subscription manager is stored in Global-e and linked to the corresponding Global-e order for reconciliation and traceability. ### Trials, Discounts & Billing Frequency * Trials are represented as \$0 orders in Global-e, allowing the shopper to complete checkout without payment capture. * Billing cadence (monthly, annual, etc.) and recurring price are passed as parameters from the merchant's platform and are used by Global-e to display the subscription terms clearly to the shopper during checkout. * Hybrid carts containing both one-time and subscription items are supported. * A subscription may contain multiple products, physical and digital (hybrid subscription), sharing a single billing frequency. ### Security & Data Handling * Global-e is fully PCI DSS compliant and handles tokenization internally. * No raw payment data is shared with merchants or subscription managers. * Tokens are deleted according to Global-e retention policy. ## Business Processes Deep Dive This section describes the full lifecycle of a subscription transaction, outlining how Global-e, the Subscription Manager, and the Merchant interact at each stage. ### Plan & Contract Management (Merchant / Subscription Manager) **Overview:** Merchants define and manage subscription plans in their chosen subscription manager. Global-e does not create, store, or manage plans or subscription contracts - it only processes transactions triggered by them. **Key Assumptions:** * Subscription plans are equivalent to merchant-defined products. * Trial duration, recurring price, and billing frequency are set in the subscription manager and passed to Global-e during checkout. * Global-e receives these attributes at checkout for display and processing but does not store or modify plan logic. * Subscription contract creation, cancellation, or updates are handled externally in the subscription manager. ### First Subscription Order (Initial Checkout & Tokenization) **Overview:** The first shopper interaction happens through Global-e checkout. If the cart includes any subscription product, it is treated as a subscription checkout. Hybrid carts are supported: * A mixture of subscription + non-subscription items * A mixture of Physical + digital products **Process:** 1. **Cart identification:** * The eCommerce platform sends product level subscription attributes to Global-e (Subscription indication, Free Trial in Days, Recurring Price, Billing Frequency). 2. **Checkout display:** * Subscription details appear on the subscription products within the product summary, billing summary, and Terms & Conditions sections. * Only one billing frequency is supported per cart. * The Billing Summary shows a "Recurring" line with the total recurring amount - the sum of all subscription products' recurring prices (shipping excluded). * The Terms & Conditions include the recurring charge disclosure (total recurring amount and billing frequency) and a shipping-fees disclaimer for physical recurring goods. * In some markets, the shopper must explicitly opt-in to subscription terms before completing payment. 3. **Payment:** * Only supported payment methods for subscription will be available for selection: credit cards and PayPal. Shopper enters payment details. * The first order follows Global-e's standard payment timing (e.g., capture at dispatch), per the merchant's configuration. * Free trials appear as $0 products and processes as 0$ payment * For a hybrid cart containing a non-subscription product and a free-trial subscription, the billing summary and payment reflect only the non-subscription product's price. 4. **Tokenization:** * Global-e securely stores a tokenized payment reference. * For PayPal, Global-e receives a vaulted ID correlating to the stored payment method. * Tokens are stored in a PCI-secured environment for recurring use (MIT). 5. **Order creation & notification:** * Global-e creates an order with a subscription indicator at both order and product level. * The merchant creates the shopper's subscription contract within the subscription manager. * Global-e stores the subscription contract ID and links it to the order and payment reference; it also stores the billing address, shipping method and address used for recurring orders ### Billing Summary calculation (Shipping, Duties & Taxes) **Overview** To ensure accurate shipping, tax and duty calculation for subscription renewals, Global-e support re-calculating the billing summary prior to each recurring billing attempt. This approach ensures compliance with current pricing, shipping options, tax rules, and regulatory requirements at the time of billing. Global-e remains the Merchant of Record (MOR) and is responsible for shipping options, tax and duty calculation logic, collection, and remittance. The Subscription Manager is responsible for triggering the calculation as part of the recurring billing flow. **Process** 1. **Recurring Billing Preparation** * Before initiating a recurring payment, the Subscription Manager identifies an upcoming renewal and determines the recurring charge amount. 2. **Billing Summary Calculation** * The Subscription Manager calls Global-e's "Billing Summary calculation" API, providing the relevant transaction details (such as amount, currency, and product context). * For physical / hybrid subscriptions, Global-e calculates available shipping options for the destination using the same option as the shopper's first-order. If that option is unavailable, a similar option is selected (see [Shipping option selection](/subscriptions#shipping-option-selection)). * Global-e calculates the applicable taxes and duties based on current rates, rules, and configuration. 3. **Billing Execution** * The calculated amounts (shipping, taxes, and duties) are used by the Subscription Manager when triggering the recurring payment request to Global-e. **Key Notes** * Shipping options, duties and taxes are recalculated for every recurring transaction, regardless of whether the recurring price has changed. * This flow supports price changes, upgrades, downgrades, and regulatory or tax rate updates without additional conditional logic. Which means the result can legitimately differ from the previous cycle. * The Subscription Manager does not calculate taxes, duties or shipping independently and relies on Global-e as the single source of truth. ### Recurring Payments & Global-e Order Creation **Overview:** Recurring payments are triggered by the subscription manager on each renewal date. Global-e processes the payment, performs fraud checks, and creates a new Global-e order upon success. **Process:** 1. **Trigger & Invoice:** * Subscription Manager identifies a due renewal and calls Global-e's "Billing Summary calculation" API, providing the relevant transaction details. * Subscription Manager then uses the returned calculated amounts (shipping, taxes, and duties) while generating the invoice. * Subscription Manager sends a payment request (amount, currency, products, shipping amount, subscription ID) to the Subscription Connector. * Global-e Adapter validates: products Subtotal + duties + taxes + additional Fee + shipping − discounts = total Amount, otherwise order is rejected. * Shipping amount for physical/hybrid subscriptions reflects the Subscription Manager's requested amount as-is; Global-e applies no recalculation or subsidy logic during payment processing. 2. **Payment Execution:** * Global-e retrieves tokenized payment details and sends a payment request to the payment gateway. * The recurring payment is charged immediately upon the Subscription Manager's trigger - no dispatch delay applies to recurring orders 3. **Fraud & Result Handling:** * If payment fails → Global-e returns a failure response. * If successful → Global-e performs fraud checks each cycle. * Approved → Success response and order creation. * Challenged → Order created with "Fraud Challenge" status for manual review. 4. **Order Creation:** * On success, a new Global-e order is created, linked to the original subscription contract. * No fulfilment occurs unless the payment succeeds. * Subscription Manager marks the invoice as "Paid". 5. **Dunning Management:** * Global-e does not manage retry or dunning logic. * Subscription Manager handles retries, customer notifications, and cancellations. * Global-e logs the payment failure reason for reference. **Key Highlights:** * Clear separation of responsibilities: * **Global-e:** on trigger - payment, fraud, shipping, order creation and fulfilment * **Subscription Manager:** lifecycle management, communication, dunning * Fraud checks occur post-payment for consistency with Global-e flows. * Each successful renewal creates a new Global-e order for fulfillment (physical/hybrid subscription), tracking and compliance. * Global-e does not persist, validate or enforce the recurring product list, price or any discount. Those remain with the Subscription Manager. * Global-e does not block the next cycle after a decline or fraud challenge order. Cross-cycle logic belongs in the Subscription Manager. *Notifications: who receives what* * Recurring payment status: Global-e Adapter to the Subscription Manager. * Order and fulfilment status: standard Global-e order notifications to the merchant, not to the Subscription Manager. ### Contract Management (Shopper Actions) **Overview:** Shoppers manage their active subscriptions through the merchant's portal or directly in the subscription manager interface. **Supported Actions:** * **Update Plan:** * Managed by the Subscription Manager. * Includes: upgrades, downgrades, adding or removing products, quantity changes. All update the existing plan. No new checkout. No new subscription. * Global-e needs no notification. It charges any products and amounts sent on the next renewal trigger, which may differ from the previous order. * **Cancel Subscription:** * Managed by the Subscription Manager. * Global-e deletes stored tokens as per Global-e retention policy * **Update Payment Details:** * Shoppers can view and update stored payment methods via a Global-e–hosted, PCI-compliant widget. Global-e stores the new payment reference against the subscription, so future renewals use it. * The widget also provides the ability to edit the billing address, within the same country. * **Update Delivery Address:** * Handled via a dedicated Global-e API: the Subscription Manager calls Global-e to validate and update the new subscription's shipping address (same country only). * On success, the subscription details are updated and all future recurring orders ship to the new address. **Assumptions:** * Token retention and deletion policies are managed by Global-e. * No direct shopper interaction with Global-e systems - all lifecycle management is via the merchant or subscription manager. ## Solution Overview & Architecture ### Conceptual Overview The Subscription Connector allows each system to do what it does best: * The **Subscription Manager** manages subscription plans, contracts, and billing schedules. * **Global-e** manages localized checkout, payment authorization, recurring charges, shipping & fulfilment, and compliance. * The **Merchant** integrates both systems to deliver a seamless experience to shoppers. ### High-Level Flow *Checkout (First Order)* * Shopper selects a subscription product on the merchant's storefront. * The eCommerce platform passes product-level subscription attributes (e.g., trial days, recurring price, billing frequency) to Global-e checkout. (see more information [here](/subscription-connector#checkout-first-order)) * Subscription details appear on the subscription product summary, billing summary, and Terms & Conditions sections. * Global-e processes the first payment (or \$0 if a trial) and securely tokenizes the payment details. * Global-e creates the initial order and sends the order confirmation to the eCommerce platform. * Following a successful order, the merchant triggers subscription creation in the Subscription Manager. * The Subscription Manager creates the subscription contract and notifies Global-e with the newly created subscription ID. (see more information [here](/api-reference/subscription-notifications)) * Global-e stores the subscription ID together with the payment reference (tokenized payment details) billing address, shipping address and shipping method for use in future recurring transactions. *Recurring Payment* * Prior to triggering the recurring payment the Subscription Manager calls Global-e "Billing Summary calculation" API to retrieve the selected shipping option and the applicable tax and duty amounts for the upcoming charge. (see more information [here](/api-reference/calculate-billing-summary)) * On each renewal, the Subscription Manager triggers a payment attempt to Global-e using the subscription ID. (see more information [here](/api-reference/create-recurring-payment)) * Global-e processes the payment, performs fraud checks, and creates a Global-e order upon success. * In case of payment failure, Global-e provides the failure reason, and the Subscription Manager handles retries and dunning logic. *Contract Management* * Shoppers manage their subscriptions (update, cancel, change plan) via the merchant's account area or the Subscription Manager portal. * **Update Payment Method:** The merchant displays the current payment method using a Global-e API, and host Global-e secure widget that allows shoppers to update their stored payment details, including the billing address (same country only). (see more information [here](/globale-updatepaymentmethod)) * **Update Delivery Address:** the Subscription Manager calls Global-e's subscription update API to validate and apply a same-country shipping address change, applied to all future recurring orders. ### Architectural Components | Component | Description | | - | - | | **Merchant Storefront** | The eCommerce front end where shoppers browse and purchase subscription products. | | **Subscription Manager** | Manages subscription plans, billing schedules, renewals, and dunning. | | **Global-e Subscription Connector** | Integration layer that translates API/webhook communication between the Subscription Manager and Global-e. Executes payment processing, tokenization, fraud checks, order creation, and compliance handling. For physical/hybrid subscriptions, this also covers shipping calculation and physical order fulfilment. | ### Architecture Summary * Global-e and the Subscription Manager communicate via the **Subscription Connector** using APIs and webhooks. * The connector ensures **secure, PCI-compliant payment execution** for recurring transactions. * Each renewal is represented as a new **Global-e order**, ensuring continuity in reporting and compliance as well as fulfillment of physical subscriptions products. ## Shipping option selection Below logic describes shipping option selection for physical subscriptions ![](https://mintcdn.com/globale-enterprise/ZiykvHZPz1ojekrf/images/subscriptions/subscriptions-shipping-option-selection.png?fit=max\&auto=format\&n=ZiykvHZPz1ojekrf\&q=85\&s=5b5d9bc5c7821cef8ff708ba7bbe82fa) ## Where to go next > [card] [Subscription Connector](/subscription-connector) > > The end-to-end integration between your Subscription Manager and Global‑e: notifications, billing summary, recurring payments and address updates. > [card] [Update Payment Method](/subscription-connector#contract-management-shopper-actions) > > Host the Global‑e widget so a shopper can change the stored payment method on an active subscription. ## API reference Every endpoint in the Subscriptions set, with its full request and response contract: > [card] [Get subscription and payment reference details](/api-reference/get-subscription-and-payment-reference-details) > > `GET /Payments/Subscriptions/{merchantGuid}` — server-to-server only > [card] [Subscription notifications](/api-reference/subscription-notifications) > > `POST /subscriptions/notifications` > [card] [Calculate billing summary](/api-reference/calculate-billing-summary) > > `POST /subscriptions/billing-summary/calculate` > [card] [Create recurring payment](/api-reference/create-recurring-payment) > > `POST /subscriptions/recurringPayments` > [card] [Recurring payment notifications](/api-reference/recurring-payment-notifications) > > `POST /subscriptions/recurringPayments/notifications` — you implement this one > [card] [Update a subscription](/api-reference/update-subscription) > > `PATCH /subscriptions/{subscriptionId}` > [card] [GlobalE.UpdatePaymentMethod](/globale-updatepaymentmethod) > > Client-side JavaScript SDK method — no REST contract # Summary Source: https://docs.global-e.com/summary The Shopify Mixed Orders feature introduces a flexible, parcel-based fulfillment and financial model that enables merchants to operate seamlessly across multiple countries while maintaining compliance, accurate taxation, and clear reconciliation. # Supported Currencies Source: https://docs.global-e.com/supported-currencies > [!NOTE] > > This section does not apply to Shopify. For information about Shopify, see [Supported Countries and Currencies](/sy_the_basics). Below is a list of countries and currencies supported by Global-e for browsing and shopping in the merchant site. Not all currencies are supported for local currency payment processing. | Country | Currency Name | Currency Code | Currency Symbol | Max Decimal Places | Default Display Example | | - | - | - | - | - | - | | Afghanistan | Afghani | AFN | ؋ | 2 | ؋‎ 1045.60 | | Aland Islands | Euro | EUR | € | 2 | € 1045.60 | | Albania | Lek | ALL | ALL | 0 | ALL 1045 | | Algeria | Algerian Dinar | DZD | DA | 2 | DA 1045.60 | | American Samoa | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Andorra | Euro | EUR | € | 2 | € 1045.60 | | Angola | Kwanza | AOA | Kz | 0 | Kz 1045 | | Anguilla | East Caribbean Dollar | XCD | EC\$ | 2 | EC\$ 1045.60 | | Antigua and Barbuda | East Caribbean Dollar | XCD | EC\$ | 2 | EC\$ 1045.60 | | Argentina | Argentine Peso | ARS | AR\$ | 2 | AR\$ 1045.60 | | Armenia | Armenian Dram | AMD | AMD | 0 | AMD 1045 | | Aruba | Aruban Florin | AWG | Afl. | 2 | Afl. 1045.60 | | Ascension Island | Saint Helena Pound | SHP | SH£ | 2 | SH£ 1045.60 | | Australia | Australian Dollar | AUD | AU\$ | 2 | AU\$ 1045.60 | | Austria | Euro | EUR | € | 2 | € 1045.60 | | Azerbaijan | Azerbaijanian Manat | AZN | man. | 2 | man. 1045.60 | | Bahamas | Bahamian Dollar | BSD | BS\$ | 2 | BS\$ 1045.60 | | Bahrain | Bahraini Dinar | BHD | BD | 2 | BD 1045.60 | | Bangladesh | Taka | BDT | Tk | 0 | Tk 1045 | | Barbados | Barbados Dollar | BBD | Bds\$ | 2 | Bds\$ 1045.60 | | Belarus\* | Euro | EUR | € | 2 | € 1045.60 | | Belgium | Euro | EUR | € | 2 | € 1045.60 | | Belize | Belize Dollar | BZD | BZ\$ | 2 | BZ\$ 1045.60 | | Benin | CFA Franc BCEAO | XOF | CFA | 0 | CFA 1045 | | Bermuda | Bermudian Dollar | BMD | BD\$ | 2 | BD\$ 1045.60 | | Bhutan | Ngultrum | BTN | Nu. | 2 | Nu. 1045.60 | | Bolivia | Boliviano | BOB | Bs | 2 | Bs 1045.60 | | Bonaire, Saint Eustatius and Saba | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Bosnia and Herzegovina | Convertible Mark | BAM | KM | 2 | KM 1045.60 | | Botswana | Pula | BWP | BWP | 2 | BWP 1045.60 | | Bouvet Island | Norwegian Krone | NOK | kr | 2 | Kr 1045.60 | | Brazil | Brazilian Real | BRL | R\$ | 2 | R\$ 1045.60 | | British Indian Ocean Territory | US Dollar | USD | \$ | 2 | \$ 1045.60 | | British Virgin Islands | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Brunei Darussalam | Brunei Dollar | BND | BN\$ | 2 | BN\$ 1045.60 | | Bulgaria | Euro | EUR | € | 2 | € 1045.60 | | Burkina Faso | CFA Franc BCEAO | XOF | CFA | 0 | CFA 1045 | | Burundi | Burundi Franc | BIF | FBu | 0 | FBu 1045 | | Cambodia | Riel | KHR | KHR | 0 | KHR 1045 | | Cameroon | CFA Franc BEAC | XAF | XAF | 0 | XAF 1045 | | Canada | Canadian Dollar | CAD | CA\$ | 2 | CA\$ 1045.60 | | Cape Verde | Cape Verde Escudo | CVE | CV\$ | 2 | CV\$ 1045.60 | | Cayman Islands | Cayman Islands Dollar | KYD | KY\$ | 2 | KY\$ 1045.60 | | Central African Republic | CFA Franc BEAC | XAF | XAF | 0 | XAF 1045 | | Chad | CFA Franc BEAC | XAF | XAF | 0 | XAF 1045 | | Chile | Chilean Peso | CLP | CL\$ | 0 | CL\$ 1045 | | China | Yuan Renminbi | CNY | CN¥ | 2 | CN¥ 1045.60 | | Christmas Island | Australian Dollar | AUD | AU\$ | 2 | AU\$ 1045.60 | | Cocos (Keeling) Islands | Australian Dollar | AUD | AU\$ | 2 | AU\$ 1045.60 | | Colombia | Colombian Peso | COP | COP | 0 | COP 1045 | | Comoros | Comoro Franc | KMF | CF | 0 | CF 1045 | | Congo | CFA Franc BEAC | XAF | XAF | 0 | XAF 1045 | | Congo | Congolese Franc | CDF | CDF | 0 | CDF 1045 | | Cook Islands | New Zealand Dollar | NZD | NZ\$ | 2 | NZ\$ 1045.60 | | Costa Rica | Costa Rican Colon | CRC | ₡ | 0 | ₡ 1045 | | Cote D'Ivoire (Ivory Coast) | CFA Franc BCEAO | XOF | CFA | 0 | CFA 1045 | | Croatia | Euro | EUR | € | 2 | € 1045.60 | | Cuba | Convertible Peso | CUC | CUC | 2 | CUC 1045.60 | | Curacao | Netherlands Antillean Guilder | XCG | NAf. | 2 | NAf. 1045.60 | | Cyprus | Euro | EUR | € | 2 | € 1045.60 | | Czech Republic | Czech Koruna | CZK | Kč | 2 | Kč 1045.60 | | Denmark | Danish Krone | DKK | kr | 2 | kr. 1045.60 | | Djibouti | Djibouti Franc | DJF | Fdj | 0 | Fdj 1045 | | Dominica | East Caribbean Dollar | XCD | EC\$ | 2 | EC\$ 1045.60 | | Dominican Republic | Dominican Peso | DOP | RD\$ | 2 | RD\$ 1045.60 | | East Timor | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Ecuador | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Egypt | Egyptian Pound | EGP | EGP | 2 | EGP 1045.60 | | El Salvador | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Equatorial Guinea | CFA Franc BEAC | XAF | XAF | 0 | XAF 1045 | | Eritrea | Nakfa | ERN | Nfk | 2 | Nfk 1045.60 | | Estonia | Euro | EUR | € | 2 | € 1045.60 | | Ethiopia | Ethiopian Birr | ETB | Br | 2 | Br 1045.60 | | Falkland Islands | Falkland Islands Pound | FKP | FK£ | 2 | FK£ 1045.60 | | Faroe Islands | Danish Krone | DKK | kr. | 2 | kr. 1045.60 | | Fiji | Fiji Dollar | FJD | FJ\$ | 2 | FJ\$ 1045.60 | | Finland | Euro | EUR | € | 2 | € 1045.60 | | France | Euro | EUR | € | 2 | € 1045.60 | | French Guiana | Euro | EUR | € | 2 | € 1045.60 | | French Polynesia | CFP Franc | XPF | CFPF | 0 | CFPF 1045 | | French Southern Territories | Euro | EUR | € | 2 | € 1045.60 | | Gabon | CFA Franc BEAC | XAF | XAF | 0 | XAF 1045 | | Gambia | Dalasi | GMD | GMD | 2 | GMD 1045.60 | | Georgia | Lari | GEL | GEL | 2 | GEL 1045.60 | | Germany | Euro | EUR | € | 2 | € 1045.60 | | Ghana | Ghana Cedi | GHS | GH₵ | 2 | GH₵ 1045.60 | | Gibraltar | Pound Sterling | GBP | £ | 2 | £ 1045.60 | | Greece | Euro | EUR | € | 2 | € 1045.60 | | Greenland | Danish Krone | DKK | kr | 2 | kr. 1045.60 | | Grenada | East Caribbean Dollar | XCD | EC\$ | 2 | EC\$ 1045.60 | | Guadeloupe | Euro | EUR | € | 2 | € 1045.60 | | Guam | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Guatemala | Quetzal | GTQ | GTQ | 2 | GTQ 1045.60 | | Guernsey | Pound Sterling | GBP | £ | 2 | £ 1045.60 | | Guinea | Guinea Franc | GNF | FG | 0 | FG 1045 | | Guinea-Bissau | CFA Franc BCEAO | XOF | CFA | 0 | CFA 1045 | | Guyana | Guyana Dollar | GYD | GY\$ | 0 | GY\$ 1045 | | Haiti | Gourde | HTG | HTG | 2 | HTG 1045.60 | | Heard and McDonald Islands | Australian Dollar | AUD | AU\$ | 2 | AU\$ 1045.60 | | Honduras | Lempira | HNL | HNL | 2 | HNL 1045.60 | | Hong Kong | Hong Kong Dollar | HKD | HK\$ | 2 | HK\$ 1045.60 | | Hungary | Forint | HUF | Ft | 0 | Ft 1045 | | Iceland | Iceland Krona | ISK | kr | 0 | kr 1045 | | India | Indian Rupee | INR | ₹ | 2 | ₹ 1045.60 | | Indonesia | Rupiah | IDR | Rp | 0 | Rp 1045 | | Iran | Iranian Rial | IRR | IRR | 0 | IRR 1045 | | Iraq | Iraqi Dinar | IQD | IQD | 0 | IQD 1045 | | Ireland (Republic of) | Euro | EUR | € | 2 | € 1045.60 | | Isle of Man | Pound Sterling | GBP | £ | 2 | £ 1045.60 | | Israel | Israeli Shekel | ILS | ₪ | 2 | ₪ 1045.60 | | Italy | Euro | EUR | € | 2 | € 1045.60 | | Jamaica | Jamaican Dollar | JMD | J\$ | 0 | J\$ 1045 | | Japan | Yen | JPY | ¥ | 0 | ¥ 1045 | | Jersey | Pound Sterling | GBP | £ | 2 | £ 1045.60 | | Jordan | Jordanian Dinar | JOD | JD | 2 | JD 1045.60 | | Kazakhstan | Tenge | KZT | KZT | 0 | KZT 1045 | | Kenya | Kenyan Shilling | KES | KSh | 0 | KSh 1045 | | Kiribati | Australian Dollar | AUD | AU\$ | 2 | AU\$ 1045.60 | | Korea (North) | North Korean Won | KPW | KPW | 0 | KPW 1045 | | Korea (South) | Won | KRW | ₩ | 0 | ₩ 1045 | | Kuwait | Kuwaiti Dinar | KWD | KD | 2 | KD 1045.60 | | Kyrgyzstan | Som | KGS | KGS | 2 | KGS 1045.60 | | Laos | Kip | LAK | ₭ | 0 | ₭ 1045 | | Latvia | Euro | EUR | € | 2 | € 1045.60 | | Lebanon | Lebanese Pound | LBP | LBP | 0 | LBP 1045 | | Lesotho | Loti | LSL | L for singular, M for plural | 2 | M 1045.60 | | Liberia | Liberian Dollar | LRD | L\$ | 0 | L\$ 1045 | | Libya | Libyan Dinar | LYD | LD | 2 | LD 1045.60 | | Liechtenstein | Swiss Franc | CHF | CHF | 2 | CHF 1045.60 | | Lithuania | Euro | EUR | € | 2 | € 1045.60 | | Luxembourg | Euro | EUR | € | 2 | € 1045.60 | | Macau | Pataca | MOP | MOP\$ | 2 | MOP\$ 1045.60 | | Madagascar | Malagasy Ariary | MGA | Ar | 0 | Ar 1045 | | Malawi | Kwacha | MWK | MWK | 0 | MWK 1045 | | Malaysia | Malaysian Ringgit | MYR | RM | 2 | RM 1045.60 | | Maldives | Rufiyaa | MVR | MVR | 2 | MVR 1045.60 | | Mali | CFA Franc BCEAO | XOF | CFA | 0 | CFA 1045 | | Malta | Euro | EUR | € | 2 | € 1045.60 | | Marshall Islands | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Martinique | Euro | EUR | € | 2 | € 1045.60 | | Mauritania | Mauritanian Ouguiya | MRU | UM | 2 | UM 1045.60 | | Mauritius | Mauritius Rupee | MUR | Rs | 2 | Rs 1045.60 | | Mayotte | Euro | EUR | € | 2 | € 1045.60 | | Mexico | Mexican Peso | MXN | Mex\$ | 2 | Mex\$ 1045.60 | | Micronesia | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Moldova | Moldovan Leu | MDL | MDL | 2 | MDL 1045.60 | | Monaco | Euro | EUR | € | 2 | € 1045.60 | | Mongolia | Tugrik | MNT | ₮ | 0 | ₮ 1045 | | Montenegro | Euro | EUR | € | 2 | € 1045.60 | | Montserrat | East Caribbean Dollar | XCD | EC\$ | 2 | EC\$ 1045.60 | | Morocco | Moroccan Dirham | MAD | MAD | 2 | MAD 1045.60 | | Mozambique | Mozambique Metical | MZN | MTn | 2 | MTn 1045.60 | | Myanmar | Kyat | MMK | MMK | 0 | MMK 1045 | | Namibia | Namibia Dollar | NAD | N\$ | 2 | N\$ 1045.60 | | Nauru | Australian Dollar | AUD | AU\$ | 2 | AU\$ 1045.60 | | Nepal | Nepalese Rupee | NPR | NPRs | 0 | NPRs 1045 | | Netherlands | Euro | EUR | € | 2 | € 1045.60 | | Netherlands Antilles | Netherlands Antillean Guilder | ANG | NAf. | 2 | NAf. 1045.60 | | New Caledonia | CFP Franc | XPF | CFPF | 0 | CFPF 1045 | | New Zealand | New Zealand Dollar | NZD | NZ\$ | 2 | NZ\$ 1045.60 | | Nicaragua | Cordoba Oro | NIO | NIO | 2 | NIO 1045.60 | | Niger | CFA Franc BCEAO | XOF | CFA | 0 | CFA 1045 | | Nigeria | Naira | NGN | ₦ | 0 | ₦ 1045 | | Niue | New Zealand Dollar | NZD | NZ\$ | 2 | NZ\$ 1045.60 | | Norfolk Island | Australian Dollar | AUD | AU\$ | 2 | AU\$ 1045.60 | | North Macedonia | Denar | MKD | ден | 2 | ден 1045.60 | | Northern Mariana Islands | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Norway | Norwegian Krone | NOK | kr | 2 | Kr 1045.60 | | Oman | Rial Omani | OMR | OMR | 2 | OMR 1045.60 | | Pakistan | Pakistan Rupee | PKR | Rs | 0 | Rs 1045 | | Palau | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Panama | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Papua New Guinea | Kina | PGK | PGK | 2 | PGK 1045.60 | | Paraguay | Guarani | PYG | ₲ | 0 | ₲ 1045 | | Peru | Sol | PEN | S/. | 2 | S/. 1045.60 | | Philippines | Philippine Peso | PHP | ₱ | 2 | ₱ 1045.60 | | Pitcairn | New Zealand Dollar | NZD | NZ\$ | 2 | NZ\$ 1045.60 | | Poland | Zloty | PLN | zł | 2 | Zł 1045.60 | | Portugal | Euro | EUR | € | 2 | € 1045.60 | | Puerto Rico | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Qatar | Qatari riyal | QAR | QR | 2 | QR 1045.60 | | Reunion | Euro | EUR | € | 2 | €1045.60 | | Romania | New Romanian Leu | RON | RON | 2 | RON 1045.60 | | Russia | Russian Ruble | RUB | RUB | 0 | RUB 1045 | | Rwanda | Rwanda Franc | RWF | RWF | 0 | RWF 1045 | | S. Georgia and S. Sandwich Isls. | Pound Sterling | GBP | £ | 2 | £ 1045.60 | | Saint Kitts and Nevis | East Caribbean Dollar | XCD | EC\$ | 2 | EC\$ 1045.60 | | Saint Lucia | East Caribbean Dollar | XCD | EC\$ | 2 | EC\$ 1045.60 | | Saint Vincent & the Grenadines | East Caribbean Dollar | XCD | EC\$ | 2 | EC\$ 1045.60 | | Samoa | Tala | WST | WS\$ | 2 | WS\$ 1045.60 | | San Marino | Euro | EUR | € | 2 | € 1045.60 | | Sao Tome and Principe | Dobra | STN | Db | 0 | Db 1045 | | Saudi Arabia | Saudi Riyal | SAR | SAR | 2 | SAR 1045.60 | | Senegal | CFA Franc BCEAO | XOF | CFA | 0 | CFA 1045 | | Serbia | Serbian Dinar | RSD | din. | 0 | din. 1045 | | Seychelles | Seychelles Rupee | SCR | SRe | 2 | SRe 1045.60 | | Sierra Leone | Leone | SLE | Le | 0 | Le 1045 | | Singapore | Singapore Dollar | SGD | S\$ | 2 | S\$ 1045.60 | | Sint Maarten | Netherlands Antillean Guilder | XCG | NAf. | 2 | NAf. 1045.60 | | Slovak Republic | Euro | EUR | € | 2 | € 1045.60 | | Slovenia | Euro | EUR | € | 2 | € 1045.60 | | Solomon Islands | Solomon Islands Dollar | SBD | SI\$ | 2 | SI\$ 1045.60 | | Somalia | Somali Shilling | SOS | Ssh | 0 | Ssh 1045 | | South Africa | Rand | ZAR | R | 2 | R 1045.60 | | South Sudan | South Sudanese Pound | SSP | SSP | 2 | SSP 1045.60 | | Spain | Euro | EUR | € | 2 | € 1045.60 | | Sri Lanka | Sri Lanka Rupee | LKR | SLRs | 0 | SLRs 1045 | | St Barthelemy | Euro | EUR | € | 2 | € 1045.60 | | St Martin | Euro | EUR | € | 2 | € 1045.60 | | St. Helena | Saint Helena Pound | SHP | SH£ | 2 | SH£ 1045.60 | | St. Pierre and Miquelon | Euro | EUR | € | 2 | € 1045.60 | | Sudan | Sudanese Pound | SDG | SDG | 2 | SDG 1045.60 | | Suriname | Surinam Dollar | SRD | SR\$ | 2 | SR\$ 1045.60 | | Svalbard & Jan Mayen Islands | Norwegian Krone | NOK | kr | 2 | Kr 1045.60 | | Swaziland | Lilangeni | SZL | SZL | 2 | SZL 1045.60 | | Sweden | Swedish Krona | SEK | kr | 2 | kr 1045.60 | | Switzerland | Swiss Franc | CHF | CHF | 2 | CHF 1045.60 | | Syria | Syrian Pound | SYP | SY£ | 0 | SY£ 1045 | | Taiwan | New Taiwan Dollar | TWD | NT\$ | 0 | NT\$ 1045 | | Tajikistan | Somoni | TJS | TJS | 2 | TJS 1045.60 | | Tanzania | Tanzanian Shilling | TZS | TSh | 0 | TSh 1045 | | Thailand | Baht | THB | ฿ | 2 | ฿ 1045.60 | | Togo | CFA Franc BCEAO | XOF | CFA | 0 | CFA 1045 | | Tokelau | New Zealand Dollar | NZD | NZ\$ | 2 | NZ\$ 1045.60 | | Tonga | Pa’anga | TOP | T\$ | 2 | T\$ 1045.60 | | Trinidad and Tobago | Trinidad and Tobago Dollar | TTD | TT\$ | 2 | TT\$ 1045.60 | | Tunisia | Tunisian Dinar | TND | DT | 2 | DT 1045.60 | | Turkey | Turkish Lira | TRY | TL | 2 | TL 1045.60 | | Turkmenistan | Turkmenistan New Manat | TMT | TMT | 2 | TMT 1045.60 | | Turks and Caicos Islands | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Tuvalu | Australian Dollar | AUD | AU\$ | 2 | AU\$ 1045.60 | | Uganda | Uganda Shilling | UGX | USh | 0 | USh 1045 | | Ukraine | Hryvnia | UAH | ₴ | 2 | ₴ 1045.60 | | United Arab Emirates | UAE Dirham | AED | AED | 2 | AED 1045.60 | | United Kingdom | Pound Sterling | GBP | £ | 2 | £ 1045.60 | | United States | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Uruguay | Peso Uruguayo | UYU | \$U | 2 | \$U 1045.60 | | US Minor Outlying Islands | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Uzbekistan | Uzbekistan Sum | UZS | UZS | 0 | UZS 1045 | | Vanuatu | Vatu | VUV | VT | 0 | VT 1045 | | Vatican City State (Holy See) | Euro | EUR | € | 2 | € 1045.60 | | Venezuela\* | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Vietnam | Dong | VND | ₫ | 0 | ₫ 1045 | | Virgin Islands (U.S.) | US Dollar | USD | \$ | 2 | \$ 1045.60 | | Wallis and Futuna Islands | CFP Franc | XPF | CFPF | 0 | CFPF 1045 | | Western Sahara | Moroccan Dirham | MAD | MAD | 2 | MAD 1045.60 | | Yemen | Yemeni Rial | YER | YR | 0 | YR 1045 | | Zambia | Zambian Kwacha | ZMW | ZMW | 2 | ZMW 1045.60 | | Zimbabwe\* | US Dollar | USD | \$ | 2 | \$ 1045.60 | > [!NOTE] > > \* Default currency differs from the national currency (BYN / VES / ZWL) due to currency instability or platform support limitations. # Supported Features Source: https://docs.global-e.com/supported-features-sfcc Capability overview for the Global-e SFCC integration. Each group links to the section where configuration and implementation are described. ## Pricing and display | Feature | Summary | | - | - | | [Dynamic prices](/price-calculation-sfcc) | Convert storefront prices on the SFCC backend from the primary price book using FX rate, product/country coefficients, and local rounding rules. | | [Fixed prices](/price-calculation-sfcc) | Use standard price book values as-is for the shopper's shipping country and currency without additional calculation. | | Price formatting | Apply the correct currency symbol and locale formatting for international prices. | | Local currency rounding rules | Round international prices per shipping country/currency defaults or merchant-defined rules. | | GROSS and NET site taxation | Show prices including or excluding tax (VAT) based on the identified shipping country. | | Country coefficient | Apply a shipping-country price uplift so shoppers see final localized prices. | | Product class/group coefficient | Apply product class or group price uplifts on the storefront. | | Price cache | Cache end-customer prices on PLP and PDP for selected shipping countries and currencies. | | Content price conversion | Convert content-embedded prices on the client side via the Global-e Client JS SDK. See [Client JS SDK](/client-js-sdk-sfcc). | | Estimated delivery date | Pass a per–product line item estimated delivery date to Global-e checkout via the `globale.getPliEstimatedDeliveryDate` hook. See [Hooks](/hooks-sfcc). | ## Promotions and targeting | Feature | Summary | | - | - | | [Promotions, campaigns, and coupons](/promotions-sfcc) | Use most standard SFCC promotions with light Global-e-specific configuration for international checkout. Target markets (for example Spain only) via Customer Group and Campaign. | | [Checkout discount vouchers](/checkout-discount-vouchers-sfcc) | Apply special Global-e checkout vouchers via session / customer-group promotions without creating an SFCC coupon line item. **Percentage discounts only** — other checkout discount types are not supported by the Global-e service. | | [Customer groups](/customer-groups-sfcc) | Use merchant-defined groups or build international segments from [session custom attributes](/session-attributes-sfcc) (for example content slots per market). | ## Checkout | Feature | Summary | | - | - | | [Embedded Global-e checkout](/checkout-flow-sfcc) | Checkout runs inside your storefront page container so the browser URL stays on your domain. Some payment providers may redirect to a hosted page and return afterward. | | Loyalty cards | Shoppers can pay with loyalty cards on Global-e checkout. | | Gift cards | Shoppers can purchase gift cards as products and redeem gift cards at checkout. | | Customer address book | Shoppers can select addresses from the SFCC profile address book and save new addresses created at checkout back to the profile. | | Customer subscription | Shoppers can subscribe to newsletters from Global-e checkout. | ## Orders and fulfillment | Feature | Summary | | - | - | | [Standard SFCC orders](/order-lifecycle-sfcc) | International orders are created through the same SFCC order flow as domestic orders. | | Dispatched orders | Export dispatched orders to Global-e using the out-of-the-box cartridge job when required data is present in SFCC. | | Order status | Send order status updates to Global-e via job, and receive inbound status updates from Global-e via incoming API. | | [Order status SFTP fallback](/order-status-sftp-fallback-sfcc) | Optional durable fallback for inbound status updates when the real-time webhook is unavailable or delayed. Global-e writes status files to SFTP; the [GlobaleOrderStatusFallback](/globale-order-status-fallback-sfcc) job applies them with cross-channel deduplication. **Disabled by default** — requires Global-e to enable SFTP export for the merchant. | | Shipping status | Receive incoming API requests from Global-e to update order shipping status in SFCC. | | Refunds | Receive refund status updates from Global-e and send refund requests to the Global-e server. | | [Mixed orders](/hooks-sfcc) | Support split main/sub-order flows when the Mixed Orders feature is enabled. | | Return Merchandise Authorization (RMA) | Process RMA updates from Global-e and sync RMA status to SFCC. See [Hooks → globale.onAfterGeRmaUpdate](/hooks-sfcc#globaleonaftergermaupdate). | | Stock validation | Validate stock availability as part of the Global-e checkout flow. | ## Catalog | Feature | Summary | | - | - | | [Catalog export](/globale-catalog-feed-sfcc) | Export a configurable CSV catalog feed to SFTP for Global-e to consume. | | [Product restrictions](/restricted-products-sfcc) | Restrict products from international sale based on Global-e rules. | ## Storefront architectures | Architecture | Cartridge | Details | | - | - | - | | SiteGenesis (Pipelines or Controllers) | `int_globale` + `int_globale_sitegenesis` | [Cartridges](/cartridges-sfcc) | | SFRA | `int_globale` + `int_globale_sfra` | [Cartridges](/cartridges-sfcc) | | Headless / PWA / mobile | `int_globale` + `int_globale_headless` | [Cartridges](/cartridges-sfcc) | | Country switcher only (non-operated sites) | `int_globale` + `int_globale_sfra_popups` or `int_globale_sitegenesis_popups` | [Client JS SDK](/client-js-sdk-sfcc) | ## Registration | Feature | Summary | | - | - | | Customer registration | Register shoppers from the order confirmation page via the `globale.customerRegistration` hook (Global-e-side configuration required). See [Hooks](/hooks-sfcc). | # Supported Countries and Currencies Source: https://docs.global-e.com/sy_the_basics ## Supported Payment Methods For the payment methods available in each country, see [Payment Methods](/payment-methods-386962). ## Countries and Currencies [A](#a) · [B](#b) · [C](#c) · [D](#d) · [E](#e) · [F](#f) · [G](#g) · [H](#h) · [I](#i) · [J](#j) · [K](#k) · [L](#l) · [M](#m) · [N](#n) · [O](#o) · [P](#p) · [Q](#q) · [R](#r) · [S](#s) · [T](#t) · [U](#u) · [V](#v) · [W](#w) · [Z](#z) **A** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Afghanistan | | | AFN | Afghan Afghani | | | Aland Islands | | | | | | | Albania | Albanian | Yes | ALL | Lek | | | Algeria | | | DZD | Algerian Dinar | | | American Samoa (Not for US) | | | USD | US Dollar | Not supported for US Shopify merchants | | Andorra | | | EUR | Euro | | | Angola | | | AOA | Kwanza | | | Anguilla | | | XCD | East Caribbean Dollar | | | Antigua and Barbuda | | | XCD | East Caribbean Dollar | | | Argentina | | | ARS | Argentine | | | Armenia | Armenian | Yes | AMD | Armenian Dram | | | Aruba | Dutch | Yes | AWG | Aruban Florin | | | Ascension Island | | | | | | | Australia | | | AUD | Australian Dollar | | | Austria | | | EUR | Euro | | | Azerbaijan | Azeri | Yes | AZN | Azerbaijanian Manat | | **B** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Bahamas | | | BSD | Bahamian Dollar | | | Bahrain | | | USD | US Dollar | | | Bangladesh | | | BDT | BangladeshTaka | | | Barbados | | | BBD | Barbados Dollar | | | Belarus | Belarusian | Yes | | | | | Belgium | Dutch | Yes | EUR | Euro | | | Belize | | | BZD | Belize Dollar | | | Benin | | | XOF | CFA Franc BCEAO | | | Bermuda | | | USD | US Dollar | | | Bhutan | | | USD | US Dollar | | | Bolivia | | | BOB | Boliviano | | | Bonaire, Sint Eustatius and Saba | | | | | | | Bosnia and Herzegovina | | | BAM | Convertible Mark | | | Botswana | | | BWP | Pula | | | Bouvet Island | | | | | | | Brazil | | | BRL | Brazilian Real | | | British Indian Ocean Territory | | | | | | | British Virgin Islands | | | USD | US Dollar | | | Brunei Darussalam | | | BND | Brunei Dolla | | | Bulgaria | Bulgarian | Yes | BGN | Bulgarian Lev | | | Burkina Faso | | | XOF | CFA Franc BCEAO | | | Burundi | | | BIF | Burundi Franc | | **C** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Cambodia | | | KHR | Riel | | | Cameroon | | | XAF | CFA Franc BEAC | | | Canada | | | CAD | Canadian Dollar | | | Cape Verde | | | CVE | Cabo Verde Escudo | | | Cayman Islands | | | KYD | Cayman Islands Dollar | | | Central African Republic | | | | | | | Chad | | | XAF | CFA Franc BEAC | | | Chile | | | CLP | Chilean Peso | | | China | Chinese (Simplified) | Yes | CNY | | | | Christmas Island | | | | | | | Cocos (Keeling) Islands | | | AUD | Australian Dollar | | | Colombia | | | COP | Colombian Peso | | | Comoros | Swahili | Yes | KMF | Comoro Franc | | | Congo (The Democratic Republic of the) | | | CDF | Congolese Franc | | | Congo (The) | | | XAF | CFA Franc BEAC | | | Congo, Democratic Republic | | | | | | | Cook Islands | | | NZD | New Zealand Dollar | | | Costa Rica | | | CRC | Costa Rican Colon | | | Cote D'Ivoire (Ivory Coast) | | | XOF | CFA Franc BCEAO | | | Croatia | Croatian | Yes | EUR | Euro | | | Cuba | | | | | | | Curacao | Dutch | Yes | ANG | Netherlands Antillean Guilder | | | Cyprus | | | EUR | Euro | | | Czech Republic | Czech | Yes | CZK | Czech Koruna | | **D** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Denmark | Danish | Yes | DKK | Danish Krone | | | Djibouti | Swahili | Yes | DJF | Djibouti Franc | | | Dominica | | | XCD | East Caribbean Dollar | | | Dominican Republic | | | DOP | Dominican | | **E** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | East Timor | | | USD | US Dollar | | | Ecuador | | | USD | US Dollar | | | Egypt | | | EGP | Egyptian Pound | | | El Salvador | | | USD | US Dollar | | | Equatorial Guinea | | | XAF | CFA Franc BEAC | | | Equatorial New Guinea | | | | | | | Estonia | Estonian | Yes | EUR | Euro | | | Ethiopia | | | ETB | Ethiopian Birr | | **F** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Falkland Islands | | | FKP | Falkland Islands Pound | | | Faroe Islands | Faroese | Yes | DKK | Danish Krone | | | Fiji | | | FJD | Fiji Dollar | | | Finland | Finnish | Yes | EUR | Euro | | | France | French | Yes | EUR | Euro | | | French Guiana | | | EUR | Euro | | | French Polynesia | | | XPF | CFP Franc | | **G** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Gabon | | | USD | US Dollar | | | Gambia | | | GMD | Dalasi | | | Georgia | Georgian | Yes | GEL | Lari | | | Germany | German | Yes | EUR | Euro | | | Ghana | | | USD | US Dollar | | | Gibraltar | | | GBP | Pound Sterling | | | Greece | Greek | Yes | EUR | Euro | | | Greenland | | | DKK | Danish Krone | | | Grenada | | | XCD | East Caribbean Dollar | | | Guadeloupe | | | EUR | Euro | | | Guam (not for US) | | | USD | US Dollar | Not supported for US Shopify merchants | | Guatemala | | | GTQ | Quetzal | | | Guernsey | | | GBP | Pound Sterling | | | Guinea | | | GNF | Guinea Franc | | | Guinea-Bissau | | | XOF | CFA Franc BCEAO | | | Guyana | | | GYD | Guyana Dollar | | **H** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Haiti | | | HTG | Gourde | | | Honduras | | | HNL | Lempira | | | Hong Kong | | | HKD | Hong Kong Dollar | | | Hungary | Hungarian | Yes | HUF | Forint | | **I** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Iceland | Icelandic | Yes | ISK | Iceland Krona | | | India | Hindi | Yes | INR | Indian Rupee | | | India | Kannada | Yes | | | | | India | Konkani | Yes | | | | | India | Marathi | Yes | | | | | India | Sanskrit | Yes | | | | | India | Tamil | Yes | | | | | India | Telugu | Yes | | | | | Indonesia | Indonesian | Yes | IDR | Rupiah | | | Iran | Farsi | Yes | | | | | Iraq | Syriac | | | | | | Ireland (Republic of) | | | EUR | Euro | | | Isle of Man | | | GBP | Pound Sterling | | | Israel | Hebrew | Yes | ILS | Israeli Shekel | | | Italy | Italian | Yes | EUR | Euro | | **J** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Jamaica | | | JMD | Jamaican Dollar | | | Japan | Japanese | Yes | JPY | Yen | | | Jersey | | | GBP | Pound Sterling | | | Jordan | | | USD | US Dollar | | **K** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Kazakhstan | Kazakh | Yes | KZT | Tenge | | | Kenya | Swahili | Yes | KES | Kenyan Shilling | | | Kiribati | | | USD | US Dollar | | | Korea (South) | Korean | Yes | KRW | Won | | | Kuwait | | | USD | US Dollar | | | Kyrgyzstan | Kyrgyz | Yes | KGS | Som | | **L** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Laos | | | LAK | Kip | | | Latvia | Latvian | Yes | EUR | Euro | | | Lebanon | | | LBP | Lebanese Pound | | | Lesotho | | | LSL | Loti | | | Liberia | | | LRD | Liberian Dollar | | | Liechtenstein | | | CHF | Swiss Franc | | | Lithuania | Lithuanian | Yes | EUR | Euro | | | Luxembourg | | | EUR | Euro | | **M** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Macau | | Yes | MOP | Pataca | | | Macedonia | Macedonian | | | | | | Madagascar | | | USD | US Dollar | | | Malawi | | | MWK | Kwacha | | | Malaysia | Malay | Yes | MYR | Malaysian Ringgit | | | Maldives | Dhivehi | Yes | MVR | Rufiyaa | | | Malta | | | EUR | Euro | | | Marshall Islands | | | USD | US Dollar | Not supported for US Shopify merchants | | Martinique | | | EUR | Euro | | | Mauritania | | | USD | US Dollar | | | Mauritius | | | MUR | Mauritius Rupee | | | Mayotte | | | EUR | Euro | | | Mexico | | | MXN | Mexican Peso | | | Moldova | | | MDL | Moldovan Leu | | | Monaco | | | EUR | Euro | | | Mongolia | Mongolian | Yes | MNT | Tugrik | | | Montenegro | | | EUR | Euro | | | Montserrat | | | XCD | East Caribbean Dollar | | | Morocco | | | MAD | Moroccan Dirham | | | Mozambique | Swahili | Yes | MZN | Mozambique Metical | | | Mynamar | | | MMK | Kyat | | **N** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Namibia | | | NAD | Namibia Dollar | | | Nauru | | | AUD | Australian Dollar | | | Nepal | | | NPR | Nepalese Rupee | | | Netherlands | Dutch | Yes | EUR | Euro | | | New Caledonia | | | XPF | CFP Franc | | | New Zealand | | | NZD | New Zealand Dollar | | | Nicaragua | | | NIO | Cordoba Oro | | | Nigeria | | | NGN | Naira | | | Niue | | | NZD | New Zealand Dollar | | | North Macedonia | | | MKD | Denar | | | Northern Mariana Islands | | | USD | US Dollar | Not supported for US Shopify merchants | | Norway | Norwegian | Yes | NOK | Norwegian Krone | | **O** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Oman | Arabic | | USD | US Dollar | | **P** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Pakistan | Punjabi | Yes | PKR | Pakistan Rupee | | | Pakistan | Gujarati | Yes | PKR | Pakistan Rupee | | | Pakistan | Urdu | Yes | PKR | Pakistan Rupee | | | Palau | | | USD | US Dollar | Not supported for US Shopify merchants | | Panama | | | USD | US Dollar | | | Papua New Guinea | | | PGK | Kina | | | Paraguay | | | PYG | Guarani | | | Peru | | | PEN | Sol | | | Philippines | | | PHP | Philippine | | | Poland | Polish | Yes | PLN | Zloty | | | Portugal | Portuguese | Yes | EUR | Euro | | | Puerto Rico | | | USD | US Dollar | Not supported for US Shopify merchants | **Q** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Qatar | | | QAR | Qatari Riyal | | **R** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Reunion | | | EUR | Euro | | | Romania | Romanian | Yes | RON | New Romanian Leu | | | Russia | Russian | Yes | | | | | | Tatar | Yes | | | | | Rwanda | Swahili | Yes | RWF | Rwanda Franc | | **S** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Saint Kitts and Nevis | | | XCD | East Caribbean Dollar | | | Saint Lucia | | | XCD | East Caribbean Dollar | | | Saint Vincent and the Grenadines | | | XCD | East Caribbean Dollar | | | Samoa | | | WST | Tala | | | San Marino | | | EUR | Euro | | | Sao Tome and Principe | | | STD | São Tomé and Príncipe Dobra | | | Saudi Arabia | Arabic | Yes | SAR | Saudi Riyal | | | Senegal | | | XOF | CFA Franc BCEAO | | | Serbia | | | RSD | Serbian Dinar | | | Seychelles | | | SCR | Seychelles Rupee | | | Sierra Leone | | | SLL | Sierra Leonean Leone | | | Singapore | | | SGD | Singapore Dollar | | | Sint Maarten | Dutch | Yes | ANG | Netherlands Antillean Guilder | | | Slovak Republic | Slovak | Yes | EUR | Euro | | | Slovenia | Slovenian | Yes | EUR | Euro | | | Solomon Islands | | | SBD | Solomon Islands Dollar | | | Somalia | Swahili | Yes | | | | | South Africa | Afrikaans | Yes | ZAR | Rand | | | Spain | Basque | Yes | EUR | Euro | | | Spain | Catalan | Yes | | | | | Spain | Galician | Yes | | | | | Spain | Spanish | Yes | | | | | Sri Lanka | | | LKR | Sri Lanka Rupee | | | St Barthelemy | | | EUR | Euro | | | St Martin | | | EUR | Euro | | | St. Helena | | | SHP | Saint Helena Pound | | | Sudan | | | SDG | Sudanese Pound | | | Suriname | Dutch | Yes | SRD | Surinam Dollar | | | Swaziland | | | SZL | Lilangeni | | | Sweden | Swedish | Yes | SEK | Swedish Krona | | | Switzerland | | | CHF | Swiss Franc | | | Syria | Syriac | Yes | | | | **T** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Taiwan | | | TWD | New Taiwan Dollar | | | Tanzania | Swahili | Yes | TZS | Tanzanian Shilling | | | Thailan | | | | | | | Thailand | Thai | Yes | THB | Baht | | | The Democratic Republic of Congo | Swahili | Yes | | | | | Togo | | | XOF | CFA Franc BCEAO | | | Tonga | | | TOP | Pa’anga | | | Trinidad and Tobago | | | TTD | Trinidad and Tobago Dollar | | | Tunisia | | | USD | US Dollar | | | Turkey | Turkish | Yes | TRY | Turkish Lira | | | Turkmenistan | | | USD | US Dollar | | | Turks and Caicos Islands | | | USD | US Dollar | | | Tuvalu | | | AUD | Australian Dollar | | **U** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Uganda | Swahili | Yes | UGX | Uganda Shilling | | | Ukraine | Ukrainian | Yes | | | | | United Arab Emirates | | | AED | UAE Dirham | | | United Kingdom | | | GBP | Pound Sterling | | | United States | | | USD | US Dollar | | | Uruguay | | | UYU | Uruguayo | | | Uzbekistan | Uzbek | Yes | UZS | Uzbekistan Sum | | **V** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Vanuatu | | | VUV | Vatu | | | Vatican City (Holy See) | | | | | | | Vatican City State (Holy See) | | | EUR | Euro | | | Venezuela | | | USD | US Dollar | | | Vietnam | Vietnamese | Yes | VND | Dong | | | Virgin Islands (U.S.) (not for US) | | | | | | | Virgin Islands (US) | | | USD | US Dollar | Not supported for US Shopify merchants | **W** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Wallis and Futuna Islands | | | XPF | CFP Franc | | **Z** | Country | Supported Language | Checkout Language Supported | Supported Currency | Currency Name | Remarks | | - | - | - | - | - | - | | Zambia | Swahili | Yes | ZMW | Zambian Kwacha | | | Zimbabwe | | | USD | US Dollar | | # System - User Management Source: https://docs.global-e.com/system---user-management From the **Users** page administrators can search, view, add, and edit user accounts and their roles. ## Searching users 1. Navigate to *System > Users*. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2e22522c-d5c3-17de-447f-f49acfa855e9.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=9878cd043c6a5429f1e791d90cb4dc7a) 2. Select **By Name**, **By Email**, or **By User Name** and type text in the search field. 3. Click **Search**. The search results are displayed in the bottom region of the page. ## Adding users 1. Navigate to *System > Users*. 2. Click **Add New User**. 3. Define the following: * First name * Last name * Email * Phone number 4. Assign a user role or roles. For what each role can access, see [Global-e Roles and Features](/global-e-roles-and-features). > [!NOTE] > > Some roles, such as Merchant Admin and Merchant CS, require you to select at least one merchant. ## Editing users The following users can edit existing users: * Global admins * Merchant, CS, and Hub admins with adequate permissions for the specific feature. For more information, see [Global-e Roles and Features](/global-e-roles-and-features). 1. Find the user. See [Searching users](#searching-users). 2. Click **Edit User** at the end of the row. The Edit User screen is displayed. 3. Edit the fields as required, including: * Personal information * Add, remove, or change roles as required * Click **Reset Password** to reset your password 4. Click **Save**. # Global-e Knowledge Hub Terms of Use Source: https://docs.global-e.com/terms-of-use Last updated: October 15, 2023 IMPORTANT – Please read the following terms of use ("**Terms**") carefully before using the Global-e Knowledge Hub and the Global-e Materials, which include the Global-e Materials and the associated Documentation (both as defined below). By using the hub, reviewing the information contained or by downloading any Documentation (or any similar action, use or activity), or otherwise accessing or using any part of the Global-e Materials, you expressly acknowledge and agree that you (on behalf of yourself or the entity that you represent, in which case the terms “User”, "you" or "your" will refer to such entity) are entering into a legal agreement with Global-e Online Ltd. ("**Global-e**", “**we**", "**us**" or "**our**") and have understood and agreed to comply with, and be legally bound by, the terms and conditions of these Terms. You hereby waive any applicable rights to require an original (non-electronic) signature or delivery or retention of non-electronic records, to the extent not prohibited under the laws of your jurisdiction. If you do not agree to be bound by these Terms, you must not access the Knowledge Hub or use any part of the Global-e Materials. These Terms may refer to you and Global-e individually as a "**Party**" and collectively as the "**Parties**". 1. **Definitions.** | 1.1 | "**Documentation**" means Global-e's proprietary documentation on Global-e's solutions and services, including, but not limited to, an overview of the Global-e technology, details on how to integrate it with your platform, the steps required to prepare your environment to fulfil international orders, step-by-step instructions for working with the Global-e Merchant Portal, programming tools and other instructional documentation, in the form generally made available by Global-e for use therewith. | | - | - | | 1.2 | "**Intellectual Property Rights**" means any and all rights, titles, and interests (under any jurisdiction or treaty, whether protectable or not, whether registered or unregistered, and whether vested, contingent, or future) in and to inventions, discoveries, works of authorship, designs, software, technical information, databases, know-how, mask works, methods, branding, technology, and other intellectual property (collectively, "Intellectual Property"), and includes but is not limited to patents, copyrights and similar authorship rights, moral (and similar personal) rights, mask work rights, data and database rights, trade secret rights and similar rights in confidential information and other non-public information, design rights, trademark, service mark, trade name, trade dress and similar branding rights, as well as: (i) all applications, registrations, renewals, reexaminations, extensions, continuations, continuations-in-part, provisionals, substitutions, divisions or reissues of or for the foregoing; and (ii) all goodwill associated with the foregoing. | | 1.3 | "**Materials**" means any Documentation, and any guides or tutorials in whatever format or medium available on or through the Knowledge Hub including any images, drawings, screen captures or videos. | | 1.4 | “**Knowledge Hub**” means the site portal available on ([https://docs.global-e.com/enterprise/index.html?lang=en](https://docs.global-e.com/enterprise/index.html?lang=en)). | 2. **License.** Subject to the terms and conditions of these Terms, Global-e grants you a personal, limited, non-exclusive, non-sublicensable, non-transferable, non-assignable license to access the Knowledge Hub and to use the Materials. The Knowledge Hub and the underlying Materials will be used solely for the purpose of enhancing your knowledge of our solutions, technology and if applicable, to further connecting your software and/or evaluating the potential connection of your software with the Global-e technology or the use thereof, using the Global-e APIs (“**Integration**”). For the avoidance of doubt, your use of the Global-e Materials will also be subject to any other agreement and/or terms of use provided to you by Global-e in connection with Global-e Materials, or any other service(s) provided by Global-e. Except to the extent expressly permitted otherwise in these Terms, you will not (and will not permit any third party to): (i) reproduce, (sub)license, disclose, distribute, sell, rent, lease, lend, transfer, assign, export, publicly display, publicly perform, or otherwise commercially exploit Global-e Materials; (ii) allow access, linking, calling or querying to, or any other interaction with, the API from any unauthorized source; (iii) reverse engineer, decompile, disassemble, or derive (or attempt to derive) the source code or underlying structure, sequence or organization of, the Global-e Materials; (iv) modify, alter, adapt, arrange, translate, or create a derivative work of the Global-e Materials; (v) circumvent, disable, work around, hide from, manipulate, or otherwise interfere with any security-related, encoding or technical features, protocols, standards of or in the Global-e Materials, or with features that prevent or restrict the use of Global-e Materials or any content therein; (vi) use Global-e Materials to develop a service or product (such as, but not limited to, your Developer Implementation) that is the same as, substantially similar to any other product or service offered by Global-e (as we may determine at our sole and absolute discretion); (vii) remove, deface, obscure, or alter Global-e's, or any third parties, trademarks, logos and/or proprietary legends displayed, or otherwise provided as part of, Global-e Materials (and you agree to reproduce such proprietary legends on/in all authorized copies thereof); (viii) use **Global-e Materials in any way that is unlawful, infringing, deceptive, harassing, or defamatory, or for any inappropriate purpose** (as we may determine at our sole and absolute discretion, but which will always include direct marketing and spamming); and (ix) publish, transmit, or link to any robot, spider, crawler, virus, malware, Trojan horse, spyware, or similar malicious code intended (or that has the potential) to damage, disrupt, compromise, or exploit a User’s browser, computer, or mobile (or other) device. 3. **Responsibility for Integration.** You are, and will always remain, solely responsible and liable for the use of the Materials, whether for Integration or for any other lawful purpose, and Global-e will have no liability or obligations with respect to the same (including support obligations), unless otherwise set forth herein or in an applicable lawful services agreement. 4. **Support.** These Terms do not entitle you to any support, maintenance or other technical assistance for the Global-e Materials. Global-e is under no obligation to create or make available any updates or upgrades to the Materials (including any Documentation) or its APIs. In the event that we do create an update or upgrade to any of the foregoing, we reserve the right at our sole and absolute discretion to decide if, when, and under what circumstances we make such update or upgrade available. 5. **Intellectual Property Rights** | 5.1 | Ownership. Global-e (and/or its licensors and suppliers, as applicable) is, and will be, the sole and exclusive owner of all right, title and interest (including without limitation all Intellectual Property Rights) in and to: (a) the Knowledge Hub and any and all Global-e Materials (and all underlying Intellectual Property); (b) Global-e’s Confidential Information; (c) any improvements, derivative works, enhancements, and/or modifications of/to any of the foregoing, as well as any other Intellectual Property conceived, authored, or otherwise developed pursuant to these Terms, in each case regardless of inventorship or authorship. To the extent any of the foregoing Intellectual Property Rights do not automatically vest in Global-e, you hereby irrevocably assign (and will assign) same to Global-e (and its designees, successors, and assigns), and undertakes to do all things reasonably requested by Global-e (including without limitation executing, filing, and delivering instruments of assignment and recordation), at Global-e’s expense, to perfect such ownership rights. Any rights not expressly granted to you in these Terms, are hereby reserved by Global-e. | | - | - | | 5.2 | Feedback. If you provide us with any feedback, ideas or suggestions regarding any Global-e Materials ("**Feedback**"), you hereby irrevocably and unconditionally assign to Global-e, for no payment or other consideration of any kind, all Intellectual Property Rights in and to such Feedback, and agree that we will have the right to use such Feedback in any manner and for any purpose whatsoever. In addition, and to the maximum extent permitted by the Laws of your jurisdiction, you hereby irrevocably waive any moral (or similar personal) rights with respect to such Feedback. Any Feedback you provide to us will be deemed Global-e's Confidential Information (as defined below), and not as confidential or proprietary to you, and will be processed and handled in accordance with Section ‎7. You agree that you will not submit to Global-e any feedback, ideas or suggestions that you consider to be confidential or proprietary to you or a third party. | | 5.3 | Usage Data. You further agree that Global-e may collect, access and use any and all usage data and information related to your use of the Knowledge Hub or the Global-e Materials (“**Usage Data**”), individually or in the aggregate, for any business purpose, including, without limitation, providing enhancements to the Global-e Materials and other services; analyzing performance, usage and preferences; and/or developing new products, services, features and functionality. You hereby represent and warrant that you have all rights required to provide Global-e with the Usage Data for the purposes intended hereunder. | | 5.4 | Third Party Software and Information. Notwithstanding anything contained herein to the contrary, Global-e does not make any representation or warranty with respect to any third party information or software. If the Integration includes any open source software, you hereby represent, warrant and covenant that the Integration: (i) has complied and will comply with all applicable open source software licensing terms; and (ii) has not and will not use any open source software in such a manner that would cause any software or other Intellectual Property of Global-e to be subject to any open source software licensing terms, restrictions or obligations. The Knowledge Hub may include or refer to third-party content typically labeled as such and provided for informational purposes only. We do not guarantee its accuracy or endorse it. Use it at your discretion, respecting copyrights and trademarks. | 6. **Confidentiality.** You may, from time to time, gain access to, or be provided with (including orally, such as by one of our sales or support **personnel**), Global-e's proprietary information and materials, technical data, trade secrets, know-how, source code, research, product plans, products, services, customers, customer lists, markets, software, developments, inventions, processes, formulas, algorithms, technology, designs, drawings, engineering, hardware configuration information, marketing, or finances, as well as other business information that is either marked (or, if disclosed orally, designated) as “confidential” or disclosed in such a manner that it would be reasonably apparent that it should be treated confidentially (collectively, “**Confidential Information**”). For the avoidance of doubt, all Global-e Materials are Confidential Information. You may use Confidential Information solely to the extent necessary to exercise your rights under these Terms. You may not disclose Confidential Information to any third party without our prior express written consent, except that you may disclose Confidential Information to your employees that are bound by written confidentiality obligations at least as protective of our Confidential Information as provided for herein. You agree to securely maintain and protect Confidential Information from unauthorized use, access, or disclosure with the same degree of care that you would use to protect your own confidential and proprietary information of a similar nature, but in any event with no less than a reasonable degree of care. 7. **Disclaimer of Warranties. Limitation of Liability.** | 7.1 | ALL GLOBAL-E MATERIALS ARE PROVIDED TO YOU ON AN "AS IS" AND "AS AVAILABLE" BASIS, WITHOUT ANY REPRESENTATION, WARRANTY, GUARANTEE OR CONDITION OF ANY KIND WHATSOEVER (WHETHER EXPRESS, IMPLIED OR STATUTORY), INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, NON-INFRINGEMENT, AND QUALITY OF SERVICE, OR THAT OTHERWISE ARISE FROM A COURSE OF PERFORMANCE OR USAGE OF TRADE, ALL OF WHICH ARE HEREBY DISCLAIMED BY GLOBAL-E. IN ADDITION, GLOBAL-E MAKES NO REPRESENTATION, WARRANTY, GUARANTEE OR CONDITION (i) REGARDING THE CONTENT, EFFECTIVENESS, USEFULNESS, RELIABILITY, AVAILABILITY, TIMELINESS, QUALITY, ACCURACY OR COMPLETENESS OF ANY OF THE GLOBAL-E MATERIALS; OR (ii) THAT YOUR USE OF THE GLOBAL-E MATERIALS WILL MEET YOUR REQUIREMENTS OR EXPECTATIONS, OR WILL BE INTERRUPTED, SECURE OR ERROR-FREE. | | - | - | | 7.2 | IN NO EVENT SHALL GLOBAL-E, ITS AFFILIATES, OR LICENSORS BE LIABLE UNDER, OR OTHERWISE IN CONNECTION WITH, THIS AGREEMENT, FOR: (A) ANY CONSEQUENTIAL, INDIRECT, SPECIAL, INCIDENTAL, OR PUNITIVE DAMAGES; (B) ANY LOSS OF PROFITS, BUSINESS, OPPORTUNITY, REVENUE, CONTRACTS, ANTICIPATED SAVINGS, OR WASTED EXPENDITURE; (C) ANY LOSS OF, OR DAMAGE OR INTERRUPTION TO, DATA, NETWORKS, INFORMATION SYSTEMS, REPUTATION, OR GOODWILL; AND/OR (D) THE COST OF PROCURING ANY SUBSTITUTE GOODS OR SERVICES. | | 7.3 | THE COMBINED AGGREGATE LIABILITY OF GLOBAL-E AND ALL GLOBAL-E AFFILIATES UNDER, OR OTHERWISE IN CONNECTION WITH, THIS AGREEMENT SHALL NOT EXCEED THE AMOUNT OF FEES ACTUALLY PAID BY CUSTOMER TO COMPANY UNDER THIS AGREEMENT IN THE SIX (6) MONTHS IMMEDIATELY PRECEDING THE DATE GIVING RISE TO LIABILITY (OR, IF NO FEES APPLY, ONE HUNDRED US DOLLARS (USD\$100)). | | 7.4 | THE FOREGOING EXCLUSIONS AND LIMITATION SHALL APPLY: (A) TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW; (B) EVEN IF A PARTY HAS BEEN ADVISED, OR SHOULD HAVE BEEN AWARE, OF THE POSSIBILITY OF LOSSES, DAMAGES, OR COSTS; (C) EVEN IF ANY REMEDY IN THIS AGREEMENT FAILS OF ITS ESSENTIAL PURPOSE; AND (D) REGARDLESS OF THE THEORY OR BASIS OF LIABILITY, AND WHETHER IN CONTRACT, TORT (INCLUDING WITHOUT LIMITATION FOR NEGLIGENCE OR BREACH OF STATUTORY DUTY), STRICT LIABILITY, MISREPRESENTATION, OR OTHERWISE. | | 7.5 | THE FOREGOING EXCLUSIONS AND LIMITATIONS SHALL APPLY: (A) EVEN IF GLOBAL-E OR OUR AFFILIATES HAVE BEEN ADVISED, OR SHOULD HAVE BEEN AWARE, OF THE POSSIBILITY OF LOSSES OR DAMAGES; (B) EVEN IF ANY REMEDY IN THIS AGREEMENT FAILS OF ITS ESSENTIAL PURPOSE; and (C) REGARDLESS OF THE THEORY OR BASIS OF LIABILITY (SUCH AS, BUT NOT LIMITED TO, BREACH OF CONTRACT OR TORT). | 8. **Termination.** Global-e reserves the right to immediately terminate these Terms, or otherwise modify, suspend or discontinue your access to and use of any and all of the Global-e Materials, for any reason whatsoever, at any time, and without notice to you, and you agree that we will have no liability or obligation to you for any such termination, modification, suspension, or discontinuance. 9. **Effect of Termination; Survival.** Upon the effective date of termination of these Terms pursuant to Section ‎8 *(Termination)* above your access to the API will immediately be revoked. All license rights granted to you hereunder will terminate and you must immediately cease all access to and use of any and all Global-e Materials. As directed by Global-e, you must return to Global-e or destroy all of the Global-e Materials, and all copies thereof, from all computers, hard drives, networks and other storage media. Upon termination of these Terms, those rights and obligations that by their nature ought to survive termination, will survive. 10. **Export Compliance**. You represent and warrant that: (a) it is not a resident of, and will not access or use the Service in, a country that the U.S. government has embargoed for use of the Service, and that Customer is not a person or entity named on the U.S. Treasury Department’s list of Specially Designated Nationals or any other applicable trade sanctioning regulations of any jurisdiction; and (b) its country of residence and/or incorporation (as applicable) is the same as the country specified in the contact and/or billing address provided to Company. You will not transfer, export, re-export, import, re-import or divert the Global-e Materials in violation of any Export Control Laws (defined below), and will not transfer, export, re-export, import, re-import or divert the Global-e Materials to Lebanon, Syria, Iran, Iraq, Sudan, Yemen, Cuba, or North Korea (or other countries specifically designated in writing by Company from time to time). In the event of a breach under this Section (Export Compliance), you agree to indemnify and hold harmless Global-e and all Global-e Affiliates (and their respective directors, officers, and employees) for any fines and/or penalties imposed upon Global-e or a Global-e Affiliate (or such persons) as a result of such breach. "Export Control Laws" means all applicable export and re-export control Laws applicable to you and/or Global-e, as well as the United States' Export Administration Regulations (EAR) maintained by the US Department of Commerce, trade and economic sanctions maintained by the US Treasury Department's Office of Foreign Assets Control, and the International Traffic in Arms Regulations (ITAR) maintained by the US Department of State. 11. **Governing Law and Jurisdiction.** These Terms will be governed by, and construed in accordance with, the laws of the State of New York, without regard to its conflicts of law rules and principles. Any claim, dispute or controversy between you and Global-e will be subject to the exclusive jurisdiction and venue of the courts located in New York City, and you hereby irrevocably submit to the personal jurisdiction of such courts and waive any jurisdictional, venue, or inconvenient forum objections to such courts. Notwithstanding the foregoing, Global-e may seek injunctive relief or specific performance in any court worldwide that has jurisdiction. YOU AGREE THAT ANY CAUSE OF ACTION THAT YOU MAY HAVE UNDER, OR OTHERWISE IN CONNECTION WITH, THIS AGREEMENT MUST COMMENCE WITHIN ONE (1) YEAR AFTER THE CAUSE OF ACTION ACCRUES. OTHERWISE, YOU AGREE THAT SUCH CAUSE OF ACTION SHALL BE DEEMED PERMANENTLY BARRED. 12. **Waiver and Remedies**. No failure or delay on the part of either Party in exercising any right or remedy hereunder will operate as a waiver thereof, nor will any single or partial exercise of any such right or remedy preclude any other or further exercise thereof, or the exercise of any other right or remedy. Any waiver granted hereunder must be in writing, duly signed by the waiving Party, and will be valid only in the specific instance in which given. Except as may be expressly provided otherwise in these Terms, no right or remedy conferred upon or reserved by either Party under these Terms is intended to be, or will be deemed, exclusive of any other right or remedy under these Terms, at law, or in equity, but will be cumulative of such other rights and remedies. 13. **Severability**. If any provision of these Terms is held by a court of competent jurisdiction to be illegal, invalid or unenforceable, then: (a) the remaining provisions of these Terms will remain in full force and effect; and (b) the Parties agree that the court making such determination will have the power to limit the provision, to delete specific words or phrases, or to replace the provision with a provision that is legal, valid and enforceable and that most closely approximates the original legal intent and economic impact of such provision, and these Terms will be enforceable as so modified in respect of such jurisdiction. In the event such court does not exercise the power granted to it as aforesaid, then such provision will be ineffective solely as to such jurisdiction, and will be substituted (in respect of such jurisdiction) with a valid, legal and enforceable provision that most closely approximates the original legal intent and economic impact of such provision. 14. **Changes to these Terms.** You acknowledge and agree that Global-e retains the right to make changes to the terms and conditions of these Terms, at any time. Such changes will become effective as of the date of the change. You should periodically check our website to review the most up-to-date version of these Terms. **YOU ACKNOWLEDGE AND AGREE, HOWEVER, THAT IF YOU ACCESS OR USE ANY PART OF THE GLOBAL-E MATERIALS AFTER THE DATE ON WHICH AN UPDATED VERSION OF THIS AGREEMENT IS POSTED, SUCH ACCESS OR USE WILL CONSTITUTE (AND GLOBAL-E WILL TREAT SUCH ACCESS OR USE AS) YOUR ACCEPTANCE OF THE CHANGES AND THE UPDATED AGREEMENT.** If any change is unacceptable to you, your sole remedy is to terminate these Terms in accordance with Section ‎8 (*Termination*) above. # Testing Payment Methods Source: https://docs.global-e.com/testing-payment-methods-basics After activating your testing environment, use the following payment information to test the payment methods supported by Global-e. This section describes the following: * [Credit Cards](/testing-payment-methods-basics#credit-cards) * [Alternative Payment Methods](/testing-payment-methods-basics#alternative-payment-methods) * [Asia-Pacific and Latin America](/testing-payment-methods-basics#asia-pacific-and-latin-america) ## Credit Cards | Card | Card Number | Expiration date | CVV | | - | - | - | - | | American Express | 370000000000002 | 03/30 | 7373 | | Master Card | 5212345678901234 | 03/30 | 737 | | Visa | 4111111111111111 | 03/30 | 737 | | JCB | 3569990010095841 | 03/30 | 737 | | Discover | 6445644564456445 | 03/30 | 737 | | Diners | 36006666333344 | 03/30 | 737 | ## Alternative Payment Methods | Payment Method | Account Details | Notes | | - | - | - | | AfterPay - Australia | Ask your Global-e integration contact for a test account. | | | AliPay | Ask your Global-e integration contact for a test account. | | | Amazon Pay | Ask your Global-e integration contact for a test account. | | | ApplePay | Follow these instructions to install ApplePay: [Apple Pay Sandbox Testing](https://developer.apple.com/apple-pay/sandbox-testing/) | This is only relevant for Apple devices in the Safari browser. | | Dotpay | Open Dotpay and simulate a payment. | | | iDEAL | **On the iDeal payment page:** Click **Select your bank** to navigate to a list of issuers. Select the **TESTNL2A** issuer. Select the test simulation you want to run according to the available test use cases (success, cancellation, expiration, etc.) | iDEAL is available only in the Netherlands. | | Klarna | Visit [Klarna](https://docs.klarna.com/resources/test-environment/sample-customer-data/) and select a country Use the account details in the "Approved" column | | | PayPal | Ask your Global-e integration contact for a test account. | Global-e supports PayPal Express for the USA and the EU. Make sure to configure it separately (from the regular PayPal). | | Sofort (only available on STG) | **Bank name**: DemoBank **Account Number**: Any **Country**: DE **PIN**: Any **TAN**: Follow the instructions | Sofort does not have a specialized test environment. You are redirected to the Sofort live environment even when making a payment from the Adyen test environment. | | Trustly | **Bank**: Choose any bank from the list **Personal number**: Enter any 10-digit number **One-time code**: Enter the 6-digit code given in the form **Account**: Choose any account from the list | | | UnionPay | **Card Number**: 8171 9999 2766 0000 **Expiration Date**: 10/30 **CVV**: 737 | | The following list shows sources where you can find more information about the payment details in the table above: * [Adyen Alternative Payment Methods](https://docs.adyen.com/developers/development-resources/test-cards/test-card-numbers) * [Ayden 3D5](https://docs.adyen.com/development-resources/testing/test-card-numbers#test-3d-secure-2-authentication) * [S2P details](https://docs.smart2pay.com/?s=test) * [Worldpay](https://developer.worldpay.com/docs/wpg/reference/testvalues#test-card-numbers) ## Asia-Pacific and Latin America | Country | Payment Method | Is Active in Adyen (Live) | Credentials | Notes | Payment Service Provider | | - | - | - | - | - | - | | Brazil | Boleto | No | No special credentials | | [Cash payments](https://docs.dlocal.com/api-documentation/payins-api-reference/payments/cash-ticket-payments)[Brazil](https://docs.dlocal.com/api-documentation/payins-api-reference/payment-methods/brazil) | | Brazil | BooletoFast | No | | | | | Brazil | PIX | No | No special credentials | | [Brazil PIX payments](https://docs.dlocal.com/api-documentation/payins-api-reference/payments/pix-payments) | | Chile | WebPay | No | No special credentials | | [Chile](https://docs.dlocal.com/api-documentation/payins-api-reference/payment-methods/chile) | | Chile | Khipu | No | No special credentials | | | | Chile | Servipag | No | No special credentials | | | | Denmark | Mobile Pay | Yes | **Phone Numbers:** +4538352308 +4522100649 | | [MobilePay for API only \| Adyen Docs](https://docs.adyen.com/payment-methods/mobilepay/api-only/#test-and-go-live) | | Japan | Konbini | No | **firstName**: Simon **lastName**: Hopper **shopperEmail**: [s.hopper@email.com](mailto:s.hopper@email.com)**telephoneNumber**: 1234567890 | | [Japanese convenience stores \| Adyen Docs](https://docs.adyen.com/payment-methods/econtext-konbini/) | | Korea (South) | KakaoPay | No | No special credentials. | In QR screen: Click on **Click here** Click the yellow **Payment Expansion** button | [KakaoPay Drop-in integration \| Adyen Docs](https://docs.adyen.com/payment-methods/kakaopay/android-drop-in) | | Korea (South) | KCP | Yes | | Test is not fully supported | | | Korea (South) | KCP | No | **Card Type:** Hyundai Card **Card Number:** 9490-2200-1166-9217**CVV:** 824**Credit Limit**: (KRW) 100,000 | | | | Malaysia | GrabPay MY | Yes | **Phone Number:** +972525269107 | | [GrabPay \| Adyen Docs](https://docs.adyen.com/payment-methods/grabpay) | | Malaysia | MOLPay | Yes | No special credentials | | [MOLPay online banking \| Adyen Docs](https://docs.adyen.com/payment-methods/molpay) | | Mexico | CODI | No | | Wait for approval before deployment to PROD | | | Mexico | SPEI | No | No special credentials | | | | Mexico | OXXO | No | No special credentials. | Refund Details:**Name of the bank account holder**: Same as in the order **CURP:** SOJH580818MVZLMY06**Name of the bank**: BANCO DE MÉXICO **KEY**: ANY **Security Code**: Provided in the refund email from DLocal | [Mexico](https://docs.dlocal.com/api-documentation/payins-api-reference/payment-methods/mexico) | | Portugal | MB Way | Yes | **Email**: Any **Phone Number**: +351213822199 | | [MB WAY for API only \| Adyen Docs](https://docs.adyen.com/payment-methods/mb-way/api-only) | | Singapore | GrabPay SG | Yes | **Phone Number:** +972525269107 | | [GrabPay \| Adyen Docs](https://docs.adyen.com/payment-methods/grabpay) | | Switzerland | Twint | Yes | No special credentials | | [TWINT \| Adyen Docs](https://docs.adyen.com/payment-methods/twint) | # Testing Payment Methods Source: https://docs.global-e.com/testing-payment-methods-ecommerce After activating your testing environment, use the following payment information to test the payment methods supported by Global-e. This section describes the following: * [Credit Cards](/testing-payment-methods-basics#credit-cards) * [Alternative Payment Methods](/testing-payment-methods-basics#alternative-payment-methods) * [Asia-Pacific and Latin America](/testing-payment-methods-basics#asia-pacific-and-latin-america) ## Credit Cards | Card | Card Number | Expiration date | CVV | | - | - | - | - | | American Express | 370000000000002 | 03/30 | 7373 | | Master Card | 5212345678901234 | 03/30 | 737 | | Visa | 4111111111111111 | 03/30 | 737 | | JCB | 3569990010095841 | 03/30 | 737 | | Discover | 6445644564456445 | 03/30 | 737 | | Diners | 36006666333344 | 03/30 | 737 | ## Alternative Payment Methods | Payment Method | Account Details | Notes | | - | - | - | | AfterPay - Australia | Ask your Global-e integration contact for a test account. | | | AliPay | Ask your Global-e integration contact for a test account. | | | Amazon Pay | Ask your Global-e integration contact for a test account. | | | ApplePay | Follow these instructions to install ApplePay: [Apple Pay Sandbox Testing](https://developer.apple.com/apple-pay/sandbox-testing/) | This is only relevant for Apple devices in the Safari browser. | | Dotpay | Open Dotpay and simulate a payment. | | | iDEAL | **On the iDeal payment page:** Click **Select your bank** to navigate to a list of issuers. Select the **TESTNL2A** issuer. Select the test simulation you want to run according to the available test use cases (success, cancellation, expiration, etc.) | iDEAL is available only in the Netherlands. | | Klarna | Visit [Klarna](https://docs.klarna.com/resources/test-environment/sample-customer-data/) and select a country Use the account details in the "Approved" column | | | PayPal | Ask your Global-e integration contact for a test account. | Global-e supports PayPal Express for the USA and the EU. Make sure to configure it separately (from the regular PayPal). | | Sofort (only available on STG) | **Bank name**: DemoBank **Account Number**: Any **Country**: DE **PIN**: Any **TAN**: Follow the instructions | Sofort does not have a specialized test environment. You are redirected to the Sofort live environment even when making a payment from the Adyen test environment. | | Trustly | **Bank**: Choose any bank from the list **Personal number**: Enter any 10-digit number **One-time code**: Enter the 6-digit code given in the form **Account**: Choose any account from the list | | | UnionPay | **Card Number**: 8171 9999 2766 0000 **Expiration Date**: 10/30 **CVV**: 737 | | The following list shows sources where you can find more information about the payment details in the table above: * [Adyen Alternative Payment Methods](https://docs.adyen.com/developers/development-resources/test-cards/test-card-numbers) * [Ayden 3D5](https://docs.adyen.com/development-resources/testing/test-card-numbers#test-3d-secure-2-authentication) * [S2P details](https://docs.smart2pay.com/?s=test) * [Worldpay](https://developer.worldpay.com/docs/wpg/reference/testvalues#test-card-numbers) ## Asia-Pacific and Latin America | Country | Payment Method | Is Active in Adyen (Live) | Credentials | Notes | Payment Service Provider | | - | - | - | - | - | - | | Brazil | Boleto | No | No special credentials | | [Cash payments](https://docs.dlocal.com/api-documentation/payins-api-reference/payments/cash-ticket-payments)[Brazil](https://docs.dlocal.com/api-documentation/payins-api-reference/payment-methods/brazil) | | Brazil | BooletoFast | No | | | | | Brazil | PIX | No | No special credentials | | [Brazil PIX payments](https://docs.dlocal.com/api-documentation/payins-api-reference/payments/pix-payments) | | Chile | WebPay | No | No special credentials | | [Chile](https://docs.dlocal.com/api-documentation/payins-api-reference/payment-methods/chile) | | Chile | Khipu | No | No special credentials | | | | Chile | Servipag | No | No special credentials | | | | Denmark | Mobile Pay | Yes | **Phone Numbers:** +4538352308 +4522100649 | | [MobilePay for API only \| Adyen Docs](https://docs.adyen.com/payment-methods/mobilepay/api-only/#test-and-go-live) | | Japan | Konbini | No | **firstName**: Simon **lastName**: Hopper **shopperEmail**: [s.hopper@email.com](mailto:s.hopper@email.com)**telephoneNumber**: 1234567890 | | [Japanese convenience stores \| Adyen Docs](https://docs.adyen.com/payment-methods/econtext-konbini/) | | Korea (South) | KakaoPay | No | No special credentials. | In QR screen: Click on **Click here** Click the yellow **Payment Expansion** button | [KakaoPay Drop-in integration \| Adyen Docs](https://docs.adyen.com/payment-methods/kakaopay/android-drop-in) | | Korea (South) | KCP | Yes | | Test is not fully supported | | | Korea (South) | KCP | No | **Card Type:** Hyundai Card **Card Number:** 9490-2200-1166-9217**CVV:** 824**Credit Limit**: (KRW) 100,000 | | | | Malaysia | GrabPay MY | Yes | **Phone Number:** +972525269107 | | [GrabPay \| Adyen Docs](https://docs.adyen.com/payment-methods/grabpay) | | Malaysia | MOLPay | Yes | No special credentials | | [MOLPay online banking \| Adyen Docs](https://docs.adyen.com/payment-methods/molpay) | | Mexico | CODI | No | | Wait for approval before deployment to PROD | | | Mexico | SPEI | No | No special credentials | | | | Mexico | OXXO | No | No special credentials. | Refund Details:**Name of the bank account holder**: Same as in the order **CURP:** SOJH580818MVZLMY06**Name of the bank**: BANCO DE MÉXICO **KEY**: ANY **Security Code**: Provided in the refund email from DLocal | [Mexico](https://docs.dlocal.com/api-documentation/payins-api-reference/payment-methods/mexico) | | Portugal | MB Way | Yes | **Email**: Any **Phone Number**: +351213822199 | | [MB WAY for API only \| Adyen Docs](https://docs.adyen.com/payment-methods/mb-way/api-only) | | Singapore | GrabPay SG | Yes | **Phone Number:** +972525269107 | | [GrabPay \| Adyen Docs](https://docs.adyen.com/payment-methods/grabpay) | | Switzerland | Twint | Yes | No special credentials | | [TWINT \| Adyen Docs](https://docs.adyen.com/payment-methods/twint) | # The Fraud Prevention Process Source: https://docs.global-e.com/the-fraud-prevention-process ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-a70f4f27-c9bc-a97a-2a96-46387c9e296f.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=33537158607e012c0c91ead61462d490) The fraud engine assesses all incoming orders and provides one of the following recommendations: * **Accept** - The order is safe to process and is approved automatically. (Approved orders can still be reviewed manually by an analyst if needed.) * **Deny** - The order has fraudulent indications and is manually reviewed by the fraud team for an Approve / Cancel final decision. The Fraud Analysts continuously monitor and review the performance of the fraud engine to maintain an optimal flow while minimizing denials. # The Shopper Journey Source: https://docs.global-e.com/the-shopper-journey During the shopping journey, customers engage and interact with your brand, store, and products in their preferred language and currency. Global-e features provide multiple customer touchpoints that highlight your offerings, enabling shoppers to browse, buy, and pay through a convenient, intuitive, and frictionless experience. When international customers visit your website, Global-e automatically detects their country. The Global-e Welcome pop-up Welcome pop-up greets shoppers in their local language and can present promotions and other incentives. ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2238234a-239b-eb8c-8944-4ff07d8b8ab9.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=b6bdfd9b487a8dc82849fcf74b77a457) An optional [Marketing Banner](/marketing-banner), displayed at the top of your website, presents promotional messages in the shopper’s language. Marketing Banners encourage visitors to begin shopping—for example, by promoting low shipping costs. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-624a7636-12b5-de53-37eb-5bbce7072aad.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=9735c3d4eebfe317faf9a9b2f6f6c118) A Country Switcher located at the top of your website, allows shoppers to easily set or change their shipping destination. Through the Country Switcher pop-up, customers can update both their destination and currency, choosing from over 200 countries with default or alternative currency options. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-6bda8359-de61-7494-5a8b-04e6b646ed55.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=9f2f36dafec4fb0d1a988304cf63254e) Shoppers benefit from the convenience of browsing and purchasing in their [local currencies](/supported-currencies). They can add products to their carts using up-to-date conversion rates, with pricing calculated according to country-specific coefficients, rounding rules, and appropriate currency symbols. Customers complete their purchases using the configurable Global-e checkout. They can select their [preferred language](/languages#supported-languages) and adjust accessibility settings as needed. During checkout, customers can review their [order summaries](/billing-and-order-summary) and choose from [popular payment methods](/payment-methods) per country, and view applicable duties and taxes calculated based on their location. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-40099632-1430-5e0d-dab7-b519cc1d872c.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=6f5e2d7869ff3ba13954c3455d667bfd) During checkout, customers enter their shipping and billing details, with optional autocorrection depending on configuration. If an address is entered incorrectly, an alternative suggestion is provided. Shoppers can select from country-specific shipping options, ranging from standard to express delivery, and can view and prepay duties and taxes where applicable. If supported, customers can enhance their orders by adding gifts, using loyalty cards or vouchers, or taking advantage of flash sales and coupons. Once payment has been verified and approved, the order is confirmed. Customers receive an email notification with their order status and can track their shipment through the [Tracking Portal](/tracking-portal). Shoppers can also use the [Returns Portal](/returns-portal) to return or replace all or part of an order. Alternatively, merchants can manage returns or replacements on behalf of customers. # Third-Party Integration Source: https://docs.global-e.com/third-party-integration ## JPresta Page Cache Ultimate and Global‑e Plugin Configuration Here is how to configure PrestaShop to work with both the JPresta and Global-e modules. 1. Navigate to **IMPROVE** > **International** > **Localization.** 2. In the configuration area, disable **Set default country from browser language** and **Geolocation by IP address.** ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a4c84950-a228-2466-ca53-8842da9a593e.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=c065099a2cb695b12e93050b51bf0f93) Disable Set default country from browser language. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5e6dc6b9-6e89-c2e5-6078-b37d386f8c83.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=fd2d0e85e3c0f5495d7c9516b4e3f17c) Disable Geolocation by IP address. 3. Move the position of the hook actionDispatcherBefore for the Global‑e plugin to be before JPresta. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-79e3389e-c92a-1ef8-3ca6-8e9f0e9087f9.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=d9cfbb329439d3f25626b36ab61f403d) 4. Modify the Bespoke Global-e Module code: Add the `countryCode`and `currencyCode` or `glCountry` and `glCurrency` query params when the country is changed in the shipping switcher. 5. Empty the PrestaShop and the JPresta caches. 6. Set \$EXPIRES_MIN = 0; in modules/pagecache/static.config.php. In purpose to disable browser cache for product and categories pages. # Tools and Applications Source: https://docs.global-e.com/tools-and-applications Explore the tools, applications, and utilities offered by Global-e to enhance your experience. * [Global-e Merchant Portal](/global-e-merchant-portal) * [Integration tools](/integration-tools) * [Returns Portal](/returns-portal) * [Tracking Portal](/tracking-portal#overview) * [Global-e Documentation MCP](/connect-docs-to-your-ai-tool) # Tracking Portal Source: https://docs.global-e.com/tracking-portal ## Overview The Tracking Portal allows customers to track their shipments by entering the **Global-e Order ID** or the **Merchant Order ID** and the **email address** used to place the order. The merchant can request that Global-e sets the Tracking Portal to show a branded merchant logo to your customers The order and shipping confirmation emails you received from Global-e include the Order ID. The Global‑e Order ID or the Merchant Order ID. The email address you used to place the order. The Tracking Portal supports English only. ## Tracking an Order **To track an order:** 1. Access the Tracking Portal: From the [Tech Support Help Center](https://service.global-e.com/), click **Where is My Order**? ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c9ccb6e2-d34d-5594-ce04-0e629ed23c55.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=2c21113870d9fab8e45ed11d5a598089) Alternatively, you can access the Tracking Portal directly: [https://service.global-e.com/track-my-order](https://service.global-e.com/track-my-order) The Tracking Portal opens showing the Track Orders view. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-7e78ef7c-2644-6fa5-5daa-ee3d4681f408.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=601dca809012e2a42b1c5fb46d33366e) 2. Enter your *Global‑e Order ID* or Merchant Order ID. 3. Enter the *email* address used to place the order. 4. Click **Track Order**. The order opens, showing the order details and status, and the Order ID as you entered it. ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-910e9b3e-c598-a91c-4949-1bd9a204174b.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=09ad6063dc67f00117c0e34fe3b9071a) > [!NOTE] > > Note for the Merchant: You can request that Global‑e changes which product details the Tracking Portal shows. > > Default: `%Product Image% %Product Name% %Product Description%` > > Supported parameters: > > * `{ProductName}` > * `{ProductDescription}` > * `{DutyCategoryName}` > * `{ProductCode}` > * `{ProductMetaData}` > * `{ProductGroupCode}` > * `{FirstProductCategory}` > * `{LastProductCategory}` 5. Optional: If required. click **Track Another Order**. You are redirected to the Track Orders view. The Order ID and email address are cleared. > [!NOTE] > > * **Marketplace Order** - If the order has an associated marketplace order ID, then the order identifier can accept the marketplace order ID. > * **Mixed Order** - Once searching for a sub-order, all the Mixed Order associated parcels will be displayed with an appropriate tracking status. Searchable by Merchant Order ID / Global-e Order ID. ### Error Messages An error message is displayed in the following cases. | Error | Description | | - | - | | Sorry, we couldn’t find that order id in our database | There is no order that matches the provided order ID and email. Make sure to enter the correct order ID and email address. | | There are multiple orders with these details | We found several orders for this merchant (or marketplace) order ID and email combination. | | Enter a valid mail address | Make sure to enter the email address used to place the order. | ## Tracking Status This section illustrates some tracking statuses. You can view the list of all statuses on the Merchant Portal (General tab). ### Cancelled Order View The cancelled order view opens when either Global-e, the merchant, or the customer cancels an order. The order shows one of the following statuses: * Cancelled by Global-E * Cancelled by Merchant * Cancelled by customer ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-81912d9a-7970-1e3a-3334-02c56890dbe1.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=e3a47912c3e7cd00264a1289f100cc05) ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5c3e52ae-d386-6065-b5d5-d433093283f2.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=db432ca47ccdc735bc6b9db4432ec01a) The Products that have yet to be shipped section is displayed only when: * There is at least one product for any parcel (ParcelProducts table); **AND** * There are products in the original order (OrderProducts table), that are not part of any parcel (ParcelProducts table) ### Single and Multiple Parcel Shipments ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-27f33ffd-da54-6910-232d-8da44bf14e18.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=b088b560c13465404a0bce11f9a30097) In the following example, there are two parcels but one tracking number. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-19d36a7e-17cb-ef38-a4ec-a29af3cb60e3.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=34c6018505bdbbe6bdb2196df0f0e3c1) Note that there are multiple tracking numbers. In the following example, the first package is in status processing, the second has been dispatched. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-5d7c4f9f-9195-3e9a-b1fb-5e90c7a103e5.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=c64c2dec01ac8428402ce4e7412f103d) ## Tracking Events Actions **Additional Information for the merchant** A tracking domain is responsible for checking and processing tracking events by a given tracking number. The event is sourced by APIs provided by the shipper as well as by Webhooks that are pushed to the service from the shipper. An action such as an early refund, cash on delivery, changing the order status, or sending an order-related email to the customer can be triggered by the tracking event. # Transactional Emails Source: https://docs.global-e.com/transactional-emails > [!NOTE] > > **This section does not apply to Shopify. For information about Shopify, see [Shopify Native](/shopify-native).** The Global‑e transactional emails inform customers about the status of their orders. As Global‑e handles shipping in most cases and since we know the various statuses during the orders’ journey, we also handle notification emails to customers. These emails are configured per merchant according to the logic described in this guide. **In this section:** * [Email Management](/email-management-transactional-emails) * [Email Types](/email-types) * [Configurations](/configurations) * [Multilingual Support](/multilingual-support) # UK Merchants with Non-Global-e Carriers Source: https://docs.global-e.com/uk-merchants-with-non-global-e-carriers ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-55bfee0e-f2e7-891e-4c2d-be5014748695.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=2dfe92edc544a4920eb16b98a6f7f1f8) When an international customer visits your site, Global-e converts the price of your product to the customer's currency. At checkout, the customer is presented with the financial details of the transaction: * The price of the product minus discounts * Shipping fees * Duties and taxes After verifying the validity of the transaction, Global‑e collects the payment and the order is packed and shipped. * If you are shipping the products directly from your hub then the final title transfer takes place in the origin country, making this a domestic B2B sale * If you are shipping from a Global-e hub, the final title transfer occurs when the goods arrive at the domestic Global-e hub. Global-e then converts the amount of the sale back to your currency and refunds you the amount of the sale, deducting relevant fees and subsidies. If you are using your own carriers then the shipping fee, plus duties and taxes (if paid for by the carrier), are included in the refund. ## Duties and Taxes Process Merchants can choose between two methods of collecting duties and taxes from customers: * **Optional/Forced DDP** : Customers pre-pay duties and taxes at checkout, which are passed by Global-e to the Merchant, and in most cases passed on to their shipper. However in some countries, like the US, Global-e will retain and remit these to the authorities directly. * **Hidden Forced DDP**: Duties and taxes are built into the amount paid by the end customer. For most countries, Global-e will pass the full value of the product to the Merchant, including the duties and taxes intended for the shipper. In some countries like Australia, Global-e will retain and remit these taxes directly to the authorities. Below are two examples of the financial process that takes place when a non-UK customer makes a purchase from a British Merchant. **British Merchant – Non-UK Customer** Example: Optional/Forced DDP for Duties & Taxes * Product price in UK = £120 (£100 + 20% VAT) - exported out of the UK * Shipping cost charged to customer £5 ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-2ae5e32e-41d2-3c8c-8ba9-9aece9c1559c.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=2a616a409540d33547f10131db3ddccf) Net product sale for Merchant: £100 Net after shipping subsidy: £105 **British Merchant – Non-UK Customer** Example: Hidden Forced DDP for Duties & Taxes * Product price in UK = £120 (£100 + 20% VAT) - exported out of the UK * Shipping cost charged to customer £5 ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-212b85c1-dc8b-9498-222a-485c5af8a96e.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=4a5e9b5ebe6b72b4a1565fcca54d3443) Net product sale for Merchant: £120 Net after shipping subsidy: £115 ## Billing Period And Payment Terms The reconciliation process typically takes place on a weekly basis and results in a comprehensive report of all Merchant sales for the week. Based on the report, Global-e pays the Merchant the sum of all products sold internationally during that week plus any relevant shipping, duties, and taxes, minus the agreed service fee. Global-e's standard payment terms: * 80% of the net proceeds are paid weekly, up to two business days after the weekly reporting day. * 20% of the net proceeds are paid seven days after the end of each calendar month. ## Invoicing When the Reconciliation Report is generated, Global-e also provides Merchants with two invoices: * A self-billing invoice for sales less refunds. * An invoice for Global-e’s services, fees, and any shipping subsidies. To view the invoice navigate to the Global-e Merchant Portal > Merchants > Reports > Reconciliation Reports. **Invoice for Service and Fees** ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ebdccc7f-24e2-14a9-0df6-c32f96546133.jpg?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=046761eadb8d44348fcc32b7c0eaf3af) **Credit Note for Net Sales** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8c58ba10-8b42-ece3-8ec8-78718083f6a8.jpg?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=0c7eb2bc93920a8c4d749a95a9acbe0d) ## Global-e Purchase Examples The following two purchase examples offer a detailed look at the price conversion process. There are two types of conversions: * **Dynamic pricing** - Global-e converts the customer currency on the website for the Merchant. * **Fixed pricing** - The Merchant gives Global-e the customer's price in the customer's currency and that information is fed into the website. **British Merchant – Non-UK Customer** Example of dynamic pricing ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-750ac966-a1c7-69d2-0116-ca0ec90e76f0.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=319851628dd367d4f47b6dace216ddaa) **British Merchant – Non-UK Customer** Example of fixed pricing ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-f6464204-ea83-f5a0-79c8-a58f4954ba6a.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=04cb42942f6d5a0fd5b6803e43320231) ## Reconciliation Report Example Below is a sample Reconciliation Report with a breakdown of the services and fees for that week. For a list of all the report fields and their definitions, see [Reconciliation Report](/reconciliation-report-overview). For a video describing the Reconciliation Report, see [Weekly Reconciliation Report](/video-overviews-financial-flow-uk#weekly-reconciliation-report). | | Amount Excl. VAT | VAT | Amount Incl. VAT | | | - | - | - | - | - | | Sales Total | £23528.85 | £4705.77 | £28234.62 | [Sales Example](/uk-merchants-with-non-global-e-carriers#sales-total) | | Refunds Total | (£2106.68) | (£423.79) | (£2530.47) | [Refunds Example](/uk-merchants-with-non-global-e-carriers#refunds-total) | | **Amount to Invoice** | **£21422.17** | **£4281.98** | **£25704.15** | | | Service Fee | £1964.01 | £392.80 | £2356.81 | 8.00% of Total Order Value | | Service Fee Adjustment | £0.00 | £0.00 | £0.00 | | | Shipping Subsidies (EU) | (£276.23) | £0.00 | (£276.23) | [Shipping Example](/uk-merchants-with-non-global-e-carriers#shipping-subsidies) | | Shipping Subsidies (Non-EU) | (£373.52) | £0.00 | (£373.52) | | | Taxes Subsidization | (£371.48) | £0.00 | (£371.48) | | | Handling Fee | £0.00 | £0.00 | £0.00 | | | Returns | £14.97 | £2.99 | £17.96 | [Returns Example](/uk-merchants-with-non-global-e-carriers#returns) | | **Services and Fees** | **£927.81** | **£389.81** | **£1317.62** | | ### Sales Total **Order Level** ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8055631c-6784-9694-1a46-6b4b5deb1277.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=e58d8b152c0d96f013517d7b2eee241d) *Sales Total on the Order Level* **Product Level** ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-45681d01-bd95-88f8-8a91-a4015eb83f8a.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=1be61bd8b24d7f88a06be1b3d18e8169) *Sales total on the Product Level* ### Refunds Total ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8e3f4862-8bdd-de90-b8c3-889781e2033e.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=5b25f3000ba3d6255d9acd2807bf922e) *Lists all the refunds that were issued through Global‑e during the relevant period* ### Shipping Subsidies Shipping prices are based on the actual weight that we received from the shipper or measured at our hub. ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4d2681d9-bced-ae9f-66d1-9de10cf606f7.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=acc2911aab96eacdd5a41be998d8ad6d) *shipping costs are reconciled based on the date of the shipment* ### Returns ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-dbd30617-2b13-e2e3-3364-73e6835dc0f1.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=2915affa7d985a178cb7a69643851f1a) *Includes the details of each returned parcel* ## Video Overviews: Financial Flow & Weekly Reconciliation Report ### Financial Flow An overview of the financial flow and reconciliation process [Embedded media](https://www.youtube.com/embed/QF4B0R3_2PE) ### Weekly Reconciliation Report A walk-through of the weekly reconciliation report [Embedded media](https://www.youtube.com/embed/ZCClXC6xBEc) # Internally Create RMA Source: https://docs.global-e.com/unlimited-mode You can start creating a return directly from the Global-e admin. Clicking **Create Return** automatically redirects you to the Create RMA page, where you choose how the return will be processed. **Unlimited** **mode** lets you create RMAs unrestricted by policy rules. While this gives you full control, it can also be risky and must be handled responsibly. **Caution**: Global-e recommends employees to receive proper training and clear instructions before creating RMAs through the Dashboard in this mode. Creating RMAs in Unlimited mode is useful for issuing refunds outside of your normal return policy rules, or when you need to create multiple RMAs on behalf of your customers. Common use cases include: * Issuing a return after the standard return window * Issuing a specific type of refund for normally ineligible items * Processing a return in-store * Handling an exception case by customer support * Returning items from an order that doesn't have customer information This can be especially useful for customer support teams, return managers, and in-store staff. ## To create an RMA in Unlimited mode 1. Navigate to **Manage Returns**. 2. Click **CREATE RMA**. 3. Search for an order using an order number. 4. At the top of the page, review all the order details and customer information. 5. Select an item you want to add to the RMA by clicking on the plus (+) symbol: ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-98a1276d-360d-ac03-d0a7-a72899ee13d2.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=6ae23bc3e018312cd9940e988a3b9109) 6. In the **ORIGINAL ITEM** region, select the return reason: ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ee609fdc-6e22-9432-0633-e1c0bd7c0d5b.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=0feddf47ac256e22fa006e0c67509adb) 7. In the item panel that is displayed, answer follow-up questions in the **Request Details** region: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1fd6c265-a53c-7f4a-35fd-dbe14fd40ac4.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=8e67c579369b321c5109a118d4161dd6) 8. In the **Policy Rule** region, select the return method and resolution: ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/uuid-013bd900-b320-790b-681d-f538bba4173e.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=621e936747f56eac1fa66e9d512c97d4) 9. In the **Balance** region, add any relevant fees, and add any adjustments to manually give a reduced refund or add a bonus to the refund: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8efb84da-22a9-5db7-61ed-fe80a2a060a3.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=1838765d271ee60ebc9fbfad13246080) > [!NOTE] > > Adjustments defined within a resolution will update this field when selected. 10. Click **ADD** to add the item to the RMA.The Return Details section shows all the items added to the RMA. You can edit or remove them by clicking on the pencil and trash icons. 11. Under the Automations section, set your automations for this RMA. > [!NOTE] > > Global-e recommends setting default automations to remember setting one that that is commonly used, such as **auto-refund**. Review the RMA summary showing the total refund amount, including any fees and adjustments. > > 1. Optional: Add an internal note that will appear on the RMA. > 2. Choose whether to send automated customer emails: > 3. Enabling **Send Customer Emails** sends emails as normal according to your email settings. > 4. If you want to refund the customer on the spot, Global-e does not recommend sending the customer all the return emails — in which case you can disable the email. You can also always send specific emails later through the RMA page if you want to send a notification during a manual process. > 5. Submit the RMA as **Pending** or as **Approved**. > 6. The RMA is created and you will be redirected to the relevant RMA, which includes an internal note identifying that it was manually created from the Dashboard. The **Timeline** section also shows which user created the RMA, and store location (if done from a physical store user). > [!NOTE] > > When an RMA is created manually in Unlimited mode using a unique combination of resolution, return method, and return reason, its policy rule will appear as Custom Policy Rule. # Internally Create RMA Source: https://docs.global-e.com/unlimited-mode-702674 You can start creating a return directly from the Global-e admin. Clicking **Create Return** automatically redirects you to the Create RMA page, where you choose how the return will be processed. **Unlimited** **mode** lets you create RMAs unrestricted by policy rules. While this gives you full control, it can also be risky and must be handled responsibly. **Caution**: Global-e recommends employees to receive proper training and clear instructions before creating RMAs through the Dashboard in this mode. Creating RMAs in Unlimited mode is useful for issuing refunds outside of your normal return policy rules, or when you need to create multiple RMAs on behalf of your customers. Common use cases include: * Issuing a return after the standard return window * Issuing a specific type of refund for normally ineligible items * Processing a return in-store * Handling an exception case by customer support * Returning items from an order that doesn't have customer information This can be especially useful for customer support teams, return managers, and in-store staff. ## To create an RMA in Unlimited mode 1. Navigate to **Manage Returns**. 2. Click **CREATE RMA**. 3. Search for an order using an order number. 4. At the top of the page, review all the order details and customer information. 5. Select an item you want to add to the RMA by clicking on the plus (+) symbol: ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-98a1276d-360d-ac03-d0a7-a72899ee13d2.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=6ae23bc3e018312cd9940e988a3b9109) 6. In the **ORIGINAL ITEM** region, select the return reason: ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-ee609fdc-6e22-9432-0633-e1c0bd7c0d5b.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=0feddf47ac256e22fa006e0c67509adb) 7. In the item panel that is displayed, answer follow-up questions in the **Request Details** region: ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1fd6c265-a53c-7f4a-35fd-dbe14fd40ac4.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=8e67c579369b321c5109a118d4161dd6) 8. In the **Policy Rule** region, select the return method and resolution: ![](https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/images/uuid-013bd900-b320-790b-681d-f538bba4173e.png?fit=max\&auto=format\&n=tw35F3WiyJ8sxtxX\&q=85\&s=621e936747f56eac1fa66e9d512c97d4) 9. In the **Balance** region, add any relevant fees, and add any adjustments to manually give a reduced refund or add a bonus to the refund: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8efb84da-22a9-5db7-61ed-fe80a2a060a3.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=1838765d271ee60ebc9fbfad13246080) > [!NOTE] > > Adjustments defined within a resolution will update this field when selected. 10. Click **ADD** to add the item to the RMA.The Return Details section shows all the items added to the RMA. You can edit or remove them by clicking on the pencil and trash icons. 11. Under the Automations section, set your automations for this RMA. > [!NOTE] > > Global-e recommends setting default automations to remember setting one that that is commonly used, such as **auto-refund**. Review the RMA summary showing the total refund amount, including any fees and adjustments. > > 1. Optional: Add an internal note that will appear on the RMA. > 2. Choose whether to send automated customer emails: > 3. Enabling **Send Customer Emails** sends emails as normal according to your email settings. > 4. If you want to refund the customer on the spot, Global-e does not recommend sending the customer all the return emails — in which case you can disable the email. You can also always send specific emails later through the RMA page if you want to send a notification during a manual process. > 5. Submit the RMA as **Pending** or as **Approved**. > 6. The RMA is created and you will be redirected to the relevant RMA, which includes an internal note identifying that it was manually created from the Dashboard. The **Timeline** section also shows which user created the RMA, and store location (if done from a physical store user). > [!NOTE] > > When an RMA is created manually in Unlimited mode using a unique combination of resolution, return method, and return reason, its policy rule will appear as Custom Policy Rule. # Updating Exchange Options Source: https://docs.global-e.com/updating-exchange-options Updating exchange options includes the following setting types: * Manual Exchange * Variant Exchange ## Overview You can update your exchange experience by editing exchange resolutions in the **Admin Dashboard** and then applying them in your return policy rules. This lets you offer customers one or both of the following: * **Manual Exchange** (reviewed and handled by your customer service team) * **Variant Exchange** (in-portal size/color exchange for the same product) You can also control variant exchange pricing rules and stock behavior. ## Objectives By the end of this guide, you will be able to: * Add **Manual Exchange** resolution * Update **Variant Exchange** resolution. * Configure variant exchange pricing and stock behaviors. * Update exchange-related settings in **General** (price source, returning exchanged items, and location-based inventory rules). * Apply exchange resolutions in **Return Policy** rules and verify they appear in your return portal. ## Prerequisites Verify that you have access to the Admin Dashboard with permission to edit **Settings**. ## Adding a Manual Exchange Resolution Manual exchange enables customers to submit an exchange request that your team handles manually (including creating the new exchange order manually). ### To add a manual exchange resolution 1. Navigate to *Settings > Resolutions*. ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-11e5c9ac-2ce4-c924-936f-ca5afc4ba983.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=83ac170741b4c98fb9fbf0f8eab49c3d) 2. In **Exchange Resolutions**, click **ADD RESOLUTION**. ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3c7cdd83-6933-b2c4-c0ba-1d5ca202b85c.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=c35586aef7234e16536cd9e3ece74fe5) 3. In **Details**, update the following fields: * **Internal Name** (not shown to customers) * **Display Name** (shown in the return portal) * **Display Description** (shown in the returns portal) ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-14175d1b-54f6-a4b8-d3cb-bf5dc46c42f3.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=ae5d68c41d4338a516d987af448b0f81) 4. In **Image**, select whether the customer can attach an image: * None (customers cannot add images) * Optional (customers can add images) * Mandatory (an RMA cannot be created without an image) ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-3c2d430b-c8e0-05de-e48d-a79a9c8c913d.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=9ad5e6c8cfcf637fe2cd7453bb8935e2) 5. Click the **save icon** in the top right corner. 6. In the Returns portal, confirm that the manual exchange option is displayed (when eligible) via policy rules. ## Updating Your Variant Exchange Resolution Variant exchange enables customers to exchange an item for a different variant of the same product (for example, size or color). ### Opening the Variant Exchange Resolution for Editing #### To open the variant exchange resolution for editing 1. Navigate to *Settings > Resolutions*. 2. In **Exchange Resolutions**, open an existing variant exchange resolution (or create a new one if available in your dashboard). ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-493c474e-e44a-6ad6-1f00-2aa13b8ec5a4.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=effdd71e934df6e83b0c4d3a98434928) 3. In **Details**, update: * **Internal Name** (internal only) * **Display Name** (shown in the return portal) * **Display Description** (shown in the returns portal) ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-cdad20e7-4c6d-546c-70e0-8b2473552445.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=a50ba4f5463f23a40cfcf869b9378adb) ### Configuring Pricing Configuring pricing is calculated as the sum of the **free range** and **price difference behavior**. #### To configure pricing 1. In **Pricing**, set the **Free exchange variant price range**. 2. Click the **save icon** in the top right corner of the page. ### Configuring Stock Behavior Configuring stock behavior is calculated as the sum of **out-of-stock**, **threshold**, and **size chart**. #### To configure stock behavior 1. Navigate to *Settings > Resolutions*: 2. In **Stock**: 1. In the **Allow out-of-stock exchange** menu, select **Allow all out-of-stock exchanges**. 2. Set **Minimum available stock threshold**. ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-b4edc0d5-9028-2495-270d-06118580f2b1.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=33e323ac9559c654ab2e847df32f8159) 3. (Optional) Add size chart support: 1. Add the size chart URL. 2. Add the size variant option name (so the size chart shows only for that option type). ![](https://mintcdn.com/globale-enterprise/QCkZopg74p33aKvu/images/uuid-dbd5b716-fb85-9ac4-e55e-458bdf75346b.png?fit=max\&auto=format\&n=QCkZopg74p33aKvu\&q=85\&s=31e30b15077c25743964d65127e2ddc6) 4. Click the **save icon** in the top right corner of the page. ### Setting the Reference Price for Exchange Price Differences #### To set the reference price for exchange price differences 1. Navigate to *Settings > General*. 2. Open the **Exchanges** section. 3. Under **Product Exchange**, set **Original Item’s Price Source**: * Paid Price * Catalog Price at Time of RMA * Catalog Price at Time of Purchase 4. Click the **save icon** in the top right corner of the page. ### Allowing Previously Exchanged Items to be Returned 1. Navigate to *Settings > General*. 2. Open **Exchanges**. 3. Enable **Allow Exchanged Items to be Returned**. 4. In the top right corner, click the **save icon**. ### Fulfilling Exchanges Based on Order Country 1. Navigate to *Settings > General*. 2. Open **Exchanges**. 3. Enable **Fulfill Exchanges Based on Order Country**. 4. In the top right corner, click the **save icon**. ## Updating General Exchange Settings Updating exchange settings in General refers to the price source + exchanged-item returns + location logic. ### Allowing Previously Exchanged Items to be Returned 1. Navigate to *Settings > General*. 2. Open **Exchanges**. 3. Enable **Allow Exchanged Items to be Returned**. 4. In the top right corner, click the **save icon** in the top right corner of the page. ### Fulfilling Exchanges Based on Order Country 1. Navigate to *Settings > General*. 2. Open **Exchanges**. 3. Enable **Fulfill Exchanges Based on Order Country**. 4. Click the **save icon** in the top right corner of the page. ## Applying Exchange Resolutions in Your Return Policy Rules Resolutions appear to customers only when they’re eligible via your return policy rules. ### To apply exchange resolutions in return policy rules 1. Navigate to *Settings > Return Policy*. 2. Update a rule: * Click **ADD RULE** to create a new rule, or * Click **EXPAND ALL** to edit existing rules. ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-82c4ef49-5ccf-bcfd-151a-dbd6367d32d8.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=e46ef9e8d45dfbb324986fdbc3c23af3) 3. In the rule’s **Details** section, select the relevant **Resolution** (for example, **Manual Exchange** or **Variant Exchange**). ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-99a32254-8fac-4741-98ca-2e5ca1964781.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=91dcaece2d187fd8fc3e00ae85620b81) 4. At the top of the page, enable **Activate Policy Rule**. 5. Click the **save icon** at the top right corner of the page. ## Verifying Exchange Processing on the RMA ### To verify exchange processing on the RMA 1. Navigate to *Manage Returns*. 2. Open a relevant RMA. 3. Confirm you can review the exchange request details and proceed with your internal fulfillment workflow. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-65508a59-4f1a-a6b4-ef28-eba09161084d.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=63cc764a8616f0a19ff1d158f25f1b64) # Updating Refund Resolutions Source: https://docs.global-e.com/updating-refund-resolutions ## Overview **Refund resolutions** control which refund options customers see in the Return Portal and how refunds are recorded from the RMA page. The following video describes updating refund resolutions: [Embedded media](https://player.vimeo.com/video/1164299961) ## Objectives By the end of this guide, you will be able to: * Update refund resolutions in *Settings > Resolutions*. * Update bank refund fields customers complete in the Return Portal. * Verify refunds and recordkeeping from the RMA page. * Link resolutions to your return policy rules. ## Prerequisites You have access to the **Admin Dashboard** with permission to edit **Settings**. ## Updating Refunds to Payment Method Updating the Refund to Payment method refers to refunds made to the original payment method. Use this resolution to refund customers back to the payment method used for the order (for example, credit card or PayPal). ### To update Refund to Payment Method 1. Navigate to *Settings > Resolutions*. 2. In **Return Resolutions**, click **REFUND TO PAYMENT METHOD**. 3. In the **Details** section, update: * Internal name * Display name * Description 4. Click the **save** icon in the top right corner. ## Updating Refunds to a Bank Account Updating the Refund to Bank Account feature is relevant to COD (Cash on Delivery) or off-platform payments. Use this resolution when you issue refunds outside of your platform (for example, COD refunds via bank transfer). ### To update Refund to Bank Account 1. Navigate to *Settings > Resolutions*. 2. In **Return Resolutions**, click **REFUND TO BANK** (or create a new resolution). 3. Update the resolution details: * Edit the internal name (customers do not see this name). * Edit the display name (shown to customers in the Return Portal). * Edit the description (shown to customers in the Return Portal). 4. Set **Refund Type** to **Bank Refund**. 5. Click the save icon in the top right corner. ## Verifying Bank Refund Works Verifying bank refund works can be done in the following ways: * In the Return Portal, confirm the refund option appears for the relevant orders, based on your policy rules. * In the Admin Dashboard, open an RMA and confirm you can view the customer’s bank details under **Refund to Bank Account** on the RMA page. * Transfer funds using the customer-provided details, then record the refund action from the RMA. ## Updating Bank Refund Fields Shown in the Return Portal Updating bank refund fields shown in the Return Portal refers to customizing which fields customers must complete when they request a bank refund. ### To update bank refund fields shown in the return portal 1. Navigate to **Settings > Genera**l. 2. Open the **Refunds** section. 3. Configure which fields appear in the Return Portal and whether each field is mandatory or optional. 4. Click the **save** icon in the top right corner. > [!NOTE] > > Your setup can include IBAN collection. Field labels can vary by store configuration. Confirm the exact field names in your dashboard. ## Verifying and Documenting Refunds from the RMA page Use the RMA page to record the refunded amount and complete the refund workflow in the admin dashboard. ### To document a bank refund in the RMA 1. Open the relevant RMA. 2. On the RMA page, review the customer’s bank details under **Refund to Bank Account**. 3. Click **REFUND/CREDIT** to open the refund calculator. 4. Click **APPLY** to apply the suggested refund amount. 5. Select the bank refund method (label can vary by configuration). 6. Click **SUBMIT** to record the refund action. 7. Verify that the RMA status shows **Done** in the RMA header after you submit the refund action. > [!NOTE] > > A refund action can be unavailable if there is no refund amount available. In that case, the refund button can appear disabled. ## Linking Resolutions to Your Return Policy After you update a resolution, ensure it is offered under the right conditions in your policy rules. ### To link resolutions to your return policy 1. Navigate to **Settings > Return Policy**. 2. Update your policy rules to offer the relevant resolutions (for example, bank refund for COD orders). # Updating Refund Resolutions Source: https://docs.global-e.com/updating-refund-resolutions-498046 ## Overview **Refund resolutions** control which refund options customers see in the Return Portal and how refunds are recorded from the RMA page. ## Objectives By the end of this guide, you will be able to: * Update refund resolutions in *Settings > Resolutions*. * Update bank refund fields customers complete in the Return Portal. * Verify refunds and recordkeeping from the RMA page. * Link resolutions to your return policy rules. ## Prerequisites Access to the Administrator dashboard with permission to edit Settings. ## Updating Refunds to a Payment Method Updating the **Refund to Payment** method refers to refunds made to the original payment method. Use this resolution to refund customers back to the payment method used for the order (for example, credit card or PayPal). 1. Navigate to *Settings > Resolutions*. 2. In **Return Resolutions**, click **REFUND TO PAYMENT METHOD**. 3. In the **Details** section, update the following: * Internal name * Display name * Description 4. Click the save icon. ## Updating Refunds to a Bank Account Updating the **Refund to Bank Account** feature is relevant to **Cash on Delivery (COD)** or off-platform payments. Use this resolution when you issue refunds outside of your platform (for example, COD refunds via bank transfer). 1. Navigate to *Settings > Resolutions*. 2. In **Return Resolutions**, click **REFUND TO BANK** (or create a new resolution). 3. Update the resolution details: * Edit the internal name (customers do not see this name). * Edit the display name (shown to customers in the Return Portal). * Edit the description (shown to customers in the Return Portal). 4. Do one of the following: * If you create a custom resolution, set **Refund Type** to **Bank Refund**. * If you do not create a custom resolution, continue to Step 5 below. 5. Click the save icon. ## Verifying Bank Refund Works ### To verify bank refund works 1. In the Return Portal, confirm the refund option appears for the relevant orders, based on your policy rules. 2. In the Administrator dashboard, open an RMA and confirm you can view the customer’s bank details under Refund to Bank Account on the RMA page. 3. Transfer funds using the customer-provided details, then record the refund action from the RMA. ## Updating Bank Refund Fields Shown in the Return Portal Updating **bank refund fields** shown in the Return Portal refers to customizing which fields customers must complete when they request a bank refund. 1. Navigate to *Settings > General*. 2. Open the **Refunds** section. 3. Configure which fields appear in the Return Portal and whether each field is **mandatory** or **optional**. 4. Click the save icon. > [!NOTE] > > Your setup can include IBAN collection. Field labels can vary by store configuration. Confirm the exact field names in your dashboard. ## Verifying and Documenting Refunds From the RMA page you can record the refunded amount and complete the refund workflow in the Administrator dashboard. ### To document a bank refund in the RMA 1. Navigate to *Returns & Exchanges*. 2. Open the relevant RMA. 3. Review the customer’s bank details under Refund to Bank Account. 4. Click REFUND/CREDIT to open the refund calculator. 5. Click APPLY to apply the suggested refund amount. 6. Select the bank refund method (label can vary by configuration). 7. Click SUBMIT to record the refund action. **Verification:** The RMA status shows Done in the RMA card header after you submit the refund action. > [!NOTE] > > A refund action can be unavailable if there is no refund amount available. In that case, the refund button can appear disabled. ## Linking Resolutions to Your Return Policy After updating a resolution, verify that it is offered under the right conditions in your policy rules. ### To link resolutions to your return policy 1. Navigate to *Settings > Return Policy*. 2. Update your policy rules to offer the relevant resolutions. An example of the above is a bank refund for COD orders: ![](https://mintcdn.com/globale-enterprise/ujVCb8fXnGRMy0Lz/images/uuid-8e2496ae-685a-f302-6172-7d79bfda5935.png?fit=max\&auto=format\&n=ujVCb8fXnGRMy0Lz\&q=85\&s=ea69b2b8ce215d7a09efa866ce259e9d) # Updating Return Fees in Your Return Policy Source: https://docs.global-e.com/updating-return-fees-in-your-return-policy ## Overview You can charge return-related fees as part of your return policy to recover operational costs and set clear customer expectations. In the admin dashboard, you update fees at the policy rule level (per return scenario). The following video describes updating return fees in your return policy: [Embedded media](https://player.vimeo.com/video/1164299206) ## Objectives By the end of this guide, you will be able to: * Update return-related fees in a policy rule. * Verify that fees appear correctly for customers in the Return Portal and on the RMA in the admin dashboard. ## Prerequisites * Access to the **Admin Dashboard** with permission to edit **Settings** (admin-level access is typically required). * An existing return policy with at least one policy rule. ## Getting Started: Understanding Supported Fee Types and Limitations This section provides basic information about supported fee types and limitations. You should review which fee types you can apply: * **Restocking Fee:** free, or charged as: * Fixed amount * Percentage of the item’s catalog price * Percentage of the item’s paid price * **Return Shipping Label Fee:** Free, or charged as: * Fixed amount * Label not provided * **Return Fee:** Free, or charged as: * Fixed amount * Percentage of items’ paid price ## Updating Return Fees in a Specific Policy Rule Use this when you want different fees by scenario (for example, “changed my mind” vs “damaged item”). ### To update return fees in a specific policy rule 1. Navigate to *Settings > Return Policy*. 2. Open the policy rule you want to update by clicking **EXPAND ALL** and selecting the rule). 3. Open the **Additional Payments** section. 4. In the **Fees** dropdown, select the option that matches your intent: * Do not charge additional fees for this policy rule * Charge additional fees for this policy rule * Waive all fees in the RMA (see the **Waive all fees** section below) 5. If you selected **Charge additional fees for this policy rule**, update the fee settings you want: * **Restocking Fee:** Select **Free**, or under **Charge Fee** select: * Fixed Amount * Percentage of the item’s catalog price * Percentage of the item’s paid price * **Return Fee:** Select Free, or under **Charge Fee** select: * Fixed Amount * Percentage of items’ paid price * **Return Shipping Label Fee:** Select: * Free * Fixed amount * Label not provided 6. Click the **save** icon in the top right corner. ## Waiving All Fees for an RMA Waiving all fees for an RMA is done using a policy rule. Use this when you want a specific scenario to override all fee charges. ### To waive all fees for an RMA 1. Navigate to *Settings > Return Policy*. 2. Select the policy rule you want to edit. 3. Open the **Additional Payments** section. 4. In the **Fees** dropdown, select **Waive All Fees**. 5. Under **Display**, select how the Return Portal displays that all fees are waived. 6. Click the **save** icon in the top right corner. ## Verifying the Configuration Works This section describes how to verify that your configurations work. ### Verifying in the New Return Portal Verifying in the New Return Portal refers to verifying that the configuration works in Customer view. #### To verify that the configuration works in the New Return Portal 1. Submit a test return that qualifies for the policy rule you updated. 2. Review the fee breakdown shown to the customer during resolution selection and/or the summary steps. ### Verifying on the RMA in the Admin Dashboard Verifying on the RMA in the Admin Dashboard refers to verifying that the configuration works in Global-e’s platform. #### To verify on the RMA in the Admin Dashboard 1. Navigate to **Manage Returns**. 2. Open the relevant RMA. 3. Review the **Order Summary** for applied fees. # Updating Return Fees in Your Return Policy Source: https://docs.global-e.com/updating-return-fees-in-your-return-policy-520374 ## Overview You can charge return-related fees as part of your return policy to recover operational costs and set clear customer expectations. In the admin dashboard, you update fees at the policy rule level (per return scenario). ## Objectives By the end of this guide, you will be able to: * Update return-related fees in a policy rule. * Verify that fees appear correctly for customers in the Return Portal and on the RMA in the admin dashboard. ## Prerequisites * Access to the **Admin Dashboard** with permission to edit **Settings** (admin-level access is typically required). * An existing return policy with at least one policy rule. ## Getting Started: Understanding Supported Fee Types and Limitations This section provides basic information about supported fee types and limitations. You should review which fee types you can apply: * **Restocking Fee:** free, or charged as: * Fixed amount * Percentage of the item’s catalog price * Percentage of the item’s paid price * **Return Shipping Label Fee:** Free, or charged as: * Fixed amount * Label not provided * **Return Fee:** Free, or charged as: * Fixed amount * Percentage of items’ paid price ## Updating Return Fees in a Specific Policy Rule Use this when you want different fees by scenario (for example, “changed my mind” vs “damaged item”). ### To update return fees in a specific policy rule 1. Navigate to *Settings > Return Policy*. 2. Open the policy rule you want to update by clicking **EXPAND ALL** and selecting the rule). 3. Open the **Additional Payments** section. 4. In the **Fees** dropdown, select the option that matches your intent: * Do not charge additional fees for this policy rule * Charge additional fees for this policy rule * Waive all fees in the RMA (see the **Waive all fees** section below) 5. If you selected **Charge additional fees for this policy rule**, update the fee settings you want: * **Restocking Fee:** Select **Free**, or under **Charge Fee** select: * Fixed Amount * Percentage of the item’s catalog price * Percentage of the item’s paid price * **Return Fee:** Select Free, or under **Charge Fee** select: * Fixed Amount * Percentage of items’ paid price * **Return Shipping Label Fee:** Select: * Free * Fixed amount * Label not provided 6. Click the **save** icon in the top right corner. ## Waiving All Fees for an RMA Waiving all fees for an RMA is done using a policy rule. Use this when you want a specific scenario to override all fee charges. ### To waive all fees for an RMA 1. Navigate to *Settings > Return Policy*. 2. Select the policy rule you want to edit. 3. Open the **Additional Payments** section. 4. In the **Fees** dropdown, select **Waive All Fees**. 5. Under **Display**, select how the Return Portal displays that all fees are waived. 6. Click the **save** icon in the top right corner. ## Verifying the Configuration Works This section describes how to verify that your configurations work. ### Verifying in the New Return Portal Verifying in the New Return Portal refers to verifying that the configuration works in Customer view. #### To verify that the configuration works in the New Return Portal 1. Submit a test return that qualifies for the policy rule you updated. 2. Review the fee breakdown shown to the customer during resolution selection and/or the summary steps. ### Verifying on the RMA in the Admin Dashboard Verifying on the RMA in the Admin Dashboard refers to verifying that the configuration works in Global-e’s platform. #### To verify on the RMA in the Admin Dashboard 1. Navigate to **Manage Returns**. 2. Open the relevant RMA. 3. Review the **Order Summary** for applied fees. # Uploading the Report Source: https://docs.global-e.com/uploading-the-report The report can be uploaded in the following ways: * On the Global-e sFTP * On the Merchant’s sFTP > [!NOTE] > > In order to pull the report from a Merchant's sFTP server, the Merchant needs to provide Global-e with write permissions to the folder where the manifests are located. This folder should also contain an archive sub-folder. # US Merchants with Non-Global-e Carriers Source: https://docs.global-e.com/us-merchants-with-non-global-e-carriers ![](https://mintcdn.com/globale-enterprise/F-UCPkf6gNa18nJ9/images/uuid-39644233-7d1c-841f-de54-c0ff278ff07a.png?fit=max\&auto=format\&n=F-UCPkf6gNa18nJ9\&q=85\&s=c5c9fad7b2826516a39be20bd4d0c88a) When an international customer visits your site, Global‑e converts the price of your product to the customer's currency. At checkout, the customer is presented with the financial details of the transaction: * The price of the product minus discounts * Shipping * Duties and taxes After verifying the validity of the transaction, Global‑e collects the payment and the order is packed and shipped. * If you are shipping the products directly from your hub then the final title transfer takes place in the origin country, making this a domestic B2B sale. * If you are shipping from a Global-e hub, the final title transfer occurs when the goods arrive at the domestic Global-e hub. Global‑e then converts the amount of the sale back to your currency and refunds you the amount of the sale, deducting relevant fees and subsidies. If you are using your own carriers then the shipping fee, plus duties and taxes (if paid for by the carrier), are included in the refund. ## Duties and Taxes Process Merchants can choose between two methods of collecting duties and taxes from customers: * **Optional/Forced DDP**: Customers pre-pay duties and taxes at checkout, which are passed by Global-e to the Merchant, and in most cases passed on to their shipper. However in some countries, like the US, Global-e will retain and remit these to the authorities directly. * **Hidden Forced DDP**: Duties and taxes are built into the amount paid by the end customer. For most countries, Global-e will pass the full value of the product to the Merchant, including the duties and taxes intended for the shipper. In some countries like Australia, Global-e will retain and remit these taxes directly to the authorities. Below are two examples of the financial process that takes place when a customer outside the US purchases from a US Merchant. **Example: Optional/Forced DDP for Duties and Taxes** US Merchant – Israeli Customer * Product price in USD = \$100 - exported to Israel * Shipping cost charged to customer \$5 ![](https://mintcdn.com/globale-enterprise/D5z97UtD_lzn1sEI/images/uuid-30a0d0b4-6f11-bf5f-328a-f8606054c998.png?fit=max\&auto=format\&n=D5z97UtD_lzn1sEI\&q=85\&s=c2078d30ee7fe3d22afc63cadb228ed5) Net product sale for Merchant: \$100 Net after shipping subsidy: \$122 **Example: Hidden Forced DDP for Duties and Taxes** US Merchant – EU Customer * Product price in USD = \$100 + 30% Country Coefficient – exported to EU * Shipping cost charged to customer \$10 (incl. 10% GST) * This process is also used for Switzerland, the UK, New Zealand, and Norway ![](https://mintcdn.com/globale-enterprise/x4RSAJ5CW3pPE0Za/images/uuid-a0341a16-b71a-bd37-51f7-2d8f5003417e.png?fit=max\&auto=format\&n=x4RSAJ5CW3pPE0Za\&q=85\&s=585e506dd9760c63573459e173ac21bb) Net product sale for Merchant: \$130 Net after shipping subsidy: \$140 ## Billing Period and Payment Term The reconciliation process typically takes place on a weekly basis and results in a comprehensive report of all Merchant sales for the week. Based on the report, Global-e pays the Merchant the sum of all products sold internationally during that week plus any relevant shipping, duties, and taxes, minus the agreed service fee. Global-e's standard payment terms: * Merchant invoice or a Global-e credit note for sales minus refunds. * Payment within two days from the date of reconciliation. ## Invoicing When the Reconciliation Report is generated, Global-e also provides Merchants with two invoices: * A self-billing invoice for sales-less refunds. * An invoice for Global-e’s services, fees, and any shipping subsidies. To view the invoice navigate to the Global-e Merchant Portal > Merchants > Reports > Reconciliation Reports. **Global-e’s Invoice for Services and Fee** ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-1426ae06-cdec-163d-f2bd-5cf1c9182b19.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=896fded9e0a4253440fc17f51ddf0380) **Credit note for Net Sale** ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-59044c2b-3ce3-d196-872b-a58115791047.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=1888900d7eaa3e4ecef39f4cb4650f05) ## Global-e Purchase Example The following purchase example offers a detailed look at the price conversion process. US Merchant- Spanish Customer ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-abf65b5a-7109-e0fd-ba81-e40c93ed5c1b.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=4c92b26a1db35dd9f902bc8384502a51) ## Reconciliation Report Example - US Merchants with Non-Global-e Carriers Below is a sample Reconciliation Report with a breakdown of the services and fees for that week. For a list of all the report fields and their definitions, see [Reconciliation Report](/reconciliation-report-overview). For a video describing the Reconciliation Report, see [Video Overviews: Financial Flow & Weekly Reconciliation Report](/video-overviews-financial-flow-us). | | Amount Exc. VAT | | | - | - | - | | Sales Total | \$54993.70 | [Sales Example](/us-merchants-with-non-global-e-carriers#sales-total) | | Refunds Total | (\$12581.17) | [Refunds Example](/us-merchants-with-non-global-e-carriers#refunds-total) | | **Amount to Invoice** | **\$42412.53** | | | Service Fee | \$4731.35 | 7.0% of Total Order Value | | Payment Processing Fee | \$0.00 | | | Service Fee Adjustment | \$0.00 | | | Shipping Subsidies | \$2776.66 | [Shipping Example](/us-merchants-with-non-global-e-carriers#shipping-subsidies) | | Taxes Subsidization | \$152.07 | | | Handling Fee | \$0.00 | | | Returns | (\$6.26) | [Returns Example](/us-merchants-with-non-global-e-carriers#returns) | | **Services and Fees** | **\$7653.82** | | ### Sales Total **Order Level** ![](https://mintcdn.com/globale-enterprise/I20EF52DcVIt-MUY/images/uuid-17297204-72cc-056b-0040-c5cd251bbbf0.png?fit=max\&auto=format\&n=I20EF52DcVIt-MUY\&q=85\&s=3028ed8e3e69f412eed1a73397a0533f) *Sales Total on the Order Level* **Product Level** ![](https://mintcdn.com/globale-enterprise/EzD3P9RZMY_VMXGZ/images/uuid-be4d2367-4d4c-3604-2aaf-d50bfaad19c0.png?fit=max\&auto=format\&n=EzD3P9RZMY_VMXGZ\&q=85\&s=6f7607c811a1741fd66561ba9f101afd) *Sales total on the Product Level* ### Refunds Total ![](https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/images/uuid-fc889469-1152-7767-a357-c0ba9a069dc6.png?fit=max\&auto=format\&n=xvASI8IP64Cj0kr_\&q=85\&s=c1273b0769998e79de3cca7fb429a008) *Lists all the refunds that were issued through Global‑e during the relevant period* ### Shipping Subsidies ![](https://mintcdn.com/globale-enterprise/SnRXO1uzDQe-KGkt/images/uuid-4d2681d9-bced-ae9f-66d1-9de10cf606f7.png?fit=max\&auto=format\&n=SnRXO1uzDQe-KGkt\&q=85\&s=acc2911aab96eacdd5a41be998d8ad6d) *Shipping prices are based on the actual weight that we received from the shipper or measured at our hub* ### Returns ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c391157a-e00c-6e60-bf73-112514526245.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=fe47e994675d9127439ca922a746d326) *Includes the details of each returned parcel* ## Video Overviews: Financial Flow & Weekly Reconciliation Report ### Financial Flow An overview of the financial flow and reconciliation process [Embedded media](https://www.youtube.com/embed/cmbs9rxufAI) ### Weekly Reconciliation Report A walk-through of the weekly reconciliation report [Embedded media](https://www.youtube.com/embed/nO3D8P29wFQ?si=hrSul5TZZLsQoLZL) # Usage of Global-E SDK Source: https://docs.global-e.com/usage-of-global-e-sdk All API requests in GlobalEMobileSDK are async. To correctly display data from the result of an API call, use the progress bar, activity indicator, etc. ## iOS Initialization and Setup **Import GlobalEMobileSDK** ``` GlobalESDK.setup(token: "YnMTYTk04do=", domain: "https://stgepi4.bglobale.com/externalapi/", cartTokenURL: "https://www2.bglobale.com/checkoutv2/fullredirect/") ``` Examples: ● `getCountriesLis`t method: ``` GlobalESDK.instance.getCountriesList { (result: Result, GlobalEError>) in switch result { case .success(let countries): print(countries) case .failure(let error): print(error.errorDescription) print(error.errorCode) } } ``` ● `getCurrenciesList` method: ``` GlobalESDK.instance.getCurrenciesList { (result: Result, GlobalEError>) in switch result { case.success(let result): print(result) case.failure(let error): print(error.errorDescription) } } ``` ● Price calculation method: `DefaultCountry` object with selected country info. Get this object from **updateCurrentCountryInfo** or **getCurrentCountryInfo** methods. ``` GlobalESDK.instance.convertPrice(countryCode: "IL", currencyCode: "ILS", merchantInfo: DefaultCountry, basePrice: 100.0, quantity: 1, isGrossPrices: false, localVatRate: nil, productCountryVatRate: nil, applyMarketingRounding: true) { (result: Result) in switch result { case .success(let value): print(value) case .failure(let error): print(error.errorDescription) print(error.errorCode) } } } ``` * Implement a calculation method: ``` class API { static func fetchData( @escaping cb: (String) -> (String)) { cb("price") } } class PriceCell: UITableViewCell { @IBOutlet var priveLabel: UILabel! func setData(price: String) { self.priveLabel.text = price } } class TableScreen: UITableView { var dataSource: [String]! func dataSourceInit() { dataSource = [String]() } func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell { let cell = tableView.dequeueReusableCell(withIdentifier: "PriceCell", for: indexPath) as! PriceCell let price = dataSource[indexPath.row] if (price == nil) { // call API API.fetchData { (result) -> (String) in dataSource[indexPath.row] = result cell.setData(price: dataSource[indexPath.row]) } } else { cell.setData(price: price) } return cell } } ``` ## Android Initialization and Setup **Initialize SDK in your Application class** ``` GlobalESDK.init(Application, token, domain, cartTokenUrl) ``` Example: ``` class App : Application() { override fun onCreate() { super.onCreate() GlobalESDK.init(this, "YnMTYTk04do=", "https://stgepi4.bglobale.com/externalapi/", "https://www2.bglobale.com/checkoutv2/fullredirect/") } } ``` Examples of different methods: `getCountriesList` method (Coroutines): ``` val payload = GlobalESDK.getInstance().getCountriesList() payload.data?.let { //it - get countries } payload.error?.let { it.forEach { error -> Log.d("TAG", "${error.errorCode}") Log.d("TAG", error.errorDescription) } } ``` `getCurrenciesList` method: ``` val payload = GlobalESDK.getInstance().getCurrenciesList() payload.data?.let { //it - get currencies list } payload.error?.let { it.forEach { error -> Log.d("TAG", "${error.errorCode}") Log.d("TAG", error.errorDescription) } } ``` `DefaultCountry` object with selected country info. Get this object from **updateCurrentCountryInfo** or **getCurrentCountryInfo** methods. `getCurrentCountryInfo` method: ``` val payload = GlobalESDK.getInstance().getCurrentCountryInfo() payload.data?.let { //it - get default country } payload.error?.let { it.forEach { error -> Log.d("TAG", "${error.errorCode}") Log.d("TAG", error.errorDescription) } } ``` `calculatePrice` method (Coroutines): ``` val payload = GlobalESDK.getInstance().convertPrice( countryCode = “IL”, currencyCode = “ILS”, merchantInfo: DefaultCountry, applyMarketingRounding = true, quantity = 1, basePrice = 100.0, productLocalVatRate = null, productCountryVatRate = null, isGrossPrices = true ) payload.data?.let { //it - get calculation price } payload.error?.let { it.forEach { error -> Log.d("TAG", "${error.errorCode}") Log.d("TAG", error.errorDescription) } } ``` To implement the calculation method in the list: ``` val totalPrice = 0.0 listProduct.forEach { product -> val payload = GlobalESDK.getInstance().convertPrice( countryCode = countryCode, currencyCode = currencyCode, merchantInfo: DefaultCountry, applyMarketingRounding = true, quantity = 1, basePrice = product.price, productLocalVatRate = 10.0, productCountryVatRate = 12.0, isGrossPrices = true ) payload.data?.let { price -> totalPrice += price.toDouble() } payload.error?.let { errors -> errors.forEach { error -> Log.d("TAG", "${error.errorCode}") Log.d("TAG", error.errorDescription) } } } ``` An example of how to correctly calculate the total price: ``` val totalPrice = 0 val calculatedPrice1 = convertPrice(basePrice1) val calculatedPrice2 = convertPrice(basePrice2) val calculatedPrice3 = convertPrice(basePrice3) totalPrice = calculatedPrice1 + calculatedPrice2 + calculatedPrice3 ``` The incorrect way to calculate the price: ``` val baseTolalPrice = basePrice1 + basePrice2 + basePrice3 totalPrice = convertPrice(baseTolalPrice) ``` Additional information for RX users: [https://github.com/Kotlin/kotlinx.coroutines/tree/master/reactive/kotlinx-coroutines-rx2](https://github.com/Kotlin/kotlinx.coroutines/tree/master/reactive/kotlinx-coroutines-rx2) # Use Cases Source: https://docs.global-e.com/use-cases ## Use Case 1: Shopify-Driven Allocation (Pre-Checkout) All warehouses are configured in Shopify with accurate inventory levels, enabling allocation decisions to be made during checkout. * Allocation decisions are made during checkout * Orders are split into multiple hub locations within Shopify * Reflected as mixed orders in Global-e ## Use Case 2: Global-e Allocation (Post-Order Creation) Shopify has limited visibility into warehouse inventory, so allocation decisions are made after the order is created. * Allocation decisions occur after order creation * Shopify does not split the order * Global-e splits the order during fulfillment ## Use Case 3: Hybrid Allocation * Initial allocation is made at checkout * Allocation may be adjusted later during fulfillment # User Roles Overview Source: https://docs.global-e.com/user-roles-overview Each role has specific permissions and access levels within the dashboard. Understanding these roles will help you effectively manage your returns and ensure that users have appropriate access based on their responsibilities. The following table shows the user roles overview: | Role | Add/Manage Users | Analytics Access | Settings Access | Manager Approval | | - | - | - | - | - | | Owner | Yes | Yes | Yes | Yes | | Admin | Yes | Yes | Yes | Yes | | Online Staff | No | Limited | No | No | | Online Store Manager | No | Limited | No | Yes | ## Owner The **Owner** role has the highest level of access and control over the application. Every store has an Owner user by default. Owner users have the following permissions: * Full access to all pages and functionalities within the app. * Ability to add and manage users, including assigning user roles. * Manager approval. ## Admin The **Admin** role is designed for users who require extensive access to manage returns, but with some restrictions. Admin users have the following permissions: * Access to all pages and functionalities, except the *Analytics > Orders* page. * Ability to add and manage users, including assigning user roles. * Manager approval. ## Online Staff The **Online Staff** role is intended for users who handle day-to-day return operations for online returns without requiring access to sensitive financial information. Online Staff users have the following permissions: * Access to all screens and functionalities, except the *Analytics > Orders* page. * No access to the Settings menu or any of its pages. * No access to the Store Account, and Billing History pages. * No manager approval. ## Online Store Manager The **Online Store Manager** role is for users who oversee online return operations. They have all the permissions of Online Store Staff plus the ability to approve RMAs requiring manager approval. # User Roles Overview Source: https://docs.global-e.com/user-roles-overview-703407 Each role has specific permissions and access levels within the dashboard. Understanding these roles will help you effectively manage your returns and ensure that users have appropriate access based on their responsibilities. The following table shows the user roles overview: | Role | Add/Manage Users | Analytics Access | Settings Access | Manager Approval | | - | - | - | - | - | | Owner | Yes | Yes | Yes | Yes | | Admin | Yes | Yes | Yes | Yes | | Online Staff | No | Limited | No | No | | Online Store Manager | No | Limited | No | Yes | ## Owner The **Owner** role has the highest level of access and control over the application. Every store has an Owner user by default. Owner users have the following permissions: * Full access to all pages and functionalities within the app. * Ability to add and manage users, including assigning user roles. * Manager approval. ## Admin The **Admin** role is designed for users who require extensive access to manage returns, but with some restrictions. Admin users have the following permissions: * Access to all pages and functionalities, except the *Analytics > Orders* page. * Ability to add and manage users, including assigning user roles. * Manager approval. ## Online Staff The **Online Staff** role is intended for users who handle day-to-day return operations for online returns without requiring access to sensitive financial information. Online Staff users have the following permissions: * Access to all screens and functionalities, except the *Analytics > Orders* page. * No access to the Settings menu or any of its pages. * No access to the Store Account, and Billing History pages. * No manager approval. ## Online Store Manager The **Online Store Manager** role is for users who oversee online return operations. They have all the permissions of Online Store Staff plus the ability to approve RMAs requiring manager approval. # Using the Account Registration Button on Order Confirmation Pages Source: https://docs.global-e.com/using-the-account-registration-button-on-order-confirmation-pages ## Overview The *Account Registration Button* allows guest shoppers who complete checkout through Global-e to register for your store account directly from the *Order Confirmation* page. When the shopper clicks the button, Global-e passes customer and order details to your site via a JavaScript callback/postMessage. You then handle the registration flow, event tracking, and redirect on your side. ## Business Value * Increase account registrations from first-time guest shoppers. * Improve retention and repeat purchases. * Maintain a seamless shopper experience—no redirects from Global-e, no checkout regressions. ## What Merchants Need to Do ### To enable and implement the Account Registration Button 1. **Step 1 – Enable the Feature** Request Global-e to enable the *“Registration Button on Confirmation Page”* in your MAS configuration. The button is only displayed for guest shoppers (non-signed-in users). 2. **Step 2 – Handle the Callback Event** Global-e sends a client-side event (`OnCustomerRegistration`) when the shopper clicks the button. You must listen to this event in your website’s parent page and implement a handler. ``` // Define your registration handler const registrationHandler = function (data) { console.log('🎉 Customer Registration Event Received!'); console.log('Registration Data:', data); // Example: access key fields console.log('Customer:', data.firstName, data.lastName); console.log('Email:', data.email); // Process data according to your needs: // 1. Redirect shopper to your registration page // 2. Pre-fill registration form fields // 3. Send event to analytics tools // 4. Store in your CRM / ERP if needed }; // Register the handler in Global-e client SDK GlobalE.OnCustomerRegistration(registrationHandler); ``` 3. **Step 3 – Process the Data** The callback contains customer, billing, and shipping details in JSON format. ``` { "countryCode": "US", "firstName": "John", "lastName": "Smith", "email": "john.smith@example.com", "phoneNumber": "+1-555-123-4567", "billingAddress": { "BillingFirstName": "John", "BillingLastName": "Smith", "BillingAddress1": "123 Main Street", "BillingCity": "New York", "BillingZIP": "10001", "BillingCountryCode": "US" }, "shippingAddress": { "ShippingFirstName": "John", "ShippingLastName": "Smith", "ShippingAddress1": "456 Oak Avenue", "ShippingCity": "Brooklyn", "ShippingZIP": "11201", "ShippingCountryCode": "US" } } ``` Use this data to: * Pre-fill registration forms on your site. * Pass data to your customer account system. * Fire analytics/marketing events. 4. **Step 4 – Manage Redirect and Tracking** Global-e does not perform redirects. You are responsible for: * Redirecting shoppers to your registration page. * Implementing your own event tracking. 5. **Step 5 – Localization and Styling** Button text is localized via Global-e’s translation layer (`TR_REGISTER_FROM_CONFIRMATION`). UI style matches your confirmation page design automatically. No action is needed unless you want to apply custom CSS. ## Shopper Experience 1. Guest completes checkout. 2. On the Confirmation page, the shopper sees: **\[Create an Account]** button. 3. Shopper clicks button → `OnCustomerRegistration` event triggers. 4. Your site handles registration redirect and tracking. ## Merchant Checklist | Task | Who Handles | Notes | | - | - | - | | Enable MAS setting for Registration Button | Global-e | One-time setup | | Implement event listener (`OnCustomerRegistration`) | Merchant | Required | | Process customer and order data | Merchant | Use payload fields | | Redirect to registration | Merchant | Required | ## Example Use Cases * **Pre-fill Registration Form** Shopper clicks the button → your form loads with name, email, and address already filled in. * **Custom Redirect** Shopper is redirected to `/register?source=confirmation` with their email passed as a query parameter. With this setup, you fully control shopper registration flow while leveraging Global-e checkout context. # Validating Items Source: https://docs.global-e.com/validating-items Validating items is only relevant for operations or the warehouse. ## To validate items 1. Navigate to **Returns and Exchanges**. 2. Search or filter for an RMA processed under the policy rule in Step 6 of Configuring Auto-Approvals. 3. In the **Item Validation** region, set a status per item: * Returned * Returned + Restockable * Not Returned 4. Click **Save**. # VAT Calculation Source: https://docs.global-e.com/vat-calculation ## B2B VAT Businesses that sell goods to customers in other countries are obligated to charge and collect local consumption taxes. The EU has enacted distance selling regulations to encourage free trade in the EU. As part of Global-e’s services, and since we are the merchant on record for all your cross-border transactions, we take responsibility for the VAT registration in each EU country. We also calculate the relevant VAT rate on each of your EU transactions and apply the correct VAT for each case. If you sell products that qualify for reduced VAT, we work with you during onboarding to identify the relevant products on your website, so that the correct VAT rate can be applied. **How it works:** * For each Global-e transaction, Global-e, as the merchant on record, purchases the items from the Merchant. * The product is purchased from the Merchant by the associated Global-e entity of the Merchant (i.e. Global-e UK purchases for UK merchants, Global-e US for US merchants, etc.) The purchase is like a domestic transaction between the Merchant and one of its domestic buyers. * For a purchase from a UK Merchant, Global-e also has to pay the UK VAT, similar to any UK buyer purchasing from a UK Merchant. Global-e then claims back the UK VAT from the UK authorities. * Global-e also provides additional services to the UK Merchant, such as shipping, fraud checks, and payment processing. The UK Merchant purchases these services from Global-e and additional domestic VAT is added. The UK Merchant then claims the local VAT back from the UK authorities. The Reconciliation Report describes all the Products and Services provided during a transaction between Global-e and the Merchant. The UK VAT paid to the Merchant is included under Products and the UK VAT paid by the Merchant to Global-e is under Services. ![](https://mintcdn.com/globale-enterprise/12a3ouYsTLkxux6r/images/uuid-78271e26-d36e-cd1f-93a5-4728e7b2d283.png?fit=max\&auto=format\&n=12a3ouYsTLkxux6r\&q=85\&s=5a0b8810ca4333ab44e35bc58f56932f) ## Products subject to a reduced VAT Several EU countries apply reduced VAT rates to specific products. For example, children’s clothing and books are subject to 0% VAT in the Republic of Ireland. Global-e works with you during the onboarding phase to identify these products and collect the required information so that we can accurately calculate their VAT rates. If this process has not been done during onboarding, please contact customer service to identify your products subject to reduced VAT rates and update accordingly. # Verifying and Monitoring Automation Results Source: https://docs.global-e.com/verifying-and-monitoring-automation-results Once you’ve set your configurations as needed, you can use the checks described in this section to verify and monitor your automation results. ## To verify and monitor automation results 1. Navigate to **Returns and Exchanges**. 2. Filter RMAs by status to confirm workflow status, such as: * Pending Requests * Requires Attention * Shipment Received * Done * Canceled Requests 3. Open an RMA. 4. Review the **Timeline** section for automation events, such as approval, refund, or completion. > [!TIP] > > If an RMA is stuck in the Requires Attention stage, verify that the automation trigger conditions were met, especially for validation-based automations. # Version Source: https://docs.global-e.com/version-sfcc | Version Type | Version | | - | - | | Current stable version | 24.6.0 | | SFRA baseline | 7.0.0 | The **current stable version** matches the cartridge release in the Global-e SFCC repository (`package.json`). The **SFRA baseline** is the Storefront Reference Architecture version that `int_globale_sfra` is built and tested against. Use a compatible SFRA release on your storefront. # Video Overviews: Financial Flow & Weekly Reconciliation Report Source: https://docs.global-e.com/video-overviews-financial-flow-au ## Financial Flow An overview of the financial flow and reconciliation process [Embedded media](https://www.youtube.com/embed/MM5OiAxXTe4) ## Weekly Reconciliation Report A walk-through of the weekly reconciliation report [Embedded media](https://www.youtube.com/embed/bLmOavYc_Eo?si=GAwso9l3GSur_FcD) # Video Overviews: Financial Flow & Weekly Reconciliation Report Source: https://docs.global-e.com/video-overviews-financial-flow-uk ## Financial Flow An overview of the financial flow and reconciliation process [Embedded media](https://www.youtube.com/embed/QF4B0R3_2PE) ## Weekly Reconciliation Report A walk-through of the weekly reconciliation report [Embedded media](https://www.youtube.com/embed/ZCClXC6xBEc) # Video Overviews: Financial Flow & Weekly Reconciliation Report Source: https://docs.global-e.com/video-overviews-financial-flow-us ## Financial Flow An overview of the financial flow and reconciliation process [Embedded media](https://www.youtube.com/embed/BnDcOn2BFHs) ## Weekly Reconciliation Report A walk-through of the weekly reconciliation report [Embedded media](https://www.youtube.com/embed/XogBM5u_m2w?si=WJuCZiysLkePxHmo) # View Orders Source: https://docs.global-e.com/view-orders From the View Orders page you can view merchant orders. The following user roles have access to the View Orders feature: * Merchant CS * Merchant CS Admin ## To view orders 1. Navigate to Orders > View Orders from the top menu. 2. Filter your orders: 1. Select and enter one of the following filter parameters: * Order number * Tracking number * Other: * Merchant reference * Transaction reference * Payment attempt GUID * Delivery reference number * PSP reference * Amazon Japan order ID 2. Define all of the required following filters: > [card] > > * Shipping service (all that apply) > * Order status (all that apply) > * Merchant (all that apply) > * Customer name > * Email > * Hub (all that apply) > [card] > > * From date > * To date > * Dispatch type (all that apply) > * Shipping country (all that apply) > * Payment method (all that apply) > * Parcel status (all that apply) 3. Insert an order number, tracking number, or a value based on what you selected for **Other** in Step 2. 4. Do one of the following: * To go directly to the Order Details page, click Find and View. * To view all found order IDs in the Order Details section - click FILTER ORDERS. > [!NOTE] > > If needed, from here you can export the table by clicking Export. You can also show or hide the results by clicking Collapse All/Expand All located below FILTER ORDERS. * Click an order ID from the Order ID column. The Order Details page is displayed for the order ID you selected. The order status is displayed in the Order Status field. # Viewing Invoice Information Source: https://docs.global-e.com/viewing-invoice-information You can use Invoice screen to review invoice information. However, note that this is not your formal invoice and should not be shared with your customers. The formal invoice is available on the Global-e Merchant's Portal, and is sent by Global-e to customers or customs clearance agencies. # Viewing the Global-e Cookie Information in the Browser Source: https://docs.global-e.com/viewing-the-global-e-cookie-information-in-the-browser The Global-e extension includes a cookie that enables the system to recognize the user, the cart, and the relevant store instance. The cookie data is stored in JSON format. The following figure shows an example of the **GlobalE_Gem_Data** cookie in a browser: ![](https://mintcdn.com/globale-enterprise/qaDCAVyR8Lg1SuMy/images/uuid-c6cf619b-8190-1eb9-8080-a76f2f5f3c16.png?fit=max\&auto=format\&n=qaDCAVyR8Lg1SuMy\&q=85\&s=b6f98d76be0eafb494198cb5cb7673f4) The cookie contains the following data: | Data | Description | | - | - | | CartID | WooCommerce Cart ID. | | UserId | The ID of the registered user. If the user is a guest, this field is set to 0. | | PreferredCulture | Store culture code. | | StoreCode | Technical field for store compatibility. | # Virtual Consolidation Source: https://docs.global-e.com/virtual-consolidation **Virtual Consolidation** enables virtual shipment consolidation for FedEx **International Priority Distribution (IPD)**, allowing multiple individual orders to be processed, cleared through customs, and billed as a consolidated shipment, while remaining logically separated at the order level for both the merchant and the shopper. ## What This Means in Practice The function addresses a cost and operational challenge inherent in international shipping for high-volume merchants: * Normally, each individual shipment incurs its own customs clearance and processing fees. * For merchants shipping dozens or hundreds of parcels per day, these per-shipment fees can become significant. * FedEx IPD allows multiple individual orders to be grouped under a master shipment for customs and carrier handling. ## Function Behavior ### Virtual Consolidation * Orders remain separate at the system and shipping label level. * Behind the scenes, orders are grouped under one or more **Master Air Waybills**. * This approach reduces per-package customs clearance and carrier fees. ### Carrier-Specific Automation The platform automatically manages all FedEx IPD–specific consolidation logic: * Assigns individual orders to master shipments. * Generates all required consolidation and customs documents. * Allows merchants to continue their standard order processing flow without modification. ### Enhanced End-of-Day Handling Unlike standard **End-of-Day (EOD)** processing, consolidated shipments require multiple documents: * Regular Manifest * Master Air Waybill * Consolidated Commercial Invoice These documents must be provided to FedEx at pickup. The system surfaces all required document numbers in the admin interface. ### Merchant Abstraction * Merchants process orders as usual. * Shipping labels are generated in the same way as standard orders. * The complexity of shipment consolidation is fully handled by the platform and hidden from the merchant. The resulting value is reduced shipping and customs costs without additional operational overhead. ## Scope and Rationale This functionality exists specifically because FedEx supports the IPD consolidation model, and the feature is FedEx-specific. The function was developed to integrate FedEx IPD consolidation cleanly into Merchant Hub while maintaining a consistent merchant experience. # What are Duties and Taxes? Source: https://docs.global-e.com/what-are-duties-and-taxes- When importing items, you must pay particular charges that are determined by the destination's regulations The charges are divided into duties, taxes, and fees. * **Duties**: Customs duties are a type of tax on cross-border goods that are collected by customs as government revenue and to protect local industries. * **Taxes**: Government fees placed on purchased goods coming into a country (imported). also called Sales tax/GST/VAT. * **Fees**: Additional charges applied by customs authorities. # Wix Source: https://docs.global-e.com/wix The Global-e Wix Application implements the Global-e solution on the Wix platform. This document explains how to install and configure the application. For countries operated by Global-e, the Global-e app adds to your store: * The Global-e JavaScript and CSS (on each page of your site, including on the Checkout page). * A wide variety of international payment methods. # WooCommerce Source: https://docs.global-e.com/woocommerce The Global-e Extension for WooCommerce allows you to start boosting your international sales within days. By implementing our smart cross-border solution and giving shoppers a truly localized experience, Global-e merchants see an immediate and continuous increase in conversion rates and international revenues. This document provides descriptive information to enable the Merchant to gain familiarity with the application; it provides a functional description of the application, as well as installation and configuration details. For countries operated by Global‑e, the Global‑e app adds to your store: * The Global‑e JavaScript and CSS (on each page of your site, including on the Checkout page). * A wide variety of international payment methods (see [Supported Countries](/countries-supported#supported-countries)).