
| 接口环境 | 接口地址 |
|---|---|
| 正式环境 | https://apis.speedaf.com/ |
| 测试环境 | https://uat-api.speedaf.com/ |
接口地址:https://uat-api.speedaf.com/open-api/express/track/subscribe?appCode=你的appCode×tamp=当前时间戳
请求方式:POST
请求数据类型:application/json
接口描述:
请求参数示例:
{ "mailNo": "86254200001257", "customerCode": "232001", "notifyUrl": "http://localhost:8094/open-api/express/track/callback"}请求参数描述:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 | 备注 |
|---|---|---|---|---|
| mailNo | 运单号 | true | string | |
| customerCode | 客户编号 | true | string | |
| notifyUrl | 回调地址 | true | string |
响应状态:
响应参数示例:
xxxxxxxxxx{ "mailNo": "86254200001257", "customerCode": "232001"}响应参数描述:
mailNo:
| 参数名称 | 参数说明 | 类型 | 备注 |
|---|---|---|---|
| mailNo | 运单号 | string | |
| customerCode | 客户编号 | string |
Speedaf提供的参数如下:
参数示例:
xxxxxxxxxx[ { "mailNo": "86254200001257", "action": "1", "subAction":"1", "actionName": "http://localhost:8094/open-api/express/track/callback", "message":"【LOS-WH1】已做收件扫描,收件员是【Ejalonibu Wahab】【09025119825】", "msgEng":"Parcel scanned by site", "msgLoc":"Parcel scanned by site", "time":"2021-05-05 21:27:34", "pictureUrl":"https://opa.speedaf.com/manager/file/view/63968d3f-be9a-4a92-8751-42d24e03933e.png", "country":"Nigeria", "countryCode":"NG", "timezone":4 }]参数描述:
| 参数名称 | 参数说明 | 数据类型 | 备注 |
|---|---|---|---|
| mailNo | 运单号 | string | |
| action | 父状态编码 | string | |
| subAction | 子状态编码 | string | |
| actionName | 状态名称 | string | |
| message | 轨迹中文描述 | string | |
| msgEng | 轨迹英文描述 | string | |
| msgLoc | 轨迹本地语言描述 | string | |
| time | 轨迹时间 | string | |
| pictureUrl | 图片URL | string | |
| country | 国家名称 | string | |
| countryCode | 国家编码 | string | |
| timezone | 轨迹时区 | int |
Speedaf接收的响应格式为:
xxxxxxxxxx{ "data": "", "error": { "code": "", "message": "" }, "success": true}其中success字段表示 是否成功接收到Speedaf推送的轨迹数据
action的枚举如下:
| Code | 描述 |
|---|---|
| 10 | 已下单 |
| -10 | 已取消 |
| 150 | 入库 |
| 181 | 集包 |
| 190 | 出库 |
| 402 | 报关 |
| 220 | 航班起飞 |
| 230 | 航班落地 |
| 360 | 清关中 |
| 401 | 清关异常 |
| 370 | 清关完成 |
| 1 | 已揽收 |
| 2 | 发件 |
| 3 | 到件 |
| 4 | 派送中 |
| 5 | 已签收 |
| -710 | 退件中 |
| 730 | 退货签收 |
| 18 | 自提件扫描 |
| 16 | 第三方代收(自提入库) |