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

Получить вариацию

GET /v1/catalog-offers/:id

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

Ответ содержит больше полей, чем список: кроме сокращённого набора приходят символьный код, габариты, тексты, картинки и свойства каталога вида propertyNNN.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор вариации. Список: GET /v1/catalog-offers

Примеры

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

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

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

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

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

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

const { success, data } = await res.json()
console.log('Вариация:', data.name, 'головной товар:', data.parentId?.value)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект вариации. Все поля — см. Поля вариации

Сверх полей, которые возвращает список, одна запись содержит:

  • code — символьный код
  • xmlId — внешний код
  • sort — порядок сортировки
  • vatId — ID ставки НДС. Список: GET /v1/catalog-vat-rates
  • width, height, length — габариты
  • previewText, detailText, previewTextType, detailTextType — тексты и их формат
  • previewPicture, detailPicture — картинки
  • quantityReserved — зарезервированный остаток
  • recurSchemeLength, recurSchemeType, trialPriceId — параметры продажи контента в коробочной версии Битрикс24
  • свойства каталога вида propertyNNN, где NNN — id свойства из GET /v1/catalog-product-properties. Пустое свойство приходит как null, заполненное множественное — массивом объектов { value, valueId }

Поля с пустым значением приходят как null.

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

Показаны основные поля.

JSON 
{
  "success": true,
  "data": {
    "id": 7191,
    "iblockId": 27,
    "iblockSectionId": null,
    "name": "Футболка базовая, размер M",
    "parentId": { "value": "7189", "valueId": "3895" },
    "type": 4,
    "active": true,
    "available": true,
    "code": null,
    "xmlId": "7191",
    "sort": 500,
    "measure": 9,
    "vatId": null,
    "vatIncluded": false,
    "purchasingPrice": 450,
    "purchasingCurrency": "RUB",
    "quantity": null,
    "quantityReserved": null,
    "quantityTrace": true,
    "canBuyZero": true,
    "weight": null,
    "width": null,
    "height": null,
    "length": null,
    "previewText": null,
    "previewTextType": "text",
    "detailPicture": null,
    "property907": null,
    "property909": null,
    "createdBy": 1295,
    "dateCreate": "2026-10-08T18:41:55.000Z",
    "timestampX": "2026-10-08T18:41:55.000Z"
  }
}

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

404 — вариации с таким id нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "offer does not exist."
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Записи с указанным id нет (offer does not exist.)
404 ENTITY_NOT_FOUND Запись с указанным id есть, но это не вариация — например, обычный или головной товар (catalogOffer <id> not found)
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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

Свободная вариация. Вариация, созданная без головного товара, приходит с parentId: null и type: 5. У вариации, привязанной к головному товару, type равен 4, а ID головного товара лежит в parentId.value строкой.

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