, настроенные для каталога на портале."> , настроенные для каталога на портале."> , настроенные для каталога на портале.">

Получить товар

GET /v1/products/:id

Возвращает один товар CRM-каталога по идентификатору. В ответ входят базовые поля товара и пользовательские свойства PROPERTY_<N>, настроенные для каталога на портале.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор товара. Список: `GET /v1/products`

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/products/6967" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/products/6967" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/products/6967', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Товар:', data.name, '—', data.price, data.currency)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/products/6967', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект товара: базовые поля — см. Поля товара, плюс пользовательские свойства PROPERTY_<N>

Базовые поля совпадают с элементом массива в `GET /v1/products`. Дополнительно приходят свойства вида PROPERTY_<N> — по одному ключу на каждое свойство каталога. Если значение не заполнено, ключ возвращается со значением null.

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": 6967,
    "name": "Головной товар",
    "code": "product_sku",
    "active": true,
    "previewPicture": null,
    "detailPicture": null,
    "sort": 100,
    "xmlId": "6967",
    "updatedAt": "2025-05-12T09:05:27.000Z",
    "createdAt": "2025-05-12T09:03:15.000Z",
    "modifyBy": 1,
    "createdBy": 1,
    "catalogId": 25,
    "sectionId": null,
    "description": null,
    "descriptionType": "text",
    "price": 100,
    "currency": "RUB",
    "vatId": null,
    "vatIncluded": false,
    "measure": null,
    "PROPERTY_309": null,
    "PROPERTY_295": null,
    "PROPERTY_297": null
  }
}

Пример ответа при ошибке

404 — товар не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Product is not found."
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Товар с таким id не найден
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 MISSING_API_KEY Не передан заголовок X-Api-Key

Полный список общих ошибок API — Ошибки.

Известные особенности

Набор свойств одинаков в пределах каталога. Состав ключей PROPERTY_<N> определяется настройками каталога на портале — у всех товаров одного каталога он совпадает.

Смотрите также