Basic info about endpoints, resources, credentials, and environments
The guide that follows is your reference for all the operations that you can perform on the API resources and contains all the information you need to get a comprehensive overview of how it works.
yourdomainis the unique subdomain of your organization.
- The resource object and its fields, attributes, and relationships.
- The allowed CRUD operations you can perform on the related endpoint with basic examples of the request/response format.
Commerce Layer implements the industry-standard OAuth 2.0 protocol to manage clients' authorization. It defines three types of applications that provide different API credentials: sales channel, integration, webapp. Which one to use depends on your specific need. You can leverage our how-tos to get started with the most popular use cases.
For each organization, you can work either in test mode (default) or live mode.
Test mode also provides you with a development environment after the go-live. All API calls are identical between the two environments. Use test or live API credentials (applications) to make the switch.
To stay up-to-date with any changes we make on Commerce Layer APIs, apps, and open-source projects (including versioning, product releases, new features, and general improvements), make sure to check our changelog.