StoreList

Function

Get a list of store.

Endpoint

• /v1/store/list

HTTP Method

• POST

Request Headers

• Authorization: Bearer {token}
• X-App-Key: {appKey}

Request Payload

{
  "pageNo": 1,
  "pageSize": 10
}

Request Parameters

Field	Required	Type	Remark	Sample
pageNo	No	integer	Pagination page number, 0 represents the first page	1
pageSize	No	integer	Number of entries per page, maximum 200	10

Response Payload

{
  "status": 1,
  "errorCode": 0,
  "message": "success",
  "morePage":true,
  "pageNo":1,
  "pageSize":1,
  "items": [
    {
      "storeCode": "KTSP010000001",
      "storeNameEn": "Name (EN)",
      "storeNameSc": "Name (SC)",
      "storeNameTc": "Name (TC)",
      "storeStatus": "Active",
      "allowEarn": true,
      "allowBurn": true,
      "siteId": "KTSP01",
      "floorName": "1F",
      "unitName": "L10001",
      "category":{
        "categoryId": "01hdmxx74gh75ykw03203hpxvq",
        "categoryNameEn": "Name (EN)",
        "categoryNameSc": "Name (SC)",
        "categoryNameTc": "Name (TC)"
      }
    }
  ]
}

Response Parameters

Field	Required	Type	Remark	Sample
status	Yes	string	status code of the api call
message	Yes	string	detail message of the api call
errorCode	No	string
morePage	No	boolean	Whether has more page. If this value is true, you may want to continue to check next page	true
pageNo	Yes	integer	Pagination page number, 0 represents the first page	1
pageSize	Yes	integer	Number of entries per page, maximum 200	10
items	No	object[]
storeCode	No	string	Unique Code	KTSP010000001
storeNameEn	No	string	English name	Name (EN)
storeNameSc	No	string	Simplified Chinese name	Name (SC)
storeNameTc	No	string	Traditional Chinese name	Name (TC)
storeStatus	No	string	Active 、 Inactive	Active
allowEarn	No	boolean	Allow Earn Point	true
allowBurn	No	boolean	Allow Burn Point	true
isRetail	No	boolean	isRetail	true
siteId	No	string	siteId: KTSP01	KTSP01
floorName	No	string	floorName	1F
unitName	No	string	unitName	L10001
category	No	object
. categoryId	Yes	string	Category Id	01hdmxx74gh75ykw03203hpxvq
. categoryNameEn	Yes	string	English Name	Name (EN)
. categoryNameSc	Yes	string	Simplified Chinese Name	Name (SC)
. categoryNameTc	Yes	string	Traditional Chinese Name	Name (TC)

Response Headers

Error Codes

Code	Description
1	Internal Error