Получить товар по идентификатору v 3.0 catalog.product.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Просмотр каталога товаров», «Просмотр товаров каталога» или «Изменение цены продажи товара»
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод catalog.product.get возвращает поля товара по идентификатору.
Метод возвращает товар любого типа: простой товар, товар с вариациями, вариацию, услугу. Тип товара приходит в поле type.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор товара. Идентификатор можно получить методом catalog.product.list |
|
select |
Массив полей товара, которые нужно вернуть в ответе. Доступные поля:
Поле По умолчанию: все поля |
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/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"]}' \
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",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или 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();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или 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());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или 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 и ctx уже созданы — см. раздел «SDK для Go»
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)
}
// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("в ответе нет ключа item")
}
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("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name)
Обработка ответа
HTTP-статус: 200
{
"result": {
"item": {
"id": 7549,
"iblockId": 25,
"name": "Футболка базовая белая",
"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+03:00",
"date_finish": "2026-10-22T12:17:27+03:00",
"operating_reset_at": 1792661220,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
result.item |
Поля товара. Состав зависит от |
|
time |
Информация о времени выполнения запроса |
Объект item
|
Название |
Описание |
|
id |
Идентификатор товара |
|
iblockId |
Идентификатор инфоблока торгового каталога |
|
name |
Название товара |
|
code |
Символьный код |
|
xmlId |
Внешний код. Если не задан при создании, совпадает с |
|
active |
Активность товара: |
|
sort |
Сортировка |
|
createdBy |
Идентификатор пользователя, который создал товар |
|
modifiedBy |
Идентификатор пользователя, который последним изменил товар |
|
dateCreate |
Дата и время создания в формате ISO 8601 |
|
timestampX |
Дата и время последнего изменения в формате ISO 8601 |
|
dateActiveFrom |
Дата начала активности |
|
dateActiveTo |
Дата окончания активности |
|
previewText |
Описание для анонса |
|
previewTextType |
Тип описания для анонса: |
|
previewPicture |
Идентификатор файла картинки для анонса. Файл можно получить методом catalog.product.download |
|
detailText |
Детальное описание |
|
detailTextType |
Тип детального описания: |
|
detailPicture |
Идентификатор файла детальной картинки. Файл можно получить методом catalog.product.download |
|
iblockSectionId |
Идентификатор основного раздела товара |
|
iblockSection |
Массив идентификаторов всех разделов, к которым привязан товар |
|
type |
Тип товара. Список типов возвращает метод catalog.product.type.list. У товара, созданного методом |
|
available |
Доступность для покупки: |
|
bundle |
Признак комплекта: |
|
quantity |
Доступное количество |
|
quantityReserved |
Зарезервированное количество |
|
quantityTrace |
Действующий режим количественного учета: |
|
canBuyZero |
Действующее разрешение покупки при отсутствии товара: |
|
subscribe |
Действующее разрешение подписки на товар: |
|
vatId |
Идентификатор ставки НДС |
|
vatIncluded |
НДС включен в цену: |
|
purchasingPrice |
Закупочная цена |
|
purchasingCurrency |
Валюта закупочной цены |
|
barcodeMulti |
Уникальный штрихкод для каждого экземпляра: |
|
weight |
Вес |
|
length |
Длина |
|
width |
Ширина |
|
height |
Высота |
|
measure |
Идентификатор единицы измерения |
|
recurSchemeLength |
Длина периода оплаты. Используется только в коробочной версии для продажи контента |
|
recurSchemeType |
Единица времени периода оплаты. Используется только в коробочной версии для продажи контента |
|
trialPriceId |
Идентификатор товара для пробной оплаты. Используется только в коробочной версии для продажи контента |
|
withoutOrder |
Продление без оформления заказа: |
|
quantityTraceRaw |
Сохраненное значение режима количественного учета: |
|
paymentType |
Тип оплаты. Используется только в коробочной версии для продажи контента |
|
subscribeRaw |
Сохраненное значение разрешения подписки: |
|
canBuyZeroRaw |
Сохраненное значение разрешения покупки при отсутствии товара: |
|
properties |
Значения свойств товара. Ключ — Значение ключа:
Для свойства типа «Файл» в |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
"message": "Запись с ID = `99999999` не найдена"
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Обязательное поле |
Передайте положительное целое число. Ошибку вызывают также |
Ошибка отсутствия объекта
Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Запись с ID = |
Проверьте идентификатор методом catalog.product.list |
Ошибка неизвестного поля
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Укажите в |
Ошибка доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
HTTP-статус: 403
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
Проверьте права пользователя на просмотр каталога и на чтение элемента инфоблока |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |