API文档

refund_query.php（查询退换管理）

¥标准

1.接口说明

1.1 接口描述：获取ERP销售退货（换货）订单信息

1.2 适用版本：网页版

1.3注意事项：权限校验：【店铺、仓库权限】

为了达到保护用户隐私数据安全的目的，本接口不返回淘系、拼多多及系统供销平台订单数据，相关平台规则点击这里，淘系及系统供销平台数据获取办法点击这里，拼多多请自行对接平台获取。

本接口中涉及到用户隐私的字段数据仅有自有平台及线下平台订单返回。

2.调用场景

2.1 自研商城、财务系统、SAP、数据分析等系统的对接

3.请求参数说明

3.1 请求地址

环境	HTTP地址
测试环境	https://openapitest.huice.com/openapi/refund_query.php
正式环境	https://openapi.huice.com/openapi/refund_query.php

3.2 公共请求参数

名称	字段	类型	必须	描述
卖家账号	sid	String	是	购买ERP时由旺店通分配给ERP购买方，请从ERP购买方获取。
接口账号	appkey	String	是	本开放平台“自助对接”功能模块内自助申请，获取方式点击这里
时间戳	timestamp	int	是	北京时间1970-01-01 08:00:00起至现在的总秒数，10位int值,旺店通企业版API服务端允许请求最大时间误差为5min，date.timezone = Asia/Shanghai。
签名	sign	String	是	API输入参数签名结果，签名算法介绍单击这里

3.3 业务请求参数

名称	字段	Y字段	描述	必须
店铺编号	shop_nos	shop_ids	由英文逗号分隔的店铺编号
原始单号	tid	tid	原始单号
客户网名	buyer_nick	无	客户网名
系统订单编号	trade_no	trade_no	系统订单编号
退换单号	refund_no	refund_no	退换单号
物流单号	return_logistics_no	return_logistics_no	物流单号（退换单上的退回物流单号）
修改起始时间	modified_from	modified_from	修改起始时间
修改结束时间	modified_to	modified_to	修改结束时间
退换单状态	status	status	10 已取消;20 待确认;35 待推送;36 推送失败;60 待入库;70 部分入库; 90 已完成
入库状态	stockin_status	stockin_status	0:无需入库;1:待入库;2:部分入库;3:全部入库;4:终止入库
退回仓库编号	return_warehouse_nos	return_warehouse_ids	退回仓库编号，用英文逗号分隔
退换单类型	type	type	订单类型 1.退款（未发货退款） 2.退货 3.换货 4.退款不退货 7 补寄 9 其他退款 11 已发货仅退款
分页大小	page_size	page_size	每页返回的数据条数，输入值范围1~100，不传本参数，输入值默认为100，使用举例单击这里	否
页号	page_no	page_no	页号，不传默认从0页开始	否

4.响应参数

4.1 公共响应参数

名称	字段	类型	长度	必须	描述
错误码	code	int	11	是	状态码:0表示成功,其他表示失败
错误描述	message	varchar	255	是	错误信息
条数	total_count	varchar	255	是	满足条件的总条数当page_no = 0时返回
系统退单	refunds	data[]		是	业务数据的一级节点，数组形式的订单数据，需要循环读取

4.2 业务响应参数

refunds

名称	字段	类型	长度	必须	描述
退换单主键	refund_id	bigint(20)	20	是	退换单主键
erp退换单号	refund_no	string	64	是	erp退换单号，默认TK开头
系统退单状态	process_status	tinyint(4)	4	是	10 已取消;20 待确认;35 待推送;36 推送失败;60 待入库;70 部分入库;90 已完成
店铺id	shop_id	int(11)	11	是
平台订单号	tid	string	255	是	可能多个
平台id	platform_id	int(11)	11	是
系统订单号	sales_tid	string	64	是
平台退单号	src_no	string	64	是
换出原始订单号	swap_trade_no	string	64	否
建单方式	from_type	tinyint(4)	4	是	建立方式 1api抓单 2手式建单
类型	type	tinyint(4)	4	是	订单类型 1.退款（未发货退款） 2.退货 3.换货 4.退款不退货 7 补寄 9 其他退款 11 已发货仅退款
数量	return_goods_count	decimal(19, 4)	19	是
申请退货金额	goods_amount	decimal(19, 4)	19	是
平台退款金额	guarante_refund_amount	decimal(19, 5)	19	否
线下退款金额	offline_refund_amount	decimal(19, 6)	19	否
实际退款金额	actual_refund_amount	decimal(19, 4)		否
实退数量	actual_refund_num	decimal(19, 4)		否	实际入库完的数量
退款原因	refund_reason	varchar	255	否
备注	remark	varchar	255	否
最后修改时间	modified	datetime		是
退回物流公司名称	return_logistics_name	varchar	255	否	买家输入
退回物流公司单号	return_logistics_no	varchar	255	否	买家输入
退款原因ID	reason_id	int(11)		否
结算时间	finish_time	datetime		否
客户昵称	buyer_nick	varchar	255	否
创建时间	created	datetime		是
申请时间	refund_time	datetime		否
退款子订单信息	refund_order_list	data[]		是	退款子订单信息, refund_order_list结构

refund_order_list

名称	字段	类型	长度	必须	描述
系统退单明细id	order_id	bigint(20)		是
平台子订单号	oid	varchar	64	是
系统订单明细id	sales_order_id	bigint(20)	20	是
平台id	platform_id	int(11)	11	是
平台订单号	tid	varchar	64	是
平台退单号	src_no	varchar	64	是
系统订单号	sales_tid	varchar	64	是
单品id	spec_id	bigint(20)	20	是
商家编码	spec_no	varchar	64	是
货品编码	goods_no	varchar	64	是
规格编码	spec_code	varchar	64	否
数量	refund_num	decimal(19, 4)	19	是
原价	original_price	decimal(19, 4)	19	是	系统订单明细的标记
价格	price	decimal(19, 4)	19	是	系统订单明细的成交价
退款金额	refund_order_amount	decimal(19, 4)	19	是
退货金额	total_amount	decimal(19, 4)	19	是	系统订单明细的分摊总价
备注	remark	varchar	255	是
最后修改时间	modified	datetime		是
实际入库数量	stockin_num	decimal(19, 4)	19	是
商品名称	goods_name	varchar	255	是
规格名称	spec_name	varchar	255	是
实际数量	order_num	decimal(19, 4)	19	否
组合装id	suite_id	bigint(20)	20	否
组合装编码	suite_no	decimal(19, 4)	19	否
组合装数量	suite_num	decimal(19, 4)	19	否