Разделы каталога на витрине магазина
Разделы каталога приходят одним списком без токена: у каждого раздела есть число товаров и ссылка на
родителя, поэтому дерево собирается на стороне читателя. Метод — часть
публичной витрины магазина: ИИ-агенты через
MCP-сервер Инвойсбокс показывают по нему покупателю, что продаёт магазин, и сужают
поиск параметром categoryId.
- метод:
GET - ресурс:
/v3/marketplace/paymentgateway/shop/{alias}/category, где{alias}— алиас витрины (полеaliasточки продаж) - авторизация: не нужна, заголовок
Authorizationне передаётся - тело ответа — список разделов Category в конверте с постраничностью
- возможные ошибки
В ответе только публичные разделы, в которых есть товары с ценой для покупателя, и их родители.
Параметры запроса
| Параметр | Пример | Смысл |
|---|---|---|
_query | бизнес | Подстрока в названии раздела |
_page, _pageSize | 1, 50 | Номер страницы с 1 и её размер |
Пример запроса и ответа
GET /v3/marketplace/paymentgateway/shop/1694158899/category?_pageSize=50
Host: api.invoicebox.ru
Accept: application/json
User-Agent: MyApp 1.0
Ответ сокращён: показаны поля, по которым строится дерево.
{
"data": [
{
"id": 11,
"externalId": "tariffs",
"title": "Тарифы",
"goodCount": 3,
"position": 1
},
{
"id": 12,
"externalId": "family-business",
"title": "Бизнес-тарифы",
"parentId": 11,
"goodCount": 2,
"position": 1
}
],
"metaData": {
"totalCount": 2,
"page": 1,
"pageSize": 50
}
}
Category
| Поле | Тип | Смысл |
|---|---|---|
id | int | Номер раздела — его передают в поиск параметром categoryId |
externalId | string | Код раздела в учётной системе продавца |
title | string(200) | Название |
description | string(1000) | Описание раздела |
parentId | int | Родительский раздел; нет поля — раздел верхнего уровня |
goodCount | int | Число товаров в разделе |
position | int | Порядок раздела среди соседей |
Читайте также
- Поиск товаров — товары раздела по
categoryId - Витрина магазина — адрес, авторизация и ошибки