# ShipSaving Legacy API

Version: v1
License: Apache 2.0

## Servers

Production server
```
https://api.shipsaving.com
```

## Security

### ApiTokenAuth

Type: apiKey
In: query
Name: api_token

## Download OpenAPI description

[ShipSaving Legacy API](https://docs.shipsaving.com/_bundle/1.0-api/openapi.yaml)

## Label Management

### Get Rate

 - [POST /api/rates/list](https://docs.shipsaving.com/1.0-api/openapi/label-management/getratelist.md): Retrieve shipping rates for a given package and address.  Rate limit: 600 requests per minute.

### Buy Label

 - [GET /api/rates/buy](https://docs.shipsaving.com/1.0-api/openapi/label-management/purchaselabel.md): Purchase a shipping label based on the provided rate ID.
Rate limit: 600 requests per minute.

### Directly Buy Label

 - [POST /api/rates/buy-label](https://docs.shipsaving.com/1.0-api/openapi/label-management/directlybuylabel.md): Purchases a shipping label directly without comparing multiple carrier options. This endpoint is applicable only when there is a single carrier configured for each carrier type in the user's account. If multiple carriers of the same type exist, use the Get Rate API to retrieve options, then call the Buy Label API to complete the purchase.  Rate limit: 600 requests per minute.

### Void Label

 - [POST /api/shipments/void](https://docs.shipsaving.com/1.0-api/openapi/label-management/voidlabel.md): Voids a purchased shipping label using the shipment’s tracking number.   Rate limit: 600 requests per minute.

## Order Management

### Create Orders

 - [POST /api/orders/create](https://docs.shipsaving.com/1.0-api/openapi/order-management/createorders.md): Creates a new order in the ShipSaving system. Typically used to pre-create orders before generating shipping labels.
Rate limit: 300 requests per minute.

### Check Order Labels

 - [GET /api/shipments/get](https://docs.shipsaving.com/1.0-api/openapi/order-management/checkorderlabels.md): Retrieves the shipment label details for a specified store and order number. Applicable only to orders with a purchased shipping label. Rate limit: 120 requests per minute.

### Delete an order

 - [DELETE /api/orders/delete](https://docs.shipsaving.com/1.0-api/openapi/order-management/deleteorder.md): Deletes an existing order from the ShipSaving system by specifying both the store name and order number. This action is irreversible and will permanently remove the order and its associated data. Rate limit: 300 requests per minute.

## Address Verification

### Address Verification

 - [POST /api/addresses/verify](https://docs.shipsaving.com/1.0-api/openapi/address-verification/verifyaddress.md): Verifies and standardizes an address based on the provided details.
This API checks for errors and returns suggestions or corrections. 
Rate limit: 600 requests per minute.

## SCAN Form

### Create USPS SCAN Form

 - [POST /api/shipments/scan-forms/create](https://docs.shipsaving.com/1.0-api/openapi/scan-form/createscanforms.md): Creates a USPS SCAN Form for the provided list of shipment tracking codes. 
Only applicable to shipments with valid USPS tracking numbers. 
Rate limit: 60 requests per minute.

### Create DHL eCommerce SCAN Form

 - [POST /api/shipments/scan-forms/dhl/ecommerce/create](https://docs.shipsaving.com/1.0-api/openapi/scan-form/createecsscanforms.md): Initiates the asynchronous creation of a DHL eCommerce SCAN Form. Returns a request ID that can be used with the Get DHL eCommerce SCAN Form endpoint to retrieve the final manifest PDF.   Rate limit: 60 requests per minute.

### Get DHL eCommerce SCAN Form

 - [GET /api/shipments/scan-forms/dhl/ecommerce/get](https://docs.shipsaving.com/1.0-api/openapi/scan-form/getecsscanforms.md): Returns the DHL eCommerce SCAN Form PDF URL based on the request ID from the creation endpoint.   Rate limit: 60 requests per minute.

## Carrier Management

### Get Carrier Account List

 - [GET /api/carrier-account/list](https://docs.shipsaving.com/1.0-api/openapi/carrier-management/getcarrieraccountlist.md): Retrieves the list of carrier accounts associated with the authenticated API token.
Rate limit: 60 requests per minute.

## Account Management

### Get Account Balance

 - [GET /api/balance](https://docs.shipsaving.com/1.0-api/openapi/account-management/querybalance.md): Retrieves real-time account balance in USD.
Rate limit: 60 requests per minute.