Для AI-агентов: markdown этой страницы — /docs-content/entities/catalogs/fields.md индекс документации — /llms.txt

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

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()

Поля ответа

data.fields — объект, ключ которого совпадает с именем поля, а значение содержит type (тип поля), readonly (true — поле нельзя передать при создании и обновлении), label (отображаемое название) и description (краткое описание). Значения label/description приходят на русском языке. Заголовками запроса язык не переключается.

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

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "ID", "description": "Уникальный идентификатор торгового каталога." },
      "iblockId": { "type": "number", "readonly": true, "label": "Информационный блок", "description": "ID информационного блока, на котором построен каталог; нужен для /v1/catalog-products и /v1/catalog-sections." },
      "iblockTypeId": { "type": "string", "readonly": true, "label": "Тип информационного блока", "description": "Символьный код типа информационного блока." },
      "lid": { "type": "string", "readonly": true, "label": "Сайт", "description": "Символьный код сайта, которому принадлежит каталог." },
      "name": { "type": "string", "readonly": true, "label": "Название", "description": "Название каталога, отображаемое пользователю." },
      "productIblockId": { "type": "number", "readonly": true, "label": "Инфоблок товаров", "description": "ID информационного блока товаров для каталога с торговыми предложениями." },
      "skuPropertyId": { "type": "number", "readonly": true, "label": "Свойство привязки предложений", "description": "ID свойства, связывающего торговые предложения с родительским товаром." },
      "subscription": { "type": "string", "readonly": true, "label": "Подписка", "description": "Является ли каталог каталогом подписки (Y/N)." },
      "vatId": { "type": "number", "readonly": true, "label": "Ставка НДС", "description": "ID ставки НДС, применяемой к каталогу по умолчанию." },
      "yandexExport": { "type": "boolean", "readonly": true, "label": "Экспорт в Яндекс.Маркет", "description": "Выгружается ли каталог в Яндекс.Маркет." }
    }
  }
}

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

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

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

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

Ошибки

HTTP Код Описание
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа catalog
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After

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

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