Retrive Carrier List

Request

This operation retrieves a list of carriers associated with the specific location/s.

Security

bearerAuth

Query

sizeinteger

The number of results to return in a single page of the carrier list.

Example:size=50

pageinteger

The page number to retrieve.

Example:page=1

barcodeAwareboolean

Indicates whether to retrieve carriers that are barcode-aware. When set to true, the response includes only those carriers capable of processing barcodes.

Example:barcodeAware=true

Bodyapplication/jsonrequired

Array [

string

An array containing locations. Each element is a string representing one or more locations. If multiple locations are provided, they should be comma-separated.

]

curl -i -X POST \
  'https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack/api/v1/carriers?size=50&page=1&barcodeAware=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    "B9Ol8nDqpq1"
  ]'

Responses

Carrier list has been retrived successfully.

Bodyapplication/json

carriersArray of objects

List of carriers.

recentCarriersArray of objects(CarrierTrans)

List of recent carriers

totalCountinteger

Total count of carriers.

Response

{
  "carriers": [
    {
      "carrierId": "XXXX",
      "name": "Amazon",
      "barcodeAware": true,
      "isCustom": false
    }
  ],
  "recentCarriers": [
    {
      "name": "string",
      "carrierId": "string"
    }
  ],
  "totalCount": 0
}