#Поля каталога

GET /v1/catalogs/fields

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

#Примеры

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

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

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

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

const { success, data } = await res.json()
console.log('Полей:', Object.keys(data.fields).length)

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

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

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

#Поля ответа

Поле Тип RO Описание
id number да Идентификатор каталога. Совпадает с iblockId
iblockId number да ID информационного блока каталога. По нему фильтруются `GET /v1/catalog-products`, `GET /v1/catalog-sections`, `GET /v1/catalog-prices`
iblockTypeId string да Тип информационного блока, например CRM_PRODUCT_CATALOG
lid string да ID сайта, к которому привязан каталог
name string да Название каталога
productIblockId number да У каталога предложений — iblockId связанного каталога товаров. У базового каталога товаров — null
skuPropertyId number да У каталога предложений — ID свойства связи предложения с товаром. У базового каталога — null
subscription string да Признак каталога подписок: Y или N
vatId number да ID ставки НДС по умолчанию для товаров каталога
yandexExport boolean да Признак выгрузки каталога в Яндекс.Маркет (true / false)

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "iblockId": { "type": "number", "readonly": true },
      "iblockTypeId": { "type": "string", "readonly": true },
      "lid": { "type": "string", "readonly": true },
      "name": { "type": "string", "readonly": true },
      "productIblockId": { "type": "number", "readonly": true },
      "skuPropertyId": { "type": "number", "readonly": true },
      "subscription": { "type": "string", "readonly": true },
      "vatId": { "type": "number", "readonly": true },
      "yandexExport": { "type": "boolean", "readonly": true }
    }
  }
}

Все поля помечены readonly: true — изменить каталог через API нельзя.

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

403 — нет скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'catalog' scope"
  }
}

#Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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