Generated from repo sources —
metadata/meta/*.xml, metadata/site/*.xml, metadata/services.xml, metadata/jobs.xml, and the cartridge service endpoint map. Do not edit by hand; change the source and regenerate.ge* fields), Hooks (globale.* extension points), Jobs.
System objects
Site Preferences
Global-e Settings
| ID | Display name | Description | Notes |
|---|---|---|---|
| geEnabled | Global-e Enabled | Specifies if Global-e integration is enabled | Default: false |
| geEnableCachePriceBooks | Enable Cache Price Books | Specifies if Global-e cache price books usage is enabled | Default: true |
| geClientJsBaseUrl | Global-e Client JS SDK Base URL | The Base URL for Global-e Client JS SDK | Mandatory |
| geApiUrl | Global-e API Base URL | Base URL for Global-e API outbound calls (for example https://connect.bglobale.com). Service paths are resolved from cartridge defaults or geServiceEndpointConfig. | Mandatory |
| geServiceEndpointConfig | Service Endpoint Config | Per-service endpoint overrides. Keys = SFCC service IDs. Value = relative path or full https URL string, or object { “url”: ”…”, “credentialId”: “Globale-…” } for alternate merchant GUID credential. Empty = cartridge defaults + geApiUrl. | — |
| geEnableStockReservation | Enable Stock Reservation | Reserve basket inventory before Send Cart request | Default: false |
| geStockReservationTime | Stock reservation time | The amount of time in minutes for stock to be reserved in Global-e checkout. default is 30 minutes | Default: 30 |
| geEnableCartValidationCAPIBasket | Enable CartValidation SFCC CAPI basket | Enable CartValidation SFCC CAPI (SCAPI/OCAPI) basket | Default: false |
| geEnableCartValidationErrors | Enable CartValidation Errors | Enables CartValidation Error popup (in case of non-expected error) | Default: false |
| geClientJsMerchantId | Client JS Merchant ID | The Merchant Id that is used to load the welcome popup template. | Mandatory |
| geResetCurrencyCodeOnCountryChange | Reset Global-e Currency Code on Country change | Reset Global-e Currency Code on Country change | Default: false |
| geDefaultShippingMethod | Global-e Default Shipping Method ID | Global-e Default Shipping Method ID | Default: GLOBALE |
| geSearchableProductsPromotionId | Searchable Products Promotion ID | This Promotion ID will be used in searchHelpers.js to filter out the restricted / forbidden products on CLP/PLP or any other search result page. | — |
| geAddNotes | Add Global-e Notes | Whether to add Notes to Order on any Global-e update or not. | Default: true |
| geReturnPortalUrl | Return Portal URL | Return Portal URL | Values: https://www.bglobale.com/Returns/Portal/{returnPortalId}?OrderID={orderNo}&Email={email}, https://web.global-e.com/Returns/Portal/{returnPortalId}?OrderID={orderNo}&Email={email} |
| geTaxJurisdictionId | Tax Jurisdiction ID | Tax Jurisdiction ID | — |
| geUseCustomProductInventoryLists | Use Custom Product Inventory Lists | Use Custom Product Inventory Lists | Default: false |
| geEnableNativeGiftCertificates | Enable Native SFCC Gift Certificates | Enables Creating And Using Native SFCC Gift Certificates | Default: false |
| geCAPIType | Used SFCC CAPI Type | The preference determines the SFCC CAPI (SCAPI/OCAPI) used with the Global-e integration | Values: OCAPI, SCAPI |
| geEnableCouponVerification | Enable Coupon Verification | Enables Coupon Verification in case of a fallback scenario | Default: false |
| geProductWholesalePricePriceBookID | Product Wholesale Price Price Book ID | The ID of the price book to be used for retrieving wholesale price value | — |
| geExpressCheckoutWidgetConfig | Express Checkout Widget Config | Express Checkout Widget Config | — |
| geCheckoutDiscountVoucherMappings | Checkout Discount Voucher Mappings | JSON array of checkout discount voucher mappings. Each entry: { voucherCode, sessionAttribute, sessionValue, promotionId }. Empty or invalid JSON disables mapped codes. | — |
Global-e Product Settings
| ID | Display name | Description | Notes |
|---|---|---|---|
| geProductClassCodePropName | Product Class Code Property ID/Name | The ID/name of the property to check against ProductClassCode for coefficient rate | — |
| geProductGroupCodePropName | Product Group Code Property Name | The name of the custom property containing ProductGroupCode if exists (optional) | — |
| geProductCodeSecondaryPattern | Product Code Secondary Pattern | The pattern of Product Code Secondary property if exists (optional) | — |
| geProductGroupCodeSecondaryPattern | Product Group Code Secondary Pattern | The pattern of Product Group Code Secondary property if exists (optional) | — |
| geProductWholesalePricePropName | Product Wholesale Price Property ID/Name | The ID/name of the property to be used for retrieving wholesale price value | — |
| geWeightAttributeKey | Weight attribute key | — | — |
| geHeightAttributeKey | Height attribute key | — | — |
| geWidthAttributeKey | Width attribute key | — | — |
| geLengthAttributeKey | Length attribute key | — | — |
| geVolumeAttributeKey | Volume attribute key | — | — |
| geProductImageViewType | Product Image ViewType | The ViewType of the image that will be sent to Global-e | Default: large |
| geMetadataCustomAttributes | Meta Data Custom Attributes | The preference contains attributes identifiers of product line items or product that should be set in the metadata array. Format of configuration: attrID or metadataAttrKey:attrID | — |
Global-e OCAPI Settings
| ID | Display name | Description | Notes |
|---|---|---|---|
| geOCAPIDomain | OCAPI Domain | OCAPI Domain | — |
| geOCAPIVersion | OCAPI Version | OCAPI Version | — |
| geOCAPIClientId | OCAPI ClientId | OCAPI ClientId | — |
Global-e SCAPI Settings
| ID | Display name | Description | Notes |
|---|---|---|---|
| geSCAPIOrganizationId | SCAPI Organization Id | — | — |
| geSCAPIShortCode | SCAPI Short Code | — | — |
| geSCAPIVersion | SCAPI Version | — | — |
| geSCAPIRedirectURI | SCAPI Redirect URI | — | Default: http://localhost:3000/callback |
| geSCAPIAuthType | SCAPI Authorization Type | — | Values: PublicClient, PrivateClient |
| geSCAPIClientId | SCAPI ClientId | — | — |
| geSCAPIClientSecret | SCAPI ClientSecret | — | — |
Global-e Crypto Settings
| ID | Display name | Description | Notes |
|---|---|---|---|
| geRSAPublicKey | RSA Public Key | RSA Public Key | — |
| geRSAPrivateKey | RSA Private Key | RSA Private Key | — |
| geAESPrivateKey | AES Private Key | AES Private Key | — |
Global-e Catalog Jobs
| ID | Display name | Description | Notes |
|---|---|---|---|
| geCatalogFeedConfig | Catalog Feed Configuration | Configuration of the SFCC job ‘GlobaleCatalogFeed’ | — |
| geRestrictedItemsFeedConfig | Restricted Items Feed Configuration | Configuration of the SFCC job ‘GlobaleRestrictedItemsFeed’ | — |
Not assigned to an attribute group
| ID | Display name | Description | Notes |
|---|---|---|---|
| geClientJsSource | Client JS SDK Source (/SOURCE) | The Source for Global-e Client JS SDK | Default: /merchant/clientsdk/{merchantId} |
| geCookieDomain | Cookie domain | The domain for which the Global-e cookies are registered. | — |
| geCookieLifetime | Cookie lifetime | The lifetime of the cookie (in seconds) default is one week. | Default: 604800 |
| geLoyaltyPromotionSpentPointsFactor | Global-e Loyalty Promotion Spent Points Factor | 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. | — |
| geLoyaltyPromotionEarnedPointsFactor | Global-e Loyalty Promotion Earned Points Factor | 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. | — |
| geServiceMerchantGuidAuthConfig | Service Merchant GUID Auth Config | Per-service merchantGUID auth mode override. Default header when empty. | — |
Product
Global-e Attributes
| ID | Display name | Description | Notes |
|---|---|---|---|
| geRestrictedCountries | Global-e RestrictedCountries | — | — |
| geIsForbidden | Global-e Is Forbidden | — | — |
| geVatRates | Global-e Vat Rates | — | — |
| geIsGiftCard | Is Globale Gift Card | — | — |
Not assigned to an attribute group
| ID | Display name | Description | Notes |
|---|---|---|---|
| geCountriesExclusions | Countries Exclusions | Specifies the list of countries codes for which the product is restricted(blocked) | — |
Promotion
Global-e Settings
| ID | Display name | Description | Notes |
|---|---|---|---|
| geDiscountType | Promotion Discount Type | Please help Global-e to identify the Promotion Discount Type properly. It helps to calculate Promotional Price properly on Storefront. | Values: AMOUNT, BONUS, BONUS_CHOICE, FIXED_PRICE, FREE, PERCENTAGE, PRICE_BOOK_PRICE, TOTAL_FIXED_PRICE |
| geDoNotConvert | 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 | Global-e Free Shipping Method | Allows Global-e to identify the Free Shipping Method in the checkout. | Values: 1, 2, 3, 4, 5, 6, 7 |
Not assigned to an attribute group
| ID | Display name | Description | Notes |
|---|---|---|---|
| geLoyaltyPromotion | 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. | — |
| geDiscountPrice | Discount Price | Applicable only for the following Promotion Discount Types: AMOUNT | — |
Shipping Method
Global-e Attributes
| ID | Display name | Description | Notes |
|---|---|---|---|
| isGeShippingMethod | Is Global-e Shipping Method | — | Mandatory |
| geCarrier | Carrier | Carrier’s short name | — |
| geCarrierName | Carrier Name | Carrier’s full name | — |
| geCarrierTitle | Carrier Title | Carrier’s title | — |
Product Line Item
Global-e Attributes
| ID | Display name | Description | Notes |
|---|---|---|---|
| geCartItemId | Cart item ID | Identifier of the cart item on the Merchant’s site originally specified in Product.CartItemId property of the respective product in SendCart method for the cart converted to this order on Global-e. | — |
| geCartItemOptionId | Cart item option ID | Identifier of the child cart item “option” on the Merchant’s site originally specified in Product.CartItemOptionId property of the respective product in SendCart method for the cart converted to this order on Global-e. | — |
| geInternationalPrice | International Price | Single product final sale price in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable) and IncludeVAT handling | — |
| geDiscountedPrice | Discounted Price | The product value in merchant currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as pre-calculated value for returned product’s refund. | — |
| geInternationalDiscountedPrice | International Discounted Price | The product value in customer currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as pre-calculated value for returned product’s refund. | — |
| geInternationalDiscountedPriceInMerchantCurrency | International Discounted Price in merchant currency | International Discounted Price in merchant currency | — |
| geParentCartItemId | Parent cart item ID | Identifier of the current item’s parent cart item on the Merchant’s site originally specified in Product.ParentCartItemId property of the respective product in SendCart method for the cart converted to this order on Global-e. | — |
| gePrice | Price | Single product final sale price in currency defined in geCurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant | — |
| gePriceBeforeGlobaleDiscount | Price Before Global-e Discount (DEPRECATED) | Single product price in currency defined in CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant, before applying any per-product Global-e discounts (such as per-product Shipping discounts). If no Global-e discount was applied, PriceBeforeGlobalEDiscount is equal to Price. | — |
| gePriceBeforeRoundingRate | Price BeforeRounding Rate | Price BeforeRounding Rate | — |
| geVatRate | VAT Rate | VAT rate applied to this product | — |
| geCustomerVATRate | Customer VAT Rate | Customer VAT Rate applied to this product | — |
| geProductSubsidy | Product DTSubsidy on Merchant currency | Product DTSubsidy on Merchant currency | — |
| geInternationalProductSubsidy | Product DTSubsidy on Buyer currency | Product DTSubsidy on Buyer currency | — |
| geRoundingRate | Global-e Rounding Rate | Conversion rate applied to this product’s price paid by the end customer, when calculating the prices paid by Global-e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors. | — |
| geOriginalPriceBookTotalPrice | Original Price Book Total Price | Original Price Book Total Price | — |
| geDiscountedPriceForCustoms | Original Discounted Price for Customs | Product price in merchant currency reflects the price after Reverse D&T calculation | — |
| geInternationalDiscountedPriceForCustoms | International Discounted Price for Customs | Product price in customer currency reflects the price after Reverse D&T calculation | — |
| geListPrice | Original List Price | Single product List price in currency defined in geCurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant | — |
| geInternationalListPrice | International List Price | Single product list price in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable) and IncludeVAT handling | — |
| geLineItemInternationalPrice | Line Item International Price | Line item (product in ordered quantity) price in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable) and IncludeVAT handling. If not specified, should be deemed equal to “InternationalPrice * Quantity”. If specified, should take preference over InternationalPrice. | — |
| geIsBackOrdered | Is Back Ordered | Boolean specifying if the product was ordered as a back-ordered item | — |
| geBackOrderDate | Back Order Date | Estimated date for the backordered item to be in stock | — |
| geIsGiftCard | Is Globale Gift Card | — | — |
Price Adjustment
Global-e
| ID | Display name | Description | Notes |
|---|---|---|---|
| geName | Discount Name | Discount textual description | — |
| geDescription | Discount Description | Discount Description | — |
| gePrice | Price | Discount value in currency defined in CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant. | — |
| geVatRate | VAT Rate | VAT rate applied to this discount | — |
| geLocalVatRate | Local VAT Rate | VAT rate that would be applied to this discount if the order was placed by the local customer. This value must be specified if UseCountryVAT for the current Country is TRUE and therefore VATRate property actually denotes the VAT for the target country. | — |
| geInternationalPrice | International Price | Discount value in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion and IncludeVAT handling. | — |
| geCouponCode | Coupon Code | Merchant’s coupon code used for this discount (applicable to coupon-based discounts only) | — |
| geDiscountCode | Discount Code | Discount code originally specified in Discount.DiscountCode property of the respective discount in SendCart method for the cart converted to this order on Global-e. | — |
| geLoyaltyVoucherCode | Loyalty Voucher Code | Loyalty Voucher code originally specified in Discount.LoyaltyVoucherCode property of the respective discount in SendCart method for the cart converted to this order on Global-e. | — |
| geDiscountType | Discount Type | Discount type (“Cart”, “Shipping”, etc.), as defined in DiscountTypeOptions enumeration described in Discount class in this document. | — |
| geOriginalPriceAdjustmentPrice | Original Price Adjustment Price | Original Price Adjustment Price | — |
Price Book
Global-e
| ID | Display name | Description | Notes |
|---|---|---|---|
| geBasePricebook | Global-e Base Price Book | — | — |
| geFixedPricebook | Global-e Fixed Price Book | — | — |
| geApplicableToDynamicCountries | Applicable To Dynamic Countries | Comma-separated Global-E operated countries to which the price book is applicable in dynamic pricing strategy | — |
| geApplicableToFixedCountries | Applicable To Fixed Countries | Comma-separated Global-E operated countries to which the price book is applicable in fixed pricing strategy | — |
| geApplicableToMerchantId | Applicable to Merchant ID | Allows to apply the price book to some specific merchant ID (should be used only if multiple GE accounts are used in the same SFCC instance). | — |
| geApplicableToSiteId | Applicable to Site ID | Allows to apply the price book to some specific Site ID. | — |
| geCachePriceBook | Global-e Cache Price Book | — | — |
Organization Preferences
Global-e
| ID | Display name | Description | Notes |
|---|---|---|---|
| geCachePriceBooksConfiguration | Global-e Cache Price Books Configuration | — | — |
| geShippingSwitcherConfiguration | Global-e Shipping Switcher Configuration | — | — |
Order Address
Global-e Order Address
| ID | Display name | Description | Notes |
|---|---|---|---|
| geCityRegion | City Region | City Region | — |
| geDeliveryStoreId | Delivery Store ID | Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on Global-e side) | — |
| geVATRegistrationNumber | Customer VAT registration Number | Customer VAT registration Number if provided in cart / checkout or Global-e importer entity registration number for relevant markets (eg. Switzerland) | — |
| geCustomerTaxId | Customer Tax number | Customer Tax number provided at checkout as required for clearance into certain markets | — |
Customer Address
Global-e Customer Address
| ID | Display name | Description | Notes |
|---|---|---|---|
| geCityRegion | City Region | City Region | — |
Order
Global-e
| ID | Display name | Description | Notes |
|---|---|---|---|
| geOrderType | Global-e Order Type | Possible values are: SingleOrder, MixedOrdersMainOrder, MixedOrdersSubOrder | Values: SingleOrder, MixedOrdersMainOrder, MixedOrdersSubOrder |
| geCartToken | Global-e Cart Token | The token exchanged within the SendCart API call to display the Global-e checkout iframe. | — |
| geOrderNumber | Global-e Order Number | Global-e order unique identifier | — |
| geIsReplacementOrder | Is Replacement Order | Indicates if the order is replacement | — |
| geOriginalOrderNumber | Original Order Global-e Order Number | Global-e order unique identifier for the Original order | — |
| geOriginalMerchantOrderNumber | Original Order Merchant Order Number | OrderId returned from SendOrderToMerchant call for the Original order | — |
| geOriginalMerchantInternalOrderNumber | Original Order Merchant Internal Order Number | InternalOrderId returned from SendOrderToMerchant call for the Original order | — |
| geBarCode | Global-e BarCode | — | — |
| geCurrencyCode | Global-e Currency Code | 3-char ISO currency code for the order being posted. By default this is set to the original Merchant’s currency | — |
| geTotalDutiesAndTaxesPrice | Total Duties and Taxes Price in Merchant Currency | Total Duties & Taxes value including Customs Clearance Fees, in the merchant currency. This amount is the total amount, regardless whether customer or the merchant paid it. | — |
| geTotalDutiesPaidByCustomerPrice | Total Duties Paid By Customer | The Duties paid by customer (in merchant currency) for Duties as they were shown in checkout. | — |
| geDutiesAndTaxesSubsidy | Duties And Taxes Subsidy | Value of Duties and Taxes subsidized as part of product price in Merchant’s Currency | — |
| geUSSalesTax | Sales tax value for USA | Sales tax value for USA in the merchant currency. This value is included in TotalDutiesAndTaxesPrice. | — |
| geCashOnDeliveryFeeMc | CashOnDeliveryFee (Merchant currency) | Additional charge paid by the end customer when “Cash on Delivery” payment method has been selected. | — |
| geTotalProductsNetPrice | Total Products Net Price | Value of products after deduction of duties and taxes subsidies in Merchant’s Currency | — |
| geShippingSubsidy | Shipping Subsidy | Shipping Subsidy | — |
| geMerchantShippingVATRate | Merchant Shipping VAT Rate | Merchant Shipping VAT rate. This rate is applied on the shipping cost between Global-e and a Merchant. | — |
| geDiscountedShippingPriceMerchantCurrency | Discounted Shipping Price In Merchant Currency | The shipping price paid by the customer converted to the merchant’s currency. Total Shipping price reducing Order Discounts (InternationalDetails.DiscountedShippingPrice price converted to the merchant currency) | — |
| geAllowEmailsFromMerchant | Allow Emails from Merchant | Indicates if the end customer has opted on Global-e checkout to receive emails from the Merchant. | — |
| geAllowDirectCommunicationFromMerchant | Allow Direct Communication from Merchant | Indicates if the end customer has opted on Global-e checkout to receive direct communication from the Merchant. | — |
| geCartId | Cart ID | Identifier of the cart on the Merchant’s site originally specified in geMerchantCartToken argument for SendCart method for the cart converted to this order on Global-e | — |
| geSuppressPersonalInformation | Is Suppress Personal Information (GDPR) | Is Suppress Personal Information (GDPR) | — |
| geIsSplitOrder | Is Split Order | Indicates if the order should be handled as split order (i.e. without consolidation) | — |
| geOtVoucherCode | OT Voucher Code | Onetime voucher code used to place the order | — |
| geOtCurrencyCode | OT Currency Code | Currency of the onetime voucher code used to place the order | — |
| geOtVoucherAmount | OT Voucher Amount | Amount taken off the voucher when applicable | — |
| geOrderDocuments | Order Documents | The order documents received from Global-e | — |
| geSelectedPackageOption | Selected Package Option | The order Selected Package Option received from Global-e | — |
| geNonProductTotalSubsidy | Order DTSubsidy on Merchant currency | Order DTSubsidy on Merchant currency. | — |
| geOrderCreationSource | Order Creation Source | Order Creation Source | — |
| geOrderCreationSourceInfo | Order Creation Source Info | Order Creation Source Info | — |
| geIsTaxExemption | Is Tax Exemption | Indication if the order has tax exemption | — |
| geCookieConsent | Customer Cookie Consent | Customer Cookie Consent | — |
| geIsOrderCreatedFallbackScenario | Is Order Created Fallback Scenario | SFCC order is created from a fallback scenario(when a new SFCC basket is generated from the SOTM payload) | — |
| geIsGiftWrappingRequired | Is Gift Wrapping Required | Indication if the order has Gift Wrapping | — |
| geIsOrderCreatedPayByLinkScenario | Is Order Created PayByLink Scenario | SFCC order is created by an agent user from the PayByLink scenario | — |
Global-e Order Status
| ID | Display name | Description | Notes |
|---|---|---|---|
| geStatusCode | Order Status Code | Code denoting the order status on the Merchant’s site (to be mapped on Global-e side) | — |
| geReceivedOrderStatusUpdates | Order Status Updates received from Global-e | The set of strings of the statuses received from Global-e | — |
| geAppliedStatusOperationIds | Applied Status Operation IDs | OrderStatusUpdateTime values already applied to this order (cross-channel dedup for webhook and SFTP fallback) | — |
| geOrderCancellationReasonCode | Global-e Order Cancellation Reason Code | Global-e order cancellation reason code received from Global-e | — |
Global-e Loyalty
| ID | Display name | Description | Notes |
|---|---|---|---|
| geLoyaltyPointsSpent | Loyalty Points Spent | Number of loyalty points spent for this purchase. The existing loyalty points handling procedure must be applied to the end customer’s user account. Therefore, “Loyalty points” type discount must not be applied to the order directly, but can be used for the display purposes elsewhere in the system (i.e in end user’s My Account page) | — |
| geLoyaltyPointsEarned | Loyalty Points Earned | Number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site, as specified in loyaltyPointsEarned argument for SendCart method for the cart converted to this order on Global-e | — |
| geLoyaltyCode | Loyalty Code | Loyalty code applicable to the Merchant’s site entered by the end customer in Global-e checkout | — |
Global-e Shipping Address
| ID | Display name | Description | Notes |
|---|---|---|---|
| geShippingAddress1 | Shipping Address 1 | Shipping Address line 1 | — |
| geShippingAddress2 | Shipping Address 2 | Shipping Address line 2 | — |
| geShippingCity | Shipping City | Shipping City name | — |
| geShippingCityRegion | City Region | Shipping City Region | — |
| geShippingCompany | Shipping Company | Shipping Company name | — |
| geShippingCountryCode | Shipping Country code | Shipping Country code | — |
| geShippingCountryName | Shipping Country name | Shipping Country name | — |
| geShippingEmail | Shipping Email | Shipping Email address | — |
| geShippingFax | Shipping Fax | Shipping Fax | — |
| geShippingFirstName | Shipping First name | Shipping First name | — |
| geShippingLastName | Shipping Last name | Shipping Last name | — |
| geShippingMiddleName | Shipping Middle name | Shipping Middle name | — |
| geShippingPhone1 | Shipping Phone 1 | Shipping Phone 1 | — |
| geShippingPhone2 | Shipping Phone 2 | Shipping Phone 2 | — |
| geShippingSalutation | Shipping Salutation | Shipping Salutation | — |
| geShippingStateCode | Shipping State code | Shipping State code | — |
| geShippingStateOrProvince | Shipping State or province | Shipping State or province | — |
| geShippingZip | Shipping Zip | Shipping Zip code | — |
Global-e Billing Address
| ID | Display name | Description | Notes |
|---|---|---|---|
| geBillingAddress1 | address 1 | Address line 1 | — |
| geBillingAddress2 | address 2 | Address line 2 | — |
| geBillingCity | city | City name | — |
| geBillingCityRegion | City Region | Billing City Region | — |
| geBillingCompany | company | Company name | — |
| geBillingCountryCode | country code | 2-char ISO country code | — |
| geBillingCountryName | country name | Country name | — |
| geBillingEmail | E-mail address | — | |
| geBillingFax | fax | Fax | — |
| geBillingFirstName | first name | First name | — |
| geBillingMiddleName | middle name | Middle name | — |
| geBillingLastName | Last name | Last name | — |
| geBillingPhone1 | phone 1 | Phone 1 | — |
| geBillingPhone2 | phone 2 | Phone 2 | — |
| geBillingSalutation | salutation | Salutation | — |
| geBillingStateCode | state code | State code | — |
| geBillingStateOrProvince | state or province | State or province | — |
| geBillingZip | Zip | Zip code | — |
Global-e Customer Shipping Address
| ID | Display name | Description | Notes |
|---|---|---|---|
| geDeliveryStoreId | Delivery Store ID | Delivery Store ID | — |
| geCustomerShippingAddress1 | Address1 | Address1 | — |
| geCustomerShippingAddress2 | Address2 | Address2 | — |
| geCustomerShippingCity | City | City | — |
| geCustomerShippingCityRegion | City Region | Customer Shipping City Region | — |
| geCustomerShippingCompany | Company | Company | — |
| geCustomerShippingCountryName | Country name | Country name | — |
| geCustomerShippingCountryCode | Country code | Country code | — |
| geCustomerShippingEmail | — | ||
| geCustomerShippingFax | Fax | Fax | — |
| geCustomerShippingFirstName | First name | First name | — |
| geCustomerShippingMiddleName | Middle name | Middle name | — |
| geCustomerShippingLastName | Last name | Last name | — |
| geCustomerShippingPhone1 | Phone1 | Phone1 | — |
| geCustomerShippingPhone2 | Phone2 | Phone2 | — |
| geCustomerShippingSalutation | Salutation | Salutation | — |
| geCustomerShippingStateCode | State code | State code | — |
| geCustomerShippingStateOrProvince | State or province | State or province | — |
| geCustomerShippingZip | Zip | Zip | — |
Global-e Customer Billing Address
| ID | Display name | Description | Notes |
|---|---|---|---|
| geCustomerBillingAddress1 | Address1 | Address1 | — |
| geCustomerBillingAddress2 | Address2 | Address2 | — |
| geCustomerBillingCity | City | City | — |
| geCustomerBillingCityRegion | City Region | Customer Billing City Region | — |
| geCustomerBillingCompany | Company | Company | — |
| geCustomerBillingCountryCode | Country code | Country code | — |
| geCustomerBillingCountryName | Country name | Country name | — |
| geCustomerBillingEmail | — | ||
| geCustomerBillingFax | Fax | Fax | — |
| geCustomerBillingFirstName | First name | First name | — |
| geCustomerBillingMiddleName | Middle name | Middle name | — |
| geCustomerBillingLastName | Last name | Last name | — |
| geCustomerBillingPhone1 | Phone1 | Phone1 | — |
| geCustomerBillingPhone2 | Phone2 | Phone2 | — |
| geCustomerBillingSalutation | Salutation | Salutation | — |
| geCustomerBillingStateCode | State code | State code | — |
| geCustomerBillingStateOrProvince | State or province | State or province | — |
| geCustomerBillingZip | Zip | Zip | — |
Global-e Payment Method Address
| ID | Display name | Description | Notes |
|---|---|---|---|
| gePdOwnerFirstName | PD Owner first name | PD Owner first name | — |
| gePdOwnerLastName | PD Owner last name | PD Owner last name | — |
| gePdOwnerName | PD Owner name | PD Owner name | — |
| gePdPaymentMethodName | PD Payment method name | PD Payment method name | — |
| gePdPaymentMethodCode | PD Payment method code | PD Payment method code | — |
| gePdCountryName | PD Country name | PD Country name | — |
| gePdCountryCode | PD Country code | PD Country code | — |
| gePdStateCode | PD State code | PD State code | — |
| gePdStateOrProvince | PD State or province | PD State or province | — |
| gePdCity | PD City | PD City | — |
| gePdZip | PD Zip | PD Zip | — |
| gePdAddress1 | PD Address1 | PD Address1 | — |
| gePdAddress2 | PD Address2 | PD Address2 | — |
| gePdPhone1 | PD Phone1 | PD Phone1 | — |
| gePdPhone2 | PD Phone2 | PD Phone2 | — |
| gePdFax | PD Fax | PD Fax | — |
| gePdEmail | PD Email | PD Email | — |
| gePdPaymentMethodTypeCode | PD Payment method type code | PD Payment method type code | — |
| gePdCardNumber | PD Card Number | PD Card Number | — |
| gePdCvvNumber | PD CVV Number | PD CVV Number | — |
| gePdExpirationDate | PD Expiration Date | PD Expiration Date | — |
Global-e International Details
| ID | Display name | Description | Notes |
|---|---|---|---|
| geOrderTrackingNumber | Order Tracking Number | Tracking number used by the selected international shipping method for this order. | — |
| geOrderTrackingUrl | Order Tracking URL | Full tracking URL including OrderTrackingNumber used by the selected international shipping method for this order. | — |
| geIsFreeShipping | Is Free Shipping | Indicates if the Merchant offers free international shipping to the end customer, as specified in IsFreeShipping argument for SendCart method for the cart converted to this order on Global-e | — |
| geFreeShippingCouponCode | Free Shipping Coupon Code | Merchant’s free shipping coupon code applied by the end customer, as specified in FreeShippingCouponCode argument for SendCart method for the cart converted to this order on Global-e | — |
| geShippingMethodCode | Shipping Method Code | Code denoting the selected international shipping method as defined on the Merchant’s site (to be mapped on Global-e side). If this international shipping method doesn’t exist on the Merchant’s site, the internal Global-e shipping method code will be specified instead | — |
| geShippingMethodName | Shipping Method Name | Name of the selected international shipping method. | — |
| geShippingMethodTypeCode | Shipping Method Type Code | Code denoting the selected international shipping method type as defined on the Merchant’s site (to be mapped on Global-e side). If this international shipping method type doesn’t exist on the Merchant’s site, the internal Global-e shipping method type code will be specified instead. | — |
| geShippingMethodTypeName | Shipping Method Type Name | Name of the selected international shipping method type. | — |
| geDeliveryDaysFrom | Delivery Days From | Minimum number of days for delivery to the end customer for the selected shipping method. | — |
| geDeliveryDaysTo | Delivery Days To | Maximum number of days for delivery to the end customer for the selected shipping method. | — |
| geConsignmentFee | Consignment Fee | Consignment fee paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice. | — |
| geSizeOverchargeValue | Size Overcharge Value | Oversized items charge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice. | — |
| geRemoteAreaSurcharge | Remote Area Surcharge | Remote area surcharge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice. | — |
| geCustomerCurrencyCode | Customer Currency Code | 3-char ISO code for the currency selected by the end customer for the order payment | — |
| gePriceCoefficientRate | Price Coefficient Rate | CountryCoefficient rate applied to the prices in this order | — |
| geTotalPrice | Total Price | Total order price in the currency denoted by CurrencyCode | — |
| geTransactionCurrencyCode | Transaction Currency Code | 3-char ISO code for the currency actually used for the current order payment. TransactionCurrencyCode may differ from CurrencyCode if the currency selected by the end customer could not be used with the selected payment method | — |
| geTransactionTotalPrice | Transaction Total Price | Total order price actually paid by the end customer in the currency denoted by TransactionCurrencyCode | — |
| geTotalShippingPrice | Total Shipping Price | Total shipping price in the currency denoted by CurrencyCode | — |
| geTotalDiscountedShippingPrice | Total Discounted Shipping Price | The price paid by customer in local currency. Total Shipping price reducing Order Discounts International price. | — |
| geSameDayDispatch | Same Day Dispatch | Indicates if the end customer has requested “Same Day Dispatch” on Global-e checkout | — |
| geSameDayDispatchCost | Same Day Dispatch Cost | Cost of “Same Day Dispatch” option (if selected by the end customer on Global-e checkout), in the currency denoted by CurrencyCode. This value is NOT included in TotalShippingPrice. | — |
| geDoNotChargeVat | Do Not Charge VAT | Indicates if the end customer hasn’t been charged VAT in Global-e checkout, as specified in doNotChargeVAT argument for SendCart method for the cart converted to this order on Global-e | — |
| geTotalDutiesPrice | Total Duties Price | Total Duties & Taxes value including Customs Clearance Fees, in the currency denoted by CurrencyCode | — |
| geCustomerUSSalesTax | Sales tax value for USA | Sales tax value for USA in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice. | — |
| geCcfPrice | CCF Price | Customs Clearance Fees (CCF), in the merchant currency | — |
| geTotalCcfPrice | Total CCF Price | Total Customs Clearance Fees value in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice. | — |
| geDutiesGuaranteed | Is Duties Guaranteed | Indicates if the end customer has selected the “guaranteed duties and taxes” option. | — |
| geOrderWaybillNumber | Order Waybill Number | Waybill number used by the selected international shipping method for this order | — |
| geCashOnDeliveryFee | CashOnDeliveryFee | Additional charge paid by the end customer when “Cash on Delivery” payment method has been selected. | — |
| geTotalVatAmount | Total VAT Amount | Amount of VAT paid by the customer to Global-e | — |
| geShippingMethodStatusCode | Shipping Method Status Code | Code denoting the selected shipping status as defined on the Merchant’s site (to be mapped on Global-e side). If this shipping status doesn’t exist on the Merchant’s site, the internal Global-e shipping status code will be specified instead. | — |
| geShippingMethodStatusName | Shipping Method Status Name | Name of the shipping status | — |
| geShippingVATRate | Shipping VAT Rate | Shipping VAT rate for customer. This rate is applied on the shipping cost. | — |
| gePaymentMethodCode | Payment method code | Code denoting the selected payment method as defined on the Merchant’s site (to be mapped on Global-e side). If this payment method doesn’t exist on the Merchant’s site, the internal Global-e payment method code will be specified instead. | — |
| gePaymentMethodName | Payment method name | Name of the selected payment method. | — |
| geRoundingRate | Global-e Rounding Rate | Average conversion rate applied to the prices paid by the end customer, when calculating the prices paid by Global-e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors | — |
| geTotalCustomerDiscounts | Total Customer Discounts | Total customer discounts for Cart and Loyalty type discounts | — |
| geOrderDeliveryDate | Global-e Order Delivery Date | — | — |
| geInternationalNonProductTotalSubsidy | Order DTSubsidy on Customer currency | Order DTSubsidy on Customer currency. | — |
Global-e Mixed Orders
| ID | Display name | Description | Notes |
|---|---|---|---|
| geMixedOrdersMainOrderID | Main Order ID | — | — |
| geMixedOrdersSubOrdersIDs | Sub Orders IDs | — | — |
| geMixedOrdersSuccessfullyUpdated | All Mixed Orders Successfully Updated | — | — |
Not assigned to an attribute group
| ID | Display name | Description | Notes |
|---|---|---|---|
| gePrePayOffered | PrePay Offered | Indicates if the prepayment option for duties and taxes was offered to the customer | — |
Basket
Global-e
| ID | Display name | Description | Notes |
|---|---|---|---|
| geCartToken | Global-e Cart Token | The token exchanged within the SendCart API call to display the Global-e checkout iframe. | — |
| geMerchantOrderId | Global-e Merchant Order ID | Reserved SFCC merchant order ID. | — |
| geIsOrderCreatedFallbackScenario | Is Order Created Fallback Scenario | SFCC order is created from a fallback scenario(when a new SFCC basket is generated from the SOTM payload) | — |
| geIsOrderCreatedPayByLinkScenario | Is Order Created PayByLink Scenario | SFCC order is created by an agent user from the PayByLink scenario | — |
| geCheckoutDiscountVouchers | Checkout Discount Vouchers | JSON array of active checkout discount voucher codes (e.g. [“SOME_VOUCHER_CODE”]). Used to rehydrate session customer-group attributes on Globale-Coupon flows. | — |
Not assigned to an attribute group
| ID | Display name | Description | Notes |
|---|---|---|---|
| geCartId | Cart ID | Identifier of the cart on the Merchant’s site originally specified in geMerchantCartToken argument for SendCart method for the cart converted to this order on Global-e | — |
Payment Transaction
Global-e
| ID | Display name | Description | Notes |
|---|---|---|---|
| gePaymentMethodName | Payment Method Name | Global-e Payment Method Name | — |
| gePaymentMethodType | Payment Method Type | Global-e Payment Method Type | Values: GlobalePayment, GlobaleGiftCard, GlobaleLoyaltyCard |
| gePaymentAmountInCustomerCurrency | Payment Amount In Customer Currency | Global-e Payment Amount In Customer Currency | — |
| gePaymentDetails | Payment Details | Global-e Payment Details | — |
| geAlternativePaymentDetails | Alternative Payment Details | Global-e Alternative Payment Details | — |
Profile
Global-e Attributes
| ID | Display name | Description | Notes |
|---|---|---|---|
| geSalutation | Salutation | Salutation | Values: 0, 1, 2, 3, 4 |
Gift Certificate
Global-e Attributes
| ID | Display name | Description | Notes |
|---|---|---|---|
| geInternationalPrice | International Price | Price in end customer’s currency, after applying country coefficient, FX conversion, and rounding rule (if applicable) | — |
| geCurrencyCode | International Currency Code | — | — |
| originalCurrencyCode | Currency Code | — | — |
| initialBalance | Initial Balance | — | — |
| currentBalance | Current Balance | — | — |
| redeemRequestJSON | Redeem Request JSON | — | — |
| redeemResponseJSON | redeemResponseJSON | — | — |
| refundRequestJSON | Refund Request JSON | — | — |
| refundResponseJSON | Refund Response JSON | — | — |
Not assigned to an attribute group
| ID | Display name | Description | Notes |
|---|---|---|---|
| geGiftCertificateID | Global-e GiftCertificateID | — | — |
Gift Certificate Line Item
Uses the same Global-e custom attributes as Product Line Item (see above). Additional gift-certificate line item attribute:| ID | Display name | Description | Notes |
|---|---|---|---|
| geGiftCertificateID | Global-e GiftCertificateID | — | — |
Custom objects
Defined inmetadata/meta/custom-objecttype-definitions.xml. Site-scoped unless noted in Business Manager.
Demo types (DEMO_GLOBALE_*): Shipped for sandbox and reference implementations only (gift and loyalty demo providers). They are not a production integration pattern. Do not import demo custom-object data from metadata/demo/ into production. Replace demo providers with your own before go-live — see Gift Cards and Loyalty Points Cards.
GLOBALE_APP_SETTINGS
Version identifier of Global-e API. Site-scoped; keyname.
| ID | Display name | Description | Notes |
|---|---|---|---|
| apiVersion | APIVersion | Version identifier of Global-e API | — |
| serverSettings | ServerSettings | Dictionary of server-side settings | — |
| webClientVersion | WebClientVersion | Version identifier of Global-e client-side (JS) code | — |
| sfccUseGEShippingPrice | Use Global-e Shipping Price (B2B) | Use Global-e Shipping Price (B2B) | — |
| sfccSendCartSendHubId | Send HubId in SendCart | Send HubId in SendCart Payload | — |
| sfccLanguagesConfiguration | Languages Switcher Configuration | Languages Switcher Configuration | — |
| sfccParseCountryCodeFromRequestLocale | Parse CountryCode from RequestLocale | Use SFCC locale country code to define shipping country | — |
| sfccShippingSwitcherConfiguration | Shipping Switcher Configuration | Shipping Switcher Configuration | — |
| sfccCartHashValidation | SFCC Cart Hash Validation | Enable SFCC Cart Hash Validation | — |
| sfccPlaceOrderOnPaymentUpdate | Place Order On Payment Update | SFCC order remains in ‘Created’ status until payment notification from Global-e | — |
| sfccCreateNewAddressesFromCheckout | Save GE Address | Allows to create and save new addresses from GE checkout | — |
| sfccCultureMapping | Culture Mapping | Culture Mapping allows overriding Global-e cultures for popups | — |
| sfccCheckoutCultureMapping | Checkout Culture Mapping | Checkout Culture Mapping allows overriding Global-e cultures for checkout | — |
| sfccDynamicCountryCurrencyMapping | Dynamic Country/Currency Mapping | Allows overriding Global-e default currency code for dynamic price countries | — |
| sfccAllowedCurrencies | Allowed country currencies | Allowed country currencies (price book caching approach) | — |
| sfccDefaultCountryCodeMapping | Default Country Code Mapping | Default Country Code Mapping | — |
| sfccMerchantBaseCurrencyCode | Merchant Base Currency Code | Merchant Base Currency Code(Site default currency is used if empty) | — |
| sfccJWTAuthConfiguration | JWT Authentication Configuration | JWT Authentication Configuration (GE to SFCC) | — |
| sfccJWTApiAuthConfiguration | JWT API Authentication Configuration | JWT API Authentication Configuration (SFCC to GE) | — |
| sfccKlarnaConfigurations | SFCC Klarna Configurations | SFCC Klarna OSM Configurations | — |
| sfccLocalizationConfiguration | SendCartV2 Localization Configuration | SendCartV2 Localization Configuration | — |
| sfccUseProductCodeSecondaryInFulfillmentEnabled | SFCC Use ProductCodeSecondary In Fulfilment Enabled | SFCC Use ProductCodeSecondary In Fulfilment Enabled | — |
| sfccDoWebStoreValidation | SFCC Do WebStore Validation | Do WebStore Validation | — |
| sfccPayByLinkConfigurations | Pay By Link Configurations | Pay By Link Configurations | — |
| sfccReconciliationCurrency | Reconciliation Currency | Uses if a merchant has more than 1 reconciliation currency | — |
| sfccDataExtrasConfig | Data Extras Config | Data Extras Config | — |
| sfccDynamicConversionFallback | Dynamic Conversion Fallback Configurations | Dynamic Conversion Fallback Configurations | — |
| sfccOrderUpdateMappings | Order Update Mappings | Attribute mappings used on OrderUpdate notification | — |
| sfccSendCartMappings | SendCart Mappings | Attribute mappings used on SendCart request | — |
GLOBALE_COUNTRIES
A custom object type to hold the countries from Global-e. Site-scoped; keycode.
| ID | Display name | Description | Notes |
|---|---|---|---|
| defaultCurrencyCode | DefaultCurrencyCode | 3-char ISO currency code | — |
| isStateMandatory | IsStateMandatory | TRUE if State or province (region) is mandatory for addresses in this country | — |
| isOperatedByGlobalE | IsOperatedByGlobalE | Flag to be used as a Mode indicator. Countries that are not operated by Global-e must 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 | Name | Country name | — |
| 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 | — |
| 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 | DefaultVATRateType | Default (most widely used) VAT rate type or class for this country | — |
| 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 | VATExemptionDisabled | Used in order to identify, if no VAT case is supported | — |
| countryCode3 | CountryCode3 | ISO3 Country Code | — |
GLOBALE_CACHE_PRICE_BOOK_COMBINATION
2-char ISO country code. Site-scoped; keycountryCode.
| ID | Display name | Description | Notes |
|---|---|---|---|
| baseCurrencyCode | Base Currency Code | Merchant base currency for this site at last combination sync | — |
| combinations | Combinations | JSON map of currency code to cache price book id arrays | — |
GLOBALE_COUNTRY_COEFFICIENTS
2-char ISO country code. Site-scoped; keycountryCode.
| ID | Display name | Description | Notes |
|---|---|---|---|
| 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 | Rate | Country Coefficient rate decimal value. All the prices displayed to the end customer shipping to the country involved must be multiplied by this value | — |
GLOBALE_PRODUCT_CLASS_COEFFICIENTS
Country Coefficient rate decimal value. All the prices displayed to the end customer shipping to the country involved must be multiplied by this value. Site-scoped; keykey.
| ID | Display name | Description | Notes |
|---|---|---|---|
| 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 | CountryCode | 2-char ISO country code | — |
| productClassCode | ProductClassCode | Product class code used by the merchant to classify products for using different country coefficient rates per classes of products instead of the single country level default (when no rate is defined for a certain product class, the country level default rate should be used by the merchant for the respective product) | — |
GLOBALE_CULTURES
2-char ISO country code. Site-scoped; keycode.
| ID | Display name | Description | Notes |
|---|---|---|---|
| regionCode | Region Code | Region code (unique in the respective Country) | — |
| cityCode | City Code | City code (unique in the respective Region) | — |
| isRTL | IsRTL | TRUE for “right-to-left” languages such as Hebrew and Arabic | — |
| localizedName | Localized Name | Culture name in the respective language, such as “עברית” for he-IL (Hebrew-Israel) culture | — |
| name | Name | Culture name | — |
| culture | Culture Code | ISO culture code | — |
GLOBALE_CURRENCIES
3-char ISO currency code. Site-scoped; keycode.
| ID | Display name | Description | Notes |
|---|---|---|---|
| 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 | Name | Currency name | — |
| symbol | Symbol | Currency symbol (e.g. $ for USD) | — |
GLOBALE_CURRENCY_RATES
SourceCurrencyCode - TargetCurrencyCode. Site-scoped; keykey.
| ID | Display name | Description | Notes |
|---|---|---|---|
| rate | Rate | Currency rate decimal value | — |
| sourceCurrencyCode | SourceCurrencyCode | 3-char ISO currency code | — |
| targetCurrencyCode | TargetCurrencyCode | 3-char ISO currency code | — |
| rateData | Rate Data | Currency data used by global-e to verify the rate | — |
GLOBALE_ROUNDING_RULES
2-char ISO country code. Site-scoped; keykey.
| ID | Display name | Description | Notes |
|---|---|---|---|
| countryCode | CountryCode | 2-char ISO country code | — |
| currencyCode | CurrencyCode | 3-char ISO currency code | — |
| roundingRanges | RoundingRanges | List of decimal ranges and their respective rounding behaviors | — |
| roundingRuleId | RoundingRuleId | Rule identifier denoting the respective Rounding Rule on Global-e side. This value must be further specified when calling SaveProductsList and SendCart methods | — |
GLOBALE_HUB_DETAILS
Address line 1. Site-scoped; keykey.
| ID | Display name | Description | Notes |
|---|---|---|---|
| address1 | Address1 | Address line 1 | — |
| address2 | Address2 | Address line 2 | — |
| city | City | City name | — |
| countryCode | CountryCode | 2-char ISO country code | — |
| countryName | CountryName | Country name | — |
| E-mail address | — | ||
| fax | Fax | Fax | — |
| hubID | HubID | Hub identifier on Global-e system | — |
| hubName | HubName | Name of the Hub | — |
| phone1 | Phone1 | Phone #1 | — |
| phone2 | Phone2 | Phone #2 | — |
| stateCode | StateCode | State or province ISO code such as AZ for Arizona (if applicable) | — |
| stateOrProvince | StateOrProvince | State or province name | — |
| zip | Zip | Zip or postal code | — |
GLOBALE_ORDER_NOTIFICATION
The custom objects are used for initiating order update notifications. Site-scoped; retention 7 days; keyID.
| ID | Display name | Description | Notes |
|---|---|---|---|
| geNotificationPayload | Notification Payload | The notification payload | — |
| geNotificationType | Notification Type | Possible values are: OrderStatusUpdate, OrderDispatchUpdate, OrderRefundUpdate, OrderRMAUpdate, OrderRMACreate | Mandatory. Values: OrderStatusUpdate, OrderDispatchUpdate, OrderRefundUpdate, OrderRMAUpdate, OrderRMACreate, ParcelStatusUpdate |
| geOrderId | Order Id | SFCC or Global-e order ID | Mandatory |
GLOBALE_INBOUND_ORDER_FALLBACK
Queue for order status fallback files downloaded from Global-e SFTP. Site-scoped; retention 5 days; keyID.
| ID | Display name | Description | Notes |
|---|---|---|---|
| geNotificationPayload | Notification Payload | Order status payload from fallback file. | — |
| geAttemptCount | Attempt Count | Number of failed apply attempts for this fallback CO. Removed when maxAttempts is reached. | — |
GLOBALE_INVENTORY_NOTIFICATION
The custom objects are used for storing inventory update notifications. Site-scoped; retention 7 days; keyID.
| ID | Display name | Description | Notes |
|---|---|---|---|
| geNotificationPayload | Notification Payload | The notification payload | — |
| geNotificationType | Notification Type | Possible values are: VoidReservation | Mandatory. Values: VoidReservation |
| geOrderId | Order Id | SFCC or Global-e order ID | Mandatory |
DEMO_GLOBALE_GIFT_CARDS
Demo / sandbox only. Reference schema for the cartridge demo gift-card provider. Do not use in production; do not import demo records into production environments.
cardID.
| ID | Display name | Description | Notes |
|---|---|---|---|
| currentBalance | Current Balance | — | — |
| initialBalance | Initial Balance | — | — |
| originalCurrencyCode | Currency Code | — | — |
| redeemRequestJSON | Redeem Request JSON | — | — |
| redeemResponseJSON | Redeem Response JSON | — | — |
| refundRequestJSON | Refund Request JSON | — | — |
| refundResponseJSON | Refund Response JSON | — | — |
DEMO_GLOBALE_LOYALTY_CARDS
Demo / sandbox only. Reference schema for the cartridge demo loyalty provider. Do not use in production; do not import demo records into production environments.
cardID.
| ID | Display name | Description | Notes |
|---|---|---|---|
| currentBalance | Current Balance | — | — |
| initialBalance | Initial Balance | — | — |
| originalCurrencyCode | Currency Code | — | — |
| redeemRequestJSON | Redeem Request JSON | — | — |
| redeemResponseJSON | Redeem Response JSON | — | — |
| refundRequestJSON | Refund Request JSON | — | — |
| refundResponseJSON | Refund Response JSON | — | — |
GLOBALE_RESTRICTED_ITEMS
Site-scoped; keyname.
| ID | Display name | Description | Notes |
|---|---|---|---|
| countriesExclusions | Countries Exclusions | — | — |
| sourceHandler | Source Handler | — | — |
GLOBALE_COUPON_REDEMPTIONS
The custom objects are used for storing coupon data for redemption. Site-scoped; retention 7 days; keyID.
| ID | Display name | Description | Notes |
|---|---|---|---|
| geCouponCode | Coupon code | — | — |
| geCouponId | Coupon ID | — | — |
| geCustomerEmail | Customer email | — | — |
| geOrderNumber | Order Number | — | — |
GLOBALE_LOCAL_STORAGE
The custom objects are used for keep relevant information generated and used at SFCC level. Site-scoped; keyID.
| ID | Display name | Description | Notes |
|---|---|---|---|
| geLocalStorageValue | Value | Persistent storage field that contains JSON-serialized application settings with embedded type metadata. Stores both the actual value and its data type (boolean, json, date, string) to ensure proper type conversion during retrieval operations. | Eg: { value: ‘Thu Oct 09 2025 11:35:03 GMT+0300’, type: ‘date’ } | — |
Shipping methods (placeholders)
Frommetadata/site/shippingmethods.xml. Placeholder methods for SFCC order creation; actual international shipping is selected in Global-e checkout. Set isGeShippingMethod = true on each method.
| ID | Display name | Description | Notes |
|---|---|---|---|
| GLOBALE | GLOBALE | Global-e Generic Shipping (default) | Placeholder; isGeShippingMethod = true |
| GLOBALE_STANDARD | GLOBALE STANDARD | Global-e Standard Shipping | Placeholder; isGeShippingMethod = true |
| GLOBALE_EXPRESS | GLOBALE EXPRESS | Global-e Express Shipping | Placeholder; isGeShippingMethod = true |
| GLOBALE_STORE_COLLECTION | GLOBALE STORE COLLECTION | Global-e Store Collection | Placeholder; isGeShippingMethod = true |
| GLOBALE_HUB | GLOBALE HUB | Global-e Shipping via GE Hub | Placeholder; isGeShippingMethod = true |
| GLOBALE_DIRECT | GLOBALE DIRECT | Global-e Shipping Direct from Brand Hub | Placeholder; isGeShippingMethod = true |
| GLOBALE_WYOL | GLOBALE WYOL | Brand own carrier service | Placeholder; isGeShippingMethod = true |
Payment method (placeholder)
Frommetadata/site/paymentmethod.xml. Order payment details are stored on the order; this method is a processor placeholder.
| ID | Name | Payment processor | Notes |
|---|---|---|---|
| GLOBALE | Globale | GLOBALE | Use the GLOBALE processor for Global-e order creation |
Services
Service definitions and credentials come frommetadata/services.xml; default API paths come from cartridges/int_globale/cartridge/scripts/globale/application/system/serviceEndpoints.js. A path is relative to site preference geApiUrl and can be overridden per service with geServiceEndpointConfig. SFTP services take host and credentials from Business Manager.
| Service ID | Service profile | Credential | Path / note |
|---|---|---|---|
| Globale-ActiveHubDetails | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Browsing/ActiveHubDetails |
| Globale-AppSettings | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Browsing/AppSettings |
| Globale-AppVersion | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Browsing/AppVersion |
| Globale-Countries | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Browsing/Countries |
| Globale-CountryCoefficients | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Browsing/CountryCoefficients |
| Globale-CreateOrderRefund | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Order/CreateOrderRefund |
| Globale-Currencies | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Browsing/Currencies |
| Globale-CurrencyRates | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Browsing/CurrencyRates |
| Globale-JWT | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Authentication/GetAuthenticationToken |
| Globale-LocationsDefaultCulturesList | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Browsing/LocationsDefaultCulturesList |
| Globale-OCAPI | GLOBALE-JOB.LCT | Globale-OCAPI | Configure base URL and path on the credential in Business Manager |
| Globale-SCAPI | GLOBALE-JOB.LCT | Globale-SCAPI | Configure base URL and path on the credential in Business Manager |
| Globale-OrderDetails | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Order/GetOrdersDetails |
| Globale-RecentProductCountryS | GLOBALE-JOB.HCT | Globale-MerchantAccount | /Browsing/RecentProductCountryS |
| Globale-RoundingRules | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Browsing/RoundingRules |
| Globale-SFTPUpload | GLOBALE-SFTPUpload | — | SFTP — configure host, user, and password on the credential in Business Manager |
| Globale-SFTPDownload | GLOBALE-SFTPUpload | Globale-SFTPDownload | SFTP — configure host, user, and password on the credential in Business Manager |
| Globale-CreateOrderLog | GLOBALE-CREATEORDERLOG | Globale-MerchantAccount | /GEPI/CreateOrderLog |
| Globale-SendCartV2 | GLOBALE-SENDCART | Globale-MerchantAccount | /Checkout/SendCartV2 |
| Globale-ShippingDetails | GLOBALE-JOB.LCT | Globale-MerchantAccount | /ShippingDetails/GetShippingDetails |
| Globale-UpdateOrderDispatchV2 | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Order/UpdateOrderDispatchV2 |
| Globale-UpdateOrderStatus | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Order/UpdateOrderStatus |
| Globale-UpdateRMA | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Return/UpdateRMA |
| Globale-OrderCreate | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Checkout/CreateOrder |
| Globale-RmaCreate | GLOBALE-JOB.LCT | Globale-MerchantAccount | /Return/GetReturnDocuments |
| Globale-UpdateParcelStatus | GLOBALE-JOB.LCT | Globale-MerchantAccount | /orders/{0}/parcels/{1}/statuses |
Scheduled jobs
Frommetadata/jobs.xml. Sample site IDs in the import file; adjust triggers and site scope per project.
| Job ID | Job description | Step ID | Step type | Step description |
|---|---|---|---|---|
| GlobaleSettings | Loads the Global-e Settings in respective SFCC Custom Objects | AppSettings | custom.GlobaleAppSettings | Loads Global-e AppSettings |
| GlobaleSettings | Loads the Global-e Settings in respective SFCC Custom Objects | Countries | custom.GlobaleCountries | Loads Global-e Countries |
| GlobaleSettings | Loads the Global-e Settings in respective SFCC Custom Objects | CountryCoefficients | custom.GlobaleCountryCoefficients | Loads Global-e Country Coefficients |
| GlobaleSettings | Loads the Global-e Settings in respective SFCC Custom Objects | Cultures | custom.GlobaleCultures | Loads Global-e Cultures |
| GlobaleSettings | Loads the Global-e Settings in respective SFCC Custom Objects | Currencies | custom.GlobaleCurrencies | Loads Global-e Currencies |
| GlobaleSettings | Loads the Global-e Settings in respective SFCC Custom Objects | CurrencyRates | custom.GlobaleCurrencyRates | Loads Global-e Currency Rates |
| GlobaleSettings | Loads the Global-e Settings in respective SFCC Custom Objects | RoundingRules | custom.GlobaleRoundingRules | Loads Global-e Rounding Rules |
| GlobaleSettings | Loads the Global-e Settings in respective SFCC Custom Objects | ActiveHubDetails | custom.GlobaleActiveHubDetails | Loads Global-e Active Hub Details |
| GlobaleSettings | Loads the Global-e Settings in respective SFCC Custom Objects | GlobaleGenerateCachePriceBooksXML | custom.GlobaleGenerateCachePriceBooksXML | Initializes org preference cache price books config for the site base currency and generates Global-e cache price books XML |
| GlobaleSettings | Loads the Global-e Settings in respective SFCC Custom Objects | GlobaleImportPriceBook | ImportPriceBook | Imports Global-e cache price books |
| GlobaleSettings | Loads the Global-e Settings in respective SFCC Custom Objects | GlobaleUpdateCachePriceBooksConfigHash | custom.GlobaleUpdateCachePriceBooksConfigHash | Updates Global-e cache price books config hashes after import |
| GlobaleSettings | Loads the Global-e Settings in respective SFCC Custom Objects | GlobaleSyncCachePriceBookCombinations | custom.GlobaleSyncCachePriceBookCombinations | Syncs cache price book combinations into custom objects |
| GlobaleSettings | Loads the Global-e Settings in respective SFCC Custom Objects | InvalidatePageCache | InvalidateCache | Invalidates Cache |
| GlobaleProducts | Loads products restrictions and destination VAT rates for different countries. | LoadRecentProductCountryData | custom.GlobaleLoadRecentProductCountryS | Loads Recent ProductCountry Data (delta) |
| GlobaleProducts | Loads products restrictions and destination VAT rates for different countries. | ImportRecentProductCountryData | custom.GlobaleImportRecentProductCountryS | Import Recent ProductCountry Data |
| GlobaleProducts | Loads products restrictions and destination VAT rates for different countries. | ArchiveRecentProductCountryData | custom.GlobaleArchiveRecentProductCountryS | Archive Recent ProductCountry Data |
| GlobaleOrderNotifications | This job sends the Order status update, the UpdateOrderDispatchV2 request, the CreateOrderRefund request to Global-e | UpdateOrderStatus | custom.GlobaleUpdateOrderStatus | Sends the Order status update to Global-e |
| GlobaleOrderNotifications | This job sends the Order status update, the UpdateOrderDispatchV2 request, the CreateOrderRefund request to Global-e | UpdateOrderDispatch | custom.GlobaleUpdateOrderDispatch | Sends the UpdateOrderDispatchV2 request to Global-e |
| GlobaleOrderNotifications | This job sends the Order status update, the UpdateOrderDispatchV2 request, the CreateOrderRefund request to Global-e | CreateOrderRefund | custom.GlobaleCreateOrderRefund | Sends the CreateOrderRefund request to Global-e |
| GlobaleOrderNotifications | This job sends the Order status update, the UpdateOrderDispatchV2 request, the CreateOrderRefund request to Global-e | UpdateRMA | custom.GlobaleUpdateRMA | Sends the UpdateRMA request to Global-e |
| GlobaleCatalogFeed | Generates Catalog Feed and sends it to Global-e SFTP folder | GenerateCatalogFeed | custom.GlobaleGenerateCatalogFeed | Generates Catalog file and stores it in IMPEX/* folder |
| GlobaleCatalogFeed | Generates Catalog Feed and sends it to Global-e SFTP folder | UploadCatalogFeed | custom.GlobaleUploadCatalogFeed | Uploads generated Catalog file from IMPEX/* to Global-e SFTP folder |
| GlobaleOrderStatusFallback | Downloads and enqueues Global-e order status fallback files from SFTP | DownloadOrderStatusFiles | custom.GlobaleDownloadOrderStatusFiles | Downloads site-scoped order status files from Global-e SFTP and removes or archives them remotely |
| GlobaleOrderStatusFallback | Downloads and enqueues Global-e order status fallback files from SFTP | EnqueueOrderStatusFiles | custom.GlobaleEnqueueOrderStatusFiles | Parses downloaded order status files and enqueues fallback custom objects |
| GlobaleOrderStatusFallback | Downloads and enqueues Global-e order status fallback files from SFTP | ProcessOrderStatusFallbackQueue | custom.GlobaleProcessOrderStatusFallbackQueue | Drains the fallback CO queue and applies order status updates |