Skip to main content

QueryMemberProfile

Function

Query Member Profile

Endpoint

  • /v1/member/profile

HTTP Method

  • POST

Request Headers

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

Request Payload

  • query with memberId
{
"searchType": "memberId",
"searchValue": "xxx"
}
  • query with email
{
"searchType": "email",
"searchValue": "email@example.com"
}
  • query with mobile
{
"searchType": "mobile",
"searchValue": "88888888",
"countryCode": "852"
}
  • query with kdp member number
{
"searchType": "kdp",
"searchValue": "kdp member number"
}

Request Parameters

FieldRequiredTypeRemarkSample
searchTypeYesstringSearch Type: memberId、email、mobile、kdpmobile
searchValueYesstringSearch Value88888888
countryCodeNostringphone country code852

Response Payload

{
"status": 1,
"errorCode": 0,
"message": "success",
"memberId":"xxx",
"title": "Dr",
"languagePreference": "en",
"nickname": "",
"firstname": "",
"lastname": "",
"chineseName": "",
"kdpMemberNumber":"10012275255"
}

Response

FieldRequiredTypeRemarkSample
statusYesnumberstatus code of the api call, 1=success, 0=fail
messageYesstringdetail message of the api call
errorCodeNonumber
memberIdYesstringmemberId
titleNostringtitleDr
languagePreferenceNostringlanguagePreferenceen
firstnameNostringfirstname
lastnameNostringlastname
chineseNameNostringchineseName
kdpMemberNumberNostringkdp member number10012275255

Error Codes

Status CodeStatus Description
1Internal Error
3Missing Parameter
4100Member not found
4199Member Inactive