API文档

goods.Goods.queryWithSpec（货品档案查询）

¥标准

1.接口说明

1.1 接口描述：获取ERP的货品档案资料

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

1.3 增量获取：支持

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

1.5注意事项：开始时间和结束时间是货品或单品最后修改时间的范围
【权限校验】：品牌权限（旺店通客户端-采购-采购权限管理界面控制品牌权限）

2.调用场景

2.1 举例说明：自研商城、SCM、SRM、财务系统、SAP等系统的对接

3.请求参数说明

3.1 请求地址

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

3.2 公共请求参数

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

3.3 业务请求参数

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

名称

字段

类型

长度

必须

描述

查询参数

params

Map<String, Object>

是

查询参数

分页

pager

Pager

是

分页

params

名称	字段	类型	长度	必须	描述
商家编码	spec_no	String	40	否	商家编码（如果不传时间，则spec_no和goods_no必须传一个）
货品编号	goods_no	String	40	否	货品编号
品牌名称	brand_name	String	64	否	品牌名称
分类名称	class_name	String	100	否	分类名称
条码	barcode	String	50	否	条码
是否隐藏已删除的货品。	hide_deleted	boolean	1	否	0:返回全部;1:隐藏已删除默认隐藏
开始时间	start_time	String	40	否	起始修改时间最大跨度为30天
结束时间	end_time	String	40	否	结束修改时间, 不填默认为当前时间最大跨度为30天

pager

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

4.响应参数

名称	字段	类型	必须	描述
状态码	status	Int	是	状态码,0表示正常
错误信息	message	String	是	无错误信息不返回
货品数据	data	Map<String, Object>	是	货品相关数据

名称

字段

类型

长度

必须

描述

状态码

status

Int

是

状态码,0表示正常

错误信息

message

String

是

无错误信息不返回

货品数据

data

Map<String, Object>

是

货品相关数据

data

名称	字段	类型	长度	必须	描述
货品数据	goods_list	List<Map<String, Object>>		是	货品数据
总数	total_count	Int	11	是	查询条件总单据数

名称

字段

类型

长度

必须

描述

货品数据

goods_list

List<Map<String, Object>>

是

货品数据

总数

total_count

Int

是

查询条件总单据数

goods_list

名称	字段	类型	长度	必须	描述
货品id	goods_id	Int		是	唯一键
货品编号	goods_no	String	40	是	货品编号
货品名称	goods_name	String	255	是	货品名称
货品简称	short_name	String	255	是	货品简称
货品别名	alias	String	255	是	货品别名
货品类别	goods_type	int	4	是	货品类别 0：其它 1：销售货品 2：原材料 3：包装物 4：周转材料 5：虚拟商品 6：固定资产 8：分装箱 9：周期送货品 10：赠品
规格数	spec_count	Int	11	是	规格数
品牌名称	brand_name	String	64	是	品牌名称
品牌id	brand_id	Int	11	是	品牌id
备注	remark	String	512	是	备注
自定义属性1	prop1	String	255	是	自定义属性1
自定义属性2	prop2	String	255	是	自定义属性2
自定义属性3	prop3	String	255	是	自定义属性3
自定义属性4	prop4	String	255	是	自定义属性4
自定义属性5	prop5	String	255	是	自定义属性5
自定义属性6	prop6	String	255	是	自定义属性6
自定义属性7	prop7	String	255	是	自定义属性7
自定义属性8	prop8	String	255	是	自定义属性8
自定义属性9	prop9	String	255	是	自定义属性9
自定义属性10	prop10	String	255	是	自定义属性10
产地	origin	String	64	是	产地
分类名称	class_name	String	64	是	分类名称
分类ID	class_id	int		是	分类ID主键
基本单位	unit_name	String	20	是	基本单位
辅助单位	aux_unit_name	String	20	是	辅助单位
标记名称	flag_name	String	32	是	标记名称
货品已删除	deleted	Int	11	是	0代表未删除大于0代表已删除
最后修改时间	goods_modified	String	40	是	最后修改时间
创建时间	goods_created	String	40	是	创建时间, 时间格式 YYYY-MM-DD HH:MM:SS
最后修改时间	modified	String	40	是	最后修改时间，格式：yyyy-MM-dd HH:mm:ss
品牌编号	brand_no	String	64	是	品牌编号
水洗标	washing_label	String	20	是	水洗标
基本单位id	unit	Int	11	是	基本单位id
辅助单位id	aux_unit	Int	11	是	辅助单位id
标记id	flag_id	Int	11	是	标记id
单品信息详情	spec_list	List<Map<String, Object>>		是	单品信息详情

spec_list

名称	字段	类型	长度	必须	描述
货品id	goods_id	Int		是	货品唯一键
单品id	spec_id	Int		是	单品唯一键
商家编码	spec_no	String	80	是	商家编码
规格码	spec_code	String	40	是	规格码
主条码	barcode	String	50	是	主条码
规格名称	spec_name	String	100	是	规格名称
最低价	lowest_price	Decimal(19,4)		是	最低价
零售价	retail_price	Decimal(19,4)		是	零售价
批发价	wholesale_price	Decimal(19,4)		是	批发价
会员价	member_price	Decimal(19,4)		是	会员价
市场价	market_price	Decimal(19,4)		是	市场价
有效期天数	validity_days	Int	11	是	有效期天数
最佳销售天数	sales_days	Int	11	是	最佳销售天数
最佳收货天数	receive_days	Int	11	是	最佳收货天数
重量(kg)	weight	Decimal(19,4)		是	重量(kg)
长(cm)	length	Decimal(19,4)		是	长(cm)
宽(cm)	width	Decimal(19,4)		是	宽(cm)
高(cm)	height	Decimal(19,4)		是	高(cm)
启用序列号	sn_type	Int	4	是	启用序列号(原is_sn_enable) 0:未启用 1:已启用
允许低于成本价	is_lower_cost	boolean	1	是	允许低于成本价 true：是 false：否
航空禁运	is_not_use_air	Int	1	是	航空禁运
仓库流程	wms_process_mask	int	4	是	默认0：无仓库流程（需要的仓库流程相加） 2：无需验货 8：需要质检 16：无需拣货 32：无需唯一码 64：无需自动打印吊牌 128：不计结构 256：电子面单不打印 512：不计绩效 1024：管理克重 2048：退货入库不校验
税率	tax_rate	Decimal(19,4）		是	税率
拆分	large_type	int	4	是	大件类别 0、普通件 1、普通大件（可与非大件一起发） 2、独立大件（不可和小件一起发） 3、按箱规拆分 -1、非单发件
货品标签	goods_label	String	255	是	货品标签，多个标签用英文逗号隔开
货品已删除	deleted	int	11	是	0代表未删除大于0代表已删除
备注	remark	String	512	是	备注
最后修改时间	spec_modified	int	40	是	最后修改时间
创建时间	spec_created	String	40	是	创建时间, 时间格式 YYYY-MM-DD HH:MM:SS
自定义属性1	prop1	String	255	是	自定义属性1
自定义属性2	prop2	String	255	是	自定义属性2
自定义属性3	prop3	String	255	是	自定义属性3
自定义属性4	prop4	String	255	是	自定义属性4
自定义属性5	prop5	String	255	是	自定义属性5
自定义属性6	prop6	String	255	是	自定义属性6
自定义价格1	custom_price1	Decimal(19,4）		是	自定义价格1
自定义价格2	custom_price2	Decimal(19,4）		是	自定义价格2
图片URL	img_url	String	1024	是	图片URL
基本单位	spec_unit_name	String	20	是	基本单位
辅助单位	spec_aux_unit_name	String	20	是	辅助单位
税务编码	tax_code	String	40	是	税务编码
打包积分	pack_score	Decimal(19,4）		是	打包积分
拣货积分	pick_score	Decimal(19,4）		是	拣货积分
验货积分	scan_score	Decimal(19,4）		是	验货积分
单品标记名称	spec_flag_name	String	32	是	单品标记名称
条码个数	barcode_count	Int		是	条码个数
销售积分	sale_score	Decimal(19,4）		是	销售积分
是否出库不验货	is_not_need_examine	Int		是	是否出库不验货 1：出库不验货 0：出库验货
基本单位id	spec_unit	Int	11	是	基本单位id
辅助单位id	spec_aux_unit	Int	11	是	辅助单位id
备注换货货品的换货识别符	exchange_name	String	500	否	备注换货货品的换货识别符（无值该字段不返回）
备注换货货品的最大限制数量	max_limit_num	Decimal(19,4）		否	备注换货货品的最大限制数量（无值该字段不返回）
条码信息	barcode_list	List<Map<String,Object>>		是	条码信息，没有时为空数组

barcode_list

名称	字段	类型	长度	必须	描述
条码	barcode	String	50	否	条码
类型	type	Int	4	否	货品类型，这里默认为1
是否主条码	is_master	Int	1	否	是否主条码 1：是 0：否·
最后修改时间	modified	String	40	否	最后修改时间，格式: yyyy-MM-dd HH:mm:ss

5.请求示例

json格式请求报文	[{ "start_time": "2020-01-01 00:00:00", "end_time": "2020-01-20 00:00:00", "hide_deleted": 1 }]
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"); $parMap = new stdClass(); $parMap->start_time = "2020-01-01 00:00:00"; $parMap->end_time = "2020-01-20 00:00:00"; $parMap->hide_deleted=1; $pager = new Pager(1, 0, true); $data = $client->pageCall("goods.Goods.queryWithSpec", $pager, $parMap); ?>
JAVA
C#

6.响应示例

6.1 正常响应示例

JSON

{
	"status": 0,
	"data": {
		"goods_list": [{
			"goods_no": "wangdiantong",
			"origin": "",
			"class_id": 7,
			"goods_modified": 1678351062000,
			"remark": "12323213aaa",
			"aux_unit_name": "哒哒哒哒哒",
			"goods_created": "2017-08-06 22:01:20",
			"flag_name": "无",
			"spec_list": [{
				"spec_id": 1,
				"goods_id": 1,
				"spec_no": "wangdiantong",
				"spec_code": "LL ",
				"barcode": "wangdiantong",
				"spec_name": "暂无",
				"lowest_price": 0,
				"retail_price": 234,
				"wholesale_price": 0,
				"member_price": 0,
				"market_price": 0,
				"spec_created": "2017-08-06 22:01:20",
				"validity_days": 0,
				"sales_days": 0,
				"receive_days": 0,
				"weight": 0.2,
				"length": 1,
				"width": 2,
				"height": 3,
				"sn_type": 0,
				"is_lower_cost": false,
				"tax_rate": 0,
				"wms_process_mask": 8,
				"deleted": 0,
				"large_type": 0,
				"remark": "dsfdk;ds123",
				"spec_modified": 1683771314000,
				"prop1": "自定义属性1",
				"prop2": "自定义属性2",
				"prop3": "自定义属性3",
				"prop4": "自定义属性4",
				"prop5": "自定义属性5",
				"prop6": "自定义属性6",
				"img_url": "cos:\/\/IMG135.jpg",
				"is_not_use_air": 0,
				"custom_price1": 0,
				"custom_price2": 0,
				"spec_unit_name": "口",
				"spec_aux_unit_name": "锅",
				"goods_label": "",
				"tax_code": "",
				"barcode_list": [{
					"barcode": "wangdiantong",
					"type": 1,
					"is_master": 1,
					"modified": "2022-08-31 11:18:59"
				}]
			}],
			"alias": "",
			"modified": "2023-03-09 16:37:42",
			"spec_count": 1,
			"class_name": "短袖1",
			"goods_name": "wangdiantong",
			"goods_id": 1,
			"brand_name": "发发拉",
			"prop6": "",
			"prop5": "",
			"prop4": "",
			"brand_id": 2179,
			"prop3": "",
			"prop2": "",
			"unit_name": "箱",
			"prop1": "",
			"pinyin": "",
			"deleted": 0,
			"short_name": "",
			"goods_type": 1
		}],
		"total_count": 1
	}
}

6.2 异常响应示例

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