Получить список вариаций товара catalog.product.offer.list

Scope: catalog

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

Метод возвращает список вариаций товара по фильтру.

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

Название
тип

Описание

select
array

Массив со списком полей, которые необходимо выбрать (смотрите поля объекта catalog_product_offer).

Обязательные поля: id, iblockId

filter
object

Объект для фильтрации выбранных вариаций товара в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Возможные значения для field соответствуют полям объекта catalog_product_offer.

Обязательные поля: iblockId — идентификатор информационного блока торгового каталога для вариаций.
Для получения существующих идентификаторов информационных блоков торговых каталогов необходимо использовать catalog.catalog.list. У инфоблока вариаций заполнено поле productIblockId.

Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, начинающиеся с «мол»
    • "%мол" — ищет значения, заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где «мол» может быть в любой позиции
  • %= — LIKE (аналогично =%)
  • !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
  • !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, не начинающиеся с «мол»
    • "%мол" — ищет значения, не заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
  • !%= — NOT LIKE (аналогично !=%)
  • = — равно, точное совпадение (используется по умолчанию). Для поиска IN можно передавать несколько значений массивом
  • != — не равно
  • ! — не равно. Для поиска NOT IN можно передавать несколько значений массивом

order
object

Объект для сортировки выбранных вариаций товара в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Возможные значения для field соответствуют полям объекта catalog_product_offer.

Возможные значения для order:

  • asc — в порядке возрастания
  • desc — в порядке убывания

start
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы

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

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

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","iblockId","name","active","available","barcodeMulti","bundle","canBuyZero","code","createdBy","dateActiveFrom","dateActiveTo","dateCreate","detailPicture","detailText","detailTextType","height","iblockSectionId","length","measure","modifiedBy","previewPicture","previewText","previewTextType","purchasingCurrency","purchasingPrice","quantity","quantityReserved","quantityTrace","recurSchemeLength","recurSchemeType","sort","subscribe","timestampX","trialPriceId","type","vatId","vatIncluded","weight","width","withoutOrder","xmlId","parentId","property258","property259"],"filter":{"iblockId":24,">id":10,"vatId":[1,2]},"order":{"id":"desc"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.offer.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","iblockId","name","active","available","barcodeMulti","bundle","canBuyZero","code","createdBy","dateActiveFrom","dateActiveTo","dateCreate","detailPicture","detailText","detailTextType","height","iblockSectionId","length","measure","modifiedBy","previewPicture","previewText","previewTextType","purchasingCurrency","purchasingPrice","quantity","quantityReserved","quantityTrace","recurSchemeLength","recurSchemeType","sort","subscribe","timestampX","trialPriceId","type","vatId","vatIncluded","weight","width","withoutOrder","xmlId","parentId","property258","property259"],"filter":{"iblockId":24,">id":10,"vatId":[1,2]},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.product.offer.list
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        const selectFields = [
            "id",
            "iblockId",
            "name",
            "active",
            "available",
            "barcodeMulti",
            "bundle",
            "canBuyZero",
            "code",
            "createdBy",
            "dateActiveFrom",
            "dateActiveTo",
            "dateCreate",
            "detailPicture",
            "detailText",
            "detailTextType",
            "height",
            "iblockSectionId",
            "length",
            "measure",
            "modifiedBy",
            "previewPicture",
            "previewText",
            "previewTextType",
            "purchasingCurrency",
            "purchasingPrice",
            "quantity",
            "quantityReserved",
            "quantityTrace",
            "recurSchemeLength",
            "recurSchemeType",
            "sort",
            "subscribe",
            "timestampX",
            "trialPriceId",
            "type",
            "vatId",
            "vatIncluded",
            "weight",
            "width",
            "withoutOrder",
            "xmlId",
            "parentId",
            "property258",
            "property259",
        ];
        
        try {
            const response = await $b24.callListMethod(
                'catalog.product.offer.list',
                {
                    "select": selectFields,
                    "filter": {
                        "iblockId": 24,
                        ">id": 10,
                        "vatId": [1, 2],
                    },
                    "order": {
                        "id": "desc",
                    }
                },
                (progress) => { console.log('Progress:', progress) }
            );
            const items = response.getData() || [];
            for (const entity of items) { console.log('Entity:', entity); }
        } catch (error) {
            console.error('Request failed', error);
        }
        
        // fetchListMethod предпочтительно использовать при работе с крупными наборами данных. Метод реализует итеративную выборку с использованием генератора, что позволяет обрабатывать данные по частям и эффективно использовать память.
        
        try {
            const generator = $b24.fetchListMethod('catalog.product.offer.list', {
                "select": selectFields,
                "filter": {
                    "iblockId": 24,
                    ">id": 10,
                    "vatId": [1, 2],
                },
                "order": {
                    "id": "desc",
                }
            }, 'id');
            for await (const page of generator) {
                for (const entity of page) { console.log('Entity:', entity); }
            }
        } catch (error) {
            console.error('Request failed', error);
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
            const response = await $b24.callMethod('catalog.product.offer.list', {
                "select": selectFields,
                "filter": {
                    "iblockId": 24,
                    ">id": 10,
                    "vatId": [1, 2],
                },
                "order": {
                    "id": "desc",
                }
            }, 0);
            const result = response.getData().result || [];
            for (const entity of result) { console.log('Entity:', entity); }
        } catch (error) {
            console.error('Request failed', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.product.offer.list',
                    [
                        'select' => [
                            'id',
                            'iblockId',
                            'name',
                            'active',
                            'available',
                            'barcodeMulti',
                            'bundle',
                            'canBuyZero',
                            'code',
                            'createdBy',
                            'dateActiveFrom',
                            'dateActiveTo',
                            'dateCreate',
                            'detailPicture',
                            'detailText',
                            'detailTextType',
                            'height',
                            'iblockSectionId',
                            'length',
                            'measure',
                            'modifiedBy',
                            'previewPicture',
                            'previewText',
                            'previewTextType',
                            'purchasingCurrency',
                            'purchasingPrice',
                            'quantity',
                            'quantityReserved',
                            'quantityTrace',
                            'recurSchemeLength',
                            'recurSchemeType',
                            'sort',
                            'subscribe',
                            'timestampX',
                            'trialPriceId',
                            'type',
                            'vatId',
                            'vatIncluded',
                            'weight',
                            'width',
                            'withoutOrder',
                            'xmlId',
                            'parentId',
                            'property258',
                            'property259',
                        ],
                        'filter' => [
                            'iblockId' => 24,
                            '>id'      => 10,
                            'vatId'    => [1, 2],
                        ],
                        'order'  => [
                            'id' => 'desc',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching product offers: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "catalog.product.offer.list", {
                "select": [
                    "id",
                    "iblockId",
                    "name",
                    "active",
                    "available",
                    "barcodeMulti",
                    "bundle",
                    "canBuyZero",
                    "code",
                    "createdBy",
                    "dateActiveFrom",
                    "dateActiveTo",
                    "dateCreate",
                    "detailPicture",
                    "detailText",
                    "detailTextType",
                    "height",
                    "iblockSectionId",
                    "length",
                    "measure",
                    "modifiedBy",
                    "previewPicture",
                    "previewText",
                    "previewTextType",
                    "purchasingCurrency",
                    "purchasingPrice",
                    "quantity",
                    "quantityReserved",
                    "quantityTrace",
                    "recurSchemeLength",
                    "recurSchemeType",
                    "sort",
                    "subscribe",
                    "timestampX",
                    "trialPriceId",
                    "type",
                    "vatId",
                    "vatIncluded",
                    "weight",
                    "width",
                    "withoutOrder",
                    "xmlId",
                    "parentId",
                    "property258",
                    "property259",
                ],
                "filter": {
                    "iblockId": 24,
                    ">id": 10,
                    "vatId": [1, 2],
                },
                "order": {
                    "id": "desc",
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.product.offer.list',
            [
                'select' => [
                    "id",
                    "iblockId",
                    "name",
                    "active",
                    "available",
                    "barcodeMulti",
                    "bundle",
                    "canBuyZero",
                    "code",
                    "createdBy",
                    "dateActiveFrom",
                    "dateActiveTo",
                    "dateCreate",
                    "detailPicture",
                    "detailText",
                    "detailTextType",
                    "height",
                    "iblockSectionId",
                    "length",
                    "measure",
                    "modifiedBy",
                    "previewPicture",
                    "previewText",
                    "previewTextType",
                    "purchasingCurrency",
                    "purchasingPrice",
                    "quantity",
                    "quantityReserved",
                    "quantityTrace",
                    "recurSchemeLength",
                    "recurSchemeType",
                    "sort",
                    "subscribe",
                    "timestampX",
                    "trialPriceId",
                    "type",
                    "vatId",
                    "vatIncluded",
                    "weight",
                    "width",
                    "withoutOrder",
                    "xmlId",
                    "parentId",
                    "property258",
                    "property259",
                ],
                'filter' => [
                    "iblockId" => 24,
                    ">id" => 10,
                    "vatId" => [1, 2],
                ],
                'order' => [
                    "id" => "desc",
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "offers": [
                    {
                        "active": "Y",
                        "available": "Y",
                        "barcodeMulti": "N",
                        "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",
                        "purchasingCurrency": "RUB",
                        "purchasingPrice": 1000,
                        "quantity": 10,
                        "quantityReserved": 1,
                        "quantityTrace": "Y",
                        "recurSchemeLength": null,
                        "recurSchemeType": "D",
                        "sort": 100,
                        "subscribe": "Y",
                        "timestampX": "2024-06-17T12:29:59+03:00",
                        "trialPriceId": null,
                        "type": 4,
                        "vatId": 1,
                        "vatIncluded": "Y",
                        "weight": 100,
                        "width": 100,
                        "withoutOrder": "N",
                        "xmlId": "1286"
                    }
                ]
            },
            "total": 1,
            "time": {
                "start": 1718625858.291581,
                "finish": 1718625858.937026,
                "duration": 0.6454451084136963,
                "processing": 0.2336890697479248,
                "date_start": "2024-06-17T15:04:18+03:00",
                "date_finish": "2024-06-17T15:04:18+03:00"
            }
        }

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

Название
тип

Описание

result
object

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

offers
catalog_product_offer[]

Массив объектов с информацией о выбранных вариациях товара

total
integer

Общее количество найденных записей

time
time

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

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

200040300010

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

0

Не указаны поля id, iblockId в полях выбора

0

Не указано поле iblockId в фильтре

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

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

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

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

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

Предыдущая
Получить значения полей вариации товара
Следующая
Скачать файлы вариации товара