文档
测试

return(退货)

POST
\order\return

接口描述

按小票退货接口

请求参数

参数名
类型
描述
必填
token
string
身份认证
必填
operate
string
退款操作类型,参照接口说明
必填
code
string
退货输入凭证,参照接口说明
必填

响应参数

参数名
类型
描述
必填
code
string
状态码(0:成功/其它:错误)
必填
message
string
错误信息(仅在发生错误时有意义)
必填
data
json
退款基本信息
必填
return_info
json
退货基本信息,包含退货模式和基本参数设置 operate = 100 时有效
必填
return_mode
int
退货模式 1/按小票退货 2/可选方式退货 可选方式退货需要弹出选择界面
必填
return_days_max
int
最大允许对X天内的小票进行退货
必填
return_days_max_info
string
最大允许对X天内的小票进行退货显示信息 e.g. 仅支持搜索7天内的销售订单
必填
order_info
json
退货订单列表数据 operate = 200 时有效
必填
total_count
int
匹配到的订单数量,如果匹配到的订单数量为1,需要跳转到退货商品明细界面
必填
orders
set
订单列表
必填
line_id
string
行号,业务逻辑使用
必填
order_id
string
订单号
必填
create_time
datetime
销售日期
必填
sale_time
datetime
当班日期
必填
sum_amt
decimal
订单金额
必填
vip_no
string
会员编码,会员编码为空表示非会员销售
必填
vip_phone
string
会员手机号
必填
return_status
string
退货状态 0/未退货 1/部分退货 2/全部退货
必填
order_bill
json
退货订单小票信息 operate = 200 和 operate = 300 时有效, operate =200时匹配第一条
必填
order_id
string
订单号
必填
company_name
string
商户名称
必填
oper_no
string
收银员
必填
oper_name
string
收银员名称
必填
pay_remote_order
string
商户订单号
必填
mac_no
string
机器号
必填
create_time
datetime
销售时间
必填
sale_time
datetime
当班日期
必填
total_qty
decimal
商品总件数
必填
wait_amt
decimal
应收金额
必填
paid_amt
decimal
实收金额
必填
first_match_index
string
首个匹配到商品索引,从0开始,没有返回空
必填
details
set
商品明细列表
必填
order_id
string
订单号
必填
line_id
int
行号
必填
item_id
string
商品id
必填
name
string
商品名称
必填
qty
decimal
商品数量
必填
price
decimal
商品价格
必填
amt
decimal
商品金额
必填
is_match
int
是否和搜索商品条件匹配 0/否 1/是
必填
pays
set
支付信息列表
必填
order_id
string
订单号
必填
line_id
int
行号
必填
pay_no
string
支付编码
必填
pay_name
string
支付名称
必填
pay_amt
decimal
支付金额
必填
order_detail_info
json
退货商品信息 operate = 400 时有效
必填
order_id
string
订单号
必填
return_status
int
0/未退货 1/部分退货 2/退货完成
必填
return_total_amt
decimal
本次合计退款
必填
details
set
商品明细列表
必填
order_id
string
订单号
必填
row
string
行号(只用于展示)
必填
line_id
int
行号(用于业务逻辑)
必填
item_id
string
商品id
必填
name
string
商品名称
必填
org_qty
decimal
可退数量(为0代表已退单)
必填
org_price
decimal
销售价格
必填
org_amt
decimal
可退金额
必填
qty
decimal
本次退货数量, 此时为0
必填
is_match
bool
是否和商品搜索条件匹配
必填
org_spec_price
string
原单促销后价格
必填
unit
string
商品单位
必填
curr_details
set
本次选择的商品列表,此时为空
必填
total_amt
decimal
整单全退的时候显示的总金额
必填

说明 / 示例

> `operate = 100 点击退货按钮,进入退款界面,获取退货模式和基本信息,决定后续退货流程` `code: 无效` `退货模式为按小票退货,进入小票退货界面,调用接口\order\return,operate=200` `退货模式为选择商品退货,进入购物车界面,调用接口\order\cart,operate=100` `退货模式为手动选择退货模式,进入选择退货模式界面,选择后再进入上述选择` > `operate = 200 按小票退货模式下,搜索销售订单,需要将订单列表展示到订单列表界面上,且展示小票打印信息` `code: 小票搜索信息,支持完整小票号/小票后4位/商户单号/会员/商品` > `operate = 300 按小票退货模式下,点击订单获取小票信息,需要将小票信息展示到右方小票信息处` `code: 订单id` > `operate = 400 按小票退货模式下,选择小票进行退货,进入退货商品页面` `code: 订单id`