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/onsale_stockin_order_query.php
正式环境	http://6vzhpmj261.api.taobao.com/router/qm	http://zt.common.wdtdata.com/openapi/onsale_stockin_order_query.php
接口名	method: wdt.onsale.stockin.order.query	onsale_stockin_order_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	否	仓库编号
物流公司名称	logistics_name	varchar	40	否	物流公司名称
汇总单号	collect_no	varchar	150	否	汇总单号
批次号	batch_no	varchar	20	否	批次号
原始单号	src_tid	varchar	40	否	订单子订单原始单号
订单编号	trade_no	varchar	40	否	销售订单编号
退换单号	refund_no	varchar	40	否	退换单号
入库单号	stockin_no	varchar	20	否	入库单号

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	是	汇总单号
总成本	total_cost	decimal	(19,4)	是	总成本
入库数量	num	decimal	(19,4)	是	入库数量
退换单号	refund_no	varchar	40	是	退换单号
商家编码	spec_no	varchar	40	是	代表单品(sku)所有属性的编码，SKU概念介绍,单击这里。
原始退款单号	src_no	varchar	50	是	原始退款单号或天猫换货单号
退款单价	refund_price	decimal	(19,4)	是	退款单价
仓库编号	warehouse_no	varchar	40	是	代表仓库所有属性的唯一编码，用于仓库区分，ERP内支持自定义（ERP仓库界面设置），可通过warehouse_query.php 获取
仓库名称	warehouse_name	varchar	64	是	仓库名称
入库金额	refund_order_amount	decimal	(19,4)	是	入库金额
店铺编号	shop_no	varchar	20	是	代表店铺所有属性的唯一编码，用于店铺区分，ERP内支持自定义（ERP店铺界面设置），可通过shop.php获取
货品名称	goods_name	varchar	255	是	货品名称
原始单号	src_tid	varchar	40	是	原始单号
店铺网址	website	varchar	1024	是	店铺网址
客户编码	customer_no	varchar	40	是	客户编码
批次号	batch_no	varchar	20	是	批次号
销售组织	sales_system	varchar	255	是	销售组织
是否赠品	gift_type	tinyint	1	是	0非赠品 1赠品
入库单id	rec_id	bigint	20	是	入库单id
店铺名称	shop_name	varchar	128	是	店铺名称信息
店铺id	shop_id	smallint	6	是	店铺id
自定义属性1	prop1	varchar	255	是	自定义属性
货品编码	goods_no	varchar	40	是	货品编码
入库单号	stockin_no	varchar	40	是	售中退货入库单号
订单编号	trade_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自定义类型6
审核时间	check_time	date		是	审核时间
退换类型	refund_type	tinyint	4	是	退换类型：0取消1退款(未发货，退款申请)2退货3换货4退款不退货5订单补款
发货金额	total_amount	decimal	(19,4)	是	发货金额

5.响应示例

5.1 正常响应示例

JSON

{
    "message": "",
    "order_list": [
        {
            "logistics_name": "无",
            "collect_no": "2020110101WarehouseNo7210205540无0",
            "total_cost": 0,
            "num": 1,
            "refund_no": "",
            "spec_no": "10205540",
            "src_no": "",
            "refund_price": 14.9,
            "warehouse_no": "WarehouseNo72",
            "warehouse_name": "",
            "refund_order_amount": 14.9,
            "shop_no": "SMD001",
            "goods_name": "一叶子乳酸菌蜜桃面膜25ml*5",
            "src_tid": "657643714424730177",
            "website": "website",
            "customer_no": "",
            "batch_no": "",
            "refund_type": 0,
            "sales_system": "oms_remark",
            "gift_type": "否",
            "rec_id": 1,
            "shop_name": "SMD001",
            "shop_id": 1,
            "prop1": "",
            "goods_no": "",
            "stockin_no": "RK1911010002",
            "trade_no": "",
            "trade_type": "网店销售",
            "check_time": "2020-11-01 09:38:41"
        }
    ],
    "status": 0,
    "total_count": 1
}

5.2 异常响应示例

JSON

暂无