REST API Overview
The REST API documentation describes the REST APIs that are available in Adobe Commerce (PaaS) and Adobe Commerce as a Cloud Service (SaaS).
The APIs can be used to perform a wide array of tasks. For example:
Create a shopping app. This can be a traditional app that a user downloads on a mobile device. You could also create an app that an employee uses on a showroom floor to help customers make purchases.
Integrate with CRM (Customer Relationship Management) or ERP (Enterprise Resource Planning) backend systems, such as Salesforce or Xero.
Integrate with a CMS (Content Management System). Currently, content tagging is not supported.
Adobe Commerce
PaaS only
Adobe Commerce on Cloud, Adobe Commerce on-premises, and Magento Open Source 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
Adobe Commerce provides a wide range of REST API endpoints that allow you to perform actions on behalf of Commerce administrators, customers, and guest shoppers. Integrations are also supported.
Authentication
Adobe Commerce REST APIs support multiple authentication methods, including:
- Third-party applications authenticate with OAuth 1.0a.
- Mobile applications authenticate using tokens.
- Administrators and customers are authenticated with login credentials.
URL structure
The URL for Adobe Commerce REST endpoints is structured as follows:
https://<host>/rest/<store-view-code>/<endpoint>
Adobe Commerce as a Cloud Service
SaaS only
The Adobe Commerce as a Cloud Service REST API serves as a critical tool for extending and integrating commerce functionalities, but the endpoints available differ significantly from the REST APIs for Adobe Commerce on Cloud and on-premises deployments.
The following key differences are important to consider when planning your REST API integrations with Adobe Commerce as a Cloud Service:
Endpoints
Primarily the Cloud Service REST API differs in that it includes a smaller subset of endpoints. Specifically, the customer and guest REST APIs that are available in Adobe Commerce on Cloud and on-premises deployments are not available in Adobe Commerce as a Cloud Service. However, access to similar functionality remains available with the GraphQL APIs.
Authentication
In previous versions of Adobe Commerce, you would use authentication tokens to authorize your requests to the REST API. In Adobe Commerce as a Cloud Service, you must use Adobe Identity Management Service (IMS) to authenticate your requests.
The authentication system supports both interactive user-based workflows and automated server-to-server integrations, ensuring secure and appropriate access for different use cases. Both of these authentication methods require every request to be signed with an IMS Access Token. For a practical implementation guide with code examples for server-to-server integration, see our Server-to-Server Integration Guide.
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, /rest is no longer needed.
Cloud Service URLs use the following format:
https://<server>.api.commerce.adobe.com/<tenant-id>/<endpoint>
