Получить список доставок объекта CRM crm.item.delivery.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с правом на чтение объекта CRM, из которого выбираются доставки

Метод crm.item.delivery.list возвращает список доставок конкретного объекта CRM. Доставка — это отгрузка заказа, привязанного к объекту CRM.

Метод не поддерживает постраничную навигацию: все доставки объекта приходят одним ответом, параметр start не работает, полей next и total в ответе нет.

Каждый элемент списка содержит тот же краткий набор полей, что возвращает метод crm.item.delivery.get. Набор фиксированный — параметра select у метода нет.

Список будет пустым, если у объекта нет привязанных заказов или его тип не поддерживает доставки. Какие объекты CRM поддерживают доставки, описано в обзоре методов раздела.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

entityId*
integer

Идентификатор объекта CRM, доставки которого нужно получить. Например, идентификатор сделки

entityTypeId*
integer

Идентификатор типа объекта CRM. Доставки есть только у сделок и счетов: для них entityTypeId равен 2 и 31 соответственно

filter
object

Фильтр, который сужает выборку доставок объекта CRM (подробное описание)

order
object

Порядок сортировки в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Допустимые значения order_N:

  • asc — по возрастанию
  • desc — по убыванию

Сортировать можно по полям объекта sale_order_shipment. По умолчанию список сортируется по id в порядке возрастания

Параметр filter

Ключи фильтра — поля объекта sale_order_shipment, записанные в camelCase. Чаще всего доставки отбирают по полям, которые метод возвращает в ответе, — они перечислены в описании элемента массива result. Фильтровать можно и по другим полям отгрузки, например по orderId.

Ключу можно задать префикс, который уточняет поведение фильтра:

  • = — равно, работает и с массивами
  • @ — значение входит в переданный массив
  • != — не равно
  • > — больше
  • >= — больше либо равно
  • < — меньше
  • <= — меньше либо равно
  • % — LIKE, поиск подстроки. Символ % в значении передавать не нужно
  • !% — NOT LIKE, поиск подстроки. Символ % в значении передавать не нужно
  • =% и %= — LIKE, символ % нужно передавать в значении, например "мол%"
  • !=% и !%= — NOT LIKE, символ % нужно передавать в значении

Метод всегда добавляет к фильтру собственные условия и игнорирует переданные значения этих ключей. По =orderId он берет отгрузки только тех заказов, которые привязаны к объекту CRM. По =system и !deliveryId он отбрасывает служебные отгрузки и отгрузки без службы доставки. Остальные условия метод применяет вместе со своими, и они могут только сузить выборку.

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityId":13127,"entityTypeId":2,"filter":{"@id":[4077,4078]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.delivery.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityId":13127,"entityTypeId":2,"filter":{"@id":[4077,4078]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.delivery.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of each DeliveryItem returned in result[]
type DeliveryItem = {
  id: number
  accountNumber: string
  deducted: string
  dateDeducted: ISODate | null
  deliveryId: number
  priceDelivery: number
  currency: string
  deliveryName: string
}

try {
  // crm.item.delivery.list has no pagination: it returns every delivery of the CRM item
  // in one response, so the list helpers (callList/fetchList) are not needed here.
  const response = await $b24.actions.v2.call.make<DeliveryItem[]>({
    method: 'crm.item.delivery.list',
    params: {
      entityId: 13127,
      entityTypeId: 2,
      filter: {
        '@id': [4077, 4078],
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Deliveries fetched:', result.length, result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function listDeliveries() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // crm.item.delivery.list has no pagination: it returns every delivery of the CRM item
      // in one response, so the list helpers (callList/fetchList) are not needed here.
      const response = await $b24.actions.v2.call.make({
        method: 'crm.item.delivery.list',
        params: {
          entityId: 13127,
          entityTypeId: 2,
          filter: {
            '@id': [4077, 4078],
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Deliveries fetched:', result.length, result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listDeliveries)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.item.delivery.list(
        entity_id=13127,
        entity_type_id=2,
        filter={
            "@id": [
                4077,
                4078,
            ],
        },
    ).response
    result = bitrix_response.result
    for item in result:
        print(item)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'crm.item.delivery.list',
            [
                'entityId'     => 13127,
                'entityTypeId' => 2,
                'filter'       => [
                    '@id' => [4077, 4078]
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error fetching delivery list: ' . $e->getMessage();
}
BX24.callMethod(
    'crm.item.delivery.list', {
        entityId: 13127,
        entityTypeId: 2,
        filter: {
            "@id": [4077, 4078]
        },
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.log(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'crm.item.delivery.list',
    [
        'entityId' => 13127,
        'entityTypeId' => 2,
        'filter' => [
            "@id" => [4077, 4078]
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.delivery.list", b24.Params{
	"entityId":     13127,
	"entityTypeId": 2,
	"filter": b24.Params{
		"@id": []int{4077, 4078},
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.item.delivery.list: %w", err)
}

var items []struct {
	ID            b24.ID  `json:"id"`
	AccountNumber string  `json:"accountNumber"`
	Deducted      string  `json:"deducted"`
	DateDeducted  *string `json:"dateDeducted"`
	DeliveryID    b24.ID  `json:"deliveryId"`
	PriceDelivery float64 `json:"priceDelivery"`
	Currency      string  `json:"currency"`
	DeliveryName  string  `json:"deliveryName"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
// Метод отдает все доставки объекта сразу, поэтому res.Total и res.Next
// не заполняются и обходить страницы через client.Core().Pages не нужно.
for _, it := range items {
	fmt.Println(it.ID, it.AccountNumber, it.DeliveryName)
}

Обработка ответа

HTTP-статус: 200

{
   "result":[
      {
         "id":4077,
         "accountNumber":"3657\/2",
         "deducted":"N",
         "dateDeducted":null,
         "deliveryId":228,
         "priceDelivery":79.99,
         "currency":"RUB",
         "deliveryName":"Uber Taxi (Cargo)"
      },
      {
         "id":4078,
         "accountNumber":"3657\/3",
         "deducted":"N",
         "dateDeducted":null,
         "deliveryId":228,
         "priceDelivery":79.99,
         "currency":"RUB",
         "deliveryName":"Uber Taxi (Cargo)"
      }
   ],
   "time":{
      "start":1716369036.246855,
      "finish":1716369036.734466,
      "duration":0.4876110553741455,
      "processing":0.18442106246948242,
      "date_start":"2024-05-22T12:10:36+03:00",
      "date_finish":"2024-05-22T12:10:36+03:00"
   }
}

Возвращаемые данные

Название
тип

Описание

result
array

Массив объектов с краткой информацией о выбранных доставках (подробное описание)

time
time

Информация о времени выполнения запроса

Элемент массива result

Название
тип

Описание

id
sale_order_shipment.id

Идентификатор доставки. С ним работает метод crm.item.delivery.get

accountNumber
string

Системный номер доставки. Например, 3657/2

deducted
string

Признак того, отгружена ли доставка.

Возможные значения:

  • Y — отгружена
  • N — не отгружена

dateDeducted
datetime

Дата и время последнего изменения признака deducted. Поле возвращает null, если признак ни разу не меняли

deliveryId
sale_delivery_service.id

Идентификатор службы доставки. Получить список служб доставки можно методом sale.delivery.getlist

priceDelivery
double

Стоимость доставки

currency
string

Символьный код валюты доставки. Например, RUB

deliveryName
string

Название службы доставки. Например, Uber Taxi (Cargo)

Обработка ошибок

HTTP-статус: 400

{
   "error":"100",
   "error_description":"Could not find value for parameter {entityId}"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

400

100

Could not find value for parameter

Не передан обязательный параметр entityId

400

100

Could not find value for parameter

Не передан обязательный параметр entityTypeId

400

100

Invalid value {value} to match with parameter {entityId}. Should be value of type int

Значение entityId или entityTypeId не приводится к целому числу. В тексте ошибки указано имя конкретного параметра

400

100

Invalid value {value} to match with parameter {filter}. Should be value of type array

Значение filter или order передано не объектом. В тексте ошибки указано имя конкретного параметра

400

ACCESS_DENIED

Access denied

У пользователя нет права на чтение объекта CRM, доставки которого запрашиваются. Эту же ошибку метод возвращает, если пара entityId и entityTypeId не указывает на объект CRM — например, когда entityId равен 0

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение