Skip to content

Add Carrier

Request

Add Carrier Account API

Security
bearerAuth
Headers
X-PB-Developer-Partner-IDstring

This is the Developer Partner ID. When the developer is the only partner, this field is not required.

X-PB-LocationIdstring

This header is required when onboarding a carrier belongs to a locarion other than the developer's default location.

Bodyapplication/jsonrequired
accountNumberstring

Unique identifier of the account

Example:"123338"
carrierIDstring

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

Enum:"FEDEX""UPS""DHLEXP""SPEEDEE""NORATE"
Example:"FEDEX"
descriptionstring

It defines the carrier account name

Example:"FedEx Account"
parametersobject

It lists the additional details required adding carrier account

curl -i -X POST \
  https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt/api/v1/carrierAccounts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-PB-Developer-Partner-ID: string' \
  -H 'X-PB-LocationId: string' \
  -d '{
    "accountNumber": "123338",
    "carrierID": "FEDEX",
    "description": "FedEx Account",
    "parameters": {
      "username": "abcjsk",
      "password": "*******",
      "accountAddress": {
        "addressLine1": "27 Watervw Dr",
        "city": "shelton",
        "state": "CT",
        "postalCode": "06484",
        "countryCode": "US",
        "email": "",
        "company": "",
        "name": "",
        "phone": ""
      },
      "contactAddress": {
        "addressLine1": "27 Watervw Dr",
        "city": "shelton",
        "state": "CT",
        "postalCode": "06484",
        "countryCode": "US",
        "email": "",
        "company": "",
        "name": "",
        "phone": ""
      },
      "hubID": "1544",
      "invoiceAmount": "2121",
      "invoiceControlID": "123D",
      "invoiceDate": "20201203",
      "invoiceNumber": "saas212121",
      "hostName": "gppprt2ftp-ext.test.com",
      "manifestUserId": "testuser",
      "manifestPassword": "testpassword",
      "manifestPath": "/in"
    }
  }'

Responses

Carrier Added Successfully

Bodyapplication/json
carrierAccountIDstring

Unique identifier of carrier account created

Example:"abc3849"
accountNumberstring

Unique identifier of the account

Example:"123338"
carrierIDstring

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

Enum:"FEDEX""UPS""DHLEXP"
Example:"FEDEX"
descriptionstring

It defines the carrier account name

Example:"FedEx Account"
carrierAccountTypestring

This defines carrier account type

Example:"Shipping"
provisioningTypestring

It defines the provisioning method

Example:"API"
parametersobject

It lists the additional details required adding carrier account

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", "email": "", "company": "", "name": "", "phone": "" }, "contactAddress": { "addressLine1": "27 Watervw Dr", "city": "shelton", "state": "CT", "postalCode": "06484", "countryCode": "US", "email": "", "company": "", "name": "", "phone": "" }, "hubID": "1544", "invoiceAmount": "2121", "invoiceControlID": "123D", "invoiceDate": "20201203", "invoiceNumber": "saas212121" } }