Добавить отгрузку sale.shipment.add
Scope:
saleКто может выполнять метод: администратор
Метод добавляет отгрузку.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Значения полей для создания отгрузки |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
orderId* |
Идентификатор заказа |
|
allowDelivery* |
Признак разрешения доставки
|
|
deducted* |
Признак того, является ли отгрузка отгруженной
|
|
deliveryId* |
Идентификатор службы доставки |
|
statusId |
Идентификатор статуса доставки Если не передан, то используется статус DN (см. таблицу статусов по умолчанию из документации по |
|
deliveryDocDate |
Дата документа отгрузки |
|
deliveryDocNum |
Номер документа отгрузки |
|
trackingNumber |
Идентификатор отправления |
|
basePriceDelivery |
Базовая стоимость доставки (без скидок / наценок). Если передана, то значение будет использовано и в качестве стоимости доставки (поле отгрузки Если не передана, то и базовая стоимость доставки, и стоимость доставки будут рассчитаны автоматически на основе выбранной службы доставки |
|
comments |
Комментарий менеджера |
|
companyId |
Идентификатор компании из модуля «Интернет-магазин». В настоящий момент не используется |
|
responsibleId |
Идентификатор пользователя, ответственного за отгрузку |
|
xmlId |
Внешний идентификатор отгрузки. Можно использовать для синхронизации отгрузки с внешней системой |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"orderId":2068,"allowDelivery":"Y","deducted":"Y","deliveryId":2,"statusId":"DN","deliveryDocDate":"2024-02-13T14:05:48","deliveryDocNum":"DocumentNumber123456","trackingNumber":"trackingNumber","basePriceDelivery":999.99,"comments":"My comment for manager","responsibleId":25,"xmlId":"myXmlId"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipment.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"orderId":2068,"allowDelivery":"Y","deducted":"Y","deliveryId":2,"statusId":"DN","deliveryDocDate":"2024-02-13T14:05:48","deliveryDocNum":"DocumentNumber123456","trackingNumber":"trackingNumber","basePriceDelivery":999.99,"comments":"My comment for manager","responsibleId":25,"xmlId":"myXmlId"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.shipment.add
try
{
const response = await $b24.callMethod(
'sale.shipment.add', {
fields: {
orderId: 2068,
allowDelivery: 'Y',
deducted: 'Y',
deliveryId: 2,
statusId: 'DN',
deliveryDocDate: '2024-02-13T14:05:48',
deliveryDocNum: 'DocumentNumber123456',
trackingNumber: 'trackingNumber',
basePriceDelivery: 999.99,
comments: 'My comment for manager',
responsibleId: 25,
xmlId: 'myXmlId',
}
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'sale.shipment.add',
[
'fields' => [
'orderId' => 2068,
'allowDelivery' => 'Y',
'deducted' => 'Y',
'deliveryId' => 2,
'statusId' => 'DN',
'deliveryDocDate' => '2024-02-13T14:05:48',
'deliveryDocNum' => 'DocumentNumber123456',
'trackingNumber' => 'trackingNumber',
'basePriceDelivery' => 999.99,
'comments' => 'My comment for manager',
'responsibleId' => 25,
'xmlId' => 'myXmlId',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding shipment: ' . $e->getMessage();
}
BX24.callMethod(
'sale.shipment.add', {
fields: {
orderId: 2068,
allowDelivery: 'Y',
deducted: 'Y',
deliveryId: 2,
statusId: 'DN',
deliveryDocDate: '2024-02-13T14:05:48',
deliveryDocNum: 'DocumentNumber123456',
trackingNumber: 'trackingNumber',
basePriceDelivery: 999.99,
comments: 'My comment for manager',
responsibleId: 25,
xmlId: 'myXmlId',
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.shipment.add',
[
'fields' => [
'orderId' => 2068,
'allowDelivery' => 'Y',
'deducted' => 'Y',
'deliveryId' => 2,
'statusId' => 'DN',
'deliveryDocDate' => '2024-02-13T14:05:48',
'deliveryDocNum' => 'DocumentNumber123456',
'trackingNumber' => 'trackingNumber',
'basePriceDelivery' => 999.99,
'comments' => 'My comment for manager',
'responsibleId' => 25,
'xmlId' => 'myXmlId',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Ответ в случае успеха
HTTP-статус: 200
{
"result":{
"shipment":{
"accountNumber":"2068\/19",
"allowDelivery":"Y",
"basePriceDelivery":999.99,
"canceled":"N",
"comments":"My comment for manager",
"currency":"RUB",
"customPriceDelivery":"N",
"dateAllowDelivery":"2024-04-11T14:17:52+03:00",
"dateDeducted":"2024-04-11T14:17:52+03:00",
"dateInsert":"2024-04-11T14:17:52+03:00",
"dateResponsibleId":"2024-04-11T14:17:52+03:00",
"deducted":"Y",
"deliveryDocDate":"2024-02-13T13:05:48+03:00",
"deliveryDocNum":"DocumentNumber123456",
"deliveryId":2,
"deliveryName":"Доставка курьером",
"deliveryXmlId":"",
"empAllowDeliveryId":1,
"empDeductedId":1,
"empResponsibleId":1,
"id":2452,
"marked":"N",
"orderId":2068,
"priceDelivery":999.99,
"responsibleId":25,
"shipmentItems":[
],
"statusId":"DN",
"statusXmlId":"FFdddd",
"system":"N",
"trackingNumber":"trackingNumber",
"xmlId":"myXmlId"
}
},
"time":{
"start":1712837872.459187,
"finish":1712837873.462857,
"duration":1.0036699771881104,
"processing":0.8182649612426758,
"date_start":"2024-04-11T15:17:52+03:00",
"date_finish":"2024-04-11T15:17:53+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
shipment |
Объект с информацией о добавленной отгрузке |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"Не удается загрузить заказ"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для добавления отгрузки |
|
|
Не указан или пустой параметр |
|
|
Заказ не найден |
|
|
Не найдена служба доставки |
|
|
Значение одного из полей не прошло валидацию перед сохранением |
|
|
Не переданы обязательные поля |
|
|
Другие ошибки (например, фатальные ошибки) |
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Отгрузки в Интернет-магазине: обзор методов
- Обновить отгрузку sale.shipment.update
- Получить поля отгрузки sale.shipment.get
- Получить список отгрузок sale.shipment.list
- Удалить отгрузку sale.shipment.delete
- Получить доступные поля отгрузки sale.shipment.getfields