开发文档
外部渠道订单业务
3.1 业务介绍
商家外部渠道拿到商品资料和库存数据之后，在APP端进行售卖，当用户下单支付后把订单同步到ReX中台，借助ReX中台完成订单履约过程，期间会将订单各个履约状态通过消息方式给到商家外部渠道端，商家做相应的订单状态展示，支持客服代客发起售中整单或部分取消，客服代客发起售后整单或部分退款，商家接收到消息后需要根据约定进行相应处理。
3.2 业务流程
3.2.1 正向主流程
3.2.2 拣货全缺或部分缺
3.2.3 代客发起售中取消
3.2.4 代客发起售后退货
3.3 接口说明
3.3.1 创建订单 - 接口(alibaba.wdk.channel.order.create)
请求参数：
| 字段名称 |
描述 |
类型 |
备注 |
必填 |
示例 |
| buyer |
买家信息 |
|
|
是 |
|
|
买家标识 |
String |
|
是 |
|
|
买家用户名 |
String |
|
是 |
|
|
买家昵称 |
String |
|
是 |
|
|
买家电话 |
String |
|
是 |
|
| consignee |
收件人信息 |
|
|
是 |
|
|
收件人名称 |
String |
|
是 |
|
|
收件人电话 |
String |
|
是 |
|
|
配送地址 |
String |
|
是 |
|
|
配送坐标 |
String |
高德体系，如：120, 30 |
是 |
|
|
配送开始时间 |
Date |
|
是 |
|
|
配送结束时间 |
Date |
|
是 |
|
| createTime |
创单时间 |
Date |
|
是 |
|
| payTime |
支付时间 |
Date |
|
否 |
|
| subOrders |
子订单列表 |
|
|
|
|
|
外部子单号 |
String |
|
是 |
|
|
商品编码 |
String |
|
是 |
|
|
销售商品数据量 |
Integer |
|
是 |
|
|
销售单价 |
Long |
单位：分 |
是 |
|
|
实际支付金额 |
Long |
单位：分 |
是 |
|
|
原始金额 |
Long |
单位：分 |
是 |
|
|
优惠金额 |
Long |
单位：分 |
是 |
|
|
营销优惠明细 |
String |
|
否 |
|
| -activityId |
营销活动Id |
String |
|
否 |
|
| -activityType |
营销活动类型 |
String |
|
否 |
|
| -dicountFee |
优惠金额 |
Long |
单位：分 |
否 |
|
| postFee |
运费 |
Long |
单位：分 |
是 |
|
| payFee |
实际支付金额 |
Long |
单位：分 |
是 |
|
| originFee |
原始订单金额 |
Long |
单位：分，是所有子单的金额originFee合计 |
是 |
|
| discountFee |
优惠金额 |
Long |
单位：分,是所有子单的金额discountFee合计 |
是 |
|
| outOrderId |
外部订单号 |
String |
|
是 |
|
| shopId |
渠道店Id |
String |
|
是 |
|
| storeId |
经营店Id |
String |
|
是 |
|
| orderStatus |
订单状态 |
Sting |
创建订单： CREATED 已支付订单：PAID |
是 |
|
响应参数：
| 名称 |
描述 |
类型 |
备注 |
必须 |
示例 |
| bizOrderId |
主单号 |
String |
创单时orderStatus=PAID时，该值不为空， orderStatus=CREATED时为空 |
否 |
|
| outOrderId |
外部订单号 |
String |
|
是 |
|
| subOrders |
子单列表 |
|
|
|
|
|
业务子单号 |
String |
创单时orderStatus=PAID时，该值不为空， orderStatus=CREATED时为空 |
否 |
|
|
外部子单号 |
String |
|
是 |
|
3.3.2 订单状态变更 - 接口（alibaba.wdk.channel.order.status.update）
请求参数：
| 字段名称 |
描述 |
类型 |
备注 |
必须 |
示例 |
| merchantCode |
商家编码 |
String |
|
是 |
|
| storeId |
经营店编码 |
String |
|
是 |
|
| shopId |
渠道店编码 |
String |
|
是 |
|
| outOrderId |
外部主单号 |
String |
|
是 |
|
| orderStatus |
订单状态 |
String |
已支付： PAID 已关闭：TRADE_CLOSE（仅允许未支付订单更新为关闭） |
是 |
|
响应参数：
| 名称 |
描述 |
类型 |
备注 |
必须 |
示例 |
| bizOrderId |
主单号 |
String |
|
是 |
|
| outOrderId |
外部订单号 |
String |
|
是 |
|
| subOrders |
子单列表 |
|
|
|
|
|
业务子单号 |
String |
|
是 |
|
|
外部子单号 |
String |
|
是 |
|
3.3.3 售中取消外部订单 - 消息(alibaba_wdk_ChannelOrderCancel)
消息参数：
| 名称 |
描述 |
类型 |
备注 |
必须 |
示例 |
| merchantCode |
商家编码 |
String |
|
是 |
|
| storeId |
经营店Id |
String |
|
是 |
|
| shopId |
渠道店Id |
|
|
是 |
|
| bizOrderId |
主单号 |
String |
|
是 |
|
| outOrderId |
外部主单号 |
String |
|
是 |
|
| wholeCancel |
是否整单取消 |
Boolean |
|
是 |
|
| subRefundOrders |
退款子单列表 |
|
整单取消时(wholeCancel=true),该值为空 |
否 |
|
|
子单Id |
String |
|
是 |
|
|
退款单ID |
String |
|
是 |
|
|
外部子单Id |
String |
|
是 |
|
|
商家编码 |
String |
|
是 |
|
|
逆向库存数量 |
Double |
|
是 |
|
|
退款原因类型 |
String |
枚举 |
是 |
|
3.3.4 订单状态变更 - 消息(alibaba_wdk_ChannelOrderStatusChange)
消息参数：
| 名称 |
描述 |
类型 |
备注 |
必须 |
示例 |
| bizOrderId |
主单号 |
String |
|
是 |
|
| outOrderId |
外部订单号 |
String |
|
是 |
|
| merchantCode |
商家编码 |
String |
|
是 |
|
| storeId |
经营店Id |
String |
|
是 |
|
| shopId |
渠道店Id |
String |
|
是 |
|
| fulfillStatus |
履约状态 |
String |
REJECTED: 拒单 ACCEPTED: 接单 PICKED: 拣货完成 PACKAGED: 打包完成 SHIPPING: 已揽收（配送中） REFUSED: 用户拒收 SIGN: 用户签收 OUTOFSTOCK:缺货出 |
是 |
|
| orderStatus |
订单状态 |
String |
CREATED:已创建 PAID:已支付 PACKAGED:打包完成 SUCCESS:交易完成 TRADE_CLOSE:订单关闭 |
是 |
|
| subOrders |
子单列表 |
|
|
是 |
|
|
子单号 |
String |
|
是 |
|
|
外部子单号 |
String |
|
是 |
|
|
子单履约状态 |
String |
是 |
|
|
|
子订单状态 |
String |
是 |
|
|
| subRefundOrders |
退款子单 |
|
仅orderStatus=success时有部分退款的场景会有此字段 |
否 |
|
|
子单退款单Id |
String |
|
是 |
|
|
子单Id |
String |
|
是 |
|
|
外部子单Id |
String |
|
是 |
|
|
商品Code |
String |
|
是 |
|
|
逆向库存数量 |
Double |
|
是 |
|
|
退款原因类型 |
String |
10, "整单全缺" 11, "订单部分缺" 12, "商家侧发起的退款" 13, "用户侧发起的退款" 14, "客服代客发起的退款" 15, "用户拒收" |
是 |
|
3.3.5 客服代客发起售后退款(整单/部分) - 消息(alibaba_wdk_ChannelOrderCsUserrefund)
消息参数：
| 名称 |
描述 |
类型 |
备注 |
必须 |
示例 |
| merchantCode |
商家编码 |
String |
|
是 |
|
| storeId |
经营店ID |
String |
|
是 |
|
| shopId |
渠道店ID |
Strig |
|
是 |
|
| bizOrderId |
业务主单号 |
String |
|
是 |
|
| outOrderId |
外部订单号 |
String |
|
是 |
|
| refundReason |
退款原因 |
String |
|
否 |
|
| memo |
用户备注 |
String |
|
否 |
|
| refundSubOrders |
退款子单 |
|
|
是 |
|
|
业务子单号 |
String |
|
是 |
|
|
外部子单号 |
String |
|
是 |
|
|
商品编码 |
String |
|
是 |
|
|
退货销售数量 |
Integer |
|
是 |
|
3.3.6 用户发起售后退款(整单/部分) - 接口(alibaba.wdk.channel.order.userrefund)
请求参数：
| 名称 |
描述 |
类型 |
备注 |
必须 |
示例 |
| merchantCode |
商家编码 |
String |
|
是 |
|
| storeId |
经营店Id |
String |
|
是 |
|
| shopId |
渠道店Id |
String |
|
是 |
|
| bizOrderId |
业务主单号 |
String |
|
是 |
|
| outRefundBatchId |
外部退款批次Id |
String |
确保唯一，可取UUID |
是 |
|
| refundReason |
退款原因 |
String |
|
否 |
|
| memo |
用户备注 |
String |
|
否 |
|
| subRefundOrders |
退款子单 |
|
|
是 |
|
|
业务子单号 |
String |
|
是 |
|
|
商品编码 |
String |
|
是 |
|
|
退货销售数量 |
Integer |
|
是 |
|
|
退款金额 |
Long |
单位 分 |
是 |
|
响应参数：
| 名称 |
描述 |
类型 |
备注 |
必须 |
示例 |
| success |
是否成功 |
Boolean |
|
是 |
|
| errMsg |
错误信息 |
String |
|
否 |
|
3.3.7 客服审核退款结果 - 消息(alibaba_wdk_ChannelOrderCsRefundAudit)
消息参数：
| 名称 |
描述 |
类型 |
备注 |
必须 |
示例 |
| merchantCode |
商家编码 |
String |
|
是 |
|
| storeId |
经营店ID |
String |
|
是 |
|
| shopId |
渠道店ID |
String |
|
是 |
|
| bizOrderId |
业务主单号 |
String |
|
是 |
|
| outOrderId |
外部订单号 |
String |
|
是 |
|
| outRefundBatchId |
外部退款批次Id |
String |
|
是 |
|
| agreeSubOrders |
同意退款子单 |
|
|
是 |
|
|
退款Id |
String |
|
是 |
|
|
商品编码 |
String |
|
是 |
|
|
业务子单号 |
String |
|
是 |
|
|
外部子单号 |
String |
|
是 |
|
|
退货库存数量 |
Double |
|
是 |
|
| rejectSubOrders |
拒绝退款子单 |
|
|
|
|
|
退款Id |
String |
|
是 |
|
|
商品编码 |
String |
|
是 |
|
|
业务子单号 |
String |
|
是 |
|
|
外部子单号 |
String |
|
是 |
|
|
退货库存数量 |
Double |
|
是 |
|
3.3.8 售后/售中退款确认 - 接口(alibaba.wdk.channel.order.refund.confirm)
请求参数：
| 名称 |
描述 |
类型 |
备注 |
必须 |
示例 |
| merchantCode |
商家编码 |
String |
|
是 |
|
| storeId |
经营店Id |
String |
|
是 |
|
| shopId |
渠道店Id |
String |
|
是 |
|
| bizOrderId |
业务主单号 |
String |
|
是 |
|
| outRefundBatchId |
外部退款批次Id |
String |
售中取消订单，退款确认该字段不用填写； 售后退款确认则要必填 |
|
|
| agreeSubOrders |
同意退款子单 |
|
|
是 |
|
|
退款Id |
String |
|
是 |
|
|
商品编码 |
String |
|
是 |
|
|
业务子单号 |
String |
|
是 |
|
|
退款金额 |
Long |
单位：分 |
是 |
|
|
退款邮费 |
Long |
单位：分 |
否 |
|
响应参数：
| 名称 |
描述 |
类型 |
备注 |
必须 |
示例 |
| success |
是否成功 |
boolean |
|
是 |
|
| errMsg |
错误信息 |
String |
|
否 |
|
3.3.9 会员同步 - 接口(alibaba.wdk.channel.user.sync)
请求参数：
| 名称 |
描述 |
类型 |
备注 |
必须 |
示例 |
| userId |
用户Id |
Long |
|
是 |
|
| phone |
手机号 |
String |
|
是 |
|
| userName |
会员名 |
String |
|
是 |
|
| userNick |
用户昵称 |
String |
|
是 |
|
| realName |
真实姓名 |
String |
|
是 |
|
| gender |
性别 |
String |
|
是 |
|
| type |
操作类型 |
String |
create/update/delete |
是 |
|
响应参数：
| 名称 |
描述 |
类型 |
备注 |
必须 |
示例 |
| success |
是否成功 |
boolean |
|
是 |
|
| errMsg |
错误信息 |
String |
|
否 |
|
