分页查询门店详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /ListShop HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
Country | String | FormData | 否 | CN | 国家字段,CN:中国,SG:新加坡 |
PageNumber | Integer | FormData | 是 | 1 | 当前页码 |
PageSize | Integer | FormData | 是 | 50 | 每页返回最大记录数,最大分页50 |
ShopId | String | FormData | 否 | ShopId | 门店ID-可选 |
ShopGroupIds | Array of String | FormData | 否 | ShopGroupId | 门店组ID |
ShopName | String | FormData | 否 | ShopName | 门店名称 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Success | Boolean | true | 成功标志 |
Message | String | success | 说明 |
Code | String | success | 状态码 |
HttpStatusCode | Integer | 200 | http状态码 |
RequestId | String | RequestId | 请求ID |
TotalCount | Long | 10 | 查询总记录数 |
PageNumber | Integer | 1 | 当前页码 |
PageSize | Integer | 50 | 页码大小 |
Data | Array of Data | 门店列表 |
|
ShopId | String | ShopId | 自定义门店编号(ID)-必填 |
ShopName | String | xxx门店 | 门店名称-必填 |
Location | String | xxx地址 | 门店地址-选填 |
Longitude | String | 11.00 | 地理经度-选填 |
Latitude | String | 130.00 | 地理纬度-选填 |
RegionAddress | String | 杭州市滨江区 | 区域地址-省市区(查询结果) |
RegionCode | String | 330108 | 区域编码(查询结果) |
Remark | String | 备注 | 备注(可空)-选填 |
DeviceNum | Integer | 0 | 设备总数(查询结果) |
DeviceMacList | Array of String | mac | 设备Mac |
ShopGroupIds | Array of String | ShopGroupId | 门店组ID |
GmtCreateTime | Long | 1640741648999 | 添加时间(查询结果) |
WeekdaysStartTime | String | 08:00:00 | 工作日开始营业时间-选填,格式:HH:mm:ss |
WeekdaysEndTime | String | 17:00:00 | 工作日结束营业时间-选填,格式:HH:mm:ss |
WeekendStartTime | String | 08:00:00 | 周末开始营业时间-选填,格式:HH:mm:ss |
WeekendEndTime | String | 18:00:00 | 周末结束营业时间-选填,格式:HH:mm:ss |
BusinessStatus | Integer | 1 | 门店营业状态:1-营业,2-待营业 |
示例
请求示例
POST /ListShop HTTP/1.1
Host:cd.aliyuncs.com
Content-Type:application/json
Country=CN&PageNumber=1&PageSize=50&ShopId=ShopId&ShopGroupIds=["ShopGroupId"]&ShopName=ShopName
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListShopResponse>
<Success>true</Success>
<Message>success</Message>
<Code>success</Code>
<HttpStatusCode>200</HttpStatusCode>
<RequestId>RequestId</RequestId>
<TotalCount>10</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>50</PageSize>
<Data>
<ShopId>ShopId</ShopId>
<ShopName>xxx门店</ShopName>
<Location>xxx地址</Location>
<Longitude>11.00</Longitude>
<Latitude>130.00</Latitude>
<RegionAddress>杭州市滨江区</RegionAddress>
<RegionCode>330108</RegionCode>
<Remark>备注</Remark>
<DeviceNum>0</DeviceNum>
<DeviceMacList>mac</DeviceMacList>
<ShopGroupIds>ShopGroupId</ShopGroupIds>
<GmtCreateTime>1640741648999</GmtCreateTime>
<WeekdaysStartTime>08:00:00</WeekdaysStartTime>
<WeekdaysEndTime>17:00:00</WeekdaysEndTime>
<WeekendStartTime>08:00:00</WeekendStartTime>
<WeekendEndTime>18:00:00</WeekendEndTime>
<BusinessStatus>1</BusinessStatus>
</Data>
</ListShopResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Success" : true,
"Message" : "success",
"Code" : "success",
"HttpStatusCode" : 200,
"RequestId" : "RequestId",
"TotalCount" : 10,
"PageNumber" : 1,
"PageSize" : 50,
"Data" : {
"ShopId" : "ShopId",
"ShopName" : "xxx门店",
"Location" : "xxx地址",
"Longitude" : 11,
"Latitude" : 130,
"RegionAddress" : "杭州市滨江区",
"RegionCode" : 330108,
"Remark" : "备注",
"DeviceNum" : 0,
"DeviceMacList" : "mac",
"ShopGroupIds" : "ShopGroupId",
"GmtCreateTime" : 1640741648999,
"WeekdaysStartTime" : "08:00:00",
"WeekdaysEndTime" : "17:00:00",
"WeekendStartTime" : "08:00:00",
"WeekendEndTime" : "18:00:00",
"BusinessStatus" : 1
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Params.Illegal | The request parameters are invalid. | 请求入参非法 |
401 | Unauthorized | You are not authorized to perform this operation. | 未授权的请求 |
403 | Forbidden | This request is prohibited. | 请求被禁止 |
503 | Service.Unavailable | The service is unavailable. Please try again later. | 服务当前暂不可用,请稍后重试 |
访问错误中心查看更多错误码。