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

Get a product

GET /v1/catalog-products/:id

Returns a single catalog product by identifier. The response contains more fields than the list: in addition to the fields from the reference, it returns the symbolic code, dimensions, type, and custom catalog properties.

Parameters

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

Examples

curl — personal key

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

curl — OAuth application

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

const { success, data } = await res.json()
console.log('Product:', data.name)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-products/541', {
  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 object Product object. The base field set — see Product fields

In addition to the reference fields, a single record contains:

  • code — symbolic code
  • sort — sort order
  • type — product type
  • vatId — VAT rate ID
  • quantityReserved — reserved stock
  • weight, width, height, length — product dimensions
  • xmlId — external code
  • custom catalog properties of the form propertyNNN

Fields with an empty value are returned as null.

Response example

The main fields are shown.

JSON 
{
  "success": true,
  "data": {
    "id": 541,
    "iblockId": 25,
    "iblockSectionId": null,
    "name": "USB-C cable",
    "active": true,
    "code": null,
    "measure": 9,
    "weight": null,
    "vatId": 1,
    "vatIncluded": false,
    "available": true,
    "bundle": false,
    "canBuyZero": true,
    "quantityTrace": false,
    "subscribe": true,
    "barcodeMulti": false,
    "withoutOrder": false,
    "purchasingPrice": 110,
    "purchasingCurrency": "USD",
    "quantity": null,
    "quantityReserved": null,
    "sort": 500,
    "type": 1,
    "dateCreate": "2021-08-06T12:59:15.000Z",
    "timestampX": "2025-10-31T10:24:18.000Z",
    "xmlId": "541"
  }
}

Error response example

422 — there is no product with such id:

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

Errors

HTTP Code Description
422 BITRIX_ERROR No product with the specified id exists (product does not exist.)
403 SCOPE_DENIED The API key does not have the catalog scope
401 MISSING_API_KEY The X-Api-Key header was not passed

Full list of common API errors — Errors.

See also