Get Carrier Accounts

Request

The operation retrieves onboarded carriers with their Carrier Account IDs, which uniquely identify multiple accounts of the same carrier.

Note: To receive a paginated response, provide both the optional page and size query parameters. Else, the API returns all carrier accounts in response as a default behavior.

Security

bearerAuth

Query

pagestring

The page of the Shipments search result list.

sizestring

The size/count of the searched result list.

X-PB-Developer-Partner-Idstring

The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required.

X-PB-LocationIdstring

When the X-PB-LocationId header is provided, the API returns only the carrier accounts associated with the specified Location ID. If the header is not provided, API will return all carrier accounts.

curl -i -X GET \
  'https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/carrierAccounts?page=string&size=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-PB-Developer-Partner-Id: string' \
  -H 'X-PB-LocationId: string'

Responses

A list of Carrier Accounts has been fetched.

Bodyapplication/json

pageInfoobject

dataobject

Response

{
  "pageInfo": {
    "total": 78,
    "pages": 8,
    "page": 1
  },
  "data": {
    "carrierAccounts": [
      { … }
    ]
  }
}