Skip to main content
GET
List available routes

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

carrier
string

Filter by carrier code

Examples:

"postnord"

"bring"

"dao"

"gls"

merchant_country
string

Filter by the merchant's ISO 3166-1 alpha-2 country code. The merchant dispatches outbound shipments and receives returns. Omit to use the team's sender-address country for outbound services, or its return-address country for return services, falling back to the sender-address country. A country must be supplied or resolvable from team settings.

Required string length: 2
Pattern: ^[A-Z]{2}$
Examples:

"DK"

"SE"

"FI"

"NO"

"DE"

"ES"

"US"

"CN"

"CA"

customer_country
string

Filter by the customer's ISO 3166-1 alpha-2 country code. The customer receives outbound shipments and dispatches returns. Omit to leave the customer country unrestricted. The meaning of this filter does not change with is_return.

Required string length: 2
Pattern: ^[A-Z]{2}$
Examples:

"DK"

"SE"

"FI"

"NO"

"DE"

"ES"

"US"

"CN"

"CA"

addon
string

Filter by addon code — only return routes that support this addon (e.g., SIGNATURE)

Example:

"SIGNATURE"

is_pickup
boolean

Filter by pickup services (true) or home delivery services (false)

is_return
boolean
default:false

Filter by return services (true) or outbound services (false, the default). The merchant and customer country roles stay fixed; only the physical transport direction changes.

Response

Routes retrieved successfully

data
object[]
required