Модель, описывающая номенклатуру с её количеством и ценой
Название | Тип данных | Описание параметра |
---|---|---|
item | Item | Номенклатура - Объект класса Item |
quantity | ItemQuantity | Количество номенклатуры - Объект класса ItemQuantity |
price | decimal | Цена номенклатуры |
pricetype | PriceType | Вид цены - объект класса PriceType |
image_url | string | URL изображения номенклатуры |
[POST] …/v1/Item/getExt
Возвращает информацию о номенклатуре c её количеством и ценой
Входные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
ids | array of int64 | Необязательный | Массив id номенклатур |
group_ids | array of int64 | Необязательный | Массив id групп номенклатур |
type | enum | Необязательный | Тип номенклатуры: item (Предмет), service (Услуга). По умолчанию: item |
parent_ids | array of int64 | Необязательный | Массив id родительской номенклатуры |
redefinition_option | Redefinition_option | Необязательный | Опции переопределения - Объект класса Redefinition_option |
department_ids | array of int64 | Необязательный | Массив id отделов |
stock_id | int64 | Необязательный | id склада |
price_type_id | int64 | Необязательный | id типа цены |
search | string | Необязательный | Текст для поиска |
image_size | enum | Необязательный | Размер изображения: 1 = Large (900х900), 2 = Medium (300х300), 3 = Small (100х100). По умолчанию: Small |
sort_orders | Sort_orders | Необязательный | Сортировка выходных данных - Объект класса Sort_orders |
deleted_mark | bool | Необязательный | Пометка на удаление: true - помеченые позиции отображается в ответе; true - помеченые позиции не отображается в ответе; null - пометка не учиитывается(все позиции отображаются) |
compound | bool | Необязательный | Метка о том, что товар составной |
is_labeled | bool | Необязательный | Метка о том, что товар подлежит маркировке |
limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе |
offset | Int32 | Необязательный | Смещение от начала выборки |
codes | array of uint64 | Необязательный | массив кодов номенклатуры |
Ограничения, требования и проверки
При отсутствии права "Просмотр цен номенклатуры(id:183)" устанавливается цена 0.
Sort_orders - Модель сортировки выходных параметров
Название | Тип данных | Описание параметра |
---|---|---|
column | enum | Значение для сортировки: Name (Наименование), Articul (Артикул), Code (Код), Unit (Единица измерения), Color (Цвет), Size (Размер), Brand (Бренд), Producer (Производитель), Country (Страна производства), TaxVat (НДС) , Department (Отдел) |
direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"ids":[1,2],
"group_ids":[1,2],
"type":"item",
"parent_ids":[1,2],
"department_ids":[1,2],
"image_size":"small",
"limit":10,
"offset":5,
"codes": [3]
}
Выходные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
Result | array of ItemExt | Обязательный | Массив объектов ItemExt |
next_offset | Int32 | Обязательный | Смещение для следующей выборки данных |
total | Int32 | Обязательный | Общее количество элементов |
Пример ответа
{
"ok": true,
"result": [
{
"item": {
"id": 3,
"group": {
"id": 1,
"redefinition": null,
"parent_id": 0,
"path": "Бытовая химия",
"name": "Бытовая химия",
"child_count": 0,
"last_update": 1585416061
},
"department": {
"id": 1,
"name": "ОВОЩИ",
"last_update": 1577368965
},
"vat": {
"id": 8,
"value": 15.0,
"name": "15%",
"enabled": true,
"last_update": 1574075456
},
"barcode_list": "7891024149010, 1231423423434",
"unit": {
"id": 1,
"name": "шт",
"type": "pcs",
"description": null,
"last_update": 1574075456
},
"unit2": null,
"color": null,
"size": null,
"brand": null,
"producer": null,
"country": null,
"compound": true,
"deleted_mark": false,
"last_update": 1580554804,
"parent_id": 0,
"has_child": false,
"type": "Item",
"partner_id": 0,
"code": 3,
"name": "Colgate Зуб.паста",
"fullname": "",
"description": "",
"articul": "",
"kdt": 1,
"min_quantity": 0
},
"quantity": {
"common": 569.0,
"allowed": 569.0,
"booked": 0.0
},
"price": 8000.0,
"pricetype": {
"id":1,
"name":"Розничная",
"round_to":100,
"markup":20,
"max_discount":20,
"last_update": 1534151629
},
"image_url":"https://cdn.regos.uz/111/i_1645770236_6376c2e8-febb-4c45-b151-fa16f1246a91.png"
],
"next_offset": 6,
"total": 1427
}