# Ship via Code APIs

Ship Via Code APIs provide capabilities to create and manage reusable shipping configurations that combine carrier, carrier account, parcel type, service, and special services into a single identifier. <br/>These APIs help simplify shipment creation by allowing you to reference a predefined ship via code instead of repeatedly providing the same carrier configuration details in each request. <br/>The APIs support the following services:
- Create a ship via code with predefined carrier configuration
- Retrieve all ship via codes or a specific code by identifier
- Update an existing ship via code configuration
- Delete a ship via code
<br/>Use these APIs to standardize shipping configurations, reduce repetitive input, and streamline shipment workflows when using the Create Shipment API.


Version: 1.0.0
License: PB Software License Agreement

## Servers

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

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

Sandbox Server
```
https://api-sandbox.sendpro360.pitneybowes.com/shipping
```

Production Server (uses live data)
```
https://api.sendpro360.pitneybowes.com/shipping
```

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

### bearerAuth

Type: http
Scheme: bearer

## Download OpenAPI description

 - [Ship via Code APIs](https://docs.sendpro360.pitneycloud.com/_bundle/openapi/shipviacode.yaml)

## Ship Via Code

 - [POST /api/v1/shipviacode](https://docs.sendpro360.pitneycloud.com/openapi/shipviacode/ship-via-code/createshipviacode.md): Create a ship via code that represents a specific combination of carrier, carrier account, parcel type, service, and special services. This ship via code can then be used in the **Create Shipment API*
 - [GET /api/v1/shipviacode](https://docs.sendpro360.pitneycloud.com/openapi/shipviacode/ship-via-code/getshipviacodes.md): Returns a list of ship via codes.
 - [GET /api/v1/shipviacode/{code}](https://docs.sendpro360.pitneycloud.com/openapi/shipviacode/ship-via-code/getshipviacodebycode.md): This operation retrieves the details of a specific ship via code mapping by its unique `code`. A ship via code represents a saved configuration of carrier, carrier account, parcel, service, and specia
 - [PUT /api/v1/shipviacode/{code}](https://docs.sendpro360.pitneycloud.com/openapi/shipviacode/ship-via-code/updateshipviacode.md): This operation Updates the configuration for the specified ship via code. The ship via code itself **cannot** be changed. If provided in the body, it will be ignored.
 - [DELETE /api/v1/shipviacode/{code}](https://docs.sendpro360.pitneycloud.com/openapi/shipviacode/ship-via-code/deleteshipviacode.md): This operation deletes the ship via code mapping by its unique `code`.