#Получить каталог

GET /v1/catalogs/:id

Возвращает один торговый каталог по идентификатору со всеми полями.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да ID каталога

#Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalogs/25" \
  -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/25', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Каталог:', data.name, '— iblockId', data.iblockId)

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

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

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

#Поля ответа

Объект каталога со всеми полями — см. Поля каталога.

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

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
  }
}

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

422 — каталог не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "catalog does not exist."
  }
}

#Ошибки

HTTP Код Описание
422 BITRIX_ERROR Каталога с таким id нет — в сообщении «catalog does not exist.». Тот же ответ возвращается для нечислового id
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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

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

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