Добавить элемент в табличную часть отгрузки sale.shipmentitem.add

Scope: sale

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

Метод sale.shipmentitem.add добавляет элемент в табличную часть отгрузки.

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

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

Название `тип`	Описание
fields* `object`	Значения полей для создания элемента табличной части отгрузки

Параметр fields

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

Название `тип`	Описание
orderDeliveryId* `sale_order_shipment.id`	Идентификатор отгрузки
basketId* `sale_basket_item.id`	Идентификатор корзины
quantity* `double`	Количество товара
xmlId `string`	Внешний идентификатор. Можно использовать для синхронизации текущей товарной позиции доставки с аналогичной позицией во внешней системе

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"orderDeliveryId":33,"basketId":18,"quantity":1}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentitem.add

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"orderDeliveryId":33,"basketId":18,"quantity":1},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.shipmentitem.add

try
        {
        	const response = await $b24.callMethod(
        		'sale.shipmentitem.add',
        		{
        			fields: {
        				orderDeliveryId: 33,
        				basketId: 18,
        				quantity: 1
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error.ex);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.shipmentitem.add',
                    [
                        'fields' => [
                            'orderDeliveryId' => 33,
                            'basketId'        => 18,
                            'quantity'        => 1,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error()->ex);
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding shipment item: ' . $e->getMessage();
        }

BX24.callMethod(
            'sale.shipmentitem.add',
            {
                fields: {
                    orderDeliveryId: 33,
                    basketId: 18,
                    quantity: 1
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error().ex);
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.shipmentitem.add',
            [
                'fields' => [
                    'orderDeliveryId' => 33,
                    'basketId' => 18,
                    'quantity' => 1
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result":{
                "shipmentItem":{
                    "basketId":2716,
                    "dateInsert":"2024-04-11T09:10:34+03:00",
                    "id":7,
                    "orderDeliveryId":2431,
                    "quantity":3,
                    "reservedQuantity":0,
                    "xmlId":"myXmlId"
                }
            },
            "time":{
                "start":1712819431.708122,
                "finish":1712819435.985352,
                "duration":4.2772300243377686,
                "processing":4.085968971252441,
                "date_start":"2024-04-11T10:10:31+03:00",
                "date_finish":"2024-04-11T10:10:35+03:00"
            }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа
shipmentItem `sale_order_shipment_item`	Объект с информацией о добавленном элементе табличной части отгрузки
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error":201250000001,
            "error_description":"Duplicate entry for key [basketId, orderDeliveryId]"
        }

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

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

Код	Описание
`201250000001`	Элемент с указанными значениями полей `basketId` и `orderDeliveryId` уже существует. Для изменения значения количества товара воспользуйтесь методом `sale.shipmentitem.update`
`201240400002`	Отгрузка не найдена. Некорректное значение переданного параметра `orderDeliveryId`
`201240400003`	Корзина не найдена. Некорректное значение переданного параметра `basketId`
`200040300020`	Недостаточно прав для добавления элемента в табличную часть отгрузки
`100`	Не указан или пустой параметр `fields`
`0`	Не переданы обязательные поля
`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.shipmentitem.add

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

Параметр fieldsПараметр fields

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

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

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

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

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

Статусы и коды системных ошибокСтатусы и коды системных ошибок

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