This API is used to get a list of stores connected to the specified Wi-Fi, which includes store information on the Official Accounts Platform and the Wi-Fi information after a device is added. For more information on how to create a store, see Weixin Store APIs.
Note: The shop_id in all APIs used for Wi-Fi via Weixin must be obtained first using this API.
API Request Format
Protocol: HTTPS
HTTP request method: POST
Request URL: https://api.weixin.qq.com/bizwifi/shop/list?access_token=ACCESS_TOKENPOST
Data format: JSON
Request Parameters
| Parameter | Required | Description |
|---|---|---|
| access_token | Yes | The credential for calling the API |
| POST data | Yes | JSON data |
POST Data
Example:
{
"pageindex": 1,
"pagesize":2
}
Fields:
| Field | Required | Description |
|---|---|---|
| pageindex | No | Page subscript, which begins from 1 by default. |
| pagesize | No | Number of stores displayed per page. It defaults to 10. Maximum is 20. |
Response
The JSON data returned for a successful request:
{
"errcode": 0,
"data": {
"totalcount": 16,
"pageindex": 1,
"pagecount": 8,
"records": [
{
"shop_id": 429620,
"shop_name": "Nanshan Store",
"ssid": "WX123",
"ssid_list": [
"WX123",
"WX456"
],
"protocol_type": 4,
"sid": "",
"poi_id":"285633617"
},
{
"shop_id": 7921527,
"shop_name": "Baoan Store",
"ssid": "",
"ssid_list": [],
"protocol_type": 0,
"sid": "",
"poi_id":"285623614"
}
]
}
}
Fields:
| Field | Description |
|---|---|
| totalcount | Total number of stores |
| pageindex | Page subscript |
| pagecount | Total number of pages |
| records | Array of store lists on the current page |
| shop_id | Store ID (applicable to Wi-Fi via Weixin) |
| shop_name | Store name |
| ssid | The SSID of the wireless network device. This field is left empty if no device is added. If there are more than one SSID, the first one is displayed. |
| ssid_list | The list of SSIDs of wireless network devices, which is returned in an array format. |
| protocol_type | The type of device in the store. 0: No device added; 1: Specialized device; 4: Password-based device; 5: Self-service portal-based device; 31: Modified portal-based device. |
| sid | Merchant ID, corresponding to the poi_id of the store. You are recommended to link it when adding a store. For details, see "Weixin Store APIs". |
| poi_id | Store ID (applicable to Weixin Cards & Offers and Weixin Store). See the Weixin Store documentation for details. A store ID corresponds to a shop_id. |