Skip to main content
The Global-e cartridges use SFCC services for all API data exchange with Global-e. Outbound URL and GUID resolution is driven by site preferences and merchant GUID credentials — not per-endpoint service credentials. For the standard service list and base setup, see Configuration.

Configuration model

MerchantAccount.getApiBaseUrl() reads geApiUrl. MerchantAccount.getMerchantGuid() reads the canonical credential password. Inbound validation (guard.js, payload validators) always uses the canonical GUID.

Merchant GUID credentials (required)

Metadata import provides Globale-MerchantAccount (empty stub linked to service instances). Operators must create account ID credentials in Business Manager: Create one row per merchant account ID used on the instance (for example Globale-10001 and Globale-10002). Match geClientJsMerchantId on each site. Set geApiUrl per site for the API environment. Optional additional credentials (password only), referenced from geServiceEndpointConfig, for cross-environment GUID overrides (for example Globale-10001-PROD).

Service endpoint overrides (geServiceEndpointConfig)

Site preference in the Global-e Settings (GLOBALE) BM group. Keys are SFCC service IDs (for example Globale-RecentProductCountryS). Values:
  • String — relative path (appended to geApiUrl) or full https:// URL.
  • Object — { "url": "/path or https://...", "credentialId": "Globale-10001-PROD" } when the outbound call must use an alternate protected GUID credential.
When the preference is empty, cartridge defaults apply with geApiUrl. Example — QA site calling Production product restrictions:
Example — alternate GUID for one service on a test sandbox:

Multiple Global-e accounts

Set geClientJsMerchantId per site and create matching Globale-{merchantId} credentials (GUID only). Use geApiUrl per site for environment targeting (INT, QA, HF, etc.).

Merchant GUID on API calls

By default the cartridge sends the resolved GUID as the MerchantGUID HTTP header only. To force query-parameter auth for a specific service, set geServiceMerchantGuidAuthConfig — a site preference in the Global-e Settings (GLOBALE) BM group. Keys are SFCC service IDs; any service not listed keeps the default header behavior:
Inbound requests do not use geServiceEndpointConfig credential overrides — they always validate against the canonical Globale-{merchantId} GUID.

SFTP and service profiles

SFTP upload credentials (Globale-SFTPDownload, catalog/restrictions feeds) remain separate — they are not Global-e HTTP API credentials. Service instances in metadata/services.xml still define profiles (timeout, circuit breaker, comm-log, force-prd). HTTP services reference the stub credential Globale-MerchantAccount; runtime code selects Globale-{merchantId} for GUID resolution.

See also

  • Configuration — site preferences and merchant GUID credentials
  • Metadata — geApiUrl, geServiceEndpointConfig, geServiceMerchantGuidAuthConfig
  • Jobs overview — services used by Global-e jobs