PIpitneybowes
Carrier Accounts

Update Carrier

The Update Carrier operation enables you to update a carrier account and specifies its usable capabilities. By default, all available services, parcel types, and special services provided by the carrier are accessible. With this API, you can specify only the capabilities (services, parcel types, special services) that should be available for Rate Shop and Create Shipment operations. If a shipment request attempts to use a capability not enabled through this API, an error will be returned.

put/api/v1/carrierAccounts/{carrierAccountID}

Request

Path parameters

carrierAccountIDstring required

Unique identifier of carrier account created

Headers

X-PB-Developer-Partner-IDstring

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",
    "capabilities": {
      "services": [
        "NDA"
      ],
      "parcelTypes": [
        "LTR"
      ],
      "specialServices": [
        "INS"
      ]
    }
  }
}

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",
    "capabilities": {
      "services": [
        "NDA"
      ],
      "parcelTypes": [
        "LTR"
      ],
      "specialServices": [
        "INS"
      ]
    }
  },
  "permission": {
    "permissionByEntity": "ORG",
    "permissionByValue": "12345"
  }
}

Changes

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