API文档

wms.stockout.PurchaseReturn.queryWithDetail（采购退货出库单查询）

¥标准

1.接口说明

1.1 接口描述：获取ERP采购退货出库单信息

1.2 适用版本：客户端 V1.2.5.6及以上版本

1.3 增量获取：支持增量获取

1.4 时间跨度：start_time和end_time最大跨度为30天

1.5 注意事项：【权限校验】：仓库权限

2.调用场景

2.1举例说明：财务系统、SAP、线下ERP、数据分析等系统的对接

3.请求参数说明

3.1 请求地址

环境	HTTP地址
测试环境	http://47.92.239.46/openapi
正式环境	http://wdt.wangdian.cn/openapi

3.2 公共请求参数

名称	字段	类型	必须	描述
卖家账号	sid	String	Y	卖家账号, 由旺店通分配
接口账号	key	String	Y	由旺店通分配appkey, 在发送的数据中对应 key 字段
盐	salt	String	Y	由旺店通分配appsecret，是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt.
接口名称	method	String	Y	调用的接口名称
版本号	v	String	Y	1.0
秒级时间戳	timestamp	int	Y	秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名	sign	String	Y	签名
分页大小	page_size	int	N	分页大小，分页查询必传
分页编号	page_no	int	N	分页编号，分页查询必传，标准接口page_no从0开始
是否计算查询结果的总条数	calc_total	int	N	是否计算查询结果的总条数, 需要计算则1, 否则填0

3.3 业务请求参数

名称	字段	类型	长度	必须	描述
查询参数	params	Map<String, Object>		Y	查询参数
分页	pager	Pager		Y	分页

params

名称	字段	类型	长度	必须	描述
开始时间	out_start_time	String	40	N	起始时间（出库时间），若无出库单号或采购退货单号，则为必填。
结束时间	out_end_time	String	40	N	结束时间（出库时间），上同开始时间
开始时间	create_start_time	String	40	N	起始时间（出库单创建时间），若无出库单号或采购退货单号，则为必填。
结束时间	create_end_time	String	40	N	结束时间（出库单创建时间），上同开始时间
仓库编号	warehouse_no	String	40	N	限普通仓库
出库单号	stockout_no	String	40	N	出库单号
采购退货单号	src_order_no	String	40	N	采购退货单号
是否按货位分组	position	Int		N	等于0为否，不等于0为是，不填为否
出库单状态	status	String	40	N	由逗号分隔的整数数组出库单状态: 5已取消 48 未确认 50 待审核 77 拣货中,PDA拣货后 110已完成

pager

名称	字段	类型	长度	必须	描述
分页大小	page_size	Int	4	N	分页大小
页号	page_no	Int	4	N	从0开始

4.响应参数

名称	字段	类型	必须	描述
状态码	status	Int	Y	返回0为正常
错误信息	message	String	Y	无错误信息不返回
出库单信息	data	Map<String, Object>	N	出库信息

data

名称	字段	类型	长度	必须	描述
总数	total_count	Int	11	N	查询条件总单据数
单据数据	order	List<Map<String, Object>>		Y	出库单相关数据

order

名称	字段	类型	长度	必须	描述
出库单id	stockout_id	Int	11	Y	出库单id
出库单号	order_no	String	40	Y	出库单号
采购退货单号	src_order_no	String	40	Y	采购退货单号
仓库编号	warehouse_no	String	40	Y	仓库编号
发货时间	consign_time	String	40	Y	发货时间
出库单状态	status	Byte		Y	出库单状态 5: 已取消 48: 未确认 50: 待审核 65: 待处理 77: 拣货中 110: 已完成
货品数量	goods_count	Decimal(19,4)		Y	货品数量
物流编号	logistics_no	String	40	Y	物流编号
邮费	post_fee	Decimal(19,4)		Y	邮费
收件人姓名	receiver_name	String	40	Y	收货人姓名
省份id	receiver_province	String	40	Y	省份，返回值可参考城市代码表
城市id	receiver_city	String	40	Y	城市，返回值可参考城市代码表
地区id	receiver_district	String	40	Y	地区，返回值可参考城市代码表
收件人地址	receiver_address	String	256	Y	收件人地址
收件人电话	receiver_telno	String	40	Y	收件人电话
备注	remark	String	255	Y	备注
重量	weight	Decimal(19,4)		Y	重量
供应商编号	provider_no	String	20	Y	供应商编号
供应商名称	provider_name	String	64	Y	供应商名称
最后一次引用的采购单号	last_load_purchase_no	String	20	Y	最后一次引用的采购单号
总成本价	goods_total_cost	Decimal(19,4)		Y	总成本价
总货款	goods_total_amount	Decimal(19,4)		Y	总货款（出库金额）
出库单明细	details_list	List<Map<String, Object>>		Y	出库单明细

details_list

名称	字段	字段类型	长度	必须	描述
出库单明细id	rec_id	Int	11	Y	出库单明细ID（主键）
出库单id	stockout_id	Int	11	Y	出库单ID
商家编码	spec_no	String	40	Y	商家编码
货品数量	goods_count	Decimal(19,4)		Y	货品数量
货品总额	total_amount	Decimal(19,4)		Y	货品总额（税前折后单价*数量）
税前折后单价	sell_price	Decimal(19,4)		Y	税前折后单价
备注	remark	String	255	Y	备注
品牌编号	brand_no	String	32	Y	品牌编号
品牌名称	brand_name	String	64	Y	品牌名称
货品名称	goods_name	String	255	Y	货品名称
货品编号	goods_no	String	40	Y	货品编号
规格名	spec_name	String	100	Y	规格名
规格码	spec_code	String	40	Y	规格码
成本价	cost_price	Decimal(19,4)		Y	成本价
重量	weight	Decimal(19,4)		Y	重量
货品类型	goods_type	Int	11	Y	货品类型
单位	goods_unit	String	20	Y	单位
批次号	batch_no	String	40	Y	批次号
有效期	expire_date	String	40	Y	如果没有则返回空字符串
是否残次品	defect	boolean	1	Y	true：残次品 false：正品
货位编号	position_no	String	20	Y	货位编号
默认货位货品数	position_goods_count	Decimal(19,4)		Y	默认货位货品数，传入参数（position）不为0时返回

5.请求示例

json格式请求报文	[{ "out_start_time": "2019-12-11 00:00:00", "out_end_time": "2019-12-31 00:00:00" }]
php 请求示例	<?php header("Content-Type: text/html; charset=UTF-8"); date_default_timezone_set("Asia/Shanghai"); require_once('wdtsdk.php'); $client = new WdtErpClient("url", "wdtapi3", "appkey", "secret"); $pager = new Pager(1, 0, true); $params=new stdClass(); $params->out_start_time = '2019-12-11 00:00:00'; $params->out_end_time = '2019-12-31 00:00:00'; $pager = new Pager(2, 0, true); $data = $client->pageCall("wms.stockout.PurchaseReturn.queryWithDetail", $pager, $params); ?>
JAVA
C#

6.响应示例

6.1正常响应示例

json

{
       "status": 0,
       "data": {
              "total_count": 4,
              "order": [{
                     "order_no": "CK2019122517",
                     "details_list": [{
                            "rec_id": 22316,
                            "stockout_id": 8193,
                            "spec_no": "daba1",
                            "goods_count": 2.0000,
                            "total_amount": 2.0000,
                            "sell_price": 1.0000,
                            "remark": "",
                            "brand_no": "BRAND",
                            "brand_name": "无",
                            "goods_name": "美国原装进口rumbatime手表女正品腕表女石英表防水宝石时尚123",
                            "goods_no": "daba1",
                            "spec_name": "默认规格123",
                            "spec_code": "红宝石123",
                            "cost_price": 0.4400,
                            "weight": 10.0000,
                            "goods_type": 1
                     }],
                     "consign_time": 1577240320000,
                     "post_fee": 0.0000,
                     "receiver_city": 0,
                     "goods_type_count": 1,
                     "remark": "",
                     "goods_count": 2.0000,
                     "stockout_id": 8193,
                     "src_order_no": "CR201912250001",
                     "warehouse_no": "zmw01",
                     "receiver_telno": "",
                     "receiver_zip": "",
                     "receiver_name": "",
                     "receiver_country": 0,
                     "provider_name": "小饼干供应商",
                     "provider_no": "1108",
                     "seq_no": 1,
                     "receiver_area": "",
                     "create_time": 1577240319000,
                     "receiver_province": 0,
                     "logistics_no": "",
                     "receiver_district": 0,
                     "weight": 0.0000,
                     "goods_total_amount": 2.0000,
                     "receiver_mobile": "",
                     "operator_name": "张美薇",
                     "goods_total_cost": 0.8800,
                     "last_load_purchase_no": "",
                     "receiver_address": "",
                     "status": 110
              }, {
                     "order_no": "CK2019122511",
                     "details_list": [{
                            "rec_id": 22312,
                            "stockout_id": 8189,
                            "spec_no": "daba3",
                            "goods_count": 20.0000,
                            "total_amount": 0.0000,
                            "sell_price": 0.0000,
                            "remark": "",
                            "brand_no": "BD201807130002",
                            "brand_name": "牛牛2",
                            "goods_name": "阳台桌椅真藤椅茶几三件套五件套组合庭院户外花园客厅阳台藤椅子",
                            "goods_no": "daba3",
                            "spec_name": "默认规格",
                            "spec_code": "藤椅*1",
                            "cost_price": 5.8385,
                            "weight": 1.2500,
                            "goods_type": 1
                     }],
                     "consign_time": 1577238894000,
                     "post_fee": 0.0000,
                     "receiver_city": 0,
                     "goods_type_count": 1,
                     "remark": "",
                     "goods_count": 20.0000,
                     "stockout_id": 8189,
                     "src_order_no": "CR201912240001",
                     "warehouse_no": "zmw01",
                     "receiver_telno": "",
                     "receiver_zip": "",
                     "receiver_name": "",
                     "receiver_country": 0,
                     "provider_name": "小饼干供应商",
                     "provider_no": "1108",
                     "seq_no": 2,
                     "receiver_area": "",
                     "create_time": 1577238890000,
                     "receiver_province": 0,
                     "logistics_no": "",
                     "receiver_district": 0,
                     "weight": 0.0000,
                     "goods_total_amount": 0.0000,
                     "receiver_mobile": "",
                     "operator_name": "张美薇",
                     "goods_total_cost": 116.7700,
                     "last_load_purchase_no": "",
                     "receiver_address": "",
                     "status": 110
              }]
       }
}

6.2异常响应示例

json	{ "status": 100, "message": "参数中必须包含起止时间" }