5. Query PMS Collection Result
API Path
/api/open/alipayhk/businessdistrict/circleStore/queryPage
Sample: https://open.alipay.hk/api/open/alipayhk/businessdistrict/circleStore/queryPage
API Request
Request
Header
Name | Description | Type | Length | Required | Remarks | Sample |
client-id | Client ID | String | M |
| 211020000000000000044 | |
signature | Message signature information | String | M |
| algorithm=sha256withrsa,keyVersion=2,signature=xxxxxxxxxxxyyyyyyyyyyyyyyzzzzzzzzz== | |
encrypt | Message encryption information | String | O | algorithm=rsa, keyVersion=2 | ||
Content-type | HTTP content type | String | M | application/json; charset=UTF-8 |
Body
Field | Type | Length | Required | Remarks | Sample |
businessDistrictSubject | BusinessDistrictSubjectVO | M | The mall‘s information defined by AlipayHK | "businessDistrictSubject": { "mallGroupLabel": "20240316", "mallLabel": "" } | |
pageInfo | PageInfo | M | Sub-page information | "pageInfo": { "pageSize": "20", "pageIndex": "3", "totalPageCount": "0", "totalItemCount": "0" } |
BusinessDistrictSubjectVO
Field | Type | Length | Required | Remarks | Sample |
mallGroupLabel | java.lang.String | M | The IDs assigned by AlipayHK to each group | 20230316 | |
mallLabel | java.lang.String | M | The IDs assigned by AlipayHK to each mall | 20230316 |
PageInfo
Field | Type | Length | Required | Remarks | Sample |
pageSize | java.lang.String | M | Number of lines of record displayed on the page | 20 | |
pageIndex | java.lang.String | M | Index of the opage | 3 | |
totalPageCount | java.lang.String | M | Total number of pages | 0 | |
totalItemCount | java.lang.String | M | Total number of records | 0 |
Response
Header
Name | Description | Type | Length | Required | Remarks | Sample |
client-id | Client ID | String | M |
| 211020000000000000044 | |
signature | Message signature information | String | M |
| algorithm=sha256withrsa,keyVersion=2,signature=xxxxxxxxxxxyyyyyyyyyyyyyyzzzzzzzzz== | |
encrypt | Message encryption information | String | O | algorithm=rsa, keyVersion=2 | ||
Content-type | HTTP content type | String | M | application/json; charset=UTF-8 |
Body
Field | Type | Length | Required | Remarks | Sample |
businessDistrictCircleStores | List<BusinesDistrictCircleStorePageVO> | M | The store list | "businessDistrictCircleStores": [ { "businessDistrictSubject": { "mallGroupLabel": "20240316", "mallLabel": "20240323" }, "merchantName": "家乐福商家", "storeName": "家乐福" }] | |
pageInfo | PageInfo | M | Page Information | "pageInfo": { "pageIndex": 3, "pageSize": 20, "totalItemCount": 104, "totalPageCount": 6 }, | |
result | Result|2.0 | M | Result | "result": { "resultCode": "SUCCESS", "resultMessage": "success.", "resultStatus": "S" } |
PageInfo
Field | Type | Length | Required | Remarks | Sample |
pageIndex | java.lang.String | M | "pageIndex": 3, | ||
pageSize | java.lang.String | M | "pageSize": 20, | ||
totalPageCount | java.lang.String | M | "totalItemCount": 104, | ||
totalItemCount | java.lang.String | M | "totalPageCount": 6 |
BusinesDistrictCircleStorePageVO
Field | Type | Length | Required | Remarks | Sample |
businessDistrictSubject | BusinessDistrictSubjectVO | M | "businessDistrictSubject": { "mallGroupLabel": "20240316", "mallLabel": "20240323" } | ||
merchantName | java.lang.String | M | "merchantName": "家乐福商家", | ||
storeName | java.lang.String | M | "storeName": "家乐福" | ||
pmsLabel | java.lang.String | M | "pmsLabel": "2023041219161407000009000012056" |
BusinessDistrictSubjectVO
Field | Type | Length | Required | Remarks | Sample |
mallGroupLabel | java.lang.String | M | The IDs assigned by AlipayHK to each group | 20230316 | |
mallLabel | java.lang.String | M | The IDs assigned by AlipayHK to each mall | 20230316 |
Result
Field | Type | Length | Required | Description | Sample |
resultCode | java.lang.String | M | Result code | SUCCESS | |
resultStatus | java.lang.String | M | Result status | F - failed S- success | |
resultMessage | java.lang.String | M | Result message | success |
Result Code
Result Code | Result Message | Result Status | Description |
SUCCESS | success | S | |
BUSINESS_DISTRICT_NOT_EXIST | The business district does not exist | F | |
PARAM_ILLEGAL | Illegal parameters. For example, non-numeric input, invalid date. | F | |
UNKNOWN_EXCEPTION | API failed due to unknown reason. | F |
3. Request Example
Request
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240316"
},
"pageInfo": {
"pageSize": "20",
"pageIndex": "3",
"totalPageCount": "0",
"totalItemCount": "0"
}
}Response
{
"businessDistrictCircleStores": [
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240323"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012051"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240323"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012052"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240323"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012053"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240323"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012054"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240323"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012055"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240323"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012056"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240323"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012057"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240323"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012058"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240322"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012059"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240322"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012060"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240322"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012061"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240322"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012062"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240322"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012063"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240322"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012064"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240322"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012065"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240322"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012066"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240322"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012067"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240322"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012068"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240321"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012069"
},
{
"businessDistrictSubject": {
"mallGroupLabel": "20240316",
"mallLabel": "20240321"
},
"merchantName": "家乐福商家",
"storeName": "家乐福",
"pmsLabel": "2023041219161407000009000012070"
}
],
"pageInfo": {
"pageIndex": 3,
"pageSize": 20,
"totalItemCount": 104,
"totalPageCount": 6
},
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success.",
"resultStatus": "S"
}
}