Получить цену

GET /v1/catalog-prices/:id

Возвращает одну запись цены товара по идентификатору.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор записи цены

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-prices/5001" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

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

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

const { success, data } = await res.json()
console.log('Цена:', data.price, data.currency)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор записи цены
data.catalogGroupId number Тип цены. Базовая цена — 1
data.currency string Валюта цены, например RUB
data.price number Значение цены
data.productId number Идентификатор товара, к которому относится цена
data.quantityFrom number | null Нижняя граница количественного диапазона. null, если цена не зависит от количества
data.quantityTo number | null Верхняя граница количественного диапазона. null, если цена не зависит от количества
data.extraId number | null Дополнительный идентификатор записи
data.priceScale number Цена в базовой валюте портала
data.timestampX string Дата последнего изменения (ISO 8601)

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

JSON 
{
  "success": true,
  "data": {
    "catalogGroupId": 2,
    "currency": "RUB",
    "extraId": null,
    "id": 5001,
    "price": 50,
    "priceScale": 50,
    "productId": 101,
    "quantityFrom": null,
    "quantityTo": null,
    "timestampX": "2024-06-17T16:53:24+03:00"
  }
}

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

422 — записи с таким id нет:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "price does not exist."
  }
}

Ошибки

HTTP Код Описание
422 BITRIX_ERROR Записи цены с указанным id не существует
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 TOKEN_MISSING Не передан заголовок X-Api-Key

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

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