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

Get a price type

GET /v1/catalog-price-types/:id

Returns a single price type by ID, with all its fields.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionPrice type ID

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/catalog-price-types/1" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

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

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

JavaScript — OAuth application

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

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

Response fields

data is the price type object. For the full field list, see Price type fields.

Response example

JSON 
{
  "success": true,
  "data": {
    "base": "Y",
    "createdBy": 1,
    "dateCreate": "2020-04-22T05:37:42.000Z",
    "id": 1,
    "modifiedBy": 1,
    "name": "BASE",
    "sort": 100,
    "timestampX": "2024-10-22T04:31:37.000Z",
    "xmlId": "BASE"
  }
}

Error response example

404 — the Bitrix24 account has no price type with that ID:

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

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionThe portal has no price type with that id. The message echoes Bitrix24's own words verbatim. Price type IDs depend on the portal — check the list
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 refused to read the price type: the key owner has no portal administrator rights
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the catalog scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP429 CodeCALLER_RATE_LIMITED DescriptionThe shared caller limit for this API key or its owner has been reached. The response has Retry-After and X-RateLimit-Scope; it does not expose the effective limit in x-ratelimit-limit
HTTP429 CodeRATE_LIMITED DescriptionBitrix24 refused the request because its own rate limit was reached. Retry after the delay in Retry-After; this response does not report the route limit in x-ratelimit-limit

For the full list of common API errors, see Errors.

Known specifics

A price type ID does not carry over between accounts. The same id on another account refers to a different price type or to none at all. An integration working with several accounts must fetch the list on each of them.

The method requires administrator rights. The catalog scope is not enough: Bitrix24 returns a price type only to a key whose owner has the Bitrix24 account administrator role. Otherwise the API returns 422 BITRIX_ERROR with a Bitrix24 message about insufficient rights.

See also