The method of calculating the cost of delivery
General Information
Method name
The method of calculating the cost of delivery
Direction
UA-EU (US)
HTTP Method
POST
Route(s)
.../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
Autorization
Authorization: Bearer jwt-token…
Description
The method allows users to receive information about the cost of delivery, the cost of paying for customs services, and the cost of other related services.
Request and response parameters
Request .../v.1.0/shipments/calculationsResponse .../v.1.0/shipments/calculations
Changes in the method
Previous version
{ "payerType": "Sender", "currency": "USD", "incoterm": "DDP", "cost": 90, "invoice": {} -- not used ///
Current version
{payerType": "Sender", "invoice": { "incoterm": "DDP", "currency": "USD", "payerFeesCustoms": "Sender", "cost": 101 /// } ///
If you want to use parameter “incoterm” = “DDP”, you need to specify parameters "currency", "cost". Otherwise, “incoterm” = “DDP” will be ignored.
Chema
Field
Type
Description
status
enum
Status of shipment
Allowed: ReadyToShip
payerType
enum
Identifies who is responsible for the payment of delivery services. Determines which party bears the cost: Sender, Recipient, or ThirdPerson. Required payerContractNumber for shipments within Europe or from Europe to Ukraine.
Allowed: Sender┃Recipient┃ThirdPerson
* for route /shipments/delivery-calculations - the request response will always return payerType = Sender
payerContractNumber
string
Required when payerType is ThirdPerson for shipments within Europe or from Europe to Ukraine. Specifies the contract number of the third-party payer (e.g., CNPP-00001797).
invoice
object
Informatoin for calculating shipping costs and customs payments
incoterm
enum
Type of tax calculation.
Example: DAP | DDP.
DAP - Delivered At Place
DDP - Delivered Duty Paid
currency
enum
Сurrency code
cost
number
Declared value of shipment for customs duty deduction. Also indicates maximum compensation in case of loss/damage.
Requiered if incoterm = “DDP”
Limit: Min. 1
payerFeesCustoms
enum
Identifies who is responsible for the customs payments. Determines which party bears the cost: Sender, Recipient, or ThirdPerson.
Allowed: Sender┃Recipient┃ThirdPerson
parcels
array of object
An array of parcel objects representing distinct packages within the shipment, including dimensions, weight, and details for delivery cost calculation.
cargoCategory
enum
Specifies the type of shipment. Categories: parcel, documents, cargo. Affects shipping method, cost, and documentation.
Allowed: parcel┃documents┃cargo
insuranceCost
number
Declared value of shipment for insurance coverage. Indicates maximum compensation in case of loss/damage.
Constraints: Min 1
rowNumber
integer
Sequential identifier for each parcel in the shipment.
If only one parcel, value = 1.
Constraints: Min 1
width
integer
Parcel width in millimeters. Used to calculate volume.
Constraints: Min 1
length
integer
Parcel length in millimeters. Used to calculate volume.
Constraints: Min 1
height
integer
Parcel height in millimeters. Used to calculate volume.
Constraints: Min 1
actualWeight
integer
Real parcel weight in grams. Round to nearest 10 g before sending.
Constraints: Min 1┃Max 2147483647
sender
object
Information about the sender. Includes origin details, affects logistics and cost calculations.
divisionNumber
string┃null
Optional sender post office division number. Interchangeable with divisionId/ postCode
divisionId
integer┃null
Optional sender division code. Interchangeable with divisionNumber / postCode
addressParts
object
Required when shipping from an address. Contains detailed address components.
postCode
string
Postal/ZIP code of sender.
Constraints: Max 10 chars
recipient
object
Information about the party receiving the shipment.
countryCode
string
ISO 3166-1 Alpha-2 code for recipient’s country.
Pattern: ^[A-Z]{2}$
divisionNumber
string┃null
Optional recipient post office division number. Interchangeable with divisionId / postCode
divisionId
integer┃null
Optional recipient division code. Interchangeable with divisionNumber / postCode
addressParts
object
Required when delivering to a specific address. Contains detailed address fields.
postCode
string
Postal/ZIP code for recipient.
Constraints: Max 10 chars
Acceptable HTTP status codes response
HTTP-code
Status
Description
200
OK
Request successful. The server has responded as required.
422
Unprocessable entity
The request was well-formed but had semantic errors + the reason for the error