Получить список отгрузок sale.shipment.list

Scope: sale

Кто может выполнять метод: администратор

Метод получает список отгрузок.

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

Название `тип`	Описание
select `array`	Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_order_shipment).
filter `object`	Объект для фильтрации выбранных привязок оплат к отгрузкам в формате `{"field_1": "value_1", ... "field_N": "value_N"}`. Возможные значения для `field` соответствуют полям объекта sale_order_shipment. Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса: `=` — равно (работает и с массивами) `%` — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки `>` — больше `<` — меньше `!=` — не равно `!%` — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон. `>=` — больше либо равно `<=` — меньше либо равно `=%` — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры: `"мол%"` — ищем значения начинающиеся с «мол» `"%мол"` — ищем значения заканчивающиеся на «мол» `"%мол%"` — ищем значения, где «мол» может быть в любой позиции `%=` — LIKE (смотрите описание выше) `!=%` — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры: `"мол%"` — ищем значения не начинающиеся с «мол» `"%мол"` — ищем значения не заканчивающиеся на «мол» `"%мол%"` — ищем значения, где подстроки «мол» нет в любой позиции `!%=` — NOT LIKE (смотрите описание выше)
order `object`	Объект для сортировки выбранных привязок оплат к отгрузкам в формате `{"field_1": "order_1", ... "field_N": "order_N"}`. Возможные значения для `field` соответствуют полям объекта sale_order_shipment. Возможные значения для `order`: `asc` — в порядке возрастания `desc` — в порядке убывания
start `integer`	Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов необходимо передавать значение `50`. Чтобы выбрать третью страницу результатов значение — `100` и так далее. Формула расчета значения параметра `start`: `start = (N-1) * 50`, где `N` — номер нужной страницы

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","accountNumber","allowDelivery","basePriceDelivery","canceled","comments","companyId","currency","customPriceDelivery","dateAllowDelivery","dateCanceled","dateDeducted","dateInsert","dateMarked","dateResponsibleId","deducted","deliveryDocDate","deliveryDocNum","deliveryId","deliveryName","deliveryXmlId","discountPrice","empAllowDeliveryId","empCanceledId","empDeductedId","empMarkedId","empResponsibleId","externalDelivery","id1c","marked","orderId","priceDelivery","reasonMarked","reasonUndoDeducted","responsibleId","statusId","statusXmlId","system","trackingDescription","trackingLastCheck","trackingNumber","trackingStatus","updated1c","version1c","xmlId"],"filter":{"@orderId":[2069,2070],">=id":2464},"order":{"id":"desc"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipment.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","accountNumber","allowDelivery","basePriceDelivery","canceled","comments","companyId","currency","customPriceDelivery","dateAllowDelivery","dateCanceled","dateDeducted","dateInsert","dateMarked","dateResponsibleId","deducted","deliveryDocDate","deliveryDocNum","deliveryId","deliveryName","deliveryXmlId","discountPrice","empAllowDeliveryId","empCanceledId","empDeductedId","empMarkedId","empResponsibleId","externalDelivery","id1c","marked","orderId","priceDelivery","reasonMarked","reasonUndoDeducted","responsibleId","statusId","statusXmlId","system","trackingDescription","trackingLastCheck","trackingNumber","trackingStatus","updated1c","version1c","xmlId"],"filter":{"@orderId":[2069,2070],">=id":2464},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.shipment.list

// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'sale.shipment.list',
            {
              "select": [
                "id",
                "accountNumber",
                "allowDelivery",
                "basePriceDelivery",
                "canceled",
                "comments",
                "companyId",
                "currency",
                "customPriceDelivery",
                "dateAllowDelivery",
                "dateCanceled",
                "dateDeducted",
                "dateInsert",
                "dateMarked",
                "dateResponsibleId",
                "deducted",
                "deliveryDocDate",
                "deliveryDocNum",
                "deliveryId",
                "deliveryName",
                "deliveryXmlId",
                "discountPrice",
                "empAllowDeliveryId",
                "empCanceledId",
                "empDeductedId",
                "empMarkedId",
                "empResponsibleId",
                "externalDelivery",
                "id1c",
                "marked",
                "orderId",
                "priceDelivery",
                "reasonMarked",
                "reasonUndoDeducted",
                "responsibleId",
                "statusId",
                "statusXmlId",
                "system",
                "trackingDescription",
                "trackingLastCheck",
                "trackingNumber",
                "trackingStatus",
                "updated1c",
                "version1c",
                "xmlId",
              ],
              "filter": {
                ">=id": 2464,
                "@orderId": [2069, 2070],
              },
              "order": {
                "id": "desc",
              }
            },
            (progress) => { console.log('Progress:', progress) }
          );
          const items = response.getData() || [];
          for (const entity of items) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // fetchListMethod предпочтительно использовать при работе с крупными наборами данных. Метод реализует итеративную выборку с использованием генератора, что позволяет обрабатывать данные по частям и эффективно использовать память.
        
        try {
          const generator = $b24.fetchListMethod('sale.shipment.list', {
            "select": [
              "id",
              "accountNumber",
              "allowDelivery",
              "basePriceDelivery",
              "canceled",
              "comments",
              "companyId",
              "currency",
              "customPriceDelivery",
              "dateAllowDelivery",
              "dateCanceled",
              "dateDeducted",
              "dateInsert",
              "dateMarked",
              "dateResponsibleId",
              "deducted",
              "deliveryDocDate",
              "deliveryDocNum",
              "deliveryId",
              "deliveryName",
              "deliveryXmlId",
              "discountPrice",
              "empAllowDeliveryId",
              "empCanceledId",
              "empDeductedId",
              "empMarkedId",
              "empResponsibleId",
              "externalDelivery",
              "id1c",
              "marked",
              "orderId",
              "priceDelivery",
              "reasonMarked",
              "reasonUndoDeducted",
              "responsibleId",
              "statusId",
              "statusXmlId",
              "system",
              "trackingDescription",
              "trackingLastCheck",
              "trackingNumber",
              "trackingStatus",
              "updated1c",
              "version1c",
              "xmlId",
            ],
            "filter": {
              ">=id": 2464,
              "@orderId": [2069, 2070],
            },
            "order": {
              "id": "desc",
            }
          }, 'id');
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity); }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
          const response = await $b24.callMethod('sale.shipment.list', {
            "select": [
              "id",
              "accountNumber",
              "allowDelivery",
              "basePriceDelivery",
              "canceled",
              "comments",
              "companyId",
              "currency",
              "customPriceDelivery",
              "dateAllowDelivery",
              "dateCanceled",
              "dateDeducted",
              "dateInsert",
              "dateMarked",
              "dateResponsibleId",
              "deducted",
              "deliveryDocDate",
              "deliveryDocNum",
              "deliveryId",
              "deliveryName",
              "deliveryXmlId",
              "discountPrice",
              "empAllowDeliveryId",
              "empCanceledId",
              "empDeductedId",
              "empMarkedId",
              "empResponsibleId",
              "externalDelivery",
              "id1c",
              "marked",
              "orderId",
              "priceDelivery",
              "reasonMarked",
              "reasonUndoDeducted",
              "responsibleId",
              "statusId",
              "statusXmlId",
              "system",
              "trackingDescription",
              "trackingLastCheck",
              "trackingNumber",
              "trackingStatus",
              "updated1c",
              "version1c",
              "xmlId",
            ],
            "filter": {
              ">=id": 2464,
              "@orderId": [2069, 2070],
            },
            "order": {
              "id": "desc",
            }
          }, 0);
          const result = response.getData().result || [];
          for (const entity of result) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.shipment.list',
                    [
                        'select' => [
                            'id',
                            'accountNumber',
                            'allowDelivery',
                            'basePriceDelivery',
                            'canceled',
                            'comments',
                            'companyId',
                            'currency',
                            'customPriceDelivery',
                            'dateAllowDelivery',
                            'dateCanceled',
                            'dateDeducted',
                            'dateInsert',
                            'dateMarked',
                            'dateResponsibleId',
                            'deducted',
                            'deliveryDocDate',
                            'deliveryDocNum',
                            'deliveryId',
                            'deliveryName',
                            'deliveryXmlId',
                            'discountPrice',
                            'empAllowDeliveryId',
                            'empCanceledId',
                            'empDeductedId',
                            'empMarkedId',
                            'empResponsibleId',
                            'externalDelivery',
                            'id1c',
                            'marked',
                            'orderId',
                            'priceDelivery',
                            'reasonMarked',
                            'reasonUndoDeducted',
                            'responsibleId',
                            'statusId',
                            'statusXmlId',
                            'system',
                            'trackingDescription',
                            'trackingLastCheck',
                            'trackingNumber',
                            'trackingStatus',
                            'updated1c',
                            'version1c',
                            'xmlId',
                        ],
                        'filter' => [
                            '>=id'     => 2464,
                            '@orderId' => [2069, 2070],
                        ],
                        'order'  => [
                            'id' => 'desc',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching shipment list: ' . $e->getMessage();
        }

BX24.callMethod(
            "sale.shipment.list", {
                "select": [
                    "id",
                    "accountNumber",
                    "allowDelivery",
                    "basePriceDelivery",
                    "canceled",
                    "comments",
                    "companyId",
                    "currency",
                    "customPriceDelivery",
                    "dateAllowDelivery",
                    "dateCanceled",
                    "dateDeducted",
                    "dateInsert",
                    "dateMarked",
                    "dateResponsibleId",
                    "deducted",
                    "deliveryDocDate",
                    "deliveryDocNum",
                    "deliveryId",
                    "deliveryName",
                    "deliveryXmlId",
                    "discountPrice",
                    "empAllowDeliveryId",
                    "empCanceledId",
                    "empDeductedId",
                    "empMarkedId",
                    "empResponsibleId",
                    "externalDelivery",
                    "id1c",
                    "marked",
                    "orderId",
                    "priceDelivery",
                    "reasonMarked",
                    "reasonUndoDeducted",
                    "responsibleId",
                    "statusId",
                    "statusXmlId",
                    "system",
                    "trackingDescription",
                    "trackingLastCheck",
                    "trackingNumber",
                    "trackingStatus",
                    "updated1c",
                    "version1c",
                    "xmlId",
                ],
                "filter": {
                    ">=id": 2464,
                    "@orderId": [2069, 2070],
                },
                "order": {
                    "id": "desc",
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.shipment.list',
            [
                'select' => [
                    "id",
                    "accountNumber",
                    "allowDelivery",
                    "basePriceDelivery",
                    "canceled",
                    "comments",
                    "companyId",
                    "currency",
                    "customPriceDelivery",
                    "dateAllowDelivery",
                    "dateCanceled",
                    "dateDeducted",
                    "dateInsert",
                    "dateMarked",
                    "dateResponsibleId",
                    "deducted",
                    "deliveryDocDate",
                    "deliveryDocNum",
                    "deliveryId",
                    "deliveryName",
                    "deliveryXmlId",
                    "discountPrice",
                    "empAllowDeliveryId",
                    "empCanceledId",
                    "empDeductedId",
                    "empMarkedId",
                    "empResponsibleId",
                    "externalDelivery",
                    "id1c",
                    "marked",
                    "orderId",
                    "priceDelivery",
                    "reasonMarked",
                    "reasonUndoDeducted",
                    "responsibleId",
                    "statusId",
                    "statusXmlId",
                    "system",
                    "trackingDescription",
                    "trackingLastCheck",
                    "trackingNumber",
                    "trackingStatus",
                    "updated1c",
                    "version1c",
                    "xmlId",
                ],
                'filter' => [
                    ">=id" => 2464,
                    "@orderId" => [2069, 2070],
                ],
                'order' => [
                    "id" => "desc",
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Ответ в случае успеха

HTTP-статус: 200

{
           "result":{
              "shipments":[
                 {
                    "accountNumber":"2070\/2",
                    "allowDelivery":"N",
                    "basePriceDelivery":0,
                    "canceled":"N",
                    "comments":"",
                    "companyId":0,
                    "currency":"RUB",
                    "customPriceDelivery":"N",
                    "dateAllowDelivery":null,
                    "dateCanceled":null,
                    "dateDeducted":null,
                    "dateInsert":"2024-04-11T16:59:20+03:00",
                    "dateMarked":null,
                    "dateResponsibleId":"2024-04-11T16:59:20+03:00",
                    "deducted":"N",
                    "deliveryDocDate":null,
                    "deliveryDocNum":"",
                    "deliveryId":1,
                    "deliveryName":"Без доставки",
                    "deliveryXmlId":"",
                    "discountPrice":null,
                    "empAllowDeliveryId":null,
                    "empCanceledId":null,
                    "empDeductedId":null,
                    "empMarkedId":null,
                    "empResponsibleId":null,
                    "externalDelivery":"N",
                    "id":2467,
                    "id1c":"",
                    "marked":"N",
                    "orderId":2070,
                    "priceDelivery":0,
                    "reasonMarked":"",
                    "reasonUndoDeducted":"",
                    "responsibleId":0,
                    "statusId":"DN",
                    "statusXmlId":"FFdddd",
                    "system":"N",
                    "trackingDescription":"",
                    "trackingLastCheck":"",
                    "trackingNumber":"",
                    "trackingStatus":"",
                    "updated1c":"N",
                    "version1c":"",
                    "xmlId":"bx_6617fac818ee2"
                 },
                 {
                    "accountNumber":"2069\/2",
                    "allowDelivery":"N",
                    "basePriceDelivery":600,
                    "canceled":"N",
                    "comments":"",
                    "companyId":0,
                    "currency":"RUB",
                    "customPriceDelivery":"N",
                    "dateAllowDelivery":null,
                    "dateCanceled":null,
                    "dateDeducted":null,
                    "dateInsert":"2024-04-11T15:05:48+03:00",
                    "dateMarked":null,
                    "dateResponsibleId":"2024-04-11T15:05:48+03:00",
                    "deducted":"N",
                    "deliveryDocDate":null,
                    "deliveryDocNum":"",
                    "deliveryId":2,
                    "deliveryName":"Доставка курьером",
                    "deliveryXmlId":"",
                    "discountPrice":null,
                    "empAllowDeliveryId":null,
                    "empCanceledId":null,
                    "empDeductedId":null,
                    "empMarkedId":null,
                    "empResponsibleId":null,
                    "externalDelivery":"N",
                    "id":2465,
                    "id1c":"",
                    "marked":"N",
                    "orderId":2069,
                    "priceDelivery":600,
                    "reasonMarked":"",
                    "reasonUndoDeducted":"",
                    "responsibleId":0,
                    "statusId":"DN",
                    "statusXmlId":"FFdddd",
                    "system":"N",
                    "trackingDescription":"",
                    "trackingLastCheck":"",
                    "trackingNumber":"",
                    "trackingStatus":"",
                    "updated1c":"N",
                    "version1c":"",
                    "xmlId":"bx_6617e02cae2a1"
                 }
              ]
           },
           "total":2,
           "time":{
              "start":1712847615.641893,
              "finish":1712847615.857499,
              "duration":0.2156059741973877,
              "processing":0.02844095230102539,
              "date_start":"2024-04-11T18:00:15+03:00",
              "date_finish":"2024-04-11T18:00:15+03:00"
           }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа
shipments `sale_order_shipment[]`	Массив объектов с информацией о выбранных отгрузках
total `integer`	Общее количество найденных записей
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
           "error":0,
           "error_description":"error"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание
`200040300010`	Недостаточно прав для чтения отгрузок
`0`	Другие ошибки (например, фатальные ошибки)

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Получить значение полей отгрузки

Удалить отгрузку

Получить список отгрузок sale.shipment.list

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

Примеры кодаПримеры кода

Ответ в случае успехаОтвет в случае успеха

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

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

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

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