API文档

setting.Shop.queryShop（店铺查询）

¥基础 ¥增值 ¥定制

1.接口说明

1.1 接口描述：获取ERP的店铺档案资料

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

1.3 增量获取：不支持

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

1.5注意事项：【权限校验】：店铺权限

2.调用场景

2.1 举例说明：

3.请求参数说明

3.1 请求地址

环境	HTTP地址
测试环境	http://47.92.239.46/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	否	分页编号，分页查询必传
是否计算查询结果的总页数	calc_total	int	否	是否计算查询结果的总页数，分页查询必传

3.3 业务请求参数

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

名称

字段

类型

长度

必须

描述

查询参数

params

Map<String, Object>

是

查询参数

分页

pager

Pager

是

分页

params

名称	字段	类型	长度	必须	描述
店铺编号	shop_no	String		否	店铺编号
平台id	platform_id	int		否	平台id,查看附录获取平台id

pager

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

4.响应参数

名称	字段	类型	必须	描述
状态码	status	int	是	状态码:0表示成功,其他表示失败
错误信息	message	String	是	无错误信息不返回
返回信息	data	List<Map<String, Object>>	是	返回信息

data

响应参数说明示例值或者格式、具体含义、使用方法及注意事项（如隐私数据淘系平台不返回，其他平台正常返回）

名称	字段	类型	长度	必须	描述
总条数	total_count	int		是	结果总数
查询结果	details	List<Map<String, Object>>		是	查询结果

datails

名称	字段	类型	长度	必须	描述
店铺名称	shop_name	String	128	是	店铺名称
店铺编号	shop_no	String	20	是	店铺编号
平台id	platform_id	int	4	是	平台id
子平台id	sub_platform_id	int	4	是	子平台id
联系人	contact	String	32	是	联系人
省	province	String	40	是	省
市	city	String	60	是	市
区	district	String	40	是	区
地址	address	String	255	是	地址
电话号	telno	String	40	是	电话号
手机号	mobile	String	40	是	手机号
邮编	zip	String	16	是	邮编
邮箱	email	String	64	是	邮箱
备注	remark	String	255	是	备注
自定义属性1	prop1	String	255	是	自定义属性1
自定义属性2	prop2	String	255	是	自定义属性2
网站	website	String	1024	是	网站

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); $response = $client->pageCall("setting.Shop.queryShop ", $pager, $parMap); ?>
JAVA
C#

6.响应示例

6.1 正常响应示例

JSON

{
"status": 0,
"data": {
"total_count": 259,
"details": [{
"zip": "",
"website": "",
"address": "北京 北京市 海淀区",
"city": "北京市",
"mobile": "12312341234",
"sub_platform_id": 0,
"remark": "",
"shop_name": "DX测试",
"telno": "78900987",
"province": "北京",
"contact": "duanxin",
"district": "海淀区",
"platform_id": 0,
"account_nick": "",
"email": "",
"shop_no": "1031"
}]
}
}

6.2 异常响应示例

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