上传 USPS 派送前轨迹
更新时间: 2024-10-23 16:50:38 访问次数:580
接口说明
通过上传派送前轨迹接口将轨迹传给Winit,Winit将在规定时间内将轨迹上传给供应商
目前支持的供应商和上传频率:
- USPS:每4小时上传一次
- Hermes:每1小时上传一次
使用场景
此接口适用于在USPS轨迹派送轨迹前展示派送前轨迹的客户
- 一条记录只支持一个轨迹代码,想要一个跟踪号下展示多条轨迹,需录入多条跟踪号一样,轨迹代码不一样的记录
- 一次请求最多支持100条跟踪号,400条轨迹代码
- 跟踪号:仅支持创建时间<120天的跟踪号
- 轨迹生成时间:轨迹在USPS tracking页面上展示的时间,不支持过去时间
- 轨迹代码:跟踪号+轨迹代码不支持重复上传
接口名称
pis.mscan.addTask
请求说明
请求内容 | 说明 |
---|---|
URL | https://openapi.winit.com.cn/openapi/service |
接口测试 | https://sandboxopenapi.winit.com.cn/openapi/service |
验证方法 | Token,md5 |
格式 | json |
字符编码 | UTF-8 |
http请求方式 | http |
请求数限制 | 默认每分钟1000,1000有需要可申请加大。 |
请求入参
名称 | 类型 | 必填 | 说明 | 示例 |
---|---|---|---|---|
mscanInfoList | Array | Y | 派送前轨迹列表 一条记录只支持一个轨迹代码,想要一个跟踪号下展示多条轨迹,需录入多条跟踪号一样,轨迹代码不一样的记录; 一次请求最多支持100条跟踪号,400条轨迹代码 |
|
- | trackingNo | string(50) | Y | 跟踪号 仅支持创建时间<120天的跟踪号 |
- | trackingCode | string(50) | Y | 轨迹代码 跟踪号+轨迹代码不支持重复上传 USPS枚举值:GX,80,81,82; GX:Shipping Label Created 80:Picked Up By Shipping Partner 81:Arrived Shipping Partner Facility 82:Departed Shipping Partner Facility Hermes枚举值:AC001,CC001 AC001: Accepted By Evri Gateway(Gscan) CC001: Collected By Evri(Cscan) |
- | trackingTime | string(50) | Y | 轨迹生成时间 轨迹在USPS tracking页面上展示的时间 格式:2023-12-13 10:00:00(当地时间) USPS:不支持过去时间 Hermes:不支持未来时间 |
请求示例
{
"action":"pis.mscan.addTask",
"app_key":"rebecca",
"data":{
"mscanInfoList":
[
{
"trackingNo":"9205690332390200000074",
"trackingCode":"GX",
"trackingTime":"2023-12-13 10:00:00"
},
{
"trackingNo":"9205690332390200000074",
"trackingCode":"81",
"trackingTime":"2023-12-13 10:00:00"
},
{
"trackingNo":"9205690332390200000074",
"trackingCode":"82",
"trackingTime":"2023-12-13 10:00:00"
},
{
"trackingNo":"9205690332390200000067",
"trackingCode":"83",
"trackingTime":"2023-12-13 10:00:00"
}
]
},
"format":"json",
"language":"zh_CN",
"platform":"sw",
"sign":"00000000000000000000000000000000",
"sign_method":"md5",
"timestamp":"2023-11-27 17:45:28",
"version":"1.0"
}
返回出参
返回参数说明:正确的返回编码code:0及结果data,错误的返回错误码及错误信息msg。
名称 | 类型 | 必传 | 说明 | 示例 |
---|---|---|---|---|
trackingNo | string(50) | Y | 跟踪号 | |
trackingCode | string(50) | Y | 轨迹代码 | |
trackingTime | string(50) | Y | 轨迹生成时间 | |
code | string() | Y | 编码 | |
msg | string() | N | 错误描述 按每条记录返回结果,如某条结果返回失败,重新上传该条记录即可 |
返回示例
{
"code": "0",
"msg": "操作成功",
"data": [
{
"trackingNo": "9205690332390200001316",
"trackingCode": "GX",
"trackingTime": "2023-12-20 10:00:00",
"code": 0,
"msg": null
},
{
"trackingNo": "9205690332390200001309",
"trackingCode": "81",
"trackingTime": "2023-12-20 10:00:00",
"code": 0,
"msg": null
},
{
"trackingNo": "9205590181411237533531",
"trackingCode": "82",
"trackingTime": "2023-12-20 10:00:00",
"code": 0,
"msg": null
}
]
}