v1

latestOpenAPI 3.0.32026-07-26170311887.2 KB

Couriers

List all Couriers

Retrieve a list of active couriers.

Required authorization scope: public.courier:read

get/2024-09/couriers

pageinteger

Page number to fetch, default: 1

per_pageinteger

Number of records per page to fetch, default: 20

sort_by'customer_reference_id' | 'umbrella_name' | 'country_alpha2' | '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).

customer_reference_idstring

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

auth_statestring[]

Filter records by auth state.

statestring[]

Filter records by courier state.

umbrella_namestring

Filter records by umbrella name.

active_courier_servicesboolean

Filter records to only those with available courier services.

easyship_courierboolean

Whether the courier belongs to Easyship or not.

list of couriers