[TOC] ##介绍 #### 文档地址 [https://www.showapi.com/apiGateway/view/64/23](https://www.showapi.com/apiGateway/view/64/23 "https://www.showapi.com/apiGateway/view/64/23") #### 功能说明 用户提交`快递单号`及`快递公司编码`到易源,易源在信息有更新时,将`单号物流轨迹`POST推送至用户指定的callBackUrl。在物流未签收前,易源会进行多次推送操作。 #### 流程图 `流程图`如下所示: ![](https://oss.showapi.com/doc/3157/14/6c442215a5e8_1604295586171.png) ## 规范 ####使用步骤 1、首先设置回调地址。 2、提交需要推送的快递单号。 3、异步等待易源post信息到您的callbackUrl。 #### 提交规范 使用HTTP的get或post请求,以`普通表单`提交方式,编码:`Content-Type=application/x-www-form-urlencoded`发送数据,阻塞式调用。 #### 推送规则 1、每天定时推送,推送时间段为:每天的08:00—22:00,平均每两个小时为一次,每天预计8次。 2、物流信息有增量变化时才会推送。 3、物流信息无变化,超过3天,将会推送无变化的信息 #### 关键参数com_nu说明 com_nu是一个list结构,其中的每一个object有4个属性: ```json [{ "com": "shunfeng", "nu": "299801844590", "phone": "1234", "outCode": "任意串,长度小于200字符" }, { "com": "shunfeng", "nu": "299801844592", "phone": "", "outCode": "thisismyoutcode" }, { "com": "shunfeng", "nu": "299801844593", "phone": "", "outCode": "this is my json string" } ] ``` 其中每个字段的含义是: | 参数名 | 描述 | | ------------ | ------------ | | com | 快递公司编码,[点此查看列表](https://www.showapi.com/book/view/3157/3 "点此查看列表"),也可以使用[【工具】查询快递公司列表](https://www.showapi.com/apiGateway/view/?apiCode=64&pointCode=20 "【工具】查询快递公司列表")接口获取。 | | nu |快递单号。 | | phone |可选。只对于顺丰单号查询有效。是`收件人`或`发件人`的手机号码后4位。如果是顺丰单号,请务必传递本参数。| | outCode |比如您在提交查询时,传入outCode=myOrderId123456,那么易源在推送结果到回调URL时,会带上outCode=myOrderId123456给您,便于您做单号对应。 outCode是一个< 200长度的串(也可以是json的string格式),易源回推时将原封返回。| [查看showapi_appid及showapi_sign。](https://www.showapi.com/console#/myApp "查看showapi_appid及showapi_sign。") > 易源在回推单号物流时,会将您提交的`outCode`值一并提交过来,便于您标识单号身份。 ##注意事项 ####回复格式 用户服务器收到易源请求后,需要回复一个消息以确认。此消息的2个要求是: | 条件名称 |描述 | | ------------ | ------------ | | http返回状态码 | 等于200 | | http返回体 | `{"success":true}` 或 `success` | 如果不满足上面2个条件(且的关系)则认为失败。失败时易源会重复推送5次,间隔时间分别是2,4,8,16,32分钟。 ####推送的实例 ``` #http头 host:129.211.129.137:7243 //易源推送服务器地址,会改变 content-type:application/x-www-form-urlencoded;charset=utf-8 content-length:697 user-agent:lua-resty-http/0.12 (Lua) ngx_lua/10013 #http body result=%7B%22queryTimes%22%3A1%2C%22upgrade_info%22%3A%22%22%2C%22fee_num%22%3A0%2C%22status%22%3A2%2C%22expSpellName%22%3A%22huitong%22%2C%22msg%22%3A%22%E6%9F%A5%E8%AF%A2%E6%88%90%E5%8A%9F%22%2C%22updateStr%22%3A%222020-11-02%2010%3A47%3A37%22%2C%22outCode%22%3A%22%22%2C%22flag%22%3Atrue%2C%22tel%22%3A%2295320%22%2C%22ret_code%22%3A0%2C%22logo%22%3A%22http%3A%2F%2Fstatic.showapi.com%2Fapp2%2Fimg%2FexpImg%2Fht.jpg%22%2C%22expTextName%22%3A%22%E7%99%BE%E4%B8%96%E5%BF%AB%E9%80%92(%E5%8E%9F%E6%B1%87%E9%80%9A)%22%2C%22data%22%3A%5B%7B%22context%22%3A%22%E3%80%90%E4%B9%89%E4%B9%8C%E8%BD%AC%E8%BF%90%E4%B8%AD%E5%BF%83%E3%80%91%EF%BC%8C%E6%AD%A3%E5%8F%91%E5%BE%80%E3%80%90%E5%A4%A9%E6%B4%A5%E8%BD%AC%E8%BF%90%E4%B8%AD%E5%BF%83%E3%80%91%22%2C%22time%22%3A%222020-11-01%2022%3A57%3A19%22%7D%2C%7B%22context%22%3A%22%E5%88%B0%E3%80%90%E4%B9%89%E4%B9%8C%E8%BD%AC%E8%BF%90%E4%B8%AD%E5%BF%83%E3%80%91%22%2C%22time%22%3A%222020-11-01%2022%3A55%3A13%22%7D%2C%7B%22context%22%3A%22%E3%80%90%E5%85%B0%E6%BA%AA%E3%80%91%EF%BC%8C%E6%AD%A3%E5%8F%91%E5%BE%80%E3%80%90%E9%87%91%E5%8D%8E%E8%BD%AC%E8%BF%90%E4%B8%AD%E5%BF%83%E3%80%91%22%2C%22time%22%3A%222020-11-01%2017%3A56%3A19%22%7D%2C%7B%22context%22%3A%22%E5%88%B0%E3%80%90%E5%85%B0%E6%BA%AA%E9%9B%86%E8%B4%A7%E7%82%B9%E3%80%91%22%2C%22time%22%3A%222020-11-01%2017%3A42%3A28%22%7D%2C%7B%22context%22%3A%22%E3%80%90%E4%B9%89%E4%B9%8C%E9%BE%9A%E5%A4%A7%E5%A1%98%E5%88%86%E9%83%A8-%E4%BC%98%E8%B4%A8%E5%AE%A2%E6%88%B7%E3%80%91%EF%BC%8C%E3%80%90%E5%BC%A0%E6%9F%B3%E5%A9%B7%2F15658902667%E3%80%91%E5%B7%B2%E6%8F%BD%E6%94%B6%22%2C%22time%22%3A%222020-11-01%2017%3A08%3A49%22%7D%5D%2C%22mailNo%22%3A%22557030343293696%22%2C%22possibleExpList%22%3A%5B%5D%2C%22dataSize%22%3A5%2C%22update%22%3A1604285257608%7D ```