#Список каталогов

GET /v1/catalogs

Возвращает список торговых каталогов портала с поддержкой фильтрации, сортировки и выборки полей.

#Параметры

Параметр Тип По умолч. Описание
limit number 50 Количество записей (до 5000). При limit > 50 ответ автоматически собирается из нескольких страниц Битрикс24
select string — Выборка полей: ?select=id,name. Возвращаются только перечисленные поля
sort string — Поле сортировки. Префикс - — по убыванию: ?sort=-id
filter object — Фильтрация по полям GET /v1/catalogs/fields.
Синтаксис фильтрации. Пример: ?filter[iblockTypeId]=CRM_PRODUCT_CATALOG

#Примеры

#curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalogs" \
  -H "X-Api-Key: YOUR_API_KEY"

#curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalogs" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalogs', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Каталогов: ${meta.total}`)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalogs', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив каталогов (все поля — см. Поля каталога)
meta.total number Общее количество каталогов, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 25,
      "iblockId": 25,
      "iblockTypeId": "CRM_PRODUCT_CATALOG",
      "lid": "s1",
      "name": "Товарный каталог CRM",
      "productIblockId": null,
      "skuPropertyId": null,
      "subscription": "N",
      "vatId": 1,
      "yandexExport": false
    },
    {
      "id": 27,
      "iblockId": 27,
      "iblockTypeId": "CRM_PRODUCT_CATALOG",
      "lid": "s1",
      "name": "Товарный каталог CRM (предложения)",
      "productIblockId": 25,
      "skuPropertyId": 101,
      "subscription": "N",
      "vatId": 1,
      "yandexExport": false
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false
  }
}

#Пример ответа при ошибке

400 — фильтр по несуществующему полю:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'nonExistentField' for entity 'catalogs'. Available: id, iblockId, iblockTypeId, lid, name, productIblockId, skuPropertyId, subscription, vatId, yandexExport"
  }
}

#Ошибки

HTTP Код Описание
400 UNKNOWN_FILTER_FIELD Фильтр по полю, которого нет у каталога. Сообщение содержит список доступных полей
400 UNKNOWN_SORT_FIELD Сортировка по полю, которого нет у каталога
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key

Полный список общих ошибок API — Ошибки.

#Известные особенности

Каталог товаров или каталог предложений. Тип каталога в выдаче видно по полям productIblockId и skuPropertyId: у базового каталога товаров оба null; у каталога предложений они заполнены, причём productIblockId — это iblockId связанного каталога товаров.

Когда использовать search вместо list: для условий по нескольким полям удобнее `POST /v1/catalogs/search` — фильтр передаётся в теле запроса.

#Смотрите также