Stores

GET Get Stores

GET /organizations/{organizationId}/stores

Operation ID: getStores. Security: AmOAuth2 (sfcc.stores, sfcc.stores.rw).

Retrieve a list of all stores in an organization. Pagination is supported for results.

This endpoint returns all stores within the specified organization without any filtering. Use the offset and limit parameters to control pagination.

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
```
select (query, Select)
Example: select
```
(**)
```
limit (query, integer (int32)) Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 50.
Default: 50. 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 Returns a paginated list of stores

Media type: application/json. Schema: StoreResult.

Example: StoreResultSuccess Successful store list result

Example response for a successful get stores request with pagination

{
  "limit": 2,
  "offset": 0,
  "total": 5,
  "data": [
    {
      "id": "store-001",
      "name": "Downtown Store",
      "address1": "123 Main St",
      "address2": "Suite 100",
      "city": "San Francisco",
      "stateCode": "CA",
      "postalCode": "94102",
      "countryCode": "US",
      "phone": "+1-555-123-4567",
      "email": "downtown@example.com",
      "latitude": 37.7749,
      "longitude": -122.4194,
      "inventoryId": "inventory-001",
      "storeHours": {
        "default": {
          "markup": "08:00 am - 07:30 pm",
          "source": "08:00 am - 07:30 pm"
        }
      },
      "storeEvents": {
        "default": {
          "markup": "Sale 40% off",
          "source": "Sale 40% off"
        }
      },
      "storeLocatorEnabled": true,
      "posEnabled": true,
      "creationDate": "2023-01-15T10:30:00.000Z",
      "lastModified": "2024-06-20T14:45:00.000Z",
      "c_customAttribute": "Custom Value"
    },
    {
      "id": "store-002",
      "name": "Downtown Plaza",
      "address1": "456 Market St",
      "city": "San Francisco",
      "stateCode": "CA",
      "postalCode": "94103",
      "countryCode": "US",
      "phone": "+1-555-234-5678",
      "email": "plaza@example.com",
      "latitude": 37.7833,
      "longitude": -122.4167,
      "inventoryId": "inventory-002",
      "storeHours": {
        "default": {
          "markup": "08:00 am - 07:30 pm",
          "source": "08:00 am - 07:30 pm"
        }
      },
      "storeLocatorEnabled": true,
      "posEnabled": false,
      "creationDate": "2023-03-20T08:15:00.000Z",
      "lastModified": "2024-07-10T16:20:00.000Z"
    }
  ]
}

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": "Your access token is invalid or expired and can’t be used to identify a user."
}

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": "Your access token is valid, but you don’t have the required permissions to access the resource."
}