Ruby developer? Check out our official ruby gem on Github.
Commerce Layer exposes a fast REST API that lets you add ecommerce to your favorite tech stack. This guide is your reference for all the operations that you can perform on the API resources.
All API requests must be made over HTTPS to the following base endpoint:
subdomain parameter is the unique subdomain of your organization. The rest of the documentation omits the base endpoint from all the example requests.
Commerce Layer API is 100% compliant with the JSON API specification (v1.0). It supports compound documents, sparse fieldsets, resource linking, filtering, sorting, pagination and more. The JSON API community has shared some client libraries that can help you get started. Official libraries and SDKs for the most popular languages are coming soon.
Commerce Layer implements the industry-standard OAuth 2.0 protocol to manage clients authorization. It defines four types of applications:
- Best suited to create storefront channels, like an ecommerce website or application.
- Perfect to integrate any 3rd party system, like an ERP or a CRM, that needs custom permissions.
- Used to authenticate our official Zapier app (currently in beta) and to build any workflow.
- Used to authenticate users and access resources on their behalf.
Which application to use depends on your specific use case. Official guides and tutorials for the most popular use cases are coming soon.
For each organization, you can work either in test mode (default) or live mode. Working in test mode is free forever. You can try Commerce Layer in test mode as long as you need. 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 application credentials to make the switch.