POST
Quote landed cost

Authorizations

Authorization
string
header
required

sk_test_ / sk_live_ / rk_test_ / rk_live_ keys

Headers

Shipping-Version
string
Shipping-Account
string

Act on behalf of a connected account (acct_...)

Idempotency-Key
string
Maximum string length: 255

Body

application/json
ship_from
object

A party to a shipment. Either name or company is required. address is required on ship_from, ship_to, return_to, bill_to.

ship_to
object

A party to a shipment. Either name or company is required. address is required on ship_from, ship_to, return_to, bill_to.

items
object[]
order
object
customs_declaration
object
shipment
string
service
string
currency
string
user_metadata
object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

Response

OK

id
string
required

Prefixed lc_

Example:

"lc_1Q2w3E4r"

object
enum<string>
required
Available options:
landed_cost
livemode
boolean
required
created
integer<unix-time>
required

Unix timestamp (seconds)

guaranteed
boolean
required
totals
object
required
updated
integer<unix-time>

Unix timestamp (seconds)

expires_at
integer<unix-time>

Unix timestamp (seconds)

currency
string
incoterm
string
regime
object
de_minimis
object
items
object[]
fees
object[]
messages
object[]
user_metadata
object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

carrier_metadata
object
read-only

Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.

system_metadata
object
read-only

Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.