Skip to content

Update Carrier

Request

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.

Security
bearerAuth
Path
carrierAccountIDstringrequired

Unique identifier of carrier account created

Headers
X-PB-Developer-Partner-IDstring
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 PUT \
  'https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt/api/v1/carrierAccounts/{carrierAccountID}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-PB-Developer-Partner-ID: 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",
      "capabilities": {
        "services": [
          "NDA"
        ],
        "parcelTypes": [
          "LTR"
        ],
        "specialServices": [
          "INS"
        ]
      }
    }
  }'

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

permissionobject

Permission details that define access control for this 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", "capabilities": { "services": [ … ], "parcelTypes": [ … ], "specialServices": [ … ] } }, "permission": { "permissionByEntity": "ORG", "permissionByValue": "12345" } }