GetExt

ItemExt

Расширенная модель номенклатуры

Название Тип данных Описание
item Item Номенклатура
quantity ItemQuantity Количество номенклатуры
pricetype PriceType Вид цены
price Decimal Цена номенклатуры
last_purchase_cost Decimal Последняя закупочная стоимость
image_url String URL изображения номенклатуры

[POST] …/v1/Item/GetExt

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

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

Название Тип данных Обязательность Описание
stock_id Int64 Необязательный ID склада
price_type_id Int64 Необязательный ID типа цены
sort_orders Array of SortOrders Необязательный Сортировка выходных параметров
filters Array of Filter Необязательный Фильтры по основным и дополнительным полям
search String Необязательный Строка поиска по полям: name - наименование, articul - артикул, code - код, barcode - штрих-код
zero_quantity Boolean Необязательный Флаг, указывающий, выводить ли товары с 0 Количеством
zero_price Boolean Необязательный Флаг, указывающий, выводить ли товары с 0 Ценой
image_size Enum Необязательный Размер изображения: <Large | 1> - 900х900px, <Medium | 2> - 300х300px, <Small | 3> - 100х100px
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 - не имеет
has_image Boolean Необязательный Флаг, указывающий, есть ли изображение у номенклатуры: null - вся номенклатура, true - только с изображениями, false - только без изображений
is_labeled Boolean Необязательный Метка о том, что товар подлежит маркировке
limit Int32 Необязательный Количество возвращаемых элементов при запросе
offset Int32 Необязательный Смещение от начала выборки

Поля, доступные для сортировки (sort_orders):

name, articul, code, unit.name, color.name, size.name, brand.name, producer.name, country.name, vat.name, department.name

Поля, доступные для фильтрации (filters):

icps, articul, comission_tin, package_code, price, last_purchase_cost, quantity.booked, quantity.common, quantity.allowed

Ограничения, требования и проверки

  1. При отсутствии права "Просмотр цен номенклатуры(id:183)" устанавливается цена 0.

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

{
    "stock_id": 1,
    "price_type_id": 1,
    "sort_orders": [
        {
            "column": "Name",
            "direction": "ASC"
        }
    ],
    "search": "cola",
    "zero_quantity": true,
    "zero_price": true,
    "image_size": "Large",
    "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 ItemExt Массив номенклатуры с расширенной информацией
next_offset Int32 Смещение для следующей выборки данных
total Int32 Общее количество элементов

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

{
    "ok": true,
    "result": [
        {
            "item": {
                "id": 1,
                "group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Бакалея",
                    "path": "Продукты/Бакалея",
                    "child_count": 1,
                    "last_update": 1533619486
                },
                "department": {
                    "id": 1,
                    "name": "Напитки",
                    "last_update": 1671689500
                },
                "vat": {
                    "id": 1,
                    "value": 12,
                    "name": "12%",
                    "enabled": true,
                    "last_update": 1672188628
                },
                "barcode_list": "9582638638288, 2042993381221",
                "base_barcode": "9582638638288",
                "unit": {
                    "id": 1,
                    "name": "Кг",
                    "type": 1,
                    "description": "Килограмм",
                    "kkm_code": 235,
                    "last_update": 1713435678
                },
                "unit2": {
                    "id": 1,
                    "name": "Кг",
                    "type": 1,
                    "description": "Килограмм",
                    "kkm_code": 235,
                    "last_update": 1713435678
                },
                "color": {
                    "id": 1,
                    "name": "Красный",
                    "last_update": 1671716048
                },
                "size": {
                    "id": 1,
                    "name": "S",
                    "last_update": 1671715998
                },
                "brand": {
                    "id": 1,
                    "name": "Coca-cola",
                    "last_update": 1671716103
                },
                "producer": {
                    "id": 1,
                    "name": "Coca-Cola Co.",
                    "last_update": 1688063968
                },
                "country": {
                    "id": 1,
                    "name": "СОЕДИНЕННЫЕ ШТАТЫ",
                    "fullname": "Соединенные Штаты Америки",
                    "code": "840",
                    "alfa2": "US",
                    "alfa3": "USA",
                    "last_update": 1535245932
                },
                "compound": true,
                "deleted_mark": false,
                "image_url": "https://cdn.regos.uz/5fbc650b-6166-4e1b-8864-f93c0617bbf8/i_1678063359_905ee850-3e41-4ec9-b70a-b78b5d7d52f0.png",
                "parent_id": 1,
                "has_child": false,
                "last_update": 1688064039,
                "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
            },
            "quantity": {
                "stock": {
                    "id": 1,
                    "name": "Новомосковская",
                    "address": "example",
                    "firm": {
                        "id": 1,
                        "group": {
                            "id": 1,
                            "parent_id": 0,
                            "name": "Предприятия",
                            "child_count": 0,
                            "last_update": 1715233269
                        },
                        "deleted_mark": false,
                        "last_update": 1715863600,
                        "name": "REGOS",
                        "fullname": "ООО \"REGOS Software\"",
                        "boss_name": "Андрей",
                        "address": "Мукими, 8А",
                        "phones": "+998987654321",
                        "description": "EasyTrade successor",
                        "inn": "305930137",
                        "bank_name": "Ипак Йули",
                        "mfo": "01101",
                        "rs": "22125489632541254782",
                        "oked": "62090",
                        "vat_index": "1325489654785"
                    },
                    "description": "example",
                    "area": 1.1,
                    "deleted_mark": false,
                    "last_update": 1705583155
                },
                "common": 3,
                "allowed": 3,
                "booked": 1
            },
            "pricetype": {
                "id": 1,
                "name": "example",
                "round_to": 0.00,
                "markup": 0.25,
                "max_discount": 0.2,
                "currency": {
                    "id": 1,
                    "code_num": 123,
                    "code_chr": "UZS",
                    "name": "Узбекский сум",
                    "exchange_rate": 1,
                    "is_base": true,
                    "deleted": false,
                    "last_update": 1533619909
                },
                "currency_additional": {
                    "id": 1,
                    "code_num": 123,
                    "code_chr": "USD",
                    "name": "Dolar",
                    "exchange_rate": 1.1,
                    "is_base": false,
                    "deleted": false,
                    "last_update": 1533619909
                },
                "last_update": 1700000000
            },
            "price": 22000,
            "last_purchase_cost": 21000,
            "image_url": "https://cdn.regos.uz/5fbc650b-6166-4e1b-8864-f93c0617bbf8/i_1678063359_905ee850-3e41-4ec9-b70a-b78b5d7d52f0.png"
        }
    ],
    "next_offset": 1,
    "total": 1
}