New Elastic Path Documentation Beta Release
We’re excited to announce that we are working on a new documentation site.
This is the point where we need your help. Come and test out our new documentation at elasticpath.dev/docs.
In addition to a new, user-friendly, visual design, we have reorganized our content, improving navigation and making it easier for you to find the information you need.
And check out our new customer feedback feature!
We can’t wait to see you!
If you want to evaluate Commerce Cloud, please contact us to speak with an Elastic Path representative.
This API Reference Guide describes the resources, endpoints, methods, requests, and responses that are available to you in the Commerce Cloud API. For an overview of the top-level endpoints, see the API Endpoints Overview section.
For backward compatibility, code samples and URLs continue to use
Introduction to API
The Commerce Cloud API follows a microservice architecture that enables you to plug commerce into any part of your application. The API is inspired by the JSON API specification, follows predictable REST API URLs, and supports cross-origin resource sharing. The two-track authentication layer enables destructive and non-destructive actions across projects.
API Base URLs
Elastic Path Commerce Cloud supports multiple geographical regions. For each customer, Elastic Path Commerce Cloud accounts and stores are created in a specific region. When you interact with and use the Elastic Path Commerce Cloud API, ensure that you use the API end point for the region your store is in. To view the API base URL field, go to Settings > Application Keys in Commerce Manager.
In the documentation, we use the variable name
<your_elasticpath_api_base_url> in the sample requests. When making API requests, customers substitute the hostname for the variable.
All requests must include an authentication token in the header. Generate the token by using your API keys.
- To find your API keys, go to Settings > Application Keys section in Commerce Manager.
- To use the API to generate a token from your API keys, see the Authentication or Your first API request sections.
- To learn more about API keys, see the Security section.
If you are looking to test or develop with the Commerce Cloud API, we recommend using the Elastic Path Postman collection. The collection includes all endpoints.
Software Development Kits
Elastic Path officially maintains the following Software Development Kits (SDK) for Commerce Cloud. Other community-driven SDKs are available within the Moltin GitHub organization.
The Legacy label indicates that an enhanced replacement service is now available. The API resources and endpoints marked as legacy are still supported for existing stores, that is, there are no breaking changes. However, for new stores, you should use the replacement service to take advantage of the enhancements. For a summary of legacy resources, see Legacy API resources.
Elastic Path Documentation & API Help
You can find the supporting documentation and help in the following resources:
- Commerce Cloud documentation - The home page for all Elastic Path documentation and help.
- Key Concepts - Learn about commerce topics and understand how Elastic Path implements the concepts.
- Your first API request - Learn how to make your first API call.
- How-to guides - Learn how to achieve your goals with step-by-step instructions.
You can find a self-serve Commerce Cloud API course and other learning opportunities at Elastic Path Education. Sign in, select the Content Library, and search for
Commerce Cloud API.
The [Reference Experience stores](/commerce-cloud/docs/developer/get-started/shopkit demo.html) page contains instructions on how to set up shopkit and integration examples.