Products

The Product object — a concrete configuration of a configurator, or a standalone item — its bill of materials, de-duplication by hash, and the endpoints to list, create, update and delete products.

A product is one concrete thing that can be put on an order: a configurator with specific control values (a 1200×1600 roller blind in Blackout 605), or a standalone item. A product stores its bill of materials and cut-list, so its cost can be computed and warehouse automations know what to write off.

Products are de-duplicated. Each product has a hash of its configurator, configuration and materials; creating a product identical to an existing one returns the existing one instead.

Field types follow the field notation.

Access

Every endpoint on this page requires both the projects and products OAuth scopes. The user must be a member of the project, and the owner's subscription must be active. Otherwise the endpoint returns 404 RES_NOT_FOUND. The project owner bypasses permission checks.

Product Object

Product Structure

Product Material Structure

This is the shape the app stores, taken from a configurator calculation. The API accepts any array, but the order cost (purchase_price of order lines) and warehouse write-offs read only uuid and quantity. Materials that are not linked to the product's configurator are ignored when computing cost.

Example Product

{
  "uuid": "0199a3f1-5c2e-7d40-b1a2-3c4d5e6f7a8b",
  "configurator_uuid": "0199ab16-3d4e-7f50-8162-738495061728",
  "name": "Roller blind Blackout 605, 1200×1600 mm",
  "configuration": {
    "$width": 1200,
    "$height": 1600,
    "$cloth": "Blackout 605"
  },
  "materials": [
    {
      "uuid": "0199a2c0-7a1b-7c2d-8e3f-a0b1c2d3e4f5",
      "name": "Blackout 605",
      "unit": "sm",
      "quantity": "2.268"
    }
  ],
  "parts": [
    {
      "name": "Blackout 605",
      "quantity": 1,
      "unit": "pcs",
      "size": "1157×1600",
      "size_unit": "mm"
    }
  ],
  "unit": "pcs",
  "hash": "3f1c9a5e0b7d2c4e6f8a1b3d5e7f9a0c2e4b6d8f",
  "orders_count": 4,
  "created_at": "2026-10-01T09:20:00.000Z",
  "updated_at": "2026-10-01T09:20:00.000Z"
}

List Products

GET /api/v1/projects/{project.uuid}/products

Returns a page of products, newest first, without orders_count.

Requires can_view_products.

Query String Params

Filters with the same field combine with OR; different fields combine with AND.

Response

200 OK — {data, page, limit, total, total_pages}, as in List Materials.

Get Product

GET /api/v1/projects/{project.uuid}/products/{product.uuid}

Returns a single product with orders_count.

Requires can_view_products.

Create Product

POST /api/v1/projects/{project.uuid}/products

Creates a product, or returns the existing identical one.

Requires can_edit_products.

JSON Params

name and parts do not take part in the hash. Two requests with the same configurator, configuration and materials but different names return the same product, with the first name.

Example Request

The usual flow is to run Calculate Configurator and save its result:

{
  "name": "Roller blind Blackout 605, 1200×1600 mm",
  "configurator_uuid": "0199ab16-3d4e-7f50-8162-738495061728",
  "configuration": {
    "$width": 1200,
    "$height": 1600,
    "$cloth": "Blackout 605"
  },
  "materials": [
    {
      "uuid": "0199a2c0-7a1b-7c2d-8e3f-a0b1c2d3e4f5",
      "name": "Blackout 605",
      "unit": "sm",
      "quantity": "2.268"
    }
  ],
  "parts": []
}

Response

201 Created for a new product:

{
  "uuid": "0199a3f1-5c2e-7d40-b1a2-3c4d5e6f7a8b",
  "hash": "3f1c9a5e0b7d2c4e6f8a1b3d5e7f9a0c2e4b6d8f"
}

200 OK if an identical product already exists:

{
  "uuid": "0199a3f1-5c2e-7d40-b1a2-3c4d5e6f7a8b",
  "unit": "pcs",
  "hash": "3f1c9a5e0b7d2c4e6f8a1b3d5e7f9a0c2e4b6d8f"
}

Modify Product

PATCH /api/v1/projects/{project.uuid}/products/{product.uuid}

Updates only the fields you send, with the same rules as Create Product. At least one field must be present. The hash is recomputed.

If the change makes the product identical to another existing product, the two are merged: order lines and warehouse stock move to the other product, this product is deleted, and the response is 200 OK with:

{
  "merged_into": "0199a3f1-77d0-7a11-8c9b-0a1b2c4d5e6f"
}

Otherwise the response is 204 No Content.

Requires can_edit_products.

Replace Product

PUT /api/v1/projects/{project.uuid}/products/{product.uuid}

Same as Modify Product, but every field of Create Product is required.

Delete Product

DELETE /api/v1/projects/{project.uuid}/products/{product.uuid}

Deletes the product and its stock in every warehouse. Order lines that used it keep their prices and quantities but lose the link (product_uuid: null). Warehouse automations can then no longer write off its materials for those orders.

Requires can_edit_products.

Response

204 No Content

Errors