API文档

stockin_order_query_refund.php（查询退货入库单）

1.接口说明

1.1 接口描述：获取旺店通ERP销售退货（换货）订单对应的入库单信息

1.2 适用版本：客户端 V2.4.5.6及以上版本

1.3 增量获取：按照ERP退货入库单的最后修改时间增量获取数据，请求时输入start_time和end_time作为时间跨度的筛选条件。

1.4 时间跨度：start_time和end_time最大跨度为30天，开始时间和结束时间取值范围为闭区间取值，例如2018-11-01 00:00:00至2018-11-30 23:59:59，建议根据获取数据量的多少适当减小时间跨度。

1.5 注意事项：本接口不返回淘系及系统供销平台订单数据，相关平台规则单击这里。淘系及系统供销订单数据获取办法单击这里。其他平台的敏感信息会根据平台规则同步调整。

2.调用场景

2.1 财务系统、SAP、数据分析等系统的对接

3.请求参数说明

3.1 请求地址

环境	HTTP地址
测试环境	https://sandbox.wangdian.cn/openapi2/stockin_order_query_refund.php
正式环境	https://api.wangdian.cn/openapi2/stockin_order_query_refund.php

查询历史退货入库单地址：

环境	HTTP地址
测试环境	https://sandbox.wangdian.cn/openapi2/his_stockin_order_query_refund.php
正式环境	https://api.wangdian.cn/openapi2/his_stockin_order_query_refund.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 业务请求参数

名称	字段	类型	长度	必须	描述
状态	status	tinyint	4	否	入库单状态 10已取消20编辑中30待审核60待结算80已完成（默认查询80已完成单据）
开始时间	start_time	datetime		是	按时间增量获取数据,start_time作为开始时间，格式：yyyy-MM-dd HH:mm:ss
结束时间	end_time	datetime		是	按时间增量获取数据,end_time作为结束时间，格式：yyyy-MM-dd HH:mm:ss
入库单号	stockin_no	varchar	40	否	入库单号，传该字段可以不传时间范围
退换单号	src_order_no	varchar	40	否	系统退换单号，默认TK开头，传该字段可以不传时间范围
分页大小	page_size	int		否	每页返回的数据条数，输入值范围1~100，不传本参数，输入值默认为40，使用举例单击这里
页号	page_no	int		否	页号默认从0开始
仓库编号	warehouse_no	varchar	40	否	仓库编号
店铺编号	shop_no	varchar	40	否	代表店铺所有属性的唯一编码，用于店铺区分，ERP内支持自定义（ERP店铺界面设置），用于获取指定店铺单据数据信息
时间类型	time_type	tinyint	1	否	0:最后修改时间，1:创建时间 2:预入库单关联时间默认为0
关联历史表	include_history	tinyint	1	否	0:不关联历史表，1关联历史表，默认为0
店铺编号（批量）	shop_nos	varchar		否	批量指定店铺获取（多个店铺编号之间用英文逗号隔开，最多指定20个店铺）

4.响应参数

4.1 公共响应参数

名称	字段	类型	长度	必须	描述
错误码	code	int	40	是	状态码:0表示成功,其他表示失败
错误描述	message	varchar	255	是	错误描述
数据条数	total_count	int	10	否	符合条件的数据条数，用来分页当page_no = 0时返回
入库单详情	stockin_list	data[]		否	入库单详情数据节点

4.2 业务响应参数

stockin_list

名称	字段	类型	长度	必须	描述
入库单主键id	stockin_id	int	11	是	入库单主键id
入库单号	order_no	varchar	40	是	入库单号
仓库编号	warehouse_no	varchar	40	是	代表仓库所有属性的唯一编码，用于仓库区分，ERP内支持自定义（ERP仓库界面设置）
仓库名称	warehouse_name	varchar	64	是	仓库名称
店铺编号	shop_no	varchar	20	是	代表店铺所有属性的唯一编码，用于店铺区分，ERP内支持自定义（ERP店铺界面设置），用于获取指定店铺数据信息
店铺备注	shop_remark	varchar	255	是	店铺备注
上层单据（退换单）编号	src_order_no	varchar	40	是	上层单据（退换单）编号，默认TK开头
退换单状态	process_status	tinyint	4	是	10已取消,20待审核,30已同意,40已拒绝,50待财审,60待收货,63待推送,64推送失败,65委外待收货,69待收货(已结算),70部分到货,71部分到货(已结算),80待结算 ,90已完成。ERP版本V2.3.8.4及以上才可返回
退货入库单状态	status	tinyint	4	是	入库单状态 10已取消20编辑中30待审核60待结算80已完成
更新时间	stockin_time	datetime	datetime	是	更新时间格式：yyyy-MM-dd HH:mm:ss
创建时间	created_time	datetime	datetime	是	创建时间格式：yyyy-MM-dd HH:mm:ss
关联时间	associated_time	datetime	datetime	是	预入库单关联退换单时间格式：yyyy-MM-dd HH:mm:ss
备注	remark	varchar	255	是	备注
订单编号	trade_no	varchar	40	是	系统订单编号，默认单号为JY开头，ERP内支持自定义（设置路径：设置——编码设置）
系统订单类别	trade_type	varchar	128	是	系统订单类别（1网店销售,2线下零售,3售后换货,4批发业务,5保修换新,6保修完成,7订单补发 .. 101自定义类型1,102自定义类型2,103自定义类型3,104自定义类型4 ,105自定义类型5,106自定义类型6）
单据类别	order_type	tinyint	4	是	单据类别，默认返回3
单据类别名称	order_type_name	varchar	128	是	单据类别名称，默认为“退货入库”
货品数量	goods_count	decimal	(19,4)	是	货品数量
货款总额	goods_amount	decimal	(19,4)	是	退回货款收入
实际退款金额	actual_refund_amount	decimal	(19,4)	是	实际退款金额
扣除优惠后货款总额	total_price	decimal	(19,4)	是	退回货品成本
优惠金额	discount	decimal	(19,4)	是	优惠金额
税后金额	tax_amount	decimal	(19,4)	是	税后金额
邮费	post_fee	decimal	(19,4)	是	退货入库单的“邮资”
其他费用	other_fee	decimal	(19,4)	是	退货入库单的“其它金额”
纠错金额	adjust_price	decimal	(19,4)	是	纠错金额
调整后总金额	right_price	decimal	(19,4)	是	调整后总金额
物流类型	logistics_type	smallint	6	是	响应值为代表物流类型的数字，数字对应的物流类型名称单击这里
物流编号	logistics_no	varchar	20	是	代表物流所有属性的唯一编码，用于物流区分，ERP内支持自定义（ERP物流界面设置）
物流名称	logistics_name	varchar	40	是	ERP设置的物流公司名称
物流单号	logistics_code	varchar	40	是	物流单单号
退换单编号	refund_no	varchar	40	是	退换单编号
入库审核时间	check_time	datetime		是	入库时间返回数据格式，0000-00-00 00:00:00
客户编号	customer_no	varchar	40	是	客户编号
客户名称	customer_name	varchar	100	是	退货人的姓名
客户网名	nick_name	varchar	100	是	客户网名
店铺名称	shop_name	varchar	128	是	店铺名称
分销商昵称	fenxiao_nick	varchar	40	是	分销商昵称
分销商编号	fenxiao_nick_no	varchar	40	是	分销商编号
退换原因	reason	varchar	255	是	退换原因
入库原因	stockin_reason	varchar	32	是	入库原因
退货单标记	flag_name	varchar	32	是	退换单界面的标记
平台id	platform_id	smallint	6	是	平台id 响应值为代表平台的ID数字，ID对应的平台名称单击这里
订单原始单号	tid	varchar	255	是	订单原始单号
入库操作人姓名	stockin_operator_name	varchar	40	是	默认为''，入库操作人姓名
审核人姓名	check_operator_name	varchar	40	是	默认为''，审核人姓名
退换备注	refund_remark	varchar	255	是	默认为''，退换备注
退货员姓名	refund_operator_name	varchar	40	是	默认为''，退货员姓名
入库单号	stockin_no	varchar	20	是	入库单号
外部仓库单号	wms_outer_no	varchar	40	是	默认为''，对应外部仓库的单号
外部仓库状态	wms_status	tinyint	4	是	默认为'0'，外部状态,与wms对接使用 0初始化 1失败 2成功'
结果	wms_result	varchar	512	是	默认为''，错误信息
仓库id	warehouse_id	int	11	是	默认为'0'，仓库id
入库单类型	src_order_type	tinyint	6	是	默认为'0'，入库单类型 3退货入库
业务单据id	src_order_id	int	11	是	默认为'0'，业务单据id
原因	reason_id	int	11	是	原因
财务同步状态	fa_status	tinyint	4	是	默认为'0'，财务同步状态
物流公司d	logistics_id	smallint	6	是	默认为'0'，物流公司id
邮资分摊类型	post_share_type	int	11	是	默认为'0'，邮费分摊类型0,不分摊 1,按数量分摊2,按照金额分摊'
操作员id	operator_id	varchar	40	是	操作员id
审核员id	check_operator_id	varchar	40	是	审核员id
货品种类数	goods_type_count	int	11	是	默认为'0'，货品种类数
调整数量	adjust_num	decimal	(19,4)	是	默认为'0'，调整数量
便签条数	note_count	smallint	6	是	默认为'0'，便签条数
标记id	flag_id	smallint	6	是	默认为'0'，标记id
最后修改时间	modified	datetime		是	最后修改时间
货品列表节点	details_list	data[]	data	是	退回货品列表节点

details_list

名称	字段	类型	长度	必须	描述
明细表主键id	rec_id	int	11	是	明细表主键id
入库单主键id	stockin_id	int	11	是	入库单主键id
上层单据（退换单）退回货品明细主键	src_order_detail_id	int	11	是	上层单据（退换单）退回货品明细主键，ERP版本V2.3.8.3及以上才可返回
商家编码	spec_no	varchar	40	是	代表单品(sku)所有属性的唯一编码，用于系统单品区分，SKU概念介绍,单击这里
组合装商家编码	suite_no	varchar	40	是	代表组合装商品所有属性的唯一编码，用于系统组合装商品的区分
货品数量	goods_count	decimal	(19,4)	是	货品数量
优惠金额	discount	decimal	(19,4)	是	优惠金额
单价	cost_price	decimal	(19,4)	是	单价，订单商品成本价
生产日期	production_date	datetime		是	生产日期，格式：yyyy-MM-dd HH:mm:ss
有效期天数	validity_days	int	11	是	有效期天数
有效期	expire_date	datetime		是	有效期，格式：yyyy-MM-dd HH:mm:ss
原价	src_price	decimal	(19,4)	是	原价订单商品实付金额
税后单价	tax_price	decimal	(19,4)	是	税后单价
税后金额	tax_amount	decimal	(19,4)	是	税后金额
税率	tax	decimal	(19,4)	是	税率
总成本	total_cost	decimal	(19,4)	是	总成本
备注	remark	varchar	255	是	备注
纠错数量	adjust_num	decimal	(19,4)	是	纠错数量
纠错金额	adjust_price	decimal	(19,4)	是	纠错金额
调整后数量	right_num	decimal	(19,4)	是	调整后数量
调整后单价	right_price	decimal	(19,4)	是	调整后单价
入库数量	num	decimal	(19,4)	是	入库数量
辅助数量	num2	decimal	(19,4)	是	辅助数量
调整后总金额	right_cost	decimal	(19,4)	是	调整后总金额
品牌编号	brand_no	varchar	32	是	品牌编号
品牌名称	brand_name	varchar	64	是	品牌名称
货品名称	goods_name	varchar	255	是	货品名称
单品自定义属性1	prop1	varchar	255	是	单品自定义属性1
单品自定义属性2	prop2	varchar	255	是	单品自定义属性2
单品自定义属性3	prop3	varchar	255	是	单品自定义属性3
单品自定义属性4	prop4	varchar	255	是	单品自定义属性4
单品自定义属性5	prop5	varchar	255	是	单品自定义属性5
单品自定义属性6	prop6	varchar	255	是	单品自定义属性6
货品档案自定义属性1	good_prop1	varchar	255	是	货品档案自定义属性1
货品档案自定义属性2	good_prop2	varchar	255	是	货品档案自定义属性2
货品档案自定义属性3	good_prop3	varchar	255	是	货品档案自定义属性3
货品档案自定义属性4	good_prop4	varchar	255	是	货品档案自定义属性4
货品档案自定义属性5	good_prop5	varchar	255	是	货品档案自定义属性5
货品档案自定义属性6	good_prop6	varchar	255	是	货品档案自定义属性6
货品编号	goods_no	varchar	40	是	代表货品(spu)所有属性的唯一编号，用于系统货品区分，，SPU概念介绍,单击这里
规格名称	spec_name	varchar	255	是	规格名称
规格编号	spec_code	varchar	40	是	规格编号
基本单位	goods_unit	varchar	20	是	基本单位
入库批次	batch_no	varchar	20	是	入库批次
批次备注	batch_remark	varchar	255	是	批次备注
货位编号	position_no	varchar	40	是	货位编号
原订单原始单号	tid	varchar	40	是	原订单原始单号
原订单原始子单号	oid	varchar	40	是	原订单原始子单号
订单类型	src_order_type	tinyint	4	是	仅返回 3退货入库类型单据
原始入库单明细	org_stockin_detail_id	int	11	是	默认为'0'，原始入库单明细
erp商品主键	spec_id	int	11	是	erp内商品主键
批次	batch_id	int	11	是	默认为'0'，批次
货位id	position_id	int	11	是	默认为'0'，货位ID，入库时默认ID
辅助单位	unit_id	smallint	6	是	默认为'0'，辅助单位
基本单位	base_unit_id	smallint	6	是	默认为'0'，基本单位
单位比率	unit_ratio	decimal	(19,4)	是	默认为'1.0000'，单位换算关系
期望数量	expect_num	decimal	(19,4)	是	默认为'0.0000'，预期入库数量（基本单位数量，显示可自动转换成辅助单位）
辅助价格	cost_price2	decimal	(19,4)	是	默认为'0.0000'，辅助成本价
邮资分摊成本	share_post_cost	decimal	(19,4)	是	默认为'0.0000'，邮资分摊成本
邮资分摊总成本	share_post_total	decimal	(19,4)	是	默认为'0.0000'，邮资分摊总成本
最后修改时间	modified	datetime		是	最后修改时间
创建时间	created	datetime		是	创建时间
标价	price	decimal	(19,4)	是	订单商品平台优惠前金额
主条码	barcode	varchar	50	是	主条码

5.请求示例

PHP	<?php require_once '../WdtClient.php'; $c = new WdtClient(); $c->sid = ''; $c->appkey = ''; $c->appsecret = ''; $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/stockin_order_query_refund.php'; $c->putApiParam('start_time', '2017-09-05 00:00:00'); $c->putApiParam('end_time', '2017-09-05 23:59:59'); $json = $c->wdtOpenApi(); var_dump($json); ?>
JAVA	package com.wangdian.api.refund; import java.io.IOException; import java.util.HashMap; import java.util.Map; import com.wangdian.api.WdtClient; public class StockinRefundQuery { public static void main(String[] args) { // TODO Auto-generated method stub WdtClient client = new WdtClient("传入sid", "传入appkey", "传入appsecret", "传入url"); //测试环境sid、appkey、密钥请到旺店通开放平台-自助对接-申请测试环境内查看，测试环境url=https://sandbox.wangdian.cn/openapi2/ //调用正式环境时请将sid、appkey、appsecret切换为实际参数，参数在旺店通开放平台-自助对接-应用管理内应用状态为已上线的应用中查看，调用正式环境注意切换正式环境url=https://api.wangdian.cn/openapi2/ Map<String, String> params = new HashMap<String, String>(); //params.put("shop_no", "ghs2test"); params.put("start_time", "2018-12-04 00:00:00"); params.put("end_time", "2018-12-11 00:00:00"); try { String response = client.execute("stockin_order_query_refund.php", params); System.out.println(response); } catch (IOException e) { // TODO Auto-generated catch block e.printStackTrace(); } } }
C#	using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using WdtSdk; namespace StockinOrderQueryRefund { class StockinOrderQueryRefund { static void Main(string[] args) { WdtClient client = new WdtClient(); client.sid = ""; client.appkey = ""; client.appsecret = ""; client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/stockin_order_query_refund.php"; client.putParams("start_time", "2019-01-01 00:00:00"); client.putParams("end_time", "2019-01-17 10:45:00"); string result = client.wdtOpenapi(); Console.WriteLine(result); Console.ReadKey(); } } }
python	import WdtClient t = WdtClient.WdtClient('appkey', 'appsecret', 'sid', 'http://sandbox.wangdian.cn/openapi2/') params = {} params.update({"start_time": '2021-01-01 00:00:00'}) params.update({"end_time": '2021-01-01 00:59:59'}) params.update({"page_size": '40'}) params.update({"page_no": '0'}) response = t.execute("stockin_order_query_refund.php", params) print(response)

6.响应示例

6.1 正常响应示例

JSON

{
    "code": 0,
    "message": "",
    "total_count": 1,
    "stockin_list": [{
        "status": "80",
        "stockin_id": "9516",
        "order_no": "RK1905180003",
        "warehouse_no": "xyp2test",
        "warehouse_name": "小鹏测试仓库",
        "stockin_time": "2019-05-18 01:16:15",
        "created_time": "2019-05-18 01:16:14",
        "order_type": "3",
        "goods_amount": "0.0000",
        "total_price": "0.0000",
        "adjust_price": "0.0000",
        "right_price": "0.0000",
        "discount": "0.0000",
        "tax_amount": "0.0000",
        "post_fee": "0.0000",
        "other_fee": "0.0000",
        "remark": "[接口创建库单]",
        "logistics_type": "0",
        "check_time": "2019-05-18 01:16:15",
        "src_order_no": "TK1905180001",
        "goods_count": "1.0000",
        "logistics_name": "无",
        "logistics_code": "",
        "logistics_no": "",
        "actual_refund_amount": "2399.0000",
        "refund_no": "TK1905180001",
        "process_status": "90",
        "customer_no": "KH201811230003",
        "customer_name": "小明",
        "nick_name": "MOB13233456110",
        "shop_name": "lx2test",
        "shop_no": "lx2test",
        "shop_remark": "123",
        "flag_name": "",
        "trade_no": "JY201811230001",
        "trade_type": "网店销售",
        "stockin_reason": "",
        "platform_id": "127",
        "order_type_name": "退货入库",
        "details_list": [{
            "stockin_id": "9516",
            "goods_count": "1.0000",
            "discount": "0.0000",
            "cost_price": "0.0000",
            "production_date": "0000-00-00 00:00:00",
            "validity_days": "0",
            "expire_date": "0000-00-00 00:00:00",
            "src_price": "0.0000",
            "tax_price": "0.0000",
            "tax_amount": "0.0000",
            "tax": "0.0000",
            "total_cost": "0.0000",
            "remark": "",
            "adjust_num": "0.0000",
            "adjust_price": "0.0000",
            "right_num": "1.0000",
            "right_price": "0.0000",
            "right_cost": "0.0000",
            "rec_id": "12793",
            "src_order_detail_id": "4030",
            "goods_name": "旺店通手持终端",
            "goods_no": "WDTPDA",
            "spec_no": "WDTPDA-BLACK006",
            "prop2": "",
            "spec_name": "旺店通手持终端黑色006型",
            "spec_code": "BLACK006",
            "brand_no": "BD201811230002",
            "brand_name": "旺店通",
            "goods_unit": "",
            "batch_no": ""
        }]
    }]
}

6.2 异常响应示例

JSON	{ "code": 20, "message": "店铺不存在或已经停用" }