Get couriers

get
/couriers

Return a list of couriers.

active
boolean

get user activated couriers

slug
string

Unique courier code Use comma for multiple values. (Example: dhl,ups,usps)

>= 1 characters
Example:
usps
Match pattern:
^[a-z0-9-]+$
Content-Type
string
required

Content-Type

Allowed value:
application/json
Default:
application/json
Example:
application/json

Couriers object

Model of all couriers endpoint response

meta
meta
required

Meta data

code
integer
required

meta code

Example:
200
message
string

error message, only exist if the response status is not 2xx

type
string

error type, only exist if the response status is not 2xx

Allowed values:
BadRequestUnauthorizedForbiddenNotFoundTooManyRequestsInternalError
data
object
required
total
integer

Total count of courier objects

couriers
array[Courier]

Array of Courier object.

Auth
:
Parameters
:
:
:
Response Example
{ "meta": { "code": 200 }, "data": { "total": 1, "couriers": [ { "slug": "ups-api", "name": "UPS", "phone": "+1 800 742 5877", "other_name": "United Parcel Service", "web_url": "https://www.ups.com", "required_fields": [], "optional_fields": [], "default_language": "en", "support_languages": [ "en" ], "service_from_country_regions": [], "credentials": { "fields": [ { "name": "user_id", "type": "string", "required": true }, { "name": "password", "type": "string", "required": true }, { "name": "access_license_number", "type": "string", "required": true } ] } } ] } }