Description#
This function loads a list of stores based on a query.
Request Body Parameters#
This function accepts the standard query parameters for filtering, sorting, and pagination.
Response Parameters#
| Parameter | Type | Description |
|---|---|---|
success |
Boolean | Boolean value for if the request was successful. |
totalCount |
Number | Total number of stores matching the query. |
startOffset |
Number | The offset of the first result returned. |
data |
Array | Array of store objects. |
Example Request#
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "StoreList_Load_Query"
}
Example Response#
{
"success": 1,
"totalCount": 1,
"startOffset": 0,
"data": [
{
"id": 1,
"code": "my-store",
"name": "My Store"
}
]
}