API
获取scanform文件接口
更新时间： 2025-11-13 12:06:55 访问次数：2092

接口说明

通过本接口可获取USPS scanform文件
支持供应商：

  • USPS：Scanform文件

使用场景

通过提供已发货的USPS跟踪号，获取USPS scanform文件

提前确定大小包关系，通过此接口获取大包号和大包箱单。订单出库时，在大包外粘贴大包箱单，供应商扫描大包时，大包内小包都将产生轨迹，加快您的订单上网速度。

接口名称

pis.scanForm.queryUspsScan

请求说明

请求内容 说明
URL https://openapi.winit.com.cn/openapi/service
接口测试 https://sandboxopenapi.winit.com.cn/openapi/service
验证方法 Token,md5
格式 json
字符编码 UTF-8
http请求方式 http
请求数限制 每次请求限制5000单
接口版本Version 1

请求入参

名称 类型 必填 说明 示例
warehouseCode String(50) N 仓库代码，根据仓库代码获取发货仓地址信息 US0001
orderVo Array Y 快递单号List，单次请求限制5000个。单号较多时，接口返回较慢，请设置接口超时时间为10min
– trackingNo String(50) Y 跟踪号

请求示例

  1. {
  2.     "action": "pis.scanForm.queryUspsScan",
  3.     "app_key": "rebecca",
  4.     "data": {
  5.         "orderVo": [
  6.             {
  7.                 "trackingNo": "923xxxxxxxxxxxxx"
  8.             },
  9.             {
  10.                 "trackingNo": "923xxxxxxxxxxxxx"
  11.             },
  12.             {
  13.                 "trackingNo": "923xxxxxxxxxxxxx"
  14.             }
  15.         ],
  16.         "warehouseCode": "US0001"
  17.     },
  18.     "format": "json",
  19.     "language": "zh_CN",
  20.     "sign": "00000000000000000000000000000000",
  21.     "sign_method": "md5",
  22.     "platform": "OWNERERP",
  23.     "timestamp": "2024-04-09 00:19:26",
  24.     "version": "1.0"
  25. }

返回出参

返回参数说明：正确的返回编码code：0及结果data，错误的返回错误码及错误信息msg。

名称 类型 必传 说明 示例
scanFormNumbers Arraylist Y scanform文件号码
scanFormFile String Y Scanform Base64文件流

返回示例

成功：code=0

  1. {
  2.     "code": "0",
  3.     "msg": "操作成功",
  4.     "data": {
  5.         "scanFormNumbers": [
  6.             "LCSSF005795950001"
  7.         ],
  8.         "scanFormFile": "BASE64文件流",
  9.         "status": "SUCCESS",
  10.         "failedTrackingNos": [],
  11.         "successedTrackingNos": [
  12.             "923xxx"
  13.         ],
  14.         "failedMsg": ""
  15.     }
  16. }

部分成功，部分失败：code=0

  1. {
  2.     "code": "0",
  3.     "msg": "操作成功",
  4.     "data": {
  5.         "scanFormNumbers": [
  6.             "LCSSF005795480001"
  7.         ],
  8.         "scanFormFile": "base64文件流",
  9.         "status": "SUCCESS",
  10.         "failedTrackingNos": [
  11.             "9236290327908750050373"
  12.         ],
  13.         "successedTrackingNos": [
  14.             "9236290327908750050397"
  15.         ],
  16.         "failedMsg": "远程调用异常:[SCANFORM] 错误:[{\"vendorErrorCode\":\"400005\",\"vendorErrorMsg\":\"Unable to find this shipment\"}]\n"
  17.     }
  18. }

失败：code=1

  1. {
  2.     "code": "1",
  3.     "msg": "远程调用异常:[SCANFORM] 错误:[{\"vendorErrorCode\":\"400005\",\"vendorErrorMsg\":\"Unable to find this shipment\"}]\n远程调用异常:[SCANFORM] 错误:[{\"vendorErrorCode\":\"400005\",\"vendorErrorMsg\":\"Unable to find this shipment\"}]\n",
  4.     "data": ""
  5. }

scanform文件生成失败原因：

  1. 跟踪号列表存在非USPS订单
  2. 跟踪号订单不存在
  3. 当前日期超过下单时shipdate，USPS已计费
  4. scanform仓库与下单仓库不一致
  5. 跟踪号已调用确认发货接口

#

关键词