Put Provider Account
Use this endpoint to add or update carrier/provider account information.
REST Endpoint
PUT /restapi/v1/customers/:customerId/provider-accounts/:providerCode
providerCode must be one of ups or fedex
Request Content Type
application/json
Request JSON Example
{
"accountFields": {
"accountNumber": "1234",
"key": "abcd",
"password": "xyz",
"meterNumber": "aaa123"
}
}
Explanation of Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
| accountFields | object | true | Provider specific account fields |
| accountFields.accountNumber (FedEx) | string | true (FedEx only) | FedEx Account Number |
| accountFields.key (FedEx) | string | true (FedEx only) | FedEx Key |
| accountFields.password (FedEx) | string | true (FedEx only) | FedEx Password |
| accountFields.meterNumber (FedEx) | string | true (FedEx only) | FedEx Meter Number |
| accountFields.accountNumber (UPS) | string | true (UPS only) | UPS Account Number |
| accountFields.userId (UPS) | string | true (UPS only) | UPS User ID |
| accountFields.password (UPS) | string | true (UPS only) | UPS Password |
| accountFields.accessLicenceNumber (UPS) | string | true (UPS only) | UPS Access License Number |
Response Status Code
201 OK