CartDocs

Products API

Paid plans

List, read, create, change, publish, archive, duplicate and delete products through the API, and set their categories and tags.

On this page

The products calls cover the same work as Products in the admin. A key needs the matching permission, for example See products to read and Edit products to change. All examples leave out the Host: api.ixxocart.com and Authorization: Bearer ... headers, which every call needs (see API keys and authentication).

List products

GET /api/v1/products?status=active&limit=25

Each item is a product card: id (prd_...), slug, status, title, subtitle, price_from_minor, price_to_minor, currency, image, stock_summary (in_stock, low, out or untracked), flags, visibility, published_at and updated_at.

Filters you can combine:

ParameterValues
statusdraft, active, archived (comma list)
visibilityvisible, hidden, search_only (comma list)
category_idcat_..., any linked category
brand_idbrd_...
tag_idtag_...
flagfeatured, new, sale
qTitle words or an exact SKU
languageA shop language for the texts. Default: your main language.

Page through the list with limit and cursor (see Pagination, errors and limits).

Read one product

GET /api/v1/products/prd_...?include=variants,media,categories

The answer is the full product: the card plus its texts (overview, description, specifications, tabs, meta_title, meta_description), brand_id and primary_category_id. Without include, every part comes back. To keep the answer small, name only what you need: variants, media, categories, tags, custom_values, relations, options or family.

Create a product

A new product is always a draft with one default variant.

POST /api/v1/products
Content-Type: application/json
Idempotency-Key: 0b6f3a52-4c1e-4e0a-9a51-3d2f4f7c9e10

{
  "preset_code": "physical",
  "intl": {
    "en": { "title": "Gold hoop earrings", "description": "<p>Solid 14k gold, 20 mm.</p>" },
    "el": { "title": "Χρυσοί κρίκοι" }
  },
  "price_minor": 12900,
  "currency": "EUR",
  "sku": "HOOP-14K-20",
  "visibility": "visible",
  "weight_grams": 4,
  "track_inventory": true
}
  • preset_code picks the kind of product: physical, digital, subscription, booking, donation or auction.
  • intl holds the texts per language: title, subtitle, overview, description, specifications, tabs, meta_title, meta_description and search_keywords.
  • Prices are in minor units: 12900 is 129.00.
  • Other fields include slug, brand_id, primary_category_id, compare_at_minor (must be above the price), gtin, mpn, is_featured and allow_backorder. cost_minor needs See cost prices.

The answer is 201 with the new product.

Change a product

Send only the fields you change:

PATCH /api/v1/products/prd_...
Content-Type: application/json

{
  "price_minor": 11900,
  "compare_at_minor": 12900,
  "intl": { "en": { "meta_title": "Gold hoop earrings, 14k, 20 mm" } }
}

A price change on the default variant is kept in the price history, as in the admin.

To change one variant, use PATCH /api/v1/variants/var_.... To list a product's variants, GET /api/v1/products/prd_.../variants.

Categories and tags

These calls replace the whole list:

PUT /api/v1/products/prd_.../categories
Content-Type: application/json

{ "category_ids": ["cat_...", "cat_..."], "primary_id": "cat_..." }
PUT /api/v1/products/prd_.../tags
Content-Type: application/json

{ "tags": ["gift", "bestseller"] }

To find category IDs, list them with GET /api/v1/categories, or as a tree with GET /api/v1/categories/tree.

Publish, archive and duplicate

POST /api/v1/products/prd_.../publish
Idempotency-Key: 9d4e...

Publishing runs every check at once. If something is missing, the answer is 422 with one field error per missing piece, for example price_required, title_required, sku_required or custom_field_required:<code>.

  • POST /api/v1/products/prd_.../archive takes the product off sale and out of every listing. Orders keep referring to it.
  • POST /api/v1/products/prd_.../duplicate makes a draft copy, with its texts, options, media and variants (without SKUs), under the next free web address.

Publishing and archiving need Publish and archive products; duplicating needs Add products.

Delete a product

DELETE /api/v1/products/prd_...

Only an archived product that no order names can be deleted. A product that was ordered stays archived. The answer is 204 with no body. Deleting needs Delete archived products.

Updated 13 November 2026