PIpitneybowes
Carrier Accounts

Add Carrier

Add Carrier Account API

post/api/v1/carrierAccounts

Request

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.

Request body

accountNumberstring

Unique identifier of the account

carrierID'FEDEX' | 'UPS' | 'DHLEXP' | 'SPEEDEE' | 'NORATE'

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

descriptionstring

It defines the carrier account name

Example request

{
  "accountNumber": "123338",
  "carrierID": "FEDEX",
  "description": "FedEx Account",
  "parameters": {
    "username": "abcjsk",
    "password": "*******",
    "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",
    "hostName": "gppprt2ftp-ext.test.com",
    "manifestUserId": "testuser",
    "manifestPassword": "testpassword",
    "manifestPath": "/in"
  }
}

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.