How an order is delivered: the carrier, the shipping amounts, and for carriers that deliver to
a pickup point, the pickup point itself. The recipient's address is not part of it — it is
the shippingAddress of the order's customer.
| Name | Type | Description | |
|---|---|---|---|
id
|
number
|
Unique numeric identifier for the OrderShipping. | |
title
|
string
|
Name of the shipping method, for your own reference. Stored as sent; the carrier that
delivers the order is chosen by carrier, not by this name.
|
|
price
|
number
|
The price of this shipping method. | |
codPrice
|
number
|
Total collect on delivery (COD) amount. | |
orderValue
|
number
|
Declared value of the shipment, passed to the carrier (for example as the insured or customs
value). When omitted or 0, the carrier's default value for the destination
country is used.
|
|
carrier
|
Carrier | The shipping company. | |
branchId
|
string
|
Identifier of the pickup point (branch, parcel shop, locker) the shipment is delivered to. Required by some shipping providers and ignored by the others; the accepted values come from the provider's own branch list. | |
preferedDeliveryTime
|
number
|
The delivery date requested by the customer, as an ISO 8601 date and time string
(for example 2019-04-25T18:02:07+02:00) in both JSON and XML.
|
{
"shippingLine" : {
"id" : 12345,
"title" : "Zasilkovna - pickup point",
"price" : 12345.0,
"codPrice" : 12345.0,
"orderValue" : 12345.0,
"carrier" : {
"id" : 12345,
"name" : "UPS",
"description" : "Standard domestic shipping method",
"phoneRequired" : true,
"moduleProvider" : {
"id" : 12345,
"name" : "Standard",
"provider" : "ups",
"serviceType" : "standard",
"moduleType" : { },
"letter" : "UPS",
"useLastLabel" : true,
"packageLength" : 12345,
"packageWidth" : 12345,
"packageHeight" : 12345,
"defaultCountryOfOrigin" : "CZ"
},
"customProvider" : "...",
"premium" : true,
"emdorsement" : "...",
"ddp" : true,
"showTicketLogo" : true,
"customApiUser" : "...",
"customApiKey" : "...",
"htmlTemplate" : "...",
"mainCarrier" : { },
"perProduct" : true
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
}
}