物流轨迹推送接口
注意:该接口需与1.18物流轨迹订阅接口搭配使用,主要给三方erp用的,商家自研系统无需接入该接口
基本信息
接口名称 | |
---|---|
请求方式 | Post application/x-www-form-urlencoded |
功能描述 | 菜鸟速递将运单物流轨迹信息推送给外部ERP |
编码 | UTF-8 |
入参
项目 | 名称 | 类型 | 必填 | 描述 | 备注 |
---|---|---|---|---|---|
对接码 | logistic_provider_id | String | 是 | 菜鸟侧提供 | |
签名 | data_digest | String | 是 | Base64(Md5(logistics_interface+双方约定的secretKey)) ,0.2 签名方法 | x-www-form-urlencoded格式可能会出现加号变空格的情况,发请求之前可以对签名进行urlencode |
业务报文 | logistics_interface | String | 是 | JSON |
logistics_interface内容
项目 | 名称 | 类型 | 必填 | 描述 | 示例 |
---|---|---|---|---|---|
运单号 | bizId | String | 是 | 运单号 | 621000153894 |
节点状态编码 | action | String | 是 | 状态编码,具体枚举见附录 | TMS_SIGN |
节点所在城市 | operateCity | String | 是 | 节点所在城市 | 杭州市 |
节点产生时间 | operateTime | String | 否 | 节点产生时间 | 2023-07-24 23:59:59 |
节点描述 | operateDesc | String | 否 | 节点描述 | 您的包裹已被签收 |
出参
项目 | 名称 | 类型 | 必填 | 描述 | 备注 |
---|---|---|---|---|---|
成功标识 | success | Boolean | 是 | ||
错误码 | errorCode | String | 否 | ||
错误说明 | errorMsg | String | 否 |
示例报文
请求:
仅供参考,实际测试账号需联系菜鸟速递开发提供
logistic_provider_id: edi_test_json
logistics_interface: {"bizId":"621000153894","action":"TMS_SIGN","operateCity":"杭州市","operateTime":"2023-07-24 23:59:59","operateDesc":"您的包裹已被签收"}
data_digest: 4HQeJTYreTvD57k8tU8xCQ==
返回:
{"success":true}
附录
节点状态编码枚举
状态编码 | 状态描述 | 备注 |
---|---|---|
DANNIAO_ACCEPT | 揽收 | |
TMS_AC_IN | 进入分拨 | |
TMS_SITE_IN | 进入站点 | |
TRUNK_SIGN | 干线车辆到达 | |
TMS_AC_OUT | 出分拨 | |
TMS_SITE_OUT | 出站点 | |
TMS_CANCEL_PROMISED | 承诺拦截成功 | |
TMS_CANCEL_SUCCESSED | 实物拦截成功 | |
TMS_DELIVERING | 派件中 | |
TMS_SIGN | 签收 | |
TMS_FAILED | 拒收 | |
INBOUND | 代收 | |
SH_INBOUND | 放入代收点 | |
SH_SIGNED | 代收点取件 | |
TMS_ERROR | 滞留 | |
INVERSE_AC_IN | 逆向分拨入 | |
INVERSE_AC_OUT | 逆向分拨出 | |
INVERSE_TMS_SITE_IN | 逆向站点入 | |
INVERSE_TMS_SITE_OUT | 逆向站点出 | |
INVERSE_TMS_SIGNED | 逆向签收 | |
MODIFY_ADDRESS | 改地址 |