В розділ Shipments додано новій метод Create Light Return Shipment
Назва методу
The method of calculating the cost of delivery
Направлення
UA-EU (US)
Метод
POST
Роути
.../ui/v.1.0/shipments/calculations
.../v.1.0/shipments/calculations
.../ui/site/v.1.0/shipments/delivery-calculations
.../ui/v.1.0/shipments/delivery-calculations
.../mobileapp/v.1.1/shipments/calculations
Авторизація
Authorization: Bearer jwt-token…
Опис
Метод дозволяє користувачам отримувати інформацію про вартість доставки, вартість оплати митних послуг та вартість інших супутніх сервісів.
Параметри запиту та відповіді Запит .../v.1.0/shipments/calculations Відповідь .../v.1.0/shipments/calculations
Request .../v.1.0/shipments/calculationsResponse .../v.1.0/shipments/calculations
Зміни в методі Попередня версія
{ "payerType": "Sender", "currency": "USD", "incoterm": "DDP", "cost": 90, "invoice": {} -- not used ///
Поточна версія
{payerType": "Sender", "invoice": { "incoterm": "DDP", "currency": "USD", "payerFeesCustoms": "Sender", "cost": 101 /// } ///
Якщо потрібно використовувати параметр incoterm = DDP, обов’язково необхідно передати параметри currency та cost.
У разі відсутності цих параметрів значення incoterm = DDP буде проігноровано.
Схема
Поле
Тип
Опис
status
enum
Стасут відправлення
Allowed: ReadyToShip
payerType
enum
Визначає сторону, відповідальну за оплату послуг доставки. Параметр визначає, хто несе витрати: Sender, Recipient або ThirdPerson. Для відправлень у межах Європи або з Європи в Україну обов’язковим є параметр payerContractNumber.
Допустимі значення: Sender┃Recipient┃ThirdPerson
* Для маршруту /shipments/delivery-calculations у відповіді завжди повертається payerType = Sender.
payerContractNumber
string
Обов’язковий параметр, якщо payerType = ThirdPerson для відправлень у межах Європи або з Європи в Україну. Визначає номер договору платника третьої сторони (наприклад, CNPP-00001797).
invoice
object
Інформація для розрахунку вартості доставки та митних платежів.
incoterm
enum
Тип розрахунку митних платежів.
Приклад: DAP | DDP
DAP — Delivered At Place
DDP — Delivered Duty Paid
currency
enum
Код валюти
cost
number
Оголошена вартість відправлення для розрахунку митних платежів. Також визначає максимальну суму компенсації у разі втрати або пошкодження.
Обов’язковий параметр, якщо incoterm = DDP
Обмеження: мін. 1
payerFeesCustoms
enum
Визначає, хто відповідає за митні платежі. Визначає, яка сторона несе витрати: Відправник, Одержувач або Третя особа. Дозволено: Відправник┃Одержувач┃Третя особа
parcels
array of object
Масив об'єктів посилок, що представляють окремі посилки в межах відправлення, включаючи розміри, вагу та деталі для розрахунку вартості доставки.
cargoCategory
enum
Визначає тип відправлення. Категорії: посилка, документи, вантаж. Впливає на спосіб доставки, вартість та документацію. Дозволено: посилка┃документи┃
вантаж
insuranceCost
number
Заявлена вартість відправлення для страхового покриття. Вказує максимальну компенсацію у разі втрати/пошкодження. Обмеження: Мін. 1
rowNumber
integer
Послідовний ідентифікатор для кожної посилки у відправленні. Якщо лише одна
width
integer
Ширина посилки в міліметрах. Використовується для обчислення об'єму. Обмеження: Мін. 1
length
integer
Довжина посилки в міліметрах. Використовується для обчислення об'єму. Обмеження: Мін. 1
height
integer
Висота посилки в міліметрах. Використовується для обчислення об'єму. Обмеження: Мін. 1
actualWeight
integer
Фактична вага посилки в грамах. Округліть до найближчих 10 г перед відправкою. Обмеження: Мін. 1┃Макс. 2147483647
sender
object
Інформація про відправника. Включає деталі походження, впливає на логістику та розрахунок вартості.
divisionNumber
string┃null
Номер відділення поштового зв'язку відправника (необов'язковий). Взаємозамінний з divisionId/postCode
divisionId
integer┃null
Необов'язковий код відділу відправника. Взаємозамінний з divisionNumber / postCode
addressParts
object
Обов’язково під час відправлення з адреси. Містить детальні компоненти адреси.
postCode
string
Поштовий індекс відправника. Обмеження: Максимум 10 символів
recipient
object
Інформація про сторону, яка отримує вантаж.
countryCode
string
Iод ISO 3166-1 Alpha-2 для країни одержувача. Шаблон: ^[A-Z]{2}$
divisionNumber
string┃null
Номер поштового відділення одержувача (необов'язковий). Взаємозамінний з divisionId / postCode
divisionId
integer┃null
Необов'язковий код підрозділу одержувача. Взаємозамінний з divisionNumber / postCode
addressParts
object
Обов'язково під час доставки на певну адресу. Містить детальні поля адреси.
postCode
string
Поштовий індекс одержувача. Обмеження: максимум 10 символів
Прийнятні коди статусу HTTP у відповіді
HTTP-код
Статус
Опис
200
OK
Запит успішно виконано. Сервер відповів належним чином.
422
Unprocessable entity
Запит був правильно сформований, але містив семантичні помилки + причина помилки
Останнє оновлення