Skip to main content

Как получить список магазинов

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

Get stores list

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

Как получить один магазин

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

Get single store

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

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

Метод возвращает объект или массив объектов, в зависимости роута:
{
  "id": "int",
  "name": "string",
  "short_desc": "string",
  "detail_desc": "string",
  "web_site": "string",
  "logo_url": "string",
  "address": "string",
  "email": "string",
  "phone_number": "string"
}

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

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

Get store 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 магазина, к которому привязан продукт

Как создать магазин

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

Create store

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

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

Запрос должен отправляться как multipart/form-data, чтобы можно было отправить изображение в виде файла.
{
  "name": "string",
  "short_desc": "string",
  "detail_desc": "string",
  "web_site": "string",
  "logo_url": "string",
  "address": "string",
  "email": "string",
  "phone_number": "string"
}
где: logo_url - Загруженное пользователем изображение в формате File