GetExt

ItemExt

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

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


[POST] …/v1/Item/GetExt

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

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

Название Тип данных Обязательность Описание параметра
stock_id int64 Необязательный ID склада
price_type_id int64 Необязательный id типа цены
sort_orders SortOrders Необязательный Сортировка выходных данных
search string Необязательный Текст для поиска. Ишет по значениям: name, articul, code, barcode
zero_quantity boolean Необязательный Флаг, указывающий, выводить ли товары с 0 Количеством
zero_price boolean Необязательный Флаг, указывающий, выводить ли товары с 0 Ценой
image_size enum Необязательный Размер изображения: 1 = Large (900х900), 2 = Medium (300х300), 3 = Small (100х100). По умолчанию: Small
ids array of int64 Необязательный Массив id номенклатур
group_ids array of int64 Необязательный Массив id групп номенклатур
type enum Необязательный Тип номенклатуры: item (Предмет), service (Услуга)
parent_ids array of int64 Необязательный Массив id родительской номенклатуры
codes array of uint64 Необязательный массив кодов номенклатуры
department_ids array of int64 Необязательный Массив id отделов
deleted_mark boolean Необязательный Пометка на удаление: true - помеченые позиции отображается в ответе; true - помеченые позиции не отображается в ответе; null - пометка не учиитывается(все позиции отображаются)
assemblable boolean Необязательный Сборный. Может участвовать в сборке на производстве
disassemblable boolean Необязательный Разборный. Может участвовать в разборке на производстве
compound boolean Необязательный Метка о том, что товар составной
has_child boolean Необязательный Имеет потомков или нет
redefinition_option RedefinitionOption Необязательный Опции переопределения
is_labeled boolean Необязательный Метка о том, что товар подлежит маркировке
limit Int32 Необязательный Лимит возвращаемых данных при запросе
offset Int32 Необязательный Смещение от начала выборки

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

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


SortOrders - Модель сортировки выходных параметров

Название Тип данных Описание параметра
column enum Значение для сортировки: Name (Наименование), Articul (Артикул), Code (Код), Unit (Единица измерения), Color (Цвет), Size (Размер), Brand (Бренд), Producer (Производитель), Country (Страна производства), TaxVat (НДС) , Department (Отдел)
direction enum Порядок сортировки: ASC (По возрастанию), DESC (По убыванию)

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

{
      "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
      ],
      "department_ids": [
            1
      ],
      "deleted_mark": true,
      "assemblable": true,
      "disassemblable": true,
      "compound": true,
      "has_child": true,
      "redefinition_option": {
            "language": "RUS",
            "app_id": 1
      },
      "is_labeled": true,
      "limit": 1,
      "offset": 1
}

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

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

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

{
  "ok": true,
  "result": [
    {
      "item": {
        "id": 1,
        "group": {
          "id": 2,
          "parent_id": 1,
          "path": "Напитки/Газированные",
          "name": "Газированные",
          "child_count": 0,
          "last_update": 1694590676
        },
        "department": null,
        "vat": {
          "id": 1,
          "value": -1,
          "name": "Без НДС",
          "enabled": true,
          "last_update": 1664715017
        },
        "barcode_list": "2040238780891",
        "base_barcode": "2040238780891",
        "unit": {
          "id": 1,
          "name": "шт",
          "type": "pcs",
          "description": null,
          "kkm_code": 1,
          "last_update": 1694588105
        },
        "unit2": null,
        "color": null,
        "size": null,
        "brand": null,
        "producer": null,
        "country": null,
        "compound": false,
        "deleted_mark": false,
        "image_url": null,
        "parent_id": 0,
        "has_child": false,
        "last_update": 1694617896,
        "type": "Item",
        "code": 1,
        "name": "Coca-cola 1.5l",
        "fullname": "",
        "description": "",
        "articul": "",
        "kdt": 1,
        "min_quantity": 0,
        "icps": "",
        "assemblable": false,
        "disassemblable": false,
        "is_labeled": false,
        "comission_tin": null,
        "package_code": null,
        "origin": -1,
        "partner_id": 0
      },
      "quantity": {
        "common": 84,
        "allowed": 84,
        "booked": 0
      },
      "pricetype": null,
      "price": 0,
      "image_url": null
    }
  ],
  "next_offset": 1,
  "total": 359
}