Get Product by ID catalog.product.get
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
This method retrieves information about a product in the trade catalog by its ID.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Product identifier. To obtain product identifiers, use catalog.product.list |
Working with Product Price
To get product prices, use the methods catalog.price.*.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1243}' \
https://**put_your_bitrix24_address**/rest/**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":1243,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.product.get
// 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
// Shape of the payload returned in result (match the "response handling" section of the page)
type ProductGetResult = {
product: {
id: number
name: string
active: string
available: string
bundle: string
canBuyZero: string
code: string
sort: number
iblockId: number
iblockSectionId: number
type: number
vatId: number
vatIncluded: string
weight: number
width: number
height: number
length: number
measure: number
quantity: number
quantityReserved: number
quantityTrace: string
purchasingPrice: string
purchasingCurrency: string
subscribe: string
xmlId: string
createdBy: number
modifiedBy: number
dateCreate: ISODate | null
dateActiveFrom: ISODate | null
dateActiveTo: ISODate | null
timestampX: ISODate | null
detailPicture: { id: string; url: string; urlMachine: string } | null
previewPicture: { id: string; url: string; urlMachine: string } | null
detailText: string | null
detailTextType: string
previewText: string | null
previewTextType: string
}
}
try {
const response = await $b24.actions.v2.call.make<ProductGetResult>({
method: 'catalog.product.get',
params: {
id: 1243,
},
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(result.product.id, result.product.name, result.product.active)
}
} 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 getProduct() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.product.get',
params: {
id: 1243,
},
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(result.product.id, result.product.name, result.product.active)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getProduct)
</script>
try {
$productId = 123; // Replace with the actual product ID you want to retrieve
$productResult = $serviceBuilder->getCatalogScope()
->product()
->get($productId);
$itemResult = $productResult->product();
print("Active: " . ($itemResult->active ? 'Yes' : 'No') . PHP_EOL);
print("Available: " . ($itemResult->available ? 'Yes' : 'No') . PHP_EOL);
print("Bundle: " . ($itemResult->bundle ? 'Yes' : 'No') . PHP_EOL);
print("Code: " . $itemResult->code . PHP_EOL);
print("Created By: " . $itemResult->createdBy . PHP_EOL);
print("Date Active From: " . ($itemResult->dateActiveFrom ? $itemResult->dateActiveFrom->format(DATE_ATOM) : 'N/A') . PHP_EOL);
print("Date Active To: " . ($itemResult->dateActiveTo ? $itemResult->dateActiveTo->format(DATE_ATOM) : 'N/A') . PHP_EOL);
print("Date Created: " . $itemResult->dateCreate->format(DATE_ATOM) . PHP_EOL);
print("Name: " . $itemResult->name . PHP_EOL);
print("ID: " . $itemResult->id . PHP_EOL);
print("Iblock ID: " . $itemResult->iblockId . PHP_EOL);
print("Iblock Section ID: " . $itemResult->iblockSectionId . PHP_EOL);
print("Modified By: " . $itemResult->modifiedBy . PHP_EOL);
print("Timestamp: " . $itemResult->timestampX->format(DATE_ATOM) . PHP_EOL);
print("XML ID: " . $itemResult->xmlId . PHP_EOL);
} catch (Throwable $e) {
print("An error occurred: " . $e->getMessage() . PHP_EOL);
}
BX24.callMethod(
'catalog.product.get',
{
'id': 1243
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.product.get',
[
'id' => 1243
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"product": {
"active": "Y",
"available": "Y",
"bundle": "N",
"canBuyZero": "Y",
"code": "Product",
"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": "6455",
"url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6455\u0026fields%5BproductId%5D=1243",
"urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6455\u0026fields%5BproductId%5D=1243"
},
"detailText": null,
"detailTextType": "text",
"height": 100,
"iblockId": 23,
"iblockSectionId": 47,
"id": 1243,
"length": 100,
"measure": 5,
"modifiedBy": 1,
"name": "Product",
"previewPicture": {
"id": "6454",
"url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6454\u0026fields%5BproductId%5D=1243",
"urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6454\u0026fields%5BproductId%5D=1243"
},
"previewText": null,
"previewTextType": "text",
"property258": {
"value": "test",
"valueId": "9743"
},
"property259": [
{
"value": "test1",
"valueId": "9744"
},
{
"value": "test2",
"valueId": "9745"
}
],
"purchasingCurrency": "EUR",
"purchasingPrice": "1000.000000",
"quantity": 10,
"quantityReserved": 1,
"quantityTrace": "Y",
"sort": 100,
"subscribe": "Y",
"timestampX": "2024-06-06T16:45:35+02:00",
"type": 1,
"vatId": 1,
"vatIncluded": "Y",
"weight": 100,
"width": 100,
"xmlId": "1243"
}
},
"time": {
"start": 1717745698.684563,
"finish": 1717745699.571344,
"duration": 0.8867809772491455,
"processing": 0.47261500358581543,
"date_start": "2024-06-07T10:34:58+02:00",
"date_finish": "2024-06-07T10:34:59+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
product |
Object containing product information |
|
time |
Information about the request execution time |
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 |
|
|
The information block with the specified identifier does not exist |
|
|
Insufficient rights to read the information block element |
|
|
Insufficient rights to read the trade catalog |
|
|
The |
|
|
The product does not exist |
|
|
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 |