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

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

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

Scope: catalog

Кто может выполнять метод: администратор

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

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

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

Название
тип

Описание

id*
catalog_product_offer.id

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

Для получения идентификаторов вариаций товара необходимо использовать catalog.product.offer.list

Работа с ценой товара

Чтобы получить цены вариации, используйте методы catalog.price.*.

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1286}' \
        https://**put_your_bitrix24_address**/rest/**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":1286,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.product.offer.get
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type OfferResult = {
          offer: {
            id: number
            name: string
            active: string
            available: string
            bundle: string
            canBuyZero: string
            code: string
            createdBy: number
            dateActiveFrom: ISODate | null
            dateActiveTo: ISODate | null
            dateCreate: ISODate | null
            detailPicture: { id: string; url: string; urlMachine: string } | null
            detailText: string | null
            detailTextType: string
            height: number
            iblockId: number
            iblockSectionId: number | null
            length: number
            measure: number
            modifiedBy: number
            parentId: { value: string; valueId: string }
            previewPicture: { id: string; url: string; urlMachine: string } | null
            previewText: string | null
            previewTextType: string
            purchasingCurrency: string
            purchasingPrice: string
            quantity: number
            quantityReserved: number
            quantityTrace: string
            sort: number
            subscribe: string
            timestampX: ISODate | null
            type: number
            vatId: number
            vatIncluded: string
            weight: number
            width: number
            xmlId: string
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<OfferResult>({
            method: 'catalog.product.offer.get',
            params: {
              id: 1286,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Product offer:', result.offer.id, result.offer.name, result.offer.active)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getProductOffer() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'catalog.product.offer.get',
                params: {
                  id: 1286,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Product offer:', result.offer.id, result.offer.name, result.offer.active)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getProductOffer)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.product.offer.get',
                    [
                        'id' => 1286
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting product offer: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'catalog.product.offer.get', {
                'id': 1286
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.product.offer.get',
            [
                'id' => 1286
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": {
                "offer": {
                    "active": "Y",
                    "available": "Y",
                    "bundle": "N",
                    "canBuyZero": "Y",
                    "code": "Tovar",
                    "createdBy": 1,
                    "dateActiveFrom": "2024-05-28T10:00:00+03:00",
                    "dateActiveTo": "2024-05-29T10:00:00+03:00",
                    "dateCreate": "2024-05-27T10:00:00+03:00",
                    "detailPicture": {
                        "id": "6538",
                        "url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6538\u0026fields%5BproductId%5D=1286",
                        "urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6538\u0026fields%5BproductId%5D=1286"
                    },
                    "detailText": null,
                    "detailTextType": "text",
                    "height": 100,
                    "iblockId": 24,
                    "iblockSectionId": null,
                    "id": 1286,
                    "length": 100,
                    "measure": 5,
                    "modifiedBy": 1,
                    "name": "Вариация товара",
                    "parentId": {
                        "value": "1275",
                        "valueId": "9867"
                    },
                    "previewPicture": {
                        "id": "6537",
                        "url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6537\u0026fields%5BproductId%5D=1286",
                        "urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6537\u0026fields%5BproductId%5D=1286"
                    },
                    "previewText": null,
                    "previewTextType": "text",
                    "property261": {
                        "value": "test",
                        "valueId": "9868"
                    },
                    "property262": [
                        {
                            "value": "test1",
                            "valueId": "9869"
                        },
                        {
                            "value": "test2",
                            "valueId": "9870"
                        }
                    ],
                    "purchasingCurrency": "RUB",
                    "purchasingPrice": "1000.000000",
                    "quantity": 10,
                    "quantityReserved": 1,
                    "quantityTrace": "Y",
                    "sort": 100,
                    "subscribe": "Y",
                    "timestampX": "2024-06-17T12:29:59+03:00",
                    "type": 4,
                    "vatId": 1,
                    "vatIncluded": "Y",
                    "weight": 100,
                    "width": 100,
                    "xmlId": "1286"
                }
            },
            "time": {
                "start": 1718623874.271071,
                "finish": 1718623874.871713,
                "duration": 0.6006419658660889,
                "processing": 0.1868131160736084,
                "date_start": "2024-06-17T14:31:14+03:00",
                "date_finish": "2024-06-17T14:31:14+03:00"
            }
        }
        

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

Название
тип

Описание

result
object

Корневой элемент ответа

offer
catalog_product_offer

Объект с информацией о вариации товара

time
time

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

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

HTTP-статус: 400

{
            "error":200040300010,
            "error_description":"Access Denied"
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

200040300000

Информационный блок с указанным идентификатором не существует

200040300040

Недостаточно прав для чтения элемента информационного блока

200040300010

Недостаточно прав для чтения торгового каталога

100

Не указан параметр id

0

Вариация товара не существует

0

Другие ошибки (например, фатальные ошибки)

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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