Environments

GET Get environments for a storefront.

GET /organizations/{organizationId}/storefronts/{storefrontId}/environments

Operation ID: getEnvironmentsForStorefront. Security: AmOAuth2 (sfcc.storefront.environments, sfcc.storefront.environments.rw).

Retrieves the list of environments belonging to the specified storefront, ordered by creationDate in ascending order.

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
  • storefrontId (path, string, required) The storefront identifier that B2C Commerce generates based on the provided storefront name. It consists of lowercase letters, numbers, and hyphens only, with no leading or trailing hyphens.
    Minimum length: 1. Maximum length: 20. Pattern: ^[a-z0-9]+(?:-+[a-z0-9]+)*$. Example: my-storefront-a1b2c3.
  • limit (query, integer (int32)) Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 25.
    Default: 25. Minimum: 1. Maximum: 200.
  • offset (query, integer (int32)) Used to retrieve the results based on a particular resource offset.
    Default: 0. Minimum: 0.

Responses

  • 200 List of environments successfully retrieved.

    Media type: application/json. Schema: EnvironmentResult.

    Example: EnvironmentListSuccess Successful environment list result

    Example of a successful response returning the list of environments for a storefront.

    {
      "limit": 25,
      "offset": 0,
      "total": 1,
      "data": [
        {
          "environmentId": "production-a1b2c3d4",
          "displayName": "Production",
          "status": "ready",
          "isPrimary": true,
          "subdomain": "production",
          "mrtOrigin": "https://production-my-storefront.exp-delivery.com",
          "defaultEcdnHostname": "marketstreetb82739d375a9270f.zzzz-001.my.cc.salesforce.com",
          "creationDate": "2026-04-08T21:47:28.188965Z",
          "lastModified": "2026-04-08T21:47:31.307595Z"
        }
      ]
    }
  • 401 Your access token is invalid or expired and can’t be used to identify a user.

    Media type: application/problem+json. Schema: ErrorResponse.

    Example: UnauthorizedExample

    {
      "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unauthorized",
      "title": "Unauthorized",
      "detail": "Unauthorized request"
    }
  • 403 Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.

    Media type: application/problem+json. Schema: ErrorResponse.

    Example: ForbiddenExample

    {
      "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/forbidden",
      "title": "Forbidden",
      "detail": "Access to requested resource forbidden"
    }
  • 404 We couldn't find the requested storefront.

    Media type: application/problem+json. Schema: StorefrontNotFoundErrorResponse.

    Example: StorefrontNotFoundErrorResponseExample

    {
      "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/storefront-not-found",
      "detail": "We couldn't find storefront my-storefront-a1b2c3.",
      "title": "Storefront Not Found"
    }