API ReferenceDocs
API Reference
Dashboard
These docs are for v2023.01. Click to read the latest docs for v2024.09.

List all Couriers

get
https://api.easyship.com/2023-01/couriers

Retrieve a list of couriers available with your account.

Required authorization scope: Courier

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1

Page number to fetch, default: 1

integer
1 to 100

Number of records per page to fetch, default: 20

string
enum

Sort records by listed columns. Default: created_at

Allowed:
string
enum

Set the sort direction. Default: DESC

Allowed:
country_alpha2
array of strings

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

country_alpha2
string

Filter records by courier umbrella name

boolean
deprecated

Filter records if the courier accepts any type of returns (prepaid or pay on scan)

boolean

Filter records if the courier accepts prepaid returns

boolean

Filter records if the courier accepts accepts pay on scan returns

boolean

Filter records if the courier accepts battery (pi965)

boolean

Filter records if the courier accepts battery (pi966)

boolean

Filter records if the courier accepts battery (pi967)

boolean

Filter records if the courier accepts liquids

boolean

Filter records if the courier accepts dangerous goods

boolean

Filter records if the courier does not accept dangerous goods

boolean

Filter records if the courier accepts documents

boolean

Filter records if the courier accepts parcels

string

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

boolean

Filter records if the courier is international service

string
enum

Filter records if the courier supports DDUs, DDPs or both

Allowed:
Response

Updated 10 months ago

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago