Add Carrier

Add Carrier Account API

SecuritybearerAuth
Request
header Parameters
X-PB-Developer-Partner-ID
string

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

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.

post/api/v1/carrierAccounts
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": {
    }
}