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.

Parameters

Parameter	Type	Required	Default	Description
`filter`	object	yes	—	Filtering 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`
`select`	string	no	—	Comma-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`
`sort`	string	no	—	Sort field. The `-` prefix means descending: `?sort=-id`
`limit`	number	no	`50`	Number of records (up to 5000)
`offset`	number	no	`0`	Offset 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
`success`	boolean	Always `true` on success
`data`	array	Array of offers. For the fields of each item, see Offer fields
`meta.total`	number	Total number of records matching the filter
`meta.hasMore`	boolean	Whether there are more records beyond `limit`
`meta.warnings`	array	Warnings. 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: