AlipayHKAlipayHKDOCS

6. Query PMS Collection Result

API Path

/api/open/businessdistrict/circleStore/queryPage

Sample: https://open.alipay.hk/api/open/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

C

For haft auto-earn-point.

Mall subject information, filter by mall. At least one of this or subjectId must be provided

"businessDistrictSubject": {

"mallGroupLabel": "20240316",

"mallLabel": ""

}

pageInfo

PageInfo

M

Sub-page information

  • pageSize must not be greater than 50.

"pageInfo": {

"pageSize": "20",

"pageIndex": "3"

}

subjectId

String

64

C

For auto-earn-point.

Filter by points subject ID; fill in with mall ID or brand ID. At least one of this or businessDistrictSubject must be provided.

2160120139241234

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

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": [

    {

      "subjectId": "2160120146501234",

      "merchantName": "Carrefour Merchant",

      "storeName": "Carrefour",

      "pmsLabel": "2023041219161407000009000012051"

    },

    {

      "businessDistrictSubject": {

        "mallGroupLabel": "20241234",

        "mallLabel": "202401234"

      },

      "merchantName": "Carrefour Merchant",

      "storeName": "Carrefour",

      "pmsLabel": "2023041219161407000009000012345"

    }

  ],

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

C

haft-auto-earn point

"businessDistrictSubject": {

"mallGroupLabel": "20240316",

"mallLabel": "20240323"

}

merchantName

java.lang.String

M

"merchantName": "家乐福商家",

storeName

java.lang.String

M

"storeName": "家乐福"

pmsLabel

java.lang.String

M

"pmsLabel": "2023041219161407000009000012056"

subjectId

java.lang.String

C

Points subject ID

2160120146500000

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

Query for haft-auto-earn point

copy
{
  "businessDistrictSubject": {
    "mallGroupLabel": "20241234",
    "mallLabel": "202401234"
  },
  "pageInfo": {
    "pageSize": "20",
    "pageIndex": "3"
  }
}

Query for auto-earn point

copy
{
  "subjectId": "2160120146501234",
  "pageInfo": {
    "pageSize": "20",
    "pageIndex": "1"
  }
}

Response

Query for haft-auto-earn point

copy
{
  "businessDistrictCircleStores": [
    {
      "businessDistrictSubject": {
        "mallGroupLabel": "20241234",
        "mallLabel": "202401234"
      },
      "merchantName": "家乐福商家",
      "storeName": "家乐福",
      "pmsLabel": "2023041219161407000009000012341"
    },
    {
      "businessDistrictSubject": {
        "mallGroupLabel": "20241235",
        "mallLabel": "2024012345"
      },
      "merchantName": "家乐福商家",
      "storeName": "家乐福",
      "pmsLabel": "2023041219161407000009000012342"
    }
      ],
      "pageInfo": {
      "pageIndex": 3,
      "pageSize": 20,
      "totalItemCount": 104,
      "totalPageCount": 6
    },
      "result": {
      "resultCode": "SUCCESS",
      "resultMessage": "success.",
      "resultStatus": "S"
    }
    }

Query for auto-earn point

copy
{
    "businessDistrictCircleStores": [
      {
        "merchantName": "huahuo_test_merchantName7",
        "pmsLabel": "2026082819161407000000700078902",
        "storeName": "huahuo_test17",
        "subjectId": "122023000000135808000000000000032"
      },
      {
        "pmsLabel": "2023082819161407000003000078901",
        "subjectId": "122023000000135808000000000001234"
      }
    ],
    "pageInfo": {
      "pageIndex": 1,
      "pageSize": 20,
      "totalItemCount": 2,
      "totalPageCount": 1
    },
    "result": {
      "resultCode": "SUCCESS",
      "resultMessage": "success.",
      "resultStatus": "S"
    }