Adobe Commerce only. Learn more
Using the storefront API
The storefront API endpoints for all storefront API operations operations are:
Environment | URL |
---|---|
Testing | |
Production |
You must also specify multiple HTTP headers, including an API key, with each request.
Authentication
Add authentication information here.
Headers
When making requests to the storefront API, you must include specific HTTP headers to ensure proper authentication and data retrieval. These headers provide necessary information, such as the channel ID, locale, price book, and optional price book and policy headers that tailor the API response to your needs.
The following table describes required (fixed form) headers:
Header name | Description |
---|---|
AC-Channel-ID | Required. The id for the channel that products will be sold through. For example, in the automotive industry, the channel could be dealers. In the manufacturing industry, the channel could be a manufacturing location for suppliers. Use the channels query to retrieve the list of available channels with the channel id. |
AC-Locale : | Required. The locale (language or geography) scope to filter products for display or update, for example en_US . Use the channels query to retrieve the locale IDs available for each channel. |
AC-Price-Book-ID | Optional. Defines how prices are calculated for a specific channel. Use if the merchant uses price books to calculate pricing. CCDM provides a default price book main with currency in US dollars. |
AC-Policy-{*} | Optional. The trigger name configured for a policy that sets data access filters to restrict product access based on request attributes and context. Examples include POS physical stores, marketplaces, or advertisement pipelines like Google, Meta, or Instagram. Use the policies query to retrieve the policy trigger names available for each policy. You can specify multiple policy headers per request. Example: AC-Policy-Country . |
Magento-Environment-ID | Required. Specify the environment id for the data space where commerce data is stored. Retrieve the SaaS data space id from Commerce Admin at Stores > Configuration > Services > Magento Services > SaaS Environment, or using the Commerce CLI command bin/magento config:show services_connector/services_id/environment_id command. |
X-Api-Key | Production public API key. |