当前位置: 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/qmtesthttp://39.100.141.5:30002/openapi/return_collect_query.php
正式环境http://6vzhpmj261.api.taobao.com/router/qmhttp://zt.common.wdtdata.com/openapi/return_collect_query.php
接口名method: wdt.return.collect.query

return_collect_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奇门签名计算规则signwdt签名计算规则API输入参数签名结果,签名算法介绍单击这里
方法名method方法名


奇门接入必传参数
目标appkeytarget_app_key旺店通在奇门授权应用


奇门接入必传参数

业务请求参数

名称字段类型长度
必须描述
开始时间start_timedate

按汇总日期增量获取数据,start_time作为开始时间(包含当天),格式: YYYY-MM-DD
结束时间end_timedate

按汇总日期增量获取数据,end_time作为结束时间(包含当天),格式: YYYY-MM-DD
分页大小page_sizeint

每页返回的数据条数,输入值范围1~100,不传本参数输入值默认为30,使用举例单击这里

页号page_noint


需要查询第page_no页的数据,不传值默认从第1页开始

店铺编号
shop_no
varchar
20
店铺编号
仓库编号warehouse_novarchar40仓库编号
物流公司名称logistics_namevarchar40物流公司名称

4.响应参数

 4.1 正确响应参数

名称奇门响应常规响应类型长度
必须描述
错误码errorcodecodeint11状态码:0表示成功,其他表示失败
错误描述messagemessagevarchar255错误描述
数据条数total_counttotal_countint11只有page_no = 1 时才返回的符合条件的数据总条数,用来分页
数据节点order_list
order_list
data[]

响应参数的1级数据节点

   4.2 错误响应参数

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


   4.3 业务响应参数

   order_list[]

名称字段类型长度
必须描述
汇总单号collect_novarchar150汇总单号
店铺名称shop_name
varchar
128店铺名称信息
店铺编号shop_no
varchar20

代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置),可通过shop.php获取
仓库名称warehouse_namevarchar64
仓库名称信息
仓库编号warehouse_novarchar40代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置),可通过warehouse_query.php获取
物流公司名称logistics_namevarchar40物流公司名称

商家编码

spec_novarchar40代表单品(sku)所有属性的编码,SKU概念介绍,单击这里
退货类型is_aftersaleint11退货类型 0售中,1售后
退款金额refund_amountdecimal(19,4)
退款金额
入库数量num
decimal(19,4)入库数量
汇总日期collect_datedate
汇总日期
单据类型
trade_typetinyint4
单据类型:1网店销售2线下零售3售后换货4批发业务5保修换新6保修完成7订单补发 .. 101自定义类型1 102自定义类型2 103自定义类型3 104自定义类型4 105自定义类型5 106自定义类型6
用户编码user_novarchar40用户编码
退款单价refund_pricedecimal(19,4)退款单价
是否赠品
gift_typetinyint10非赠品 1赠品
税率tax_ratedecimal(19,4)税率

5.响应示例

   5.1 正常响应示例 

JSON
暂无

   5.2 异常响应示例

JSON
暂无




常用工具