About the API
Commerce Kitty ships with a full REST API. Everything you can do in the admin UI, you can do over HTTP. Build custom integrations, automate reporting, or connect Commerce Kitty to internal tools.
Where the docs live
Full endpoint reference, request and response schemas, and examples are published at api.commercekitty.com. This help center page covers the basics. The reference site is the source of truth for every endpoint.
What you can do
The API exposes the same resources you see in the admin UI:
- Products and variants. Create, read, update, and delete catalog records.
- Orders. Create manual orders, read existing ones, update status, and trigger fulfillment.
- Customers. Look up buyers and their order history.
- Channels and plugins. Read your configured sales destinations and their sync state.
- Shipments and tracking. Post shipment events and attach tracking numbers.
- Reports. Pull aggregated data for your own dashboards.
Authentication
Every request needs an API key. Generate one from Configuration, then API Keys, in the admin UI. Send the key as a bearer token in the Authorization header:
Authorization: Bearer YOUR_API_KEY_HERE
Keys inherit the permissions of the user they belong to. If you need a key that can only read data, create a read-only user and generate the key against that user.
API keys are tied to a user. If the user lacks a permission in the UI, the API key also lacks it. Plan your user group setup before generating keys.
Rate limits
The API is rate limited per key to protect the platform from runaway scripts. Normal use rarely hits the limit. If you are building a high-volume integration, batch requests where possible and back off when you receive a 429 Too Many Requests response. Contact support if you need higher limits for a legitimate use case.
Versioning
Endpoints are versioned in the URL path. Breaking changes go into a new version. Non-breaking additions (new fields, new endpoints) roll out to the current version without notice.
Subscribe your integration to the changelog on the API reference site so you know when new fields become available.