Installation

Installation has two main steps: upload cartridges to the active code version, then import Global-e metadata. Business Manager configuration is covered in Configuration.

See Cartridges to choose the right cartridge set for your storefront (SFRA, SiteGenesis, headless, or popups-only) and for b2c code deploy examples per architecture.

Upload cartridges

Upload int_globale and the storefront cartridge for your architecture:

Architecture	Upload
SFRA	int_globale + int_globale_sfra
SiteGenesis	int_globale + int_globale_sitegenesis
Headless / PWA	int_globale + int_globale_headless (add int_globale_sfra or int_globale_sitegenesis if the site also serves a traditional storefront)
Country Switcher only	int_globale + int_globale_sfra_popups or int_globale_sitegenesis_popups

Upload to the active code version on your Salesforce B2C Commerce instance using the b2c CLI. If you build client assets from source, run the compile scripts in the repository package.json before deploy.

Example (SFRA):

b2c code deploy ./cartridges -c int_globale -c int_globale_sfra --server your-sandbox-hostname.demandware.net --reload

Import metadata

Import Global-e metadata before using cartridge functionality. Import in this order (all in MERGE mode):

Order	Content	Repo path	Business Manager
1	System object Global-e custom attributes	metadata/meta/system-objecttype-extensions.xml	Administration → Site Development → Import & Export
2	Global-e custom object definitions	metadata/meta/custom-objecttype-definitions.xml	Administration → Site Development → Import & Export
3	Global-e services	metadata/services.xml	Administration → Operations → Import & Export
4	Global-e jobs	metadata/jobs.xml	Administration → Operations → Import & Export
5	Global-e payment method	metadata/site/paymentmethod.xml	Merchant Tools → Ordering → Import & Export
6	Global-e shipping methods	metadata/site/shippingmethods.xml	Merchant Tools → Ordering → Import & Export

Optional demo data under metadata/demo/ is for sandbox examples only — do not import to production without review. Demo custom object types (DEMO_GLOBALE_*) are described in Metadata; do not rely on demo data or demo object records in production.

OCAPI templates live in metadata/ocapi-settings/:

• wapi_shop_config.json — Shop API (headless / Commerce API)
• wapi_data_config.json — Data API for Global-e configuration sync and read access (mandatory for new integrations)

Apply equivalent permissions in Business Manager — see Configuration § Open Commerce API Settings.

After import

1. Create the GLOBALE payment processor manually (not included in metadata) — see Configuration § Payment Processor
   

2. Configure site preferences and cartridge path — Configuration
   

3. Create merchant GUID credentials (Globale-{merchantId}) in Business Manager — required for every Global-e account used on the instance; see Configuration → Merchant GUID credentials
   

4. Create a dedicated Account Manager API client and apply Data OCAPI settings — Configuration → Data API; also required per Requirements
   

5. Run the GlobaleSettings job — Configuration § Scheduled Jobs; see Jobs for all cartridge jobs.
   

6. Site preference reference — Metadata