j
Stores
1.2.0
API Overview
The Stores API provides access to store data within the Data API family. This API allows you to retrieve and search for stores using complex query expressions.
Features
- Get Stores: Retrieve a paginated list of all stores in an organization
- Store Search: Search for stores using flexible query expressions
- Complex Queries: Support for term queries, text queries, boolean queries, and range filters
- Sorting: Sort results by any searchable field
- Pagination: Built-in pagination support with configurable limits and offsets
- Field Selection: Use the select parameter to retrieve only specific fields
Endpoints
GET /organizations/{organizationId}/stores
Retrieve a list of all stores within the specified organization. This endpoint returns all stores without any filtering and supports pagination for results.
Parameters:
organizationId(required) - The organization identifiersiteId(required) - The site identifieroffset(optional) - Zero-based index of the first store to return (default: 0)limit(optional) - Maximum number of stores to return (default: 50, max: 200)select(optional) - Property selector to retrieve only specific fields
GET /organizations/{organizationId}/stores/{id}
Retrieve detailed information for a specific store by ID.
Parameters:
organizationId(required) - The organization identifiersiteId(required) - The site identifierid(required) - The ID of the store to retrieveselect(optional) - Property selector to retrieve only specific fields
Error Responses:
404- Store not found when the specified store ID does not exist
POST /organizations/{organizationId}/store-search
Search for stores using flexible query expressions with support for filtering, sorting, and pagination.
Searchable Fields
The following fields are searchable in store queries:
id- Store identifier (String)name- Store name (String)address1- Primary address (String)address2- Secondary address (String)city- City name (String)stateCode- State code (String)postalCode- Postal code (String)countryCode- Country code (String)phone- Phone number (String)fax- Fax number (String)email- Email address (String)latitude- Geographic latitude (Double)longitude- Geographic longitude (Double)inventoryId- Associated inventory list ID (String)storeHours- Store hours information (String)storeEvents- Store events information (String)
Authentication
This API uses OAuth 2.0 client credentials flow via Account Manager with the following scope:
sfcc.stores- Read access to store resources
Related APIs
- Shopper Stores API: Shopper-facing store search with geolocation support
- Inventory APIs: Manage inventory associated with stores
https://{shortCode}.api.commercecloud.salesforce.com/store/stores/v1
DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!