К содержимому
Инвойсбокс
get/v3/marketplace/paymentgateway/shop/{alias}/category

Разделы каталога на витрине магазина

Разделы каталога приходят одним списком без токена: у каждого раздела есть число товаров и ссылка на родителя, поэтому дерево собирается на стороне читателя. Метод — часть публичной витрины магазина: ИИ-агенты через MCP-сервер Инвойсбокс показывают по нему покупателю, что продаёт магазин, и сужают поиск параметром categoryId.

  • метод: GET
  • ресурс: /v3/marketplace/paymentgateway/shop/{alias}/category, где {alias} — алиас витрины (поле alias точки продаж)
  • авторизация: не нужна, заголовок Authorization не передаётся
  • тело ответа — список разделов Category в конверте с постраничностью
  • возможные ошибки

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

Параметры запроса

ПараметрПримерСмысл
_queryбизнесПодстрока в названии раздела
_page, _pageSize1, 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

ПолеТипСмысл
idintНомер раздела — его передают в поиск параметром categoryId
externalIdstringКод раздела в учётной системе продавца
titlestring(200)Название
descriptionstring(1000)Описание раздела
parentIdintРодительский раздел; нет поля — раздел верхнего уровня
goodCountintЧисло товаров в разделе
positionintПорядок раздела среди соседей

Читайте также

Страница помогла?
getВозвращает каталог категорий товаров магазина с количеством товаров в каждойДемо
curl -X GET 'https://api.invoicebox.ru/v3/marketplace/paymentgateway/shop/<alias>/category' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0'
Витрина отвечает без токена: выполните запрос по примеру рядом, подставив алиас своего магазина.