Получить список головных товаров catalog.product.sku.list

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

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

Scope: catalog

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

Метод возвращает список головных товаров по фильтру.

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

Название
тип

Описание

select
array

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

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

filter
object

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

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

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

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

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • % — 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_sku.

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

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

start
integer

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

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

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

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

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

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","iblockId","name","active","available","bundle","canBuyZero","code","createdBy","dateActiveFrom","dateActiveTo","dateCreate","detailPicture","detailText","detailTextType","height","iblockSectionId","length","measure","modifiedBy","previewPicture","previewText","previewTextType","purchasingCurrency","purchasingPrice","quantity","sort","subscribe","timestampX","type","vatId","vatIncluded","weight","width","xmlId","property258","property259"],"filter":{"iblockId":23,">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.sku.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","iblockId","name","active","available","bundle","canBuyZero","code","createdBy","dateActiveFrom","dateActiveTo","dateCreate","detailPicture","detailText","detailTextType","height","iblockSectionId","length","measure","modifiedBy","previewPicture","previewText","previewTextType","purchasingCurrency","purchasingPrice","quantity","sort","subscribe","timestampX","type","vatId","vatIncluded","weight","width","xmlId","property258","property259"],"filter":{"iblockId":23,">id":10,"vatId":[1,2]},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.product.sku.list
        
// 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
        
        type SkuItem = {
          id: number
          iblockId: number
          iblockSectionId: number | null
          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 | null
          length: number | null
          measure: number | null
          modifiedBy: number
          previewPicture: { id: string; url: string; urlMachine: string } | null
          previewText: string | null
          previewTextType: string
          purchasingCurrency: string | null
          purchasingPrice: string | null
          quantity: number | null
          sort: number
          subscribe: string
          timestampX: ISODate | null
          type: number
          vatId: number | null
          vatIncluded: string
          weight: number | null
          width: number | null
          xmlId: string
          property258: { value: string; valueId: string } | null
          property259: Array<{ value: string; valueId: string }>
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type SkuListResult = {
          units: SkuItem[]
        }
        
        try {
          // catalog.product.sku.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<SkuListResult>({
            method: 'catalog.product.sku.list',
            params: {
              select: [
                'id',
                'iblockId',
                'name',
                'active',
                'available',
                'bundle',
                'canBuyZero',
                'code',
                'createdBy',
                'dateActiveFrom',
                'dateActiveTo',
                'dateCreate',
                'detailPicture',
                'detailText',
                'detailTextType',
                'height',
                'iblockSectionId',
                'length',
                'measure',
                'modifiedBy',
                'previewPicture',
                'previewText',
                'previewTextType',
                'purchasingCurrency',
                'purchasingPrice',
                'quantity',
                'sort',
                'subscribe',
                'timestampX',
                'type',
                'vatId',
                'vatIncluded',
                'weight',
                'width',
                'xmlId',
                'property258',
                'property259',
              ],
              filter: {
                iblockId: 23,
                '>id': 10,
                vatId: [1, 2],
              },
              order: {
                id: 'desc',
              },
              start: 0,
            },
            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('SKUs on this page:', result.units.length, result.units)
          }
        } 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 listProductSkus() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // catalog.product.sku.list returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'catalog.product.sku.list',
                params: {
                  select: [
                    'id',
                    'iblockId',
                    'name',
                    'active',
                    'available',
                    'bundle',
                    'canBuyZero',
                    'code',
                    'createdBy',
                    'dateActiveFrom',
                    'dateActiveTo',
                    'dateCreate',
                    'detailPicture',
                    'detailText',
                    'detailTextType',
                    'height',
                    'iblockSectionId',
                    'length',
                    'measure',
                    'modifiedBy',
                    'previewPicture',
                    'previewText',
                    'previewTextType',
                    'purchasingCurrency',
                    'purchasingPrice',
                    'quantity',
                    'sort',
                    'subscribe',
                    'timestampX',
                    'type',
                    'vatId',
                    'vatIncluded',
                    'weight',
                    'width',
                    'xmlId',
                    'property258',
                    'property259',
                  ],
                  filter: {
                    iblockId: 23,
                    '>id': 10,
                    vatId: [1, 2],
                  },
                  order: {
                    id: 'desc',
                  },
                  start: 0,
                },
                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('SKUs on this page:', result.units.length, result.units)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listProductSkus)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.product.sku.list',
                    [
                        'select' => [
                            'id',
                            'iblockId',
                            'name',
                            'active',
                            'available',
                            'bundle',
                            'canBuyZero',
                            'code',
                            'createdBy',
                            'dateActiveFrom',
                            'dateActiveTo',
                            'dateCreate',
                            'detailPicture',
                            'detailText',
                            'detailTextType',
                            'height',
                            'iblockSectionId',
                            'length',
                            'measure',
                            'modifiedBy',
                            'previewPicture',
                            'previewText',
                            'previewTextType',
                            'purchasingCurrency',
                            'purchasingPrice',
                            'quantity',
                            'sort',
                            'subscribe',
                            'timestampX',
                            'type',
                            'vatId',
                            'vatIncluded',
                            'weight',
                            'width',
                            'xmlId',
                            'property258',
                            'property259',
                        ],
                        'filter' => [
                            'iblockId' => 23,
                            '>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 SKUs: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "catalog.product.sku.list", {
                "select": [
                    "id",
                    "iblockId",
                    "name",
                    "active",
                    "available",
                    "bundle",
                    "canBuyZero",
                    "code",
                    "createdBy",
                    "dateActiveFrom",
                    "dateActiveTo",
                    "dateCreate",
                    "detailPicture",
                    "detailText",
                    "detailTextType",
                    "height",
                    "iblockSectionId",
                    "length",
                    "measure",
                    "modifiedBy",
                    "previewPicture",
                    "previewText",
                    "previewTextType",
                    "purchasingCurrency",
                    "purchasingPrice",
                    "quantity",
                    "sort",
                    "subscribe",
                    "timestampX",
                    "type",
                    "vatId",
                    "vatIncluded",
                    "weight",
                    "width",
                    "xmlId",
                    "property258",
                    "property259",
                ],
                "filter": {
                    "iblockId": 23,
                    ">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.sku.list',
            [
                'select' => [
                    "id",
                    "iblockId",
                    "name",
                    "active",
                    "available",
                    "bundle",
                    "canBuyZero",
                    "code",
                    "createdBy",
                    "dateActiveFrom",
                    "dateActiveTo",
                    "dateCreate",
                    "detailPicture",
                    "detailText",
                    "detailTextType",
                    "height",
                    "iblockSectionId",
                    "length",
                    "measure",
                    "modifiedBy",
                    "previewPicture",
                    "previewText",
                    "previewTextType",
                    "purchasingCurrency",
                    "purchasingPrice",
                    "quantity",
                    "sort",
                    "subscribe",
                    "timestampX",
                    "type",
                    "vatId",
                    "vatIncluded",
                    "weight",
                    "width",
                    "xmlId",
                    "property258",
                    "property259",
                ],
                'filter' => [
                    "iblockId" => 23,
                    ">id" => 10,
                    "vatId" => [1, 2],
                ],
                'order' => [
                    "id" => "desc",
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": {
                "units": [
                    {
                        "active": "Y",
                        "available": "N",
                        "bundle": "N",
                        "canBuyZero": "N",
                        "code": "product_sku",
                        "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": "6546",
                            "url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6546\u0026fields%5BproductId%5D=1289",
                            "urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6546\u0026fields%5BproductId%5D=1289"
                        },
                        "detailText": null,
                        "detailTextType": "text",
                        "height": null,
                        "iblockId": 23,
                        "iblockSectionId": 47,
                        "id": 1289,
                        "length": null,
                        "measure": null,
                        "modifiedBy": 1,
                        "name": "Головной товар",
                        "previewPicture": {
                            "id": "6545",
                            "url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6545\u0026fields%5BproductId%5D=1289",
                            "urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6545\u0026fields%5BproductId%5D=1289"
                        },
                        "previewText": null,
                        "previewTextType": "text",
                        "property258": {
                            "value": "test",
                            "valueId": "9877"
                        },
                        "property259": [
                            {
                                "value": "test1",
                                "valueId": "9878"
                            },
                            {
                                "value": "test2",
                                "valueId": "9879"
                            }
                        ],
                        "purchasingCurrency": null,
                        "purchasingPrice": null,
                        "quantity": null,
                        "sort": 100,
                        "subscribe": "Y",
                        "timestampX": "2024-06-17T14:30:33+03:00",
                        "type": 6,
                        "vatId": null,
                        "vatIncluded": "N",
                        "weight": null,
                        "width": null,
                        "xmlId": "1289"
                    }
                ]
            },
            "total": 1,
            "time": {
                "start": 1718631434.15105,
                "finish": 1718631434.921837,
                "duration": 0.7707870006561279,
                "processing": 0.3575417995452881,
                "date_start": "2024-06-17T16:37:14+03:00",
                "date_finish": "2024-06-17T16:37:14+03:00"
            }
        }
        

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

Название
тип

Описание

result
object

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

units
catalog_product_sku[]

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

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

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

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

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

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