# Carrier Onbording APIs

The Carrier Accounts APIs provide capabilities to onboard and manage carrier accounts used for shipment processing.<br/> These services include creating and maintaining carrier accounts, configuring carrier-specific details and capabilities, and retrieving supporting hub information for applicable carriers.<br/> Carrier accounts enable authentication with carriers and are required for rating, shipment creation, and label generation.


Version: 0.1

## Servers

```
https://api-dev.sendpro360.pitneycloud.com/carrieraccountmgmt
```

```
https://api-dev.sendpro360.pitneycloud.com/metadata
```

```
https://api-qa.sendpro360.pitneycloud.com/carrieraccountmgmt
```

```
https://api-qa.sendpro360.pitneycloud.com/metadata
```

```
https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt
```

Sandbox Server for Carrier Account
```
https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt
```

Sandbox Server for Hub API
```
https://api-sandbox.sendpro360.pitneybowes.com/metadata
```

Production Server for Carrier Account (uses live data)
```
https://api.sendpro360.pitneybowes.com/carrieraccountmgmt
```

Production Server for Hub API (uses live data)
```
https://api.sendpro360.pitneybowes.com/metadata
```

Sandbox Server for Canada
```
https://api-ppd.shipping360.pitneybowes.com/ca/shipping
```

Production Server for Canada
```
https://api.shipping360.pitneybowes.com/ca/shipping
```

## Security

### basicAuth

Type: http
Scheme: basic

### bearerAuth

Type: http
Scheme: bearer

## Download OpenAPI description

[Carrier Onbording APIs](https://docs.sendpro360.pitneycloud.com/_bundle/openapi/carrieraccounts.yaml)

## Carrier Accounts

APIs to create, retrieve, update, and delete carrier accounts, and to retrieve supporting hub details required for specific carriers.

### Add Carrier

 - [POST /api/v1/carrierAccounts](https://docs.sendpro360.pitneycloud.com/openapi/carrieraccounts/carrier-accounts/addcarrieraccount.md): Add Carrier Account API

### Update Carrier

 - [PUT /api/v1/carrierAccounts/{carrierAccountID}](https://docs.sendpro360.pitneycloud.com/openapi/carrieraccounts/carrier-accounts/updatecarrieraccount.md): 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.

### Get Carrier

 - [GET /api/v1/carrierAccounts/{carrierAccountID}](https://docs.sendpro360.pitneycloud.com/openapi/carrieraccounts/carrier-accounts/getcarrieraccount.md): Get Carrier Account details API

### Delete Carrier

 - [DELETE /api/v1/carrierAccounts/{carrierAccountID}](https://docs.sendpro360.pitneycloud.com/openapi/carrieraccounts/carrier-accounts/deletecarrieraccount.md): Delete Carrier Account API

### Get FedEx Smartpost hub details

 - [GET /api/v1/hubs](https://docs.sendpro360.pitneycloud.com/openapi/carrieraccounts/carrier-accounts/getfedexsmartposthubdetails.md): Get FedEx Smartpost hub details