CartDocs

The IXXO Cart REST API

Paid plans

What the shop API does, its base address, the JSON envelope every answer uses, API versions and the OpenAPI description.

On this page

The REST API lets your own tools read and change your shop: sync products with a supplier feed, send orders to a warehouse, update stock from a till, or pull orders into your accounting. It covers the same things you do in the admin, with the same permissions.

Base address

Every call goes to the API host, with the path starting at /api/v1:

GET https://api.ixxocart.com/api/v1/ping

The API knows which shop you mean from your API key, so the address is the same for every shop.

Send and receive JSON. Use HTTPS only.

Your first call

  1. Make an API key on Settings > API keys (see API keys and authentication).
  2. Call /me with the key:
GET /api/v1/me HTTP/1.1
Host: api.ixxocart.com
Authorization: Bearer ics_your_key_here

The answer tells you who the key belongs to and what it may do.

The answer envelope

Every answer, success or error, has the same three parts:

{
  "data": { "id": "prd_...", "title": "Gold hoop earrings" },
  "meta": {},
  "errors": []
}
  • data: the result. A single object, a list, or null on an error.
  • meta: extra facts, such as the next page of a list.
  • errors: empty on success. On an error, a list of objects with a code, a message and, for a field problem, the field.

How lists and errors work is in Pagination, errors and limits.

IDs

Every object has a public ID with a short prefix that says what it is, for example prd_ for a product, var_ for a variant, ord_ for an order, cus_ for a customer, cat_ for a category and loc_ for a stock location. Use these IDs in paths and bodies.

Amounts of money

Amounts are whole numbers in the currency's smallest unit, in fields ending in _minor. price_minor: 12900 with currency: "EUR" is €129.00.

API versions

The API has dated versions. The current version is 2026-10-01. To keep your integration stable when the API changes, send the version you built against in the Api-Version header:

GET /api/v1/products HTTP/1.1
Host: api.ixxocart.com
Authorization: Bearer ics_your_key_here
Api-Version: 2026-10-01

Without the header, the current version is used. The answer always says which version it used, in its own Api-Version header. An unknown version is refused with 400 and the code unsupported_version.

The OpenAPI description

The full list of calls, fields and error codes is published as an OpenAPI document. It needs no key:

GET https://api.ixxocart.com/api/v1/openapi.json

Load it into Postman, Insomnia or a code generator to explore every call.

Webhooks

The shop API has no outgoing webhooks yet. To pick up new orders or changes, call the list endpoints on a schedule, for example new orders every few minutes, and page through what is new.

Main resources

Updated 13 November 2026