Skip to content

Rest API. Store header usage in ACCS #485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keharper merged 6 commits into from
Aug 28, 2025
Merged

Rest API. Store header usage in ACCS #485

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d5bd3d4
Rest API - Product Media Import Roles are assigning on Store level
andimov Aug 26, 2025
42155bb
Minor edits
keharper Aug 28, 2025
92fd5f5
Merge branch 'main' into patch-1
keharper Aug 28, 2025
2155b7c
linting
keharper Aug 28, 2025
c8723ec
another linting thing
keharper Aug 28, 2025
877e665
Update broken link
keharper Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions src/pages/rest/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The APIs can be used to perform a wide array of tasks. For example:

<Edition name="paas" />

[Adobe Commerce on Cloud](https://experienceleague.adobe.com/en/docs/commerce-on-cloud/user-guide/overview?lang=en), Adobe Commerce on-premises, and [Magento Open Source](https://experienceleague.adobe.com/docs/magento-open-source/user-guide/overview/overview.html?lang=en) all use the same REST API framework. The REST API documentation describes the REST APIs that are available in these versions of Adobe Commerce and Magento Open Source.
[Adobe Commerce on Cloud](https://experienceleague.adobe.com/en/docs/commerce-on-cloud/user-guide/overview?lang=en), Adobe Commerce on-premises, and [Magento Open Source](https://experienceleague.adobe.com/en/docs/commerce-admin/start/guide-overview) all use the same REST API framework. The REST API documentation describes the REST APIs that are available in these versions of Adobe Commerce and Magento Open Source.

### Endpoints

Expand Down Expand Up @@ -63,8 +63,27 @@ The authentication system supports both [interactive user-based workflows](./aut

### URL structure

The URL structure for your REST endpoints will be slightly different in Adobe Commerce as a Cloud Service. In addition to your base URL changing, the route no longer contains the string `/rest`, nor does it contain the store view code. The store view code is specified in the `Store` header of the request.
In Adobe Commerce as a Cloud Service, REST endpoint URLs do not include `/rest` or the store view code. The store scope is specified via the `Store` HTTP header.

Cloud Service URLs use the following format:
* Base format:

`https://<server>.api.commerce.adobe.com/<tenant-id>/<endpoint>`
`https://<server>.api.commerce.adobe.com/<tenant-id>/<endpoint>`

* Set the scope with the `Store` header:

* Predefined values:

* `Store: all` — Execute in the global scope
* `Store: default` — Target the default store view (or use your specific store view code)

* You can also pass any specific store view code: `Store: <store_view_code>`

The following `curl` command shows the request pattern:

```bash
curl --location 'https://<server>.api.commerce.adobe.com/<tenant-id>/<endpoint>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Store: <all | default | <store_view_code>>'
....
```