Получить список головных товаров v 3.0 catalog.product.sku.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Просмотр каталога товаров», «Просмотр товаров каталога» или «Изменение цены продажи товара»
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод catalog.product.sku.list возвращает список головных товаров каталога по фильтру.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
filter* |
Фильтр в формате REST 3.0: массив условий вида Обязательно передайте условие Фильтровать можно по полям: Поддерживаются операторы Для поля Если для одного поля передать два условия с одинаковым оператором, учитывается последнее |
|
select |
Массив полей головного товара, которые нужно вернуть в ответе. Доступные поля:
Указывайте По умолчанию: все поля, кроме |
|
order |
Сортировка в формате Возможные значения направления:
Сортировать можно по полям: |
|
pagination |
Постраничная навигация. Описание объекта |
Параметр pagination
|
Название |
Описание |
|
limit |
Количество записей на странице. Значения больше По умолчанию: |
|
page |
Номер страницы, начиная с |
|
offset |
Смещение от начала списка. Должно быть кратно |
Номер страницы за пределами списка возвращает первую страницу, а не пустой массив. Не завершайте обход по пустой странице: цикл не остановится. Если на странице записей меньше, чем limit, страница последняя. Если число записей кратно limit, следующая страница повторит первую — сравнивайте идентификаторы.
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.product.sku.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["iblockId","=",25],["iblockSectionId","=",31],["type","=",3]],"select":["id","name","type","active"],"order":{"id":"desc"},"pagination":{"limit":2}}' \
https://**put_your_bitrix24_address**/rest/api/**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 '{"filter":[["iblockId","=",25],["iblockSectionId","=",31],["type","=",3]],"select":["id","name","type","active"],"order":{"id":"desc"},"pagination":{"limit":2},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.product.sku.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type SkuListResult = {
items: Array<{
id: number
name: string
type: number
}>
}
try {
const response = await $b24.actions.v3.call.make<SkuListResult>({
method: 'catalog.product.sku.list',
params: {
filter: [
['iblockId', '=', 25],
['iblockSectionId', '=', 31],
['type', '=', 3],
],
select: ['id', 'name', 'type', 'active'],
order: {
id: 'desc',
},
pagination: {
limit: 2,
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Items:', result.items.length)
}
} 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 listSku() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.product.sku.list',
params: {
filter: [
['iblockId', '=', 25],
['iblockSectionId', '=', 31],
['type', '=', 3],
],
select: ['id', 'name', 'type', 'active'],
order: {
id: 'desc',
},
pagination: {
limit: 2,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Items:', result.items.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listSku)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product.sku.list(
filter=[
["iblockId", "=", 25],
["iblockSectionId", "=", 31],
["type", "=", 3],
],
select=["id", "name", "type", "active"],
order={
"id": "desc",
},
pagination={
"limit": 2,
},
).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.sku.list',
[
'filter' => [
['iblockId', '=', 25],
['iblockSectionId', '=', 31],
['type', '=', 3],
],
'select' => ['id', 'name', 'type', 'active'],
'order' => [
'id' => 'desc',
],
'pagination' => [
'limit' => 2,
],
]
);
$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.sku.list',
{
filter: [
['iblockId', '=', 25],
['iblockSectionId', '=', 31],
['type', '=', 3],
],
select: ['id', 'name', 'type', 'active'],
order: {
id: 'desc',
},
pagination: {
limit: 2,
},
},
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.sku.list',
[
'filter' => [
['iblockId', '=', 25],
['iblockSectionId', '=', 31],
['type', '=', 3],
],
'select' => ['id', 'name', 'type', 'active'],
'order' => [
'id' => 'desc',
],
'pagination' => [
'limit' => 2,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.product.sku.list", b24.Params{
"filter": []any{
[]any{"iblockId", "=", 25},
[]any{"iblockSectionId", "=", 31},
[]any{"type", "=", 3},
},
"select": []string{"id", "name", "type", "active"},
"order": b24.Params{
"id": "desc",
},
"pagination": b24.Params{
"limit": 2,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.product.sku.list: %w", err)
}
var result struct {
Items []struct {
ID int `json:"id"`
Name string `json:"name"`
Type int `json:"type"`
} `json:"items"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, item := range result.Items {
fmt.Println(item.ID, item.Name, item.Type)
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"items": [
{
"id": 7553,
"name": "DOCS-V3-SKU Футболка хлопковая",
"active": "Y",
"type": 3
}
]
},
"time": {
"start": 1792660767,
"finish": 1792660767.794007,
"duration": 0.7940070629119873,
"processing": 0,
"date_start": "2026-10-22T12:19:27+03:00",
"date_finish": "2026-10-22T12:19:27+03:00",
"operating_reset_at": 1792660860,
"operating": 0.10251188278198242
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
result.items |
Массив головных товаров. Состав полей зависит от |
|
time |
Информация о времени выполнения запроса |
Элемент items
|
Название |
Описание |
|
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 |
Значения свойств товара. Ключи — |
Общее количество записей в ответе не возвращается.
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта запроса",
"validation": [
{
"message": "Iblock Not Found",
"field": "200040300000"
}
]
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Iblock Not Found |
Передайте в |
|
|
productType is not allowed for this catalog |
Передайте в |
|
|
The type field supports only the =, != and in filter operators |
Используйте для |
|
|
В DTO |
Фильтруйте только по полям из описания параметра |
|
|
В DTO |
Сортируйте только по полям из описания параметра |
|
|
pagination.offset must be a non-negative multiple of pagination.limit |
Передайте |
Ошибка оператора фильтра
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNFILTEROPERATOREXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестный оператор фильтра |
Используйте операторы |
Ошибка пагинации
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать параметр пагинации |
Передайте |
Ошибка неизвестного поля
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Укажите только поля из описания параметров. Ключи |
Ошибка доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
Проверьте права пользователя на каталог и на инфоблок |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить головной товар v 3.0 catalog.product.sku.add
- Обновить поля головного товара v 3.0 catalog.product.sku.update
- Получить значения полей головного товара v 3.0 catalog.product.sku.get
- Удалить головной товар v 3.0 catalog.product.sku.delete
- Скачать файлы головного товара v 3.0 catalog.product.sku.download
- Получить список полей головного товара v 3.0 catalog.product.sku.field.list
- Получить поле головного товара catalog.product.sku.field.get