List carriers

Retrieves a list of carriers registered for current marketplace, narrowed by the optional filters (name, enabled services, countries, status, rules).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Filter by Mode

Allowed:
string

Case-insensitive search on the carrier display name.

shippingTypes
array of strings

Carriers with at least one of these services ENABLED (an activated method with the price switched on, directly or through its rule).

shippingTypes
Allowed:
regions
array of strings

Region tokens — ES (any method covering the country) or ES:M (a method covering that province, or the whole country). Carriers matching any token.

regions
enabled
array of booleans

Carrier status: true = active (some method activated), false = inactive. Both (or none) = no filter.

enabled
hasRules
array of booleans

Whether any method price of the carrier carries a rule. Both (or none) = no filter.

hasRules
Responses

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