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

Список доставок CRM

GET /v1/crm-deliveries

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

Параметры

Параметр Тип Обяз. Описание
ПараметрentityTypeId (query) Типnumber Обяз.да ОписаниеТип объекта CRM, положительное целое. Для сделки — 2
ПараметрentityId (query) Типnumber Обяз.да ОписаниеID объекта CRM, положительное целое. Для сделки — ID из GET /v1/deals

Пагинации и сортировки нет: приходят все доставки объекта.

Общий параметр filter этим эндпоинтом не применяется. По умолчанию API сохраняет прежний ответ HTTP 200 и прежние данные, добавляет заголовок Warning: 299 - "filter is not supported on this endpoint and was ignored", а сервер фиксирует использование неподдерживаемого фильтра в журнале.

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-deliveries?entityTypeId=2&entityId=8847" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-deliveries?entityTypeId=2&entityId=8847" \
  -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?entityTypeId=2&entityId=8847', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data, meta } = await res.json()
console.log(`Доставок: ${meta.total}`)

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

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

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

Поля ответа

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

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

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

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

400 — не передан entityId:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "entityTypeId and entityId are required positive integers."
  }
}

Ошибки

HTTP Код Описание
HTTP200 КодWarning: 299 ОписаниеФильтр игнорируется по умолчанию; прежние данные сохраняются, предупреждение передаётся заголовком Warning.
HTTP400 только при включённом строгом режиме КодUNSUPPORTED_FILTER ОписаниеСерверный режим выключен по умолчанию; до его включения эндпоинт сохраняет HTTP 200 и прежние данные.
HTTP400 КодMISSING_REQUIRED_FIELDS ОписаниеНе передан entityTypeId или entityId, или значение не положительное целое
HTTP404 КодENTITY_NOT_FOUND ОписаниеОбъекта CRM с такими entityTypeId и entityId нет
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа crm
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет подключения к Битрикс24

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

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

deducted здесь строка. Та же доставка в GET /v1/shipments/:id отдаёт deducted как true или false. Сравнивайте с "Y", а не с true.

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