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

Search offers

POST /v1/catalog-offers/search

Search product offers using the conditions passed in the request body.

Unlike GET /v1/catalog-offers, 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 Required Default Description
filter object yes — Filtering by the fields of GET /v1/catalog-offers/fields. The iblockId key is required — the offer catalog ID from GET /v1/catalogs; this catalog has productIblockId filled in. Offers of one parent product are selected by parentId with an ID from GET /v1/catalog-skus. type accepts one exact value: 4 or 5.
Filtering syntax. Example: { "iblockId": 27, "parentId": 7189 }
select string[] no — Field selection: ["iblockId", "id", "name", "parentId"]. If the parameter is passed, it must include iblockId and id. Without select, the response carries a reduced set of fields: the symbolic code, dimensions, texts, images, and catalog properties are returned only when listed explicitly — Offer fields lists which ones
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. Combined with a date-range filter wider than 14 days, the request 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

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/catalog-offers/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 27, "parentId": 7189 },
    "limit": 10
  }'

curl — OAuth application

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/catalog-offers/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 27, "parentId": 7189 },
    "limit": 10
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-offers/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 27, parentId: 7189 },
    limit: 10,
  }),
})

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-offers/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 27, parentId: 7189 },
    limit: 10,
  }),
})

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

Response fields

Field Type Description
success boolean Always true on success
data array Array of offers. For the fields of each item, see Offer fields
meta.total number Number of records that matched the filter
meta.hasMore boolean Whether there are more records beyond limit
meta.durationMs number Request duration 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. Paginate using meta.hasMore: a data length equal to limit does not rule out the last page.

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "active": true,
      "available": true,
      "barcodeMulti": false,
      "bundle": false,
      "canBuyZero": true,
      "createdBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T18:41:55.000Z",
      "iblockId": 27,
      "iblockSectionId": null,
      "id": 7191,
      "measure": 9,
      "modifiedBy": 1295,
      "name": "Basic T-shirt, size M",
      "parentId": { "value": "7189", "valueId": "3895" },
      "purchasingCurrency": "USD",
      "purchasingPrice": 450,
      "quantity": null,
      "quantityTrace": true,
      "subscribe": true,
      "timestampX": "2026-10-08T18:41:55.000Z",
      "type": 4,
      "vatIncluded": false,
      "weight": null,
      "withoutOrder": false
    },
    {
      "active": true,
      "available": true,
      "barcodeMulti": false,
      "bundle": false,
      "canBuyZero": true,
      "createdBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T18:41:56.000Z",
      "iblockId": 27,
      "iblockSectionId": null,
      "id": 7193,
      "measure": 9,
      "modifiedBy": 1295,
      "name": "Basic T-shirt, size L",
      "parentId": { "value": "7189", "valueId": "3897" },
      "purchasingCurrency": "USD",
      "purchasingPrice": 490,
      "quantity": 10,
      "quantityTrace": true,
      "subscribe": true,
      "timestampX": "2026-10-08T18:41:56.000Z",
      "type": 4,
      "vatIncluded": false,
      "weight": null,
      "withoutOrder": false
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false,
    "durationMs": 474
  }
}

Error response example

400 — the required filter was not passed:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FILTER",
    "message": "POST /v1/catalog-offers/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
400 UNSUPPORTED_FILTER filter.type carries a value other than 4 and 5, an array, or an operator
400 UNKNOWN_FILTER_FIELD Filtering by a field the offer does not have. The message contains the list of available fields
400 UNKNOWN_SORT_FIELD Sorting by a field the offer 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. Fetch 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
422 BITRIX_ERROR select does not include iblockId (Required select fields: iblockId)
422 BITRIX_ERROR select does not include id (Required select fields: id)
403 SCOPE_DENIED The API key does not have the catalog scope
401 MISSING_API_KEY The X-Api-Key header was not passed
429 RATE_LIMITED Rate 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

Time-window splitting. A date-range filter wider than 14 days, for example "dateCreate": { "$gte": "2023-01-01T00:00:00Z", "$lte": "2026-10-09T00:00:00Z" }, is automatically split into weekly windows executed in parallel waves. 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