Add

[POST] .../v1/item/add

Adds a new item. Use this method to create a catalog item before it is referenced by documents, prices, stock operations or POS workflows. It writes a new item and returns new_id, after validating required catalog references and item identity fields such as group_id, vat_id, type, name, unit_id, ICPS, article, commission TIN and item code availability. The caller must have item add permission; validation errors such as 1002 or 1008, duplicate item code error 2002, denied access and persistent storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
articul String Optional Item article number.
assemblable Boolean Optional Whether the item can be produced through production documents.
brand_id Int64 Optional Item brand ID.
code Int64 Optional Item code.
color_id Int64 Optional Item color ID.
comission_tin String Optional TIN or PINFL of the commission item owner.
compound Boolean Optional Whether the item is compound.
country_id Int64 Optional Item country of origin ID.
department_id Int64 Optional Department ID.
description String Optional Item description.
disassemblable Boolean Optional Whether the item can be disassembled. Applies only to producible items.
fields Array of FieldValueAdd Optional Custom field values to add.
fullname String Optional Full item name.
group_id Int64 Required Item group ID. Required.
icps String Optional Identification code of products and services (ICPS).
is_labeled Boolean Optional Whether labeling is tracked for the item.
min_quantity Int32 Optional Minimum item quantity.
name String Required Item name.
origin String Optional Item origin. Allowed values: BuyingAndSelling, Produced, Service, NotSpecified.
package_code String Optional Package code.
parent_id Int64 Optional Parent item ID for variation items.
partner_id Int64 Optional Partner ID for commission items.
producer_id Int64 Optional Item producer ID.
size_id Int64 Optional Item size ID.
type String Required Item type. Allowed values: Item, Service.
unit_id Int64 Required Item unit of measure ID. Required.
vat_id Int64 Required VAT rate ID. Required.

Request Example

{
  "type": "Item",
  "name": "Arabica Coffee 1 kg",
  "group_id": 1,
  "vat_id": 1,
  "unit_id": 1,
  "code": 1000001,
  "articul": "COF-AR-1KG",
  "fullname": "Arabica Coffee Beans 1 kg",
  "description": "Roasted coffee beans for retail sale"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Insert Created record result.

Response Example

{
  "ok": true,
  "result": {
    "new_id": 1001
  }
}