Skip to main content

Documentation Portal

Metadata

Custom Objects

Global‑e cartridge uses the following Custom Objects, which needs to be imported once on the Salesforce B2C Commerce Digital (can be found in the metadata folder as globale.custom.xml file). For all Global‑e Custom Objects: Data Replication: Not Replicable. Storage Scope: Site.

GLOBALE_APP_SETTINGS

Used to hold cached data from Global-e API /Browsing/AppSettings and /Browsing/AppVersion.

SFCC Attribute ID

SFCC Key Attribute

Type

SFCC Attribute Name

Global‑e API Attribute ID

Description

name

Yes

String

Name

-

Name of App Setting on Global‑e side

apiVersion

No

String

APIVersion

APIVersion

Version identifier of Global-e API

clientSettings

No

Text

ClientSettings

ClientSettings

Dictionary of client-side settings

serverSettings

No

Text

ServerSettings

ServerSettings

Dictionary of server-side settings

webClientVersion

No

String

WebClientVersion

WebClientVersion

Version identifier of Global-e client-side (JS) code

sfccSendCartSendHubId

No

String

Send HubId in SendCart

sfccUseGEShippingPrice

Send HubId in SendCart Payload

sfccUseGEShippingPrice

No

String

Use Global-e Shipping Price (B2B)

sfccUseGEShippingPrice

Use Global-e Shipping Price (B2B)

sfccWhitelistedServerIps

No

String

Whitelisted Global-e Server IP's

sfccWhitelistedServerIps

A list of IP addresses of Global‑e servers separated by a semicolon (;) that should be whitelisted.

sfccLanguagesConfiguration

No

Text

Languages Switcher Configuration

sfccLanguagesConfiguration

The attribute specifies the configuration of language selector in Global‑e Country Switcher. More details are here: Global‑e_SFCC_Country_Switcher.pdf

sfccCartHashValidation

No

Text

SFCC Cart Hash Validation

sfccCartHashValidation

Enable SFCC Cart Hash Validation

sfccPlaceOrderOnPaymentUpdate

No

String

Place Order On Payment Update

sfccPlaceOrderOnPaymentUpdate

The preference allows turn on/off the placing of SFCC order when is seng Global-e PaymentUpdate request.

If the preference is set to false then order is placed during SOTM request(when are updated order attributes). If the preference is set to 'false’ the order is placed during PaymentUpdate request(when is changed order payment and export statuses).

sfccUseFixedPricesOnly

No

String

Use Only Fixed Prices

sfccUseFixedPricesOnly

The preference is used only for fixed price countries. It specifies that for fixed price countries should be used the prices only from fixed price books.

sfccCreateNewAddressesFromCheckout

No

String

Save GE Address

sfccCreateNewAddressesFromCheckout

Allows to create and save new addresses from GE checkout

sfccCultureMapping

No

Text

Culture Mapping

sfccCultureMapping

The preference allows to override default culture code for Global-e popups/templates.

Culture code is used for setting right language.

sfccCheckoutCultureMapping

No

Text

Checkout Culture Mapping

sfccCheckoutCultureMapping

The preference allows to override default culture code for Global-e checkout templates.

Culture code is used for setting right language.

sfccDynamicCountryCurrencyMapping

No

Text

Dynamic Country/Currency Mapping

sfccDynamicCountryCurrencyMapping

The preference allows to override default currency code for dynamic price countries

sfccAllowedCurrencies

No

Text

Allowed country currencies

sfccAllowedCurrencies

Allowed country currencies (price book caching approach)

sfccShippingSwitcherConfiguration

No

Text

Shipping Switcher Configuration

sfccShippingSwitcherConfiguration

Shipping Switcher Configuration

sfccDefaultCountryCodeMapping

No

Text

Default Country Code Mapping

sfccDefaultCountryCodeMapping

Default Country Code Mapping

sfccMerchantBaseCurrencyCode

No

String

Merchant Base Currency Code

sfccMerchantBaseCurrencyCode

Merchant Base Currency Code (Site default currency is used if empty)

sfccCachePriceBooksConfig

No

Text

Cache Price Books Configuration

sfccCachePriceBooksConfig

Cache Price Books Configuration

sfccParseCountryCodeFromRequestLocale

No

String

Parse CountryCode from RequestLocale

sfccParseCountryCodeFromRequestLocale

Use SFCC locale country code to define shipping country

sfccJWTAuthConfiguration

No

Text

JWT Authentication Configuration

sfccJWTAuthConfiguration

JWT Authentication Configuration (GE to SFCC)

sfccJWTApiAuthConfiguration

No

Text

JWT API Authentication Configuration

sfccJWTApiAuthConfiguration

JWT API Authentication Configuration (SFCC to GE)

sfccLocalizationConfiguration

No

Text

SendCartV2 Localization Configuration

sfccLocalizationConfiguration

Allows to configure localized product data (SendCartV2 API).

sfccUseProductCodeSecondaryInFulfillmentEnabled

No

String

SFCC Use ProductCodeSecondary In Fulfilment Enabled

sfccUseProductCodeSecondaryInFulfillmentEnabled

Allows to use ProductCodeSecondary In Fulfilment instead of ProductCode

sfccKlarnaConfigurations

No

Text

SFCC Klarna Configurations

sfccKlarnaConfigurations

SFCC Klarna OSM Configurations

sfccDoWebStoreValidation

No

String

Do WebStore Validation

sfccDoWebStoreValidation

Do WebStore Validation

GLOBALE_COUNTRIES

Used to hold cached data from Global-e API /Browsing/Countries.

SFCC Attribute ID

SFCC Key Attribute

Type

SFCC Attribute Name

Global‑e API Attribute ID

Description

code

Yes

String

Code

Code

2-char ISO country code

defaultCurrencyCode

No

String

DefaultCurrencyCode

DefaultCurrencyCode

3-char ISO currency code

isStateMandatory

No

Boolean

IsStateMandatory

IsStateMandatory

TRUE if State or province (region) is mandatory for addresses in this country

isOperatedByGlobalE

No

Boolean

IsOperatedByGlobalE

IsOperatedByGlobalE

TRUE if Country is operated by Global-e. Countries that are not operated by Global-e can still be available for selection as a shipping destination on the merchant’s site. However Global-e functionality must be disabled for such countries

name

No

String

Name

Name

Country name

siteUrl

No

String

SiteURL

SiteURL

URL of a country-specific site owned by the merchant. Used to allow redirection to the merchant’s country-specific domain for a selected country. Can be either a static URL, like “https://merchantsite.com” or a special format to be parsed on SFCC backend, like “en_US|SiteGenesis|merchantsite.com|param1|value1”.

useCountryVAT

No

Boolean

UseCountryVAT

UseCountryVAT

TRUE if VAT rate specific to this shipping country must be applied to the product prices. Otherwise, VAT rates defined for the products on the merchant’s site must be used. This setting is used to support trade agreements between the countries such as EEA, when end customer must pay VAT for the shipping country in certain cases

defaultVATRateType

No

String

DefaultVATRateType

DefaultVATRateType

Default (most widely used) VAT rate type or class for this country

supportsFixedPrices

No

Boolean

SupportsFixedPrices

SupportsFixedPrices

TRUE if fixed product prices are allowed for this country. Product prices may be fixed only in the Default Currency for this Country

vatExemptionDisabled

No

Boolean

VATExemptionDisabled

VATExemptionDisabled

Used in order to identify, if no VAT case is supported

GLOBALE_COUNTRY_COEFFICIENTS

Used to hold cached data from Global-e API /Browsing/CountryCoefficients.

SFCC Attribute ID

SFCC Key Attribute

Type

SFCC Attribute Name

Global‑e API Attribute ID

Description

countryCode

Yes

String

CountryCode

CountryCode

2-char ISO country code

includeVAT

No

Integer

IncludeVAT

IncludeVAT

This attribute is applicable only to Country level (i.e. not applicable to ProductClass level). One of the possible values of IncludeVATOptions enumeration designated to control the way VAT is handled in browsing on the Merchant’s site and in checkout on Global-e

rate

No

Double

Rate

Rate

Country Coefficient rate decimal value. All the prices displayed to the end customer shipping to the country involved must be multiplied by this value

GLOBALE_PRODUCT_CLASS_COEFFICIENTS

Used to hold cached data from Global-e API /Browsing/CountryCoefficients.

SFCC Attribute ID

SFCC Key Attribute

Type

SFCC Attribute Name

Global‑e API Attribute ID

Description

key

Yes

String

Key

ProductClassCode + '_' + CountryCode

The unique key value for the instance

rate

No

Double

Rate

Rate

Country Coefficient rate decimal value. All the prices displayed to the end customer shipping to the country involved must be multiplied by this value

countryCode

No

String

CountryCode

CountryCode

2-char ISO country code

productClassCode

No

String

ProductClassCode

ProductClassCode

Product class code used by the merchant to classify products for using different country coefficient rates per classes of products instead of the single country level default (when no rate is defined for a certain product class, the country level default rate should be used by the merchant for the respective product)

GLOBALE_CULTURES

Used to hold cached data from Global-e API /Browsing/LocationsDefaultCulturesList.

SFCC Attribute ID

SFCC Key Attribute

Type

SFCC Attribute Name

Global‑e API Attribute ID

Description

code

Yes

String

Country code

CountryCode

2-char ISO country code

regionCode

No

String

Region Code

RegionCode

Region code (unique in the respective Country)

cityCode

No

String

City Code

CityCode

City code (unique in the respective Region)

isRTL

No

Boolean

IsRTL

Culture.IsRTL

TRUE for "right-to-left" languages such as Hebrew and Arabic

localizedName

No

String

Localized Name

Culture.LocalizedName

Culture name in the respective language, such as "עברית" for he-IL (Hebrew-Israel) culture

name

No

String

Name

Culture.Name

Culture name

culture

No

String

Culture Code

Culture.Code

ISO culture code

GLOBALE_CURRENCIES

Used to hold cached data from Global-e API /Browsing/Currencies.

SFCC Attribute ID

SFCC Key Attribute

Type

SFCC Attribute Name

Global‑e API Attribute ID

Description

code

Yes

String

Code

Code

3-char ISO currency code

maxDecimalPlaces

No

Integer

MaxDecimalPlaces

MaxDecimalPlaces

Number of decimal places indicating the fractional ("cents") part of the price. For example Bahraini Dinar "cents" has 3 decimal places, US Dollar has 2, and Japanese Yen has 0

name

No

String

Name

Name

Currency name

symbol

No

String

Symbol

Symbol

Currency symbol (e.g. $ for USD)

GLOBALE_CURRENCY_RATES

Used to hold cached data from Global-e API /Browsing/CurrencyRates.

SFCC Attribute ID

SFCC Key Attribute

Type

SFCC Attribute Name

Global‑e API Attribute ID

Description

key

Yes

String

Key

SourceCurrencyCode + '_' + TargetCurrencyCode

The unique key value for the instance

rate

No

String

Rate

Rate

Currency rate decimal value

sourceCurrencyCode

No

String

SourceCurrencyCode

SourceCurrencyCode

3-char ISO currency cod

targetCurrencyCode

No

String

TargetCurrencyCode

TargetCurrencyCode

3-char ISO currency code

rateData

No

String

Rate Data

RateData

Currency data used by global-e to verify the rate

GLOBALE_ROUNDING_RULES

Used to hold cached data from Global-e API /Browsing/RoundingRules.

SFCC Attribute ID

SFCC Key Attribute

Type

SFCC Attribute Name

Global‑e API Attribute ID

Description

key

Yes

String

Key

CurrencyCode [+ '_' + CountryCode]

The unique key value for the instance

countryCode

No

String

CountryCode

CurrencyCode

2-char ISO country code

currencyCode

No

String

CurrencyCode

CurrencyCode

3-char ISO currency code

roundingRanges

No

Text

RoundingRanges

RoundingRanges

List of decimal ranges and their respective rounding behaviors

roundingRuleId

No

String

RoundingRuleId

RoundingRuleId

Rule identifier denoting the respective Rounding Rule on Global‑e side. This value must be further specified when calling SaveProductsList and SendCart methods

GLOBALE_HUB_DETAILS

Used to hold cached data from Global-e API /Browsing/ActiveHubDetails.

SFCC Attribute ID

SFCC Key Attribute

Type

SFCC Attribute Name

Global‑e API Attribute ID

Description

key

Yes

String

Key

-

The unique key value for the instance

address1

No

String

Address1

Address1

Address line 1

address2

No

String

Address2

Address2

Address line 2

city

No

String

City

City

City name

countryCode

No

String

CountryCode

CountryCode

2-char ISO country code

countryName

No

String

CountryName

CountryName

Country name

email

No

String

Email

Email

E-mail address

fax

No

String

Fax

Fax

Fax

hubID

No

String

HubID

HubId

Hub identifier on Global‑e system

hubName

No

String

HubName

HubName

Name of the Hub

phone1

No

String

Phone1

Phone1

Phone #1

phone2

No

String

Phone2

Phone2

Phone #2

stateCode

No

String

StateCode

StateCode

State or province ISO code such as AZ for Arizona (if applicable)

stateOrProvice

No

String

StateOrProvice

StateOrProvice

State or province name

zip

No

String

Zip

Zip

Zip or postal code

DEMO_GLOBALE_GIFT_CARDS

Used for demo implementation of the 'Gift Cards' feature

SFCC Attribute ID

SFCC Key Attribute

Type

SFCC Attribute Name

Description

cardID

Yes

String

Card ID 

Card ID(card number) 

currentBalance

No

Integer

Current Balance 

Current balance of the card

initialBalance

No

Integer

Initial Balance

Initial balance of the card

originalCurrencyCode

No

String

Currency Code 

Currency code of the card

redeemRequestJSON

No

Text

Redeem Request JSON 

Used as a storage and contains information about redeem requests(between Global-e and SFCC) of the card

redeemResponseJSON

No

Text

Redeem Response JSON 

Used as a storage and contains information about redeem responses(between Global-e and SFCC) of the card

refundRequestJSON

No

Text

Refund Request JSON 

Used as a storage and contains information about refund requests(between Global-e and SFCC) of the card

refundResponseJSON

No

Text

Refund Response JSON 

Used as a storage and contains information about refund responses(between Global-e and SFCC) of the card

DEMO_GLOBALE_LOYALTY_CARDS

Used for demo implementation of the 'Loyalty Cards' feature

SFCC Attribute ID

SFCC Key Attribute

Type

SFCC Attribute Name

Description

cardID

Yes

String

Card ID 

Card ID(card number) 

currentBalance

No

Integer

Current Balance 

Current balance of the card

initialBalance

No

Integer

Initial Balance

Initial balance of the card

originalCurrencyCode

No

String

Currency Code 

Currency code of the card

redeemRequestJSON

No

Text

Redeem Request JSON 

Used as a storage and contains information about redeem requests(between Global-e and SFCC) of the card

redeemResponseJSON

No

Text

Redeem Response JSON 

Used as a storage and contains information about redeem responses(between Global-e and SFCC) of the card

refundRequestJSON

No

Text

Refund Request JSON 

Used as a storage and contains information about refund requests(between Global-e and SFCC) of the card

refundResponseJSON

No

Text

Refund Response JSON 

Used as a storage and contains information about refund responses(between Global-e and SFCC) of the card

GLOBALE_RESTRICTED_ITEMS

Used for SFCC job 'GlobaleRestrictedItemsFeed'. More details are described here: Global-e_SFCC_Cartridge_GlobaleRestrictedItemsFeed

SFCC Attribute ID

SFCC Key Attribute

Type

SFCC Attribute Name

Description

name

Yes

String

name

Name of entity which is used restrictions. There are possible values: ‘brands', ‘categories’, 'products’

countriesExclusions

No

Text

Countries Exclusions

Used for storing Countries Exclusions of entities: ‘brands', 'categories’

sourceHandler

No

Text

Source Handler

Used as source handler for extracting the current values products restrictions

GLOBALE_ORDER_NOTIFICATION

Used for GE->SFCC and SFCC->GE notifications.

The Custom Object Retention is 7 days.

SFCC Attribute ID

SFCC Key Attribute

Type

SFCC Attribute Name

Description

ID

Yes

string

ID 

Notification ID 

geOrderId

No

string

Order Id 

SFCC or Global‑e order ID

geNotificationType

No

enum-of-string

Notification Type

Possible values are: OrderStatusUpdate, OrderDispatchUpdate, OrderRefundUpdate, OrderRMAUpdate, OrderRMACreate

geNotificationPayload

No

Text

Notification Payload

The notification payload (JSON stringified object)

System Objects
Product

Used for demo implementation of the 'Loyalty Cards' feature

ID

Type

Name

Attributes Group Name

Description

geCountriesExclusions

string

Countries Exclusions

not assigned

Specifies the list of countries codes for which the product is restricted(blocked)

geIsForbidden

boolean

Global‑e Is Forbidden

Global‑e Attributes

Specifies that the product is globally forbidden(for all countries) for selling

geRestrictedCountries

string

Global‑e RestrictedCountries

Global‑e Attributes

Specifies the list of Global‑e Restricted Countries for the product. Contains the list of countries codes. Example value: AU,UA,IT

geVatRates

text

Global‑e Vat Rates

Global‑e Attributes

Specifies the list of Global‑e Vat Rates for the product in json format. JSON format provides different vat rates depends on country code. Example value: {'AU': {}, 'UA': {}}

geIsGiftCard

boolean

Is Globale Gift Card

Global‑e Attributes

Specifies that the product is selling as 'gift card' product

Site Preferences

ID

Type

Name

Preference Group Name

Description

Default Value

Purpose

Configuration

geEnabled

boolean

Global‑e Enabled

Global‑e Settings

The preference allows turn on/off Global-e integration

  • No (false)

  • Yes (true)

  • No (false)

geCookieLifetime

int

Cookie lifetime

not assigned

The preference specifies the lifetime of the 'GlobalE_Data' - main Global-e cookie(in seconds) default is one week(7 days).

By default is not required any configuration. The default value should not be changed without good reason.

  • 604 800

geCookieDomain

text

Cookie domain

not assigned

The preference specifies the domain for which the Global-e cookies are registered in browser.

Not required any configuration. By default is taken 'httpHost' from SFCC Request (class: dw.system.Request).

Exceptions: If for different locales of one site are used different domains then can be added configuration which will handle this case. The configuration example:

{

"defaultDomain":"www.example.com",

"en_GB":"www.example.uk"

}

-

geClientJsMerchantId

int

Client JS Merchant ID

Global‑e Settings

The preference specifies the Global-e Merchant ID. The Global-e Merchant ID is used to load Global-e Client SDK.

Must be set Global‑e Merchant ID (which is provided by the Global‑e team to the Merchant team)

-

geClientJsBaseUrl

enum-of-string

Global‑e Client JS SDK Base URL

Global‑e Settings

The preference specifies the Base URL for Global-e Client SDK.

The Global‑e Base URL is used to load Global‑e Client SDK.

  • Global‑e Staging (https://www2.bglobale.com) Must be selected on SFCC sandboxes/Development/Staging instances

  • Global‑e Production (https://web.global-e.com) Must be selected on SFCC Production instance

  • Global‑e Staging (https://www2.bglobale.com)

geClientJsSource

string

Client JS SDK Source (/SOURCE)

Global‑e Settings

The preference specifies the Source of Global-e Client JS SDK. The Global-e Source is used to load Global-e Client SDK.

By default is not required any configuration. The default value should not be changed without good reason.

  • /scripts/merchants/globale.merchant.client.js

geMerchantGuid

string

Merchant GUID

Global‑e Settings

The preference specifies the Global-e Merchant GUID. The Global-e Merchant GUID is used for validation requests:

  • from Global‑e to SFCC (SOTM, PaymentUpdate, etc.)

  • from SFCC to Global‑e (service calls which are sent to Global‑e)

Must be set Global‑e Merchant GUID (which is provided by the Global‑e team to the Merchant team)

-

geApiUrl

enum-of-string

Global‑e API URL

Global‑e Settings

The preference specifies the Global-e API URL. The Global-e API URL is used for generating SFCC service URL when is sent a request from SFCC to Global-e.

  • Global‑e Staging (https://connect2.bglobale.com) Must be selected on SFCC sandboxes/Development/Staging instances

  • Global‑e Production (https://api.global-e.com)) Must be selected on SFCC Production instance

  • Global‑e Staging (https://connect2.bglobale.com)

geDefaultShippingMethod

string

Global‑e Default Shipping Method ID

Global‑e Settings

The preference specifies Default Shipping Method ID for operated by Global-e countries. This shipping method is selected and assigned to shipment by default.

By default is not required any configuration. The default value should not be changed without good reason.

  • GLOBALE

geEnableStockReservation

boolean

Enable Stock Reservation

Global‑e Settings

The preference allows turn on/off reservation of basket inventory before Global-e checkout is displayed (before Send Cart request)

  • No (false)

  • Yes (true)

  • No (false)

geStockReservationTime

int

Stock reservation time

Global‑e Settings

The preference specifies the amount of time in minutes for stock to be reserved in Global-e checkout

By default is not required any configuration. The default value should not be changed without good reason.

30

geEnableCartValidationOcapiBasket

boolean

Enable CartValidation OCAPI basket

Global‑e Settings

Enables CartValidation using OCAPI basket

  • No (false)

  • Yes (true)

No (false)

geEnableCartValidationErrors

boolean

Enable CartValidation Errors

Global‑e Settings

Enables CartValidation Error popup (in case of non-expected error)

  • No (false)

  • Yes (true)

No (false)

geAddNotes

boolean

Add Global‑e Notes

Global‑e Settings

The preference allows turn on/off adding of Notes to SFCC Order when are processed any requests to/from Global-e that are related to the order.

  • No (false)

  • Yes (true)

  • Yes (true)

geCatalogFeedConfig

text

Global‑e Catalog Feed Config

Global‑e Catalog Jobs

The preference specifies Global-e Catalog Feed configuration.

More details are described here: Global‑e_SFCC_Cartridge_GlobaleCatalogFeed.pdf

-

geCatalogFeedLastRun

datetime

Global‑e CatalogFeed last run

not assigned

This preference contains information about last time run of Global-e Catalog Feed.

Not required any configuration.

-

geCatalogFeedStartPosition

number

Catalog Feed Start Position

not assigned

This preference specifices of products iterator start position for Global-e Catalog Feed.

By default is used 0.

geRestrictedItemsFeedConfig

text

Restricted Items Feed Configuration

Global‑e Catalog Jobs

The preference specifies Global-e Restricted Items Feed configuration.

More details are described here: Global‑e_SFCC_Cartridge_GlobaleRestrictedItemsFeed

-

geRestrictedItemsFeedLastRun

datetime

Restricted Items Last Run

not assigned

This preference contains information about last time run of Global-e Restricted Items Feed.

Not required any configuration.

-

geProductClassCodePropName

string

Product Class Code Custom Property Name

Global‑e Product Settings

The preference specifies the product custom attribute that is used to check against ProductClassCode for coefficient rate. Product class code used by the merchant to classify products for using different country coefficient rates per classes of products instead of the single country level default (when no rate is defined for a certain product class, the country level default rate should be used by the merchant for the respective product).

By default is not required any configuration. If is needed to use product class code for calculation of coefficient rate then should be set product attribute in format - custom[attribute id] For example: custom.geProductClassCode

-

geProductGroupCodePropName

string

Product Group Code Property Name

Global‑e Product Settings

The preference specifies the product custom attribute that is used for setting ProductGroupCode(in SendCart request) if exists (optional).

Product’s group code on the Merchant’s site (to be mapped on Global‑e side). Usually this value is a part of product SKU code denoting a group of similar products (such as "the same product in different colors").

By default is not required any configuration. If is needed to use the attribute then should be set product attribute in format - custom[attribute id] For example: custom.geProductGroupCode

-

geProductCodeSecondaryPattern

string

Product Code Secondary Pattern

Global‑e Product Settings

The preference specifies the product custom attribute that is used for setting ProductCodeSecondary(in SendCart request) if exists (optional).

Secondary code that may be used to refer to the product on the Merchant’s site. This code may be used in addition to the ProductCode and is not guaranteed to be unique (may be reused for other products as long as the old product is not available on the merchant’s site anymore).

By default is not required any configuration. If is needed to use the attribute then should be set product attribute in format - custom[attribute id] For example: custom.geProductCodeSecondary

-

geProductGroupCodeSecondaryPattern

string

Product Group Code Secondary Pattern

Global‑e Product Settings

The preference specifies the product custom attribute that is used for setting ProductGroupCodeSecondary(in SendCart request) if exists (optional).

Secondary code that may be used to refer to the group of products on the Merchant’s site. This code may be used in addition to the ProductGroupCode and is not guaranteed to be unique (may be reused for other groups as long as the old group is not available on the merchant’s site anymore).

By default is not required any configuration. If is needed to use the attribute then should be set product attribute in format - custom[attribute id] For example: custom.geProductGroupCodeSecondary

-

geWeightAttributeKey

string

Weight attribute key

Global‑e Product Settings

The preference specifies the product custom attribute that is used for setting product’s weight(in SendCart request) if exists (optional). Product’s weight in Merchant’s default unit of weight measure (will be converted to grams). Merchant’s default product weight will be used if not specified.

By default is not required any configuration. If is needed to use the attribute then should be set product attribute in format - custom[attribute id] For example: custom.geWeight

-

geHeightAttributeKey

string

Height attribute key

Global‑e Product Settings

The preference specifies the product custom attribute that is used for setting product’s height(in SendCart request) if exists (optional).

Product’s height in Merchant’s default unit of length measure (will be converted to CM).

By default is not required any configuration. If is needed to use the attribute then should be set product attribute in format - custom[attribute id] For example: custom.geHeight

-

geWidthAttributeKey

string

Width attribute key

Global‑e Product Settings

The preference specifies the product custom attribute that is used for setting product’s width(in SendCart request) if exists (optional).

Product’s width in Merchant’s default unit of length measure (will be converted to CM).

By default is not required any configuration. If is needed to use the attribute then should be set product attribute in format - custom[attribute id] For example: custom.geWidth

-

geLengthAttributeKey

string

Length attribute key

Global‑e Product Settings

The preference specifies the product custom attribute that is used for setting product’s length(in SendCart request) if exists (optional).

Product’s length in Merchant’s default unit of length measure (will be converted to CM).

By default is not required any configuration. If is needed to use the attribute then should be set product attribute in format - custom[attribute id] For example: custom.geLength

-

geVolumeAttributeKey

string

Volume attribute key

Global‑e Product Settings

The preference specifies the product custom attribute that is used for setting product’s volume(in SendCart request) if exists (optional).

Alternative for specifying all 3 dimensions above(height, width, length). Product’s volume in Merchant’s default unit of volume measure (will be converted to cubic CM).

By default is not required any configuration. If is needed to use the attribute then should be set product attribute in format - custom[attribute id] For example: custom.geVolume

-

geProductImageViewType

string

Product Image ViewType

Global‑e Product Settings

The preference specifies the ViewType of the product’s image that will be sent to Global-e(in SendCart request) and used on Global-e page (checkout, confirmation page, emails, etc.)

By default is not required any configuration. The default value should not be changed without good reason.

  • large

geParseCountryCodeFromRequestUrl

boolean

Parse Global‑e Country Code from Request URL

Global‑e Settings

The preference allows turn on/off parsing of Request URL (i.e. SFCC locale). If the preference is enabled - the country code is taken from the selected SFCC locale

  • No (false)

  • Yes (true)

  • No (false)

geResetCurrencyCodeOnCountryChange

boolean

Reset Global‑e Currency Code on Country change

Global‑e Settings

The preference allows turn on/off resetting currency code on Country change. The preference is used only for dynamic price countries and allows to reset currency code to the country’s default value for every SFCC request.

  • No (false)

  • Yes (true)

  • No (false)

geSearchableProductsPromotionId

string

Searchable Products Promotion ID

Global‑e Settings

The preference specifies the SFCC Promotion ID that is used filter out the restricted / forbidden products on CLP/PLP or any other search result page. More details are described here: Global-e_SFCC_Cartridge_Restricted_Forbidden_Products.pdf

By default is not required any configuration. If is used SFCC Promotion for hiding some products then should be set SFCC Promotion ID. For example: GLOBALE-RESTRICTED-PRODUCTS

-

geLoyaltyPromotionSpentPointsFactor

double

Global‑e Loyalty Promotion Spent Points Factor

not assigned

The preference specifies Global-e Loyalty Promotion Spent Points Factor. Can be any Number like 0.001, 0.01, 0.1, 1, 10, 100, 1000, etc. For example: 100, which means each really spent dollar will be represented on Global-e Checkout page as 100 Global-e Loyalty points.

By default is not required any configuration.

-

geLoyaltyPromotionEarnedPointsFactor

double

Global‑e Loyalty Promotion Earned Points Factor

not assigned

The preference specifies Global-e Loyalty Promotion Earned Points Factor. Can be any Number like 0.001, 0.01, 0.1, 1, 10, 100, 1000, etc. For example: 100, which means each really earned dollar will be represented on Global-e Checkout page as 100 Global-e Loyalty points.

By default is not required any configuration.

-

geReturnPortalUrl

enum-of-string

Return Portal URL

Global‑e Settings

The preference specifies the URL for Global-e return portal. Out of the box the value of this preference is not used in code. If project requires to use Return Protla URL then development team can use the preference and implement custom logic according to requirements.

  • Global‑e Staging (https://www2.bglobale.com/Returns/Portal/{returnPortalId}?OrderID={orderNo}&Email={email}) Must be selected on SFCC sandboxes/Development/Staging instances

  • Global‑e Production (https://web.global-e.com/Returns/Portal/{returnPortalId}?OrderID={orderNo}&Email={email}) Must be selected on SFCC Production instance

geCustomObjectsCacheSettings

text

Custom Objects cache settings

not assigned

The preference specifies the SFCC Custom Cache settings for cached entities.

By default is not required any configuration and are used next settings:

{

"countries": 86400,

"appSettings": 86400,

"hubDetails": 86400,

"countryCoefficients": 86400,

"productClassCoefficients": 86400,

"cultures": 86400,

"currencies": 86400,

"currencyRates": 86400,

"roundingRules": 86400,

"fixedPriceBooks": 60,

"priceDisplayFormat": 60

}

where is: 'countries' - ID of entity 86400 - cache time in seconds If is needed to change cache time then should be added configuration according to format above

-

geOCAPIDomain

string

OCAPI Domain

Global‑e OCAPI Settings

The preference specifies OCAPI domain and is used for Global-e features that work with SFCC OCAPI

By default is not required any configuration.

-

geOCAPIVersion

string

OCAPI Version

Global‑e OCAPI Settings

The preference specifies OCAPI Version and is used for Global-e features that work with SFCC OCAPI

By default is not required any configuration.

-

geOCAPIClientId

password

OCAPI ClientId

Global‑e OCAPI Settings

The preference specifies OCAPI ClientId and is used for Global-e features that work with SFCC OCAPI

By default is not required any configuration.

-

geRSAPublicKey

text

RSA Public Key

Global‑e Crypto Settings

The preference specifies RSA Public Key and is used to Global-e features that work with RSA encryption/decryption

By default is not required any configuration.

-

geRSAPrivateKey

text

RSA Private Key

Global‑e Crypto Settings

The preference specifies RSA Private Key and is used to Global-e features that work with RSA encryption/decryption

By default is not required any configuration.

-

geAESPrivateKey

text

AES Private Key

Global‑e Crypto Settings

The preference specifies AES Private Key and is used to Global-e features that work with AES encryption/decryption

By default is not required any configuration.

-

geMetadataCustomAttributes

set-of-string

Meta Data Custom Attributes

Global‑e Product Settings

The preference specifies attributes of product line items or product that should be set in the ‘metadata’ array(which is sent in SendCart request). For example: if is needed to add one more product custom attribute for displaying on Global-e checkout. (by default are sent only the values from product’s variation attributes)

Format of configuration:

  • attrID or

  • metadataAttrKey:attrID

Example of configuration:

  • custom.productVolume or

  • Volume:custom.productVolume

-

geTaxJurisdictionId

string

Tax Jurisdiction ID

Global‑e Settings

Tax Jurisdiction ID

By default is not required any configuration.

geEnableNativeGiftCertificates

boolean

Enable Native SFCC Gift Certificates

Global‑e Auth Settings

Enables Creating And Using Native SFCC Gift Certificates

  • No (false)

  • Yes (true)

  • No (false)

geUseCustomProductInventoryLists

boolean

Use Custom Product Inventory Lists

Global‑e Auth Settings

The preference specifies JWT Auth Public Key.

JWT Auth Public Key is used to check JWT attached to all GE server-to-server notifications

  • No (false)

  • Yes (true)

  • No (false)

geWebStoreUUID

string

Global-e WebStore UUID

not assigned

Global-e WebStore UUID

Organization Preferences

ID

Type

Name

Description

Default Value

geLanguagesConfiguration

text

Global‑e Languages Selector Configuration

The preference specifies the configuration of language selector in Global-e Country Switcher.

-

Promotion

ID

Type

Name

Description

Default Value

geDiscountType

enum-of-string

Promotion Discount Type

Please help Global‑e to identify the Promotion Discount Type properly. It helps to calculate Promotional Price properly on Storefront.

TYPE_PERCENTAGE: PERCENTAGE

geDoNotConvert

boolean

Do not Convert Promotional Discount

For example: "get -10 off" - will do -10 off on end-customer Price. Applicable only for the following Promotion Discount Types: AMOUNT, FIXED_PRICE, PRICE_BOOK_PRICE, TOTAL_FIXED_PRICE.

-

geFreeShippingMethod

enum-of-string

Global-e Free Shipping Method

Allows Global-e to identify the Free Shipping Method in the checkout.

geLoyaltyPromotion

boolean

Global‑e Loyalty Promotion

If it is Global‑e Loyalty Promotion - then Global‑e cartridge will treat this Promotion as special promotion in SendCart API.

-

Price Adjustment

ID

Type

Name

Description

geName

string

Discount Name

Discount textual description

geDescription

string

Discount Description

Discount Description

gePrice

double

Price

Discount value in currency defined in CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant.

geVatRate

double

VAT Rate

VAT rate applied to this discount

geLocalVatRate

double

Local VAT Rate

VAT rate that would be applied to this discount if the order was placed by the local customer. This value must be specified if UseCountryVAT for the current Country is TRUE and therefore VATRate property actually denotes the VAT for the target country.

geInternationalPrice

double

International Price

Discount value in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion and IncludeVAT handling.

geCouponCode

string

Coupon Code

Merchant’s coupon code used for this discount (applicable to coupon-based discounts only)

geDiscountCode

string

Discount Code

Discount code originally specified in Discount.DiscountCode property of the respective discount in SendCart method for the cart converted to this order on Global‑e.

geLoyaltyVoucherCode

string

Loyalty Voucher Code

Loyalty Voucher code originally specified in Discount.LoyaltyVoucherCode property of the respective discount in SendCart method for the cart converted to this order on Global‑e.

geDiscountType

int

Discount Type

Discount type (“Cart”, “Shipping”, etc.), as defined in DiscountTypeOptions enumeration described in Discount class in this document.

geOriginalPriceAdjustmentPrice

double

Original Price Adjustment Price

Original Price Adjustment Price

Basket

ID

Type

Name

Description

geCartToken

string

Global‑e Cart Token

The token exchanged within the SendCart API call to display the Global-e checkout iframe.

geMerchantOrderId

string

Global‑e Merchant Order ID

Reserved SFCC merchant order ID.

geIsOrderCreatedFallbackScenario

boolean

Is Order Created Fallback Scenario

SFCC order is created from a fallback scenario(when a new SFCC basket is generated from the SOTM payload).

geBasketCountryCurrency

string

Global-e Basket Country Currency

Global-e Basket Country Currency.

Order

ID

Type

Name

Description

geCartToken

string

Global‑e Cart Token

The token exchanged within the SendCart API call to display the Global-e checkout iframe.

geOrderNumber

string

Global‑e Order Number

Global‑e Order Number

geReceivedOrderStatusUpdates

set-of-string

Order Status Updates received from Global‑e

The set of strings of the statuses received from Global-e

geOrderCancellationReasonCode

string

Global‑e Order Cancellation Reason Code

Global‑e order cancellation reason code received from Global‑e

geStatusCode

string

Order Status Code

Code denoting the order status on the Merchant’s site (to be mapped on Global‑e side)

geIsSplitOrder

boolean

Is Split Order

Indicates if the order should be handled as split order (i.e. without consolidation)

geOtVoucherCode

string

OT Voucher Code

Onetime voucher code used to place the order

geOtCurrencyCode

string

OT Currency Code

Currency of the onetime voucher code used to place the order

geOtVoucherAmount

double

OT Voucher Amount

Amount taken off the voucher when applicable

geLoyaltyPointsSpent

double

Loyalty Points Spent

Number of loyalty points spent for this purchase. The existing loyalty points handling procedure must be applied to the end customer’s user account. Therefore, “Loyalty points” type discount must not be applied to the order directly, but can be used for the display purposes elsewhere in the system (i.e in end user’s My Account page)

geLoyaltyPointsEarned

double

Loyalty Points Earned

Number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site, as specified in loyaltyPointsEarned argument for SendCart method for the cart converted to this order on Global‑e

geLoyaltyCode

string

Loyalty Code

Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout

geCustomerComments

text

Customer Comments

Comments text entered by the end customer in Global‑e checkout

geDeliveryStoreId

string

Delivery Store ID

Delivery Store ID

geBarCode

string

Global‑e Bar Code

Global‑e Bar Code. The attribute contains - Global‑e Order Number.

geCurrencyCode

string

Global‑e Currency Code

3-char ISO currency code for the order being posted. By default this is set to the original Merchant’s currency

geIsFreeShipping

boolean

Is Free Shipping

Indicates if the Merchant offers free international shipping to the end customer, as specified in IsFreeShipping argument for SendCart method for the cart converted to this order on Global‑e

geFreeShippingCouponCode

string

Free Shipping Coupon Code

Merchant’s free shipping coupon code applied by the end customer, as specified in FreeShippingCouponCode argument for SendCart method for the cart converted to this order on Global‑e

geShippingMethodCode

string

Shipping Method Code

Code denoting the selected international shipping method as defined on the Merchant’s site (to be mapped on Global‑e side). If this international shipping method doesn’t exist on the Merchant’s site, the internal Global‑e shipping method code will be specified instead

gePriceCoefficientRate

double

Price Coefficient Rate

CountryCoefficient rate applied to the prices in this order

geAllowEmailsFromMerchant

boolean

Allow Emails from Merchant

Indicates if the end customer has opted on Global‑e checkout to receive emails from the Merchant.

geAllowDirectCommunicationFromMerchant

boolean

Allow Direct Communication from Merchant

Indicates if the end customer has opted on Global‑e checkout to receive direct communication from the Merchant.

geCartId

string

Cart ID

Identifier of the cart on the Merchant’s site originally specified in geMerchantCartToken argument for SendCart method for the cart converted to this order on Global‑e.

geRoundingRate

string

Global‑e Rounding Rate

Average conversion rate applied to the prices paid by the end customer, when calculating the prices paid by Global‑e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors

geTotalCustomerDiscounts

double

Total Customer Discounts

Total customer discounts for Cart and Loyalty type discounts

geTotalDutiesPaidByCustomerPrice

double

Total Duties Paid By Customer

The Duties paid by customer (in merchant currency) for Duties as they were shown in checkout

geOrderTrackingNumber

string

Order Tracking Number

Tracking number used by the selected international shipping method for this order.

geOrderTrackingUrl

string

Order Tracking URL

Full tracking URL including OrderTrackingNumber used by the selected international shipping method for this order.

geShippingMethodName

string

Shipping Method Name

Name of the selected international shipping method.

geShippingMethodTypeCode

string

Shipping Method Type Code

Code denoting the selected international shipping method type as defined on the Merchant’s site (to be mapped on Global‑e side). If this international shipping method type doesn’t exist on the Merchant’s site, the internal Global‑e shipping method type code will be specified instead.

geShippingMethodTypeName

string

Shipping Method Type Name

Name of the selected international shipping method type.

geOrderDeliveryDate

string

Global‑e Order Delivery Date

Global‑e Order Delivery Date

geDeliveryDaysFrom

int

Delivery Days From

Minimum number of days for delivery to the end customer for the selected shipping method.

geDeliveryDaysTo

int

Delivery Days To

Maximum number of days for delivery to the end customer for the selected shipping method.

geConsignmentFee

double

Consignment Fee

Consignment fee paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.

geSizeOverchargeValue

double

Size Overcharge Value

Oversized items charge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.

geRemoteAreaSurcharge

double

Remote Area Surcharge

Remote area surcharge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.

geCustomerCurrencyCode

string

Customer Currency Code

3-char ISO code for the currency selected by the end customer for the order payment

geTotalPrice

double

Total Price

Total order price in the currency denoted by CurrencyCode

geTransactionCurrencyCode

string

Transaction Currency Code

3-char ISO code for the currency actually used for the current order payment. TransactionCurrencyCode may differ from CurrencyCode if the currency selected by the end customer could not be used with the selected payment method

geTransactionTotalPrice

double

Transaction Total Price

Total order price actually paid by the end customer in the currency denoted by TransactionCurrencyCode

geTotalShippingPrice

double

Total Shipping Price

Total shipping price in the currency denoted by CurrencyCode

geSameDayDispatch

boolean

Same Day Dispatch

Indicates if the end customer has requested “Same Day Dispatch” on Global‑e checkout

geSameDayDispatchCost

double

Same Day Dispatch Cost

Cost of 'Same Day Dispatch' option (if selected by the end customer on Global-E checkout), in the currency denoted by CurrencyCode. This value is NOT included in TotalShippingPrice

geDoNotChargeVat

boolean

Do Not Charge VAT

Indicates if the end customer hasn’t been charged VAT in Global‑e checkout, as specified in doNotChargeVAT argument for SendCart method for the cart converted to this order on Global‑e

gePrePayOffered

boolean

PrePay Offered

Indicates if the prepayment option for duties and taxes was offered to the customer

geIsReplacementOrder

boolean

Is Replacement Order

Indicates if the order is replacement

geOriginalOrderNumber

string

Original Order Global‑e Order Number

Global‑e order unique identifier for the Original order

geOriginalMerchantOrderNumber

string

Original Order Merchant Order Number

OrderId returned from SendOrderToMerchant call for the Original order

geOriginalMerchantInternalOrderNumber

string

Original Order Merchant Internal Order Number

InternalOrderId returned from SendOrderToMerchant call for the Original order

geTotalDutiesPrice

double

Total Duties Price

Total Duties and Taxes value including Customs Clearance Fees, in the currency denoted by Customer Currency Code

geTotalDutiesAndTaxesPrice

double

Total Duties and Taxes Price in Merchant Currency

Total Duties & Taxes value including Customs Clearance Fees, in the merchant currency. This amount is the total amount, regardless whether customer or the merchant paid it.

geDutiesAndTaxesSubsidy

double

Duties And Taxes Subsidy

Value of Duties and Taxes subsidized as part of product price in Merchant’s Currency

geTotalProductsNetPrice

double

Total Products Net Price

Value of products after deduction of duties and taxes subsidies in Merchant’s Currency

geCcfPrice

double

CCF Price

Customs Clearance Fees (CCF), in the merchant currency

geTotalCcfPrice

double

Total CCF Price

Total Customs Clearance Fees value in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice

geDutiesGuaranteed

boolean

Is Duties Guaranteed

Indicates if the end customer has selected the 'guaranteed duties and taxes' option.

geOrderWaybillNumber

string

Order Waybill Number

Waybill number used by the selected international shipping method for this order

geCashOnDeliveryFee

double

CashOnDeliveryFee

Additional charge paid by the end customer when “Cash on Delivery” payment method has been selected.

geTotalVatAmount

double

Total VAT Amount

Amount of VAT paid by the customer to Global‑e

geShippingMethodStatusCode

string

Shipping Method Status Code

Code denoting the selected shipping status as defined on the Merchant’s site (to be mapped on Global‑e side). If this shipping status doesn’t exist on the Merchant’s site, the internal Global‑e shipping status code will be specified instead

geShippingMethodStatusName

string

Shipping Method Status Name

Name of the shipping status

geTotalDiscountedShippingPrice

double

Total Discounted Shipping Price

The price paid by customer in local currency. Total Shipping price reducing Order Discounts International price.

geDiscountedShippingPriceMerchantCurrency

double

Discounted Shipping Price In Merchant Currency

The shipping price paid by the customer converted to the merchant’s currency. Total Shipping price reducing Order Discounts (InternationalDetails.DiscountedShippingPrice price converted to the merchant currency)

geShippingSubsidy

double

Shipping Subsidy

Shipping Subsidy

geShippingVATRate

double

Shipping VAT Rate

Shipping VAT rate for customer. This rate is applied on the shipping cost.

geMerchantShippingVATRate

double

Merchant Shipping VAT Rate

Merchant Shipping VAT rate. This rate is applied on the shipping cost between Global‑e and a Merchant.

gePaymentMethodName

string

Payment method name

Name of the selected payment method.

gePaymentMethodCode

string

Payment method code

Code denoting the selected payment method as defined on the Merchant’s site (to be mapped on Global‑e side). If this payment method doesn’t exist on the Merchant’s site, the internal Global‑e payment method code will be specified instead.

geShippingAddress1

string

Shipping Address 1

Shipping Address line 1

geShippingAddress2

string

Shipping Address 2

Shipping Address line 2

geShippingCity

string

Shipping City

Shipping City name

geShippingCityRegion

string

City Region

Shipping City Region

geShippingCompany

string

Shipping Company

Shipping Company name

geShippingCountryCode

string

Shipping Country code

Shipping Country code

geShippingCountryName

string

Shipping Country name

Shipping Country name

geShippingEmail

string

Shipping Email

Shipping Email address

geShippingFax

string

Shipping Fax

Shipping Fax

geShippingFirstName

string

Shipping FIrst name

Shipping First nam

geShippingLastName

string

Shipping Last nam

Shipping Last name

geShippingMiddleName

string

Shipping Middle name

Shipping Middle name

geShippingPhone1

string

Shipping Phone 1

Shipping Phone 1

geShippingPhone2

string

Shipping Phone 2

Shipping Phone 2

geShippingSalutation

string

Shipping Salutation

Shipping Salutation

geShippingStateCode

string

Shipping State code

Shipping State code

geShippingStateOrProvince

string

Shipping State or province

Shipping State or province

geShippingZip

string

Shipping Zip

Shipping Zip code

geBillingAddress1

string

address 1

Address line 1

geBillingAddress2

string

address 2

Address line 2

geBillingCity

string

city

City name

geBillingCityRegion

string

City Region

Billing City Region

geBillingCompany

string

company

Company name

geBillingCountryCode

string

country code

2-char ISO country code

geBillingCountryName

string

country name

Country name

geBillingEmail

string

email

E-mail address

geBillingFax

string

fax

Fax

geBillingFirstName

string

first name

First name

geBillingLastName

string

Last name

Last name

geBillingMiddleName

string

middle name

Middle name

geBillingPhone1

string

phone 1

Phone 1

geBillingPhone2

string

phone 2

Phone 2

geBillingSalutation

string

salutation

Salutation

geBillingStateCode

string

state code

State code

geBillingStateOrProvince

string

state or province

State or province

geBillingZip

string

Zip

Zip code

geCustomerShippingAddress1

string

Address1

Address1

geCustomerShippingAddress2

string

Address2

Address2

geCustomerShippingCity

string

City

City

geCustomerShippingCityRegion

string

City Region

City Region

geCustomerShippingCompany

string

Company

Company

geCustomerShippingCountryCode

string

Country code

Country code

geCustomerShippingCountryName

string

Country name

Country name

geCustomerShippingEmail

string

Email

Email

geCustomerShippingFax

string

Fax

Fax

geCustomerShippingFirstName

string

First name

First name

geCustomerShippingLastName

string

Last name

Last name

geCustomerShippingMiddleName

string

Middle name

Middle name

geCustomerShippingPhone1

string

Phone1

Phone1

geCustomerShippingPhone2

string

Phone2

Phone2

geCustomerShippingSalutation

string

Salutation

Salutation

geCustomerShippingStateCode

string

State code

State code

geCustomerShippingStateOrProvince

string

State or province

State or province

geCustomerShippingZip

string

Zip

Zip

geCustomerBillingAddress1

string

Address1

Address1

geCustomerBillingAddress2

string

Address2

Address2

geCustomerBillingCity

string

City

City

geCustomerBillingCityRegion

string

City Region

City Region

geCustomerBillingCompany

string

Company

Company

geCustomerBillingCountryCode

string

Country code

Country code

geCustomerBillingCountryName

string

Country name

Country name

geCustomerBillingEmail

string

Email

Email

geCustomerBillingFax

string

Fax

Fax

geCustomerBillingFirstName

string

First name

First name

geCustomerBillingLastName

string

Last name

Last name

geCustomerBillingMiddleName

string

Middle name

Middle name

geCustomerBillingPhone1

string

Phone1

Phone1

geCustomerBillingPhone2

string

Phone2

Phone2

geCustomerBillingSalutation

string

Salutation

Salutation

geCustomerBillingStateCode

string

State code

State code

geCustomerBillingStateOrProvince

string

State or province

State or province

geCustomerBillingZip

string

Zip

Zip

gePdOwnerFirstName

string

PD Owner first name

PD Owner first name

gePdOwnerLastName

string

PD Owner last name

PD Owner last name

gePdOwnerName

string

PD Owner name

PD Owner name

gePdPaymentMethodCode

string

PD Payment method code

PD Payment method code

gePdPaymentMethodName

string

PD Payment method name

PD Payment method name

gePdCountryCode

string

PD Country code

PD Country code

gePdCountryName

string

PD Country name

PD Country name

gePdEmail

string

PD Email

PD Email

gePdExpirationDate

password

PD Expiration Date

PD Expiration Date

gePdFax

string

PD Fax

PD Fax

gePdStateCode

string

PD State code

PD State code

gePdStateOrProvince

string

PD State or province

PD State or province

gePdCity

string

PD City

PD City

gePdZip

string

PD Zip

PD Zip

gePdAddress1

string

PD Address1

PD Address1

gePdAddress2

string

PD Address2

PD Address2

gePdPhone1

string

PD Phone1

PD Phone1

gePdPhone2

string

PD Phone2

PD Phone2

gePdPaymentMethodTypeCode

string

PD Payment method type code

PD Payment method type code

gePdCardNumber

password

PD Card Number

PD Card Number

gePdCvvNumber

password

PD CVV Number

PD CVV Number

geSuppressPersonalInformation

boolean

Is Suppress Personal Information (GDPR)

Is Suppress Personal Information (GDPR)

geOrderDocuments

text

Order Documents

The list of possible order documents. There possible values In format(DocumentTypeName = DocumentTypeCode):

  • Commercialnvoice = 1

  • PackingList = 2

  • ShipperManifest = 3

  • Label = 4

  • VATInvoice = 5

  • DangerousGoodDeclarationLink = 6

  • GELabel = 7

  • CustomerReceiptInvoice = 8

geUSSalesTax

double

Sales tax value for USA

Sales tax value for USA in the merchant currency. This value is included in TotalDutiesAndTaxesPrice.

geCashOnDeliveryFeeMc

double

CashOnDeliveryFee (Merchant currency)

Additional charge paid by the end customer when “Cash on Delivery” payment method has been selected.

geCustomerUSSalesTax

double

Sales tax value for USA

Sales tax value for USA in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice.

geNonProductTotalSubsidy

double

Order DTSubsidy in Merchant currency

Order DTSubsidy in Merchant currency

geInternationalNonProductTotalSubsidy

double

Order DTSubsidy in Customer currency

Order DTSubsidy in Customer currency

geOrderCreationSource

number

Order Creation Sourse

Order Creation Sourse

The possible values:

  • 0 - Global‑e checkout

  • 1 - Marketplace

geIsTaxExemption

boolean

Is Tax Exemption

Indication if the order has tax exemption

geCookieConsent

string

Customer Cookie Consent

The possible values:

  • 0 - No consent

  • 1 - Consent to all cookies

  • 2 - Consent to the essential cookies only

geIsOrderCreatedFallbackScenario

boolean

Is Order Created Fallback Scenario

SFCC order is created from a fallback scenario(when a new SFCC basket is generated from the SOTM payload)

geIsGiftWrappingRequired

boolean

Is Gift Wrapping Required

Indication if the order has Gift Wrapping

geOrderType

enum-of-string

Global-e Order Type

Indication if the SFCC order type created via Global-e checkout

geMixedOrdersMainOrderID

string

Main Order ID

Used/filled only with “Mixed Orders“ feature. Contains the Global-e order number of main order.

geMixedOrdersSubOrdersIDs

string

Sub Orders IDs

Used/filled only with “Mixed Orders“ feature. Contains the Global-e order numbers of sub orders.

geMixedOrdersSuccessfullyUpdated

boolean

All Mixed Orders Successfully Updated

Used/filled only with “Mixed Orders“ feature.

The value is set to TRUE only if all main and sub order were succesfully updated on SOTM request from the Global-e

Order Address

ID

Type

Name

Description

geDeliveryStoreId

string

Delivery Store ID

Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on Global‑e side)

geVATRegistrationNumber

string

Customer VAT registration Number

Customer VAT registration Number if provided in cart / checkout or Global‑e importer entity registration number for relevant markets (eg. Switzerland)

geCustomerTaxId

string

Customer Tax number

Customer Tax number provided at checkout as required for clearance into certain markets

geCityRegion

string

City Region

City Region

Customer Address

ID

Type

Name

Description

geCityRegion

string

City Region

City Region

Product Line Item

ID

Type

Name

Description

geCartItemOptionId

string

Cart item option ID

Identifier of the child cart item “option” on the Merchant’s site originally specified in Product.CartItemOptionId property of the respective product in SendCart method for the cart converted to this order on Global‑e.

geInternationalPrice

double

International Price

Single product final sale price in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable) and IncludeVAT handling

geDiscountedPrice

double

Discounted Price

The product value in merchant currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as pre-calculated value for returned product’s refund.

geInternationalDiscountedPrice

double

International Discounted Price

The product value in customer currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as pre-calculated value for returned product’s refund.

geInternationalDiscountedPriceInMerchantCurrency

double

International Discounted Price in merchant currency

International Discounted Price in merchant currency

geParentCartItemId

string

Parent cart item ID

Identifier of the current item’s parent cart item on the Merchant’s site originally specified in Product.ParentCartItemId property of the respective product in SendCart method for the cart converted to this order on Global‑e.

gePrice

double

Price

Single product final sale price in currency defined in geCurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant

gePriceBeforeGlobaleDiscount

double

Price Before Global‑e Discount (DEPRECATED)

Single product price in currency defined in CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant, before applying any per-product Global‑e discounts (such as per-product Shipping discounts). If no Global‑e discount was applied, PriceBeforeGlobalEDiscount is equal to Price.

gePriceBeforeRoundingRate

double

Price BeforeRounding Rate

Price BeforeRounding Rate

geVatRate

double

VAT Rate

VAT rate applied to this product (decimal point rate eg. "0.2" for 20%)

geCustomerVATRate

double

Customer VAT Rate

Customer VAT Rate applied to this product (raw rate eg. "20" for 20%)

geRoundingRate

string

Global‑e Rounding Rate

Conversion rate applied to this product’s price paid by the end customer, when calculating the prices paid by Global‑e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors.

geOriginalPriceBookTotalPrice

double

Original Price Book Total Price

Original Price Book Total Price

geDiscountedPriceForCustoms

double

Original Discounted Price for Customs

Product price in merchant currency reflects the price after Reverse D&T calculation

geInternationalDiscountedPriceForCustoms

double

International Discounted Price for Customs

Product price in customer currency reflects the price after Reverse D&T calculation

geListPrice

double

Original List Price

Single product List price in currency defined in geCurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant

geInternationalListPrice

double

International List Price

Single product list price in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable) and IncludeVAT handling

geLineItemInternationalPrice

double

Line Item International Price

Line item (product in ordered quantity) price in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable) and IncludeVAT handling. If not specified, should be deemed equal to “InternationalPrice * Quantity”. If specified, should take preference over InternationalPrice.

geIsBackOrdered

boolean

Is Back Ordered

Boolean specifying if the product was ordered as a backed ordered item

geBackOrderDate

string

Back Order Date

Estimated date for the backordered item to be in stock

geIsGiftCard

boolean

Is Globale Gift Card

Specifies that the product line items is a 'gift card'

geProductSubsidy

double

Product DTSubsidy in Merchant currency

Product DTSubsidy in Merchant currency

geInternationalProductSubsidy

double

Product DTSubsidy in customer currency

Product DTSubsidy in customer currency

Shipping Method

ID

Type

Name

Description

isGeShippingMethod

boolean

Is Global‑e Shipping Method

Specifies that shipping method is used for Global‑e integration

geCarrier

string

Carrier

Carrier’s short name

geCarrierName

string

Carrier Name

Carrier’s full name

geCarrierTitle

string

Carrier Title

Carrier’s title

Price book

ID

Type

Name

Description

geNotApplicableForDynamic

boolean

Global‑e Not Applicable for Dynamic Countries

Global‑e Not Applicable for Dynamic Countries

geBasePricebook

boolean

Global‑e Base Price Book

Global‑e Base Price Book

geFixedPricebook

boolean

Global‑e Fixed Price Book

Global‑e Fixed Price Book

geApplicableToCountries

set-of-string

Applicable To Countries

Global-E operated countries to which the price book is applicable

geApplicableToCurrencies

set-of-string

Applicable To Currencies

Global-E operated country currencies to which the price book is applicable

geApplicableToMerchantId

string

Applicable to Merchant ID

Allows to apply the price book to some specific merchant ID (should be used only if multiple GE accounts are used in the same SFCC instance).

geCachePriceBook

boolean

Global-e Cache Price Book

Identifies if a price book is used for caching purposes.

geCachePriceBookCombinations

string

Global-e Cache Price Book Combinations

Global-E country/currency combinations to which the price book is applicable.

Payment Transaction

ID

Type

Name

Description

geAmountCustomerCurrency

double

Amount In Customer Currency

Payment amount In Customer Currency

gePaymentMethodType

enum-of-string

Payment method name

Global-e Payment Method Type

Possible values:

  • GlobalePayment

  • GlobaleGiftCard

  • GlobaleLoyaltyCard

gePaymentMethodName

string

Payment method name

Name of the selected payment method

gePaymentDetails

text

Payment Details

Global-e Payment Details

geAlternativePaymentDetails

text

Alternative Payment Details

Global-e Alternative Payment Details

Gift Certificate

ID

Type

Name

Description

currentBalance

double

Current Balance

Current balance of the card

geCurrencyCode

string

International Currency Code

Customer currency code of the card

geInternationalPrice

double

International Price

Price in end customer’s currency, after applying country coefficient, FX conversion, and rounding rule (if applicable).

initialBalance

double

Initial Balance

Initial balance of the card.

redeemRequestJSON

text

Redeem Request JSON

Used as a storage and contains information about redeem requests(between Global-e and SFCC) of the card.

redeemResponseJSON

text

Redeem Response JSON

Used as a storage and contains information about redeem responses(between Global-e and SFCC) of the card.

refundRequestJSON

text

Refund Request JSON

Used as a storage and contains information about refund requests(between Global-e and SFCC) of the card.

refundResponseJSON

text

Refund Response JSON

Used as a storage and contains information about refund responses(between Global-e and SFCC) of the card.

originalCurrencyCode

string

Currency Code

Currency code of the card (should be the same as GC’s currency code in “General” tab”).

Gift Certificate Line Item

ID

Type

Name

Description

geCartItemId

string

Cart item ID

Identifier of the cart item on the Merchant’s site originally specified in Product.CartItemId property of the respective product in SendCart method for the cart converted to this order on Global-e.geCartItemOptionId.

geCartItemOptionId

string

Cart item option ID

Identifier of the child cart item “option” on the Merchant’s site originally specified in Product.CartItemOptionId property of the respective product in SendCart method for the cart converted to this order on Global-e.

geInternationalPrice

double

International Price

Single gift cart final sale price in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order).

geDiscountedPrice

double

Discounted Price

The product value in merchant currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as pre-calculated value for returned product’s refund.

geInternationalDiscountedPrice

double

International Discounted Price

The product value in customer currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as pre-calculated value for returned product’s refund.

geParentCartItemId

string

Parent cart item ID

Identifier of the current item’s parent cart item on the Merchant’s site originally specified in Product.ParentCartItemId property of the respective product in SendCart method for the cart converted to this order on Global-e.

gePrice

double

Price

Used as a storage and contains information about refund requests(between Global-e and SFCC) of the card.

gePriceBeforeGlobaleDiscount

double

Price Before Global-e Discount (DEPRECATED)

Single product price in currency defined in CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant, before applying any per-product Global-e discounts (such as per-product Shipping discounts). If no Global-e discount was applied, PriceBeforeGlobalEDiscount is equal to Price.

gePriceBeforeRoundingRate

double

Price BeforeRounding Rate

Price BeforeRounding Rate.

geVatRate

double

VAT Rate

VAT rate applied to this product (decimal point rate eg. "0.2" for 20%).

geCustomerVATRate

double

Customer VAT Rate

Customer VAT Rate applied to this product (raw rate eg. "20" for 20%).

geRoundingRate

string

Global-e Rounding Rate

Conversion rate applied to this product’s price paid by the end customer, when calculating the prices paid by Global-e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors.

geOriginalPriceBookTotalPrice

double

Original Price Book Total Price

Original Price Book Total Price

geDiscountedPriceForCustoms

double

Original Discounted Price for Customs

Product price in merchant currency reflects the price after Reverse D&T calculation.

geInternationalDiscountedPriceForCustoms

double

International Discounted Price for Customs

Product price in customer currency reflects the price after Reverse D&T calculation.

geListPrice

double

Original List Price

Single product List price in currency defined in geCurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant.

geInternationalListPrice

double

International List Price

Single product list price in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable) and IncludeVAT handling

geLineItemInternationalPrice

double

Line Item International Price

Line item (product in ordered quantity) price in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable) and IncludeVAT handling. If not specified, should be deemed equal to “InternationalPrice * Quantity”. If specified, should take preference over InternationalPrice.

geIsBackOrdered

boolean

Is Back Ordered

Boolean specifying if the product was ordered as a backed ordered item.

geBackOrderDate

string

Back Order Date

Estimated date for the backordered item to be in stock.

geIsGiftCard

boolean

Is Globale Gift Card

Specifies that the product line items is a 'gift card'.

geProductSubsidy

double

Product DTSubsidy in Merchant currency

Product DTSubsidy in Merchant currency.

geInternationalProductSubsidy

double

Product DTSubsidy in customer currency

Product DTSubsidy in customer currency

Organization Preferences

ID

Type

Name

Description

Default Value

geLanguagesConfiguration

text

Global‑e Languages Selector Configuration

The preference specifies the configuration of language selector in Global-e Country Switcher.

-

Profile

ID

Type

Name

Description

Default Value

geSalutation

enum-of-int

Salutation

Salutation

0 (None)

Shipping Methods

Note that the following list of Shipping Methods is not the real Global-e Shipping Methods, it is needed only for Salesforce B2C Commerce Digital as a placeholder to be able to Create/Place SFCC Order.

Despite some Shipping Method filtering logic in Global-e cartridge, by default, the Global-e Shipping Method is not configured to be restricted to your local/domestic Checkout. Global-e Shipping Methods should not be shown anywhere on your storefront, but we recommend making additional configurations to all of the following Shipping Methods and add to exclusion of your domestic/local (not operated by Global-e) country(ies).

ID

Name

Description

GLOBALE

GLOBALE

Global‑e Generic Shipping (default)

GLOBALE_STANDARD

GLOBALE STANDARD

Global‑e Standard Shipping

GLOBALE_EXPRESS

GLOBALE EXPRESS

Global‑e Express Shipping

GLOBALE_STORE_COLLECTION

GLOBALE STORE COLLECTION

Global‑e Store Collection

GLOBALE_HUB

GLOBALE HUB

Global‑e Shipping via GE Hub

GLOBALE_DIRECT

GLOBALE DIRECT

Global‑e Shipping Direct from Brand Hub

GLOBALE_WYOL

GLOBALE WYOL

Brand own carrier service

Payment Method

Note that the following Payment Method/Processor is not a real Global‑e Payment Method/Processor, it is needed only for Salesforce B2C Commerce Digital as a placeholder to be able to Create/Place SFCC Order. The real data about shipping and payment methods will be stored in custom attributes of the Order.

ID

Name

Payment Processor

GLOBALE

Globale General

GLOBALE

GLOBALE_PAYMENT

Globale Payment

GLOBALE

Services

Global‑e cartridge uses the following Services, which needs to be imported once on Salesforce B2C Commerce Digital (can be also found in metadata folder as globale.services.xml file):

Service

Profile

Credential

Description

Globale-AppSettings

GLOBALE-JOB.LCT

Globale-AppSettings

To retrieve Global-e App Settings and store in GLOBALE_APP_SETTINGS Custom Object

Globale-AppVersion

GLOBALE-JOB.LCT

Globale-AppVersion

To retrieve Global-e App Version and store in GLOBALE_APP_VERSION Custom Object

Globale-Countries

GLOBALE-JOB.LCT

Globale-Countries

To retrieve Global-e Countries and store in GLOBALE_COUNTRIES Custom Object

Globale-CountryCoefficients

GLOBALE-JOB.LCT

Globale-CountryCoefficients

To retrieve Global-e Country Coefficients and store in GLOBALE_COUNTRY_COEFFICIENTS Custom Object

Globale-Currencies

GLOBALE-JOB.LCT

Globale-Currencies

To retrieve Global-e Currencies and store in GLOBALE_CURRENCIES Custom Object

Globale-CurrencyRates

GLOBALE-JOB.LCT

Globale-CurrencyRates

To retrieve Global-e Currency Rates and store in GLOBALE_CURRENCY_RATES Custom Object

Globale-ActiveHubDetails

GLOBALE-JOB.LCT

Globale-ActiveHubDetails

To retrieve Global-e Hub Details and store in GLOBALE_HUB_DETAILS Custom Object

Globale-LocationsDefaultCulturesList

GLOBALE-JOB.LCT

Globale-LocationsDefaultCulturesList

To retrieve Global-e Cultures and store in GLOBALE_CULTURES Custom Object

Globale-RecentProductCountryS

GLOBALE-JOB.HCT

Globale-RecentProductCountryS

To retrieve Global-e Product Restrictions and store them on SFCC Product’s level

Globale-RoundingRules

GLOBALE-JOB.LCT

Globale-RoundingRules

To retrieve Global-e Rounding Rules and store in GLOBALE_ROUNDING_RULES Custom Object

Globale-SendCartV2

GLOBALE-SENDCART

Globale-SendCartV2

Used to send SendCartData data to Global-e, for Global-e Checkout

Globale-CreateOrderRefund

GLOBALE-JOB.LCT

Globale-CreateOrderRefund

Used to send OrderRefundDetails data to Global-e, in case of Refund should be created

Globale-UpdateOrderDispatchV2

GLOBALE-JOB.LCT

Globale-UpdateOrderDispatchV2

Used to send UpdateOrderDispatchRequest data to Global-e, to update Order status and Delivery Quantities for the products on Global-e side

Globale-UpdateOrderStatus

GLOBALE-JOB.LCT

Globale-UpdateOrderStatus

Used to send OrderStatusDetails data to Global-e, to update Order status on Global-e side

Globale-JWT

GLOBALE-JOB.LCT

Globale-JWT

Used to get Global-e JWT token

Globale-ShippingDetails

GLOBALE-JOB.LCT

Globale-ShippingDetails

Used to get ShippingDetails data

Scheduled Jobs

Please note that all Jobs except 'GlobaleSettings' are just a samples, so you might have to extend/customize it according to your business logic/requirements.

Job ID

Description

Step ID

Step Description

GlobaleSettings

Loads the Global‑e Settings in respective SFCC Custom Objects

AppSettings

Loads Global‑e AppSettings

Countries

Loads Global‑e Countries

CountryCoefficients

Loads Global‑e Country Coefficients

Cultures

Loads Global‑e Cultures

Currencies

Loads Global‑e Currencies

CurrencyRates

Loads Global‑e Currency Rates

RoundingRules

Loads Global‑e Rounding Rules

ActiveHubDetails

Loads Global‑e Active Hub Details

LoadRecentProductCountryS

Loads Recent Product Country S data

GenerateCustomObjectsCache

Generates custom SFCC cache for Global‑e CustomObjects

GlobaleOrderNotifications

This job sends the UpdateOrderDispatchV2, GlobaleUpdateRMA, CreateOrderRefund request and the Order status update to Global-e.

UpdateOrderDispatch

Sends the UpdateOrderDispatchV2 request to Global‑e

UpdateOrderStatus

Sends the Order status update to Global‑e

CreateOrderRefund

Sends the CreateOrderRefund request to Global‑e

UpdateRMA

Sends update RMA number from SFCC to Global‑e

GlobaleCatalogFeed

Generates Catalog Feed and sends it to Global‑e SFTP folder

GenerateCatalogFeed

Generates Product Catalog Feed for Global‑e and stores it in IMPEX/globale/catalog/ folder

UploadCatalogFeed

Uploads the generated catalog feed(s) stored in IMPEX/globale/catalog/ folder to SFTP folder configured in GLOBALE Site Preferences

GlobaleRestrictedItemsFeed

Generates Restricted Items Feed and sends it to Global‑e SFTP folder

GenerateRestrictedItemsFeed

Generates Restricted Items file and stores it in IMPEX/* folder

UploadRestrictedItemsFeed

Uploads generated Restricted Items file from IMPEX/* to Global-e SFTP folder