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

Search SKUs

POST /v1/catalog-skus/search

Search parent products using the conditions passed in the request body.

Unlike GET /v1/catalog-skus, the filter, select, sort, limit, and offset parameters are passed in the JSON body rather than in the query string — conditions across several fields are expressed as a nested structure. Like the list, search requires filter.iblockId — without this field the request returns 400. The response format is the same as for the list.

The dateCreate, timestampX, dateActiveFrom, and dateActiveTo fields are not accepted in filter: the request returns 400 UNKNOWN_FILTER_FIELD before calling Bitrix24. These dates remain available in select and responses.

Request fields (body)

Parameter	Type	Required	Default	Description
Parameter`filter`	Typeobject	Requiredyes	Default—	DescriptionFiltering conditions. The `iblockId` key is required — the product catalog ID from `GET /v1/catalogs`. The `type` key accepts one exact number: `3` — parent products with offers, `6` — without offers. Filtering syntax. Example: `{ "iblockId": 25, "type": 3 }`
Parameter`select`	Typestring[]	Requiredno	Default—	DescriptionField selection: `["iblockId", "id", "name", "type"]`. If the parameter is passed, it must include `iblockId` and `id`. Without `select`, the response carries a reduced set of fields: the symbolic code, texts, sort order, and external code are returned only when listed explicitly — SKU fields lists which ones. A catalog property is requested by its own name: `["iblockId", "id", "name", "property295"]`
Parameter`sort`	Typestring	Requiredno	Default—	DescriptionSort field. The `-` prefix means descending: `"-id"`
Parameter`limit`	Typenumber	Requiredno	Default`50`	DescriptionNumber of records (up to 5000)
Parameter`offset`	Typenumber	Requiredno	Default`0`	DescriptionOffset from the start of the result set

Examples

curl — personal key

Terminal

curl -X POST "https://vibecode.bitrix24.com/v1/catalog-skus/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25, "type": 3 },
    "sort": "-id",
    "limit": 2
  }'

curl — OAuth application

Terminal

curl -X POST "https://vibecode.bitrix24.com/v1/catalog-skus/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25, "type": 3 },
    "sort": "-id",
    "limit": 2
  }'

JavaScript — personal key

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-skus/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25, type: 3 },
    sort: '-id',
    limit: 2,
  }),
})

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

JavaScript — OAuth application

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-skus/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25, type: 3 },
    sort: '-id',
    limit: 2,
  }),
})

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

Response fields

Field	Type	Description
Field`success`	Typeboolean	DescriptionAlways `true` on success
Field`data`	Typearray	DescriptionArray of parent products. For the fields of each item, see SKU fields
Field`meta.total`	Typenumber	DescriptionNumber of records matching the filter
Field`meta.hasMore`	Typeboolean	DescriptionWhether there are more records beyond `limit`
Field`meta.durationMs`	Typenumber	DescriptionRequest duration in milliseconds
Field`meta.warnings`	Typearray	DescriptionWarnings about `select`. Present when `select` contains a name that is not in the field reference: an item `{ code: "UNKNOWN_SELECT_FIELD", message, field }`, and no value for that name is included in the response

The meta fields sit next to data, not inside it. Paginate using meta.hasMore: a data array whose length equals limit can still be the last page.

Response example

JSON

{
  "success": true,
  "data": [
    {
      "id": 7205,
      "iblockId": 25,
      "iblockSectionId": 19,
      "name": "Basic hoodie",
      "type": 3,
      "active": true,
      "available": true,
      "bundle": false,
      "createdBy": 1295,
      "modifiedBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T18:45:34.000Z",
      "timestampX": "2026-10-08T18:45:36.000Z"
    },
    {
      "id": 7203,
      "iblockId": 25,
      "iblockSectionId": null,
      "name": "Basic T-shirt",
      "type": 3,
      "active": true,
      "available": true,
      "bundle": false,
      "createdBy": 1295,
      "modifiedBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T18:45:34.000Z",
      "timestampX": "2026-10-08T18:45:35.000Z"
    }
  ],
  "meta": {
    "total": 14,
    "hasMore": true,
    "durationMs": 140
  }
}

Error response example

400 — the required filter was not passed: