API文档

查询退换单接口

¥标准

1.接口说明

1.1 接口描述：获取结算中心—退换单数据（仅退款、退货退款）

1.2 适用版本：任何版本

1.3 增量获取：按照退换单结算时间增量获取数据，请求时输入start_time和end_time作为时间跨度的筛选条件。

1.4 时间跨度：start_time和end_time建议不超过30天

1.5注意事项：淘系数据需要通过奇门接口获取。

2.调用场景

2.1 举例说明：用于第三方系统进行售中退货入库汇总数据同步

3.请求参数说明

3.1 请求地址

环境	奇门访问地址	访问地址
测试环境	http://6vzhpmj261.api.taobao.com/router/qmtest	http://39.100.141.5:30002/openapi/aftersale_stockin_order_query.php
正式环境	http://6vzhpmj261.api.taobao.com/router/qm	http://zt.common.wdtdata.com/openapi/aftersale_stockin_order_query.php
接口名	method: wdt.refund.collect.detail.query	refund_collect_detail_query.php

3.2 SDK下载地址：

奇门SDK下载：结算中心—奇门接口SDK.rar

公共请求参数

名称	奇门接入参数	奇门参数说明	常规接入参数	常规参数说明	必须	描述
卖家账号	sid	卖家账号	sid	卖家账号	是	购买ERP时由旺店通分配给ERP购买方，请从ERP购买方获取。
接口账号	app_key	奇门授权应用	appkey	旺店通授权应用	是	需线下联系工作人员进行授权。
时间戳	timestamp	格式化后的时间戳2019-12-06 10:37:00	timestamp	时间戳（1575599760）	是	北京时间1970-01-01 08:00:00起至现在的总秒数，10位int值,旺店通企业版API服务端允许请求最大时间误差为5min，date.timezone = Asia/Shanghai。
签名	sign	奇门签名计算规则	sign	wdt签名计算规则	是	API输入参数签名结果，签名算法介绍单击这里
方法名	method	方法名				奇门接入必传参数
目标appkey	target_app_key	旺店通在奇门授权应用				奇门接入必传参数

业务请求参数

名称	字段	类型	长度	必须	描述
开始时间	start_time	date		是	按结算时间增量获取数据,start_time作为开始时间(包含当天)，格式： YYYY-MM-DD
结束时间	end_time	date		是	按结算时间增量获取数据,end_time作为结束时间(包含当天)，格式： YYYY-MM-DD
分页大小	page_size	int		否	每页返回的数据条数，输入值范围1~100，不传本参数输入值默认为30，使用举例单击这里
页号	page_no	int		否	需要查询第page_no页的数据，不传值默认从第1页开始
店铺编号	shop_no	varchar	20	否	店铺编号
仓库编号	warehouse_no	varchar	40	否	仓库编号
汇总单号	collect_no	varchar	150	否	汇总单号
原始单号	src_tid	varchar	40	否	订单子订单原始单号
订单类型	trade_type	tinyint	4	否	销售订单类型 1网店销售2线下零售3售后换货4批发业务5保修换新6保修完成7订单补发..101自定义类型1 102自定义类型2 103自定义类型3 104自定义类型4 105自定义类型5 106自定义类型6
退货类型	refund_type	tinyint	4	否	0取消订单(目前没用)1退款(未发货，退款申请)2退货3换货4退款不退货5订单补款
是否是售后	is_aftersale	tinyint	4	否	是否是售后

4.响应参数

4.1 正确响应参数

名称	奇门响应	常规响应	类型	长度	必须	描述
错误码	errorcode	errorcode	int	11	是	状态码:0表示成功,其他表示失败
错误描述	message	message	varchar	255	是	错误描述
数据条数	total_count	total_count	int	11	否	只有page_no = 1 时才返回的符合条件的数据总条数，用来分页
数据节点	order_list	order_list	data[]		是	响应参数的1级数据节点

4.2 错误响应参数

名称	奇门响应	常规响应	类型	长度	必须	描述
错误码	code	code	int	11	是	状态码:0表示成功,其他表示失败
错误描述	message	message	varchar	255	是	错误描述
错误标记	flag		bool	11	是	奇门错误响应标识，failure代表失败
子错误码	sub_code		int	11	是	旺店通错误码
子错误原因	sub_message		varchar	255	是	旺店通错误原因

4.3 业务响应参数

order_list[]

名称	字段	类型	长度	必须	描述
物流公司名称	logistics_name	varchar	40	是	物流公司名称
汇总单号	collect_no	varchar	150	是	汇总单号
分摊邮费	share_post	decimal	(19,4)	是	分摊邮费
入库数量	stockin_num	decimal	(19,4)	是	入库数量
退货数量	refund_num	varchar	40	是	退换单号
商家编码	spec_no	varchar	40	是	代表单品(sku)所有属性的编码，SKU概念介绍,单击这里。
货品编号	goods_no	varchar	50	是	货品编号
退款单价	refund_price	decimal	(19,4)	是	退款单价
仓库编号	warehouse_no	varchar	40	是	代表仓库所有属性的唯一编码，用于仓库区分，ERP内支持自定义（ERP仓库界面设置），可通过warehouse_query.php 获取
仓库名称	warehouse_name	varchar	64	是	仓库名称
退款金额	refund_amount	decimal	(19,4)	是	退款金额
发货金额	total_amount	decimal	(19,4)	是	发货金额
分摊抵扣退款金额	discount_amount	decimal	(19,4)	是	分摊抵扣退款金额
店铺编号	shop_no	varchar	20	是	代表店铺所有属性的唯一编码，用于店铺区分，ERP内支持自定义（ERP店铺界面设置），可通过shop.php获取
货品名称	goods_name	varchar	255	是	货品名称
原始单号	src_tid	varchar	40	是	原始单号
原始子单号	src_oid	varchar	40	是	原始子单号
店铺网址	website	varchar	1024	是	店铺网址
是否是售后	is_aftersale	tinyint	4	是	是否是售后
税率	tax_rate	decimal	(19,4)	是	是否是税率
销售组织	sales_system	varchar	255	是	销售组织
是否赠品	gift_type	tinyint	1	是	0非赠品 1赠品
退换单	rec_id	bigint	20	是	入库单id
店铺名称	shop_name	varchar	128	是	店铺名称信息
店铺id	shop_id	smallint	6	是	店铺id
货品自定义属性1	prop1	varchar	255	是	自定义属性1
货品编码	goods_no	varchar	40	是	货品编码
组合装编码	suite_no	varchar	40	是	组合装编码
组合装名称	suite_name	varchar	40	是	组合装名称
退换原因	reason	varchar	40	是	退换原因
备注	remark	varchar	255	是	备注
退换单号	refund_no	varchar	40	是	退换单号
单据类型	trade_type	tinyint	4	是	单据类型：1网店销售2线下零售3售后换货4批发业务5保修换新6保修完成7订单补发 .. 101自定义类型1 102自定义类型2 103自定义类型3 104自定义类型4 105自定义类型5 106自定义类型
结算时间	finish_time	date		是	结算时间
退换类型	refund_type	tinyint	4	是	退换类型：0取消1退款(未发货，退款申请)2退货3换货4退款不退货5订单补款

5.响应示例

5.1 正常响应示例

JSON

{
	"message": "",
	"order_list": [{
		"logistics_name": "\u624b\u5de5\u5efa\u5355\u7269\u6d41",
		"reason": "7\u5929\u65e0\u7406\u7531",
		"collect_no": "20210219SMD010SMC001SMDP010012",
		"discount_amount": 0,
		"goods_no": "SMHP006",
		"refund_no": "WDTTK2102190006",
		"suite_name": "",
		"remark": "\u5907\u6ce8",
		"spec_no": "SMDP010",
		"refund_price": 10,
		"tax_rate": 0.13,
		"warehouse_no": "SMC001",
		"refund_amount": 9.091,
		"shop_no": "SMD010",
		"src_tid": "SMTID1-1613646727",
		"website": "WZ5566",
		"refund_type": 2,
		"stockin_num": 1,
		"is_aftersale": "1",
		"sales_system": "BZ5566",
		"gift_type": 0,
		"rec_id": 7179,
		"shop_name": "\u8bdd\u6885\u95e8\u5e97\u6d4b\u8bd5\u5e97",
		"share_post": 0,
		"finish_time": "2021-02-19 13:39:30",
		"shop_id": 25,
		"prop1": "1",
		"warehouse_name": "SMC001",
		"refund_num": 1,
		"suite_no": "",
		"trade_type": "0",
		"src_oid": "SMOID1-1613646727"
	}],
	"status": 0,
	"total_count": 331
}

5.2 异常响应示例

JSON

暂无