Get List of Parent Products v 3.0 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: catalog

Who can execute the method: a user with the "View product catalog", "View catalog products", or "Edit selling price" access permission

The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The method catalog.product.sku.list returns a list of catalog parent products by filter.

Method Parameters

Required parameters are marked with *

Name
type

Description

filter*
array

Filter in REST 3.0 format: an array of conditions of the form ["field", "operator", "value"]. The filter syntax is described in the REST 3.0 overview.

You must pass the ["iblockId", "=", 25] condition with the identifier of the product catalog information block. The identifier can be retrieved using the catalog.catalog.list method: it is the catalog whose productIblockId equals 0.

You can filter by the fields: id, iblockId, name, code, xmlId, active, sort, createdBy, modifiedBy, dateCreate, timestampX, dateActiveFrom, dateActiveTo, iblockSectionId, type, available, bundle, quantity, quantityReserved, quantityTrace, canBuyZero, subscribe, vatId, vatIncluded, purchasingPrice, purchasingCurrency, barcodeMulti, weight, length, width, height, measure. Filtering by properties is not supported.

The =, !=, >, >=, <, and <= operators are supported. The in operator is not currently applied: the method returns records without taking this condition into account. The % operator, or logic, and negation are not supported.

The type field supports the =, !=, and in operators. A value other than 3 or 6 does not narrow the selection.

If you pass two conditions with the same operator for one field, the last one is applied

select
array

Array of parent product fields to return in the response.

Available fields:

  • id — identifier
  • iblockId — information block identifier
  • name — name
  • code — symbolic code
  • xmlId — external code
  • active — activity
  • sort — sort index
  • createdBy — created by
  • modifiedBy — modified by
  • dateCreate — creation date
  • timestampX — modification date
  • dateActiveFrom — activity start
  • dateActiveTo — activity end
  • previewText — preview description
  • previewTextType — preview description type
  • previewPicture — preview picture
  • detailText — detailed description
  • detailTextType — detailed description type
  • detailPicture — detail picture
  • iblockSectionId — main section
  • iblockSection — all sections
  • type — product type
  • available — availability for purchase
  • bundle — bundle flag
  • quantity — quantity
  • quantityReserved — reserved quantity
  • quantityTrace — quantity tracking
  • canBuyZero — purchase when out of stock
  • subscribe — subscription
  • vatId — VAT rate
  • vatIncluded — VAT included in the price
  • purchasingPrice — purchase price
  • purchasingCurrency — purchase price currency
  • barcodeMulti — unique barcodes
  • weight — weight
  • length — length
  • width — width
  • height — height
  • measure — unit of measurement
  • recurSchemeLength — payment period length
  • recurSchemeType — payment period unit
  • trialPriceId — product for trial payment
  • withoutOrder — renewal without an order
  • quantityTraceRaw — saved quantity tracking value
  • paymentType — payment type
  • subscribeRaw — saved subscription value
  • canBuyZeroRaw — saved value of purchase when out of stock
  • properties — property values

Specify id in select: without it, the method currently returns the INTERNAL_SERVER_ERROR error with HTTP status 500. The ["*"] and PROPERTY_{id} values are not supported: property values are returned by the properties field.

Default: all fields except properties. To retrieve property values, pass properties in select

order
object

Sorting in the {"field": "direction"} format, for example {"id": "desc"}.

Possible direction values:

  • asc — ascending
  • desc — descending

You can sort by the fields: id, iblockId, name, code, xmlId, active, sort, dateCreate, timestampX, dateActiveFrom, dateActiveTo, type, quantity

pagination
object

Pagination. Object description

Parameter pagination

Name
type

Description

limit
integer

Number of records per page. Values greater than 50 are reduced to 50. The 0 value causes an error.

Default: 50

page
integer

Page number, starting from 1

offset
integer

Offset from the beginning of the list. Must be a multiple of limit

A page number beyond the list returns the first page, not an empty array. Do not end the iteration on an empty page: the loop will not stop. If a page has fewer records than limit, it is the last page. If the number of records is a multiple of limit, the next page repeats the first one — compare the identifiers.

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/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 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}")
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or 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();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or 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());
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or 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 and ctx are already created — see the Go SDK section
        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("parsing the response: %w", err)
        }
        for _, item := range result.Items {
        	fmt.Println(item.ID, item.Name, item.Type)
        }
        

Response Handling

HTTP status: 200

{
            "result": {
                "items": [
                    {
                        "id": 7553,
                        "name": "DOCS-V3-SKU Cotton T-shirt",
                        "active": "Y",
                        "type": 3
                    }
                ]
            },
            "time": {
                "start": 1792660767,
                "finish": 1792660767.794007,
                "duration": 0.7940070629119873,
                "processing": 0,
                "date_start": "2026-10-22T12:19:27+02:00",
                "date_finish": "2026-10-22T12:19:27+02:00",
                "operating_reset_at": 1792660860,
                "operating": 0.10251188278198242
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with the response data

result.items
array

Array of parent products. The set of fields depends on select. Field description

time
time

Information about the request execution time

Items Element

Name
type

Description

id
integer

Parent product identifier

iblockId
integer

Identifier of the product catalog information block

name
string

Parent product name

code
string or null

Symbolic code

xmlId
string

External code. If not set, it matches id

active
string

Activity: Y — active, N — inactive

sort
integer

Sort index

createdBy
integer

Identifier of the user who created the record

modifiedBy
integer

Identifier of the user who last modified the record

dateCreate
datetime

Creation date and time

timestampX
datetime

Date and time of the last modification

dateActiveFrom
datetime or null

Activity start date

dateActiveTo
datetime or null

Activity end date

previewText
string or null

Preview description

previewTextType
string

Preview description type: text or html

previewPicture
string or null

Preview picture file identifier

detailText
string or null

Detailed description

detailTextType
string

Detailed description type: text or html

detailPicture
string or null

Detail picture file identifier

iblockSectionId
integer or null

Main section identifier

iblockSection
array

Array of identifiers of all sections the product is linked to

type
integer

Product type: 3 — parent product with variations, 6 — without variations

available
string

Availability for purchase: Y — available, N — unavailable

bundle
string

Whether the product has a bundle: Y — yes, N — no

quantity
double

Available quantity

quantityReserved
double

Reserved quantity

quantityTrace
string

Whether quantity tracking is enabled: Y — yes, N — no

canBuyZero
string

Whether purchase is allowed when the product is out of stock: Y — yes, N — no

subscribe
string

Whether subscription to the product is allowed: Y — yes, N — no

vatId
integer or null

VAT rate identifier

vatIncluded
string

Whether VAT is included in the price: Y — yes, N — no

purchasingPrice
double or null

Purchase price. Returned if the user has the "View purchase price" access permission

purchasingCurrency
string or null

Purchase price currency. Returned if the user has the "View purchase price" access permission

barcodeMulti
string

Unique barcodes for each item: Y — yes, N — no

weight
double or null

Weight

length
double or null

Length

width
double or null

Width

height
double or null

Height

measure
integer or null

Unit of measurement identifier

recurSchemeLength
integer or null

Payment period length. Used only in the on-premise version for content sales

recurSchemeType
string

Time unit of the payment period. Used only in the on-premise version for content sales

trialPriceId
integer or null

Product for trial payment. Used only in the on-premise version for content sales

withoutOrder
string

Renewal without placing an order: Y — yes, N — no. Used only in the on-premise version for content sales

quantityTraceRaw
string

Saved quantity tracking value: Y — yes, N — no, D — according to the module settings

paymentType
string

Payment type: S — one-time, R — recurring, T — trial. Used only in the on-premise version for content sales

subscribeRaw
string

Saved subscription value: Y — yes, N — no, D — according to the module settings

canBuyZeroRaw
string

Saved value of purchase when out of stock: Y — yes, N — no, D — according to the module settings

properties
object

Product property values. The keys are PROPERTY_{id}, where {id} is the property identifier. The value is null, a {"VALUE": ..., "VALUE_ID": ...} object, or an array of such objects for a multiple property

The total number of records is not returned in the response.

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "Iblock Not Found",
                        "field": "200040300000"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

200040300000

Iblock Not Found

Pass the iblockId condition with the identifier of an existing catalog in filter

-

productType is not allowed for this catalog

Pass the product catalog information block in iblockId

-

The type field supports only the =, != and in filter operators

Use the =, !=, or in operators for type

#FIELD#

DTO ProductDto in field #FIELD# requires attribute Filterable to perform this request

Filter only by the fields from the filter parameter description

#FIELD#

DTO ProductDto in field #FIELD# requires attribute Sortable to perform this request

Sort only by the fields from the order parameter description

-

pagination.offset must be a non-negative multiple of pagination.limit

Pass an offset that is a multiple of limit, or use page

Filter Operator Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNFILTEROPERATOREXCEPTION

Field

Error description

How to Fix

filter

Unknown filter operator #OPERATOR#

Use the =, !=, >, >=, <, <= operators

Pagination Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Field

Error description

How to Fix

pagination

Incorrect pagination parameter value: #PAGINATION#

Pass a limit greater than 0

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

select, filter, order

Unknown field #FIELD# found in entity ProductDto

Specify only the fields from the parameter descriptions. PROPERTY_{id} keys are not supported

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field

Error description

How to Fix

-

Access denied

Check the user's permissions for the catalog and the information block

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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