Get couriers list

GET 
/couriers

Returns the list of couriers supported by TrackBot Pro. The list of couriers is also available in the Supported couriers page.

Responses

200

List of couriers supported by TrackBot Pro with their respective slugs.

application/json

Schema

Schema

data

object[]

Array [

slug string

Courier slug.

name string

Courier name.

]

Example (from schema)

{
  "data": [
    {
      "slug": "string",
      "name": "string"
    }
  ]
}

Example

{
  "data": [
    {
      "slug": "brt",
      "name": "BRT"
    },
    {
      "slug": "poste-italiane",
      "name": "Poste Italiane"
    },
    {
      "slug": "dhl-express",
      "name": "DHL Express"
    }
  ]
}

401

The API token in the request is missing or is invalid. See the Error responses page for more details.

application/json

Schema

Schema

error

object

status integerrequired

HTTP status code of the error.

message stringrequired

Human-readable message describing the error.

code string

Optional machine-readable code providing details about some 4xx errors.

Example (from schema)

{
  "error": {
    "status": 0,
    "message": "string",
    "code": "string"
  }
}

402

No active plan for the account or plan doesn't allow API/endpoint usage. See the Error responses page for more details.

application/json

Schema

Schema

error

object

status integerrequired

HTTP status code of the error.

message stringrequired

Human-readable message describing the error.

code string

Optional machine-readable code providing details about some 4xx errors.

Example (from schema)

{
  "error": {
    "status": 0,
    "message": "string",
    "code": "string"
  }
}

429

The API rate limit has been exceeded. See the Error responses page for more details.

application/json

Schema

Schema

error

object

status integerrequired

HTTP status code of the error.

message stringrequired

Human-readable message describing the error.

code string

Optional machine-readable code providing details about some 4xx errors.

Example (from schema)

{
  "error": {
    "status": 0,
    "message": "string",
    "code": "string"
  }
}

Loading...