#Products

Entity: product | Scope: crm | Base path: /v1/products

Legacy entity (UPPER_CASE field names) — field names are automatically converted to camelCase.

#Operations

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

#Fields

API Name Bitrix24 Name Type Readonly Description
id ID number yes Идентификатор записи
name NAME string
active ACTIVE boolean
price PRICE number
currency CURRENCY_ID string
sectionId SECTION_ID number
catalogId CATALOG_ID number
measure MEASURE number
description DESCRIPTION string
sort SORT number
xmlId XML_ID string
createdAt DATE_CREATE datetime yes Дата создания
updatedAt TIMESTAMP_X datetime yes Дата изменения

#Relations (reference)

Relation Entity Type Foreign Key
section productSection one sectionId

#Aggregatable Fields

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

  • price
  • sectionId
  • catalogId
  • active

#Examples

#List

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

#Get by ID

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

#Create

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

#Update

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

#Delete

Terminal 
curl -X DELETE '/v1/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":"products","action":"list","params":{"limit":5}}]}'