# sale.shipmentitem.add

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

Добавить элемент в табличную часть отгрузки
Scope: `sale`
Кто может выполнять метод: администратор

## Описание

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

## Параметры

- `fields` `object` — обязательный. Значения полей для создания элемента табличной части отгрузки

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

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

## Ответ

HTTP-статус: 200

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

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

- `201250000001` — Элемент с указанными значениями полей `basketId` и `orderDeliveryId` уже существует.
  Для изменения значения количества товара воспользуйтесь методом [`sale.shipmentitem.update`](https://chugunov.pro/api-bitrix24/sale/shipment-item/sale-shipment-item-update/)
- `201240400002` — Отгрузка не найдена. Некорректное значение переданного параметра `orderDeliveryId`
- `201240400003` — Корзина не найдена. Некорректное значение переданного параметра `basketId`
- `200040300020` — Недостаточно прав для добавления элемента в табличную часть отгрузки
- `100` — Не указан или пустой параметр `fields`
- `0` — Не переданы обязательные поля
- `0` — Другие ошибки (например, фатальные ошибки)

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

### cURL (Webhook)

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

### cURL (OAuth)

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

### 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 ShipmentItemAddResult = {
  shipmentItem: {
    basketId: number
    dateInsert: ISODate | null
    id: number
    orderDeliveryId: number
    quantity: number
    reservedQuantity: number
    xmlId: string
  }
}

try {
  const response = await $b24.actions.v2.call.make<ShipmentItemAddResult>({
    method: 'sale.shipmentitem.add',
    params: {
      fields: {
        orderDeliveryId: 33,
        basketId: 18,
        quantity: 1,
      },
    },
    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(result.shipmentItem.id, result.shipmentItem.basketId, result.shipmentItem.quantity)
  }
} 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 addShipmentItem() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

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

  document.addEventListener('DOMContentLoaded', addShipmentItem)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

fields = {
    "orderDeliveryId": 33,
    "basketId": 18,
    "quantity": 1,
}

try:
    bitrix_response = client.sale.shipmentitem.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.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.js

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

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'sale.shipmentitem.add',
    [
        'fields' => [
            'orderDeliveryId' => 33,
            'basketId' => 18,
            'quantity' => 1
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.shipmentitem.add", b24.Params{
	"fields": b24.Params{
		"orderDeliveryId": 33,
		"basketId":        18,
		"quantity":        1,
	},
})
if err != nil {
	return fmt.Errorf("sale.shipmentitem.add: %w", err)
}

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

var item struct {
	BasketID         b24.ID `json:"basketId"`
	DateInsert       string `json:"dateInsert"`
	ID               b24.ID `json:"id"`
	OrderDeliveryID  b24.ID `json:"orderDeliveryId"`
	Quantity         int    `json:"quantity"`
	ReservedQuantity int    `json:"reservedQuantity"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.BasketID, item.DateInsert)
```

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