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 Required Description
Parameterid (path) Typenumber Requiredyes DescriptionPrice record identifier

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/catalog-prices/383" \
  -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/383', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

JavaScript — OAuth application

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

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionThe price record with all its fields — Price fields
Fielddata.id Typenumber DescriptionPrice record identifier
Fielddata.catalogGroupId Typenumber DescriptionPrice type. The number depends on the Bitrix24 account — see price types
Fielddata.currency Typestring DescriptionPrice currency, e.g. USD
Fielddata.price Typenumber DescriptionPrice value
Fielddata.productId Typenumber DescriptionIdentifier of the product the price belongs to
Fielddata.quantityFrom Typenumber | null DescriptionLower bound of the quantity range. null if the price does not depend on quantity
Fielddata.quantityTo Typenumber | null DescriptionUpper bound of the quantity range. null if the price does not depend on quantity
Fielddata.extraId Typenumber | null DescriptionMarkup identifier (catalog_extra). Deprecated Bitrix24 field
Fielddata.priceScale Typenumber DescriptionPrice in the Bitrix24 account's base currency
Fielddata.timestampX Typestring DescriptionLast modification date (ISO 8601)

Response example

JSON 
{
  "success": true,
  "data": {
    "catalogGroupId": 1,
    "currency": "USD",
    "extraId": null,
    "id": 383,
    "price": 10,
    "priceScale": 10,
    "productId": 533,
    "quantityFrom": null,
    "quantityTo": null,
    "timestampX": "2021-09-27T13:32:20.000Z"
  }
}

Error response example

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

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

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionA price record with the given id does not exist. The message echoes Bitrix24's own words verbatim: price does not exist.
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the catalog scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

The full list of common API errors — Errors.

See also