Get List of Parent Products catalog.product.sku.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 the "View product catalog", "View catalog products", or "Edit selling price" access permission and the permission to read the catalog information block
The catalog.product.sku.list method returns a list of catalog parent products by filter. The list includes parent products with variations (type 3) and without variations (type 6).
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
select* |
An array of fields to return. The fields are described in the catalog_product_sku object. Make sure to pass the In The method skips unknown fields and uppercase names, such as |
|
filter* |
An object for filtering parent products in the format Make sure to pass You can filter by the fields of the catalog_product_sku object and by single properties, for example An additional prefix can be set for the key to specify the filter behavior. Possible prefix values:
The method does not apply the The The method skips unknown fields and uppercase names, such as |
|
order |
An object for sorting parent products in the format Possible values for
The direction is case-insensitive. The method skips unknown fields and an invalid direction without an error. By default, results are sorted in ascending order by |
|
start |
This parameter is used to manage pagination. The page size of results is always static — 50 records. To select the second page of results, pass the value The formula for calculating the
|
A start value beyond the list returns the first page, not an empty array. Do not stop the iteration on an empty page: the loop will not end. Rely on the total field and on whether the next field is present in the response.
Code Examples
How to Use Examples in Documentation
The example retrieves parent products of section 31 with a sort index of at least 100 and a symbolic code that contains t-shirt.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","iblockId","name","active","sort","code","iblockSectionId","property303"],"filter":{"iblockId":25,"iblockSectionId":31,">=sort":100,"%code":"t-shirt"},"order":{"sort":"asc"},"start":0}' \
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","sort","code","iblockSectionId","property303"],"filter":{"iblockId":25,"iblockSectionId":31,">=sort":100,"%code":"t-shirt"},"order":{"sort":"asc"},"start":0,"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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of one item returned in result.units (only the selected fields)
type SkuListItem = {
id: number
iblockId: number
name: string
active: string
sort: number | null
code: string | null
iblockSectionId: number | null
property303: { value: string; valueId: string } | null
}
try {
// catalog.product.sku.list returns a single page (max 50 records).
// The list is returned under the "units" key.
const response = await $b24.actions.v2.call.make<{ units: SkuListItem[] }>({
method: 'catalog.product.sku.list',
params: {
select: ['id', 'iblockId', 'name', 'active', 'sort', 'code', 'iblockSectionId', 'property303'],
filter: {
iblockId: 25,
iblockSectionId: 31,
'>=sort': 100,
'%code': 't-shirt',
},
order: {
sort: 'asc',
},
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('SKU products on page:', result.units.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 listSkuProducts() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.product.sku.list',
params: {
select: ['id', 'iblockId', 'name', 'active', 'sort', 'code', 'iblockSectionId', 'property303'],
filter: {
iblockId: 25,
iblockSectionId: 31,
'>=sort': 100,
'%code': 't-shirt',
},
order: {
sort: 'asc',
},
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('SKU products on page:', result.units.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listSkuProducts)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product.sku.list(
select=["id", "iblockId", "name", "active", "sort", "code", "iblockSectionId", "property303"],
filter={
"iblockId": 25,
"iblockSectionId": 31,
">=sort": 100,
"%code": "t-shirt",
},
order={
"sort": "asc",
},
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.sku.list',
[
'select' => ['id', 'iblockId', 'name', 'active', 'sort', 'code', 'iblockSectionId', 'property303'],
'filter' => [
'iblockId' => 25,
'iblockSectionId' => 31,
'>=sort' => 100,
'%code' => 't-shirt',
],
'order' => [
'sort' => 'asc',
],
'start' => 0,
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'catalog.product.sku.list',
{
select: ['id', 'iblockId', 'name', 'active', 'sort', 'code', 'iblockSectionId', 'property303'],
filter: {
iblockId: 25,
iblockSectionId: 31,
'>=sort': 100,
'%code': 't-shirt',
},
order: {
sort: 'asc',
},
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.sku.list',
[
'select' => ['id', 'iblockId', 'name', 'active', 'sort', 'code', 'iblockSectionId', 'property303'],
'filter' => [
'iblockId' => 25,
'iblockSectionId' => 31,
'>=sort' => 100,
'%code' => 't-shirt',
],
'order' => [
'sort' => 'asc',
],
'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.sku.list", b24.Params{
"select": []string{"id", "iblockId", "name", "active", "sort", "code", "iblockSectionId", "property303"},
"filter": b24.Params{
"iblockId": 25,
"iblockSectionId": 31,
">=sort": 100,
"%code": "t-shirt",
},
"order": b24.Params{
"sort": "asc",
},
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.product.sku.list: %w", err)
}
// The method returns the list under the "units" key.
raw, ok := b24.Unwrap(res.Result, "units")
if !ok {
return fmt.Errorf("no units key in the response")
}
// 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"`
Active string `json:"active"`
Sort *int `json:"sort"`
Code *string `json:"code"`
IblockSectionID *int `json:"iblockSectionId"`
Property303 *struct {
Value string `json:"value"`
ValueID string `json:"valueId"`
} `json:"property303"`
}
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": {
"units": [
{
"active": "Y",
"code": "basic-t-shirt",
"iblockId": 25,
"iblockSectionId": 31,
"id": 7679,
"name": "Basic T-shirt",
"property303": {
"value": "Cotton Yard",
"valueId": "4117"
},
"sort": 300
}
]
},
"total": 1,
"time": {
"start": 1793893107,
"finish": 1793893107.413658,
"duration": 0.41365790367126465,
"processing": 0,
"date_start": "2026-11-05T18:38:27+01:00",
"date_finish": "2026-11-05T18:38:27+01:00",
"operating_reset_at": 1793893200,
"operating": 0.13479113578796387
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
result.units |
Array of parent products. The method returns the list under the Each product contains only the fields from |
|
total |
Total number of parent products found |
|
next |
The |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error": "0",
"error_description": "Required filter 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 does not have a permission to view the catalog |
|
|
|
Access Denied |
The user does not have the permission to read the catalog information block |
|
|
|
Required filter fields: iblockId |
|
|
|
|
Required select fields: iblockId |
|
|
|
|
iblock is not catalog |
The |
|
|
|
productType is not allowed for this catalog |
|
|
|
|
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 Parent Product catalog.product.sku.add
- Update Parent Product Fields catalog.product.sku.update
- Get Parent Product Field Values catalog.product.sku.get
- Download Parent Product Files catalog.product.sku.download
- Delete Parent Product catalog.product.sku.delete
- Get Parent Product Fields by Filter catalog.product.sku.getFieldsByFilter