Sign in

v1

latestOpenAPI 3.0.32026-07-26170311887.2 KB
Couriers

List all Courier Services of a Courier

Retrieve a list of courier services for selected courier.

Required authorization scope: public.courier_service:read

get/2024-09/couriers/{courier_id}/courier_services

Path parameters

courier_idstring required

The Courier ID

Query parameters

pageinteger

Page number to fetch, default: 1

per_pageinteger

Number of records per page to fetch, default: 20

sort_by'origin_country_id' | 'courier_name' | 'created_at'

Sort records by listed columns. Default: created_at

sort_direction'ASC' | 'DESC'

Set the sort direction. Default: DESC

country_alpha2string[]

Filter records by country code: Alpha-2 format (ISO 3166-1).

umbrella_namestring

Filter records by courier umbrella name

customer_reference_idstring

An identifier for a customer (available only for selected customers)

acceptsstring[]

Filter records by acceptance criteria

prohibit_dangerous_goodsboolean

Filter records if the courier does not accept dangerous goods

supported_incotermsstring[]

Filter records if the courier supports DDUs, DDPs or both

internationalboolean

Filter records if the courier is an international service

domesticboolean

Filter records if the courier is an domestic service

Response

list of courier services