For AI agents: markdown of this page — /docs-content-en/entities/catalog-prices/get.md documentation index — /llms.txt

Get a price

GET /v1/catalog-prices/:id

Returns a single product-price record by identifier.

Parameters

Parameter Type Req. Description
id (path) number yes Price record identifier

Examples

curl — personal key

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

curl — OAuth app

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

JavaScript — personal key

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

const { success, data } = await res.json()
console.log('Price:', data.price, data.currency)

JavaScript — OAuth app

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

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

Response fields

Field Type Description
success boolean Always true on success
data.id number Price record identifier
data.catalogGroupId number Price type. Base price is 1
data.currency string Price currency, e.g. USD
data.price number Price value
data.productId number Identifier of the product the price belongs to
data.quantityFrom number | null Lower bound of the quantity range. null if the price does not depend on quantity
data.quantityTo number | null Upper bound of the quantity range. null if the price does not depend on quantity
data.extraId number | null Markup identifier (catalog_extra). Deprecated Bitrix24 field
data.priceScale number Price in the Bitrix24 account's base currency
data.timestampX string Last modification date (ISO 8601)

Response example

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

Error response example

422 — a price record with the given id does not exist:

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

Errors

HTTP Code Description
422 BITRIX_ERROR A price record with the given id does not exist
403 SCOPE_DENIED The API key does not have the catalog scope
401 TOKEN_MISSING The X-Api-Key header was not provided

The full list of common API errors — Errors.

See also