Добавить отгрузку sale.shipment.add

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

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

Scope: sale

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

Метод sale.shipment.add добавляет отгрузку.

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

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

Название
тип

Описание

fields*
object

Значения полей для создания отгрузки

Параметр fields

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

Название
тип

Описание

orderId*
sale_order.id

Идентификатор заказа

allowDelivery*
string

Признак разрешения доставки
Возможные значения:

  • Y – да (доставка разрешена)
  • N – нет (доставка не разрешена)

deducted*
string

Признак того, является ли отгрузка отгруженной
Возможные значения:

  • Y – да (отгружена)
  • N – нет (не отгружена)

deliveryId*
sale_delivery_service.id

Идентификатор службы доставки

statusId
sale_status

Идентификатор статуса доставки

Если не передан, то используется статус DN (см. таблицу статусов по умолчанию из документации по sale.status.*)

deliveryDocDate
datetime

Дата документа отгрузки

deliveryDocNum
string

Номер документа отгрузки

trackingNumber
string

Идентификатор отправления

basePriceDelivery
double

Базовая стоимость доставки (без скидок / наценок).

Если передана, то значение будет использовано и в качестве стоимости доставки (поле отгрузки priceDelivery).

Если не передана, то и базовая стоимость доставки, и стоимость доставки будут рассчитаны автоматически на основе выбранной службы доставки

comments
string

Комментарий менеджера

companyId
integer

Идентификатор компании из модуля «Интернет-магазин».

В настоящий момент не используется

responsibleId
user

Идентификатор пользователя, ответственного за отгрузку

xmlId
string

Внешний идентификатор отгрузки.

Можно использовать для синхронизации отгрузки с внешней системой

Примеры кода

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

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
// 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 the payload returned in result (match the "response handling" section of the page)
type ShipmentAddResult = {
  shipment: {
    accountNumber: string
    allowDelivery: string
    basePriceDelivery: number
    canceled: string
    comments: string
    currency: string
    customPriceDelivery: string
    dateAllowDelivery: ISODate | null
    dateDeducted: ISODate | null
    dateInsert: ISODate | null
    dateResponsibleId: ISODate | null
    deducted: string
    deliveryDocDate: ISODate | null
    deliveryDocNum: string
    deliveryId: number
    deliveryName: string
    deliveryXmlId: string
    empAllowDeliveryId: number
    empDeductedId: number
    empResponsibleId: number
    id: number
    marked: string
    orderId: number
    priceDelivery: number
    responsibleId: number
    shipmentItems: unknown[]
    statusId: string
    statusXmlId: string
    system: string
    trackingNumber: string
    xmlId: string
  }
}

try {
  const response = await $b24.actions.v2.call.make<ShipmentAddResult>({
    method: 'sale.shipment.add',
    params: {
      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',
      },
    },
    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('Added shipment id:', result.shipment.id, result.shipment)
  }
} 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 addShipment() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.shipment.add',
        params: {
          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',
          },
        },
        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('Added shipment id:', result.shipment.id, result.shipment)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

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",
}

try:
    bitrix_response = client.sale.shipment.add(
        fields=fields,
    ).response
    result = bitrix_response.result
    print(result)
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(
            '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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.shipment.add", b24.Params{
	"fields": b24.Params{
		"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",
	},
})
if err != nil {
	return fmt.Errorf("sale.shipment.add: %w", err)
}

// Метод заворачивает ответ в объект с ключом "shipment".
raw, ok := b24.Unwrap(res.Result, "shipment")
if !ok {
	return fmt.Errorf("в ответе нет ключа shipment")
}

var item struct {
	AccountNumber     string  `json:"accountNumber"`
	AllowDelivery     string  `json:"allowDelivery"`
	BasePriceDelivery float64 `json:"basePriceDelivery"`
	Canceled          string  `json:"canceled"`
	Comments          string  `json:"comments"`
	Currency          string  `json:"currency"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.AccountNumber, item.AllowDelivery)

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

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
object

Корневой элемент ответа

shipment
sale_order_shipment

Объект с информацией о добавленной отгрузке

time
time

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

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

HTTP-статус: 400

{
   "error":0,
   "error_description":"Не удается загрузить заказ"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

200040300020

Недостаточно прав для добавления отгрузки

100

Не указан или пустой параметр fields

0

Заказ не найден

SALE_SHIPMENT_WRONG_DELIVERY_SERVICE

Не найдена служба доставки

BX_INVALID_VALUE

Значение одного из полей не прошло валидацию перед сохранением

0

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

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

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

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