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

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

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)