Edit

[POST] .../v1/item/edit

Edits an item. Use this method to update catalog item attributes after the item has been created. It changes the item identified by id and returns row_affected, validating optional text limits, ICPS format, commission TIN format and the item edit permission before delegating to the persistent layer. Business errors such as missing request body, invalid id, field length violations, denied access, locked or invalid item state and persistent 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.
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 FieldValueEdit Optional Custom field values.
fullname String Optional Full item name.
group_id Int64 Optional Item group ID. Zero means the root group.
icps String Optional Identification code of products and services (ICPS).
id Int64 Required Item ID.
is_labeled Boolean Optional Whether labeling is tracked for the item.
min_quantity Int32 Optional Minimum item quantity.
name String Optional 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, used to create a size grid.
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 Optional Item type. Allowed values: Item, Service.
unit_id Int64 Optional Item unit of measure ID.
vat_id Int64 Optional VAT rate ID.

Request Example

{
  "articul": "string",
  "assemblable": true,
  "brand_id": 1,
  "code": 1,
  "color_id": 1,
  "comission_tin": "string",
  "country_id": 1,
  "department_id": 1,
  "description": "string",
  "disassemblable": true,
  "fields": [
    {
      "deleted": true,
      "key": "string",
      "value": "string"
    }
  ],
  "fullname": "string",
  "group_id": 1,
  "icps": "string",
  "id": 1,
  "is_labeled": true,
  "min_quantity": 1,
  "name": "string",
  "origin": "BuyingAndSelling",
  "package_code": "string",
  "parent_id": 1,
  "partner_id": 1,
  "producer_id": 1,
  "size_id": 1,
  "type": "Item",
  "unit_id": 1,
  "vat_id": 1
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "ids": [
      null
    ],
    "row_affected": 1
  }
}