接口说明

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

PB：PB大包号和大包箱单
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
请求数限制	默认每分钟1000，有需要可申请加大。
接口版本Version	1.0

请求入参

名称	类型	必填	说明	示例
mailDate	String(20)	Y	发货日期 yyyy-mm-dd HH:mm:ss 传发件地址当地时间
mailDateTimeZone	String	N	发货日期的时区
warehouseCode	String(50)	N	仓库代码，根据仓库代码获取发货仓地址信息(usps渠道必填)	US0001
orderVo	Array	Y	快递单号List，单次请求限制2000个。单号较多时，接口返回较慢，请设置接口超时时间为10min
– trackingNo	String(50)	Y	跟踪号，PB Container 请传输Barcode
fromAddress	Object	N	发件人信息
– name	String(50)	N	发货人姓名
– companyName	String(100)	N	发货公司
– countryCode	String(2)	N	发货地国家二字码
– address1	String(35)	N	发货地址1
– address2	String(35)	N	发货地址2
– stateCode	String(3)	N	发货地州/省编码
– city	String(50)	N	发货地城市
– postcode	String(10)	N	发货地邮编
shipmentReference	String(25)	N	订单备注用于识别订单，面单以Shpmt Ref#字段展示。仅支持空格，数字，英文字符，不支持特殊字符

请求示例

{
    "action":"pis.scanForm.queryUspsScan",
    "app_key":"rebecca",
    "data":{
        "mailDate":"2023-05-17 00:00:00",
        "orderVo":[
            {
                "trackingNo":"4201123592xxxxxxx71660"
            },
            {
                "trackingNo":"4201123592xxxxxxx71677"
            }
        ],
        "warehouseCode":"1xxxxxxxxx"
        "fromAddress":{
            "name":"revName",
            "companyName":"revCompany",
            "countryCode":"US",
            "address1":"123",
            "address2":"",
            "stateCode":"DE",
            "city":"Herten NRW",
            "postcode":"45701"
        }
    },
    "format":"json",
    "language":"zh_CN",
    "sign":"00000000000000000000000000000000",
    "sign_method":"md5",
    "platform":"OWNERERP",
    "timestamp":"2023-05-17 00:19:26",
    "version":"1.0"
}

返回出参

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

名称	类型	必传	说明	示例
scanFormNumbers	Arraylist	Y	PB：PB Container ID USPS：Scanform EFN号
scanFormFile	String	Y	Scanform Base64文件流 USPS：如多次请求的跟踪号在同一EFN号，不同的跟踪号请求都同一EFN对应的scanform文件

返回示例

成功：code=0

{
    "code": "0",
    "msg": "操作成功",
    "data": {
        "scanFormNumbers": [
            "645394exxxxxxf5e6ac",
            "6465eeaxxxxxx17387a"
        ],
        "scanFormFile": ""
    }
}

失败：code=1

{
    "code": "1",
    "msg": "跟踪号["xxxxxx","xxxxx"]不存在"
}
//USPS：
code=1存在以下5种场景：
1. USPS订单未填写warehouseCode，msg：第三方仓库代码必填
2. 未填写mailDate，msg：mailDate必填
3. 跟踪号列表存在非USPS订单，不支持生成scanform，msg：跟踪号[""xxxxxx"",""xxxxx""]不支持生成scanform
4. 跟踪号订单不存在，msg：跟踪号[""xxxxxx"",""xxxxx""]不存在
5. 确认是否发货：请确认跟踪号[""xxxxxx"",""xxxxx""]是否发货，如未发货，请调用“确认发货”接口发货；如已发货，请10分钟后重试

生成中：code=2

{
    "code": "2",
    "msg": "scanform文件生成中，预计10分钟后可再次请求生成"
}

关键词