Получение списка категорий продуктов
Метод Get list of product categories используется для получения списка всех категорий продуктов текущего или нижестоящего реселлера.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET {base_url}/api/v3/customer_store/resellers/{reseller_id}/product_categories
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) |
Content-Type | header | string | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json |
Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json |
base_url | path | string | Обязательный | URL ActivePlatform |
reseller_id | path | integer | Обязательный | ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) |
page | query | integer | Опциональный | Параметр постраничной навигации. Номер страницы ответа |
per_page | query | integer | Опциональный | Параметр постраничной навигации |
Модель ответа
Название | Тип данных | Описание | |||||
---|---|---|---|---|---|---|---|
data | array of objects | Данные ответа | |||||
id | string | ID категории продуктов | |||||
type | string | Тип данных | |||||
attributes | object | Информация о категории продуктов | |||||
created_at | string | Дата и время создания категории продуктов | |||||
updated_at | string | Дата и время последнего обновления категории продуктов | |||||
key | string | Ключ категории продуктов | |||||
name | string | Название категории продуктов | |||||
description | string | Описание категории продуктов | |||||
priority | integer | Приоритет категории продуктов | |||||
public | bool | Признак того, отображается ли категория продуктов в Reseller Store (см. Главная страница и Каталог), Витрине Customer Store (см. Страница каталога и Просмотр списка страниц категорий) и доступны ли все связанные с ней опубликованные продукты при заказе подписки в Панели управления Клиента (подробнее см. Создание категории продуктов) | |||||
logo | string | Ссылка на файл логотипа категории продуктов |
Пример запроса
GET /api/v3/customer_store/resellers/1/product_categories
Host: https://test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
Пример ответа
{
"data": [
{
"id": "5",
"type": "product_categories",
"attributes": {
"created_at": "2017-07-11T10:58:21.037+03:00",
"updated_at": "2017-07-13T13:01:24.431+03:00",
"key": "default",
"name": "default",
"description": "",
"priority": 1,
"public": false,
"logo": null
}
},
{
"id": "6",
"type": "product_categories",
"attributes": {
"created_at": "2017-07-11T10:58:35.864+03:00",
"updated_at": "2017-07-13T13:01:33.474+03:00",
"key": "new",
"name": "new",
"description": "000",
"priority": 2,
"public": true,
"logo": null
}
}
]
}