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

Получить тип цены

GET /v1/catalog-price-types/:id

Возвращает один тип цены по идентификатору со всеми полями.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID типа цены

Примеры

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

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

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

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

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

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

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

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

Поля ответа

data — объект типа цены. Полный перечень полей — Поля типа цены.

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

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

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

404 — типа цены с таким номером на портале нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "priceType does not exist."
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Типа цены с таким id на портале нет. Сообщение повторяет слова Битрикс24 дословно. Номера типов зависят от портала — сверьтесь со списком
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 — Ошибки.

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

Номер типа не переносится между порталами. Один и тот же id на другом портале означает другой тип цены или не существует вовсе. Интеграция, работающая с несколькими порталами, должна получать список на каждом из них.

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

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