当前位置: API文档
setting.Shop.queryShop(店铺查询)
1.1 接口描述:获取ERP的店铺档案资料 |
1.2 适用版本:客户端 V1.2.9.7及以上版本 |
1.3 增量获取:不支持 |
1.4 时间跨度:start_time和end_time最大跨度为30天。 |
1.5注意事项:【权限校验】:店铺权限 |
2.1 举例说明: |
环境 | HTTP地址 |
---|---|
测试环境 | http://47.92.239.46/openapi |
正式环境 | http://wdt.wangdian.cn/openapi |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | 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 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
查询参数 | params | Map<String, Object> | 是 | 查询参数 | |
分页 | pager | Pager | 是 | 分页 |
params
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
店铺编号 | shop_no | String | 20 | 否 | 店铺编号 |
平台id | platform_id | Int | 6 | 否 | 平台id,查看附录获取平台id |
pager
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
分页大小 | page_size | Int | 4 | 否 | 分页大小 |
页号 | page_no | Int | 4 | 否 | 从0开始 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
状态码 | status | Int | 是 | 状态码:0表示成功,其他表示失败 | |
错误信息 | message | String | 是 | 无错误信息不返回 | |
返回信息 | data | List<Map<String, Object>> | 是 | 返回信息 |
data
响应参数说明示例值或者格式、具体含义、使用方法及注意事项(如隐私数据淘系平台不返回,其他平台正常返回)
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
总条数 | total_count | Int | 是 | 结果总数 | |
查询结果 | details | List<Map<String, Object>> | 是 | 查询结果 |
datails
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
店铺id | shop_id | Int | 11 | 是 | 店铺唯一键 |
店铺名称 | 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 | 是 | 邮编 |
邮箱 | String | 64 | 是 | 邮箱 | |
备注 | remark | String | 255 | 是 | 备注 |
网站 | website | String | 1024 | 是 | 网站 |
是否停用 | is_disabled | bool | 1 | 是 | 1:停用 0:未停用 |
JSON | { "status": 100, "message": "参数中必须包含起止时间" } |