Order History

Function

Order History

Endpoint

• /v1/order/list

HTTP Method

• POST

Request Headers

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

Request Payload

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

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
memberId	Yes	string	memberId

Response Payload

{
    "status": 1,
    "errorCode": 0,
    "message": "success",
    "morePage": false,
    "pageNo": 1,
    "pageSize": 10,
    "items": [
        {
            "orderCode": "2024091011191818231978786816",
            "orderTime": "2024-08-31T10:00:00+08:00",
            "originalAmount": "1000.00",
            "discountAmount": "200.00",
            "paymentAmount": "800.00",
            "storeCode": "KTSP010000001",
            "storeNameEn": "Store name (EN)",
            "storeNameSc": "Store name (SC)",
            "storeNameTc": "Store 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	No	integer	Pagination page number, 0 represents the first page	1
pageSize	No	integer	Number of entries per page, maximum 200	10
items	No	object[]
. orderCode	Yes	string	order code	xx
. orderTime	Yes	string	order time, rfc3339 format	2024-01-01T10:00:00+08:00
. originalAmount	Yes	string	original order amount	1000.00
. discountAmount	Yes	string	discount amount	200.00
. paymentAmount	Yes	string	amount of payment	800.00
. storeCode	No	string	Store Code
. storeNameEn	No	string	Store name (EN)
. storeNameSc	No	string	Store name (SC)
. storeNameTc	No	string	Store name (TC)

Response Headers

Error Codes

Code	Description
1	Internal Error
3	Missing Parameter
4	Invalid Input
4100	Member not found