Категории товаров

Как получить список категорий

Получить список категорий можно с помощью GET запроса к API /categories.

Get categories list

Перейти к роуту и изучить основные поля

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

Как получить одну категорию

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

Get single category

Перейти к роуту и изучить основные поля

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

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

Метод возвращает объект или массив объектов, в зависимости роута:

{
  "id": "int",
  "name": "string"
}

Как получить список товаров категории

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

Get category products

Перейти к роуту и изучить основные поля

Данный роут требует 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 магазина, к которому привязан продукт

Как получить список категорий с товарами

Данный метод используется для отображания на главном экране и на экране категорий.

Получить список категорий с товарами можно с помощью GET запроса к API /categories/previews.

Get categories previews

Перейти к роуту и изучить основные поля

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

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

Фильтры указываются в GET параметрах. Все фильтры являются не обязательными.

Параметр	Описание	Значение по умолчанию
`category_limit`	Лимит по кол-ву категорий. Не может быть больше 10	4
`category_offset`	Смещение для категорий	0
`product_limit`	Лимит по кол-ву продуктов в каждой категории. Не может быть больше 10	4
`product_offset`	Смещение для продуктов	0

Пример использования:

GET /categories/previews?category_limit=5&category_offset=0&product_limit=3&product_offset=1

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

Метод возвращает массив объектов категорий с продуктами:

[
  {
    "id": 0, // ID категории
    "name": "string", // Название категории
    "products": [ // Массив продуктов
      {
        "id": "string",
        "name": "string",
        "price": 0,
        "main_picture_url": "string",
        "is_active": true,
        "quantity": 0,
        "store_id": 0,
        "detail_desc": "string",
        "question_id": 0,
        "format_price": "string"
      }
    ]
  }
]

Get Started

Экраны и методы

Категории товаров

Как получить список категорий

Get categories list

Как получить одну категорию

Get single category

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

Как получить список товаров категории

Get category products

Как получить список категорий с товарами

Get categories previews

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

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

​Как получить список категорий

Get categories list

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

Get single category

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

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

Get category products

​Как получить список категорий с товарами

Get categories previews

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

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

Как получить список категорий

Как получить одну категорию

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

Как получить список товаров категории

Как получить список категорий с товарами

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

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