Skip to main content

​
Как получить список продуктов

Получить список всех продуктов можно с помощью GET запроса к API /products.

Get products

Перейти к роуту и изучить основные поля
Данный роут требует JWT авторизацию для получения данных.Все ответы возвращаются с сортировкой в зависимости от параметров фильтрации.

​
Основные фильтры

Фильтры указываются в GET параметрах. Все фильтры являются не обязательными.
ПараметрОписаниеЗначение по умолчанию
nameИщет продукты по идентичному названиюnull
name_ilikeИщет продукты по названию БЕЗ учета регистраnull
name_likeИщет продукты по названию С учетом регистраnull
name_neqИщет продукты которые НЕ соответствуют значению С учетом регистра. Т.е. если указать Лампа, метод вернет только те продукты, название которых не равно Лампаnull
price_lteИщет продукты, цена которых Меньше или равна указанной (Less than or equal)null
price_gteИщет продукты, цена которых Больше или равна указанной (Greater than or equal)null
category_idИщет продукты по определенной категорииnull
order_byСортирует список продуктов по одному или нескольким полям. Доступные значения: create_time (дата создания) и name (по названию в алфавитном порядке). Значения передаются через запятуюcreate_time,name
Пример использования: 
GET /products?name__ilike=Кроссовки&price__lte=1000&price__gte=500&category_id=5&order_by=create_time,name

​
Структура ответа

Метод возвращает массив объектов продуктов: 
[
  {
    "id": "string",
    "name": "string",
    "price": "numeric",
    "main_picture_url": "string",
    "is_active": "bool",
    "quantity": "int",
    "store_id": "int",
    "detail_desc": "string",
    "question_id": "int"
  }
]
где: price - цена товара в копейках quantity - кол-во единиц товара (пока что будет всегда 1) question_id - необезательное поле, вернет ID вопроса, привязанного к товару, если есть store_id - ID магазина, к которому привязан продукт

​
Как получить один продукт

Получить один продукт можно с помощью GET запроса к API /products/{id} по ID продукта.

Get single product

Перейти к роуту и изучить основные поля
Данный роут требует JWT авторизацию для получения данных.

​
Структура ответа

Метод возвращает объект продукта: 
{
  "id": "string",
  "name": "string",
  "price": "numeric",
  "main_picture_url": "string",
  "is_active": "bool",
  "quantity": "int",
  "store_id": "int",
  "detail_desc": "string",
  "question_id": "int"
}
где: price - цена товара в копейках quantity - кол-во единиц товара (пока что будет всегда 1) question_id - необезательное поле, вернет ID вопроса, привязанного к товару, если есть store_id - ID магазина, к которому привязан продукт

​
Как создать продукт

Создать продукт можно с помощью POST запроса к API /products.

Create product

Перейти к роуту и изучить основные поля
Данный роут требует JWT авторизацию для получения данных.

​
JSON объект, необходимый для создания

Запрос должен отправляться как multipart/form-data, чтобы можно было отправить изображение в виде файла.
{
  "name": "string",
  "price": 0,
  "main_picture_url": "string",
  "is_active": true, // не обязательно
  "quantity": 1, // не обязательно
  "store_id": 0, // не обязательно
  "detail_desc": "string", // не обязательно
  "question_id": 0 // не обязательно
}
где: main_picture_url - Загруженное пользователем изображение в формате File