Обновить отгрузку sale.shipment.update

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

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

Scope: sale

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

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

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

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

Название
тип

Описание

id*
sale_order_shipment.id

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

fields*
object

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

Параметр fields

Общие параметры, актуальные для свойств отгрузки любого типа:

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

Название
тип

Описание

allowDelivery*
string

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

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

deducted*
string

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

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

deliveryId*
sale_delivery_service

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

statusId
sale_status

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

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

deliveryDocDate
datetime

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

deliveryDocNum
string

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

trackingNumber
string

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

basePriceDelivery
double

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

Если передана, то используется и для выставления значения priceDelivery. Переданное значение priceDelivery в этом случае игнорируется.

Если не передана ни basePriceDelivery, ни priceDelivery, то обе цены выставляются в 0

priceDelivery
double

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

Если передана и не выставлена basePriceDelivery, то используется и для выставления значения basePriceDelivery.

Если не передана ни basePriceDelivery, ни priceDelivery, то обе цены выставляются в 0

comments
string

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

companyId
integer

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

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

responsibleId
user

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

xmlId
string

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

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

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":2452,"fields":{"allowDelivery":"N","deducted":"N","deliveryId":3,"statusId":"DD","deliveryDocDate":"2024-02-13T15:05:49","deliveryDocNum":"MyDocumentNumber","trackingNumber":"MyTrackingNumber","basePriceDelivery":1999.99,"comments":"My new comment for manager","responsibleId":1,"xmlId":"myNewXmlId"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipment.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":2452,"fields":{"allowDelivery":"N","deducted":"N","deliveryId":3,"statusId":"DD","deliveryDocDate":"2024-02-13T15:05:49","deliveryDocNum":"MyDocumentNumber","trackingNumber":"MyTrackingNumber","basePriceDelivery":1999.99,"comments":"My new comment for manager","responsibleId":1,"xmlId":"myNewXmlId"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.shipment.update
// 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 ShipmentUpdateResult = {
  shipment: {
    id: number
    orderId: number
    accountNumber: string
    deliveryId: number
    deliveryName: string
    statusId: string
    allowDelivery: string
    deducted: string
    canceled: string
    marked: string
    priceDelivery: number
    basePriceDelivery: number
    discountPrice: number
    currency: string
    comments: string
    trackingNumber: string
    deliveryDocNum: string
    deliveryDocDate: ISODate | null
    xmlId: string
    companyId: number | null
    responsibleId: number | null
    dateInsert: ISODate | null
    dateAllowDelivery: ISODate | null
    dateDeducted: ISODate | null
    shipmentItems: unknown[]
  }
}

try {
  const response = await $b24.actions.v2.call.make<ShipmentUpdateResult>({
    method: 'sale.shipment.update',
    params: {
      id: 2452,
      fields: {
        allowDelivery: 'N',
        deducted: 'N',
        deliveryId: 3,
        statusId: 'DD',
        deliveryDocDate: '2024-02-13T15:05:49',
        deliveryDocNum: 'MyDocumentNumber',
        trackingNumber: 'MyTrackingNumber',
        basePriceDelivery: 1999.99,
        comments: 'My new comment for manager',
        responsibleId: 1,
        xmlId: 'myNewXmlId',
      },
    },
    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('Updated shipment id:', result.shipment.id, 'status:', result.shipment.statusId)
  }
} 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 updateShipment() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.shipment.update',
        params: {
          id: 2452,
          fields: {
            allowDelivery: 'N',
            deducted: 'N',
            deliveryId: 3,
            statusId: 'DD',
            deliveryDocDate: '2024-02-13T15:05:49',
            deliveryDocNum: 'MyDocumentNumber',
            trackingNumber: 'MyTrackingNumber',
            basePriceDelivery: 1999.99,
            comments: 'My new comment for manager',
            responsibleId: 1,
            xmlId: 'myNewXmlId',
          },
        },
        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('Updated shipment id:', result.shipment.id, 'status:', result.shipment.statusId)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

fields = {
    "allowDelivery": "N",
    "deducted": "N",
    "deliveryId": 3,
    "statusId": "DD",
    "deliveryDocDate": "2024-02-13T15:05:49",
    "deliveryDocNum": "MyDocumentNumber",
    "trackingNumber": "MyTrackingNumber",
    "basePriceDelivery": 1999.99,
    "comments": "My new comment for manager",
    "responsibleId": 1,
    "xmlId": "myNewXmlId",
}

try:
    bitrix_response = client.sale.shipment.update(
        bitrix_id=2452,
        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.update',
            [
                'id' => 2452,
                'fields' => [
                    'allowDelivery'      => 'N',
                    'deducted'           => 'N',
                    'deliveryId'         => 3,
                    'statusId'           => 'DD',
                    'deliveryDocDate'    => '2024-02-13T15:05:49',
                    'deliveryDocNum'     => 'MyDocumentNumber',
                    'trackingNumber'     => 'MyTrackingNumber',
                    'basePriceDelivery'  => 1999.99,
                    'comments'           => 'My new comment for manager',
                    'responsibleId'      => 1,
                    'xmlId'              => 'myNewXmlId',
                ],
            ]
        );

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

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

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error updating shipment: ' . $e->getMessage();
}
BX24.callMethod(
    'sale.shipment.update', {
        id: 2452,
        fields: {
            allowDelivery: 'N',
            deducted: 'N',
            deliveryId: 3,
            statusId: 'DD',
            deliveryDocDate: '2024-02-13T15:05:49',
            deliveryDocNum: 'MyDocumentNumber',
            trackingNumber: 'MyTrackingNumber',
            basePriceDelivery: 1999.99,
            comments: 'My new comment for manager',
            responsibleId: 1,
            xmlId: 'myNewXmlId',
        }
    },
    function(result) {
        if (result.error())
            console.error(result.error().ex);
        else
            console.log(result.data());
    }
);
require_once('crest.php');

$result = CRest::call(
    'sale.shipment.update',
    [
        'id' => 2452,
        'fields' => [
            'allowDelivery' => 'N',
            'deducted' => 'N',
            'deliveryId' => 3,
            'statusId' => 'DD',
            'deliveryDocDate' => '2024-02-13T15:05:49',
            'deliveryDocNum' => 'MyDocumentNumber',
            'trackingNumber' => 'MyTrackingNumber',
            'basePriceDelivery' => 1999.99,
            'comments' => 'My new comment for manager',
            'responsibleId' => 1,
            'xmlId' => 'myNewXmlId',
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.shipment.update", b24.Params{
	"id": 2452,
	"fields": b24.Params{
		"allowDelivery":     "N",
		"deducted":          "N",
		"deliveryId":        3,
		"statusId":          "DD",
		"deliveryDocDate":   "2024-02-13T15:05:49",
		"deliveryDocNum":    "MyDocumentNumber",
		"trackingNumber":    "MyTrackingNumber",
		"basePriceDelivery": 1999.99,
		"comments":          "My new comment for manager",
		"responsibleId":     1,
		"xmlId":             "myNewXmlId",
	},
})
if err != nil {
	return fmt.Errorf("sale.shipment.update: %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":"N",
         "basePriceDelivery":1999.99,
         "canceled":"N",
         "comments":"My new comment for manager",
         "companyId":null,
         "currency":"RUB",
         "customPriceDelivery":"N",
         "dateAllowDelivery":"2024-04-12T10:01:23+03:00",
         "dateCanceled":null,
         "dateDeducted":"2024-04-12T10:01:23+03:00",
         "dateInsert":"2024-04-11T14:17:52+03:00",
         "dateMarked":null,
         "dateResponsibleId":"2024-04-12T10:01:23+03:00",
         "deducted":"N",
         "deliveryDocDate":"2024-02-13T14:05:49+03:00",
         "deliveryDocNum":"MyDocumentNumber",
         "deliveryId":3,
         "deliveryName":"Самовывоз",
         "deliveryXmlId":"",
         "discountPrice":0,
         "empAllowDeliveryId":1,
         "empCanceledId":null,
         "empDeductedId":1,
         "empMarkedId":null,
         "empResponsibleId":1,
         "externalDelivery":"N",
         "id":2452,
         "id1c":"",
         "marked":"N",
         "orderId":2068,
         "priceDelivery":1999.99,
         "reasonMarked":"",
         "reasonUndoDeducted":"",
         "responsibleId":1,
         "shipmentItems":[
            
         ],
         "statusId":"DD",
         "statusXmlId":"",
         "system":"N",
         "trackingDescription":"",
         "trackingLastCheck":"",
         "trackingNumber":"MyTrackingNumber",
         "trackingStatus":"",
         "updated1c":"N",
         "version1c":"",
         "xmlId":"myNewXmlId"
      }
   },
   "time":{
      "start":1712928678.417617,
      "finish":1712928679.68092,
      "duration":1.2633028030395508,
      "processing":1.0808379650115967,
      "date_start":"2024-04-12T16:31:18+03:00",
      "date_finish":"2024-04-12T16:31:19+03:00"
   }
}

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

Название
тип

Описание

result
object

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

shipment
sale_order_shipment

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

time
time

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

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

HTTP-статус: 400

{
   "error":0,
   "error_description":"Required fields: name"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

201140400001

Отгрузка не найдена

200040300020

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

BX_INVALID_VALUE

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

100

Не указан параметр id

100

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

0

Не переданы обязательные поля структуры fields

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

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

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