Introduction

The ReadyCMS API is a multi-tenant REST API for products, orders, customers, content, and media. Everything the admin can do, your integration can do too.

What you can build

The API powers headless storefronts, ERP/PIM synchronization, order pipelines, bulk catalog tooling, and anything else that needs programmatic access to a ReadyCMS tenant. It exposes the same data model the admin uses - products and variants, orders and carts, customers, media, custom content, discounts, gift cards, and more.

The model in one minute

• Standard REST. Normal methods on clean paths: GET /products/, POST /orders/, PATCH /products/123/.
• Multi-tenant. Every request selects a tenant with a namespace parameter.
• Authenticated. Non-public endpoints require an Authorization header (app credentials) or a user token.
• JSON envelope. Responses are a predictable JSON object with a request_id for tracing.

Base URL

Production requests go to:

https://api.readycms.io

Use this base URL and send your tenant on every request with the namespace parameter.

How these docs are organized

• Guides - the concepts every integration needs: auth, tenancy, requests, responses, errors, pagination, caching.
• Reference - every endpoint, grouped by domain, with copy-paste code and a live try-it console.
• Resources - the error-code index, plus the help center, changelog, and support.