Изменение отгрузки
Для изменения отгрузки, необходимо вызвать следующий метод API:
- метод:
PUT - ресурс:
/v3/filter/api/order/shipment/:uuid- где:uuidэто идентификатор отгрузки - тело запроса - объект UpdateShipmentRequest
- тело ответа - объект ShipmentResponse
- Возможные ошибки
UpdateShipmentRequest
| Свойство | Обязательное | Тип | Описание | Пример значения |
|---|---|---|---|---|
| orderId | да | string(36) | Id заказа | 01771534-1a57-f184-dee3-ebeb91dded75 |
| documentNumber | нет | string(36) | Номер документа (накладная, счёт-фактура и пр.) | 123 |
| documentDate | нет | date | Дата документа | 2023-12-12 |
| basketItems | да | array of BasketItem | Корзина заказа | |
| type | нет | string, enum | Тип отгрузки, по умолчанию shipment | shipment, cancel |
| final | нет | bool | Завершающая ли отгрузка по заказу, по умолчанию false | true, false |
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%, RUS_VAT20 - 20% |
| type | да | string(10) или int | Тип позиции, в соответствии со справочником или service - сервис, commodity - товар |
| paymentType | да | string(20) enum | Тип оплаты, допустимые значения: full_prepayment, prepayment, advance, full_payment |
| metaData | нет | object | Дополнительные данные элемента корзины |