Get the list of parent products catalog.product.sku.list
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
catalogWho can execute the method: administrator
The method returns a list of parent products based on the filter.
Method Parameters
|
Name |
Description |
|
select |
An array of fields to be selected (see the fields of the catalog_product_sku object). Required fields: |
|
filter |
An object for filtering the selected parent products in the format Possible values for Required fields: An additional prefix can be set for the key to specify the filter behavior. Possible prefix values:
|
|
order |
An object for sorting the selected parent products in the format Possible values for Possible values for
|
|
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
|
Code Examples
How to Use Examples in Documentation
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>';
Response Handling
HTTP status: 200
{
"result": {
"units": [
{
"active": "Y",
"available": "N",
"bundle": "N",
"canBuyZero": "N",
"code": "product_sku",
"createdBy": 1,
"dateActiveFrom": "2024-05-28T10:00:00+02:00",
"dateActiveTo": "2024-05-29T10:00:00+02:00",
"dateCreate": "2024-05-27T10:00:00+02: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": "Parent Product",
"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+02: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+02:00",
"date_finish": "2024-06-17T16:37:14+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response |
|
units |
An array of objects with information about the selected parent products |
|
total |
The total number of records found |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error":200040300010,
"error_description":"Access denied"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient rights to read the trade catalog |
|
|
Fields |
|
|
Field |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 the main product fields catalog.product.sku.update
- Get the values of the parent product fields catalog.product.sku.get
- Download Main Product Files catalog.product.sku.download
- Delete Head Product catalog.product.sku.delete
- Get Parent Product Fields by Filter catalog.product.sku.getFieldsByFilter