Skip to main content

Plugin Configuration Page

You can use one of the following plug configuration methods:

Configuring Global-e Cross Border Settings via the WooCommerce Settings Menu

  1. Navigate to Woocommerce > Settings.
  2. Click the Integration tab.
  3. In the GlobalE Pro Integration section, configure the fields as needed:
    The following table describes the parameters in the Global-E API Settings section:
    ParametersDescription and Settings
    Enable JS/CSS IncludeON/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 IDMerchant Account ID in the Global-e system (provided by Global-e as part of the merchant’s onboarding process).
    Merchant GUIDPrivate key of the Merchant Account ID in Global-e (provided by Global-e as part of the merchant’s onboarding process).
    API PathPath 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:
    ParameterDescription
    Extra Product AttributesYou 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

  1. Navigate to Plugins > Installed Plugins.
  2. In the Global-e Cross-Border for WooCommerce section, click Settings.

Global-E API Settings

SettingDefaultDescription
Enable JS/CSS includeOffAllows you to enable/disable external Global-e JavaScript and CSS includes. For headless integration, the setting should be disabled.
Merchant IDThe merchant Identifier which allows you to identify JavaScript and CSS includes.
Merchant GUIDThe API key that is used for communication to and from Global-e.
API path//stglite.bglobale.com/Defines the GEM URL.
Possible Values:
Integration Environment: //intgepi.bglobale.com/
Staging Environment: //stgepi.bglobale.com/
Production Environment: //gepi.global-e.com/
API Base URLhttps://connect.bglobale.com/Determines the Global-e environment with which to communicate.
Possible values:
Integration Environment: https://connect.bglobale.com/
Staging Environment: https://connect2.bglobale.com/
Production Environment: https://api.global-e.com/
Include modePRODefines the GEM variation.
Possible values:
PRO
GEM
Global-e data cookie nameGlobalE_DataDefines 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.
SettingDefaultDescription
Extra product attributesSlugs of custom attributes with copa separator (like: “attr1,attr2,attr3”)
Product attributes mapProduct attributes map. Json. Attributes slug => Attribute sign. (example: {“attribute_pa_size”:“size”} )
Brand AttributeThe technical name of a product custom field used as an extra product brand attribute.
Product class code attributeProduct class code attribute
Country of origin attributeThe technical name of a product custom field used as an extra product country of origin attribute.
Description AttributeThe technical name of a product custom field used as an extra product description attribute.
HS Code AttributeThe technical name of a product custom field used as an extra product HS Code attribute.
Weight AttributeThe technical name of a product custom field used as an extra product weight attribute.
Enable save product listTickedEnables/disables saving product data on the Global‑e system.

Order

SettingDefaultDescription
Unique Product identifierSKUDefines which product attribute is considered a unique identifier.
Possible values:
SKU
Product ID / Variation ID
Skip Cart ValidationFalseEnables/disables cart validation on order create notifications.
Use Shipping Method MappingPlugin mapDefines 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 asCountry nameDefines 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 itemsExtra meta, that should be added to order items .Json. MetaKey => MetaValue.(example: {“internationalOrder”:“YES”} )
Reconciliation VATStandard flowDefine how reconciliation VAT is processed.
Possible values:
Standard flow - product prices contain reconciliation VAT.
Deduct - reconciliation VAT is deducted from product prices.
Restock refunded productsTickedIf checked - the system will restock products on order refund.
Enable loggerTickedEnables/disables module logging.
Add shipping cost to totalsUntickedIf checked - the system will add the shipping cost to the product’s total cost.
Allow order currency from request.UntickedIf checked - allows a setting order currency different from a store based on the order creation request value.

Checkout / Order

SettingDefaultDescription
JS Code on Checkout Pagevar 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 countriesUntickedRemove coupons from cart when switching from domestic country to any other one.
Store CodeThis 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:

Clear Cart

Clear Cart: This AJAX endpoint clears the cart after order confirmation. [POST] http://example.com/global-e/?wc-api=pro-cart-clear