# ShipSaving Legacy API

Version: v1
License: Apache 2.0

## Servers

[object Object]
```
https://api.shipsaving.com
```

## Security

### ApiTokenAuth

Type: apiKey
In: query
Name: api_token

## Download OpenAPI description

 - [ShipSaving Legacy API](https://docs.shipsaving.com/_bundle/@l10n/zh-Hans/v1/openapi.yaml)

## 运单管理

 - [POST /api/rates/list](https://docs.shipsaving.com/zh-hans/v1/openapi/%E8%BF%90%E5%8D%95%E7%AE%A1%E7%90%86/getratelist.md): 根据指定的包裹信息和地址获取运费报价。 </br> **限流说明：** 每分钟最多600次请求。
 - [GET /api/rates/buy](https://docs.shipsaving.com/zh-hans/v1/openapi/%E8%BF%90%E5%8D%95%E7%AE%A1%E7%90%86/purchaselabel.md): 根据提供的运费报价ID购买运单面单。 </br> **限流说明：** 每分钟最多600次请求。
 - [POST /api/rates/buy-label](https://docs.shipsaving.com/zh-hans/v1/openapi/%E8%BF%90%E5%8D%95%E7%AE%A1%E7%90%86/directlybuylabel.md): 在无需比较多个承运商选项的情况下直接购买运单面单。 仅当用户账户中针对每种承运商类型只配置了一个承运商时，才适用该接口。 若同一类型下存在多个承运商，请先使用查询包裹价格列表接口获取可选方案，再调用购买包裹接口完成购买。 </br> **限流说明：** 每分钟最多600次请求。
 - [POST /api/shipments/void](https://docs.shipsaving.com/zh-hans/v1/openapi/%E8%BF%90%E5%8D%95%E7%AE%A1%E7%90%86/voidlabel.md): 通过运单的追踪号码作废已购买的运单面单。 </br> **限流说明：** 每分钟最多600次请求。
## 订单管理

 - [POST /api/orders/create](https://docs.shipsaving.com/zh-hans/v1/openapi/%E8%AE%A2%E5%8D%95%E7%AE%A1%E7%90%86/createorders.md): 在 ShipSaving 系统中创建一个新订单。通常用于在生成运单面单之前预先创建订单。 </br> **速率限制：** 每分钟最多 300 次请求。
 - [GET /api/shipments/get](https://docs.shipsaving.com/zh-hans/v1/openapi/%E8%AE%A2%E5%8D%95%E7%AE%A1%E7%90%86/checkorderlabels.md): 获取指定店铺及订单号对应的运单面单信息。仅适用于已成功购买运单面单的订单。 </br> **速率限制：** 每分钟最多 120 次请求。
 - [DELETE /api/orders/delete](https://docs.shipsaving.com/zh-hans/v1/openapi/%E8%AE%A2%E5%8D%95%E7%AE%A1%E7%90%86/deleteorder.md): 通过指定店铺名称和订单号，从 ShipSaving 系统中删除一个已有订单。该操作不可逆，将永久删除订单及其关联数据。 </br> **速率限制：** 每分钟最多 300 次请求。
## 地址校验

 - [POST /api/addresses/verify](https://docs.shipsaving.com/zh-hans/v1/openapi/%E5%9C%B0%E5%9D%80%E6%A0%A1%E9%AA%8C/verifyaddress.md): 根据提供的地址信息进行校验与标准化处理。 该接口会检测地址错误，并返回可能的修正或建议。 </br> **速率限制：** 每分钟最多 600 次请求。
## SCAN Form

 - [POST /api/shipments/scan-forms/create](https://docs.shipsaving.com/zh-hans/v1/openapi/scan-form/createscanforms.md): 根据提供的运单追踪号列表创建 USPS SCAN Form。 </br> **速率限制：** 每分钟最多 60 次请求。
 - [POST /api/shipments/scan-forms/dhl/ecommerce/create](https://docs.shipsaving.com/zh-hans/v1/openapi/scan-form/createecsscanforms.md): 发起 DHL eCommerce SCAN Form的异步创建流程。 接口将返回一个请求 ID，可用于通过“获取 DHL eCommerce SCAN Form”接口获取最终的PDF文件。 </br> **速率限制：** 每分钟最多 60 次请求。
 - [GET /api/shipments/scan-forms/dhl/ecommerce/get](https://docs.shipsaving.com/zh-hans/v1/openapi/scan-form/getecsscanforms.md): 根据创建接口返回的请求 ID，获取 DHL eCommerce SCAN Form PDF 下载地址。 </br> **速率限制：** 每分钟最多 60 次请求。
## 承运商管理

 - [GET /api/carrier-account/list](https://docs.shipsaving.com/zh-hans/v1/openapi/%E6%89%BF%E8%BF%90%E5%95%86%E7%AE%A1%E7%90%86/getcarrieraccountlist.md): 获取与当前 API Token 关联的承运商账户列表。 </br> **速率限制：** 每分钟最多 60 次请求。
## 账户管理

 - [GET /api/balance](https://docs.shipsaving.com/zh-hans/v1/openapi/%E8%B4%A6%E6%88%B7%E7%AE%A1%E7%90%86/querybalance.md): 获取账户的实时余额（美元）。 </br> **速率限制：** 每分钟最多 60 次请求。