Изменение отгрузки

Отгрузка меняется по своему идентификатору:

метод: PUT
ресурс: /v3/billing/api/order/shipment/:uuid - где :uuid это идентификатор отгрузки

Примечание

Идентификатор заказа при изменении не передаётся — отгрузка уже связана с заказом. Признак завершающей отгрузки задаётся при создании.

тело запроса - объект UpdateShipmentRequest
тело ответа - объект ShipmentResponse
Возможные ошибки

Пример запроса и ответа

PUT /v3/billing/api/order/shipment/{id}
Authorization: Bearer b37c4c689295904ed21eee5d9a48d42e
Content-Type: application/json
User-Agent: MyApp 1.0
Accept: application/json
{
  "basketItems": [
    {
      "sku": "string",
      "name": "string",
      "groupName": "string",
      "measureCode": "string",
      "originCountry": "string",
      "originCountryCode": "string",
      "grossWeight": 100.5,
      "netWeight": 100.5,
      "quantity": 100.5,
      "amount": 100.5,
      "amountWoVat": 100.5,
      "totalAmount": 100.5,
      "totalVatAmount": 100.5,
      "vatCode": "RUS_VAT22",
      "type": "string",
      "gtdNumber": "string",
      "paymentType": "string",
      "excise": 100.5,
      "metaData": {},
      "tnved": "string",
      "rnpt": "string",
      "gtin": "string",
      "category": "string",
      "categoryType": "string",
      "serviceDate": "2026-08-03T12:00:00+03:00"
    }
  ],
  "amount": 100.5,
  "vatAmount": 100.5,
  "documentNumber": "string",
  "documentDate": "2026-08-03T12:00:00+03:00"
}

Ответ (по схеме):

{
  "data": {
    "id": 1,
    "orderId": "01771534-1a57-f184-dee3-ebeb91dded75",
    "merchantId": "01771534-1a57-f184-dee3-ebeb91dded75",
    "basketItems": [
      {
        "sku": "string",
        "name": "string",
        "groupName": "string",
        "measure": "string",
        "measureCode": "string",
        "originCountry": "string",
        "originCountryCode": "string",
        "grossWeight": 100.5,
        "netWeight": 100.5,
        "quantity": 100.5,
        "amount": 100.5,
        "amountWoVat": 100.5,
        "totalAmount": 100.5,
        "totalVatAmount": 100.5,
        "vatCode": "RUS_VAT22",
        "type": "string",
        "gtdNumber": "string",
        "paymentType": "string",
        "excise": 100.5,
        "metaData": {},
        "tnved": "string",
        "rnpt": "string",
        "gtin": "string",
        "category": "string",
        "categoryType": "string",
        "serviceDate": "2026-08-03T12:00:00+03:00"
      }
    ],
    "createdAt": "2026-08-03T12:00:00+03:00",
    "type": "string",
    "status": "draft",
    "amount": 100.5,
    "vatAmount": 100.5,
    "final": false,
    "documentNumber": "string",
    "description": "string",
    "documentDate": "2026-08-03T12:00:00+03:00"
  },
  "metaData": {
    "totalCount": 1,
    "pageSize": 1,
    "page": 1
  },
  "extendedData": [
    {
      "type": "string",
      "data": {}
    }
  ]
}

UpdateShipmentRequest

Свойство	Тип	Описание	Пример значения
documentNumber	string(36)	Номер документа (накладная, счёт-фактура и пр.)	`123`
documentDate	date	Дата документа	`2026-09-07`
basketItems *	array of BasketItem	Корзина заказа
type	string, enum	Тип отгрузки, по умолчанию `shipment`	`shipment`, `cancel`

ShipmentResponse

Повторяет свойства объекта CreateShipmentRequest с дополнительными свойствами:

Свойство	Тип	Описание	Пример значения
id *	int	Идентификатор отгрузки в системе Инвойсбокс	`2`
merchantId *	string(36)	Идентификатор магазина	`01771534-1a57-f184-dee3-ebeb91dded76`

BasketItem

Корзина заказа. Пожалуйста, внимательно ознакомьтесь с требованиями по заполнению наименования номенклатуры.

Свойство	Тип	Описание
sku *	string(500)	Артикул, например: `5fe0adcfa7fb4`
name *	string(500)	Наименование, например `Бронирование номера`
groupName	string(500)	Наименование группы позиций заказа, используется для формирования отчетных документов
measure *	string(10)	Единица измерения (для России - по ОКЕИ), например `шт.`
measureCode *	string(4)	Код единицы измерения (для России - по ОКЕИ), например `796`
originCountry	string(20)	Страна происхождения товара, например, `Россия`
originCountryCode	string(4)	Код страны происхождения, например, Россия `643`
grossWeight	float	Вес брутто, например `125.45`
netWeight	float	Вес нетто, например `125.45`
quantity *	float	Количество, например `3`
amount *	float	Стоимость единицы, например `100.55`
amountWoVat *	float	Стоимость единицы без учёта НДС
totalAmount *	float	Стоимость всех единиц с НДС, например`123.55`
totalVatAmount *	float	Итого сумма НДС, например `23`
excise	float	Сумма акциза, например, `10.00`
vatCode *	string(20) enum	Код процента НДС, допустимые значения: `VATNONE` - не облагается,`VATNONE` - не облагается, `RUS_VAT0` - 0%, `RUS_VAT10` - 10/110, `RUS_VAT10_ADDED` - 10%, `RUS_VAT20` - 20/120, `RUS_VAT20_ADDED` - 20% `RUS_VAT22` - 22/122, `RUS_VAT22_ADDED` - 22%
type *	string(10) или int	Тип позиции, в соответствии со справочником или service - сервис, commodity - товар
paymentType *	string(20) enum	Тип оплаты, допустимые значения: `full_prepayment`, `prepayment`, `advance`, `full_payment`
metaData	object	Дополнительные данные элемента корзины

curl -X PUT 'https://api.invoicebox.ru/v3/billing/api/order/shipment/<id>' \ -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \ -H 'Content-Type: application/json' \ -H 'User-Agent: MyApp 1.0' \ -d '{ "basketItems": [ { "sku": "sku-1", "name": "Бронирование номера", "quantity": 1, "amount": 12200, "amountWoVat": 100, "totalAmount": 100, "totalVatAmount": 100, "vatCode": "RUS_VAT22", "type": "service" } ], "amount": 12200, "vatAmount": 2200 }'

curl -X PUT 'https://api.invoicebox.ru/v3/billing/api/order/shipment/<id>/status' \ -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \ -H 'Content-Type: application/json' \ -H 'User-Agent: MyApp 1.0' \ -d '{ "status": "draft", "description": "Оплата бронирования" }'