Creating a Product

Creates a product together with its components. The product appears at storage location storage_id and at any storage location that stores all products or its categories.

v1/products/add.php

Parameters

A category can be passed by name: if there is no such category, it is created. The IDs of existing categories are returned by v1/categories/get_list.

The uniqueness of the main and alternative SKUs is not checked.

Product components

The components are defined per batch (batch_size units) and passed as the arrays materials, products (subassemblies) and resources.

materials and products lines

position sets the order of component lines in the Controlata interface, shared by materials and products. Lines without it go last, in the order passed. Controlata renumbers positions from 0, so in Retrieving a Product they may differ from the ones you passed.

resources lines

Each resource line contains the resource id. Whether amount_per_batch and unit are needed depends on the resource type (see Creating a Resource):

Example request

A table: 10 per batch, each batch uses 0.5 cu m of board with 5% loss, 400 screws, 40 legs (a subassembly) and 30 hours of carpenter's work. Overhead is a percentage set in the resource itself, so its id is enough.

{
    "name": "Dining table",
    "sku": "P100",
    "unit": "pcs",
    "price": 45000,
    "batch_size": 10,
    "storage_id": 3999,
    "stock": 5,
    "minimum": 2,
    "categories": [{ "id": 21 }],
    "suppliers": [{ "id": 46 }],
    "alternative_sku": [
        {
            "label": "Shopify",
            "sku": "SH-P100"
        }
    ],
    "materials": [
        {
            "id": 2051,
            "amount_per_batch": 0.5,
            "unit": "cu m",
            "loss_percent": 5
        },
        {
            "id": 2060,
            "amount_per_batch": 400,
            "unit": "pcs"
        }
    ],
    "products": [
        {
            "id": 312,
            "amount_per_batch": 40,
            "unit": "pcs"
        }
    ],
    "resources": [
        {
            "id": 57,
            "amount_per_batch": 30,
            "unit": "h"
        },
        {
            "id": 58
        }
    ]
}

Example response

{
    "success": true,
    "product_id": 3120
}

Errors

Errors in component lines

In the error text, instead of 2051 there is the item ID, and instead of 0 the line number in the array (from 0).