Shopper Configurations

GET Retrieves configurations

GET /organizations/{organizationId}/configurations

Operation ID: getConfigurations. Security: ShopperToken (sfcc.shopper-configurations, sfcc.shopper-standard); ShopperClientContextToken (sfcc.shopper-configurations, sfcc.shopper-standard).

Retrieves configurations for the specified organization and site.

Parameters

• organizationId (path, OrganizationId, required) An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character realm identifier and a 3-character instance type identifier.

  Example

  f_ecom_zzxy_prd

• siteId (query, SiteId, required) The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.

  Example: SiteId

  RefArch

• sfdc_usid (header, string (uuid)) A unique shopper identifier (USID) for tracking client context. Used with endpoints secured with ShopperClientContextToken. This header is required for all endpoints secured with ShopperClientContextToken.
  Example: 550e8400-e29b-41d4-a716-446655440000.
• personalized (query, string) Controls whether personalization is applied to the response. When set to none, the server skips applying personalization to the response.
  Allowed values: none. Example: none.
• sfdc_shopper_context (header, string) Shopper context information (for example clientIP, sourceCode, and customQualifiers) passed in from a trusted backend application.

Responses

• 200 Retrieved configurations successfully.

  Media type: application/json. Schema: SiteConfiguration.

  Example: ConfigurationsExample

  {
    "configurations": [
      {
        "id": "id",
        "value": "RefArch",
        "configurationType": "siteConfiguration"
      },
      {
        "id": "name",
        "value": "Ref Arch",
        "configurationType": "siteConfiguration"
      },
      {
        "id": "status",
        "value": "online",
        "configurationType": "siteConfiguration"
      },
      {
        "id": "timezone",
        "value": "Etc/UTC",
        "configurationType": "siteConfiguration"
      },
      {
        "id": "timezoneOffset",
        "value": 0,
        "configurationType": "siteConfiguration"
      },
      {
        "id": "defaultCurrency",
        "value": "USD",
        "configurationType": "siteConfiguration"
      },
      {
        "id": "allowedCurrencies",
        "value": [
          "USD",
          "EUR"
        ],
        "configurationType": "siteConfiguration"
      },
      {
        "id": "defaultLocale",
        "value": "en-US",
        "configurationType": "siteConfiguration"
      },
      {
        "id": "allowedLocales",
        "value": [
          {
            "id": "en-US",
            "country": "US",
            "default": true,
            "displayCountry": "United States",
            "displayLanguage": "English",
            "displayName": "English (United States)",
            "iso3Country": "USA",
            "iso3Language": "eng",
            "language": "en",
            "name": "English (United States)"
          },
          {
            "id": "en-CA",
            "country": "CA",
            "default": false,
            "displayCountry": "Canada",
            "displayLanguage": "English",
            "displayName": "English (Canada)",
            "iso3Country": "CAN",
            "iso3Language": "eng",
            "language": "en",
            "name": "English (Canada)"
          }
        ],
        "configurationType": "siteConfiguration"
      },
      {
        "id": "SalesforcePaymentsAllowed",
        "value": true,
        "configurationType": "globalConfiguration"
      },
      {
        "id": "gcp",
        "value": "abc123",
        "configurationType": "globalConfiguration"
      }
    ]
  }

• 400 Bad request - invalid parameters provided.

  Media type: application/json. Schema: ErrorResponse.

  Example: getShopperConfigurations400 Bad Request Error

  Example of a 400 Bad Request error response

  {
    "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
    "title": "Bad Request",
    "detail": "The request could not be processed due to invalid parameters.",
    "correlationId": "12345678-1234-1234-1234-123456789012"
  }

• 401 Your shopper JWT is invalid and cannot be used to identify the API client.

  Media type: application/json. Schema: ErrorResponse.

  Example: getShopperConfigurations401 Unauthorized Error

  Example of a 401 Unauthorized error response

  {
    "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unauthorized",
    "title": "Unauthorized",
    "detail": "Your shopper JWT is invalid and cannot be used to identify the API client.",
    "correlationId": "12345678-1234-1234-1234-123456789012"
  }

• 404 Application context not found for the specified organization and site.

  Media type: application/json. Schema: ErrorResponse.

  Example: getShopperConfigurations404 Not Found Error

  Example of a 404 Not Found error response

  {
    "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/not-found",
    "title": "Not Found",
    "detail": "Configuration not found for the specified organization and site.",
    "correlationId": "12345678-1234-1234-1234-123456789012"
  }