冰河系统(OMS)订单,(Express)快递状态推送,(WMS)入库通知单推送API_V1.0.md

用于(OMS---WMS)销售订单状态,快递(Express)状态回传，不适用出入库通知单状态回传

回调说明

1. 所有方法 回调参数包含在请求体(requestBody)中, 所有参数按照json格式发送，编码格式为UTF-8

2. 回调API授权目前支持accessToken和username/password方式,使用其中之一方式即可

3. 所有回调会尝试3次,第三次失败会发生告警邮件, 务必将负责人的email录入到冰河系统

4. 回调后必须返回如下json结构数据:
   { "status": "success", "mark": "说明" }
   字段说明:
   status取值范围 success/fail
mark:处理失败,使用该参数说明

5. 回调url格式: pushURL/(方法名)
   解释说明:
   pushURL：调用方接收地址 （例如： http://xxxxx/xxx/xxx/xxx）
方法名:黑狗对应的回调方法名 （例如 ：/API/V1/updateOrderStatus）
实际回调地址为 : http://xxxxx/xxx/xxx/xxx/API/V1/updateOrderStatus

6. 推送是以快递纬度推送路由跟踪信息，黑狗后台已自动判断箱子是否全部送达，暂不支持以箱子纬度推送路由跟踪信息

Push URL:/API/V1/updateOrderStatus (没有.do后缀)

状态回调流程如下:

快递订单状态回传

返回订单在冰河系统产生的快递跟踪信息,电商网站可以直接使用返回的信息轨迹,显示给用户查看。黑狗快递查询官方地址:[http://higo-express.com/traking.html?waybillID=4000226100],类似下图:

![快递流转信息][3]

回调参数

{
  "messageID":1234,
  "operateDatetime": "2015-09-14 18:02:58",
  "operationUser": "张三",
  "accessToken": "123457",
  "accessUserName": "accessUserName",
  "accessPassword": "123456",
  "sourceNO": "DX123456789",
  "waybillID": "SA12345678",
  "statusDesc": "订单打包中",
  "statusCode": 4,
  "remark":"备注信息",
  "courier": "申玉龙",
  "courierPhone":"13301070965",
  "reason": "xxxxxxxx"
}

参数说明

字段名	是否必须	描述	示例
messageID	是	消息唯一标识,防止重复推送	1234
operateDatetime	是	发生时间	2015-09-14 18:02:58
operationUser	是	操作人	张三
accessToken	否	授权token,token,accessUserName,accessPassword参数只能取一种	123457
accessUserName	否	授权用户名	accessUserName
accessPassword	否	授权密码	123456
sourceNO	否	来源单号,传入黑狗的原始单号	DX123456789
waybillID	否	运单号，面单上打印的运单号	SA12345678
statusDesc	是	状态描述	订单打包中
statusCode	是	订单状态对应的数字 取值范围,参考下面备注	4
remark	否	备注信息	备注
courier	否	快递员姓名（只有在statusCode等于7时才会推送此字段）	申玉龙
courierPhone	否	快递员电话（只有在statusCode等于7时才会推送此字段）	13301070965
reason	否	拒收、延迟接收，改签原因	客户要求取消原因列表

statusCode取值范围

状态码	状态解释	状态描述
0	取消	-- （忽略此状态，不推送）
1	录入	订单推送成功
2	系统确认收件	--（忽略此状态，不推送）
3	已揽件	您的快递已在【四道口】站点收件
4	打包中	您的订单正在准备出库/您的订单拣货中
5	转运出发	您的订单在【东四】转运出发
6	转运接收	您的订单在【四道口】验货完成，正在分配配送员
7	派送中	配送员【汪月闪】已出发，联系电话【15801339847】，感谢您的耐心等待
8	已签收	您的快递已经签收，欢迎您再次光临！
9	延迟接收	您的快递已要求延迟接收，原因：xxx 原因见列表
10	拒收	您的快递拒收，原因：xxx
11	代收	您的快递由【xxx】代收
12	快速下单	-- （忽略此状态，不推送）
13	改签	您的快递已经被改签，原因：xxx
14	返仓	您的快递被返仓，原因：xxx
15	保留状态	-- （忽略此状态，不推送）
16	过期	-- （忽略此状态，不推送）
17	异常接收	【四道口】异常接收
18	异常出发	【四道口】异常出发
19	丢失	-- （忽略此状态，不推送）
20	返仓出发	【四道口】返仓出发
21	返仓接收	【四道口】返仓出发
22	返仓入库	【四道口】返仓入库
23	集货完毕	您的订单已打包完毕
24	发货	您的订单在【大兴RDC】发货完成
25	踢单成功,调用方发起拦截请求之后	订单拦截成功
29	异常关闭	订单已被异常关闭

订单对应状态能否调用取消订单,拦截订单API

状态代码	状态描述	能否取消订单	能否拦截订单
0	取消	×	×
1	录入	√	×
2	系统确认收件	×	×
3	已揽件	×	×
4	打包中	×	√
5	转运出发	×	×
6	转运接收	×	×
7	派送中	×	×
8	已签收	×	×
9	延迟接收	×	×
10	拒收	×	×
11	代收	×	×
12	快速下单	×	×
13	改签	×	×
14	返仓	×	×
15	保留状态	×	×
16	过期	×	×
17	异常接收	×	×
18	异常出发	×	×
19	丢失	×	×
20	返仓出发	×	×
21	返仓接收	×	×
22	返仓入库	×	×
23	集货完毕	×	×
24	发货	×	×
25	踢单成功,调用方发起拦截请求之后	×	×

---

单据状态回传(针对库内部分，快递部分不需要对接这个接口)

Push URL:/API/V1/updateReceiptStatus

回调参数

{
  "messageID":1234,
  "operateDatetime": "2015-09-15 10:43:22",
  "sourceNO": "DX123456789",
  "statusDesc": "入库成功",
  "statusCode": 0,
  "accessToken": "123457",
  "accessUserName": "accessUserName",
  "accessPassword": "123456",
  "remark": "备注",
  "detailList": [
    {
      "goodsNO": "LJ13234",
      "qit": 234,
      "unit": "盒"
    }
  ],
"recepitNO": "SN1234355"
}

参数说明

参数名	是否必须	描述	示例
messageID	是	消息唯一标识,防止重复推送	1234
operateDatetime	是	发生时间	2015-09-14 18:02:58
operationUser	是	操作人	张三
accessToken	否	授权token,token,accessUserName,accessPassword参数只能取一种	123457
accessUserName	否	授权用户名	accessUserName
accessPassword	否	授权密码	123456
sourceNO	否	传入黑狗的原始单号，如果有	DX123456789
detailList	是	单据确认明细 ,注意,一个入库通知单,会有多条入库确认通知,调用方，需要根据入库通知单总量进行比较,判断消息推送是否合法,冰河保证总量一致,不保证一次推送当前入库通知单所有确认信息
detailList.goodsNO	否	商品编号	SA12345678
detailList.qit	否	数量	123
detailList.unit	否	商品规格	盒
statusDesc	否	状态描述	成功,失败
statusCode	是	状态对应的数字 取值范围，0:成功,1:失败	1
remark	否	备注信息	备注
recepitNO	是	单据入库后,冰河系统生成的唯一单据号	SN1234