Get Carrier Accounts

Request

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

Security

bearerAuth

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 \
  -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

carrierAccountsArray of objects

Response

{
  "carrierAccounts": [
    {
      "carrierAccountId": "abcd12",
      "carrierName": "FedEx"
    },
    {
      "carrierAccountId": "xyz12",
      "carrierName": "UPS"
    },
    {
      "carrierAccountId": "12prqs",
      "carrierName": "USPS"
    }
  ]
}