GET
Get all

Authorizations

x-api-key
string
header
required

Query Parameters

warehouse_code
string

Code of the warehouse (CEDI). Only couriers configured for this warehouse are returned.

courier_company_code
string

Code of a courier company. Returns only that courier (if it matches the other filters).

inbound
enum<boolean>

Only couriers active for inbound service (delivering inventory to the warehouse). Only true is accepted. See "How the filters combine" for the default when omitted.

Available options:
true
outbound
enum<boolean>

Only couriers active for outbound service (delivering orders from the warehouse to buyers). Only true is accepted. See "How the filters combine" for the default when omitted.

Available options:
true

Response

List of courier companies matching the filters (can be empty).

id
integer
required

Courier company id. Use it as courier_company_id when creating a supplier order.

Example:

3

name
string
required

Display name of the courier company.

Example:

"TCC"

code
string
required

Unique code of the courier company. Can be used in the courier_company_code filter.

Example:

"TCC"