Get Product by ID v 3.0 catalog.product.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" 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 catalog.product.get method returns product fields by identifier.

The method returns a product of any type: a simple product, a product with variations, a variation, or a service. The product type is returned in the type field.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Product identifier.

The identifier can be retrieved using the catalog.product.list method

select
array

An array of product fields to return in the response.

Available fields:

id — product identifier
iblockId — information block identifier
name — name
code — symbolic code
xmlId — external code
active — activity
sort — sort order
createdBy — created by
modifiedBy — modified by
dateCreate — creation date
timestampX — modification date
dateActiveFrom — activity start
dateActiveTo — activity end
previewText — preview text
previewTextType — preview text type
previewPicture — preview picture
detailText — detail text
detailTextType — detail text 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 to the product
vatId — VAT rate
vatIncluded — VAT included in the price
purchasingPrice — purchase price
purchasingCurrency — purchase price currency
barcodeMulti — barcode for each item
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 tracking mode
paymentType — payment type
subscribeRaw — saved subscription permission
canBuyZeroRaw — saved permission to purchase when out of stock
properties — values of all product properties

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

Default: all fields

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":7549,"select":["id","iblockId","name","code","active","iblockSectionId","type","vatId","measure"]}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":7549,"select":["id","iblockId","name","code","active","iblockSectionId","type","vatId","measure"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.product.get

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type ProductGetResult = {
          item: {
            id?: number
            iblockId?: number
            name?: string
            code?: string | null
            active?: 'Y' | 'N'
            iblockSectionId?: number | null
            type?: number
            vatId?: number | null
            measure?: number | null
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<ProductGetResult>({
            method: 'catalog.product.get',
            params: {
              id: 7549,
              select: ['id', 'iblockId', 'name', 'code', 'active', 'iblockSectionId', 'type', 'vatId', 'measure'],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Product:', result.item.id, result.item.name)
          }
        } 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 productGet() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.product.get',
                params: {
                  id: 7549,
                  select: ['id', 'iblockId', 'name', 'code', 'active', 'iblockSectionId', 'type', 'vatId', 'measure'],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Product:', result.item.id, result.item.name)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', productGet)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.product.get(
                bitrix_id=7549,
                select=["id", "iblockId", "name", "code", "active", "iblockSectionId", "type", "vatId", "measure"],
            ).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.get',
                    [
                        'id' => 7549,
                        'select' => ['id', 'iblockId', 'name', 'code', 'active', 'iblockSectionId', 'type', 'vatId', 'measure'],
                    ]
                );
        
            $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.get',
            {
                id: 7549,
                select: ['id', 'iblockId', 'name', 'code', 'active', 'iblockSectionId', 'type', 'vatId', 'measure'],
            },
            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.get',
            [
                'id' => 7549,
                'select' => ['id', 'iblockId', 'name', 'code', 'active', 'iblockSectionId', 'type', 'vatId', 'measure'],
            ]
        );
        
        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.get", b24.Params{
        	"id":    7549,
        	"select":[]string{"id", "iblockId", "name", "code", "active", "iblockSectionId", "type", "vatId", "measure"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("catalog.product.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("no item key in the response")
        }
        
        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("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name)

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 7549,
                    "iblockId": 25,
                    "name": "Basic T-shirt, white",
                    "code": "tshirt-basic",
                    "active": "Y",
                    "iblockSectionId": 41,
                    "type": 1,
                    "vatId": 1,
                    "measure": 9
                }
            },
            "time": {
                "start": 1792660647,
                "finish": 1792660647.669521,
                "duration": 0.6695210933685303,
                "processing": 0,
                "date_start": "2026-10-22T12:17:27+02:00",
                "date_finish": "2026-10-22T12:17:27+02:00",
                "operating_reset_at": 1792661220,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	An object with the response data
result.item `object`	Product fields. The set of fields depends on `select`. Field description
time `time`	Information about the request execution time

Item Object

Name `type`	Description
id `integer`	Product identifier
iblockId `integer`	Identifier of the trade catalog information block
name `string`	Product name
code `string` or `null`	Symbolic code
xmlId `string`	External code. If not set on creation, it matches `id`
active `string`	Product activity: `Y` — active, `N` — inactive
sort `integer`	Sort order
createdBy `integer`	Identifier of the user who created the product
modifiedBy `integer`	Identifier of the user who last modified the product
dateCreate `datetime`	Creation date and time in ISO 8601 format
timestampX `datetime`	Date and time of the last modification in ISO 8601 format
dateActiveFrom `datetime` or `null`	Activity start date
dateActiveTo `datetime` or `null`	Activity end date
previewText `string` or `null`	Preview text
previewTextType `string`	Preview text type: `text` — text, `html` — HTML
previewPicture `string` or `null`	Identifier of the preview picture file. The file can be retrieved using the catalog.product.download method
detailText `string` or `null`	Detail text
detailTextType `string`	Detail text type: `text` — text, `html` — HTML
detailPicture `string` or `null`	Identifier of the detail picture file. The file can be retrieved using the catalog.product.download method
iblockSectionId `integer` or `null`	Identifier of the product's main section
iblockSection `array`	An array of identifiers of all sections the product is linked to
type `integer`	Product type. The list of types is returned by the catalog.product.type.list method. For a product created with `catalog.product.add`, the value is `1`
available `string`	Availability for purchase: `Y` — available, `N` — unavailable
bundle `string`	Bundle flag: `Y` — yes, `N` — no
quantity `double`	Available quantity
quantityReserved `double`	Reserved quantity
quantityTrace `string`	Effective quantity tracking mode: `Y` — enabled, `N` — disabled
canBuyZero `string`	Effective permission to purchase an out-of-stock product: `Y` — yes, `N` — no
subscribe `string`	Effective permission to subscribe to the product: `Y` — yes, `N` — no
vatId `integer` or `null`	VAT rate identifier
vatIncluded `string`	VAT is included in the price: `Y` — yes, `N` — no
purchasingPrice `double` or `null`	Purchase price
purchasingCurrency `string` or `null`	Purchase price currency
barcodeMulti `string`	Unique barcode for each item: `Y` — yes, `N` — no
weight `double`	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`	Identifier of the 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 value of the quantity tracking mode: `Y`, `N`, or `D` — the value from the module settings
paymentType `string`	Payment type. Used only in the on-premise version for content sales
subscribeRaw `string`	Saved value of the subscription permission: `Y`, `N`, or `D` — the value from the module settings
canBuyZeroRaw `string`	Saved value of the permission to purchase an out-of-stock product: `Y`, `N`, or `D` — the value from the module settings
properties `object`	Product property values. The key is `PROPERTY_{id}`, where `id` is the property identifier. The response contains all properties of the information block. Key value: `null` — the value is not filled in an object `{"VALUE": ..., "VALUE_ID": ...}` — the value of a single property and the identifier of this value an array of such objects — the values of a multiple property For a "File" type property, `VALUE` returns the file identifier

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
                "message": "Entity with ID 99999999 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 integer. The error is also caused by `0` and a string

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	Check the identifier using the catalog.product.list 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. The `PROPERTY_{id}` keys and `*` are not supported

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

HTTP status: 403

Field	Error description	How to Fix
`-`	Access denied	Check the user's permissions to view the catalog and to read the information block element

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

Was the article helpful?

Get product by id

Get list of products by filter

Get Product by ID v 3.0 catalog.product.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Item ObjectItem Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Object Not Found ErrorObject Not Found Error

Unknown Field ErrorUnknown Field Error

Access ErrorAccess Error

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Code Examples

Response Handling

Returned Data

Item Object

Error Handling

Possible Error Codes

Request Validation Errors

Object Not Found Error

Unknown Field Error

Access Error

Statuses and System Error Codes

Continue Learning