Get courier connections - AfterShip Tracking API Docs

Get courier connection results of multiple courier connections.

Request

Security: API Key

Query Parameters

courier_slug

string

Unique courier code.(Example: dhl-api)

cursor

string

A string representing the cursor value for the current page of results.

limit

string

Number of courier connections each page contain. (Default: 100, Max: 200)

Headers

Content-Type

string

required

Content-Type

Responses

200 Body

Courier connection response for getting courier connections

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

pagination

object

courier_connections

array[courier_connection]

This model represents user-created courier connection details. AfterShip will use this information to retrieve tracking updates from carriers based on the provided tracking numbers.

Auth

Parameters

Response Example

{
  "meta": {
    "code": 200
  },
  "data": {
    "pagination": {
      "total": 1,
      "next_cursor": "",
      "has_next_page": false
    },
    "courier_connections": [
      {
        "id": "ed0319bbd6cd4cd98df761cb474dec44",
        "courier_slug": "dhl-api",
        "credentials": {
          "api_key": "Xci90MlaeeE!wpqd4CqM"
        },
        "created_at": "2025-03-24T03:18:32+08:00",
        "updated_at": "2025-03-24T03:18:32+08:00"
      }
    ]
  }
}