## Search products

`POST /v1/catalog-products/search`

Search catalog products by the conditions passed in the request body.

Unlike [`GET /v1/catalog-products`](./list.md), 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.

## Request fields (body)

| Parameter | Type | Req. | Default | Description |
|----------|-----|:-----:|-----------|---------|
| `filter` | object | yes | — | Filtering conditions. The `iblockId` key is required — the catalog ID from [`GET /v1/catalogs`](/docs/entities/catalogs).<br>[Filtering syntax](/docs/filtering). Example: `{ "iblockId": 25, "active": true }` |
| `select` | string[] | no | — | Field selection: `["iblockId", "id", "name"]`. If the parameter is passed, it must include `iblockId`. Without `select`, all product fields are returned |
| `sort` | string | no | — | Sort field. The `-` prefix means descending: `"-id"` |
| `limit` | number | no | `50` | Number of records (up to 5000) |
| `offset` | number | no | `0` | Offset from the start of the result set. Together with a date-range filter wider than 14 days it is rejected — see `UNSTABLE_OFFSET_PAGINATION` in the "Errors" section |
| `autoWindow` | boolean | no | `true` | Split the result set into weekly windows when filtering by a date range wider than 14 days. `false` disables splitting |

## Examples

### curl — personal key

```bash
curl -X POST "https://vibecode.bitrix24.com/v1/catalog-products/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25, "active": true },
    "limit": 3
  }'
```

### curl — OAuth application

```bash
curl -X POST "https://vibecode.bitrix24.com/v1/catalog-products/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25, "active": true },
    "limit": 3
  }'
```

### JavaScript — personal key

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

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-products/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, active: true },
    limit: 3,
  }),
})

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

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | array | Array of products. For the fields of each item, see [Product fields](./fields.md) |
| `meta.total` | number | Total number of records matching the filter |
| `meta.hasMore` | boolean | Whether there are more records beyond `limit` |
| `meta.durationMs` | number | Request execution time in milliseconds |
| `meta.autoWindowed` | boolean | `true` if the result set was split into time windows |
| `meta.windowCount` | number | Number of windows. Present with `autoWindowed: true` |
| `meta.batchWaves` | number | Number of parallel request waves. Present with `autoWindowed: true` |

The `meta` fields sit next to `data`, not inside it. Pages must be walked by `meta.hasMore`: a `data` length equal to `limit` does not rule out the last page.

The card URL of any product from the `data` array is built from its `iblockId` and `id`:

```
https://<portal>.bitrix24.com/shop/catalog/<iblockId>/product/<id>/
```

`<portal>` is the Bitrix24 account domain. Access is restricted by the employee's permissions in Bitrix24.

## Response example

```json
{
  "success": true,
  "data": [
    {
      "id": 6975,
      "iblockId": 25,
      "iblockSectionId": null,
      "name": "Delivery service",
      "active": true,
      "available": true,
      "barcodeMulti": false,
      "bundle": false,
      "canBuyZero": true,
      "measure": 9,
      "purchasingCurrency": null,
      "purchasingPrice": null,
      "quantity": 1,
      "quantityTrace": false,
      "subscribe": false,
      "vatIncluded": false,
      "weight": null,
      "withoutOrder": false,
      "dateCreate": "2025-12-02T09:14:05.000Z",
      "timestampX": "2025-12-02T09:14:05.000Z"
    }
  ],
  "meta": {
    "total": 19,
    "hasMore": true,
    "durationMs": 540
  }
}
```

With a date-range filter wider than 14 days, `meta` additionally returns `autoWindowed`, `windowCount`, and `batchWaves`:

```json
{
  "success": true,
  "data": [ /* ... */ ],
  "meta": {
    "total": 19,
    "hasMore": true,
    "autoWindowed": true,
    "windowCount": 131,
    "batchWaves": 3,
    "durationMs": 8745
  }
}
```

## Error response example

400 — the required filter was not passed:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FILTER",
    "message": "POST /v1/catalog-products/search requires filter fields: iblockId. Example body: { \"filter\": {\"iblockId\":\"...\"} }"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `MISSING_REQUIRED_FILTER` | The required `filter.iblockId` filter was not passed. The request is rejected before Bitrix24 is called — the message contains the name of the missing field and a request body example |
| 422 | `BITRIX_ERROR` | `select` was passed without `iblockId` (`Required select fields: iblockId`) |
| 400 | `UNKNOWN_FILTER_FIELD` | Filtering by a field the product does not have. The message contains the list of available fields |
| 400 | `UNKNOWN_SORT_FIELD` | Sorting by a field the product does not have. The message contains the list of available fields |
| 400 | `UNSTABLE_OFFSET_PAGINATION` | `offset` greater than zero together with a date-range filter wider than 14 days. Two different retrieval algorithms produce inconsistent results, so the request is rejected. Take everything in a single request with `limit` up to 5000, or pass `autoWindow: false` with sorting by `id`, or split the date range into parts yourself |
| 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](/docs/errors).

## Known specifics

**Time-window splitting.** A date-range filter wider than 14 days is automatically split into weekly windows executed in parallel waves, so the result set bypasses the ceiling of 5000 records per call. `meta` then returns `autoWindowed: true`, the number of windows `windowCount`, and the number of waves `batchWaves`. The `autoWindow: false` parameter disables splitting. While splitting is active, an `offset` greater than zero is rejected with `UNSTABLE_OFFSET_PAGINATION`.

## See also

- [List products](/docs/entities/catalog-products/list)
- [Create a product](/docs/entities/catalog-products/create)
- [Get a product](/docs/entities/catalog-products/get)
- [Product fields](/docs/entities/catalog-products/fields)
- [Filtering syntax](/docs/filtering)
- [Entity reference](/docs/entities-index)