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

Список обработчиков доставки

GET /v1/delivery-services/handlers

Показывает зарегистрированные REST-обработчики доставки, чтобы выбрать обработчик перед созданием службы доставки.

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/delivery-services/handlers" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

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

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

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

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

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

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

Поля ответа

Поле Тип Обяз. Описание
success boolean да true при успешном запросе
data array да Массив зарегистрированных обработчиков. Пустой массив, если обработчиков нет
data[].id integer нет Идентификатор обработчика
data[].name string нет Название обработчика
data[].code string нет Код обработчика. Передаётся в поле restCode при создании службы доставки
data[].sort integer нет Порядок сортировки обработчика
data[].description string нет Описание обработчика
data[].settings object | array нет Настройки обработчика. Вложенные ключи сохраняют имена Битрикс24
data[].profiles array нет Описания профилей обработчика. Вложенные ключи сохраняют имена Битрикс24
meta object да Сведения о количестве обработчиков
meta.total integer да Число элементов в data

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

Показаны основные поля обработчика. Полный состав — в таблице «Поля ответа» выше.

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Обработчик доставки",
      "code": "my_delivery_handler",
      "sort": 250
    }
  ],
  "meta": {
    "total": 1
  }
}

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

400 — в URL переданы параметры запроса:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Handlers have no query parameters"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Передан любой параметр запроса в URL. Метод вызывается без параметров
502 BITRIX_RESPONSE_INVALID Получен ответ с некорректной структурой или значением числового поля
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING У ключа нет доступных токенов Битрикс24
403 SCOPE_DENIED У ключа нет скоупа delivery
403 BITRIX_ACCESS_DENIED Битрикс24 отказал в доступе
422 BITRIX_ERROR Битрикс24 отклонил запрос. Причина указана в error.message

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

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