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).
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.
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 for more information.
Global-e cookie: The Global-e GEM 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 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.
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
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
Note
You can deactivate and reactivate the extension after installation if required. See Step 3 below.
Extract the Global‑e WooCommerce extension's zip file onto the server where WordPress is installed.
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.
(Optional) Navigate to WooCommerce > Plugins > Installed Plugins.
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
Log in to WooCommerce administration.
Navigate to Plugins.
Select Add New Plugin.
Click Upload Plugin.
Click Choose File and select WooCommerce zip file.
Click Install Now.
Installing the Plugin from the WordPress Marketplace
Log in to Wordpress admin.
Navigate to Plugins > Add New Plugin and search for Global-e Cross-Border Integration for WooCommerce.
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.
Click Plugins.
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
Plugin Configuration Page
You can use one of the following plug configuration methods:
Configuring Global-e Cross Border Settings via the WooCommerce Settings Menu
Navigate to Woocommerce > Settings.
Click the Integration tab.
In the GlobalE Pro Integration section, configure the fields as needed:
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
Navigate to Plugins > Installed Plugins.
In the Global-e Cross-Border for WooCommerce section, click Settings.
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 | Defines the GEM URL. Possible Values:
| |
API Base URL | Determines the Global-e environment with which to communicate. Possible values:
| |
Include mode | PRO | Defines the GEM variation. Possible values:
|
Global-e data cookie name | GlobalE_Data | Defines the cookie name. The cookie is set by the plugin and is used by GEM. |
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:
|
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:
|
Save country name as | Country name | Defines how the country of address is saved in Woocommerce. Possible values:
|
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:
|
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. |
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.
Discounts provided by third-party module, Discount Rules for WooCommerce.
Discounts provided by third-party module, Advanced Coupons.
Clear Cart
Clear Cart: This AJAX endpoint clears the cart after order confirmation.
[POST] http://example.com/global-e/?wc-api=pro-cart-clear
Configuring your Site to Support Fixed Prices
Global-e supports fixed prices on WooCommerce with some setup on the merchant's site.
Define the countries for which you wish to set fixed prices.
Install and configure the 3rd-party extension: WooCommerce Price Based on Country.
Set the product prices for each pricing zone.
Contact
[email protected]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.
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 .
<base_host>/?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.
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:
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.
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.
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.