Получить товар по идентификатору catalog.product.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: администратор
Метод получает информацию о товаре торгового каталога по его ID.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
Идентификатор товара. Для получения идентификаторов товаров необходимо использовать catalog.product.list |
Работа с ценой товара
Чтобы получить цены товара, используйте методы catalog.price.*.
Примеры кода
Как использовать примеры в документации
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>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"product": {
"active": "Y",
"available": "Y",
"bundle": "N",
"canBuyZero": "Y",
"code": "Tovar",
"createdBy": 1,
"dateActiveFrom": "2024-05-28T10:00:00+03:00",
"dateActiveTo": "2024-05-29T10:00:00+03:00",
"dateCreate": "2024-05-27T10:00:00+03: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": "Товар",
"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": "RUB",
"purchasingPrice": "1000.000000",
"quantity": 10,
"quantityReserved": 1,
"quantityTrace": "Y",
"sort": 100,
"subscribe": "Y",
"timestampX": "2024-06-06T16:45:35+03: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+03:00",
"date_finish": "2024-06-07T10:34:59+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
product |
Объект с информацией о товаре |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":200040300010,
"error_description":"Access Denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Информационный блок с указанным идентификатором не существует |
|
|
Недостаточно прав для чтения элемента информационного блока |
|
|
Недостаточно прав для чтения торгового каталога |
|
|
Не указан параметр |
|
|
Товар не существует |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |