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_ids	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:待审核;30:已同意;35 待推送；36 推送失败； 40 已拒绝；45 部分推送; 60 待入库 ; 70 部分入库; 80:待结算; 85:部分结算; 90:已完成
入库状态	stockin_status	stockin_status	0:无需入库;1:待入库;2:部分入库;3:全部入库;4:终止入库
退回仓库编号	return_warehouse_nos	return_warehouse_ids	退回仓库编号，用英文逗号分隔
退换单类型	type	type	订单类型 1-退款(未发货，退款申请),2-退货,3-换货,4-退款不退货
模糊查询	fuzzy_query	无	默认false,业务单号进行模糊查询匹配，匹配数量大于1条时会报错
是否为拦截件	return_mask_manual_intercept	无	0：否 1：是不传不判断
是否拒收	refund_mask_reject_return	无	0：否 1：是不传不判断
分页大小	page_size	page_size	每页返回的数据条数，输入值范围1~100，不传本参数，输入值默认为100，使用举例单击这里	否
页号	page_no	page_no	页号，不传默认从0页开始	否

4.响应参数

4.1 公共响应参数

名称	字段	类型	长度	必须	描述
错误码	code	int	11	是	状态码:0表示成功,其他表示失败
错误信息	message	varchar	255	是	错误信息
满足条件的总条数	total_count	int	11	否	满足条件的总条数当page_no = 0时返回
当前页的退换单数据	refunds	data[]		否	当前页的退换单数据

4.2 业务响应参数

refunds

名称	字段	类型	长度	必须	描述
退换单主键	refund_id	long	20	是	退换单主键
erp退换单号	refund_no	varchar	64	是	erp退换单号，默认TK开头
平台类型	platform_id	long	20	是	平台类型，响应值为代表平台的ID数字，ID对应的平台名称单击这里
平台退款单号	src_no	varchar	40	是	平台退款单号
类型	type	tinyint	4	是	1退款(未发货，退款申请)2退货3换货4退款不退货5订单补款
处理状态	process_status	tinyint	4	是	10已取消 20待审核 30已同意 40已拒绝 50待财审 60待收货 70部分到货 80待结算 90已完成
平台状态	platform_status	tinyint	4	是	1取消退款,2已申请退款,3等待退货,4等待收货,5退款成功
退货金额	goods_amount	decimal	19,4	是	退货金额
线下退款金额	direct_refund_amount	decimal	19,4	是	订单确认收货之后的退款金额
平台退款金额	guarante_refund_amount	decimal	19,4	是	平台退款金额
实际退款/收款金额	actual_refund_amount	decimal	19,4	是	实际退款/收款金额
订单的原始单号	tid	varchar	255	是	订单的原始单号
系统订单号	sales_tid	varchar	40	是	系统订单编号，默认单号为JY开头，ERP内支持自定义（设置路径：设置——编码设置）
昵称	buyer_nick	varchar	128	是	昵称
退回物流公司名称	return_logistics_name	varchar	64	是	退回物流公司名称
退回物流单号	return_logistics_no	varchar	64	是	退回物流单号
退款创建时间	refund_time	datetime		是	退款创建时间格式：yyyy-MM-dd HH:mm:ss
备注	remark	varchar	255	是	备注
退款原因	refund_reason	varchar	255	是	退款的具体原因说明
换出原始单号	swap_trade_no	varchar	40	是	ERP生成的换出订单的原始订单编号
最后修改时间	modified	datetime		是	最后修改时间格式：yyyy-MM-dd HH:mm:ss
结算时间	finish_time	datetime		是	旺店通内操作结算的时间格式：yyyy-MM-dd HH:mm:ss
创建时间	created	datetime		是	创建时间
店铺id	shop_id	smallint	6	是	店铺id
建立方式	from_type	tinyint	4	是	1api抓单 2手式建单
退回货品数量	return_goods_count	decimal	19,4	是	默认为'0'，退回货品数量
原因	reason_id	int	11	是	默认为'0'，原因
退款子订单信息	refund_order_list	data[]		是	退款子订单信息, refund_order_list结构

refund_order_list

名称	字段	类型	长度	必须	描述
货品明细主键	order_id	long	20	是	退换单退回货品明细主键
原始子订单编号	oid	varchar	64	是	原始子订单编号
订单子订单的原始单号	tid	varchar	64	是	订单子订单的原始单号
平台退款单号	src_no	varchar	64	是	平台退款单号
销售订单编号	sales_tid	varchar	64	是	销售订单编号
实际数量	order_num	decimal	19,4	是	实际数量
价格	price	decimal	19,4	是	价格
平台类型	platform_id	smallint	6	是	平台类型，响应值为代表平台的ID数字，ID对应的平台名称单击这里
原价	original_price	decimal	19,4	是	原价
退款数量	refund_num	decimal	19,4	是	退款数量
明细退款金额	refund_order_amount	decimal	19,4	是	明细退款金额，由主单退款金额分摊
退货金额	total_amount	decimal	19,4	是	退货金额
erp商品主键	spec_id	long	20	是	erp商品主键
商家编码	spec_no	varchar	255	是	代表单品(sku)所有属性的唯一编码，用于系统单品区分，SKU概念介绍,单击这里
货品名称	goods_name	varchar	255	是	货品名称
货品编号	goods_no	varchar	255	是	代表货品(spu)所有属性的唯一编号，用于系统货品区分，，SPU概念介绍,单击这里
规格名称	spec_name	varchar	255	是	规格名称
规格编码	spec_code	varchar	255	是	规格编码
组合装编号	suite_no	varchar	255	是	组合装编号
组合装数量	suite_num	decimal	19,4	是	组合装数量
退货入库数量	stockin_num	decimal	19,4	是	退货入库数量
退款说明	remark	varchar	255	是	退换明细的备注
销售订单ID	sales_order_id	long	20	是	默认为'0'
组合装ID	suite_id	long	20	是	默认为'0'，组合装ID
最后修改时间	modified	datetime		是	最后修改时间格式：yyyy-MM-dd HH:mm:ss
创建时间	created	datetime		是	创建时间