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

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

GET /v1/crm-deliveries/:id

Возвращает одну доставку объекта CRM по ID, например доставку сделки из её списка доставок.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеID доставки. Список доставок объекта: GET /v1/crm-deliveries. Тот же ID у отгрузки в GET /v1/shipments

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-deliveries/1223" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-deliveries/1223" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

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

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

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

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

const { data } = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе
Полеdata.id Типnumber ОписаниеID доставки
Полеdata.accountNumber Типstring ОписаниеНомер доставки: номер заказа и порядковый номер через /
Полеdata.priceDelivery Типnumber ОписаниеСтоимость доставки
Полеdata.currency Типstring ОписаниеКод валюты стоимости
Полеdata.deducted Типstring ОписаниеОтметка об отгрузке: Y — отгружено, N — нет
Полеdata.dateDeducted Типstring | null ОписаниеВремя отгрузки или null, пока не отгружено
Полеdata.deliveryId Типnumber ОписаниеID службы доставки. Список: GET /v1/delivery-services
Полеdata.deliveryName Типstring ОписаниеНазвание службы доставки

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

JSON 
{
  "success": true,
  "data": {
    "id": 1223,
    "accountNumber": "1041/2",
    "priceDelivery": 500,
    "currency": "RUB",
    "deducted": "N",
    "dateDeducted": null,
    "deliveryId": 1,
    "deliveryName": "Доставка курьером"
  }
}

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

404 — доставки с таким ID нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Delivery has not been found"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_ID Описаниеid не положительное целое число
HTTP404 КодENTITY_NOT_FOUND ОписаниеДоставки с таким id нет
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа crm
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет подключения к Битрикс24

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

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