API文档

vip_api_refund_query.php（原始平台退单查询）

¥标准

奇门接口url : wdt.api.refund.query

1.接口说明

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

1.2 适用版本：网页版

2.调用场景

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

3.请求参数说明

3.1 请求地址

环境	HTTP地址
测试环境	https://openapitest.huice.com/openapi/vip_api_refund_query.php
正式环境	https://openapi.huice.com/openapi/vip_api_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 业务请求参数

名称	字段	描述	是否必填
开始时间	start_time	开始时间
结束时间	end_time	结束时间
时间条件类型	time_type（1）	1：修改时间2：退款时间不传按照修改时间获取数据
原始退单号	refund_no	原始退单号
物流单号	logistics_no	物流单号
平台id	platform_id	平台id，映射表点击文档中心查看
店铺编号	shop_id	店铺编号
平台订单号	tid	平台原始单号
平台子单号	oid	平台原始子单号
分页大小	page_size	每页返回的数据条数，输入值范围1~100，不传本参数，输入值默认为100，使用举例单击这里	否
页号	page_no	页号，不传默认从0页开始	否

4.响应参数

4.1 公共响应参数

名称	字段	类型	长度	必须	描述
错误码	code	int	11	是	状态码:0表示成功,其他表示失败
错误信息	message	varchar	255	是	错误信息
条数	total_count	varchar	255	是	符合查询条件的总数量，只有page_no = 0 时才有值
当前页的退换单数据	trade_list	data[]		是	业务数据的一级节点，数组形式的订单数据，需要循环读取

4.2 业务响应参数

trade_list

名称	Y字段	Y 父级字段	Y类型	Y枚举	是否必须	默认值	是否可变更
原始退单号	refund_no		string		是		否
平台id	platform_id		int(11)		是		否
平台退单状态	status		tinyint(4)	平台状态：1取消退款,2已申请退款,3等待退货,4等待收货,5退款成功	是		是
原始订单号	tid		string		是		否
店铺id	shop_id		int(11)		是		否
退款类型	type		tinyint(4)	退款类型：0.无 1.退款（未发货退款） 2.退货 3.换货 4.退款不退货 5 拒收退货 6 投诉退款 7 补寄 8 维修退款 9 其他退款 11 已发货仅退款 40 三无包裹	是		否
退款阶段	无		tinyint(4)	退款阶段 0售前和售中 1售后	是		否
退款原因	reason		string		是		是
申请退款金额	refund_amount		decimal(19, 4)		是		是
申请退款时间	refund_time		datetime		是		是
退款成功金额	actual_refund_amount		decimal(19, 4)		是		否
退款成功时间	current_phase_timeout		datetime	完成后部分平台有，没有的传null	否		否
退款数量	num		decimal(19, 4)		是		是
快递公司	logistics_name		string		否	null	是
物流单号	logistics_no		string		否	null	是
备注	remark		string		是		是
最后修改时间	modified		datetime		是		是
是否售后退款单据	is_aftersale		int	是否是售后退款单据 0 否 1 是
标记掩码	refund_mask		int		是	0	否
明细货品列表	goods_list		array[]		是
原始子单号	oid	goods_list	string		是		否
平台id	platform_id	goods_list	int(11)		是		否
原始单号	tid	goods_list	string
原始退单号	refund_no	goods_list	string		是		否
退单子单状态	status	goods_list	tinyint(4)		是		是
退款数量	num	goods_list	decimal(19, 4)		是		否
分摊后总额	total_amount	goods_list	decimal(19, 4)	与主单一对一目前不分摊	是		否
备注	remark	goods_list	string		是		是
平台货品ID	goods_id	goods_list	string		是		是
平台货品编码	goods_no	goods_list	string		是		是
平台货品名称	goods_name	goods_list	string		是		是
平台规格ID	spec_id	goods_list	string		是		是
平台规格编码	spec_no	goods_list	string		是		是
平台规格码	无	goods_list	string		是	''	是
平台规格名称	spec_name	goods_list	string		是		是
子单最后修改时间	modified	goods_list	datetime		是		是