PIpitneybowes
Carrier Accounts

Get Carrier

Get Carrier Account details API

get/api/v1/carrierAccounts/{carrierAccountID}

Request

Path parameters

carrierAccountIDstring required

Unique identifier of carrier account created

Headers

X-PB-Developer-Partner-IDstring

Response

Carrier Added Successfully

carrierAccountIDstring

Unique identifier of carrier account created

accountNumberstring

Unique identifier of the account

carrierID'FEDEX' | 'UPS' | 'DHLEXP'

It defines the carrier ID, can be get from Get Carriers API

descriptionstring

It defines the carrier account name

carrierAccountTypestring

This defines carrier account type

provisioningTypestring

It defines the provisioning method

Example response

{
  "carrierAccountID": "abc3849",
  "accountNumber": "123338",
  "carrierID": "FEDEX",
  "description": "FedEx Account",
  "carrierAccountType": "Shipping",
  "provisioningType": "API",
  "parameters": {
    "username": "abcjsk",
    "accountAddress": {
      "addressLine1": "27 Watervw Dr",
      "city": "shelton",
      "state": "CT",
      "postalCode": "06484",
      "countryCode": "US"
    },
    "contactAddress": {
      "addressLine1": "27 Watervw Dr",
      "city": "shelton",
      "state": "CT",
      "postalCode": "06484",
      "countryCode": "US"
    },
    "hubID": "1544",
    "invoiceAmount": "2121",
    "invoiceControlID": "123D",
    "invoiceDate": "20201203",
    "invoiceNumber": "saas212121"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.