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.

Note: Support for this capability in the Create and Rate Shipment APIs is under active development. It is targeted for next release, but availability may change before GA..

SecuritybearerAuth
Request
path Parameters
carrierAccountID
required
string

Unique identifier of carrier account created

header Parameters
X-PB-Developer-Partner-ID
string
Request Body schema: application/json
accountNumber
string

Unique identifier of the account

carrierID
string

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

Enum: "FEDEX" "UPS" "DHLEXP" "SPEEDEE" "NORATE"
description
string

It defines the carrier account name

object

It lists the additional details required adding carrier account

Responses
200

Carrier Added Successfully

400

Invalid request.

401

The request could not be authorized.

put/api/v1/carrierAccounts/{carrierAccountID}
Request samples
application/json
{
  • "accountNumber": "123338",
  • "carrierID": "FEDEX",
  • "description": "FedEx Account",
  • "parameters": {
    }
}
Response samples
application/json
{
  • "carrierAccountID": "abc3849",
  • "accountNumber": "123338",
  • "carrierID": "FEDEX",
  • "description": "FedEx Account",
  • "carrierAccountType": "Shipping",
  • "provisioningType": "API",
  • "parameters": {
    },
  • "permission": {
    }
}