GetShort

ItemShort

Модель, сокращённо описывающая номенклатуру

Название Тип данных Описание
id Int64 ID номенклатуры
group_id Int64 ID Группы номенклатуры
department_id Int64 ID Отдела, к которому принадлежит номенклатура
vat_id Int64 ID Ставки НДС (%)
unit_id Int64 ID Единицы измерения номенклатуры
unit2_id Int64 ID Единицы измерения номенклатуры для КДТ
color_id Int64 ID Цвета номенклатуры
size_id Int64 ID Размера номенклатуры
brand_id Int64 ID Бренда номенклатуры
producer_id Int64 ID Производителя номенклатуры
country_id Int64 ID Страны производства номенклатуры
compound Boolean Метка о том, что номенклатура составная
parent_id Int64 ID родительской номенклатуры (используется для создания вариаций)
has_child Boolean Метка о наличии дочерних элементов (используется для создания вариаций)
deleted_mark Boolean Метка на удаление
last_update Int64 Дата последнего изменения записи в формате unix time в секундах
type Enum Тип номенклатуры: <Item | 1> - Товар, <Service | 2> - Услуга
code Int64 Код номенклатуры
name String Наименование номенклатуры
fullname String Полное наименование номенклатуры
description String Дополнительное описание номенклатуры
articul String Артикул номенклатуры
kdt Int32 Количество номенклатуры для КДТ
min_quantity Int32 Минимальное количество номенклатуры
icps string ИКПУ - идентификационный код продукции и услуг
assemblable Boolean Метка о том, что товар можно произвести
disassemblable Boolean Метка о том, что товар можно разобрать
is_labeled Boolean Метка о том, что товар подлежит маркировке
comission_tin String ИНН комиссионера
package_code String Код упаковки
origin Enum Происхождение товара: <NotSpecified | -1> - Не задано, <BuyingAndSelling | 0> - Купля продажа, <Produced | 1> - Производство, <Service | 2> - Услуги
partner_id Int32 ID контрагента

[POST] …/v1/Item/GetShort

Возвращает сокращённую информацию о номенклатуре.

Входные параметры

Название Тип данных Обязательность Описание
ids Array of int64 Необязательный Массив id номенклатур
group_ids Array of int64 Необязательный Массив id групп номенклатур
type Enum Необязательный Тип номенклатуры: <Item | 1> - Товар, <Service | 2> - Услуга
parent_ids Array of int64 Необязательный Массив id родительской номенклатуры
codes Array of int64 Необязательный Массив кодов номенклатуры
redefinition_option RedefinitionOption Необязательный Опции переопределения
department_ids Array of int64 Необязательный Массив id отделов
deleted_mark Boolean Необязательный Метка об удалении
assemblable Boolean Необязательный Метка о том, что товар можно произвести
disassemblable Boolean Необязательный Метка о том, что товар можно разобрать
compound Boolean Необязательный Метка о том, что товар составной
has_child Boolean Необязательный Имеет ли дочернюю номенклатуру: true - имеет, false - не имеет
is_labeled Boolean Необязательный Метка о том, что товар подлежит маркировке
limit Int32 Необязательный Количество возвращаемых элементов при запросе
offset Int32 Необязательный Смещение от начала выборки

Пример запроса

{
    "ids":[1],
    "group_ids":[1],
    "type":"Item",
    "parent_ids":[1],
    "codes":[1],
    "redefinition_option": {
        "language": "RUS",
        "app_id": 1
    },
    "department_ids":[1],
    "deleted_mark": false,
    "assemblable": false,
    "disassemblable": false,
    "compound": true,
    "has_child": true,
    "is_labeled": false,
    "limit":1,
    "offset":0
}

Выходные параметры

Название Тип данных Описание
result Array of ItemShort Массив сокращённой информации о номенклатуре
next_offset Int32 Смещение для следующей выборки данных
total Int32 Общее количество элементов

Пример ответа

{
    "ok": true,
    "result": [
        {
            "id": 2,
            "group_id": 2,
            "department_id": -1,
            "vat_id": 1,
            "unit_id": 1,
            "unit2_id": -1,
            "color_id": -1,
            "size_id": -1,
            "brand_id": -1,
            "producer_id": -1,
            "country_id": -1,
            "compound": false,
            "parent_id": 1,
            "has_child": false,
            "deleted_mark": false,
            "last_update": 1732280084,
            "type": "Item",
            "code": 1,
            "name": "Coca-Cola",
            "fullname": "Coca-cola 0.5l",
            "description": "Состав: вода, сахар, краситель.",
            "articul": "4780069000017",
            "kdt": 1,
            "min_quantity": 1,
            "icps": "02202002001000000",
            "assemblable": true,
            "disassemblable": true,
            "is_labeled": true,
            "comission_tin": "32641859724615",
            "package_code": "example123",
            "origin": "BuyingAndSelling",
            "partner_id": 1
        }
    ],
    "next_offset": 1,
    "total": 1
}