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

Получить службу доставки

GET /v1/delivery-services/:id

Позволяет найти службу доставки по идентификатору, чтобы проверить её настройки перед обновлением или использованием в интеграции.

Параметры

Параметр Тип Обяз. Описание
id (path) integer да Положительное целое число не больше 9007199254740991. Источник — список служб доставки

Параметры строки запроса не поддерживаются.

Примеры

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

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

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

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

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

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект службы доставки
data.id integer Идентификатор службы доставки
data.parentId integer | null Идентификатор родительской службы из списка служб доставки. Может быть null
data.name string | null Название службы доставки
data.active string | null Признак активности: Y или N
data.description string | null Описание службы доставки
data.currency string | null Код валюты из списка валют
data.sort integer | null Порядок сортировки
data.logotype integer | null Идентификатор файла логотипа, не URL. Может быть null

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

JSON 
{
  "success": true,
  "data": {
    "id": 85,
    "parentId": null,
    "name": "Курьерская доставка",
    "active": "N",
    "description": "",
    "currency": "USD",
    "sort": 100,
    "logotype": null
  }
}

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

404 — служба доставки не найдена:

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Идентификатор в пути не является положительным безопасным целым числом или переданы параметры запроса
404 ENTITY_NOT_FOUND Служба доставки с таким идентификатором не найдена
502 BITRIX_RESPONSE_INVALID Ответ не соответствует формату службы доставки
422 BITRIX_ERROR Битрикс24 отклонил операцию. Исходный текст ошибки сохраняется
403 BITRIX_ACCESS_DENIED Битрикс24 отказал в доступе
403 SCOPE_DENIED У API-ключа нет скоупа delivery
401 TOKEN_MISSING Для ключа не настроены данные авторизации Битрикс24

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

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