Get Parent Product Field Values v 3.0 catalog.product.sku.get

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.get returns the field values of a parent product by its identifier.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Parent product identifier.

The identifier can be retrieved using the catalog.product.sku.list method or from the catalog.product.sku.add response

select
array

Array of parent product fields to return in the response.

Available fields:

  • id — parent product 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

The id field is returned only if it is specified in select. Values of individual properties cannot be selected: properties returns all properties. The ["*"] value is not supported.

Default: all fields, including properties

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.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":7553,"select":["id","iblockId","name","code","active","type","iblockSectionId","previewText","detailText","detailPicture","dateCreate"]}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.sku.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":7553,"select":["id","iblockId","name","code","active","type","iblockSectionId","previewText","detailText","detailPicture","dateCreate"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.product.sku.get
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type SkuGetResult = {
          item: {
            id: number
            name: string
            type: number
            detailPicture: string | null
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<SkuGetResult>({
            method: 'catalog.product.sku.get',
            params: {
              id: 7553,
              select: ['id', 'iblockId', 'name', 'code', 'active', 'type', 'iblockSectionId', 'previewText', 'detailText', 'detailPicture', 'dateCreate'],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Item:', result.item)
          }
        } 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 getSku() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.product.sku.get',
                params: {
                  id: 7553,
                  select: ['id', 'iblockId', 'name', 'code', 'active', 'type', 'iblockSectionId', 'previewText', 'detailText', 'detailPicture', 'dateCreate'],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Item:', result.item)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getSku)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.product.sku.get(
                id=7553,
                select=["id", "iblockId", "name", "code", "active", "type", "iblockSectionId", "previewText", "detailText", "detailPicture", "dateCreate"],
            ).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.get',
                    [
                        'id' => 7553,
                        'select' => ['id', 'iblockId', 'name', 'code', 'active', 'type', 'iblockSectionId', 'previewText', 'detailText', 'detailPicture', 'dateCreate'],
                    ]
                );
        
            $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.get',
            {
                id: 7553,
                select: ['id', 'iblockId', 'name', 'code', 'active', 'type', 'iblockSectionId', 'previewText', 'detailText', 'detailPicture', 'dateCreate'],
            },
            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.get',
            [
                'id' => 7553,
                'select' => ['id', 'iblockId', 'name', 'code', 'active', 'type', 'iblockSectionId', 'previewText', 'detailText', 'detailPicture', 'dateCreate'],
            ]
        );
        
        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.get", b24.Params{
        	"id": 7553,
        	"select": []string{"id", "iblockId", "name", "code", "active", "type", "iblockSectionId", "previewText", "detailText", "detailPicture", "dateCreate"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("catalog.product.sku.get: %w", err)
        }
        
        // The method wraps the response in an object with the "item" key.
        raw, ok := b24.Unwrap(res.Result, "item")
        if !ok {
        	return fmt.Errorf("the response has no item key")
        }
        
        var item struct {
        	ID   int    `json:"id"`
        	Name string `json:"name"`
        	Type int    `json:"type"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parsing the response: %w", err)
        }
        fmt.Println(item.ID, item.Name, item.Type)
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 7553,
                    "iblockId": 25,
                    "name": "DOCS-V3-SKU Cotton T-shirt",
                    "code": "docs-v3-sku-t-shirt",
                    "active": "Y",
                    "dateCreate": "2026-10-22T12:18:48+02:00",
                    "previewText": "Cotton T-shirt",
                    "detailText": "Composition: 100% cotton",
                    "detailPicture": "39455",
                    "iblockSectionId": 31,
                    "type": 3
                }
            },
            "time": {
                "start": 1792660764,
                "finish": 1792660764.959464,
                "duration": 0.9594640731811523,
                "processing": 0,
                "date_start": "2026-10-22T12:19:24+02:00",
                "date_finish": "2026-10-22T12:19:24+02:00",
                "operating_reset_at": 1792661340,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with the response data

result.item
object

Parent product fields. The set depends on select. Field description

time
time

Information about the request execution time

Item Object

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

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
                "message": "Entity with ID 7533 was not found."
            }
        }
        

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

id

Required field id is missing

Pass a positive number in id

Object Not Found Error

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field

Error description

How to Fix

id

Entity with ID #ID# was not found

The record does not exist or is not a parent product. Retrieve variations using the catalog.product.offer.get method

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

select

Unknown field #FIELD# found in entity ProductDto

Specify in select only the fields from the select parameter description. For property values, use properties

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