# Documentation that helps you ship

**Commerce Layer** provides the complete [transactional engine](#core-api) for modern commerce through powerful APIs. We handle the complexity of checkout, payments, inventory, orders management, and fulfillment so you can build shopping experiences that work everywhere — from traditional websites to mobile apps to [AI agents](#ready-for-the-agentic-age) making autonomous purchases. Your frontend, your CMS, your channels. Our commerce infrastructure.

## Docs-first platform

At Commerce Layer, documentation isn't an afterthought — it's our foundation, the primary interface between our engineering and yours. We treat documentation as a product with the same rigor we apply to our APIs themselves. We believe that great APIs deserve equally great docs, which is why we've invested heavily in creating comprehensive, accurate, and developer-friendly resources. Whether you're building your first integration or architecting a complex multi-market commerce system, our documentation and support are here to give you confidence that you're implementing things correctly.

This developer portal serves as your central hub for exploring everything Commerce Layer has to offer:

<table data-card-size="large" data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><h4><i class="fa-cart-circle-check">:cart-circle-check:</i></h4></td><td><strong>Core API</strong></td><td>The complete transactional commerce engine with hundreds of fast and secure REST API endpoints. Manage checkout, payments, inventory, orders, and fulfillment across any channel.</td><td><a href="#core-api">#core-api</a></td><td></td></tr><tr><td><h4><i class="fa-window-restore">:window-restore:</i></h4></td><td><strong>Pre-built applications</strong></td><td>Production-ready micro frontends you can deploy instantly or use as reference implementations. From hosted checkout and cart to customer portals — integrate with a link or fork and customize the code.</td><td><a href="#pre-built-applications">#pre-built-applications</a></td><td></td></tr><tr><td><h4><i class="fa-screwdriver-wrench">:screwdriver-wrench:</i></h4></td><td><strong>Developer tools</strong></td><td>SDKs, CLI, component libraries, and integrations for your entire workflow. Work in JavaScript, React, or the terminal — use Postman collections, OpenAPI schemas, or connect via Zapier for no-code automation.</td><td><a href="#developer-tools">#developer-tools</a></td><td></td></tr><tr><td><h4><i class="fa-chart-pie">:chart-pie:</i></h4></td><td><strong>Advanced APIs</strong></td><td>Specialized APIs that extend Core functionality with analytics and provisioning capabilities. Query commerce metrics directly, build custom dashboards, and automate team management across organizations.</td><td><a href="#advanced-apis">#advanced-apis</a></td><td></td></tr></tbody></table>

{% hint style="success" icon="user-group" %}
Want to get involved? Explore [our ecosystem](#build-with-us) to contribute code, stay updated, and connect with fellow developers.
{% endhint %}

## Ready for the agentic age

As a unified commerce engine that powers any transaction, anywhere, built API-first since day one, Commerce Layer is ready by design to be the enabler of a new era of interactions where AI agents don't just recommend products — they research, compare, and complete purchases autonomously on behalf of users. Enter [agentic commerce](https://commercelayer.io/agentic-commerce).

Our architecture enables AI agents to execute every commerce action programmatically. But having accessible APIs is only half the equation for agentic commerce. AI agents also need to understand how to use those APIs correctly, which means they need access to documentation in formats they can effectively consume and reason about. In short terms, documentation must also be AI-ready. That's why Commerce Layer docs follow close behind, offering some features you can leverage out of the box to ensure that AI systems can retrieve and provide accurate, contextual responses in real-time.&#x20;

### LLM-friendly <a href="#llm-friendly" id="llm-friendly"></a>

**Large Language Models** are becoming increasingly important for information retrieval and knowledge assistance. To make Commerce Layer APIs documentation content available in [text-based formats](https://llmstxt.org/) that are easier for LLMs to process, ingest, and work with, you can leverage the following `llms.txt` files.

* [Index](https://docs.commercelayer.io/llms.txt) — contains an index of all the page URLs and titles of our API docs sites, providing a comprehensive list of all available markdown-formatted pages:

```
https://docs.commercelayer.io/llms.txt
```

* [Full content](https://docs.commercelayer.io/llms-full.txt) — contains the full content of our API docs sites in one file that can be passed to LLMs as context:

```
https://docs.commercelayer.io/llms-full.txt
```

{% hint style="info" icon="circle-info" %}
On top of that, all of the pages of Commerce Layer docs are automatically available as markdown files. If you add the `.md` extension to any page, you will see the content of that page rendered in markdown which you can pass to an LLM for more efficient processing than an HTML file.
{% endhint %}

### MCP server <a href="#mcp-server" id="mcp-server"></a>

**Model Context Protocol** gives AI tools a structured way to discover and retrieve your docs as resources — no scraping required. To allow AI assistants to access Commerce Layer APIs documentation content directly, making it easy for tools like [Claude Desktop](https://code.claude.com/docs/en/mcp), [Cursor](https://cursor.com/docs/context/mcp), and [VS Code](https://code.visualstudio.com/docs/copilot/customization/mcp-servers) extensions to answer questions using the docs, we expose via `HTTP` an MCP server at the following URL:

```
https://docs.commercelayer.io/~gitbook/mcp
```

{% hint style="warning" %}
Visiting the URL above in your browser will result in an error. Instead, you can share this with tools that can make HTTP requests, like LLMs or IDEs.
{% endhint %}

## Core API

Build comprehensive commerce experiences with our API-first platform. Access hundreds of endpoints and webhooks to add global shopping capabilities — from dynamic pricing and distributed inventory to localized payments and intelligent order management — to any digital experience.

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><h4><i class="fa-rocket-launch">:rocket-launch:</i></h4></td><td><strong>Getting started</strong></td><td>Learn how to set up your Commerce Layer organization and place your first order. Follow our comprehensive onboarding guide to understand the data model, configure your environment, and start building quickly.</td><td><a href="https://app.gitbook.com/o/-Lfu_B3DKew-kvoEWzTk/s/-LgByaSP8eKjad-MIuHE/">Getting started</a></td><td></td></tr><tr><td><h4><i class="fa-book-open-lines">:book-open-lines:</i></h4></td><td><strong>API reference</strong></td><td>Explore our complete REST API with detailed documentation for all 100+ endpoints. Browse resource structures, discover 400+ available CRUD operations, and understand authentication patterns for every use case.</td><td><a href="https://app.gitbook.com/o/-Lfu_B3DKew-kvoEWzTk/s/RWJeylueWkzLadK710XZ/">API reference</a></td><td></td></tr><tr><td><h4><i class="fa-lightbulb">:lightbulb:</i></h4></td><td><strong>How-tos</strong></td><td>ccess step-by-step tutorials and practical examples covering common commerce scenarios. Learn best practices for implementing features like multi-currency pricing, promotions, and subscription management.</td><td><a href="https://app.gitbook.com/o/-Lfu_B3DKew-kvoEWzTk/s/-Lk-ezuDClaMavTqnRi0/">How-tos</a></td><td></td></tr><tr><td><h4><i class="fa-gear">:gear:</i></h4></td><td><strong>Rules engine</strong></td><td>Build flexible business logic tailored to your needs. Create dynamic pricing strategies, complex promotions, and conditional workflows using JSON-based rules with intuitive visual builders available.</td><td><a href="https://app.gitbook.com/o/-Lfu_B3DKew-kvoEWzTk/s/hiqD9AvrD8A8IPj7QXPv/">Rules Engine</a></td><td></td></tr><tr><td><h4><i class="fa-signal-stream">:signal-stream:</i></h4></td><td><strong>Event stream</strong></td><td>Stay synchronized with real-time resource changes using Server-Sent Events. Our Stream Hub provides enterprise customers with instant updates for orders, inventory, and all API resources without polling.</td><td><a href="https://app.gitbook.com/s/-LgByaSP8eKjad-MIuHE/event-stream-hub">Event stream hub</a></td><td></td></tr><tr><td><h4><i class="fa-diagram-project">:diagram-project:</i></h4></td><td><strong>Data model</strong></td><td>Understand how Commerce Layer structures commerce data through comprehensive E-R diagrams. Explore resource relationships, learn dependency patterns, and see how objects connect across the system.</td><td><a href="https://commercelayer.io/docs/data-model">https://commercelayer.io/docs/data-model</a></td><td></td></tr></tbody></table>

## Pre-built applications

Accelerate development with our production-ready commerce micro frontends. These open-source applications integrate seamlessly into your website with a simple link or serve as reference implementations for custom builds. Focus on your unique value while we handle core commerce functionality.

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><h4><i class="fa-cart-shopping">:cart-shopping:</i></h4></td><td><strong>Cart</strong></td><td>Implement a full-featured shopping cart with real-time inventory checks and automatic price updates. Customers can manage quantities, apply promo codes, and see personalized pricing across all markets.</td><td><a href="https://github.com/commercelayer/mfe-cart">https://github.com/commercelayer/mfe-cart</a></td><td></td></tr><tr><td><h4><i class="fa-credit-card">:credit-card:</i></h4></td><td><strong>Checkout</strong></td><td>Deploy a PCI-compliant, PSD2-ready checkout flow powered by Commerce Layer APIs. Support multiple payment methods, handle tax calculations, and enable seamless multi-market transactions out of the box.</td><td><a href="https://github.com/commercelayer/mfe-checkout">https://github.com/commercelayer/mfe-checkout</a></td><td></td></tr><tr><td><h4><i class="fa-circle-user">:circle-user:</i></h4></td><td><strong>My account</strong></td><td>Give customers a complete self-service portal to manage order history, saved addresses, and payment methods. Enable profile updates, track shipments, and handle returns without custom development.</td><td><a href="https://github.com/commercelayer/mfe-my-account">https://github.com/commercelayer/mfe-my-account</a></td><td></td></tr><tr><td><h4><i class="fa-user-viewfinder">:user-viewfinder:</i></h4></td><td><strong>Identity</strong></td><td>Streamline user authentication and account management with our hosted identity solution. Handle customer registration, password resets, and secure login flows while maintaining full brand consistency.</td><td><a href="https://github.com/commercelayer/mfe-identity">https://github.com/commercelayer/mfe-identity</a></td><td></td></tr><tr><td><h4><i class="fa-browsers">:browsers:</i></h4></td><td><strong>Microstores</strong></td><td>Launch lightweight commerce experiences for specific campaigns, collections, or markets. Create focused shopping environments that share your main store's inventory and backend without full site development.</td><td><a href="https://github.com/commercelayer/mfe-microstore">https://github.com/commercelayer/mfe-microstore</a></td><td></td></tr><tr><td><h4><i class="fa-browser">:browser:</i></h4></td><td><strong>Demo store</strong></td><td>Explore a fully functional static ecommerce site built with Commerce Layer, complete with SSR capabilities. Use it as a starting template, reference architecture, or learning resource for your projects.</td><td><a href="https://github.com/commercelayer/demo-store">https://github.com/commercelayer/demo-store</a></td><td></td></tr></tbody></table>

## Developer tools

Build fast and stay productive with our comprehensive developer toolkit. From SDKs and CLI tools to component libraries and integrations, we provide everything you need for modern development. Manage resources, automate workflows, and integrate Commerce Layer using your preferred tools and frameworks.

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><h4><i class="fa-key">:key:</i></h4></td><td><strong>JS Auth</strong></td><td>Simplify authentication flows with our lightweight JavaScript library. Handle OAuth2 tokens, manage refresh logic, and secure API calls across browser, server, or edge environments with minimal code.</td><td><a href="https://github.com/commercelayer/commercelayer-js-auth">https://github.com/commercelayer/commercelayer-js-auth</a></td><td></td></tr><tr><td><h4><i class="fa-gear-code">:gear-code:</i></h4></td><td><strong>JS SDK</strong></td><td>Interact with Commerce Layer APIs using our modern JavaScript SDK with full TypeScript support. Features tree-shaking for optimal bundle sizes, intuitive resource methods, and automatic token management.</td><td><a href="https://github.com/commercelayer/commercelayer-sdk">https://github.com/commercelayer/commercelayer-sdk</a></td><td></td></tr><tr><td><h4><i class="fa-eye-dropper">:eye-dropper:</i></h4></td><td><strong>Drop-in library</strong></td><td>Transform static HTML pages into enterprise-grade commerce sites with simple web components. Add prices, availability, cart functionality, and checkout to any page using only HTML attributes — no frameworks required.</td><td><a href="https://commercelayer.github.io/drop-in.js/">https://commercelayer.github.io/drop-in.js/</a></td><td></td></tr><tr><td><h4><i class="fa-terminal">:terminal:</i></h4></td><td><strong>CLI</strong></td><td>Manage your Commerce Layer operations directly from the terminal. Import data, export reports, create resources, generate checkout links, and automate complex workflows without leaving the command line.</td><td><a href="https://github.com/commercelayer/commercelayer-cli">https://github.com/commercelayer/commercelayer-cli</a></td><td></td></tr><tr><td><h4><i class="fa-react">:react:</i></h4></td><td><strong>React components</strong></td><td>Build custom commerce UIs with our composable React component library. Create flexible, interactive shopping experiences while maintaining full control over styling and behavior in your React applications.</td><td><a href="https://commercelayer.github.io/commercelayer-react-components/">https://commercelayer.github.io/commercelayer-react-components/</a></td><td></td></tr><tr><td><h4><i class="fa-shapes">:shapes:</i></h4></td><td><strong>App elements</strong></td><td>Replicate Commerce Layer's Dashboard design system in your custom applications. This React component library provides pre-built UI elements that match our interface, ensuring consistent user experiences.</td><td><a href="https://commercelayer.github.io/app-elements">https://commercelayer.github.io/app-elements</a></td><td></td></tr><tr><td><h4><i class="fa-list-tree">:list-tree:</i></h4></td><td><strong>OpenAPI schema</strong></td><td>Generate client libraries, validate requests, and build tooling using our complete OpenAPI specification. Access machine-readable API definitions to automate integration and streamline developer workflows.</td><td><a href="https://data.commercelayer.app/schemas/openapi.json">https://data.commercelayer.app/schemas/openapi.json</a></td><td></td></tr><tr><td><h4><i class="fa-bolt-lightning">:bolt-lightning:</i></h4></td><td><strong>Zapier app</strong></td><td>Connect Commerce Layer with 5,000+ third-party services through Zapier. Build no-code automation workflows for order processing, inventory updates, customer notifications, and business operations in minutes.</td><td><a href="https://zapier.com/apps/commerce-layer/integrations">https://zapier.com/apps/commerce-layer/integrations</a></td><td></td></tr><tr><td><h4><i class="fa-user-astronaut">:user-astronaut:</i></h4></td><td><strong>Postman collections</strong></td><td>Import all Commerce Layer API endpoints into Postman with a single click. Test API calls, explore resources, and debug integrations using our maintained workspace with pre-configured request examples.</td><td><a href="https://www.postman.com/commercelayer">https://www.postman.com/commercelayer</a></td><td></td></tr></tbody></table>

## Advanced APIs

Extend your implementation with modular APIs for business analytics, operational insights, and flexible integration. These specialized APIs work alongside [Core API](#core-api) to provide deeper control over provisioning, enable custom reporting, and unlock programmatic account management across your organization.

<table data-card-size="large" data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><h4><i class="fa-chart-line-up">:chart-line-up:</i></h4></td><td><strong>Metrics API</strong></td><td>Extract powerful commerce insights through advanced analytics queries. Calculate conversion rates, track customer behavior, and build custom dashboards with KPI measurements on-demand — no external BI tools needed.</td><td><a href="https://app.gitbook.com/o/-Lfu_B3DKew-kvoEWzTk/s/ASSiAvbL4nFnkl8plQy2/">Getting started</a></td><td></td></tr><tr><td><h4><i class="fa-user">:user:</i></h4></td><td><strong>Provisioning API</strong></td><td>Automate account management and access control programmatically. Create team accounts, assign permissions, generate API credentials, and streamline user onboarding workflows across multiple organizations.</td><td><a href="https://app.gitbook.com/o/-Lfu_B3DKew-kvoEWzTk/s/xrdVVavnnBMHRCqrLp1y/">Provisioning API</a></td><td></td></tr></tbody></table>

## Build with us

Commerce Layer is built in the open, by developers, for developers — because we believe transparency and collaboration create better software. Whether you want to contribute code, stay informed about new features, or connect with our community, we're here to support your journey. Explore our open-source projects, track updates, and join the conversation.

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><h4><i class="fa-github">:github:</i></h4></td><td><strong>GitHub</strong></td><td>Every tool, library, and micro frontend we build is open source. Browse our repositories, inspect the code, submit pull requests, and contribute improvements. Your inputs help shape Commerce Layer's future.</td><td><a href="https://github.com/commercelayer">https://github.com/commercelayer</a></td><td></td></tr><tr><td><h4><i class="fa-calendar">:calendar:</i></h4></td><td><strong>Changelog</strong></td><td>Track every update, feature release, and improvement across all Commerce Layer products. Get detailed release notes for all our APIs, developer tools, and open-source projects — never miss what's new or breaking.</td><td><a href="https://app.gitbook.com/o/-Lfu_B3DKew-kvoEWzTk/s/8DjTu5pfPzXTm6rzaAmr/">Changelog</a></td><td></td></tr><tr><td><h4><i class="fa-discord">:discord:</i></h4></td><td><strong>Discord</strong></td><td>Get your invite and connect with fellow developers building on Commerce Layer. Get help from our team, share solutions with the community, discuss best practices, and stay informed about upcoming features and beta programs.</td><td><a href="https://discord.com/invite/commercelayer">https://discord.com/invite/commercelayer</a></td><td></td></tr></tbody></table>