Для AI-агентов: markdown этой страницы — /docs-content/entities/catalog-price-types/list.md индекс документации — /llms.txt

Список типов цен

GET /v1/catalog-price-types

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

Параметры

Параметр Тип По умолч. Описание
limit number 50 Количество записей (до 5000). При limit > 50 ответ автоматически собирается из нескольких страниц Битрикс24
offset number 0 Пропустить N записей. Вместе с limit задаёт окно выборки
select string — Выборка полей: ?select=id,name,base. Возвращаются только перечисленные поля
sort string — Поле сортировки. Префикс - — по убыванию: ?sort=-sort. Та же сортировка в полной форме: ?order[sort]=desc
filter object — Фильтрация по полям GET /v1/catalog-price-types/fields.
Синтаксис фильтрации. Пример: ?filter[base]=Y

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-price-types" \
  -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-price-types', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
const basePriceType = data.find(t => t.base === 'Y')
console.log('catalogGroupId базовой цены:', basePriceType.id)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив типов цен (все поля — см. Поля типа цены)
meta.total number Общее количество типов цен, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

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

Ответ на GET /v1/catalog-price-types?limit=2 — две записи из пяти, заведённых на портале:

JSON 
{
  "success": true,
  "data": [
    {
      "base": "Y",
      "createdBy": 1,
      "dateCreate": "2020-04-22T05:37:42.000Z",
      "id": 1,
      "modifiedBy": 1,
      "name": "BASE",
      "sort": 100,
      "timestampX": "2024-10-22T04:31:37.000Z",
      "xmlId": "BASE"
    },
    {
      "base": "N",
      "createdBy": 29,
      "dateCreate": "2021-04-20T12:56:47.000Z",
      "id": 3,
      "modifiedBy": 1,
      "name": "2base",
      "sort": 100,
      "timestampX": "2024-10-22T04:31:36.000Z",
      "xmlId": null
    }
  ],
  "meta": {
    "total": 5,
    "hasMore": true
  }
}

Номера в примере — с конкретного портала. На вашем они будут другими: определяйте базовый тип по base: "Y", а не по значению id.

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'nonExistentField' for entity 'catalog-price-types'. Available: id, name, base, xmlId, sort, createdBy, modifiedBy, dateCreate, timestampX"
  }
}

Ошибки

HTTP Код Описание
400 UNKNOWN_FILTER_FIELD Фильтр по полю, которого нет у типа цены. Сообщение содержит список доступных полей
400 UNKNOWN_SORT_FIELD Сортировка по полю, которого нет у типа цены
422 BITRIX_ERROR Битрикс24 отказал в чтении типов цен: у владельца ключа нет прав администратора портала
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики). Повторите после срока из заголовка Retry-After

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

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

Базовый тип цены ровно один. Фильтр ?filter[base]=Y возвращает одну запись — её id и есть значение catalogGroupId базовой цены для POST /v1/catalog-prices.

Метод требует прав администратора. Скоупа catalog недостаточно: Битрикс24 отдаёт типы цен только ключу, владелец которого имеет роль администратора портала. Иначе приходит 422 BITRIX_ERROR с сообщением Битрикс24 о недостатке прав.

Постраничный переход через offset поддерживается. Вайбкод возвращает запрошенное окно [offset, offset + limit): meta.total — точное число записей под фильтром, meta.hasMore — есть ли записи за пределами окна.

Когда использовать search вместо list: для условий по нескольким полям удобнее POST /v1/catalog-price-types/search — фильтр передаётся в теле запроса.

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