API 列表

xiaodian.store.queryList

  • 免费
  • 无需授权

API功能描述(支持get和post)

批量获取门店列表

公共参数

名称 类型 必选 描述
app_key Long 是 接入时申请的app_key
method String 是 接口名称
access_token String 是 Oauth2.0授权获得的access_token
sign String 是 对 API 调用参数（除sign外）进行 md5 加密获得。参数的顺序为字母表的顺序
timestamp Long 是 时间戳，使用Unix时间戳格式
format String 是 响应格式。默认为json格式，固定
sign_method String 否 参数的加密方法选择，当前只支持Md5
version String 否 API协议版本，固定值为：1.0

输入参数

名称 类型 必选 描述 示例值
req Object 是 入参
pageNum Number 是 页码
pageSize Number 是 每页显示条数（最多30条）

返回参数

名称 类型 描述 默认值
result Object 结果
data Object 数据
total Number 总条数 20
pageNum Number 当前页码 1
pageSize Number 当前条数 10
list Object[] 集合
list_object Object
name String 门店名称 蛋糕测试的门店
address String 详细地址 蘑菇街
country String 国 中国
province String 省 浙江省
city String 市 杭州市
area String 区 西湖区
phone String 联系方式 12345678777
lat Number lat纬度 4
lon Number lon精度 3
outStoreCode String 三方门店编码 123
businessHours Object[] 营业时间
businessHours_object Object
startTime String 开始时间 07:00
endTime String 结束时间 23:00
week String[] 星期集合 Monday,Tuesday,Wednesday,Thursday,Friday
desc String 特殊描述 描述例如：法定节假日除外
status Number 网点状态：0开启  1关闭 0
success Boolean 是否成功 true
status Object 状态
msg String 信息 成功
code String 状态码 0000000

请求参数示例

1).
{
	"userId": 123,
	"req": {
		"pageNum": 1,
                "pageSize": 10
	}
}

返回示例

1).
{
	"result": {
		"data": {
			"total": 20,
			"pageNum": 1,
			"pageSize": 10,
			"list": [{
				"name": "蛋糕测试的门店",
				"address": "蘑菇街",
				"country": "中国",
				"province": "浙江省",
				"city": "杭州市",
				"area": "西湖区",
				"phone": "12345678777",
				"lat": 4,
				"lon": 3,
				"outStoreCode": "123",
				"businessHours": [{
					"startTime": "07:00",
					"endTime": "23:00",
					"week": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"],
					"desc": "描述例如：法定节假日除外"
				}, {
					"startTime": "07:00",
					"endTime": "23:00",
					"week": ["Saturday", "Sunday"],
					"desc": "描述例如：法定节假日除外"
				}]
			}]
		}
	},
	"success": true,
	"status": {
		"msg": "成功",
		"code": "0000000"
	}
}

异常示例

1).
{
    "result":{
        "data":{}
    },
    "success":false,
    "status":{
        "msg":"分页条数超过30条",
        "code":"1900002"
    }
}

API测试工具