Skip to main content
POST

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. Every supplied amount includes value and currency; every supplied weight or dimension includes value and unit. Within one shipment, all non-null amounts use the same currency, all weights use the same unit, and all parcel dimensions use the same unit. Missing or invalid object fields and mixed currencies or units return 422; currency and units never fall back to team defaults. Missing weights or dimensions remain unspecified during discovery. Does not create a shipment or reserve carrier capacity.

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 | object

Total goods value excluding tax.

Example:
tax_amount
null | object

Total goods tax.

Example:
duty_amount
null | object

Total goods duty.

Example:
shipping_net_amount
null | object

Shipping cost excluding tax.

Example:
shipping_tax_amount
null | object

Shipping tax.

Example:

Response

Delivery options retrieved successfully

data
object[]
required