Skip to main content

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 IDSFCC Key AttributeTypeSFCC Attribute NameGlobal‑e API Attribute IDDescription
nameYesStringName-Name of App Setting on Global‑e side
apiVersionNoStringAPIVersionAPIVersionVersion identifier of Global-e API
clientSettingsNoTextClientSettingsClientSettingsDictionary of client-side settings
serverSettingsNoTextServerSettingsServerSettingsDictionary of server-side settings
webClientVersionNoStringWebClientVersionWebClientVersionVersion identifier of Global-e client-side (JS) code
sfccSendCartSendHubIdNoStringSend HubId in SendCartsfccUseGEShippingPriceSend HubId in SendCart Payload
sfccUseGEShippingPriceNoStringUse Global-e Shipping Price (B2B)sfccUseGEShippingPriceUse Global-e Shipping Price (B2B)
sfccWhitelistedServerIpsNoStringWhitelisted Global-e Server IP’ssfccWhitelistedServerIpsA list of IP addresses of Global‑e servers separated by a semicolon (;) that should be whitelisted.
sfccLanguagesConfigurationNoTextLanguages Switcher ConfigurationsfccLanguagesConfigurationThe attribute specifies the configuration of language selector in Global‑e Country Switcher. More details are here: Global‑e_SFCC_Country_Switcher.pdf
sfccCartHashValidationNoTextSFCC Cart Hash ValidationsfccCartHashValidationEnable SFCC Cart Hash Validation
sfccPlaceOrderOnPaymentUpdateNoStringPlace Order On Payment UpdatesfccPlaceOrderOnPaymentUpdateThe 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).
sfccUseFixedPricesOnlyNoStringUse Only Fixed PricessfccUseFixedPricesOnlyThe 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.
sfccCreateNewAddressesFromCheckoutNoStringSave GE AddresssfccCreateNewAddressesFromCheckoutAllows to create and save new addresses from GE checkout
sfccCultureMappingNoTextCulture MappingsfccCultureMappingThe preference allows to override default culture code for Global-e popups/templates.Culture code is used for setting right language.
sfccCheckoutCultureMappingNoTextCheckout Culture MappingsfccCheckoutCultureMappingThe preference allows to override default culture code for Global-e checkout templates.Culture code is used for setting right language.
sfccDynamicCountryCurrencyMappingNoTextDynamic Country/Currency MappingsfccDynamicCountryCurrencyMappingThe preference allows to override default currency code for dynamic price countries
sfccAllowedCurrenciesNoTextAllowed country currenciessfccAllowedCurrenciesAllowed country currencies (price book caching approach)
sfccShippingSwitcherConfigurationNoTextShipping Switcher ConfigurationsfccShippingSwitcherConfigurationShipping Switcher Configuration
sfccDefaultCountryCodeMappingNoTextDefault Country Code MappingsfccDefaultCountryCodeMappingDefault Country Code Mapping
sfccMerchantBaseCurrencyCodeNoStringMerchant Base Currency CodesfccMerchantBaseCurrencyCodeMerchant Base Currency Code (Site default currency is used if empty)
sfccCachePriceBooksConfigNoTextCache Price Books ConfigurationsfccCachePriceBooksConfigCache Price Books Configuration
sfccParseCountryCodeFromRequestLocaleNoStringParse CountryCode from RequestLocalesfccParseCountryCodeFromRequestLocaleUse SFCC locale country code to define shipping country
sfccJWTAuthConfigurationNoTextJWT Authentication ConfigurationsfccJWTAuthConfigurationJWT Authentication Configuration (GE to SFCC)
sfccJWTApiAuthConfigurationNoTextJWT API Authentication ConfigurationsfccJWTApiAuthConfigurationJWT API Authentication Configuration (SFCC to GE)
sfccLocalizationConfigurationNoTextSendCartV2 Localization ConfigurationsfccLocalizationConfigurationAllows to configure localized product data (SendCartV2 API).
sfccUseProductCodeSecondaryInFulfillmentEnabledNoStringSFCC Use ProductCodeSecondary In Fulfilment EnabledsfccUseProductCodeSecondaryInFulfillmentEnabledAllows to use ProductCodeSecondary In Fulfilment instead of ProductCode
sfccKlarnaConfigurationsNoTextSFCC Klarna ConfigurationssfccKlarnaConfigurationsSFCC Klarna OSM Configurations
sfccDoWebStoreValidationNoStringDo WebStore ValidationsfccDoWebStoreValidationDo WebStore Validation

GLOBALE_COUNTRIES

Used to hold cached data from Global-e API /Browsing/Countries.
SFCC Attribute IDSFCC Key AttributeTypeSFCC Attribute NameGlobal‑e API Attribute IDDescription
codeYesStringCodeCode2-char ISO country code
defaultCurrencyCodeNoStringDefaultCurrencyCodeDefaultCurrencyCode3-char ISO currency code
isStateMandatoryNoBooleanIsStateMandatoryIsStateMandatoryTRUE if State or province (region) is mandatory for addresses in this country
isOperatedByGlobalENoBooleanIsOperatedByGlobalEIsOperatedByGlobalETRUE 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
nameNoStringNameNameCountry name
siteUrlNoStringSiteURLSiteURLURL 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”.
useCountryVATNoBooleanUseCountryVATUseCountryVATTRUE 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
defaultVATRateTypeNoStringDefaultVATRateTypeDefaultVATRateTypeDefault (most widely used) VAT rate type or class for this country
supportsFixedPricesNoBooleanSupportsFixedPricesSupportsFixedPricesTRUE if fixed product prices are allowed for this country. Product prices may be fixed only in the Default Currency for this Country
vatExemptionDisabledNoBooleanVATExemptionDisabledVATExemptionDisabledUsed 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 IDSFCC Key AttributeTypeSFCC Attribute NameGlobal‑e API Attribute IDDescription
countryCodeYesStringCountryCodeCountryCode2-char ISO country code
includeVATNoIntegerIncludeVATIncludeVATThis 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
rateNoDoubleRateRateCountry 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 IDSFCC Key AttributeTypeSFCC Attribute NameGlobal‑e API Attribute IDDescription
keyYesStringKeyProductClassCode + ’_’ + CountryCodeThe unique key value for the instance
rateNoDoubleRateRateCountry Coefficient rate decimal value. All the prices displayed to the end customer shipping to the country involved must be multiplied by this value
countryCodeNoStringCountryCodeCountryCode2-char ISO country code
productClassCodeNoStringProductClassCodeProductClassCodeProduct 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 IDSFCC Key AttributeTypeSFCC Attribute NameGlobal‑e API Attribute IDDescription
codeYesStringCountry codeCountryCode2-char ISO country code
regionCodeNoStringRegion CodeRegionCodeRegion code (unique in the respective Country)
cityCodeNoStringCity CodeCityCodeCity code (unique in the respective Region)
isRTLNoBooleanIsRTLCulture.IsRTLTRUE for “right-to-left” languages such as Hebrew and Arabic
localizedNameNoStringLocalized NameCulture.LocalizedNameCulture name in the respective language, such as “עברית” for he-IL (Hebrew-Israel) culture
nameNoStringNameCulture.NameCulture name
cultureNoStringCulture CodeCulture.CodeISO culture code

GLOBALE_CURRENCIES

Used to hold cached data from Global-e API /Browsing/Currencies.
SFCC Attribute IDSFCC Key AttributeTypeSFCC Attribute NameGlobal‑e API Attribute IDDescription
codeYesStringCodeCode3-char ISO currency code
maxDecimalPlacesNoIntegerMaxDecimalPlacesMaxDecimalPlacesNumber 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
nameNoStringNameNameCurrency name
symbolNoStringSymbolSymbolCurrency symbol (e.g. $ for USD)

GLOBALE_CURRENCY_RATES

Used to hold cached data from Global-e API /Browsing/CurrencyRates.
SFCC Attribute IDSFCC Key AttributeTypeSFCC Attribute NameGlobal‑e API Attribute IDDescription
keyYesStringKeySourceCurrencyCode + ’_’ + TargetCurrencyCodeThe unique key value for the instance
rateNoStringRateRateCurrency rate decimal value
sourceCurrencyCodeNoStringSourceCurrencyCodeSourceCurrencyCode3-char ISO currency cod
targetCurrencyCodeNoStringTargetCurrencyCodeTargetCurrencyCode3-char ISO currency code
rateDataNoStringRate DataRateDataCurrency 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 IDSFCC Key AttributeTypeSFCC Attribute NameGlobal‑e API Attribute IDDescription
keyYesStringKeyCurrencyCode [+ ’_’ + CountryCode]The unique key value for the instance
countryCodeNoStringCountryCodeCurrencyCode2-char ISO country code
currencyCodeNoStringCurrencyCodeCurrencyCode3-char ISO currency code
roundingRangesNoTextRoundingRangesRoundingRangesList of decimal ranges and their respective rounding behaviors
roundingRuleIdNoStringRoundingRuleIdRoundingRuleIdRule 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 IDSFCC Key AttributeTypeSFCC Attribute NameGlobal‑e API Attribute IDDescription
keyYesStringKey-The unique key value for the instance
address1NoStringAddress1Address1Address line 1
address2NoStringAddress2Address2Address line 2
cityNoStringCityCityCity name
countryCodeNoStringCountryCodeCountryCode2-char ISO country code
countryNameNoStringCountryNameCountryNameCountry name
emailNoStringEmailEmailE-mail address
faxNoStringFaxFaxFax
hubIDNoStringHubIDHubIdHub identifier on Global‑e system
hubNameNoStringHubNameHubNameName of the Hub
phone1NoStringPhone1Phone1Phone #1
phone2NoStringPhone2Phone2Phone #2
stateCodeNoStringStateCodeStateCodeState or province ISO code such as AZ for Arizona (if applicable)
stateOrProviceNoStringStateOrProviceStateOrProviceState or province name
zipNoStringZipZipZip or postal code

DEMO_GLOBALE_GIFT_CARDS

Used for demo implementation of the ‘Gift Cards’ feature
SFCC Attribute IDSFCC Key AttributeTypeSFCC Attribute NameDescription
cardIDYesStringCard IDCard ID(card number)
currentBalanceNoIntegerCurrent BalanceCurrent balance of the card
initialBalanceNoIntegerInitial BalanceInitial balance of the card
originalCurrencyCodeNoStringCurrency CodeCurrency code of the card
redeemRequestJSONNoTextRedeem Request JSONUsed as a storage and contains information about redeem requests(between Global-e and SFCC) of the card
redeemResponseJSONNoTextRedeem Response JSONUsed as a storage and contains information about redeem responses(between Global-e and SFCC) of the card
refundRequestJSONNoTextRefund Request JSONUsed as a storage and contains information about refund requests(between Global-e and SFCC) of the card
refundResponseJSONNoTextRefund Response JSONUsed 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 IDSFCC Key AttributeTypeSFCC Attribute NameDescription
cardIDYesStringCard IDCard ID(card number)
currentBalanceNoIntegerCurrent BalanceCurrent balance of the card
initialBalanceNoIntegerInitial BalanceInitial balance of the card
originalCurrencyCodeNoStringCurrency CodeCurrency code of the card
redeemRequestJSONNoTextRedeem Request JSONUsed as a storage and contains information about redeem requests(between Global-e and SFCC) of the card
redeemResponseJSONNoTextRedeem Response JSONUsed as a storage and contains information about redeem responses(between Global-e and SFCC) of the card
refundRequestJSONNoTextRefund Request JSONUsed as a storage and contains information about refund requests(between Global-e and SFCC) of the card
refundResponseJSONNoTextRefund Response JSONUsed 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 IDSFCC Key AttributeTypeSFCC Attribute NameDescription
nameYesStringnameName of entity which is used restrictions. There are possible values: ‘brands’, ‘categories’, ‘products’
countriesExclusionsNoTextCountries ExclusionsUsed for storing Countries Exclusions of entities: ‘brands’, ‘categories’
sourceHandlerNoTextSource HandlerUsed 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 IDSFCC Key AttributeTypeSFCC Attribute NameDescription
IDYesstringIDNotification ID
geOrderIdNostringOrder IdSFCC or Global‑e order ID
geNotificationTypeNoenum-of-stringNotification TypePossible values are: OrderStatusUpdate, OrderDispatchUpdate, OrderRefundUpdate, OrderRMAUpdate, OrderRMACreate
geNotificationPayloadNoTextNotification PayloadThe notification payload (JSON stringified object)

System Objects

Product

Used for demo implementation of the ‘Loyalty Cards’ feature
IDTypeNameAttributes Group NameDescription
geCountriesExclusionsstringCountries Exclusionsnot assignedSpecifies the list of countries codes for which the product is restricted(blocked)
geIsForbiddenbooleanGlobal‑e Is ForbiddenGlobal‑e AttributesSpecifies that the product is globally forbidden(for all countries) for selling
geRestrictedCountriesstringGlobal‑e RestrictedCountriesGlobal‑e AttributesSpecifies the list of Global‑e Restricted Countries for the product. Contains the list of countries codes. Example value: AU,UA,IT
geVatRatestextGlobal‑e Vat RatesGlobal‑e AttributesSpecifies 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’: {}}
geIsGiftCardbooleanIs Globale Gift CardGlobal‑e AttributesSpecifies that the product is selling as ‘gift card’ product

Site Preferences

IDTypeNamePreference Group NameDescriptionDefault Value
PurposeConfiguration
geEnabledbooleanGlobal‑e EnabledGlobal‑e SettingsThe preference allows turn on/off Global-e integrationNo (false)
Yes (true)
No (false)
geCookieLifetimeintCookie lifetimenot assignedThe 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
geCookieDomaintextCookie domainnot assignedThe 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”}
-
geClientJsMerchantIdintClient JS Merchant IDGlobal‑e SettingsThe 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)-
geClientJsBaseUrlenum-of-stringGlobal‑e Client JS SDK Base URLGlobal‑e SettingsThe 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)
geClientJsSourcestringClient JS SDK Source (/SOURCE)Global‑e SettingsThe 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
geMerchantGuidstringMerchant GUIDGlobal‑e SettingsThe 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)-
geApiUrlenum-of-stringGlobal‑e API URLGlobal‑e SettingsThe 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)
geDefaultShippingMethodstringGlobal‑e Default Shipping Method IDGlobal‑e SettingsThe 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
geEnableStockReservationbooleanEnable Stock ReservationGlobal‑e SettingsThe 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)
geStockReservationTimeintStock reservation timeGlobal‑e SettingsThe preference specifies the amount of time in minutes for stock to be reserved in Global-e checkoutBy default is not required any configuration. The default value should not be changed without good reason.30
geEnableCartValidationOcapiBasketbooleanEnable CartValidation OCAPI basketGlobal‑e SettingsEnables CartValidation using OCAPI basketNo (false)
Yes (true)
No (false)
geEnableCartValidationErrorsbooleanEnable CartValidation ErrorsGlobal‑e SettingsEnables CartValidation Error popup (in case of non-expected error)No (false)
Yes (true)
No (false)
geAddNotesbooleanAdd Global‑e NotesGlobal‑e SettingsThe 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)
geCatalogFeedConfigtextGlobal‑e Catalog Feed ConfigGlobal‑e Catalog JobsThe preference specifies Global-e Catalog Feed configuration.More details are described here: Global‑e_SFCC_Cartridge_GlobaleCatalogFeed.pdf-
geCatalogFeedLastRundatetimeGlobal‑e CatalogFeed last runnot assignedThis preference contains information about last time run of Global-e Catalog Feed.Not required any configuration.-
geCatalogFeedStartPositionnumberCatalog Feed Start Positionnot assignedThis preference specifices of products iterator start position for Global-e Catalog Feed.By default is used 0.
geRestrictedItemsFeedConfigtextRestricted Items Feed ConfigurationGlobal‑e Catalog JobsThe preference specifies Global-e Restricted Items Feed configuration.More details are described here: Global‑e_SFCC_Cartridge_GlobaleRestrictedItemsFeed-
geRestrictedItemsFeedLastRundatetimeRestricted Items Last Runnot assignedThis preference contains information about last time run of Global-e Restricted Items Feed.Not required any configuration.-
geProductClassCodePropNamestringProduct Class Code Custom Property NameGlobal‑e Product SettingsThe 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-
geProductGroupCodePropNamestringProduct Group Code Property NameGlobal‑e Product SettingsThe 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-
geProductCodeSecondaryPatternstringProduct Code Secondary PatternGlobal‑e Product SettingsThe 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-
geProductGroupCodeSecondaryPatternstringProduct Group Code Secondary PatternGlobal‑e Product SettingsThe 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-
geWeightAttributeKeystringWeight attribute keyGlobal‑e Product SettingsThe 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-
geHeightAttributeKeystringHeight attribute keyGlobal‑e Product SettingsThe 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-
geWidthAttributeKeystringWidth attribute keyGlobal‑e Product SettingsThe 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-
geLengthAttributeKeystringLength attribute keyGlobal‑e Product SettingsThe 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-
geVolumeAttributeKeystringVolume attribute keyGlobal‑e Product SettingsThe 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-
geProductImageViewTypestringProduct Image ViewTypeGlobal‑e Product SettingsThe 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
geParseCountryCodeFromRequestUrlbooleanParse Global‑e Country Code from Request URLGlobal‑e SettingsThe 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 localeNo (false)
Yes (true)
No (false)
geResetCurrencyCodeOnCountryChangebooleanReset Global‑e Currency Code on Country changeGlobal‑e SettingsThe 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)
geSearchableProductsPromotionIdstringSearchable Products Promotion IDGlobal‑e SettingsThe 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.pdfBy 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-
geLoyaltyPromotionSpentPointsFactordoubleGlobal‑e Loyalty Promotion Spent Points Factornot assignedThe 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.-
geLoyaltyPromotionEarnedPointsFactordoubleGlobal‑e Loyalty Promotion Earned Points Factornot assignedThe 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.-
geReturnPortalUrlenum-of-stringReturn Portal URLGlobal‑e SettingsThe 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
Global‑e Staging (https://www2.bglobale.com/Returns/Portal/{returnPortalId}?OrderID={orderNo}&Email={email})
geCustomObjectsCacheSettingstextCustom Objects cache settingsnot assignedThe 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
-
geOCAPIDomainstringOCAPI DomainGlobal‑e OCAPI SettingsThe preference specifies OCAPI domain and is used for Global-e features that work with SFCC OCAPIBy default is not required any configuration.-
geOCAPIVersionstringOCAPI VersionGlobal‑e OCAPI SettingsThe preference specifies OCAPI Version and is used for Global-e features that work with SFCC OCAPIBy default is not required any configuration.-
geOCAPIClientIdpasswordOCAPI ClientIdGlobal‑e OCAPI SettingsThe preference specifies OCAPI ClientId and is used for Global-e features that work with SFCC OCAPIBy default is not required any configuration.-
geRSAPublicKeytextRSA Public KeyGlobal‑e Crypto SettingsThe preference specifies RSA Public Key and is used to Global-e features that work with RSA encryption/decryptionBy default is not required any configuration.-
geRSAPrivateKeytextRSA Private KeyGlobal‑e Crypto SettingsThe preference specifies RSA Private Key and is used to Global-e features that work with RSA encryption/decryptionBy default is not required any configuration.-
geAESPrivateKeytextAES Private KeyGlobal‑e Crypto SettingsThe preference specifies AES Private Key and is used to Global-e features that work with AES encryption/decryptionBy default is not required any configuration.-
geMetadataCustomAttributesset-of-stringMeta Data Custom AttributesGlobal‑e Product SettingsThe 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
-
geTaxJurisdictionIdstringTax Jurisdiction IDGlobal‑e SettingsTax Jurisdiction IDBy default is not required any configuration.
geEnableNativeGiftCertificatesbooleanEnable Native SFCC Gift CertificatesGlobal‑e Auth SettingsEnables Creating And Using Native SFCC Gift CertificatesNo (false)
Yes (true)
No (false)
geUseCustomProductInventoryListsbooleanUse Custom Product Inventory ListsGlobal‑e Auth SettingsThe preference specifies JWT Auth Public Key.JWT Auth Public Key is used to check JWT attached to all GE server-to-server notificationsNo (false)
Yes (true)
No (false)
geWebStoreUUIDstringGlobal-e WebStore UUIDnot assignedGlobal-e WebStore UUID

Organization Preferences

IDTypeNameDescriptionDefault Value
geLanguagesConfigurationtextGlobal‑e Languages Selector ConfigurationThe preference specifies the configuration of language selector in Global-e Country Switcher.-

Promotion

IDTypeNameDescriptionDefault Value
geDiscountTypeenum-of-stringPromotion Discount TypePlease help Global‑e to identify the Promotion Discount Type properly. It helps to calculate Promotional Price properly on Storefront.TYPE_PERCENTAGE: PERCENTAGE
geDoNotConvertbooleanDo not Convert Promotional DiscountFor 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.-
geFreeShippingMethodenum-of-stringGlobal-e Free Shipping MethodAllows Global-e to identify the Free Shipping Method in the checkout.
geLoyaltyPromotionbooleanGlobal‑e Loyalty PromotionIf it is Global‑e Loyalty Promotion - then Global‑e cartridge will treat this Promotion as special promotion in SendCart API.-

Price Adjustment

IDTypeNameDescription
geNamestringDiscount NameDiscount textual description
geDescriptionstringDiscount DescriptionDiscount Description
gePricedoublePriceDiscount value in currency defined in CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant.
geVatRatedoubleVAT RateVAT rate applied to this discount
geLocalVatRatedoubleLocal VAT RateVAT 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.
geInternationalPricedoubleInternational PriceDiscount 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.
geCouponCodestringCoupon CodeMerchant’s coupon code used for this discount (applicable to coupon-based discounts only)
geDiscountCodestringDiscount CodeDiscount code originally specified in Discount.DiscountCode property of the respective discount in SendCart method for the cart converted to this order on Global‑e.
geLoyaltyVoucherCodestringLoyalty Voucher CodeLoyalty 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.
geDiscountTypeintDiscount TypeDiscount type (“Cart”, “Shipping”, etc.), as defined in DiscountTypeOptions enumeration described in Discount class in this document.
geOriginalPriceAdjustmentPricedoubleOriginal Price Adjustment PriceOriginal Price Adjustment Price

Basket

IDTypeNameDescription
geCartTokenstringGlobal‑e Cart TokenThe token exchanged within the SendCart API call to display the Global-e checkout iframe.
geMerchantOrderIdstringGlobal‑e Merchant Order IDReserved SFCC merchant order ID.
geIsOrderCreatedFallbackScenariobooleanIs Order Created Fallback ScenarioSFCC order is created from a fallback scenario(when a new SFCC basket is generated from the SOTM payload).
geBasketCountryCurrencystringGlobal-e Basket Country CurrencyGlobal-e Basket Country Currency.

Order

IDTypeNameDescription
geCartTokenstringGlobal‑e Cart TokenThe token exchanged within the SendCart API call to display the Global-e checkout iframe.
geOrderNumberstringGlobal‑e Order NumberGlobal‑e Order Number
geReceivedOrderStatusUpdatesset-of-stringOrder Status Updates received from Global‑eThe set of strings of the statuses received from Global-e
geOrderCancellationReasonCodestringGlobal‑e Order Cancellation Reason CodeGlobal‑e order cancellation reason code received from Global‑e
geStatusCodestringOrder Status CodeCode denoting the order status on the Merchant’s site (to be mapped on Global‑e side)
geIsSplitOrderbooleanIs Split OrderIndicates if the order should be handled as split order (i.e. without consolidation)
geOtVoucherCodestringOT Voucher CodeOnetime voucher code used to place the order
geOtCurrencyCodestringOT Currency CodeCurrency of the onetime voucher code used to place the order
geOtVoucherAmountdoubleOT Voucher AmountAmount taken off the voucher when applicable
geLoyaltyPointsSpentdoubleLoyalty Points SpentNumber 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)
geLoyaltyPointsEarneddoubleLoyalty Points EarnedNumber 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
geLoyaltyCodestringLoyalty CodeLoyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout
geCustomerCommentstextCustomer CommentsComments text entered by the end customer in Global‑e checkout
geDeliveryStoreIdstringDelivery Store IDDelivery Store ID
geBarCodestringGlobal‑e Bar CodeGlobal‑e Bar Code. The attribute contains - Global‑e Order Number.
geCurrencyCodestringGlobal‑e Currency Code3-char ISO currency code for the order being posted. By default this is set to the original Merchant’s currency
geIsFreeShippingbooleanIs Free ShippingIndicates 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
geFreeShippingCouponCodestringFree Shipping Coupon CodeMerchant’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
geShippingMethodCodestringShipping Method CodeCode 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
gePriceCoefficientRatedoublePrice Coefficient RateCountryCoefficient rate applied to the prices in this order
geAllowEmailsFromMerchantbooleanAllow Emails from MerchantIndicates if the end customer has opted on Global‑e checkout to receive emails from the Merchant.
geAllowDirectCommunicationFromMerchantbooleanAllow Direct Communication from MerchantIndicates if the end customer has opted on Global‑e checkout to receive direct communication from the Merchant.
geCartIdstringCart IDIdentifier 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.
geRoundingRatestringGlobal‑e Rounding RateAverage 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
geTotalCustomerDiscountsdoubleTotal Customer DiscountsTotal customer discounts for Cart and Loyalty type discounts
geTotalDutiesPaidByCustomerPricedoubleTotal Duties Paid By CustomerThe Duties paid by customer (in merchant currency) for Duties as they were shown in checkout
geOrderTrackingNumberstringOrder Tracking NumberTracking number used by the selected international shipping method for this order.
geOrderTrackingUrlstringOrder Tracking URLFull tracking URL including OrderTrackingNumber used by the selected international shipping method for this order.
geShippingMethodNamestringShipping Method NameName of the selected international shipping method.
geShippingMethodTypeCodestringShipping Method Type CodeCode 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.
geShippingMethodTypeNamestringShipping Method Type NameName of the selected international shipping method type.
geOrderDeliveryDatestringGlobal‑e Order Delivery DateGlobal‑e Order Delivery Date
geDeliveryDaysFromintDelivery Days FromMinimum number of days for delivery to the end customer for the selected shipping method.
geDeliveryDaysTointDelivery Days ToMaximum number of days for delivery to the end customer for the selected shipping method.
geConsignmentFeedoubleConsignment FeeConsignment fee paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.
geSizeOverchargeValuedoubleSize Overcharge ValueOversized items charge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.
geRemoteAreaSurchargedoubleRemote Area SurchargeRemote area surcharge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.
geCustomerCurrencyCodestringCustomer Currency Code3-char ISO code for the currency selected by the end customer for the order payment
geTotalPricedoubleTotal PriceTotal order price in the currency denoted by CurrencyCode
geTransactionCurrencyCodestringTransaction Currency Code3-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
geTransactionTotalPricedoubleTransaction Total PriceTotal order price actually paid by the end customer in the currency denoted by TransactionCurrencyCode
geTotalShippingPricedoubleTotal Shipping PriceTotal shipping price in the currency denoted by CurrencyCode
geSameDayDispatchbooleanSame Day DispatchIndicates if the end customer has requested “Same Day Dispatch” on Global‑e checkout
geSameDayDispatchCostdoubleSame Day Dispatch CostCost 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
geDoNotChargeVatbooleanDo Not Charge VATIndicates 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
gePrePayOfferedbooleanPrePay OfferedIndicates if the prepayment option for duties and taxes was offered to the customer
geIsReplacementOrderbooleanIs Replacement OrderIndicates if the order is replacement
geOriginalOrderNumberstringOriginal Order Global‑e Order NumberGlobal‑e order unique identifier for the Original order
geOriginalMerchantOrderNumberstringOriginal Order Merchant Order NumberOrderId returned from SendOrderToMerchant call for the Original order
geOriginalMerchantInternalOrderNumberstringOriginal Order Merchant Internal Order NumberInternalOrderId returned from SendOrderToMerchant call for the Original order
geTotalDutiesPricedoubleTotal Duties PriceTotal Duties and Taxes value including Customs Clearance Fees, in the currency denoted by Customer Currency Code
geTotalDutiesAndTaxesPricedoubleTotal Duties and Taxes Price in Merchant CurrencyTotal 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.
geDutiesAndTaxesSubsidydoubleDuties And Taxes SubsidyValue of Duties and Taxes subsidized as part of product price in Merchant’s Currency
geTotalProductsNetPricedoubleTotal Products Net PriceValue of products after deduction of duties and taxes subsidies in Merchant’s Currency
geCcfPricedoubleCCF PriceCustoms Clearance Fees (CCF), in the merchant currency
geTotalCcfPricedoubleTotal CCF PriceTotal Customs Clearance Fees value in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice
geDutiesGuaranteedbooleanIs Duties GuaranteedIndicates if the end customer has selected the ‘guaranteed duties and taxes’ option.
geOrderWaybillNumberstringOrder Waybill NumberWaybill number used by the selected international shipping method for this order
geCashOnDeliveryFeedoubleCashOnDeliveryFeeAdditional charge paid by the end customer when “Cash on Delivery” payment method has been selected.
geTotalVatAmountdoubleTotal VAT AmountAmount of VAT paid by the customer to Global‑e
geShippingMethodStatusCodestringShipping Method Status CodeCode 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
geShippingMethodStatusNamestringShipping Method Status NameName of the shipping status
geTotalDiscountedShippingPricedoubleTotal Discounted Shipping PriceThe price paid by customer in local currency. Total Shipping price reducing Order Discounts International price.
geDiscountedShippingPriceMerchantCurrencydoubleDiscounted Shipping Price In Merchant CurrencyThe 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)
geShippingSubsidydoubleShipping SubsidyShipping Subsidy
geShippingVATRatedoubleShipping VAT RateShipping VAT rate for customer. This rate is applied on the shipping cost.
geMerchantShippingVATRatedoubleMerchant Shipping VAT RateMerchant Shipping VAT rate. This rate is applied on the shipping cost between Global‑e and a Merchant.
gePaymentMethodNamestringPayment method nameName of the selected payment method.
gePaymentMethodCodestringPayment method codeCode 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.
geShippingAddress1stringShipping Address 1Shipping Address line 1
geShippingAddress2stringShipping Address 2Shipping Address line 2
geShippingCitystringShipping CityShipping City name
geShippingCityRegionstringCity RegionShipping City Region
geShippingCompanystringShipping CompanyShipping Company name
geShippingCountryCodestringShipping Country codeShipping Country code
geShippingCountryNamestringShipping Country nameShipping Country name
geShippingEmailstringShipping EmailShipping Email address
geShippingFaxstringShipping FaxShipping Fax
geShippingFirstNamestringShipping FIrst nameShipping First nam
geShippingLastNamestringShipping Last namShipping Last name
geShippingMiddleNamestringShipping Middle nameShipping Middle name
geShippingPhone1stringShipping Phone 1Shipping Phone 1
geShippingPhone2stringShipping Phone 2Shipping Phone 2
geShippingSalutationstringShipping SalutationShipping Salutation
geShippingStateCodestringShipping State codeShipping State code
geShippingStateOrProvincestringShipping State or provinceShipping State or province
geShippingZipstringShipping ZipShipping Zip code
geBillingAddress1stringaddress 1Address line 1
geBillingAddress2stringaddress 2Address line 2
geBillingCitystringcityCity name
geBillingCityRegionstringCity RegionBilling City Region
geBillingCompanystringcompanyCompany name
geBillingCountryCodestringcountry code2-char ISO country code
geBillingCountryNamestringcountry nameCountry name
geBillingEmailstringemailE-mail address
geBillingFaxstringfaxFax
geBillingFirstNamestringfirst nameFirst name
geBillingLastNamestringLast nameLast name
geBillingMiddleNamestringmiddle nameMiddle name
geBillingPhone1stringphone 1Phone 1
geBillingPhone2stringphone 2Phone 2
geBillingSalutationstringsalutationSalutation
geBillingStateCodestringstate codeState code
geBillingStateOrProvincestringstate or provinceState or province
geBillingZipstringZipZip code
geCustomerShippingAddress1stringAddress1Address1
geCustomerShippingAddress2stringAddress2Address2
geCustomerShippingCitystringCityCity
geCustomerShippingCityRegionstringCity RegionCity Region
geCustomerShippingCompanystringCompanyCompany
geCustomerShippingCountryCodestringCountry codeCountry code
geCustomerShippingCountryNamestringCountry nameCountry name
geCustomerShippingEmailstringEmailEmail
geCustomerShippingFaxstringFaxFax
geCustomerShippingFirstNamestringFirst nameFirst name
geCustomerShippingLastNamestringLast nameLast name
geCustomerShippingMiddleNamestringMiddle nameMiddle name
geCustomerShippingPhone1stringPhone1Phone1
geCustomerShippingPhone2stringPhone2Phone2
geCustomerShippingSalutationstringSalutationSalutation
geCustomerShippingStateCodestringState codeState code
geCustomerShippingStateOrProvincestringState or provinceState or province
geCustomerShippingZipstringZipZip
geCustomerBillingAddress1stringAddress1Address1
geCustomerBillingAddress2stringAddress2Address2
geCustomerBillingCitystringCityCity
geCustomerBillingCityRegionstringCity RegionCity Region
geCustomerBillingCompanystringCompanyCompany
geCustomerBillingCountryCodestringCountry codeCountry code
geCustomerBillingCountryNamestringCountry nameCountry name
geCustomerBillingEmailstringEmailEmail
geCustomerBillingFaxstringFaxFax
geCustomerBillingFirstNamestringFirst nameFirst name
geCustomerBillingLastNamestringLast nameLast name
geCustomerBillingMiddleNamestringMiddle nameMiddle name
geCustomerBillingPhone1stringPhone1Phone1
geCustomerBillingPhone2stringPhone2Phone2
geCustomerBillingSalutationstringSalutationSalutation
geCustomerBillingStateCodestringState codeState code
geCustomerBillingStateOrProvincestringState or provinceState or province
geCustomerBillingZipstringZipZip
gePdOwnerFirstNamestringPD Owner first namePD Owner first name
gePdOwnerLastNamestringPD Owner last namePD Owner last name
gePdOwnerNamestringPD Owner namePD Owner name
gePdPaymentMethodCodestringPD Payment method codePD Payment method code
gePdPaymentMethodNamestringPD Payment method namePD Payment method name
gePdCountryCodestringPD Country codePD Country code
gePdCountryNamestringPD Country namePD Country name
gePdEmailstringPD EmailPD Email
gePdExpirationDatepasswordPD Expiration DatePD Expiration Date
gePdFaxstringPD FaxPD Fax
gePdStateCodestringPD State codePD State code
gePdStateOrProvincestringPD State or provincePD State or province
gePdCitystringPD CityPD City
gePdZipstringPD ZipPD Zip
gePdAddress1stringPD Address1PD Address1
gePdAddress2stringPD Address2PD Address2
gePdPhone1stringPD Phone1PD Phone1
gePdPhone2stringPD Phone2PD Phone2
gePdPaymentMethodTypeCodestringPD Payment method type codePD Payment method type code
gePdCardNumberpasswordPD Card NumberPD Card Number
gePdCvvNumberpasswordPD CVV NumberPD CVV Number
geSuppressPersonalInformationbooleanIs Suppress Personal Information (GDPR)Is Suppress Personal Information (GDPR)
geOrderDocumentstextOrder DocumentsThe 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
geUSSalesTaxdoubleSales tax value for USASales tax value for USA in the merchant currency. This value is included in TotalDutiesAndTaxesPrice.
geCashOnDeliveryFeeMcdoubleCashOnDeliveryFee (Merchant currency)Additional charge paid by the end customer when “Cash on Delivery” payment method has been selected.
geCustomerUSSalesTaxdoubleSales tax value for USASales tax value for USA in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice.
geNonProductTotalSubsidydoubleOrder DTSubsidy in Merchant currencyOrder DTSubsidy in Merchant currency
geInternationalNonProductTotalSubsidydoubleOrder DTSubsidy in Customer currencyOrder DTSubsidy in Customer currency
geOrderCreationSourcenumberOrder Creation SourseOrder Creation Sourse
The possible values:
0 - Global‑e checkout
1 - Marketplace
geIsTaxExemptionbooleanIs Tax ExemptionIndication if the order has tax exemption
geCookieConsentstringCustomer Cookie ConsentThe possible values:
0 - No consent
1 - Consent to all cookies
2 - Consent to the essential cookies only
geIsOrderCreatedFallbackScenariobooleanIs Order Created Fallback ScenarioSFCC order is created from a fallback scenario(when a new SFCC basket is generated from the SOTM payload)
geIsGiftWrappingRequiredbooleanIs Gift Wrapping RequiredIndication if the order has Gift Wrapping
geOrderTypeenum-of-stringGlobal-e Order TypeIndication if the SFCC order type created via Global-e checkout
geMixedOrdersMainOrderIDstringMain Order IDUsed/filled only with “Mixed Orders“ feature. Contains the Global-e order number of main order.
geMixedOrdersSubOrdersIDsstringSub Orders IDsUsed/filled only with “Mixed Orders“ feature. Contains the Global-e order numbers of sub orders.
geMixedOrdersSuccessfullyUpdatedbooleanAll Mixed Orders Successfully UpdatedUsed/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

IDTypeNameDescription
geDeliveryStoreIdstringDelivery Store IDCode denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on Global‑e side)
geVATRegistrationNumberstringCustomer VAT registration NumberCustomer VAT registration Number if provided in cart / checkout or Global‑e importer entity registration number for relevant markets (eg. Switzerland)
geCustomerTaxIdstringCustomer Tax numberCustomer Tax number provided at checkout as required for clearance into certain markets
geCityRegionstringCity RegionCity Region

Customer Address

IDTypeNameDescription
geCityRegionstringCity RegionCity Region

Product Line Item

IDTypeNameDescription
geCartItemOptionIdstringCart item option IDIdentifier 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.
geInternationalPricedoubleInternational PriceSingle 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
geDiscountedPricedoubleDiscounted PriceThe 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.
geInternationalDiscountedPricedoubleInternational Discounted PriceThe 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.
geInternationalDiscountedPriceInMerchantCurrencydoubleInternational Discounted Price in merchant currencyInternational Discounted Price in merchant currency
geParentCartItemIdstringParent cart item IDIdentifier 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.
gePricedoublePriceSingle product final sale price in currency defined in geCurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant
gePriceBeforeGlobaleDiscountdoublePrice 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.
gePriceBeforeRoundingRatedoublePrice BeforeRounding RatePrice BeforeRounding Rate
geVatRatedoubleVAT RateVAT rate applied to this product (decimal point rate eg. “0.2” for 20%)
geCustomerVATRatedoubleCustomer VAT RateCustomer VAT Rate applied to this product (raw rate eg. “20” for 20%)
geRoundingRatestringGlobal‑e Rounding RateConversion 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.
geOriginalPriceBookTotalPricedoubleOriginal Price Book Total PriceOriginal Price Book Total Price
geDiscountedPriceForCustomsdoubleOriginal Discounted Price for CustomsProduct price in merchant currency reflects the price after Reverse D&T calculation
geInternationalDiscountedPriceForCustomsdoubleInternational Discounted Price for CustomsProduct price in customer currency reflects the price after Reverse D&T calculation
geListPricedoubleOriginal List PriceSingle product List price in currency defined in geCurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant
geInternationalListPricedoubleInternational List PriceSingle 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
geLineItemInternationalPricedoubleLine Item International PriceLine 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.
geIsBackOrderedbooleanIs Back OrderedBoolean specifying if the product was ordered as a backed ordered item
geBackOrderDatestringBack Order DateEstimated date for the backordered item to be in stock
geIsGiftCardbooleanIs Globale Gift CardSpecifies that the product line items is a ‘gift card’
geProductSubsidydoubleProduct DTSubsidy in Merchant currencyProduct DTSubsidy in Merchant currency
geInternationalProductSubsidydoubleProduct DTSubsidy in customer currencyProduct DTSubsidy in customer currency

Shipping Method

IDTypeNameDescription
isGeShippingMethodbooleanIs Global‑e Shipping MethodSpecifies that shipping method is used for Global‑e integration
geCarrierstringCarrierCarrier’s short name
geCarrierNamestringCarrier NameCarrier’s full name
geCarrierTitlestringCarrier TitleCarrier’s title

Price book

IDTypeNameDescription
geNotApplicableForDynamicbooleanGlobal‑e Not Applicable for Dynamic CountriesGlobal‑e Not Applicable for Dynamic Countries
geBasePricebookbooleanGlobal‑e Base Price BookGlobal‑e Base Price Book
geFixedPricebookbooleanGlobal‑e Fixed Price BookGlobal‑e Fixed Price Book
geApplicableToCountriesset-of-stringApplicable To CountriesGlobal-E operated countries to which the price book is applicable
geApplicableToCurrenciesset-of-stringApplicable To CurrenciesGlobal-E operated country currencies to which the price book is applicable
geApplicableToMerchantIdstringApplicable to Merchant IDAllows 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).
geCachePriceBookbooleanGlobal-e Cache Price BookIdentifies if a price book is used for caching purposes.
geCachePriceBookCombinationsstringGlobal-e Cache Price Book CombinationsGlobal-E country/currency combinations to which the price book is applicable.

Payment Transaction

IDTypeNameDescription
geAmountCustomerCurrencydoubleAmount In Customer CurrencyPayment amount In Customer Currency
gePaymentMethodTypeenum-of-stringPayment method nameGlobal-e Payment Method Type
Possible values:
GlobalePayment
GlobaleGiftCard
GlobaleLoyaltyCard
gePaymentMethodNamestringPayment method nameName of the selected payment method
gePaymentDetailstextPayment DetailsGlobal-e Payment Details
geAlternativePaymentDetailstextAlternative Payment DetailsGlobal-e Alternative Payment Details

Gift Certificate

IDTypeNameDescription
currentBalancedoubleCurrent BalanceCurrent balance of the card
geCurrencyCodestringInternational Currency CodeCustomer currency code of the card
geInternationalPricedoubleInternational PricePrice in end customer’s currency, after applying country coefficient, FX conversion, and rounding rule (if applicable).
initialBalancedoubleInitial BalanceInitial balance of the card.
redeemRequestJSONtextRedeem Request JSONUsed as a storage and contains information about redeem requests(between Global-e and SFCC) of the card.
redeemResponseJSONtextRedeem Response JSONUsed as a storage and contains information about redeem responses(between Global-e and SFCC) of the card.
refundRequestJSONtextRefund Request JSONUsed as a storage and contains information about refund requests(between Global-e and SFCC) of the card.
refundResponseJSONtextRefund Response JSONUsed as a storage and contains information about refund responses(between Global-e and SFCC) of the card.
originalCurrencyCodestringCurrency CodeCurrency code of the card (should be the same as GC’s currency code in “General” tab”).

Gift Certificate Line Item

IDTypeNameDescription
geCartItemIdstringCart item IDIdentifier of the cart item on the Merchant’s site originally specified in Product.CartItemId property of the respective product in SendCartmethod for the cart converted to this order on Global-e.geCartItemOptionId.
geCartItemOptionIdstringCart item option IDIdentifier 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.
geInternationalPricedoubleInternational PriceSingle gift cart final sale price in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order).
geDiscountedPricedoubleDiscounted PriceThe 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.
geInternationalDiscountedPricedoubleInternational Discounted PriceThe 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.
geParentCartItemIdstringParent cart item IDIdentifier 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.
gePricedoublePriceUsed as a storage and contains information about refund requests(between Global-e and SFCC) of the card.
gePriceBeforeGlobaleDiscountdoublePrice 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.
gePriceBeforeRoundingRatedoublePrice BeforeRounding RatePrice BeforeRounding Rate.
geVatRatedoubleVAT RateVAT rate applied to this product (decimal point rate eg. “0.2” for 20%).
geCustomerVATRatedoubleCustomer VAT RateCustomer VAT Rate applied to this product (raw rate eg. “20” for 20%).
geRoundingRatestringGlobal-e Rounding RateConversion 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.
geOriginalPriceBookTotalPricedoubleOriginal Price Book Total PriceOriginal Price Book Total Price
geDiscountedPriceForCustomsdoubleOriginal Discounted Price for CustomsProduct price in merchant currency reflects the price after Reverse D&T calculation.
geInternationalDiscountedPriceForCustomsdoubleInternational Discounted Price for CustomsProduct price in customer currency reflects the price after Reverse D&T calculation.
geListPricedoubleOriginal List PriceSingle product List price in currency defined in geCurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant.
geInternationalListPricedoubleInternational List PriceSingle 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
geLineItemInternationalPricedoubleLine Item International PriceLine 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.
geIsBackOrderedbooleanIs Back OrderedBoolean specifying if the product was ordered as a backed ordered item.
geBackOrderDatestringBack Order DateEstimated date for the backordered item to be in stock.
geIsGiftCardbooleanIs Globale Gift CardSpecifies that the product line items is a ‘gift card’.
geProductSubsidydoubleProduct DTSubsidy in Merchant currencyProduct DTSubsidy in Merchant currency.
geInternationalProductSubsidydoubleProduct DTSubsidy in customer currencyProduct DTSubsidy in customer currency

Organization Preferences

IDTypeNameDescriptionDefault Value
geLanguagesConfigurationtextGlobal‑e Languages Selector ConfigurationThe preference specifies the configuration of language selector in Global-e Country Switcher.-

Profile

IDTypeNameDescriptionDefault Value
geSalutationenum-of-intSalutationSalutation0 (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).
IDNameDescription
GLOBALEGLOBALEGlobal‑e Generic Shipping (default)
GLOBALE_STANDARDGLOBALE STANDARDGlobal‑e Standard Shipping
GLOBALE_EXPRESSGLOBALE EXPRESSGlobal‑e Express Shipping
GLOBALE_STORE_COLLECTIONGLOBALE STORE COLLECTIONGlobal‑e Store Collection
GLOBALE_HUBGLOBALE HUBGlobal‑e Shipping via GE Hub
GLOBALE_DIRECTGLOBALE DIRECTGlobal‑e Shipping Direct from Brand Hub
GLOBALE_WYOLGLOBALE WYOLBrand 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.
IDNamePayment Processor
GLOBALEGlobale GeneralGLOBALE
GLOBALE_PAYMENTGlobale PaymentGLOBALE

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):
ServiceProfileCredentialDescription
Globale-AppSettingsGLOBALE-JOB.LCTGlobale-AppSettingsTo retrieve Global-e App Settings and store in GLOBALE_APP_SETTINGS Custom Object
Globale-AppVersionGLOBALE-JOB.LCTGlobale-AppVersionTo retrieve Global-e App Version and store in GLOBALE_APP_VERSION Custom Object
Globale-CountriesGLOBALE-JOB.LCTGlobale-CountriesTo retrieve Global-e Countries and store in GLOBALE_COUNTRIES Custom Object
Globale-CountryCoefficientsGLOBALE-JOB.LCTGlobale-CountryCoefficientsTo retrieve Global-e Country Coefficients and store in GLOBALE_COUNTRY_COEFFICIENTS Custom Object
Globale-CurrenciesGLOBALE-JOB.LCTGlobale-CurrenciesTo retrieve Global-e Currencies and store in GLOBALE_CURRENCIES Custom Object
Globale-CurrencyRatesGLOBALE-JOB.LCTGlobale-CurrencyRatesTo retrieve Global-e Currency Rates and store in GLOBALE_CURRENCY_RATES Custom Object
Globale-ActiveHubDetailsGLOBALE-JOB.LCTGlobale-ActiveHubDetailsTo retrieve Global-e Hub Details and store in GLOBALE_HUB_DETAILS Custom Object
Globale-LocationsDefaultCulturesListGLOBALE-JOB.LCTGlobale-LocationsDefaultCulturesListTo retrieve Global-e Cultures and store in GLOBALE_CULTURES Custom Object
Globale-RecentProductCountrySGLOBALE-JOB.HCTGlobale-RecentProductCountrySTo retrieve Global-e Product Restrictions and store them on SFCC Product’s level
Globale-RoundingRulesGLOBALE-JOB.LCTGlobale-RoundingRulesTo retrieve Global-e Rounding Rules and store in GLOBALE_ROUNDING_RULES Custom Object
Globale-SendCartV2GLOBALE-SENDCARTGlobale-SendCartV2Used to send SendCartData data to Global-e, for Global-e Checkout
Globale-CreateOrderRefundGLOBALE-JOB.LCTGlobale-CreateOrderRefundUsed to send OrderRefundDetails data to Global-e, in case of Refund should be created
Globale-UpdateOrderDispatchV2GLOBALE-JOB.LCTGlobale-UpdateOrderDispatchV2Used to send UpdateOrderDispatchRequest data to Global-e, to update Order status and Delivery Quantities for the products on Global-e side
Globale-UpdateOrderStatusGLOBALE-JOB.LCTGlobale-UpdateOrderStatusUsed to send OrderStatusDetails data to Global-e, to update Order status on Global-e side
Globale-JWTGLOBALE-JOB.LCTGlobale-JWTUsed to get Global-e JWT token
Globale-ShippingDetailsGLOBALE-JOB.LCTGlobale-ShippingDetailsUsed 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 IDDescriptionStep IDStep Description
GlobaleSettingsLoads the Global‑e Settings in respective SFCC Custom ObjectsAppSettingsLoads Global‑e AppSettings
CountriesLoads Global‑e Countries
CountryCoefficientsLoads Global‑e Country Coefficients
CulturesLoads Global‑e Cultures
CurrenciesLoads Global‑e Currencies
CurrencyRatesLoads Global‑e Currency Rates
RoundingRulesLoads Global‑e Rounding Rules
ActiveHubDetailsLoads Global‑e Active Hub Details
LoadRecentProductCountrySLoads Recent Product Country S data
GenerateCustomObjectsCacheGenerates custom SFCC cache for Global‑e CustomObjects
GlobaleOrderNotificationsThis job sends the UpdateOrderDispatchV2, GlobaleUpdateRMA, CreateOrderRefund request and the Order status update to Global-e.UpdateOrderDispatchSends the UpdateOrderDispatchV2 request to Global‑e
UpdateOrderStatusSends the Order status update to Global‑e
CreateOrderRefundSends the CreateOrderRefund request to Global‑e
UpdateRMASends update RMA number from SFCC to Global‑e
GlobaleCatalogFeedGenerates Catalog Feed and sends it to Global‑e SFTP folderGenerateCatalogFeedGenerates Product Catalog Feed for Global‑e and stores it in IMPEX/globale/catalog/ folder
UploadCatalogFeedUploads the generated catalog feed(s) stored in IMPEX/globale/catalog/ folder to SFTP folder configured in GLOBALE Site Preferences
GlobaleRestrictedItemsFeedGenerates Restricted Items Feed and sends it to Global‑e SFTP folderGenerateRestrictedItemsFeedGenerates Restricted Items file and stores it in IMPEX/* folder
UploadRestrictedItemsFeedUploads generated Restricted Items file from IMPEX/* to Global-e SFTP folder