Получить значения полей вариации товара v 3.0 catalog.product.offer.get

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: catalog

Кто может выполнять метод: пользователь с правом «Просмотр каталога товаров», «Просмотр товаров каталога» или «Изменение цены продажи товара»

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод catalog.product.offer.get возвращает значения полей вариации по идентификатору.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор вариации.

Идентификатор можно получить методом catalog.product.offer.list или из ответа catalog.product.offer.add

select
array

Массив полей вариации, которые нужно вернуть в ответе.

Доступные поля:

  • id — идентификатор вариации
  • iblockId — идентификатор инфоблока
  • name — название
  • code — символьный код
  • xmlId — внешний код
  • active — активность
  • sort — сортировка
  • createdBy — кто создал
  • modifiedBy — кто изменил
  • dateCreate — дата создания
  • timestampX — дата изменения
  • dateActiveFrom — начало активности
  • dateActiveTo — окончание активности
  • previewText — описание для анонса
  • previewTextType — тип описания для анонса
  • previewPicture — картинка для анонса
  • detailText — детальное описание
  • detailTextType — тип детального описания
  • detailPicture — детальная картинка
  • iblockSectionId — основной раздел
  • iblockSection — все разделы
  • type — тип товара
  • available — доступность для покупки
  • bundle — наличие набора
  • quantity — количество
  • quantityReserved — зарезервированное количество
  • quantityTrace — количественный учет
  • canBuyZero — покупка при отсутствии
  • subscribe — подписка
  • vatId — ставка НДС
  • vatIncluded — НДС включен в цену
  • purchasingPrice — закупочная цена
  • purchasingCurrency — валюта закупочной цены
  • barcodeMulti — уникальные штрихкоды
  • weight — вес
  • length — длина
  • width — ширина
  • height — высота
  • measure — единица измерения
  • recurSchemeLength — длина периода оплаты
  • recurSchemeType — единица периода оплаты
  • trialPriceId — товар для пробной оплаты
  • withoutOrder — продление без заказа
  • quantityTraceRaw — сохраненное значение количественного учета
  • paymentType — тип оплаты
  • subscribeRaw — сохраненное значение подписки
  • canBuyZeroRaw — сохраненное значение покупки при отсутствии
  • properties — значения свойств

Поле id возвращается, только если указано в select. Значения отдельных свойств выбрать нельзя: properties возвращает все свойства. Значение ["*"] не поддерживается.

По умолчанию: все поля, включая properties

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.product.offer.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":7555,"select":["id","iblockId","name","type","available","quantity","measure","vatId","vatIncluded","weight","properties"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.offer.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":7555,"select":["id","iblockId","name","type","available","quantity","measure","vatId","vatIncluded","weight","properties"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.product.offer.get
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type OfferGetResult = {
  item: {
    id: number
    name: string
    type: number
    properties: Record<string, { VALUE: string, VALUE_ID: string } | null>
  }
}

try {
  const response = await $b24.actions.v3.call.make<OfferGetResult>({
    method: 'catalog.product.offer.get',
    params: {
      id: 7555,
      select: ['id', 'iblockId', 'name', 'type', 'available', 'quantity', 'measure', 'vatId', 'vatIncluded', 'weight', 'properties'],
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Item:', result.item)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getOffer() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.product.offer.get',
        params: {
          id: 7555,
          select: ['id', 'iblockId', 'name', 'type', 'available', 'quantity', 'measure', 'vatId', 'vatIncluded', 'weight', 'properties'],
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Item:', result.item)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getOffer)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.product.offer.get(
        id=7555,
        select=["id", "iblockId", "name", "type", "available", "quantity", "measure", "vatId", "vatIncluded", "weight", "properties"],
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.product.offer.get',
            [
                'id' => 7555,
                'select' => ['id', 'iblockId', 'name', 'type', 'available', 'quantity', 'measure', 'vatId', 'vatIncluded', 'weight', 'properties'],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'catalog.product.offer.get',
    {
        id: 7555,
        select: ['id', 'iblockId', 'name', 'type', 'available', 'quantity', 'measure', 'vatId', 'vatIncluded', 'weight', 'properties'],
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'catalog.product.offer.get',
    [
        'id' => 7555,
        'select' => ['id', 'iblockId', 'name', 'type', 'available', 'quantity', 'measure', 'vatId', 'vatIncluded', 'weight', 'properties'],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.product.offer.get", b24.Params{
	"id": 7555,
	"select": []string{"id", "iblockId", "name", "type", "available", "quantity", "measure", "vatId", "vatIncluded", "weight", "properties"},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.product.offer.get: %w", err)
}

// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
	return fmt.Errorf("в ответе нет ключа item")
}

var item struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
	Type int    `json:"type"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name, item.Type)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 7555,
            "iblockId": 27,
            "name": "DOCS-V3-OFFER Футболка синяя L",
            "type": 4,
            "available": "Y",
            "quantity": 0,
            "vatId": 1,
            "vatIncluded": "Y",
            "weight": 220,
            "measure": 9,
            "properties": {
                "PROPERTY_101": {
                    "VALUE": "7553",
                    "VALUE_ID": "4019"
                },
                "PROPERTY_907": null,
                "PROPERTY_905": null,
                "PROPERTY_429": null,
                "PROPERTY_891": null,
                "PROPERTY_895": null,
                "PROPERTY_909": null,
                "PROPERTY_911": null,
                "PROPERTY_925": null,
                "PROPERTY_937": null
            }
        }
    },
    "time": {
        "start": 1792660765,
        "finish": 1792660765.952521,
        "duration": 0.9525210857391357,
        "processing": 0,
        "date_start": "2026-10-22T12:19:25+03:00",
        "date_finish": "2026-10-22T12:19:25+03:00",
        "operating_reset_at": 1792661340,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Объект с данными ответа

result.item
object

Поля вариации. Состав зависит от select. Описание полей

time
time

Информация о времени выполнения запроса

Объект item

Название
тип

Описание

id
integer

Идентификатор вариации

iblockId
integer

Идентификатор инфоблока каталога вариаций

name
string

Название вариации

code
string или null

Символьный код

xmlId
string

Внешний код. Если не задан, совпадает с id

active
string

Активность: Y — активен, N — неактивен

sort
integer

Сортировка

createdBy
integer

Идентификатор пользователя, который создал запись

modifiedBy
integer

Идентификатор пользователя, который последним изменил запись

dateCreate
datetime

Дата и время создания

timestampX
datetime

Дата и время последнего изменения

dateActiveFrom
datetime или null

Дата начала активности

dateActiveTo
datetime или null

Дата окончания активности

previewText
string или null

Описание для анонса

previewTextType
string

Тип описания для анонса: text или html

previewPicture
string или null

Идентификатор файла картинки для анонса

detailText
string или null

Детальное описание

detailTextType
string

Тип детального описания: text или html

detailPicture
string или null

Идентификатор файла детальной картинки

iblockSectionId
integer или null

Идентификатор основного раздела

iblockSection
array

Массив идентификаторов всех разделов, к которым привязан товар

type
integer

Тип товара: 4 — вариация с головным товаром, 5 — вариация без головного товара

available
string

Доступность для покупки: Y — доступен, N — недоступен

bundle
string

Наличие набора: Y — да, N — нет

quantity
double

Доступное количество

quantityReserved
double

Зарезервированное количество

quantityTrace
string

Включен ли количественный учет: Y — да, N — нет

canBuyZero
string

Разрешена ли покупка при отсутствии товара: Y — да, N — нет

subscribe
string

Разрешена ли подписка на товар: Y — да, N — нет

vatId
integer или null

Идентификатор ставки НДС

vatIncluded
string

Включен ли НДС в цену: Y — да, N — нет

purchasingPrice
double или null

Закупочная цена. Возвращается, если у пользователя есть право «Просмотр закупочной цены товара»

purchasingCurrency
string или null

Валюта закупочной цены. Возвращается, если у пользователя есть право «Просмотр закупочной цены товара»

barcodeMulti
string

Уникальные штрихкоды для каждого экземпляра: Y — да, N — нет

weight
double или null

Вес

length
double или null

Длина

width
double или null

Ширина

height
double или null

Высота

measure
integer или null

Идентификатор единицы измерения

recurSchemeLength
integer или null

Длина периода оплаты. Используется только в коробочной версии для продажи контента

recurSchemeType
string

Единица времени периода оплаты. Используется только в коробочной версии для продажи контента

trialPriceId
integer или null

Товар для пробной оплаты. Используется только в коробочной версии для продажи контента

withoutOrder
string

Продление без оформления заказа: Y — да, N — нет. Используется только в коробочной версии для продажи контента

quantityTraceRaw
string

Сохраненное значение количественного учета: Y — да, N — нет, D — по настройкам модуля

paymentType
string

Тип оплаты: S — однократная, R — регулярная, T — пробная. Используется только в коробочной версии для продажи контента

subscribeRaw
string

Сохраненное значение подписки: Y — да, N — нет, D — по настройкам модуля

canBuyZeroRaw
string

Сохраненное значение покупки при отсутствии: Y — да, N — нет, D — по настройкам модуля

properties
object

Значения свойств товара. Ключи — PROPERTY_{id}, где {id} — идентификатор свойства. Значение — null, объект {"VALUE": ..., "VALUE_ID": ...} или массив таких объектов для множественного свойства

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
        "message": "Запись с ID = `7529` не найдена"
    }
}

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

id

Обязательное поле id не указано

Передайте в id положительное число

Ошибка отсутствия объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле

Описание ошибки

Как исправить

id

Запись с ID = #ID# не найдена

Записи нет или это не вариация. Головные товары получайте методом catalog.product.sku.get

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

select

Неизвестное поле #FIELD# для сущности ProductDto

Укажите в select только поля из описания параметра select. Для значений свойств используйте properties

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

Проверьте права пользователя на каталог и на инфоблок

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение