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

List offers

GET /v1/catalog-offers

Returns product offers from the offer catalog with support for filtering, sorting, field selection, and pagination.

Requires the filter[iblockId] filter — the offer catalog ID. Without this filter, the request is rejected with 400.

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.

Parameters

Parameter Type Required Default Description
Parameterfilter Typeobject Requiredyes Default— DescriptionFiltering by the fields of GET /v1/catalog-offers/fields. The filter[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 filter[parentId] with an ID from GET /v1/catalog-skus. filter[type] accepts one exact value: 4 or 5.
Filtering syntax. Example: ?filter[iblockId]=27&filter[parentId]=7189
Parameterselect Typestring Requiredno Default— DescriptionComma-separated field selection: ?select=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. A catalog property is requested by its own name: ?select=iblockId,id,name,property909
Parametersort Typestring Requiredno Default— DescriptionSort field. The - prefix means descending: ?sort=-id
Parameterlimit Typenumber Requiredno Default50 DescriptionNumber of records (up to 5000)
Parameteroffset Typenumber Requiredno Default0 DescriptionOffset from the start of the selection

For limit > 50, the response is automatically assembled from several pages on the server side. The maximum is 5000 records per call. If more records match the filter than were returned, meta.hasMore is true.

Examples

curl — personal key

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/catalog-offers?filter[iblockId]=27&filter[parentId]=7189&limit=10" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/catalog-offers?filter[iblockId]=27&filter[parentId]=7189&limit=10" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const params = new URLSearchParams({
  'filter[iblockId]': '27',
  'filter[parentId]': '7189',
  limit: '10',
})
const res = await fetch(`https://vibecode.bitrix24.com/v1/catalog-offers?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

JavaScript — OAuth application

javascript 
const params = new URLSearchParams({
  'filter[iblockId]': '27',
  'filter[parentId]': '7189',
  limit: '10',
})
const res = await fetch(`https://vibecode.bitrix24.com/v1/catalog-offers?${params}`, {
  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 offers. For the fields of each item, see Offer fields
Fieldmeta.total Typenumber DescriptionTotal number of records matching the filter
Fieldmeta.hasMore Typeboolean DescriptionWhether there are more records beyond limit
Fieldmeta.warnings Typearray DescriptionWarnings. Present when select carries a name that cannot be selected: an item with code: UNKNOWN_SELECT_FIELD names it in field. The request still runs, and the name is absent from the response

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
  }
}

Error response example

400 — the required filter was not passed:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FILTER",
    "message": "GET /v1/catalog-offers requires filter fields: iblockId. Example: GET /v1/catalog-offers?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 call example
HTTP400 CodeUNSUPPORTED_FILTER Descriptionfilter[type] carries a value other than 4 or 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)
HTTP422 CodeBITRIX_ERROR Descriptionfilter[iblockId] carries the ID of a product catalog rather than an offer catalog (productType is not allowed for this catalog)
HTTP422 CodeBITRIX_ERROR DescriptionNo catalog exists with the specified iblockId (iblock is not catalog)
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.

Known specifics

parentId is an object in the response and a number in the filter. In data items, the link to the parent product arrives as an object: value is the parent product ID as a string, valueId is the internal ID of the link value. To select offers, pass the parent product ID itself in filter[parentId]. For an offer without a parent product, parentId is null.

See also