Storefronts

GET Get storefronts for an organization.

GET /organizations/{organizationId}/storefronts

Operation ID: getStorefronts. Security: AmOAuth2 (sfcc.storefront.storefronts, sfcc.storefront.storefronts.rw).

Retrieves the list of storefronts provisioned for the organization, ordered by creationDate ascending.

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
  • 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 storefronts successfully retrieved.

    Media type: application/json. Schema: StorefrontResult.

    Example: StorefrontListSuccess Successful storefront list result

    Example of a successful response returning the list of storefronts for an organization.

    {
      "limit": 25,
      "offset": 0,
      "total": 2,
      "data": [
        {
          "storefrontId": "market-street-a1b2c3",
          "storefrontName": "MarketStreet",
          "type": "storefront_next",
          "setupStatus": "success",
          "sites": [
            "MarketStreet"
          ],
          "creationDate": "2026-04-08T21:47:28.188965Z",
          "lastModified": "2026-04-08T21:47:31.307595Z"
        },
        {
          "storefrontId": "beauty-street-d4e5f6",
          "storefrontName": "BeautyStreet",
          "type": "pwa_kit",
          "setupStatus": "in_progress",
          "sites": [
            "BeautyStreet"
          ],
          "creationDate": "2026-04-09T10:12:00.000000Z",
          "lastModified": "2026-04-09T10:12:00.000000Z"
        }
      ]
    }
  • 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"
    }