# 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
```

Admin Sandbox Server for global region
```
https://admin-ppd.spo.pitneybowes.com/shipping
```

Admin Production Server for global region
```
https://admin-global.shipping360.pitneybowes.com/shipping
```

Client Sandbox Server for global region
```
https://app-global-ppd.spo.pitneybowes.com/shipping
```

Client Production Server for global region
```
https://app-global.shipping360.pitneybowes.com/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

 - [POST /api/v1/carrierAccounts](https://docs.sendpro360.pitneycloud.com/openapi/carrieraccounts/carrier-accounts/addcarrieraccount.md): Add Carrier Account API
 - [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 carri
 - [GET /api/v1/carrierAccounts/{carrierAccountID}](https://docs.sendpro360.pitneycloud.com/openapi/carrieraccounts/carrier-accounts/getcarrieraccount.md): Get Carrier Account details API
 - [DELETE /api/v1/carrierAccounts/{carrierAccountID}](https://docs.sendpro360.pitneycloud.com/openapi/carrieraccounts/carrier-accounts/deletecarrieraccount.md): Delete Carrier Account API
 - [GET /api/v1/hubs](https://docs.sendpro360.pitneycloud.com/openapi/carrieraccounts/carrier-accounts/getfedexsmartposthubdetails.md): Get FedEx Smartpost hub details