Получить список вариаций товара catalog.product.offer.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: администратор
Метод возвращает список вариаций товара по фильтру.
Параметры метода
|
Название |
Описание |
|
select |
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта catalog_product_offer). Обязательные поля: |
|
filter |
Объект для фильтрации выбранных вариаций товара в формате Возможные значения для Обязательные поля: Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
Для пользовательских полей
Примеры фильтрации по пользовательским полям:
|
|
order |
Объект для сортировки выбранных вариаций товара в формате Возможные значения для Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Работа с ценой товара
Чтобы получить цены вариаций, используйте методы 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
// 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 ProductOffer = {
id: number
iblockId: number
name: string
active: string
available: string
barcodeMulti: 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
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: number
quantity: number
quantityReserved: number
quantityTrace: string
recurSchemeLength: number | null
recurSchemeType: string
sort: number
subscribe: string
timestampX: ISODate | null
trialPriceId: number | null
type: number
vatId: number
vatIncluded: string
weight: number
width: number
withoutOrder: string
xmlId: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type ProductOfferListResult = {
offers: ProductOffer[]
}
try {
// catalog.product.offer.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<ProductOfferListResult>({
method: 'catalog.product.offer.list',
params: {
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',
},
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('Offers count:', result.offers.length, 'First offer:', result.offers[0])
}
} 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 listProductOffers() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// catalog.product.offer.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.offer.list',
params: {
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',
},
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('Offers count:', result.offers.length, 'First offer:', result.offers[0])
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listProductOffers)
</script>
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 |
Корневой элемент ответа |
|
offers |
Массив объектов с информацией о выбранных вариациях товара |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":200040300010,
"error_description":"Access denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения торгового каталога |
|
|
Не указаны поля |
|
|
Не указано поле |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить вариацию товара catalog.product.offer.add
- Обновить поля вариации товара catalog.product.offer.update
- Получить значения полей вариации товара catalog.product.offer.get
- Скачать файлы вариации товара catalog.product.offer.download
- Удалить вариацию товара catalog.product.offer.delete
- Получить поля вариации товара по фильтру catalog.product.offer.getFieldsByFilter