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

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

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

Scope: sale

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

Метод sale.shipmentitem.add добавляет товар из позиции корзины в отгрузку. Позиция корзины и отгрузка должны принадлежать одному заказу. Правила распределения количества между отгрузками — в обзоре раздела.

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

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

Название
тип

Описание

fields*
object

Значения полей для создания элемента табличной части отгрузки (подробное описание)

Параметр fields

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

Название
тип

Описание

orderDeliveryId*
sale_order_shipment.id

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

Можно получить методом sale.shipment.list

basketId*
sale_basket_item.id

Идентификатор позиции корзины.

Можно получить методом sale.basketitem.list

quantity*
double

Количество товара в отгрузке. Должно быть больше 0.

Сумма количества по всем отгрузкам заказа не может превышать количество в позиции корзины

xmlId
string

Внешний идентификатор. Если не передан, Битрикс24 генерирует значение вида bx_6abcd8337a3d4.

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

Примеры кода

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

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 -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
// 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)
}
<!-- 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>
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}")
try {
    $response = $b24Service
        ->core
        ->call(
            'sale.shipmentitem.add',
            [
                'fields' => [
                    'orderDeliveryId' => 33,
                    'basketId'        => 18,
                    'quantity'        => 1,
                ],
            ]
        );

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

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

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding shipment item: ' . $e->getMessage();
}
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());
    }
);
require_once('crest.php');

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

echo '<PRE>';
print_r($result);
echo '</PRE>';
// 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         float64 `json:"quantity"`
	ReservedQuantity float64 `json:"reservedQuantity"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.BasketID, item.DateInsert)

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

HTTP-статус: 200

{
    "result":{
        "shipmentItem":{
            "basketId":18,
            "dateInsert":"2024-04-11T10:10:35+03:00",
            "id":7,
            "orderDeliveryId":33,
            "quantity":1,
            "reservedQuantity":0,
            "xmlId":"bx_6617a2e1b3c5d"
        }
    },
    "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

Корневой элемент ответа (подробное описание)

time
time

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

Объект result

Название
тип

Описание

shipmentItem
sale_order_shipment_item

Добавленный элемент табличной части отгрузки

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

201250000001

Duplicate entry for key [basketId, orderDeliveryId]

Элемент с указанными значениями полей basketId и orderDeliveryId уже существует.

Чтобы изменить количество товара, используйте метод sale.shipmentitem.update

201240400002

shipment not exists

Отгрузка не найдена или относится к другому заказу, чем позиция корзины. Проверьте orderDeliveryId

201240400003

shipment not exists

Позиция корзины не найдена. Некорректное значение basketId

SALE_SHIPMENT_ITEM_LESS_AVAILABLE_QUANTITY

В корзине недостаточное количество свободного товара "<название>" для добавления в отгрузку. Возможно, вы уже добавили часть товара по этому заказу в другие отгрузки

В корзине недостаточно свободного товара: количество превышает остаток, не распределенный по другим отгрузкам

SALE_SHIPMENT_ITEM_ERR_QUANTITY_EMPTY

Количество <название> не может быть меньше или равны 0

Передано quantity = 0

BARCODE_MORE_ITEM_QUANTITY

Штрих-кодов больше чем количества товара

Передано отрицательное значение quantity

200040300020

Access Denied

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

100

Could not find value for parameter {fields}

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

0

Required fields: ...

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

0

Call to a member function setFields() on null

Отгрузка уже отгружена (deducted = Y), добавить в нее товар нельзя

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

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

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