#Catalog products

Entity: catalogProduct | Scope: catalog | Base path: /v1/catalog-products

SPA entity (camelCase field names) — field names pass through without transformation.

#Operations

Method Path Description Bitrix24 Method
GET /v1/catalog-products List all (with filter, sort, pagination) catalog.product.list
GET /v1/catalog-products/:id Get by ID catalog.product.get
POST /v1/catalog-products Create new catalog.product.add
PATCH /v1/catalog-products/:id Update by ID catalog.product.update
DELETE /v1/catalog-products/:id Delete by ID catalog.product.delete
GET /v1/catalog-products/fields Get available fields catalog.product.getFieldsByFilter

#Fields

API Name Bitrix24 Name Type Readonly Description
id id number yes Идентификатор записи
name name string
active active boolean
iblockId iblockId number
iblockSectionId iblockSectionId number
purchasingPrice purchasingPrice number
purchasingCurrency purchasingCurrency string
quantity quantity number
weight weight number
measure measure number
createdAt timestampX datetime yes Дата создания

#Aggregatable Fields

These fields can be used with the aggregation engine for analytics:

  • purchasingPrice
  • quantity
  • iblockSectionId

#Examples

#List

Terminal 
curl -X GET '/v1/catalog-products?limit=10' \
  -H 'X-Api-Key: YOUR_KEY'

#Get by ID

Terminal 
curl -X GET '/v1/catalog-products/123' \
  -H 'X-Api-Key: YOUR_KEY'

#Create

Terminal 
curl -X POST '/v1/catalog-products' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"value","active":"true","iblockId":1}'

#Update

Terminal 
curl -X PATCH '/v1/catalog-products/123' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"updated"}'

#Delete

Terminal 
curl -X DELETE '/v1/catalog-products/123' \
  -H 'X-Api-Key: YOUR_KEY'

#Batch

Terminal 
curl -X POST '/v1/batch' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"calls":[{"entity":"catalog-products","action":"list","params":{"limit":5}}]}'