openapi: 3.0.3
info:
title: 'Emall OpenAPI V1 документация'
description: ''
version: 1.0.0
servers:
-
url: 'https://api-sandbox.emall.by'
paths:
/open/api/v1/catalog/categories:
get:
summary: 'Получение каталога категорий'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр).'
example: 10
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 10
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 4220
name: Продукты
children:
-
id: 4170
name: 'Молочные продукты'
children:
-
id: 5969
name: 'Категория-ссылка тест5'
-
id: 3818
name: Молоко
-
id: 4823
name: 'Сгущенное, сухое молоко'
-
id: 4273
name: Сыр
-
id: 4655
name: Сливки
-
id: 3899
name: Йогурт
-
id: 4068
name: Десерты
-
id: 3802
name: 'Трубочки для молока'
-
id: 4051
name: Кофе
children:
-
id: 4183
name: 'Кофе молотый'
-
id: 3855
name: 'Кофе растворимый'
-
id: 4324
name: 'Кофе в зернах'
-
id: 4797
name: 'Кофе порционный'
-
id: 4023
name: 'Капсулы для кофемашин'
-
id: 3733
name: Какао
-
id: 4203
name: 'Цикорий, кофейные напитки'
-
id: 4488
name: Чай
children:
-
id: 4640
name: 'Чай пакетированный'
-
id: 3895
name: 'Чай листовой'
-
id: 4361
name: 'Чай травяной и фиточай'
-
id: 3703
name: Сладости
children:
-
id: 4571
name: Шоколад
-
id: 3789
name: 'Конфеты шоколадные'
-
id: 4279
name: 'Наборы конфет'
-
id: 4417
name: 'Батончики шоколадные'
-
id: 3952
name: 'Зефир, пастила'
-
id: 4122
name: 'Жевательная резинка'
-
id: 4587
name: 'Конфеты жевательные'
-
id: 3821
name: 'Шоколадно-ореховые пасты'
-
id: 3991
name: Мармелад
-
id: 4737
name: 'Леденцы, карамель'
-
id: 3692
name: Халва
-
id: 4456
name: 'Шоколадные яйца и фигурный шоколад'
-
id: 4608
name: 'Восточные сладости'
-
id: 5939
name: 'Сладкие подарочные наборы'
-
id: 4635
name: 'Мучные изделия, хлеб'
children:
-
id: 4710
name: Печенье
-
id: 4395
name: Вафли
-
id: 4450
name: 'Рулеты, бисквиты, круассаны, кексы'
-
id: 3986
name: 'Пряники, коврижки'
-
id: 4129
name: 'Кукурузные палочки'
-
id: 4292
name: Сушки
-
id: 3844
name: Сухари
-
id: 4597
name: 'Хлебобулочные изделия'
-
id: 4257
name: Крекеры
-
id: 3936
name: 'Коржи, вафельные листы для тортов, тарталетки'
-
id: 4576
name: 'Пироги, вафельные торты'
-
id: 4730
name: Пирожные
-
id: 3758
name: 'Сахар, соль, специи, соусы'
children:
-
id: 3801
name: Сахар
-
id: 3960
name: 'Смеси специй, приправы, панировочные сухари'
-
id: 4692
name: 'Специи, пряности, травы'
-
id: 3817
name: 'Крахмал, сода, лимонная кислота, желатин'
-
id: 4410
name: 'Для выпечки'
-
id: 5669
name: 'К Пасхе'
-
id: 4245
name: Соль
-
id: 4877
name: Дрожжи
-
id: 4379
name: 'Майонез, майонезные соусы'
-
id: 4818
name: Кетчуп
-
id: 4054
name: 'Томатный соус'
-
id: 4516
name: 'Заправка для салатов, другие соусы'
-
id: 3763
name: Уксус
-
id: 4189
name: 'Горчица, хрен, аджика'
-
id: 4669
name: 'Консервированная продукция'
children:
-
id: 4342
name: 'Консервы рыбные'
-
id: 3861
name: 'Консервы мясные'
-
id: 4016
name: 'Кукуруза, горошек консервированные'
-
id: 4803
name: 'Маслины, оливки консервированные'
-
id: 3746
name: 'Фрукты, ягоды консервированные'
-
id: 4188
name: 'Варенье, джемы, мед'
-
id: 4636
name: 'Фасоль консервированная'
-
id: 3825
name: 'Томаты консервированные'
-
id: 4285
name: 'Огурцы консервированные'
-
id: 4741
name: 'Грибы консервированные'
-
id: 3689
name: 'Другие овощи консервированные'
-
id: 4505
name: 'Крупы, каши, хлопья'
children:
-
id: 4476
name: Рис
-
id: 4607
name: 'Крупа гречневая'
-
id: 4148
name: 'Сухие завтраки'
-
id: 4149
name: 'Смеси круп'
-
id: 4435
name: Хлопья
-
id: 4865
name: 'Мюсли, батончики'
-
id: 3697
name: Каши
-
id: 3975
name: 'Горох, фасоль, чечевица, нут'
-
id: 4308
name: 'Крупы иные'
-
id: 3849
name: 'Крупа в варочных пакетах, гарниры'
-
id: 4061
name: Макароны
children:
-
id: 4015
name: 'Макаронные изделия'
-
id: 4218
name: Масло
children:
-
id: 3788
name: 'Подсолнечное масло'
-
id: 4534
name: 'Оливковое масло'
-
id: 4677
name: 'Другие масла'
-
id: 4227
name: 'Льняное масло'
-
id: 3742
name: Мука
children:
-
id: 4817
name: 'Мука пшеничная'
-
id: 3876
name: 'Мука иная'
-
id: 4331
name: 'Мучные смеси'
-
id: 3886
name: 'Соки, напитки, вода'
children:
-
id: 4691
name: 'Напитки газированные'
-
id: 4443
name: Вода
-
id: 3935
name: 'Сокосодержащие негазированные'
-
id: 4462
name: 'Чай, кофе холодный'
-
id: 3691
name: 'Безалкогольное вино'
-
id: 4614
name: Квас
-
id: 4162
name: 'Морсы, компоты'
-
id: 4304
name: Нектары
-
id: 4735
name: 'Сиропы и топпинги'
-
id: 3980
name: Соки
-
id: 3940
name: 'Энергетические напитки'
-
id: 5865
name: 'Детское шампанское'
-
id: 4766
name: 'Здоровое питание'
children:
-
id: 4098
name: Хлебцы
-
id: 4847
name: 'Кондитерские изделия'
-
id: 3813
name: 'Протеиносодержащие продукты'
-
id: 4278
name: 'Напитки диетические'
-
id: 4709
name: 'Заменители сахара'
-
id: 3964
name: 'Клетчатка, отруби, семена, зерно для проращивания'
-
id: 4291
name: 'Продукты без глютена'
-
id: 4449
name: 'Наборы для похудения'
-
id: 4596
name: 'Сиропы, джемы низкокалорийные'
-
id: 4848
name: 'Каши, супы'
-
id: 4086
name: 'Низкобелковые продукты'
-
id: 4022
name: 'Чипсы, орехи, снеки'
children:
-
id: 4240
name: 'Чипсы, снеки'
-
id: 4371
name: Орехи
-
id: 3923
name: Семечки
-
id: 4062
name: Сухофрукты
-
id: 4506
name: Сухарики
-
id: 3759
name: 'Смеси орехов и сухофруктов'
-
id: 4219
name: 'Сушеная рыба и морепродукты'
-
id: 4409
name: 'Попкорн и сладкая вата'
-
id: 3867
name: 'Продукты быстрого приготовления'
children:
-
id: 4454
name: 'Макаронные изделия'
-
id: 4603
name: Бульоны
-
id: 4171
name: Супы
-
id: 4312
name: 'Картофельное пюре'
-
id: 4682
name: 'Напитки и десерты'
-
id: 4468
name: 'Восточные продукты'
children:
-
id: 3782
name: 'Товары восточной кухни'
-
id: 4311
name: 'Колбасные изделия'
children:
-
id: 4547
name: 'Колбасные изделия'
-
id: 5851
name: 'Для вегетарианцев'
children:
-
id: 5855
name: Урбеч
-
id: 5856
name: 'Соевые продукты'
-
id: 5854
name: 'Растительное молоко'
-
id: 5857
name: 'Vega сладости'
meta:
total: 17
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 4220
name: Продукты
children:
-
id: 4170
name: 'Молочные продукты'
children:
-
id: 5969
name: 'Категория-ссылка тест5'
-
id: 3818
name: Молоко
-
id: 4823
name: 'Сгущенное, сухое молоко'
-
id: 4273
name: Сыр
-
id: 4655
name: Сливки
-
id: 3899
name: Йогурт
-
id: 4068
name: Десерты
-
id: 3802
name: 'Трубочки для молока'
-
id: 4051
name: Кофе
children:
-
id: 4183
name: 'Кофе молотый'
-
id: 3855
name: 'Кофе растворимый'
-
id: 4324
name: 'Кофе в зернах'
-
id: 4797
name: 'Кофе порционный'
-
id: 4023
name: 'Капсулы для кофемашин'
-
id: 3733
name: Какао
-
id: 4203
name: 'Цикорий, кофейные напитки'
-
id: 4488
name: Чай
children:
-
id: 4640
name: 'Чай пакетированный'
-
id: 3895
name: 'Чай листовой'
-
id: 4361
name: 'Чай травяной и фиточай'
-
id: 3703
name: Сладости
children:
-
id: 4571
name: Шоколад
-
id: 3789
name: 'Конфеты шоколадные'
-
id: 4279
name: 'Наборы конфет'
-
id: 4417
name: 'Батончики шоколадные'
-
id: 3952
name: 'Зефир, пастила'
-
id: 4122
name: 'Жевательная резинка'
-
id: 4587
name: 'Конфеты жевательные'
-
id: 3821
name: 'Шоколадно-ореховые пасты'
-
id: 3991
name: Мармелад
-
id: 4737
name: 'Леденцы, карамель'
-
id: 3692
name: Халва
-
id: 4456
name: 'Шоколадные яйца и фигурный шоколад'
-
id: 4608
name: 'Восточные сладости'
-
id: 5939
name: 'Сладкие подарочные наборы'
-
id: 4635
name: 'Мучные изделия, хлеб'
children:
-
id: 4710
name: Печенье
-
id: 4395
name: Вафли
-
id: 4450
name: 'Рулеты, бисквиты, круассаны, кексы'
-
id: 3986
name: 'Пряники, коврижки'
-
id: 4129
name: 'Кукурузные палочки'
-
id: 4292
name: Сушки
-
id: 3844
name: Сухари
-
id: 4597
name: 'Хлебобулочные изделия'
-
id: 4257
name: Крекеры
-
id: 3936
name: 'Коржи, вафельные листы для тортов, тарталетки'
-
id: 4576
name: 'Пироги, вафельные торты'
-
id: 4730
name: Пирожные
-
id: 3758
name: 'Сахар, соль, специи, соусы'
children:
-
id: 3801
name: Сахар
-
id: 3960
name: 'Смеси специй, приправы, панировочные сухари'
-
id: 4692
name: 'Специи, пряности, травы'
-
id: 3817
name: 'Крахмал, сода, лимонная кислота, желатин'
-
id: 4410
name: 'Для выпечки'
-
id: 5669
name: 'К Пасхе'
-
id: 4245
name: Соль
-
id: 4877
name: Дрожжи
-
id: 4379
name: 'Майонез, майонезные соусы'
-
id: 4818
name: Кетчуп
-
id: 4054
name: 'Томатный соус'
-
id: 4516
name: 'Заправка для салатов, другие соусы'
-
id: 3763
name: Уксус
-
id: 4189
name: 'Горчица, хрен, аджика'
-
id: 4669
name: 'Консервированная продукция'
children:
-
id: 4342
name: 'Консервы рыбные'
-
id: 3861
name: 'Консервы мясные'
-
id: 4016
name: 'Кукуруза, горошек консервированные'
-
id: 4803
name: 'Маслины, оливки консервированные'
-
id: 3746
name: 'Фрукты, ягоды консервированные'
-
id: 4188
name: 'Варенье, джемы, мед'
-
id: 4636
name: 'Фасоль консервированная'
-
id: 3825
name: 'Томаты консервированные'
-
id: 4285
name: 'Огурцы консервированные'
-
id: 4741
name: 'Грибы консервированные'
-
id: 3689
name: 'Другие овощи консервированные'
-
id: 4505
name: 'Крупы, каши, хлопья'
children:
-
id: 4476
name: Рис
-
id: 4607
name: 'Крупа гречневая'
-
id: 4148
name: 'Сухие завтраки'
-
id: 4149
name: 'Смеси круп'
-
id: 4435
name: Хлопья
-
id: 4865
name: 'Мюсли, батончики'
-
id: 3697
name: Каши
-
id: 3975
name: 'Горох, фасоль, чечевица, нут'
-
id: 4308
name: 'Крупы иные'
-
id: 3849
name: 'Крупа в варочных пакетах, гарниры'
-
id: 4061
name: Макароны
children:
-
id: 4015
name: 'Макаронные изделия'
-
id: 4218
name: Масло
children:
-
id: 3788
name: 'Подсолнечное масло'
-
id: 4534
name: 'Оливковое масло'
-
id: 4677
name: 'Другие масла'
-
id: 4227
name: 'Льняное масло'
-
id: 3742
name: Мука
children:
-
id: 4817
name: 'Мука пшеничная'
-
id: 3876
name: 'Мука иная'
-
id: 4331
name: 'Мучные смеси'
-
id: 3886
name: 'Соки, напитки, вода'
children:
-
id: 4691
name: 'Напитки газированные'
-
id: 4443
name: Вода
-
id: 3935
name: 'Сокосодержащие негазированные'
-
id: 4462
name: 'Чай, кофе холодный'
-
id: 3691
name: 'Безалкогольное вино'
-
id: 4614
name: Квас
-
id: 4162
name: 'Морсы, компоты'
-
id: 4304
name: Нектары
-
id: 4735
name: 'Сиропы и топпинги'
-
id: 3980
name: Соки
-
id: 3940
name: 'Энергетические напитки'
-
id: 5865
name: 'Детское шампанское'
-
id: 4766
name: 'Здоровое питание'
children:
-
id: 4098
name: Хлебцы
-
id: 4847
name: 'Кондитерские изделия'
-
id: 3813
name: 'Протеиносодержащие продукты'
-
id: 4278
name: 'Напитки диетические'
-
id: 4709
name: 'Заменители сахара'
-
id: 3964
name: 'Клетчатка, отруби, семена, зерно для проращивания'
-
id: 4291
name: 'Продукты без глютена'
-
id: 4449
name: 'Наборы для похудения'
-
id: 4596
name: 'Сиропы, джемы низкокалорийные'
-
id: 4848
name: 'Каши, супы'
-
id: 4086
name: 'Низкобелковые продукты'
-
id: 4022
name: 'Чипсы, орехи, снеки'
children:
-
id: 4240
name: 'Чипсы, снеки'
-
id: 4371
name: Орехи
-
id: 3923
name: Семечки
-
id: 4062
name: Сухофрукты
-
id: 4506
name: Сухарики
-
id: 3759
name: 'Смеси орехов и сухофруктов'
-
id: 4219
name: 'Сушеная рыба и морепродукты'
-
id: 4409
name: 'Попкорн и сладкая вата'
-
id: 3867
name: 'Продукты быстрого приготовления'
children:
-
id: 4454
name: 'Макаронные изделия'
-
id: 4603
name: Бульоны
-
id: 4171
name: Супы
-
id: 4312
name: 'Картофельное пюре'
-
id: 4682
name: 'Напитки и десерты'
-
id: 4468
name: 'Восточные продукты'
children:
-
id: 3782
name: 'Товары восточной кухни'
-
id: 4311
name: 'Колбасные изделия'
children:
-
id: 4547
name: 'Колбасные изделия'
-
id: 5851
name: 'Для вегетарианцев'
children:
-
id: 5855
name: Урбеч
-
id: 5856
name: 'Соевые продукты'
-
id: 5854
name: 'Растительное молоко'
-
id: 5857
name: 'Vega сладости'
items:
type: object
properties:
id:
type: integer
example: 4220
name:
type: string
example: Продукты
children:
type: array
example:
-
id: 4170
name: 'Молочные продукты'
children:
-
id: 5969
name: 'Категория-ссылка тест5'
-
id: 3818
name: Молоко
-
id: 4823
name: 'Сгущенное, сухое молоко'
-
id: 4273
name: Сыр
-
id: 4655
name: Сливки
-
id: 3899
name: Йогурт
-
id: 4068
name: Десерты
-
id: 3802
name: 'Трубочки для молока'
-
id: 4051
name: Кофе
children:
-
id: 4183
name: 'Кофе молотый'
-
id: 3855
name: 'Кофе растворимый'
-
id: 4324
name: 'Кофе в зернах'
-
id: 4797
name: 'Кофе порционный'
-
id: 4023
name: 'Капсулы для кофемашин'
-
id: 3733
name: Какао
-
id: 4203
name: 'Цикорий, кофейные напитки'
-
id: 4488
name: Чай
children:
-
id: 4640
name: 'Чай пакетированный'
-
id: 3895
name: 'Чай листовой'
-
id: 4361
name: 'Чай травяной и фиточай'
-
id: 3703
name: Сладости
children:
-
id: 4571
name: Шоколад
-
id: 3789
name: 'Конфеты шоколадные'
-
id: 4279
name: 'Наборы конфет'
-
id: 4417
name: 'Батончики шоколадные'
-
id: 3952
name: 'Зефир, пастила'
-
id: 4122
name: 'Жевательная резинка'
-
id: 4587
name: 'Конфеты жевательные'
-
id: 3821
name: 'Шоколадно-ореховые пасты'
-
id: 3991
name: Мармелад
-
id: 4737
name: 'Леденцы, карамель'
-
id: 3692
name: Халва
-
id: 4456
name: 'Шоколадные яйца и фигурный шоколад'
-
id: 4608
name: 'Восточные сладости'
-
id: 5939
name: 'Сладкие подарочные наборы'
-
id: 4635
name: 'Мучные изделия, хлеб'
children:
-
id: 4710
name: Печенье
-
id: 4395
name: Вафли
-
id: 4450
name: 'Рулеты, бисквиты, круассаны, кексы'
-
id: 3986
name: 'Пряники, коврижки'
-
id: 4129
name: 'Кукурузные палочки'
-
id: 4292
name: Сушки
-
id: 3844
name: Сухари
-
id: 4597
name: 'Хлебобулочные изделия'
-
id: 4257
name: Крекеры
-
id: 3936
name: 'Коржи, вафельные листы для тортов, тарталетки'
-
id: 4576
name: 'Пироги, вафельные торты'
-
id: 4730
name: Пирожные
-
id: 3758
name: 'Сахар, соль, специи, соусы'
children:
-
id: 3801
name: Сахар
-
id: 3960
name: 'Смеси специй, приправы, панировочные сухари'
-
id: 4692
name: 'Специи, пряности, травы'
-
id: 3817
name: 'Крахмал, сода, лимонная кислота, желатин'
-
id: 4410
name: 'Для выпечки'
-
id: 5669
name: 'К Пасхе'
-
id: 4245
name: Соль
-
id: 4877
name: Дрожжи
-
id: 4379
name: 'Майонез, майонезные соусы'
-
id: 4818
name: Кетчуп
-
id: 4054
name: 'Томатный соус'
-
id: 4516
name: 'Заправка для салатов, другие соусы'
-
id: 3763
name: Уксус
-
id: 4189
name: 'Горчица, хрен, аджика'
-
id: 4669
name: 'Консервированная продукция'
children:
-
id: 4342
name: 'Консервы рыбные'
-
id: 3861
name: 'Консервы мясные'
-
id: 4016
name: 'Кукуруза, горошек консервированные'
-
id: 4803
name: 'Маслины, оливки консервированные'
-
id: 3746
name: 'Фрукты, ягоды консервированные'
-
id: 4188
name: 'Варенье, джемы, мед'
-
id: 4636
name: 'Фасоль консервированная'
-
id: 3825
name: 'Томаты консервированные'
-
id: 4285
name: 'Огурцы консервированные'
-
id: 4741
name: 'Грибы консервированные'
-
id: 3689
name: 'Другие овощи консервированные'
-
id: 4505
name: 'Крупы, каши, хлопья'
children:
-
id: 4476
name: Рис
-
id: 4607
name: 'Крупа гречневая'
-
id: 4148
name: 'Сухие завтраки'
-
id: 4149
name: 'Смеси круп'
-
id: 4435
name: Хлопья
-
id: 4865
name: 'Мюсли, батончики'
-
id: 3697
name: Каши
-
id: 3975
name: 'Горох, фасоль, чечевица, нут'
-
id: 4308
name: 'Крупы иные'
-
id: 3849
name: 'Крупа в варочных пакетах, гарниры'
-
id: 4061
name: Макароны
children:
-
id: 4015
name: 'Макаронные изделия'
-
id: 4218
name: Масло
children:
-
id: 3788
name: 'Подсолнечное масло'
-
id: 4534
name: 'Оливковое масло'
-
id: 4677
name: 'Другие масла'
-
id: 4227
name: 'Льняное масло'
-
id: 3742
name: Мука
children:
-
id: 4817
name: 'Мука пшеничная'
-
id: 3876
name: 'Мука иная'
-
id: 4331
name: 'Мучные смеси'
-
id: 3886
name: 'Соки, напитки, вода'
children:
-
id: 4691
name: 'Напитки газированные'
-
id: 4443
name: Вода
-
id: 3935
name: 'Сокосодержащие негазированные'
-
id: 4462
name: 'Чай, кофе холодный'
-
id: 3691
name: 'Безалкогольное вино'
-
id: 4614
name: Квас
-
id: 4162
name: 'Морсы, компоты'
-
id: 4304
name: Нектары
-
id: 4735
name: 'Сиропы и топпинги'
-
id: 3980
name: Соки
-
id: 3940
name: 'Энергетические напитки'
-
id: 5865
name: 'Детское шампанское'
-
id: 4766
name: 'Здоровое питание'
children:
-
id: 4098
name: Хлебцы
-
id: 4847
name: 'Кондитерские изделия'
-
id: 3813
name: 'Протеиносодержащие продукты'
-
id: 4278
name: 'Напитки диетические'
-
id: 4709
name: 'Заменители сахара'
-
id: 3964
name: 'Клетчатка, отруби, семена, зерно для проращивания'
-
id: 4291
name: 'Продукты без глютена'
-
id: 4449
name: 'Наборы для похудения'
-
id: 4596
name: 'Сиропы, джемы низкокалорийные'
-
id: 4848
name: 'Каши, супы'
-
id: 4086
name: 'Низкобелковые продукты'
-
id: 4022
name: 'Чипсы, орехи, снеки'
children:
-
id: 4240
name: 'Чипсы, снеки'
-
id: 4371
name: Орехи
-
id: 3923
name: Семечки
-
id: 4062
name: Сухофрукты
-
id: 4506
name: Сухарики
-
id: 3759
name: 'Смеси орехов и сухофруктов'
-
id: 4219
name: 'Сушеная рыба и морепродукты'
-
id: 4409
name: 'Попкорн и сладкая вата'
-
id: 3867
name: 'Продукты быстрого приготовления'
children:
-
id: 4454
name: 'Макаронные изделия'
-
id: 4603
name: Бульоны
-
id: 4171
name: Супы
-
id: 4312
name: 'Картофельное пюре'
-
id: 4682
name: 'Напитки и десерты'
-
id: 4468
name: 'Восточные продукты'
children:
-
id: 3782
name: 'Товары восточной кухни'
-
id: 4311
name: 'Колбасные изделия'
children:
-
id: 4547
name: 'Колбасные изделия'
-
id: 5851
name: 'Для вегетарианцев'
children:
-
id: 5855
name: Урбеч
-
id: 5856
name: 'Соевые продукты'
-
id: 5854
name: 'Растительное молоко'
-
id: 5857
name: 'Vega сладости'
items:
type: object
properties:
id:
type: integer
example: 4170
name:
type: string
example: 'Молочные продукты'
children:
type: array
example:
-
id: 5969
name: 'Категория-ссылка тест5'
-
id: 3818
name: Молоко
-
id: 4823
name: 'Сгущенное, сухое молоко'
-
id: 4273
name: Сыр
-
id: 4655
name: Сливки
-
id: 3899
name: Йогурт
-
id: 4068
name: Десерты
-
id: 3802
name: 'Трубочки для молока'
items:
type: object
properties:
id:
type: integer
example: 5969
name:
type: string
example: 'Категория-ссылка тест5'
meta:
type: object
properties:
total:
type: integer
example: 17
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- Справочники
/open/api/v1/catalog/countries:
get:
summary: 'Получение каталога стран'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр).'
example: 10
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 10
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 133
name: Австралия
meta:
total: 17
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 133
name: Австралия
items:
type: object
properties:
id:
type: integer
example: 133
name:
type: string
example: Австралия
meta:
type: object
properties:
total:
type: integer
example: 17
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- Справочники
/open/api/v1/catalog/brands:
get:
summary: 'Получение каталога брендов'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр).'
example: 10
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 10
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 23267
name: Apple
meta:
total: 17
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 23267
name: Apple
items:
type: object
properties:
id:
type: integer
example: 23267
name:
type: string
example: Apple
meta:
type: object
properties:
total:
type: integer
example: 17
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- Справочники
/open/api/v1/catalog/warehouses:
get:
summary: 'Получение каталога ОПС'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр).'
example: 10
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 10
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
name: 'Минск, Логистический центр,оптовый N1'
weekdays: []
meta:
total: 17
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 1
name: 'Минск, Логистический центр,оптовый N1'
weekdays: []
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'Минск, Логистический центр,оптовый N1'
weekdays:
type: array
example: []
meta:
type: object
properties:
total:
type: integer
example: 17
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- Справочники
/open/api/v1/products:
get:
summary: 'Получение товаров'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
-
in: query
name: ids
description: 'ID продуктов (товаров). Пример:'
example: '1,2,5,8'
required: false
schema:
type: string
description: 'ID продуктов (товаров). Пример:'
example: '1,2,5,8'
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
name: 'Название товара'
country_id: 133
category_id: 3818
images:
- 'https://api-sandbox.emall.by/storage/images/14f85b7fa194ad9e945093da6dbd045f.jpg'
- 'https://api-sandbox.emall.by/storage/images/35a4835316a219540cd8e635307415e9.jpg'
- 'https://api-sandbox.emall.by/storage/images/4e990a6b6de888e6a0acf856c907e52b.jpg'
- 'https://api-sandbox.emall.by/storage/images/e547ec8a4adb21981e577fcff02c9f67.jpg'
- 'https://api-sandbox.emall.by/storage/images/81d2c093169bb71f2639e2da95d96553.jpg'
- 'https://api-sandbox.emall.by/storage/images/fdefe18a8d96c4505802387aa5ee968d.jpg'
- 'https://api-sandbox.emall.by/storage/images/5b3eb2dbbbdbaa50666b4fd008a1d29f.jpg'
- 'https://api-sandbox.emall.by/storage/images/c49e67a7c5b91cf0283ee9c0c1142781.jpg'
properties:
'149':
- 11022
'308': '100'
'1788': '1510'
'1811': '890'
'1877':
- 86
'2968':
- '100'
- '123'
'3360':
- 297
'4717': '2005'
'5719':
- 358
'8567': test
'24504':
- 11018
'25264':
- 351
'25266':
- 356
'26953': '300'
'26954': '500'
'27979': true
barcode: '4816138913389'
inner_article: '6950037'
prices:
price: 2000
old_price: 2100
is_adult: false
dimension:
width: 100
height: 1200
length: 1200
weight: 29990
composition: null
brand_id: 26330
manufacturer_name: 'Название производителя товара'
warranty_unit: days
warranty_value: '35'
service_centres: null
importer_name: 'ООО "Какая-то Компания" г. Минск, ул. Улица 123/4 пав. 231/0, УНП 00000000, 8-000-000-11-22'
description: 'Описание товара'
vat: 20
stock: 300
kit: 2
meta:
total: 17
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 1
name: 'Название товара'
country_id: 133
category_id: 3818
images:
- 'https://api-sandbox.emall.by/storage/images/14f85b7fa194ad9e945093da6dbd045f.jpg'
- 'https://api-sandbox.emall.by/storage/images/35a4835316a219540cd8e635307415e9.jpg'
- 'https://api-sandbox.emall.by/storage/images/4e990a6b6de888e6a0acf856c907e52b.jpg'
- 'https://api-sandbox.emall.by/storage/images/e547ec8a4adb21981e577fcff02c9f67.jpg'
- 'https://api-sandbox.emall.by/storage/images/81d2c093169bb71f2639e2da95d96553.jpg'
- 'https://api-sandbox.emall.by/storage/images/fdefe18a8d96c4505802387aa5ee968d.jpg'
- 'https://api-sandbox.emall.by/storage/images/5b3eb2dbbbdbaa50666b4fd008a1d29f.jpg'
- 'https://api-sandbox.emall.by/storage/images/c49e67a7c5b91cf0283ee9c0c1142781.jpg'
properties:
149:
- 11022
308: '100'
1788: '1510'
1811: '890'
1877:
- 86
2968:
- '100'
- '123'
3360:
- 297
4717: '2005'
5719:
- 358
8567: test
24504:
- 11018
25264:
- 351
25266:
- 356
26953: '300'
26954: '500'
27979: true
barcode: '4816138913389'
inner_article: '6950037'
prices:
price: 2000
old_price: 2100
is_adult: false
dimension:
width: 100
height: 1200
length: 1200
weight: 29990
composition: null
brand_id: 26330
manufacturer_name: 'Название производителя товара'
warranty_unit: days
warranty_value: '35'
service_centres: null
importer_name: 'ООО "Какая-то Компания" г. Минск, ул. Улица 123/4 пав. 231/0, УНП 00000000, 8-000-000-11-22'
description: 'Описание товара'
vat: 20
stock: 300
kit: 2
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'Название товара'
country_id:
type: integer
example: 133
category_id:
type: integer
example: 3818
images:
type: array
example:
- 'https://api-sandbox.emall.by/storage/images/14f85b7fa194ad9e945093da6dbd045f.jpg'
- 'https://api-sandbox.emall.by/storage/images/35a4835316a219540cd8e635307415e9.jpg'
- 'https://api-sandbox.emall.by/storage/images/4e990a6b6de888e6a0acf856c907e52b.jpg'
- 'https://api-sandbox.emall.by/storage/images/e547ec8a4adb21981e577fcff02c9f67.jpg'
- 'https://api-sandbox.emall.by/storage/images/81d2c093169bb71f2639e2da95d96553.jpg'
- 'https://api-sandbox.emall.by/storage/images/fdefe18a8d96c4505802387aa5ee968d.jpg'
- 'https://api-sandbox.emall.by/storage/images/5b3eb2dbbbdbaa50666b4fd008a1d29f.jpg'
- 'https://api-sandbox.emall.by/storage/images/c49e67a7c5b91cf0283ee9c0c1142781.jpg'
items:
type: string
properties:
type: object
properties:
149:
type: array
example:
- 11022
items:
type: integer
308:
type: string
example: '100'
1788:
type: string
example: '1510'
1811:
type: string
example: '890'
1877:
type: array
example:
- 86
items:
type: integer
2968:
type: array
example:
- '100'
- '123'
items:
type: string
3360:
type: array
example:
- 297
items:
type: integer
4717:
type: string
example: '2005'
5719:
type: array
example:
- 358
items:
type: integer
8567:
type: string
example: test
24504:
type: array
example:
- 11018
items:
type: integer
25264:
type: array
example:
- 351
items:
type: integer
25266:
type: array
example:
- 356
items:
type: integer
26953:
type: string
example: '300'
26954:
type: string
example: '500'
27979:
type: boolean
example: true
barcode:
type: string
example: '4816138913389'
inner_article:
type: string
example: '6950037'
prices:
type: object
properties:
price:
type: integer
example: 2000
old_price:
type: integer
example: 2100
is_adult:
type: boolean
example: false
dimension:
type: object
properties:
width:
type: integer
example: 100
height:
type: integer
example: 1200
length:
type: integer
example: 1200
weight:
type: integer
example: 29990
composition:
type: string
example: null
brand_id:
type: integer
example: 26330
manufacturer_name:
type: string
example: 'Название производителя товара'
warranty_unit:
type: string
example: days
warranty_value:
type: string
example: '35'
service_centres:
type: string
example: null
importer_name:
type: string
example: 'ООО "Какая-то Компания" г. Минск, ул. Улица 123/4 пав. 231/0, УНП 00000000, 8-000-000-11-22'
description:
type: string
example: 'Описание товара'
vat:
type: integer
example: 20
stock:
type: integer
example: 300
kit:
type: integer
example: 2
meta:
type: object
properties:
total:
type: integer
example: 17
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с товарами'
post:
summary: 'Создание товаров'
operationId: ''
description: "\n - \n Получите список всех категорий с помощью метода Получение всех категорий\n
\n - \n Получите список доступных подкатегорий с помощью метода Получение дочерних категорий для категории при их наличии\n
\n - \n Получите характеристики, которые можно задавать для этой подкатегории, с помощью метода Характеристики указанной категории\n
\n Для категорий товаров, характеристик, стран производителей, брендов, используйте значения из раздела Конфигуратор.\n \n - \n Для удобство можно получить шаблон для заполнения товаров с помощью метода Шаблон\n
\n - \n Заполните шаблон данными и отправьте запрос. Если ответ Успешно (200), значит все карточки создались, если же есть ошибка, то карточки не создадутся и в ответе придет объяснение ошибки\n
\n
\n
\n\n - \n В одном запросе можно создать максимум 100 карточек
(id).\n \n - \n Максимальный размер запроса 10 Мб.\n
\n
"
parameters: []
responses:
400:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка валидации'
errors:
'<массив_продуктов>.<индекс_в_массиве>':
'<поле>':
- '<описание_ошибки>'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка валидации'
errors:
type: object
properties:
'<массив_продуктов>.<индекс_в_массиве>':
type: object
properties:
'<поле>':
type: array
example:
- '<описание_ошибки>'
items:
type: string
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с товарами'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
items:
type: array
description: ''
example:
- []
items:
type: object
properties:
is_bunched:
type: boolean
description: 'Для создания вариантов (объединения) продуктов (товаров).
Если передается `true`, то продукты в массиве `products` должны иметь одинаковые `brand_id` и `category_id` для объединения'
example: false
nullable: false
products:
type: array
description: 'Массив добавляемых продуктов (товаров)'
example: null
items:
type: object
properties:
barcode:
type: string
description: 'Штрихкод продукта (товара)'
example: '11885828'
nullable: false
brand_id:
type: integer
description: 'ID бренда'
example: 27145
nullable: false
category_id:
type: integer
description: 'ID категории. Пункты 1, 2'
example: 3730
nullable: false
country_id:
type: integer
description: 'ID страны производителя'
example: 200
nullable: false
description:
type: string
description: 'Описание продукта (товара)'
example: 'Some description'
nullable: false
storage_period:
type: string
description: 'nullable Условия и сроки хранения (товара) Example:'
example: null
nullable: false
dimensions:
type: object
description: 'Габариты продуктов (товаров) - можно указать только в сантиметрах'
example: null
nullable: false
properties:
length:
type: integer
description: 'Длина продукта (товара)'
example: 1200
nullable: false
height:
type: integer
description: 'Высота продукта (товара)'
example: 1200
nullable: false
width:
type: integer
description: 'Ширина продукта (товара)'
example: 100
nullable: false
weight:
type: integer
description: 'Вес продукта (товара) в граммах - не более 30000'
example: 28900
nullable: false
images:
type: array
description: 'Массив ссылок на изображение продукта (товара)'
example:
- https....img_1.jpg
- https....img_2.jpg
items:
type: string
importer_name:
type: string
description: 'Название импортера продукта (товара)'
example: Alebarda
nullable: false
inner_article:
type: string
description: 'Внутренний артикул продукта (товара)'
example: '6950037'
nullable: false
is_adult:
type: boolean
description: 'Попадает ли продукт (товар) в категорию товаров для взрослых'
example: false
nullable: false
manufacturer_name:
type: string
description: 'Название производителя продукта (товара)'
example: Alebarda
nullable: false
name:
type: string
description: 'Название продукта (товара)'
example: 'Pan SK-25'
nullable: false
prices:
type: object
description: 'Объект, хранящий цены продукта (товара)'
example: null
nullable: false
properties:
price:
type: integer
description: 'Текущая цена продукта (товара). Указывается в копейках'
example: 2000
nullable: false
old_price:
type: integer
description: 'Цена продукта (товара). Указывается в копейках до применения скидки'
example: 2100
nullable: false
properties:
type: object
description: 'Дополнительные характеристики продукта (товара).'
example:
149: '2236'
1877:
- 86
- 117
- 133
- 91
2115: '6.7'
3447: '2255'
8993:
- 4516
nullable: false
properties: { }
service_centres:
type: string
description: 'Сервисные центры продукта (товара)'
example: null
nullable: false
stock:
type: integer
description: 'Остаток продукта (товара) на складе'
example: 300
nullable: false
vat:
type: integer
description: НДС
example: 10
nullable: false
enum:
- 0
- 10
- 20
warranty_unit:
type: string
description: 'Единица периода гарантийного срока.
Если передается `null`, продукт создатся без гарантийного срока'
example: days
nullable: false
enum:
- 'null'
- years
- months
- days
warranty_value:
type: integer
description: 'Количество единиц периода гарантийного срока.'
example: 35
nullable: false
kit:
type: integer
description: 'nullable Количество товаров в наборе.'
example: 45
nullable: false
installment:
type: boolean
description: 'nullable Доступность продукта (товара) в рассрочку.'
example: true
nullable: false
composition:
type: string
description: 'nullable Состав продукта (товара).'
example: 'Вода, этилпропиленгликоль'
nullable: false
required:
- barcode
- brand_id
- category_id
- country_id
- description
- dimensions
- images
- is_adult
- manufacturer_name
- name
- prices
- properties
- service_centres
- stock
- vat
- warranty_unit
- warranty_value
required:
- is_bunched
- products
required:
- items
patch:
summary: 'Редактирование товаров'
operationId: ''
description: "\n Данные для обновления можно получить с помощью методов Получение товаров или Получение товара\n
\n\n - \n В одном запросе можно создать максимум 100 карточек
(id).\n \n - \n Максимальный размер запроса 10 Мб.\n
\n
"
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
product_ids:
- 1
- 2
- 3
properties:
success:
type: boolean
example: true
data:
type: object
properties:
product_ids:
type: array
example:
- 1
- 2
- 3
items:
type: integer
400:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка валидации'
errors:
'<массив_продуктов>.<индекс_в_массиве>':
'<поле>':
- '<описание_ошибки>'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка валидации'
errors:
type: object
properties:
'<массив_продуктов>.<индекс_в_массиве>':
type: object
properties:
'<поле>':
type: array
example:
- '<описание_ошибки>'
items:
type: string
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
404:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Указанная <имя_модели> не найдена'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Указанная <имя_модели> не найдена'
tags:
- 'Работа с товарами'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
products:
type: array
description: 'Массив добавляемых продуктов (товаров)'
example: null
items:
type: object
properties:
id:
type: integer
description: 'ID продукта (товара)'
example: 11885828
nullable: false
barcode:
type: string
description: 'Штрихкод продукта (товара)'
example: '11885828'
nullable: false
brand_id:
type: integer
description: 'ID бренда'
example: 27145
nullable: false
category_id:
type: integer
description: 'ID категории. Пункты 1, 2'
example: 3730
nullable: false
country_id:
type: integer
description: 'ID страны производителя'
example: 99
nullable: false
description:
type: string
description: 'Описание продукта (товара)'
example: 'Some new description'
nullable: false
storage_period:
type: string
description: 'nullable Условия и сроки хранения (товара) Example:'
example: null
nullable: false
dimensions:
type: object
description: 'Габариты продуктов (товаров) - можно указать только в сантиметрах'
example: null
nullable: false
properties:
length:
type: integer
description: 'Длина продукта (товара)'
example: 900
nullable: false
height:
type: integer
description: 'Высота продукта (товара)'
example: 900
nullable: false
width:
type: integer
description: 'Ширина продукта (товара)'
example: 90
nullable: false
weight:
type: integer
description: 'Вес продукта (товара) в граммах - не более 30000'
example: 21900
nullable: false
images:
type: array
description: 'Массив ссылок на изображение продукта (товара)'
example:
- https....img_3.jpg
- https....img_4.jpg
items:
type: string
importer_name:
type: string
description: 'Название импортера продукта (товара)'
example: Alebarda_new
nullable: false
inner_article:
type: string
description: 'Внутренний артикул продукта (товара)'
example: '6950137'
nullable: false
is_adult:
type: boolean
description: 'Попадает ли продукт (товар) в категорию товаров для взрослых'
example: false
nullable: false
manufacturer_name:
type: string
description: 'Название производителя продукта (товара)'
example: Alebarda_new
nullable: false
name:
type: string
description: 'Название продукта (товара)'
example: 'Pan SK-25-2'
nullable: false
prices:
type: object
description: 'Объект, хранящий цены продукта (товара)'
example: null
nullable: false
properties:
price:
type: integer
description: 'Текущая цена продукта (товара). Указывается в копейках'
example: 2250
nullable: false
old_price:
type: integer
description: 'Цена продукта (товара) до применения скидки. Указывается в копейках'
example: 2500
nullable: false
properties:
type: object
description: 'Дополнительные характеристики продукта (товара).'
example:
149: '2236'
1877:
- 86
- 117
- 133
- 91
2115: '6.7'
3447: '2255'
8993:
- 4516
nullable: false
properties: { }
service_centres:
type: string
description: 'Сервисные центры продукта (товара)'
example: null
nullable: false
stock:
type: integer
description: 'Остаток продукта (товара) на складе'
example: 125
nullable: false
vat:
type: integer
description: НДС
example: 20
nullable: false
enum:
- 0
- 10
- 20
warranty_unit:
type: string
description: 'Единица периода гарантийного срока.
Если передается `null`, продукт создатся без гарантийного срока'
example: years
nullable: false
enum:
- none
- years
- months
- days
warranty_value:
type: integer
description: 'Количество единиц периода гарантийного срока.'
example: 2
nullable: false
kit:
type: integer
description: 'nullable Количество товаров в наборе.'
example: 45
nullable: false
installment:
type: boolean
description: 'nullable Доступность продукта (товара) в рассрочку.'
example: true
nullable: false
composition:
type: string
description: 'nullable Состав продукта (товара).'
example: 'Вода, этилпропиленгликоль'
nullable: false
required:
- id
- barcode
- brand_id
- category_id
- country_id
- description
- dimensions
- images
- importer_name
- is_adult
- manufacturer_name
- name
- prices
- properties
- service_centres
- stock
- vat
- warranty_unit
- warranty_value
required:
- products
'/open/api/v1/products/{product_id}':
get:
summary: 'Получение товара'
operationId: ''
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
id: 9000821
name: 'Смартфон iPhone 16 Pro Max'
country_id: 309
category_id: 3730
images:
- 'https://api-sandbox.emall.by/storage/images/7ed4b301d8328be4bc55570b20d85b1b.jpg'
- 'https://api-sandbox.emall.by/storage/images/bfeb8e4274e0e0734a1d08edf2e75c3d.jpg'
- 'https://api-sandbox.emall.by/storage/images/fc9dc2568af672e60a2dd6e29c7fdaa6.jpg'
- 'https://api-sandbox.emall.by/storage/images/9a4e4e433b233e9e38838b02c52335da.jpg'
- 'https://api-sandbox.emall.by/storage/images/8eef343f5d40cc5e8d42b8cfa127a50e.jpg'
properties:
'149':
- 346
'1788': '1510'
'1811': '890'
'1877':
- 86
'3360':
- 297
'25264':
- 351
'25266':
- 357
'26953': '300'
barcode: '5656565656561'
inner_article: 1245T678
prices:
price: 320000
old_price: 330000
is_adult: false
dimension:
width: 151
height: 200
length: 890
weight: 28000
composition: null
brand_id: 22117
manufacturer_name: Apple
warranty_unit: none
importer_name: Asbis
description: 'Первый iPhone с корпусом из авиационного титана. Чип A18 Pro задает новые стандарты производительности. Настраиваемая кнопка действия для вашего удобства. Самая мощная система камер среди всех iPhone. USB‑C и USB 3 обеспечивают молниеносную скорость передачи данных. От гибкости в кадрировании до портретов нового поколения, iPhone 15 Pro предлагает несколько фокусных расстояний, словно у вас в кармане семь профессиональных объективов. Основная камера на 48 Мп улучшена до неузнаваемости, создавая фотографии с потрясающей детализацией и насыщенностью цвета. Несмотря на обилие передовых функций, iPhone 15 Pro сохраняет впечатляющее время автономной работы на весь день. Воспроизведение видео на iPhone 15 Pro Max может длиться до 29 часов, а на iPhone 15 Pro — до 23 часов'
vat: 20
stock: 24
kit: null
properties:
id:
type: integer
example: 9000821
name:
type: string
example: 'Смартфон iPhone 16 Pro Max'
country_id:
type: integer
example: 309
category_id:
type: integer
example: 3730
images:
type: array
example:
- 'https://api-sandbox.emall.by/storage/images/7ed4b301d8328be4bc55570b20d85b1b.jpg'
- 'https://api-sandbox.emall.by/storage/images/bfeb8e4274e0e0734a1d08edf2e75c3d.jpg'
- 'https://api-sandbox.emall.by/storage/images/fc9dc2568af672e60a2dd6e29c7fdaa6.jpg'
- 'https://api-sandbox.emall.by/storage/images/9a4e4e433b233e9e38838b02c52335da.jpg'
- 'https://api-sandbox.emall.by/storage/images/8eef343f5d40cc5e8d42b8cfa127a50e.jpg'
items:
type: string
properties:
type: object
properties:
149:
type: array
example:
- 346
items:
type: integer
1788:
type: string
example: '1510'
1811:
type: string
example: '890'
1877:
type: array
example:
- 86
items:
type: integer
3360:
type: array
example:
- 297
items:
type: integer
25264:
type: array
example:
- 351
items:
type: integer
25266:
type: array
example:
- 357
items:
type: integer
26953:
type: string
example: '300'
barcode:
type: string
example: '5656565656561'
inner_article:
type: string
example: 1245T678
prices:
type: object
properties:
price:
type: integer
example: 320000
old_price:
type: integer
example: 330000
is_adult:
type: boolean
example: false
dimension:
type: object
properties:
width:
type: integer
example: 151
height:
type: integer
example: 200
length:
type: integer
example: 890
weight:
type: integer
example: 28000
composition:
type: string
example: null
brand_id:
type: integer
example: 22117
manufacturer_name:
type: string
example: Apple
warranty_unit:
type: string
example: none
importer_name:
type: string
example: Asbis
description:
type: string
example: 'Первый iPhone с корпусом из авиационного титана. Чип A18 Pro задает новые стандарты производительности. Настраиваемая кнопка действия для вашего удобства. Самая мощная система камер среди всех iPhone. USB‑C и USB 3 обеспечивают молниеносную скорость передачи данных. От гибкости в кадрировании до портретов нового поколения, iPhone 15 Pro предлагает несколько фокусных расстояний, словно у вас в кармане семь профессиональных объективов. Основная камера на 48 Мп улучшена до неузнаваемости, создавая фотографии с потрясающей детализацией и насыщенностью цвета. Несмотря на обилие передовых функций, iPhone 15 Pro сохраняет впечатляющее время автономной работы на весь день. Воспроизведение видео на iPhone 15 Pro Max может длиться до 29 часов, а на iPhone 15 Pro — до 23 часов'
vat:
type: integer
example: 20
stock:
type: integer
example: 24
kit:
type: string
example: null
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
404:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Указанная <имя_модели> не найдена'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Указанная <имя_модели> не найдена'
tags:
- 'Работа с товарами'
parameters:
-
in: path
name: product_id
description: 'ID продукта (товара)'
example: null
required: true
schema:
type: integer
/open/api/v1/products/short/status:
get:
summary: 'Получение списка товаров со статусами'
operationId: ''
description: ''
parameters:
-
in: query
name: ids
description: 'ID продуктов (товаров)'
example: '1,2,56'
required: false
schema:
type: string
description: 'ID продуктов (товаров)'
example: '1,2,56'
nullable: false
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
status: 'На проверке'
-
id: 2
status: 'На проверке'
-
id: 3
status: 'В продаже'
-
id: 4
status: 'На проверке'
-
id: 5
status: 'В продаже'
-
id: 6
status: 'В продаже'
-
id: 7
status: 'В продаже'
-
id: 8
status: 'В продаже'
-
id: 9
status: 'В продаже'
-
id: 10
status: 'В продаже'
-
id: 11
status: 'В продаже'
-
id: 12
status: 'В продаже'
-
id: 13
status: 'В продаже'
-
id: 14
status: 'В продаже'
-
id: 15
status: 'В продаже'
meta:
total: 16
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 1
status: 'На проверке'
-
id: 2
status: 'На проверке'
-
id: 3
status: 'В продаже'
-
id: 4
status: 'На проверке'
-
id: 5
status: 'В продаже'
-
id: 6
status: 'В продаже'
-
id: 7
status: 'В продаже'
-
id: 8
status: 'В продаже'
-
id: 9
status: 'В продаже'
-
id: 10
status: 'В продаже'
-
id: 11
status: 'В продаже'
-
id: 12
status: 'В продаже'
-
id: 13
status: 'В продаже'
-
id: 14
status: 'В продаже'
-
id: 15
status: 'В продаже'
items:
type: object
properties:
id:
type: integer
example: 1
status:
type: string
example: 'На проверке'
meta:
type: object
properties:
total:
type: integer
example: 16
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с товарами'
'/open/api/v1/products/short/status/{product_id}':
get:
summary: 'Получение информации по указанному товару со статусами'
operationId: ''
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
-
id: 1
status: 'На проверке'
properties:
success:
type: boolean
example: true
data:
type: array
example:
-
id: 1
status: 'На проверке'
items:
type: object
properties:
id:
type: integer
example: 1
status:
type: string
example: 'На проверке'
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
404:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Указанная <имя_модели> не найдена'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Указанная <имя_модели> не найдена'
tags:
- 'Работа с товарами'
parameters:
-
in: path
name: product_id
description: 'Optional parameter. ID продукта (товара)'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
/open/api/v1/change/products/status:
patch:
summary: 'Перевод товаров по статусам'
operationId: ''
description: "\n Для просмотра в каком статусе товар можно воспользоваться методами Получение списка товаров со статусами или Получение информации по указанному товару со статусами\n
\n\n - \n Когда товар находиться в статусе Не продается или Готов к продаже, селлер может перевести товар в статус В продаже.\n
\n - \n Когда товар находится В продаже, селлер может снять с продажи (Не продается)\n
\n
\nСписок всех статусов товара
\n\n \n \n | status | \n name | \n
\n \n \n \n | under_review | \n На проверке | \n
\n \n | need_fix | \n Требуется исправление | \n
\n \n | ready_to_sale | \n Готов к продаже | \n
\n \n | on_sale | \n В продаже | \n
\n \n | not_for_sale | \n Не продается | \n
\n \n | is_blocked | \n Заблокирован | \n
\n \n
"
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
product_ids:
- 1
- 2
- 3
properties:
success:
type: boolean
example: true
data:
type: object
properties:
product_ids:
type: array
example:
- 1
- 2
- 3
items:
type: integer
400:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка валидации'
errors:
'<массив_продуктов>.<индекс_в_массиве>':
'<поле>':
- '<описание_ошибки>'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка валидации'
errors:
type: object
properties:
'<массив_продуктов>.<индекс_в_массиве>':
type: object
properties:
'<поле>':
type: array
example:
- '<описание_ошибки>'
items:
type: string
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
404:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Указанная <имя_модели> не найдена'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Указанная <имя_модели> не найдена'
tags:
- 'Работа с товарами'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
products:
type: array
description: 'Массив ID обновляемыx продуктов (товаров).'
example: null
items:
type: object
properties:
id:
type: integer
description: 'ID продукта (товара).'
example: 13536
nullable: false
status:
type: string
description: 'Alias статуса продукта (товара).'
example: not_for_sale
nullable: false
enum:
- ready_to_sale
- on_sale
- not_for_sale
required:
- id
- status
required:
- products
/open/api/v1/configurator/categories:
get:
summary: 'Получение всех категорий'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 3671
name: Мотобуры
has_child: true
meta:
total: 17
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 3671
name: Мотобуры
has_child: true
items:
type: object
properties:
id:
type: integer
example: 3671
name:
type: string
example: Мотобуры
has_child:
type: boolean
example: true
meta:
type: object
properties:
total:
type: integer
example: 17
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с товарами'
'/open/api/v1/configurator/categories/{category_id}/subcategories':
get:
summary: 'Получение дочерних категорий для категории при их наличии'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 3671
name: 'Аксессуары для мобильных телефонов'
has_child: false
meta:
total: 17
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 3671
name: 'Аксессуары для мобильных телефонов'
has_child: false
items:
type: object
properties:
id:
type: integer
example: 3671
name:
type: string
example: 'Аксессуары для мобильных телефонов'
has_child:
type: boolean
example: false
meta:
type: object
properties:
total:
type: integer
example: 17
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
404:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Указанная <имя_модели> не найдена'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Указанная <имя_модели> не найдена'
tags:
- 'Работа с товарами'
parameters:
-
in: path
name: category_id
description: 'ID выбранной категории. Обязательный параметр.'
example: 3
required: true
schema:
type: integer
'/open/api/v1/configurator/categories/{category_id}/properties':
get:
summary: 'Характеристики указанной категории'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 149
is_required: true
is_variant: false
name: Тип
property:
name: Тип
type:
id: 3
name: list
title: Список
values:
-
id: 23227
value: 'Мотобур земляной'
-
id: 23228
value: 'Удлинитель шнека для мотобура'
-
id: 23229
value: 'Шнек к мотобуру'
meta:
total: 17
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 149
is_required: true
is_variant: false
name: Тип
property:
name: Тип
type:
id: 3
name: list
title: Список
values:
-
id: 23227
value: 'Мотобур земляной'
-
id: 23228
value: 'Удлинитель шнека для мотобура'
-
id: 23229
value: 'Шнек к мотобуру'
items:
type: object
properties:
id:
type: integer
example: 149
is_required:
type: boolean
example: true
is_variant:
type: boolean
example: false
name:
type: string
example: Тип
property:
type: object
properties:
name:
type: string
example: Тип
type:
type: object
properties:
id:
type: integer
example: 3
name:
type: string
example: list
title:
type: string
example: Список
values:
type: array
example:
-
id: 23227
value: 'Мотобур земляной'
-
id: 23228
value: 'Удлинитель шнека для мотобура'
-
id: 23229
value: 'Шнек к мотобуру'
items:
type: object
properties:
id:
type: integer
example: 23227
value:
type: string
example: 'Мотобур земляной'
meta:
type: object
properties:
total:
type: integer
example: 17
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с товарами'
parameters:
-
in: path
name: category_id
description: 'ID выбранной категории. Обязательный параметр.'
example: 2
required: true
schema:
type: integer
/open/api/v1/configurator/countries:
get:
summary: 'Получение списка стран'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 133
name: Австралия
meta:
total: 17
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 133
name: Австралия
items:
type: object
properties:
id:
type: integer
example: 133
name:
type: string
example: Австралия
meta:
type: object
properties:
total:
type: integer
example: 17
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с товарами'
/open/api/v1/configurator/brands:
get:
summary: 'Получение списка брендов'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 23267
name: Apple
meta:
total: 17
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 23267
name: Apple
items:
type: object
properties:
id:
type: integer
example: 23267
name:
type: string
example: Apple
meta:
type: object
properties:
total:
type: integer
example: 17
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с товарами'
/open/api/v1/configurator/warehouses:
get:
summary: 'Получение списка ОПС'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
name: 'Минск, Логистический центр,оптовый N1'
weekdays: []
meta:
total: 17
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 1
name: 'Минск, Логистический центр,оптовый N1'
weekdays: []
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'Минск, Логистический центр,оптовый N1'
weekdays:
type: array
example: []
meta:
type: object
properties:
total:
type: integer
example: 17
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с товарами'
'/open/api/v1/products/by/{status}':
get:
summary: 'Получение списка товаров в разрезе статусов'
operationId: ''
description: ''
parameters:
-
in: query
name: ids
description: 'ID продуктов (товаров)'
example: '1,2,56'
required: false
schema:
type: string
description: 'ID продуктов (товаров)'
example: '1,2,56'
nullable: false
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
status: 'На проверке'
-
id: 2
status: 'На проверке'
-
id: 3
status: 'В продаже'
-
id: 4
status: 'На проверке'
-
id: 5
status: 'В продаже'
-
id: 6
status: 'В продаже'
-
id: 7
status: 'В продаже'
-
id: 8
status: 'В продаже'
-
id: 9
status: 'В продаже'
-
id: 10
status: 'В продаже'
-
id: 11
status: 'В продаже'
-
id: 12
status: 'В продаже'
-
id: 13
status: 'В продаже'
-
id: 14
status: 'В продаже'
-
id: 15
status: 'В продаже'
meta:
total: 16
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 1
status: 'На проверке'
-
id: 2
status: 'На проверке'
-
id: 3
status: 'В продаже'
-
id: 4
status: 'На проверке'
-
id: 5
status: 'В продаже'
-
id: 6
status: 'В продаже'
-
id: 7
status: 'В продаже'
-
id: 8
status: 'В продаже'
-
id: 9
status: 'В продаже'
-
id: 10
status: 'В продаже'
-
id: 11
status: 'В продаже'
-
id: 12
status: 'В продаже'
-
id: 13
status: 'В продаже'
-
id: 14
status: 'В продаже'
-
id: 15
status: 'В продаже'
items:
type: object
properties:
id:
type: integer
example: 1
status:
type: string
example: 'На проверке'
meta:
type: object
properties:
total:
type: integer
example: 16
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с товарами'
parameters:
-
in: path
name: status
description: 'Optional parameter. Status продуктов (товаров)'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: on_sale
/open/api/v1/products/bunch:
post:
summary: 'Объединение товаров (создание)'
operationId: ''
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
success: true
properties:
data:
type: object
properties:
success:
type: boolean
example: true
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с товарами'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: 'int Ids товаров'
example: null
items:
type: string
patch:
summary: 'Объединение товаров (обновление)'
operationId: ''
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
success:
- 1
- 2
- 10
- 14
properties:
data:
type: object
properties:
success:
type: array
example:
- 1
- 2
- 10
- 14
items:
type: integer
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с товарами'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: 'int Ids товаров'
example: null
items:
type: string
bunch_id:
type: integer
description: 'Id объединения'
example: null
nullable: false
delete:
summary: 'Объединение товаров (удаление)'
operationId: ''
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
success:
- 1
- 2
- 10
- 14
properties:
data:
type: object
properties:
success:
type: array
example:
- 1
- 2
- 10
- 14
items:
type: integer
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с товарами'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: 'int Ids товаров'
example: null
items:
type: string
bunch_id:
type: integer
description: 'Id объединения'
example: null
nullable: false
/open/api/v1/change/products/price:
patch:
summary: 'Редактирование цены товаров'
operationId: ''
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
product_ids:
- 1
- 2
- 3
properties:
success:
type: boolean
example: true
data:
type: object
properties:
product_ids:
type: array
example:
- 1
- 2
- 3
items:
type: integer
400:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка валидации'
errors:
'<массив_продуктов>.<индекс_в_массиве>':
'<поле>':
- '<описание_ошибки>'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка валидации'
errors:
type: object
properties:
'<массив_продуктов>.<индекс_в_массиве>':
type: object
properties:
'<поле>':
type: array
example:
- '<описание_ошибки>'
items:
type: string
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с ценами и остатками'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
products:
type: array
description: 'Массив ID обновляемыx продуктов (товаров).'
example: null
items:
type: object
properties:
id:
type: integer
description: 'ID продукта (товара).'
example: 1
nullable: false
old_price:
type: integer
description: 'Изначальная цена продукта (товара). Указывается в копейках'
example: 10000
nullable: false
price:
type: integer
description: 'Текущая (новая) цена продукта (товара). Примечание: значение свойства price не должно быть больше значения свойства old_price. Указывается в копейках'
example: 9000
nullable: false
required:
- id
- old_price
- price
required:
- products
/open/api/v1/change/products/stock:
patch:
summary: 'Редактирование остатка товаров'
operationId: ''
description: "\n Примечание: обновление можно производить, используя как id, так и barcode\n
"
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
products:
-
id: 9000745
warehouse_stock: 7
available_stock: 3
reserved: 4
properties:
success:
type: boolean
example: true
data:
type: object
properties:
products:
type: array
example:
-
id: 9000745
warehouse_stock: 7
available_stock: 3
reserved: 4
items:
type: object
properties:
id:
type: integer
example: 9000745
warehouse_stock:
type: integer
example: 7
available_stock:
type: integer
example: 3
reserved:
type: integer
example: 4
400:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка валидации'
errors:
'<массив_продуктов>.<индекс_в_массиве>':
'<поле>':
- '<описание_ошибки>'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка валидации'
errors:
type: object
properties:
'<массив_продуктов>.<индекс_в_массиве>':
type: object
properties:
'<поле>':
type: array
example:
- '<описание_ошибки>'
items:
type: string
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
404:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Указанная <имя_модели> не найдена'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Указанная <имя_модели> не найдена'
tags:
- 'Работа с ценами и остатками'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
products:
type: array
description: 'Массив ID обновляемыx продуктов (товаров).'
example: null
items:
type: object
properties:
id:
type: integer
description: 'ID продукта (товара).'
example: 1
nullable: false
barcode:
type: integer
description: 'Штрих-код продукта (товара).'
example: 4811881000258
nullable: false
stock:
type: integer
description: 'Актуальное количество продукта (товара) на складе.'
example: 2
nullable: false
required:
- barcode
- stock
required:
- products
/open/api/v1/products/short/info:
get:
summary: 'Получение информации о товарах с ценами и остатками'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
-
in: query
name: ids
description: 'ID продуктов (товаров) для вывода.'
example: '1,7,289'
required: false
schema:
type: string
description: 'ID продуктов (товаров) для вывода.'
example: '1,7,289'
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
title: 'Apple iPhone 15 Pro Max'
article: '1234567867'
barcode: '123456789'
product_stock: 100
product_price:
price: 9999
red_price: 8999
old_price: 10999
meta:
total: 17
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 1
title: 'Apple iPhone 15 Pro Max'
article: '1234567867'
barcode: '123456789'
product_stock: 100
product_price:
price: 9999
red_price: 8999
old_price: 10999
items:
type: object
properties:
id:
type: integer
example: 1
title:
type: string
example: 'Apple iPhone 15 Pro Max'
article:
type: string
example: '1234567867'
barcode:
type: string
example: '123456789'
product_stock:
type: integer
example: 100
product_price:
type: object
properties:
price:
type: integer
example: 9999
red_price:
type: integer
example: 8999
old_price:
type: integer
example: 10999
meta:
type: object
properties:
total:
type: integer
example: 17
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с ценами и остатками'
'/open/api/v1/products/short/info/{product_id}':
get:
summary: 'Получение информации о товаре с ценами и остатками'
operationId: ''
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
id: 1
title: 'Apple iPhone 15 Pro Max'
article: '1234567867'
barcode: '123456789'
product_stock: 100
product_price:
price: 9999
red_price: 8999
old_price: 10999
properties:
id:
type: integer
example: 1
title:
type: string
example: 'Apple iPhone 15 Pro Max'
article:
type: string
example: '1234567867'
barcode:
type: string
example: '123456789'
product_stock:
type: integer
example: 100
product_price:
type: object
properties:
price:
type: integer
example: 9999
red_price:
type: integer
example: 8999
old_price:
type: integer
example: 10999
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
404:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Указанная <имя_модели> не найдена'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Указанная <имя_модели> не найдена'
tags:
- 'Работа с ценами и остатками'
parameters:
-
in: path
name: product_id
description: 'ID продукта (товара) для вывода'
example: 126
required: true
schema:
type: integer
/open/api/v1/new/orders/products:
get:
summary: 'Получение информации по продуктам в новом заказе'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 10001031
boxes:
-
id: 20000458
item_price: 1002
delivery_date: '2024-07-02T11:00:00.000000Z'
items:
-
id: 2822
offer:
id: 9000300
name: 'Дубль Вазы 1 опять '
description: '1'
inner_article: null
measure:
measure: шт
measure_value: null
net_measure: null
division: 1
images: []
price: 1002
total_price: 1002
quantity: 1
-
id: 20000459
item_price: 25.99
delivery_date: '2024-07-02T11:00:00.000000Z'
items:
-
id: 2823
offer:
id: 977371
name: 'Корм для кошек «Purina One» с лососем и пшеницей, 1.5 кг'
description: 'Корм Purina ONE® разработан специально для стерилизованных кошек и кастрированных котов. Он содержит оптимальный уровень белка и жира для поддержания мышечной массы тела и здорового обмена веществ. Благодаря балансу минеральных веществ мочевыделительная система кошки остается здоровой.'
inner_article: '977371'
measure:
measure: шт
measure_value: null
net_measure: кг
division: 1
images: []
price: 25.99
total_price: 25.99
quantity: 1
time_start: '2024-07-02 14:00:00'
time_end: '2024-07-03 00:06:45'
meta:
total: 25
count: 25
per_page: 50
current_page: 1
total_pages: 1
properties:
data:
type: array
example:
-
id: 10001031
boxes:
-
id: 20000458
item_price: 1002
delivery_date: '2024-07-02T11:00:00.000000Z'
items:
-
id: 2822
offer:
id: 9000300
name: 'Дубль Вазы 1 опять '
description: '1'
inner_article: null
measure:
measure: шт
measure_value: null
net_measure: null
division: 1
images: []
price: 1002
total_price: 1002
quantity: 1
-
id: 20000459
item_price: 25.99
delivery_date: '2024-07-02T11:00:00.000000Z'
items:
-
id: 2823
offer:
id: 977371
name: 'Корм для кошек «Purina One» с лососем и пшеницей, 1.5 кг'
description: 'Корм Purina ONE® разработан специально для стерилизованных кошек и кастрированных котов. Он содержит оптимальный уровень белка и жира для поддержания мышечной массы тела и здорового обмена веществ. Благодаря балансу минеральных веществ мочевыделительная система кошки остается здоровой.'
inner_article: '977371'
measure:
measure: шт
measure_value: null
net_measure: кг
division: 1
images: []
price: 25.99
total_price: 25.99
quantity: 1
time_start: '2024-07-02 14:00:00'
time_end: '2024-07-03 00:06:45'
items:
type: object
properties:
id:
type: integer
example: 10001031
boxes:
type: array
example:
-
id: 20000458
item_price: 1002
delivery_date: '2024-07-02T11:00:00.000000Z'
items:
-
id: 2822
offer:
id: 9000300
name: 'Дубль Вазы 1 опять '
description: '1'
inner_article: null
measure:
measure: шт
measure_value: null
net_measure: null
division: 1
images: []
price: 1002
total_price: 1002
quantity: 1
-
id: 20000459
item_price: 25.99
delivery_date: '2024-07-02T11:00:00.000000Z'
items:
-
id: 2823
offer:
id: 977371
name: 'Корм для кошек «Purina One» с лососем и пшеницей, 1.5 кг'
description: 'Корм Purina ONE® разработан специально для стерилизованных кошек и кастрированных котов. Он содержит оптимальный уровень белка и жира для поддержания мышечной массы тела и здорового обмена веществ. Благодаря балансу минеральных веществ мочевыделительная система кошки остается здоровой.'
inner_article: '977371'
measure:
measure: шт
measure_value: null
net_measure: кг
division: 1
images: []
price: 25.99
total_price: 25.99
quantity: 1
items:
type: object
properties:
id:
type: integer
example: 20000458
item_price:
type: integer
example: 1002
delivery_date:
type: string
example: '2024-07-02T11:00:00.000000Z'
items:
type: array
example:
-
id: 2822
offer:
id: 9000300
name: 'Дубль Вазы 1 опять '
description: '1'
inner_article: null
measure: { measure: шт, measure_value: null, net_measure: null, division: 1 }
images: []
price: 1002
total_price: 1002
quantity: 1
items:
type: object
properties:
id:
type: integer
example: 2822
offer:
type: object
properties: { id: { type: integer, example: 9000300 }, name: { type: string, example: 'Дубль Вазы 1 опять ' }, description: { type: string, example: '1' }, inner_article: { type: string, example: null }, measure: { type: object, properties: { measure: { type: string, example: шт }, measure_value: { type: string, example: null }, net_measure: { type: string, example: null }, division: { type: integer, example: 1 } } }, images: { type: array, example: [] } }
price:
type: integer
example: 1002
total_price:
type: integer
example: 1002
quantity:
type: integer
example: 1
time_start:
type: string
example: '2024-07-02 14:00:00'
time_end:
type: string
example: '2024-07-03 00:06:45'
meta:
type: object
properties:
total:
type: integer
example: 25
count:
type: integer
example: 25
per_page:
type: integer
example: 50
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 1
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с заказами'
'/open/api/v1/orders/{status}':
get:
summary: 'Получение информации по заказам в разрезе статуса'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 123
status: Отменен
total_price: 100
item_price: 50
delivery_price: 15
created_at: '2024-06-21 16:18:21'
recipient:
id: 123
delivery_type: ops
full_address_name: 'г. Минск, ул. Брикета, 30'
surname: Иванов
name: Иван
comment: 'Все хорошо'
boxes:
-
id: 10000744
item_price: 12.15
delivery_date: '2024-06-04T16:00:00.000000Z'
postal_number: BY290SLALKS23
items:
-
id: 1775
offer:
id: 578995
name: 'Кофе молотый «Жокей» по-восточному, 450 г'
description: 'Натуральный жареный, молотый.'
inner_article: '578995'
measure:
measure: шт
measure_value: null
net_measure: г
division: 1
images:
- 'https://example.com/image.png'
price: 12.15
total_price: 12.15
quantity: 1
time_start: '2024-06-04 19:00:00'
time_end: '2024-06-06 23:50:00'
meta:
total: 17
count: 15
per_page: 15
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 123
status: Отменен
total_price: 100
item_price: 50
delivery_price: 15
created_at: '2024-06-21 16:18:21'
recipient:
id: 123
delivery_type: ops
full_address_name: 'г. Минск, ул. Брикета, 30'
surname: Иванов
name: Иван
comment: 'Все хорошо'
boxes:
-
id: 10000744
item_price: 12.15
delivery_date: '2024-06-04T16:00:00.000000Z'
postal_number: BY290SLALKS23
items:
-
id: 1775
offer:
id: 578995
name: 'Кофе молотый «Жокей» по-восточному, 450 г'
description: 'Натуральный жареный, молотый.'
inner_article: '578995'
measure:
measure: шт
measure_value: null
net_measure: г
division: 1
images:
- 'https://example.com/image.png'
price: 12.15
total_price: 12.15
quantity: 1
time_start: '2024-06-04 19:00:00'
time_end: '2024-06-06 23:50:00'
items:
type: object
properties:
id:
type: integer
example: 123
status:
type: string
example: Отменен
total_price:
type: integer
example: 100
item_price:
type: integer
example: 50
delivery_price:
type: integer
example: 15
created_at:
type: string
example: '2024-06-21 16:18:21'
recipient:
type: object
properties:
id:
type: integer
example: 123
delivery_type:
type: string
example: ops
full_address_name:
type: string
example: 'г. Минск, ул. Брикета, 30'
surname:
type: string
example: Иванов
name:
type: string
example: Иван
comment:
type: string
example: 'Все хорошо'
boxes:
type: array
example:
-
id: 10000744
item_price: 12.15
delivery_date: '2024-06-04T16:00:00.000000Z'
postal_number: BY290SLALKS23
items:
-
id: 1775
offer:
id: 578995
name: 'Кофе молотый «Жокей» по-восточному, 450 г'
description: 'Натуральный жареный, молотый.'
inner_article: '578995'
measure:
measure: шт
measure_value: null
net_measure: г
division: 1
images:
- 'https://example.com/image.png'
price: 12.15
total_price: 12.15
quantity: 1
items:
type: object
properties:
id:
type: integer
example: 10000744
item_price:
type: number
example: 12.15
delivery_date:
type: string
example: '2024-06-04T16:00:00.000000Z'
postal_number:
type: string
example: BY290SLALKS23
items:
type: array
example:
-
id: 1775
offer:
id: 578995
name: 'Кофе молотый «Жокей» по-восточному, 450 г'
description: 'Натуральный жареный, молотый.'
inner_article: '578995'
measure: { measure: шт, measure_value: null, net_measure: г, division: 1 }
images: ['https://example.com/image.png']
price: 12.15
total_price: 12.15
quantity: 1
items:
type: object
properties:
id:
type: integer
example: 1775
offer:
type: object
properties: { id: { type: integer, example: 578995 }, name: { type: string, example: 'Кофе молотый «Жокей» по-восточному, 450 г' }, description: { type: string, example: 'Натуральный жареный, молотый.' }, inner_article: { type: string, example: '578995' }, measure: { type: object, properties: { measure: { type: string, example: шт }, measure_value: { type: string, example: null }, net_measure: { type: string, example: г }, division: { type: integer, example: 1 } } }, images: { type: array, example: ['https://example.com/image.png'], items: { type: string } } }
price:
type: number
example: 12.15
total_price:
type: number
example: 12.15
quantity:
type: integer
example: 1
time_start:
type: string
example: '2024-06-04 19:00:00'
time_end:
type: string
example: '2024-06-06 23:50:00'
meta:
type: object
properties:
total:
type: integer
example: 17
count:
type: integer
example: 15
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с заказами'
parameters:
-
in: path
name: status
description: 'Искомый статус. Обязательный параметр.'
example: in_payment
required: true
schema:
type: string
'/open/api/v1/orders/{orderId}/postal-numbers':
get:
summary: 'Получение почтовых номеров заказа'
operationId: ''
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
- BY080035497881
- BY080035497882
- BY080035497883
- BY080035497885
properties:
data:
type: array
example:
- BY080035497881
- BY080035497882
- BY080035497883
- BY080035497885
items:
type: string
400:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка валидации'
errors:
'<массив_продуктов>.<индекс_в_массиве>':
'<поле>':
- '<описание_ошибки>'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка валидации'
errors:
type: object
properties:
'<массив_продуктов>.<индекс_в_массиве>':
type: object
properties:
'<поле>':
type: array
example:
- '<описание_ошибки>'
items:
type: string
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с заказами'
parameters:
-
in: path
name: orderId
description: 'Уникальный ID заказа, для возврата трек-номеров коробок.'
example: 10000001
required: true
schema:
type: integer
'/open/api/v1/orders/label/{box}':
get:
summary: 'Получение адресных ярлыков для коробок'
operationId: ''
description: ''
parameters:
-
in: query
name: label_type
description: 'Параметр для получения разных типов ярлыков. Доступные типы label или thermal-label'
example: modi
required: false
schema:
type: string
description: 'Параметр для получения разных типов ярлыков. Доступные типы label или thermal-label'
example: modi
nullable: false
responses:
200:
description: boxId_label.pdf
content:
application/octet-stream:
schema:
type: string
format: binary
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с заказами'
parameters:
-
in: path
name: box
description: 'ID Коробки для получения ярлыка. Обязательный параметр.'
example: 18
required: true
schema:
type: integer
/open/api/v1/orders/status/change:
patch:
summary: 'Изменение статуса заказа'
operationId: ''
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
product_ids:
- 10000137
properties:
success:
type: boolean
example: true
data:
type: object
properties:
product_ids:
type: array
example:
- 10000137
items:
type: integer
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с заказами'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
orders:
type: array
description: 'Массив изменяемых заказов'
example: null
items:
type: object
properties:
id:
type: integer
description: 'id заказа'
example: 1
nullable: false
status:
type: string
description: 'Статус заказа'
example: cancelled_seller
nullable: false
enum:
- in_delivery
- cancelled_seller
required:
- id
- status
required:
- orders
'/open/api/v1/boxes/{status}':
get:
summary: 'Получение информации по коробкам'
operationId: ''
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
item_price: 29.78
postal_number: BY290SLALKS23
status: cancelled
delivery_date: '2024-03-07T07:00:00.000000Z'
items:
-
id: 707
offer:
id: 977371
name: 'Корм для кошек «Purina One» с лососем и пшеницей, 1.5 кг'
description: 'Корм Purina ONE® разработан специально для стерилизованных кошек и кастрированных котов. Он содержит оптимальный уровень белка и жира для поддержания мышечной массы тела и здорового обмена веществ. Благодаря балансу минеральных веществ мочевыделительная система кошки остается здоровой.'
inner_article: '977371'
measure:
measure: шт
measure_value: null
net_measure: кг
division: 1
images: []
price: 25.99
total_price: 25.99
quantity: 1
-
id: 708
offer:
id: 1274488
name: 'Носки женские «Yellow Frog» 202108-6, размер 23-25'
description: ''
inner_article: '1274488'
measure:
measure: шт
measure_value: null
net_measure: г
division: 1
images: []
price: 3.79
total_price: 3.79
quantity: 1
meta:
total: 54
count: 50
per_page: 50
current_page: 1
total_pages: 2
properties:
data:
type: array
example:
-
id: 1
item_price: 29.78
postal_number: BY290SLALKS23
status: cancelled
delivery_date: '2024-03-07T07:00:00.000000Z'
items:
-
id: 707
offer:
id: 977371
name: 'Корм для кошек «Purina One» с лососем и пшеницей, 1.5 кг'
description: 'Корм Purina ONE® разработан специально для стерилизованных кошек и кастрированных котов. Он содержит оптимальный уровень белка и жира для поддержания мышечной массы тела и здорового обмена веществ. Благодаря балансу минеральных веществ мочевыделительная система кошки остается здоровой.'
inner_article: '977371'
measure:
measure: шт
measure_value: null
net_measure: кг
division: 1
images: []
price: 25.99
total_price: 25.99
quantity: 1
-
id: 708
offer:
id: 1274488
name: 'Носки женские «Yellow Frog» 202108-6, размер 23-25'
description: ''
inner_article: '1274488'
measure:
measure: шт
measure_value: null
net_measure: г
division: 1
images: []
price: 3.79
total_price: 3.79
quantity: 1
items:
type: object
properties:
id:
type: integer
example: 1
item_price:
type: number
example: 29.78
postal_number:
type: string
example: BY290SLALKS23
status:
type: string
example: cancelled
delivery_date:
type: string
example: '2024-03-07T07:00:00.000000Z'
items:
type: array
example:
-
id: 707
offer:
id: 977371
name: 'Корм для кошек «Purina One» с лососем и пшеницей, 1.5 кг'
description: 'Корм Purina ONE® разработан специально для стерилизованных кошек и кастрированных котов. Он содержит оптимальный уровень белка и жира для поддержания мышечной массы тела и здорового обмена веществ. Благодаря балансу минеральных веществ мочевыделительная система кошки остается здоровой.'
inner_article: '977371'
measure:
measure: шт
measure_value: null
net_measure: кг
division: 1
images: []
price: 25.99
total_price: 25.99
quantity: 1
-
id: 708
offer:
id: 1274488
name: 'Носки женские «Yellow Frog» 202108-6, размер 23-25'
description: ''
inner_article: '1274488'
measure:
measure: шт
measure_value: null
net_measure: г
division: 1
images: []
price: 3.79
total_price: 3.79
quantity: 1
items:
type: object
properties:
id:
type: integer
example: 707
offer:
type: object
properties:
id:
type: integer
example: 977371
name:
type: string
example: 'Корм для кошек «Purina One» с лососем и пшеницей, 1.5 кг'
description:
type: string
example: 'Корм Purina ONE® разработан специально для стерилизованных кошек и кастрированных котов. Он содержит оптимальный уровень белка и жира для поддержания мышечной массы тела и здорового обмена веществ. Благодаря балансу минеральных веществ мочевыделительная система кошки остается здоровой.'
inner_article:
type: string
example: '977371'
measure:
type: object
properties:
measure: { type: string, example: шт }
measure_value: { type: string, example: null }
net_measure: { type: string, example: кг }
division: { type: integer, example: 1 }
images:
type: array
example: []
price:
type: number
example: 25.99
total_price:
type: number
example: 25.99
quantity:
type: integer
example: 1
meta:
type: object
properties:
total:
type: integer
example: 54
count:
type: integer
example: 50
per_page:
type: integer
example: 50
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 2
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с заказами'
parameters:
-
in: path
name: status
description: 'Искомый статус. Обязательный параметр.'
example: on_post
required: true
schema:
type: string
/open/api/v1/analytic/sku:
get:
summary: 'Получение активных SKU'
operationId: SKU
description: ''
parameters:
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
-
in: query
name: date_begin
description: 'date Дата начала. Обязательный параметр.'
example: '2024-06-13'
required: true
schema:
type: string
description: 'date Дата начала. Обязательный параметр.'
example: '2024-06-13'
nullable: false
-
in: query
name: date_end
description: 'date Дата окончания. Обязательный параметр.'
example: '2024-08-10'
required: true
schema:
type: string
description: 'date Дата окончания. Обязательный параметр.'
example: '2024-08-10'
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
barcode: '54491069'
inner_article: '12084'
name: 'Напиток газированный «Sprite», 500 мл'
category_name: 'Напитки газированные'
quantity: 1
meta:
total: 10
count: 10
per_page: 50
current_page: 1
total_pages: 1
properties:
data:
type: array
example:
-
barcode: '54491069'
inner_article: '12084'
name: 'Напиток газированный «Sprite», 500 мл'
category_name: 'Напитки газированные'
quantity: 1
items:
type: object
properties:
barcode:
type: string
example: '54491069'
inner_article:
type: string
example: '12084'
name:
type: string
example: 'Напиток газированный «Sprite», 500 мл'
category_name:
type: string
example: 'Напитки газированные'
quantity:
type: integer
example: 1
meta:
type: object
properties:
total:
type: integer
example: 10
count:
type: integer
example: 10
per_page:
type: integer
example: 50
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 1
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с аналитикой'
/open/api/v1/analytic/turnover:
get:
summary: 'Получение товараоборота'
operationId: ''
description: ''
parameters:
-
in: query
name: date_begin
description: 'Дата начала (обязательный параметр).'
example: '2025-01-01'
required: true
schema:
type: string
description: 'Дата начала (обязательный параметр).'
example: '2025-01-01'
nullable: false
-
in: query
name: date_end
description: 'Дата начала (обязательный параметр).'
example: '2025-01-04'
required: true
schema:
type: string
description: 'Дата начала (обязательный параметр).'
example: '2025-01-04'
nullable: false
-
in: query
name: page
description: 'Номер страницы (необязательный параметр).'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр).'
example: 1
nullable: false
-
in: query
name: perPage
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
required: false
schema:
type: integer
description: 'Номер страницы (необязательный параметр). По умолчанию - 15 позиций на страницу.'
example: 15
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
barcode: '54491069'
inner_article: '12084'
name: 'Напиток газированный «Sprite», 500 мл'
category_name: 'Напитки газированные'
quantity: '1.00'
total_price: '159'
meta:
total: 10
count: 10
per_page: 50
current_page: 1
total_pages: 1
properties:
data:
type: array
example:
-
barcode: '54491069'
inner_article: '12084'
name: 'Напиток газированный «Sprite», 500 мл'
category_name: 'Напитки газированные'
quantity: '1.00'
total_price: '159'
items:
type: object
properties:
barcode:
type: string
example: '54491069'
inner_article:
type: string
example: '12084'
name:
type: string
example: 'Напиток газированный «Sprite», 500 мл'
category_name:
type: string
example: 'Напитки газированные'
quantity:
type: string
example: '1.00'
total_price:
type: string
example: '159'
meta:
type: object
properties:
total:
type: integer
example: 10
count:
type: integer
example: 10
per_page:
type: integer
example: 50
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 1
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с аналитикой'
/open/api/v1/analytic/price-history:
get:
summary: 'Получение информации по истории цен'
operationId: ''
description: ''
parameters:
-
in: query
name: product_id
description: 'integer ID продукта (товаров).'
example: null
required: true
schema:
type: string
description: 'integer ID продукта (товаров).'
example: null
nullable: false
-
in: query
name: year
description: 'integer Год сбора истории.'
example: null
required: true
schema:
type: string
description: 'integer Год сбора истории.'
example: null
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
July:
prices:
-
price: 153
date: '2024-07-29'
-
price: 243
date: '2024-07-30'
average: 198
August:
prices:
-
price: 2212
date: '2024-08-30'
average: 2212
properties:
success:
type: boolean
example: true
data:
type: object
properties:
July:
type: object
properties:
prices:
type: array
example:
-
price: 153
date: '2024-07-29'
-
price: 243
date: '2024-07-30'
items:
type: object
properties:
price:
type: integer
example: 153
date:
type: string
example: '2024-07-29'
average:
type: integer
example: 198
August:
type: object
properties:
prices:
type: array
example:
-
price: 2212
date: '2024-08-30'
items:
type: object
properties:
price:
type: integer
example: 2212
date:
type: string
example: '2024-08-30'
average:
type: integer
example: 2212
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- 'Работа с аналитикой'
/open/api/v1/seller/profile/finances:
get:
summary: 'Получение информации по финансам'
operationId: ''
description: ''
parameters:
-
in: query
name: reporting_period_month
description: 'Месяц финансового периода'
example: april
required: false
schema:
type: string
description: 'Месяц финансового периода'
example: april
nullable: false
-
in: query
name: reporting_period_year
description: 'Год финансового периода'
example: '2025'
required: false
schema:
type: string
description: 'Год финансового периода'
example: '2025'
nullable: false
-
in: query
name: reporting_document
description: 'Alias необходимого документа DetailingOfServicesProvidedForDomainRegistration -> Детализация (расшифровка) оказанных услуг по регистрации доменного имени, DetailingOfServicesProvided -> Детализация (расшифровка) оказанных услуг'
example: null
required: false
schema:
type: string
description: 'Alias необходимого документа DetailingOfServicesProvidedForDomainRegistration -> Детализация (расшифровка) оказанных услуг по регистрации доменного имени, DetailingOfServicesProvided -> Детализация (расшифровка) оказанных услуг'
example: null
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
link: 'https://api-sandbox.emal.by/<ссылка_на_файл>.xlsx'
properties:
success:
type: boolean
example: true
data:
type: object
properties:
link:
type: string
example: 'https://api-sandbox.emal.by/<ссылка_на_файл>.xlsx'
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
404:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Указанная <имя_модели> не найдена'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Указанная <имя_модели> не найдена'
tags:
- 'Работа с кабинетом'
/open/api/v1/templates/product:
get:
summary: 'Получение шаблона товара'
operationId: ''
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
items:
-
is_bunched: 'Указатель на создание нескольких вариаций товара'
products:
-
barcode: 'Штрих-код, уникальное значение состоящее из 8 или 13 цифр'
brand_id: 'ID бренд, получение из справочника брендов'
category_id: 'ID категории, получение из справочника категорий'
country_id: 'ID страна, получение из справочника стран'
description: 'Описание товара'
dimensions:
length: Длина
height: Высота
width: Ширина
weight: Вес
images:
- 'URL картинки'
importer_name: 'Название импортера'
inner_article: 'Внешний артикул'
is_adult: 'Признак товара 18+'
manufacturer_name: Производитель
name: 'Название товара'
prices:
price: Цена
old_price: 'Старая цена'
properties:
'': '<значение свойства в соответствии с ответом от https://api-sandbox.emall.by/open/api/v1/configurator/categories/{category_id}/properties>'
service_centres: 'Наименование сервисного центра'
stock: 'Остаток товара'
vat: НДС
warranty_unit: 'Измерение срока гарантии, одно из 3-х значений: years, months, days'
warranty_value: 'Срок гарантии'
kit: 'Количество товаров в наборе'
composition: 'Состав продукта'
properties:
items:
type: array
example:
-
is_bunched: 'Указатель на создание нескольких вариаций товара'
products:
-
barcode: 'Штрих-код, уникальное значение состоящее из 8 или 13 цифр'
brand_id: 'ID бренд, получение из справочника брендов'
category_id: 'ID категории, получение из справочника категорий'
country_id: 'ID страна, получение из справочника стран'
description: 'Описание товара'
dimensions:
length: Длина
height: Высота
width: Ширина
weight: Вес
images:
- 'URL картинки'
importer_name: 'Название импортера'
inner_article: 'Внешний артикул'
is_adult: 'Признак товара 18+'
manufacturer_name: Производитель
name: 'Название товара'
prices:
price: Цена
old_price: 'Старая цена'
properties:
'': '<значение свойства в соответствии с ответом от https://api-sandbox.emall.by/open/api/v1/configurator/categories/{category_id}/properties>'
service_centres: 'Наименование сервисного центра'
stock: 'Остаток товара'
vat: НДС
warranty_unit: 'Измерение срока гарантии, одно из 3-х значений: years, months, days'
warranty_value: 'Срок гарантии'
kit: 'Количество товаров в наборе'
composition: 'Состав продукта'
items:
type: object
properties:
is_bunched:
type: string
example: 'Указатель на создание нескольких вариаций товара'
products:
type: array
example:
-
barcode: 'Штрих-код, уникальное значение состоящее из 8 или 13 цифр'
brand_id: 'ID бренд, получение из справочника брендов'
category_id: 'ID категории, получение из справочника категорий'
country_id: 'ID страна, получение из справочника стран'
description: 'Описание товара'
dimensions:
length: Длина
height: Высота
width: Ширина
weight: Вес
images:
- 'URL картинки'
importer_name: 'Название импортера'
inner_article: 'Внешний артикул'
is_adult: 'Признак товара 18+'
manufacturer_name: Производитель
name: 'Название товара'
prices:
price: Цена
old_price: 'Старая цена'
properties:
'': '<значение свойства в соответствии с ответом от https://api-sandbox.emall.by/open/api/v1/configurator/categories/{category_id}/properties>'
service_centres: 'Наименование сервисного центра'
stock: 'Остаток товара'
vat: НДС
warranty_unit: 'Измерение срока гарантии, одно из 3-х значений: years, months, days'
warranty_value: 'Срок гарантии'
kit: 'Количество товаров в наборе'
composition: 'Состав продукта'
items:
type: object
properties:
barcode:
type: string
example: 'Штрих-код, уникальное значение состоящее из 8 или 13 цифр'
brand_id:
type: string
example: 'ID бренд, получение из справочника брендов'
category_id:
type: string
example: 'ID категории, получение из справочника категорий'
country_id:
type: string
example: 'ID страна, получение из справочника стран'
description:
type: string
example: 'Описание товара'
dimensions:
type: object
properties:
length:
type: string
example: Длина
height:
type: string
example: Высота
width:
type: string
example: Ширина
weight:
type: string
example: Вес
images:
type: array
example:
- 'URL картинки'
items:
type: string
importer_name:
type: string
example: 'Название импортера'
inner_article:
type: string
example: 'Внешний артикул'
is_adult:
type: string
example: 'Признак товара 18+'
manufacturer_name:
type: string
example: Производитель
name:
type: string
example: 'Название товара'
prices:
type: object
properties:
price:
type: string
example: Цена
old_price:
type: string
example: 'Старая цена'
properties:
type: object
properties:
'':
type: string
example: '<значение свойства в соответствии с ответом от https://api-sandbox.emall.by/open/api/v1/configurator/categories/{category_id}/properties>'
service_centres:
type: string
example: 'Наименование сервисного центра'
stock:
type: string
example: 'Остаток товара'
vat:
type: string
example: НДС
warranty_unit:
type: string
example: 'Измерение срока гарантии, одно из 3-х значений: years, months, days'
warranty_value:
type: string
example: 'Срок гарантии'
kit:
type: string
example: 'Количество товаров в наборе'
composition:
type: string
example: 'Состав продукта'
401:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Ошибка авторизации. Проверьте токен'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Ошибка авторизации. Проверьте токен'
403:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'У Вас недостаточно прав на совершение действий, обратитесь к администратору'
tags:
- Шаблоны
tags:
-
name: Справочники
description: ''
-
name: 'Работа с товарами'
description: ''
-
name: 'Работа с ценами и остатками'
description: "\n Для получения информации о товаре с ценами и остатками можно воспользоваться методами\n Получение информации о товарах с ценами и остатками\n или\n Получение информации о товаре с ценами и остатками\n
"
-
name: 'Работа с заказами'
description: ''
-
name: 'Работа с аналитикой'
description: ''
-
name: 'Работа с кабинетом'
description: ''
-
name: Шаблоны
description: ''
components:
securitySchemes:
default:
type: http
scheme: bearer
description: 'You can retrieve your token by visiting your dashboard and clicking Generate API token.'
security:
-
default: []