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.

The date fields dateCreate, timestampX, dateActiveFrom, and dateActiveTo are not accepted in a filter: the Bitrix24 method does not apply date filters and would return every offer in the catalog. A request with such a filter is rejected with 400 UNKNOWN_FILTER_FIELD.

Request fields (body)

Parameter Type Required Default Description
Parameterfilter Typeobject Requiredyes Default— DescriptionFiltering 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 }
Parameterselect Typestring[] Requiredno Default— DescriptionField 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
Parametersort Typestring Requiredno Default— DescriptionSort field. The - prefix means descending: "-id"
Parameterlimit Typenumber Requiredno Default50 DescriptionNumber of records (up to 5000)
Parameteroffset Typenumber Requiredno Default0 DescriptionOffset from the start of the result set

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
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of offers. For the fields of each item, see Offer fields
Fieldmeta.total Typenumber DescriptionNumber of records that matched the filter
Fieldmeta.hasMore Typeboolean DescriptionWhether there are more records beyond limit
Fieldmeta.durationMs Typenumber DescriptionRequest duration in milliseconds

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
HTTP400 CodeMISSING_REQUIRED_FILTER DescriptionThe 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
HTTP400 CodeUNSUPPORTED_FILTER Descriptionfilter.type carries a value other than 4 and 5, an array, or an operator
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionFiltering by a field the offer does not have, or by a date field: dateCreate, timestampX, dateActiveFrom, dateActiveTo. The message contains the list of available fields
HTTP400 CodeUNKNOWN_SORT_FIELD DescriptionSorting by a field the offer does not have. The message contains the list of available fields
HTTP422 CodeBITRIX_ERROR Descriptionselect does not include iblockId (Required select fields: iblockId)
HTTP422 CodeBITRIX_ERROR Descriptionselect does not include id (Required select fields: id)
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the catalog scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not passed
HTTP429 CodeRATE_LIMITED DescriptionRate limit exceeded: 300 requests per minute per portal. All API keys of the portal share one limit. The current limit is returned in the x-ratelimit-limit header. Retry after the delay in the Retry-After header

For the full list of common API errors, see Errors.

See also