لوكلاء AI: ملف markdown لهذه الصفحة — /docs-content-en/entities/catalogs.md فهرس التوثيق — /llms.txt

مقالات التوثيق متاحة حاليًا باللغة الإنجليزية فقط.

Catalogs

Commercial catalogs of your Bitrix24 account: list, retrieve and filter. A catalog defines the iblockId used by products, sections and prices. Catalogs are read-only.

Bitrix24 API: catalog.catalog.* Scope: catalog

List of catalogs

GET /v1/catalogs

Returns a list of the Bitrix24 account's product catalogs with support for filtering, sorting and field selection.

Parameters

Parameter Type Default Description
Parameterlimit Typenumber Default50 DescriptionNumber of records (up to 5000). When limit > 50 the response is automatically assembled from several Bitrix24 pages
Parameterselect Typestring Default— DescriptionField selection: ?select=id,name. Only the listed fields are returned
Parametersort Typestring Default— DescriptionSort field. The - prefix means descending: ?sort=-id
Parameterfilter Typeobject Default— DescriptionFiltering by GET /v1/catalogs/fields fields.
Filtering syntax. Example: ?filter[iblockTypeId]=CRM_PRODUCT_CATALOG

Examples

curl — personal key

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

curl — OAuth application

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

const { success, data, meta } = await res.json()
console.log(`Catalogs: ${meta.total}`)

JavaScript — OAuth application

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

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of catalogs (all fields — see Catalog fields)
Fieldmeta.total Typenumber DescriptionTotal number of catalogs matching the filter
Fieldmeta.hasMore Typeboolean DescriptionWhether there are more records beyond limit

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 25,
      "iblockId": 25,
      "iblockTypeId": "CRM_PRODUCT_CATALOG",
      "lid": "s1",
      "name": "CRM product catalog",
      "productIblockId": null,
      "skuPropertyId": null,
      "subscription": "N",
      "vatId": 1,
      "yandexExport": false
    },
    {
      "id": 27,
      "iblockId": 27,
      "iblockTypeId": "CRM_PRODUCT_CATALOG",
      "lid": "s1",
      "name": "CRM product catalog (offers)",
      "productIblockId": 25,
      "skuPropertyId": 101,
      "subscription": "N",
      "vatId": 1,
      "yandexExport": false
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false
  }
}

Error response example

400 — filter by a non-existent field:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'nonExistentField' for entity 'catalogs'. Available: id, iblockId, iblockTypeId, lid, name, productIblockId, skuPropertyId, subscription, vatId, yandexExport"
  }
}

Errors

HTTP Code Description
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionFilter by a field the catalog does not have. The message contains the list of available fields
HTTP400 CodeUNKNOWN_SORT_FIELD DescriptionSort by a field the catalog does not have
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the catalog scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not provided
HTTP429 CodeRATE_LIMITED DescriptionRate limit exceeded: 300 requests per minute per portal, all API keys of the portal share one limit. The exact value arrives in the x-ratelimit-limit header (the cap is divided across replicas). Retry after the delay in the Retry-After header

Full list of common API errors — Errors.

Known specifics

Products catalog or offers catalog. The catalog type in the output is visible from the productIblockId and skuPropertyId fields: in a base products catalog both are null; in an offers catalog they are populated, where productIblockId is the iblockId of the linked products catalog.

When to use search instead of list: for conditions across multiple fields it is more convenient to use POST /v1/catalogs/search — the filter is passed in the request body.

See also