Catalog & inventory

Kit

Named group of items that go out together.

Schemas: KitDto

{
  "id": "id_8f2a1c",
  "name": "Example",
  "description": "string",
  "image": "string",
  "collectionId": "string",
  "collectionName": "Example",
  "tags": [
    {
      "id": "id_8f2a1c",
      "name": "Example"
    }
  ],
  "components": [
    {
      "itemId": "string",
      "itemName": "Example",
      "variantId": "string",
      "variantName": "Example",
      "quantity": 1,
      "position": 1
    }
  ],
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

A named group of items that go out together, with its components and the collection it belongs to. Kits are bounded to the subscription that owns the key.

Attributes

idstring

Unique identifier of the kit.

namestring

Kit name.

descriptionstring | null

Kit description; null if it has none.

imagestring | null

URL of the main image; null if it has none.

collectionIdstring | null

Collection it belongs to; null if it is in none.

collectionNamestring | null

Full path of the collection; null if it is in none.

tagsobject[]

Kit tags, with their identifier and name.

Show child attributes

tags.idstring

Unique identifier of the tag.

tags.namestring

Tag name.

componentsobject[]

Items that make up the kit, in display order.

Show child attributes

components.itemIdstring

Identifier of the item; read it in /api/v1/items/{itemId}.

components.itemNamestring

Item name, as recorded when it was added to the kit.

components.variantIdstring | null

Variant of the item, if one was chosen; null otherwise.

components.variantNamestring | null

Name of that variant; null if none.

components.quantitynumber

How many units of the item the kit includes.

components.positionnumber | null

Display order inside the kit (0-based); null if not set.

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

Returned by

GET /api/v1/kits — List kits
GET /api/v1/kits/{kitId} — Get a kit

Modified by

POST /api/v1/kits — Create a kit
PATCH /api/v1/kits/{kitId} — Update a kit

Was this page helpful?