# sale.shipment.add

URL: https://chugunov.pro/api-bitrix24/sale/shipment/sale-shipment-add/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Добавить отгрузку
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.*`](https://chugunov.pro/api-bitrix24/sale/status/))
- `deliveryDocDate` `datetime` — необязательный. Дата документа отгрузки
- `deliveryDocNum` `string` — необязательный. Номер документа отгрузки
- `trackingNumber` `string` — необязательный. Идентификатор отправления
- `basePriceDelivery` `double` — необязательный. Базовая стоимость доставки (без скидок / наценок).
  Если передана, то значение будет использовано и в качестве стоимости доставки (поле отгрузки `priceDelivery`).
  Если не передана, то и базовая стоимость доставки, и стоимость доставки будут рассчитаны автоматически на основе выбранной службы доставки
- `comments` `string` — необязательный. Комментарий менеджера
- `companyId` `integer` — необязательный. Идентификатор компании из модуля «Интернет-магазин».
  В настоящий момент не используется
- `responsibleId` `user` — необязательный. Идентификатор пользователя, ответственного за отгрузку
- `xmlId` `string` — необязательный. Внешний идентификатор отгрузки.
  Можно использовать для синхронизации отгрузки с внешней системой

## Ответ

HTTP-статус: 200

```json
{
   "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

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

- `200040300020` — Недостаточно прав для добавления отгрузки
- `100` — Не указан или пустой параметр `fields`
- `0` — Заказ не найден
- `SALE_SHIPMENT_WRONG_DELIVERY_SERVICE` — Не найдена служба доставки
- `BX_INVALID_VALUE` — Значение одного из полей не прошло валидацию перед сохранением
- `0` — Не переданы обязательные поля
- `0` — Другие ошибки (например, фатальные ошибки)

## Примеры запроса

### cURL (Webhook)

```http
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 (OAuth)

```http
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
```

### JS (TS)

```ts
// 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)
}
```

### JS (UMD)

```html
<!-- 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>
```

### Python

```python
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}")
```

### PHP

```php
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.js

```js
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());
        }
    }
);
```

### PHP CRest

```php
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>';
```

### Go

```go
// 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)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/sale/shipment/sale-shipment-add.html