Fuzzy Query Store List

Last Updated on : 2023-06-15 05:50:49

Query the details of the store list with fuzzy conditions.

API address

GET: /v1.0/iot-03/retail/shops

Request parameter

Parameter name	Type	IN	Required	Description
req	ShopQueryReq	query	false

Description of req

Parameter name	Type	Required	Description
name	String	false	The name of a specified store.
page_size	Integer	true	The number of entries returned on each page.
last_row_key	String	false	The row key of the last entry on the previous page.

Return parameter

Parameter name	Type	Description
result	CursorPage

Description of result

Parameter name	Type	Description
has_more	Boolean	Whether there is a next page of results.
list	List
last_row_key	String	The row key of the last entry on each page.

Description of list

Parameter name	Type	Description
shop_id	String	The ID of a specified store.
parent_shop_id	String	The ID of a specified parent store.
shop_name	String	The name of a specified store.
province_code	Integer	The code of a specified province.
province_name	String	The name of a specified province.
city_code	Integer	The code of a specified city.
city_name	String	The name of a specified city.
district_code	Integer	The code of a specified district.
district_name	String	The name of a specified district.
address	String	The detailed address.
business_hours	List	The list of business hours.
shop_layout_plan	String	The layout plan of a specified store.

Description of business_hours

Parameter name	Type	Description
opening_time	Long	The opening time.
closing_time	Long	The closing time.

Request example

GET: /v1.0/iot-03/retail/shops?page_size=2

Return example

{
    "result": {
        "last_row_key": "12345678***",
        "list": [
            {
                "address": "xxx Center",
                "shop_name": "xxx Center Store",
                "shop_id": "1405092931026604***"
            }
        ],
        "has_more": false
    },
    "t": 1623837257601,
    "success": true
}

Error code

For more information, see error code.

Prev DocModify Store

Next DocQuery Single Store