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

Получить локализации валюты

GET /v1/currencies/:id/localizations

Читает названия валюты и настройки отображения сумм по языкам. Используйте метод перед изменением локализаций и после ошибки записи.

Скоуп: crm. Ключ в режиме READONLY разрешён.

Параметры

Параметр Тип Обяз. По умолч. Описание
id (path) string да — Код валюты из Списка валют. Пробелы по краям удаляются, буквы приводятся к верхнему регистру

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/currencies/QVC/localizations" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/currencies/QVC/localizations', {
  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/currencies/QVC/localizations', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Карта локализаций по кодам языков. Если локализаций нет, пустой объект {}
data.{lang} object Настройки языка {lang}, например en или ru
data.{lang}.fullName string Полное название валюты
data.{lang}.formatString string Шаблон отображения суммы, # — место для числа
data.{lang}.decPoint string Разделитель дробной части
data.{lang}.thousandsVariant string Вариант разделителя тысяч
data.{lang}.thousandsSep string | null Символ или HTML-сущность разделителя тысяч
data.{lang}.decimals number Количество знаков после разделителя дробной части
data.{lang}.hideZero boolean Скрывать незначащие нули дробной части

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

JSON 
{
  "success": true,
  "data": {
    "en": {
      "fullName": "Example currency",
      "formatString": "# QVC",
      "decPoint": ".",
      "thousandsVariant": "S",
      "thousandsSep": " ",
      "decimals": 2,
      "hideZero": false
    },
    "ru": {
      "fullName": "Example currency",
      "formatString": "# QVC",
      "decPoint": ".",
      "thousandsVariant": "S",
      "thousandsSep": " ",
      "decimals": 2,
      "hideZero": false
    }
  }
}

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

404 — валюта с указанным кодом не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Not found"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_ID Код валюты после удаления пробелов пуст
404 ENTITY_NOT_FOUND Валюта с указанным кодом не найдена
422 BITRIX_ERROR Битрикс24 отклонил чтение валюты или её локализаций
403 BITRIX_ACCESS_DENIED У пользователя нет прав на операцию в Битрикс24
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
502 BITRIX_RESPONSE_INVALID Получен ответ неожиданной структуры
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

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

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

HTML-сущности в строках формата и разделителей сохраняются как есть, например  .

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