Список цен

GET /v1/catalog-prices

Возвращает список цен товаров с поддержкой фильтрации, сортировки, выборки полей и пагинации.

Параметры

Параметр Тип По умолч. Описание
filter object — Фильтрация по полям записи цены.
Синтаксис фильтрации. Пример: ?filter[productId]=101
select string — Выборка полей: ?select=id,productId,price. Возвращаются только перечисленные поля
sort string — Поле сортировки. Префикс - — по убыванию: ?sort=-price
limit number 50 Количество записей (до 5000)
offset number 0 Смещение от начала выборки

Для limit > 50 ответ автоматически собирается из нескольких страниц на стороне сервера. Максимум — 5000 записей за вызов. Если под фильтр попадает больше записей, чем возвращено, в meta.hasMore придёт true.

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-prices" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-prices" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-prices', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-prices', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив цен
data[].id number Идентификатор записи цены
data[].catalogGroupId number Тип цены. Базовая цена — 1
data[].currency string Валюта цены, например RUB
data[].price number Значение цены
data[].productId number Идентификатор товара, к которому относится цена
data[].quantityFrom number | null Нижняя граница количественного диапазона. null, если цена не зависит от количества
data[].quantityTo number | null Верхняя граница количественного диапазона. null, если цена не зависит от количества
data[].extraId number | null Дополнительный идентификатор записи
data[].priceScale number Цена в базовой валюте портала
data[].timestampX string Дата последнего изменения (ISO 8601)
meta.total number Общее количество записей, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

Пример ответа

JSON 
{
  "success": true,
  "data": [
    {
      "catalogGroupId": 2,
      "currency": "RUB",
      "extraId": null,
      "id": 5001,
      "price": 50,
      "priceScale": 50,
      "productId": 101,
      "quantityFrom": null,
      "quantityTo": null,
      "timestampX": "2024-06-17T16:53:24+03:00"
    },
    {
      "catalogGroupId": 1,
      "currency": "RUB",
      "extraId": null,
      "id": 5002,
      "price": 10,
      "priceScale": 10,
      "productId": 102,
      "quantityFrom": null,
      "quantityTo": null,
      "timestampX": "2021-09-27T16:32:20+03:00"
    },
    {
      "catalogGroupId": 1,
      "currency": "RUB",
      "extraId": null,
      "id": 5003,
      "price": 32999,
      "priceScale": 32999,
      "productId": 103,
      "quantityFrom": null,
      "quantityTo": null,
      "timestampX": "2025-01-10T14:49:59+03:00"
    }
  ],
  "meta": {
    "total": 85,
    "hasMore": true
  }
}

Пример ответа при ошибке

400 — фильтр по несуществующему полю:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'bogusField' for entity 'catalog-prices'. Available: id, catalogGroupId, currency, price, productId, quantityFrom, quantityTo"
  }
}

Ошибки

HTTP Код Описание
400 UNKNOWN_FILTER_FIELD Фильтр по полю, которого нет у записи цены. Сообщение содержит список доступных полей
400 UNKNOWN_SORT_FIELD Сортировка по полю, которого нет у записи цены. Сообщение содержит список доступных полей
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 TOKEN_MISSING Не передан заголовок X-Api-Key

Полный список общих ошибок API — Ошибки.

Известные особенности

Поля extraId, priceScale и timestampX недоступны для фильтра и сортировки. Они приходят в ответе, но в filter или sort отвечают ошибкой. Какие поля доступны — на странице Цены каталога.

Смотрите также