API文档

goods.Suite.search（组合装查询）

¥标准

1.接口说明

1.1 接口描述：获取ERP中组合装界面的组合装资料

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

1.3 增量获取：支持

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

1.5注意事项：

1、【权限校验】：品牌权限（旺店通客户端-采购-采购权限管理界面控制品牌权限）

2、开始时间和结束时间是组合装或组合装明细最后修改时间的范围

3、组合装商家编码和时间同时传的情况下，按照商家编码查询，时间不生效

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	否	商家编码
货品编号	goods_no	String	40	否	货品编号
品牌编号	brand_name	String	64	否	品牌编号
分类名称	class_name	String	100	否	分类名称
条码	barcode	String	50	否	条码
组合装商家编码	suite_no	String	80	否	组合装商家编码（如果不传时间，组合装商家编码必传）
组合装名称	suite_name	String	255	否	组合装名称
是否隐藏已删除的货品	hide_deleted	boolean	1	否	默认不隐藏 false:不隐藏已删除 true:隐藏已删除
开始时间	start_time	String	40	否	起始修改时间
结束时间	end_time	String	40	否	结束修改时间, 不填默认为当前时间

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

响应参数说明示例值或者格式、具体含义、使用方法及注意事项

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

名称

字段

类型

长度

必须

描述

货品数据

suite_list

List<Map<String, Object>>

是

货品数据

总数

total_count

Int

是

查询条件总数单据

suite_list

名称	字段	类型	长度	必须	描述
组合装id	suite_id	Int		是	组合装主键
商家编码	suite_no	String	80	是	组合装商家编码
组合装名称	suite_name	String	255	是	组合装名称
重量	weight	Decimal(19,4)		是	重量
会员价	member_price	Decimal(19,4)		是	会员价
备注	remark	String	255	否	备注
品牌id	brand_id	Int	11	是	品牌id
品牌名称	brand_name	String	64	是	品牌名称
零售价	retail_price	Decimal(19,4)		是	零售价
标记名称	flag_name	String	32	是	标记名称
基本单位	unit_name	String	20	是	基本单位
辅助单位	aux_unit_name	String	20	是	辅助单位
自定义属性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
自定义属性11	prop11	String	255	是	自定义属性11
自定义属性12	prop12	String	255	是	自定义属性12
自定义属性13	prop13	String	255	是	自定义属性13
自定义属性14	prop14	String	255	是	自定义属性14
自定义属性15	prop15	String	255	是	自定义属性15
自定义属性16	prop16	String	255	是	自定义属性16
自定义属性17	prop17	String	255	是	自定义属性17
自定义属性18	prop18	String	255	是	自定义属性18
自定义属性19	prop19	String	255	是	自定义属性19
自定义属性20	prop20	String	255	是	自定义属性20
批发价	wholesale_price	Decimal(19,4)		是	批发价
市场价	market_price	Decimal(19,4)		是	市场价
组合装简称	short_name	String	255	是	组合装简称
货品标签	goods_label	String	255	是	货品标签
条码	barcode	String	50	是	条码
分类名称（类别）	class_name	String	100	是	分类名称
打印内容	print_suite_mode	byte	1	是	打印内容 0：组合装明细 1：组合装及明细 2：组合装
是否已删除	deleted	Int	11	是	大于0表示已删除，删除后自增生成的id值
组合装修改时间	suite_modified	String	40	是	组合装修改时间
组合装创建时间	suite_created	String	40	是	组合装创建时间
条码个数	barcode_count	Int	11	是	条码个数
分类id	class_id	Int	11	是	分类id
拆分属性	large_type	Int	4	是	拆分属性 -1:非单发件 0:普通件 1:普通大件 2:独立大件 3:按箱规拆分
组合装明细	detail_list	List<Map<String,Object>>		是	组合装明细

detail_list

名称	字段	类型	长度	必须	描述
明细主键id	rec_id	Int		是	明细主键id
组合装id	suite_id	Int		是	组合装主键
商家编码	spec_no	String	80	是	商家编码
单品id	spec_id	Int		是	单品主键
基本单位id	unit	Int		是	基本单位id
删除id	deleted	Int		是	删除后自增生成的id值
规格名称	spec_name	String	100	是	规格名称
规格码	spec_code	String	40	是	规格码
条码	barcode	String	50	是	条码
货品编号	goods_no	String	40	是	货品编号
货品id	goods_id	Int		是	货品主键
货品名称	goods_name	String	255	是	货品名称
数量	num	Decimal(19,4)		是	数量
固定售价	fixed_price	Decimal(19,4)		是	固定售价/单价
金额占比	ratio	Decimal(19,4)		是	金额占比
固定价格	is_fixed_price	boolean	1	是	是否固定价格 true:是 false:否
组合装明细修改时间	modified	String	40	是	组合装明细修改时间
组合装明细创建时间	created	String	40	是	组合装明细创建时间

5.请求示例

json格式请求报文	[{ "start_time": "2020-01-01 00:00:00", "end_time": "2020-01-20 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"); $parMap = new stdClass(); $parMap->start_time = "2020-01-01 00:00:00"; $parMap->end_time = "2020-01-20 00:00:00"; $pager = new Pager(1, 0, true); $data = $client->pageCall("goods.Suite.search", $pager, $parMap); ?>
JAVA
C#
CURL	curl --location 'http://47.92.239.46/openapi?key=wdtapi3-test2&method=goods.Suite.search&salt=1566006427136280c53ba-14aa-48dd-a36e-1c2dbfb3a17c&sid=wdtapi3&timestamp=448969350&v=1.0&sign=9e9acb31c2d2782cdb7548fc078387d7&page_no=0&page_size=100&calc_total=1' \ --header 'Content-Type: application/json' \ --data '[{ "start_time": "2020-01-01 00:00:00", "end_time": "2020-01-20 00:00:00" }]'

6.响应示例

6.1 正常响应示例

JSON

{
	"status": 0,
	"data": {
		"total_count": 1,
		"suite_list": [{
			"suite_modified": "2023-03-10 13:42:56",
			"detail_list": [{
				"rec_id": 12773,
				"suite_id": 5757,
				"num": 1,
				"fixed_price": 0,
				"ratio": 0.5,
				"is_fixed_price": false,
				"modified": "2022-12-28 14:42:59",
				"created": "2022-12-28 14:42:59",
				"spec_no": "xiangyin01",
				"spec_name": "",
				"spec_code": "xiangyin01",
				"barcode": "xiaowanzi01",
				"unit": 2,
				"deleted": 0,
				"goods_no": "xiangyin",
				"goods_name": "相印",
				"spec_id": 361673,
				"goods_id": 167946
			}, {
				"rec_id": 12774,
				"suite_id": 5757,
				"num": 1,
				"fixed_price": 0,
				"ratio": 0.5,
				"is_fixed_price": false,
				"modified": "2022-12-28 14:42:59",
				"created": "2022-12-28 14:42:59",
				"spec_no": "xiangyin02",
				"spec_name": "",
				"spec_code": "",
				"barcode": "xiaowanzi02",
				"unit": 0,
				"deleted": 0,
				"goods_no": "xiangyin",
				"goods_name": "相印",
				"spec_id": 361674,
				"goods_id": 167946
			}],
			"suite_name": "相印",
			"member_price": 0,
			"remark": "",
			"aux_unit_name": "无",
			"retail_price": 0,
			"flag_name": "无",
			"wholesale_price": 0,
			"suite_id": 5757,
			"barcode": "xiangyin01+02",
			"class_name": "无",
			"suite_created": "2022-12-28 14:42:59",
			"barcode_count": 4,
			"weight": 0,
			"brand_name": "BM",
			"goods_label": "",
			"prop4": "",
			"brand_id": 2014,
			"prop3": "",
			"prop2": "",
			"unit_name": "无",
			"prop1": "",
			"deleted": 0,
			"suite_no": "xiangyin01+02",
			"market_price": 0,
			"short_name": "相印",
			"print_suite_mode": 0
		}]
	}
}

6.2 异常响应示例

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