Получение списка категорий продуктов

Метод используется для получения одностраничного списка категорий продуктов реселлера (см. ), предназначенных для продажи и удовлетворяющих всем следующим требованиям:

Категория продуктов опубликована.
Эта категория продуктов содержит хотя бы один опубликованный продукт.
Этот продукт содержит хотя бы один опубликованный тарифный план.
Этот тарифный план имеет статус Активный.

Метод возвращает пустой массив, если у реселлера нет подходящих категорий продуктов.

GET {reseller_domain}/internal_api/product_categories

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
filter[name][like]	query	string	Опциональный	Предназначен для фильтрации списка по части названия категории продуктов без учета регистра

Модель ответа

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		string	ID категории продуктов
	type		string	Тип данных
	attributes		object	Информация о категории продуктов (см. )
		key	string	Ключ категории продуктов
		name	string	Название категории продуктов
		priority	integer	Приоритет отображения категории продуктов в каталоге
		logo	string	Ссылка на логотип категории продуктов
meta			object	Дополнительная информация
	server_current_time		string	Текущие дата и время сервера

Пример запроса

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/product_categories' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

Пример ответа

JSON

{
    "data": [
        {
            "id": "5",
            "type": "product_categories",
            "attributes": {
                "key": "microsoft",
                "name": "Microsoft",
                "priority": 2,
                "logo": "https://storage.test.activeplatform.com/public/images/product_category/logo/5/Microsoft.png"
            }
        },
        {
            "id": "9",
            "type": "product_categories",
            "attributes": {
                "key": "google",
                "name": "Google",
                "priority": 1,
                "logo": "https://storage.test.activeplatform.com/public/images/product_category/logo/9/Google.png"
            }
        }
    ],
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}