[POST] …/v1/Item/Import
Импорт номенклатуры. Метод предназначен для импорта множества позиций номенклатуры.
Пример: Реализация интерфейса импорта в REGOS: Store Management (ссылка).
Максимально допустимое количество элементов в data — 250.
Входные параметры
Название | Тип данных | Обязательность | Описание |
---|---|---|---|
comparation_value | Enum | Необязательный | Сопоставление: <Default> - не задано (будут добавляться все), <Code> - по полю код, <Name> - по полю имя, <Articul > - по полю артикул, <Barcode> - по штрихкоду. Предназначен для предотвращения добавления дубликатов, будет происходить проверка добавляемой номенклатуры по указанному параметру, номенклатура с совпадающим значением указанного параметра не будет добавлена |
group_separator | String | Необязательный | Разделитель групп: символ, которым разделяются вложенные группы, по принципу Группа/Подгруппа |
barcode_separator | String | Необязательный | Разделитель штрихкодов: символ, которым разделяются несколько штрих-кодов в одной строке |
group_id | Int64 | Обязательный | ID группы номенклатуры по умолчанию, в которую будет импортирована номенклатура с пустым значением параметра group_path |
unit_id | Int64 | Обязательный | ID единицы измерения по умолчанию, которая будет присвоена импортируемой номенклатуре с пустым значением параметра unit_name |
vat_value_id | Int64 | Обязательный | ID ставки НДС по умолчанию, которая будет назначена импортируемой номенклатуре с пустым значением парвметра vat_name |
data | Array of ItemImportData | Обязательный | Массив импортируемой номенклатуры |
Модель, описывающая номенклатуру для импорта.
Название | Тип данных | Обязательность | Описание |
---|---|---|---|
index | string | Необязательный | Произвольный индекс строки запроса. Возвращается в ответе без изменений для сопоставления результатов. Рекомендуется уникальность в пределах одного запроса. |
name | string | Обязательный | Наименование |
fullname | string | Необязательный | Полное наименование |
code | string | Необязательный | Код номенклатуры |
articul | string | Необязательный | Артикул |
group_path | string | Необязательный | Группа (структура/путь) |
barcodes | string | Необязательный | Штрихкод(ы) |
color_name | string | Необязательный | Цвет |
brand_name | string | Необязательный | Бренд |
producer_name | string | Необязательный | Производитель |
size_name | string | Необязательный | Размер |
unit_name | string | Необязательный | Единица измерения |
department_name | string | Необязательный | Отдел |
description | string | Необязательный | Описание |
vat_name | string | Необязательный | Ставка НДС |
icps | string | Необязательный | ИКПУ |
labeled | Int64 | Необязательный | Метка обязательной маркировки |
package_code | Int64 | Необязательный | Код упаковки |
parent_code | Int64 | Необязательный | Код родителя (для создания вариации) |
Модель ItemImport
, описывающая результат импорта номенклатуры
Название | Тип данных | Описание |
---|---|---|
index | String | Произвольный индекс строки запроса из запроса, если был задан |
item_id | Int64 | Id номенклатуры |
success | bool | Метка об успехе импорта |
Учитывайте, что success = true
будет только в случае успешного добавления номенклатуры. Если импортируемая номенклатура уже существует, то success = false
Пример запроса
{
"comparation_value": "code",
"group_separator": "/",
"barcode_separator": ",",
"group_id": 1,
"unit_id": 1,
"vat_value_id": 2,
"data": [
{
"name": "Фломастеры",
"fullname": "Фломастеры",
"articul": "6941025106558",
"group_path": "Канцтовары/Фломастеры",
"barcodes": "6941025106558",
"color_name": "Красный",
"brand_name": "Китай",
"producer_name": "Китай",
"size_name": "S",
"unit_name": "шт",
"department_name": "Напитки",
"description": "Сахар, вода, краситель",
"vat_name": "12%",
"icps": "02202002001000000",
"labeled": 0,
"package_code": 14234
}
]
}
Выходные параметры
Название | Тип данных | Описание |
---|---|---|
result | Array of ItemImport | Массив результатов импорта |
Пример ответа
{
"ok": true,
"result": [
{
"success": true,
"index": null,
"item_id": 30977
}
]
}