Get List of Product Variations catalog.product.offer.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
catalogWho can execute the method: a user with permission to read the variations information block and one of the permissions: "View product catalog", "View catalog products", or "Edit selling price"
The method catalog.product.offer.list returns a list of product variations with filtering, sorting, and pagination.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
select* |
Array of variation fields to return. The fields are described in the catalog_product_offer object. Pass properties as The array must contain the |
|
filter* |
Object for filtering variations in the format Be sure to pass Possible values for
The method does not support the To find an empty value, pass For a list property, pass the identifier of the value option, for example
The method skips unknown fields and uppercase names, for example |
|
order |
Object for sorting variations in the format Possible values for
The By default, variations are sorted by |
|
start |
The parameter is used for pagination. The results page size is always static — 50 records. To select the second page of results, pass Formula for calculating the
If |
The method does not return variation prices. To retrieve prices, use the catalog.price.* methods.
Code Examples
How to Use Examples in Documentation
The example retrieves active variations of the parent product 7603 with sizes M and L in the property907 list property and sorts them by the sort field.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","iblockId","name","active","sort","parentId","property907"],"filter":{"iblockId":27,"parentId":7603,"active":"Y","property907":[1603,1605]},"order":{"sort":"asc","id":"desc"},"start":0}' \
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","sort","parentId","property907"],"filter":{"iblockId":27,"parentId":7603,"active":"Y","property907":[1603,1605]},"order":{"sort":"asc","id":"desc"},"start":0,"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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type OfferProperty = {
value: string
valueId: string
valueEnum?: string
}
// Shape of one offer returned in result.offers (only the selected fields)
type OfferListItem = {
id: number
iblockId: number
name: string
active: string
sort: number | null
parentId: OfferProperty | null
property907: OfferProperty | null
}
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<{ offers: OfferListItem[] }>({
method: 'catalog.product.offer.list',
params: {
select: ['id', 'iblockId', 'name', 'active', 'sort', 'parentId', 'property907'],
filter: {
iblockId: 27,
parentId: 7603,
active: 'Y',
property907: [1603, 1605],
},
order: {
sort: 'asc',
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 on page:', result.offers.length)
}
} 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 listOffers() {
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.list',
params: {
select: ['id', 'iblockId', 'name', 'active', 'sort', 'parentId', 'property907'],
filter: {
iblockId: 27,
parentId: 7603,
active: 'Y',
property907: [1603, 1605],
},
order: {
sort: 'asc',
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 on page:', result.offers.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listOffers)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product.offer.list(
select=["id", "iblockId", "name", "active", "sort", "parentId", "property907"],
filter={
"iblockId": 27,
"parentId": 7603,
"active": "Y",
"property907": [1603, 1605],
},
order={
"sort": "asc",
"id": "desc",
},
start=0,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'catalog.product.offer.list',
[
'select' => ['id', 'iblockId', 'name', 'active', 'sort', 'parentId', 'property907'],
'filter' => [
'iblockId' => 27,
'parentId' => 7603,
'active' => 'Y',
'property907' => [1603, 1605],
],
'order' => [
'sort' => 'asc',
'id' => 'desc',
],
'start' => 0,
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'catalog.product.offer.list',
{
select: ['id', 'iblockId', 'name', 'active', 'sort', 'parentId', 'property907'],
filter: {
iblockId: 27,
parentId: 7603,
active: 'Y',
property907: [1603, 1605],
},
order: {
sort: 'asc',
id: 'desc',
},
start: 0,
},
function(result)
{
if (result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.product.offer.list',
[
'select' => ['id', 'iblockId', 'name', 'active', 'sort', 'parentId', 'property907'],
'filter' => [
'iblockId' => 27,
'parentId' => 7603,
'active' => 'Y',
'property907' => [1603, 1605],
],
'order' => [
'sort' => 'asc',
'id' => 'desc',
],
'start' => 0,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.product.offer.list", b24.Params{
"select": []string{"id", "iblockId", "name", "active", "sort", "parentId", "property907"},
"filter": b24.Params{
"iblockId": 27,
"parentId": 7603,
"active": "Y",
"property907": []int{1603, 1605},
},
"order": b24.Params{
"sort": "asc",
"id": "desc",
},
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.product.offer.list: %w", err)
}
// The method wraps the response in an object with the "offers" key.
raw, ok := b24.Unwrap(res.Result, "offers")
if !ok {
return fmt.Errorf("the response has no offers key")
}
// Optional fields can be null, so pointers are used for them.
var items []struct {
ID b24.ID `json:"id"`
IblockID int `json:"iblockId"`
Name string `json:"name"`
Sort *int `json:"sort"`
ParentID *struct {
Value string `json:"value"`
} `json:"parentId"`
Property907 *struct {
Value string `json:"value"`
ValueEnum string `json:"valueEnum"`
} `json:"property907"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Name)
}
Response Handling
HTTP status: 200
{
"result": {
"offers": [
{
"active": "Y",
"iblockId": 27,
"id": 7695,
"name": "Red T-shirt, M",
"parentId": {
"value": "7603",
"valueId": "4149"
},
"property907": {
"value": "1603",
"valueEnum": "M",
"valueId": "4157"
},
"sort": 100
},
{
"active": "Y",
"iblockId": 27,
"id": 7685,
"name": "Blue T-shirt, M",
"parentId": {
"value": "7603",
"valueId": "4125"
},
"property907": {
"value": "1603",
"valueEnum": "M",
"valueId": "4143"
},
"sort": 100
}
]
},
"total": 2,
"time": {
"start": 1793895575,
"finish": 1793895575.244894,
"duration": 0.24489402770996094,
"processing": 0,
"date_start": "2026-11-05T19:19:35+01:00",
"date_finish": "2026-11-05T19:19:35+01:00",
"operating_reset_at": 1793896140,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
result.offers |
Array of variations. Each variation contains only the fields from The parent product and properties are returned as an object |
|
next |
The |
|
total |
Total number of variations found |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "0",
"error_description": "Required select fields: iblockId"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Access Denied |
The user has none of the "View product catalog", "View catalog products", or "Edit selling price" permissions |
|
|
|
Access Denied |
The user does not have permission to read the variations information block |
|
|
|
Required select fields: id, iblockId |
|
|
|
|
Required filter fields: iblockId |
|
|
|
|
Wrong format value of filter field |
|
|
|
|
productType is not allowed for this catalog |
The product information block was passed in |
|
|
|
iblock is not catalog |
The information block with the specified |
|
|
|
Invalid value {abc} to match with parameter {filter}. Should be value of type array. |
|
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Add Product Variation catalog.product.offer.add
- Update Product Variation Fields catalog.product.offer.update
- Get Product Variation Field Values catalog.product.offer.get
- Download Product Variation Files catalog.product.offer.download
- Delete Product Variation catalog.product.offer.delete
- Get Product Variation Fields by Filter catalog.product.offer.getFieldsByFilter