线下文档下载:
序号 | 版本 | 类型 | 内容 | 修改时间 |
1 | V1.0 | 新增 | ||
2 | V1.1 | 修改 | 1.新增【新增/更新商品信息】;2.新增【订单更新备注消息】;3.新增【新增售后订单消息】;4.新增【更新售后订单消息】; | 2023.12.06 |
消息 tag 说明:
tag 值 | 说明 |
trade_TradeCreate | 订单创建 |
trade_TradeClose | 订单取消 |
trade_TradeAgainOpen | 订单重推 |
trade_TradeLogisticsAddressChanged | 买家收货信息变更 |
trade_TradeMemoModified | 卖家备注变更 |
trade_TradeSellerShip | 订单发货 |
trade_TradeLogisticsInfoChanged | 发货物流信息变更 |
trade_TradeSuccess | 交易完成 |
订单取消消息
场景:书链通的订单整单取消或者商品行的订单取消后,将消息推送给上下游,更新订单的状态;
参数:
参数名称 | 参数类型 | 参数描述 |
tag | String | 消息种类,订单取消消息的tag值为”trade_TradeClose” |
msgId | String | 消息记录ID |
data | Struct | 消息体 |
消息字段:
参数名称 | 参数类型 | 参数描述 |
oids | List<String> | 子订单ID |
cancel_time | Int64 | 订单取消时间 |
cancel_reason | String | 取消原因 |
tid | String | 父订单ID |
订单发货消息
场景:书链通订单部分发货或者全部发货时触发
参数:
参数名称 | 参数类型 | 参数描述 |
tag | String | 消息种类,订单取消消息的tag值为”trade_TradeSellerShip” |
msgId | String | 消息记录ID |
data | Struct | 消息体 |
消息字段:
参数名称 | 参数类型 | 参数描述 |
tid | Int64 | 父订单ID |
oids | List | 子订单ID列表 |
is_partly_ship | boolean | 是否部分发货 |
express_company_code | String | 发货快递公司 |
logistics_code | String | 发货物流单号 |
seller_ship_time | string | 订单发货时间 |
交易完成消息
公共参数
参数名称 | 参数类型 | 参数描述 |
tag | String | 消息种类,订单取消消息的tag值为”trade_TradeSuccess” |
msg_id | String | 消息记录ID |
data | Struct | 消息体 |
消息字段
参数名称 | 参数类型 | 参数描述 |
complete_time | datetime | 交易完成时间 |
tid | String | 父订单ID |
oids | List | 子订单ID列表 |
发货物流信息变更消息fhwl
公共参数
参数名称 | 参数类型 | 参数描述 |
tag | String | 消息种类,订单取消消息的tag值为”trade_TradeLogisticsInfoChanged” |
msg_id | String | 消息记录ID |
data | Struct | 消息体 |
消息字段
参数名称 | 参数类型 | 参数描述 |
tid | string | 父订单ID |
logistics_info_changed_time | string | 发货物流变更时间 |
express_company_code | string | 发货快递公司 |
logistics_code | string | 发货物流单号 |
oids | List<String> | 子订单ID列表 |
old_express_company_code | string | 原始发货快递公司 |
old_logistics_code | string | 原始发货物流单号 |
买家收货信息变更消息
公共参数
参数名称 | 参数类型 | 参数描述 |
tag | String | 消息种类,订单取消消息的tag值为”trade_TradeLogisticsAddressChanged” |
msg_id | String | 消息记录ID |
data | Struct | 消息体 |
消息字段
参数名称 | 参数类型 | 参数描述 |
tid | String | 父订单ID |
name | String | 收货人姓名 |
tel | String | 收货人手机号 |
addr | String | 详细地址 |
province | string | 省 |
city | string | 市 |
town | string | 区/县 |
encrypte_receiver | Encrypt | 加密地址,见下方结构 |
Encrypt 结构
参数名称 | 参数类型 | 参数描述 |
source_tid | String | |
platform_code | String | |
receiver_name | String | |
receiver_mobile | String | |
receiver_addr | string | |
oaid | string |
订单重推消息
场景:订单从取消状态恢复
公共参数
参数名称 | 参数类型 | 参数描述 |
tag | String | 消息种类,订单取消消息的tag值为”trade_TradeAgainOpen” |
msgId | String | 消息记录ID |
data | Struct | 消息体 |
消息字段
参数名称 | 参数类型 | 参数描述 |
updateTime (todo) | Int64 | 订单重推时间 |
tid | String | 父订单ID |
oids | List | 子订单ID列表 |
卖家添加备注消息
公共参数
参数名称 | 参数类型 | 参数描述 |
tag | String | 消息种类,订单取消消息的tag值为”trade_TradeMemoModified” |
msgId | String | 消息记录ID |
data | Object | 消息体 |
消息字段
参数名称 | 参数类型 | 参数描述 |
remark | string | 备注内容,最大不得超过60个字符 |
memo_modified_time | string | 时间戳,秒 |
tid | string | 父订单ID |
创建订单消息
公共参数
参数名称 | 参数类型 | 参数描述 |
tag | String | 消息种类,订单取消消息的tag值为”trade_TradeCreate” |
msgId | String | 消息记录ID |
data | Struct | 消息体 |
消息字段
参数名称 | 参数类型 | 参数描述 |
createTime | Int64 | 订单创建时间 |
tid | String | 父订单ID |
oids | List | 子订单ID列表 |
公共参数
参数名称 | 参数类型 | 参数描述 |
消息字段
参数名称 | 参数类型 | 参数描述 |
授权回调
场景:
商户授权点击后,书链通回调自研ERP的接口
参数:
参数名称 | 参数类型 | 参数描述 |
state | String | 客户端给参数 state |
appKey | String | 密钥 |
appSecret | String | 密钥 |
新增/更新商品消息
场景:书链通中新增的商品后,将新增的商品信息同步至ERP系统,ERP调用查询商品信息的接口进行商品信息的更新和新增;
参数:
参数名称 | 参数类型 | 参数描述 |
tag | String | 消息种类,订单取消消息的tag值为”trade_TradeSellerShip” |
msgId | String | 消息记录ID |
data | Struct | 消息体 |
消息字段:
参数名称 | 参数类型 | 参数描述 |
goods_code | string | 规格编码 |
订单更新备注信息
场景:卖家、买家、分销商、中盘商、供应商、中盘商对供应商备注、中盘商对分销商备注更新了订单信息,需要将消息同步给供应商ERP;
公共参数:
参数名称 | 参数类型 | 参数描述 |
tag | String | 消息种类,订单取消消息的tag值为”trade_TradeMemoModified” |
msgId | String | 消息记录ID |
data | Object | 消息体 |
消息字段:
参数名称 | 参数类型 | 参数描述 |
remark | string | 卖家备注、买家备注、,最大不得超过60个字符 |
memo_modified_time | string | 时间戳,秒 |
tid | string | 父订单ID |
新增售后订单消息
场景:书链通创建的售后订单后,需要将售后订单推送至ERP系统,供应商ERP系统查询书链通系统接口,进行售后订单的新增;
公共参数
参数名称 | 参数类型 | 参数描述 |
tag | String | 消息种类,订单取消消息的tag值为”trade_TradeCreate” |
msgId | String | 消息记录ID |
data | Struct | 消息体 |
消息字段
参数名称 | 参数类型 | 参数描述 |
tid | string | 书链通单号 |
oid | string | 商品订单号 |
更新售后订单消息
业务场景:售后订单的状态更改(整单取消、子订单取消)、订单信息的更新后,书链通推送消息给供应商ERP系统,ERP查询售后订单接口进行数据更新;
公共参数
参数名称 | 参数类型 | 参数描述 |
tag | String | 消息种类,订单取消消息的tag值为”trade_TradeCreate” |
msgId | String | 消息记录ID |
data | Struct | 消息体 |
消息字段
参数名称 | 参数类型 | 参数描述 |
tid | string | 书链通单号 |
oid | string | 商品订单号 |
after_sale_order_no | string | 售后单号 |