Configuration Values

For each B2C Commerce instance that uses the Salesforce Commerce API, you must gather a set of configuration values related to that instance. These configuration values are required to complete the setup process and to formulate API requests.

A typical set of configuration values looks like this:

Configuration ValueExample
Organization IDf_ecom_zzte_053
Short codekv7kzm78
Site IDRefArch

This guide provides more details on each configuration value and shows you where to find them.

The organization ID is a short string that identifies a B2C Commerce instance. Each instance gets its own unique organization ID, such as f_ecom_zzte_053.

You can look up the organization ID for an instance through Business Manager. You must have the Business Manager Administrator role in Account Manager and know the Business Manager URL for the instance.

A Business Manager URL looks like this:

To look up the organization ID:

  1. Go to the Business Manager URL for your instance.
  2. Log in using your Account Manager credentials.
  3. Go to Administration > Site Development > Salesforce Commerce API Settings.

The organization ID is displayed on the page. Click Copy to Clipboard and paste it in a location that is easy to refer to later.

image.png

Realm ID

The part of the organization ID following the second and third underscore (_) character is a four-character string called the realm ID. If the organization ID is f_ecom_zzte_053, then the realm is zzte.

A realm describes a set of B2C Commerce instances, including both primary and secondary instances. To learn more about realms, see Concepts and Terminology in the B2C Commerce documentation.

Instance ID

The part of the organization ID following the third underscore (_) character is a three-character string called the instance ID. If the organization ID is f_ecom_zzte_053, then the instance ID is 053.

The instance ID is a three-character string for identifying an instance within a realm:

  • For production, staging, or development instances, the instance IDs are prd, stg, or dev, respectively.
  • For on-demand sandboxes, the instance ID is a three-digit number that increases as more sandboxes are created.
  • For POD sandboxes, the format of the instance ID is sXX, where XX is a number between from 01 to 99.

Tenant ID

A B2C Commerce instance is considered a “tenant” when it is associated with a supporting system, such as the Shopper Login and API Access Service (SLAS). To associate an instance with a system like SLAS, you must identify the instance with a tenant ID. A tenant ID begins with a four-character realm ID, followed by an underscore (_) and an instance ID.

Example tenant IDs for various types of instances:

Instance TypeRealm IDInstance IDTenant ID
Stagingbcglstgbcgl_stg
On-demand sandboxzzte053zzte_053
POD sandboxzzrfs01zzrf_s01

The short code is an eight-character string that is assigned to a realm for routing purposes. The short code applies to your entire realm, across all instances.

The short code is in the same place as the organization ID. To look it up:

  1. Go to the Business Manager URL for your instance.
  2. Log in using your Account Manager credentials.
  3. Go to Administration > Site Development > Salesforce Commerce API Settings.

If you’ve never used the Commerce API in your realm, click Request Short Code to request one.

image.png

It can take up to 24 hours for the short code to propagate through the CDN and all the routing systems in your configuration.

The short code is concatenated with api.commercecloud.salesforce.com to create the API host name for your API calls. For example: u8ak193h.api.commercecloud.salesforce.com

The site ID is the name of the site (sometimes called a “channel”) for which you want to access data. For example: RefArch or SiteGenesis.

To see a list of sites in Business Manager:

  1. Go to the Business Manager URL for your instance.
  2. Log in using your Account Manager credentials.
  3. Go to Administration > Sites > Manage Sites.

To learn more about site names, see Create a Site in Business Manager in the B2C Commerce documentation.

After gathering all the configuration values for your B2C Commerce instances, you’re ready for the next guide in the Get Started series: Authorization.