Skip to main content
POST
Get delivery options

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept-Language
string
default:en

Preferred language(s) for translatable content using BCP 47 language tags. Supports quality values (q-factors) for priority ordering. The API negotiates the best available language based on this header, the team's configured language, and available translations. If omitted, the team's default language is used.

Example:

"da-DK, da;q=0.9, en;q=0.8"

Request-ID
string

Optional client-supplied request identifier. When provided and matching the validation pattern, the value is echoed back in the Request-ID response header. Otherwise the server generates one. Use this to correlate requests between client and server when reporting issues.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._-]{1,64}$

Path Parameters

teamUuid
string<uuid>
required

Team uuid. All resources are scoped to this team.

Query Parameters

carriers
string[]

Only include rates from these carriers (e.g., postnord, gls)

is_return
boolean

Filter by return services (true) or outbound services (false). When omitted, return services are excluded by default.

Body

application/json

Use the same party, parcel and measurement structures as booking. currency, weight_unit and dimension_unit must be supplied explicitly; missing or null values return 422 without fallback to team defaults. Does not create a shipment or reserve carrier capacity.

currency
string
required

Required ISO 4217 currency code for all submitted shipment, parcel and item amounts. Amounts use currency minor units. No fallback to team defaults.

Required string length: 3
Pattern: ^[A-Z]{3}$
Example:

"EUR"

weight_unit
enum<string>
required

Required common unit for all submitted parcel and item weights. No per-value overrides or fallback to team defaults.

Available options:
g,
kg,
lb,
oz
Example:

"g"

dimension_unit
enum<string>
required

Required common unit for all submitted parcel and item dimensions. No per-value overrides or fallback to team defaults.

Available options:
mm,
cm,
m,
in
Example:

"cm"

parties
object
required

Omit merchant to use the appropriate team address. Pickup points belong to delivery.

parcels
object[]
required

Parcels in stable input order.

Minimum array length: 1
content_type
enum<string>

Type of contents in the shipment

Available options:
commercial_goods,
returned_goods,
gift,
commercial_sample,
documents,
other
total_net_amount
null | integer

Total goods value in minor units (cents) excluding tax

Example:

15920

tax_amount
null | integer

Total goods tax in minor units (cents)

Example:

3980

duty_amount
null | integer

Total goods duty in minor units (cents)

Example:

5572

shipping_net_amount
null | integer

Shipping cost in minor units (cents) excluding tax

Example:

3920

shipping_tax_amount
null | integer

Shipping tax in minor units (cents)

Example:

980

Response

Delivery options retrieved successfully

data
object[]
required