GET, POST, PUT и PATCH-запросы работают с моделью Product.
Product.| Параметр | Тип | Описание |
|---|---|---|
id |
number | ID. Только для GET-запросов. |
name |
string | Название. Обязательный параметр. |
nameEn |
string | null | Название на английском (необходимо для международной доставки почтой). |
vendorCode |
string | Артикул (должен быть уникальным в рамках аккаунта). Обязательный параметр. |
vat |
number | НДС. Возможные значения: 0, 10, 20. |
priceDeclared |
number | null | Страховая стоимость в рублях. |
priceCod |
number | null | Стоимость в рублях. |
weight |
number | null | Вес в кг. Может быть дробным с точностью до грамма. Минимальное значение – 0,001 (1 грамм). |
volume |
number | null | Объём в м3. |
dimensions.width |
number | null | Ширина в см. Целое число от 1 до 999. |
dimensions.height |
number | null | Высота в см. Целое число от 1 до 999. |
dimensions.length |
number | null | Длина в см. Целое число от 1 до 999. |
quantity |
number | null | Количество на складе. Только для GET-запросов. |
photo |
string | null | URL фотографии товара. |
tnved |
string | null | ТН ВЭД (необходим для международной доставки почтой). |
barcodes |
array | Массив штрих-кодов (строки). |
brand |
string | null | Бренд. |
producingCountry |
string | null | Код страны-производителя. |
markCodeRequired |
boolean |
Флаг “Требуется код маркировки“. Используется, если товар подлежит обязательной маркировке “Честный знак”. Только для клиентов на фулфилменте. |
bindings |
array |
Привязки к маркетплейсам. Массив объектом с полями:
|
GET https://api.saferoute.ru/v2/products Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
name |
— | string | Фильтр по названию по неполному совпадению. |
vendorCode |
— | string | Фильтр по артикулу по неполному совпадению. |
fulfilmentWarehouseId |
— | number | Фильтр по ID фулфилмент-склада. |
tnved |
— | string | Фильтр по ТН ВЭД по неполному совпадению. |
ids |
— | array | Фильтр по массиву ID товаров. |
vendorCodes |
— | array | Фильтр по массиву артикулов (полное совпадение). |
barcode |
— | string | Фильтр по штрих-коду по неполному совпадению. |
page |
— | number | Номер страницы. |
perPage |
— | number | Кол-во результатов на страницу. |
sort |
— | string |
Сортировка списка. Возможные значения:
По умолчанию список сортируется по ID в порядке убывания. |
desc |
— | string'true', 'false' |
Порядок сортировки. |
Данные ответа: массив моделей Product.
GET https://api.saferoute.ru/v2/products/{id} Требуется авторизация
Данные ответа: отдельная модель Product.
POST https://api.saferoute.ru/v2/products Требуется авторизация
Параметры запроса: модель Product.
Данные ответа.
| Параметр | Тип | Описание |
|---|---|---|
id |
number | ID созданного товара. |
PUT https://api.saferoute.ru/v2/products/{id} Требуется авторизация
Параметры запроса: модель Product.
PATCH https://api.saferoute.ru/v2/products/{id} Требуется авторизация
Параметры запроса: часть модели Product, которую требуется изменить.
DELETE https://api.saferoute.ru/v2/products/{id} Требуется авторизация
POST https://api.saferoute.ru/v2/products/import Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
file |
Да | string |
base64-представление xlsx-файла со списком товаров. Образец файла. В 1 файле допускается до 2 000 наименований товаров, при превышении этого количества API вернёт ошибку. При совпадении артикулов импортируемых товаров с артикулами товаров, уже имеющихся в Личном кабинете, товары в Личном кабинете перезаписываются. |
Данные ответа.
| Параметр | Тип | Описание |
|---|---|---|
success |
number | Количество успешно импортированных товаров. |
total |
number | Общее количество товаров в файле. |
errors |
object |
Ошибки импорта. Объект, в котором ключами выступают номера строк xlsx-файла, в которых содержатся ошибки. Значения – вложенные объекты с 2 полями:
|