Documentation Portal

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.

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

sfccFixedCountryCurrencyMapping

No

Text

Fixed Country/Currency Mapping

sfccFixedCountryCurrencyMapping

Allows overriding Global‑e default currency code for fixed price countries

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

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

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

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)

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

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)

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

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

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

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

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

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

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)

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

Purpose

Configuration

geEnabled

boolean

Global‑e Enabled

Global‑e Settings

The preference allows turn on/off Global-e integration

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.

geCookieDomain

text

Cookie domain

not assigned

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

{

"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.

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.

geMerchantGuid

string

Merchant GUID

Global‑e Settings

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.

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.

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)

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)

geEnableCartValidationErrors

boolean

Enable CartValidation Errors

Global‑e Settings

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

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.

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).

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.

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

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.

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.

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

}

-

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:

Example of configuration:

-

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

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

geWebStoreUUID

string

Global-e WebStore UUID

not assigned

Global-e WebStore UUID

geLanguagesConfiguration

text

Global‑e Languages Selector Configuration

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

-

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.

-

geLanguagesConfiguration

text

Global‑e Languages Selector Configuration

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

-