Guides and tutorials

How-tos, handbooks and everything you need to build with Commerce Layer

Need to fetch prices and inventory, manage shopping carts, customer accounts, or checkout orders? This collection of guides and step-by-step tutorials is what you need, featuring how-tos, handy examples, and best practices for the most common scenarios.

Commerce Layer now supports explicit API versioning, and we just released a new version — see API versioning to learn how it works. The guides in this space refer to the legacy 2017-08 version, still the default when no version is specified. We encourage you to start planning your move to the new 2026-05 version: the legacy version will now only be maintained on a bug-fix basis, while all new features — starting with the redesigned payments flow — are developed for the latest one exclusively. As a result, these guides will likely become outdated soon and be replaced by new ones.

The 2026-05 version is stable, but its new resources — starting with the redesigned payments flow — are currently in beta. For now, the API reference for this version is the only publicly available documentation for them. The related Getting started guide and How-tos are coming soon. In the meantime, a playground repository shows the new payments flow at work, with a complete checkout for each supported gateway. If you'd like early access to the guides, reach out to us.

How it works

Each guide roughly follows the same schema and is developed across four main sections:

1. Problem A presentation of the issue you are facing.

2. Solution The recommended way to solve the problem. This is where you find the API calls you need to make, along with request/response detailed examples and an image that shows how the involved elements are mapped to the related resource fields.

3. Additional notes A special focus and some highlights of critical aspects around the topic, best practices, suggestions and more in-depth information.

4. More to read Links to the API reference, articles, blog posts, or any other resource that can help you getting more information about the subject.

A sample guide page structure

List of guides

These are the main guides that are currently available. Explore the left menu for subsections and more specific tutorials.

Product listing pageProduct pageShopping cartCheckoutPaymentsInventory strategies

Ask for more!

We are working hard to make our documentation as helpful as possible. This list of guides is constantly growing and will be regularly updated. Anyway, if you don't find what you need, feel free to contact our support team at any time or contribute by sending your PR on Github!

Please check also our Getting started guide for basic information on how to interact with the API, our API reference for all the details about each single core resource, and our changelog for regular updates on any changes, new features, or product releases.

Do you need to extract some kind of data information from your Commerce Layer's organization? We've got you covered. Try out our Metrics API and see how it can enable you to gather and aggregate useful data that you can leverage to measure the health and performance of your ecommerce business.