Skip to main content
Use this method only for Adobe Commerce as a Cloud Service instances, whose REST endpoint looks like https://<server>.api.commerce.adobe.com/<tenant-id>. CMS page and block actions are not available because the Cloud Service REST API does not include them.

​
Create an OAuth Server-to-Server credential

The credential gives you the Client ID, Client Secret and Organization ID you enter below. You need developer access to the Adobe Commerce as a Cloud Service - Backend - Commerce Cloud Manager product in your organization.

1

Open your project

Sign in to the Adobe Developer Console and select the organization that owns your Commerce instance.

  • Open an existing project or create a new one.
2

Add the Commerce API

In your workspace, open Add service and select API.

  • Select Adobe Commerce as a Cloud Service and click Next.
  • On the Configure API page, select OAuth Server-to-Server and click Save configured API.
3

Copy the credential values

Open the OAuth Server-to-Server credential of the workspace.

  • Copy the Client ID, the Client Secret and the Organization ID (it ends in @AdobeOrg).
  • Note the Technical account email. You add it to Commerce in the next section.
  • Check that the credential’s scopes include commerce.accs.

​
Give the technical account Commerce permissions

REST calls run as the credential’s technical account, so it must be an Admin user of the Commerce environment you connect, with a role that grants the resources you need. Each environment (for example production and staging) needs its own credential and its own Admin user.

1

Assign a role

Enables actions: Add Item To Cart, Add Order Comment, Cancel Order, Create Cart, Create Cart Price Rule, Create Category, Create Credit Memo (Refund), Create Customer Group, Create Invoice, Create Product, Create Shipment, Delete Cart Price Rule, Delete Category, Delete Coupon, Delete Customer, Delete Customer Group, Delete Product, Generate Coupons, Get Cart, Get Cart Price Rule, Get Category, Get Credit Memo, Get Customer, Get Customer Group, Get Invoice, Get Order, Get Product By SKU, Get Shipment, Get Stock Status, List Cart Price Rules, List Categories, List Coupons, List Credit Memos, List Customer Groups, List Customers, List Invoices, List Orders, List Products, List Shipments, List Source Items, List Store Configurations, List Store Groups, List Store Views, List Tax Classes, List Tax Rates, List Tax Rules, List Websites, Remove Cart Item, Send Invoice Email, Update Cart Item, Update Cart Price Rule, Update Category, Update Customer, Update Customer Group, Update Product, Update Source Items

In the Commerce Admin, add the technical account email as an Admin user and assign it a role.

  • Roles are managed in System > Permissions > User Roles.
  • Under Role Resources, choose All or select the resources listed below. Actions that use a resource the role does not include return 401 Unauthorized.

​
Find your REST endpoint

Open Adobe Experience Cloud, go to the Commerce Cloud Service instances page, and click the information icon next to your instance. Copy the REST endpoint, for example https://na1.api.commerce.adobe.com/AbCYab34cdEfGHiJ27123. Do not add /rest or /V1.

​
Choose a Store Code (optional)

Cloud Service selects the store scope with a Store header instead of the URL. StackOne sends the Store Code you enter as that header.

  • Leave it empty to send no Store header.
  • default targets the default store view, and all runs requests in the global scope.
  • Or enter a specific store view code, as listed by the List Store Views action.
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.