Skip to main content

Register Loyalty Member

POST/v3/loyalty/member

Using Query String to Get User Profile by input the country code and phone number

Request Parameters

nameStringrequired

Member name

Example: "Oska"

countryCodeStringrequired

Country code of member contact number

Example: "60"

phoneNumberStringrequired

Phone number of member

Example: "1878241234"

emailStringrequired

Email address of member

Example: "developer.oskang@gmail.com"

nricStringrequired

IC Number

Example: "950711011234"

birthDateStringrequired

Member Birth Date

Example: "1995-07-11T00:00:00Z"

genderStringrequired

Gender

Example: "MALE"

pointUintrequired

Loyalty Point

Example: 0

addressObjectrequired

Refer to explanation below

Example: (Refer to explanation below)


Response Parameters

itemObject

Profile object

Example: (Refer to explanation below)

codeString

Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)

Example: "SUCCESS"


Profile object (item):
idString

Profile ID

Example: ""

keyString

Profile Key (Internal Usage)

Example: "EhIKBk1lbWJlchDOuOKz24XWkg4SGQoNTWVtYmVyUHJvZmlsZRDl-MTxiPOPjzY"

nameString

Profile name

Example: "Oska"

emailString

Profile email

Example: "developer.oskang@gmail.com"

nricString

IC Number

Example: "950711011234"

birthDateString

User Birth Date (YYYY:MM:DD)

Example: "1995-07-11"

genderString

Gender

Example: "MALE"

addressObject

Refer to explanation below

Example: (Refer to explanation below)

memberTierString

Member Tier Point

Example: null

totalLoyaltyPointUint

Total Loyalty Point

Example: 0

hasPinCodeBool

User Pin

Example: false

loyaltyPointBalanceUint

Total Point Balance left

Example: 0

spendingPointUint

Point Spend

Example: 0

creditBalanceUint

Credit Balance

Example: 0

statusString

Profile Status

Example: "ACTIVE"

createdAtDateTime

Creation date time

Example: "2018-10-19T03:39:47Z"

updatedAtDateTime

Last update date time

Example: "2020-06-29T10:14:33Z"


Address object:
addressLine1String

Address 1

Example: ""

addressLine2String

Address 2

Example: ""

postcodeString

Postcode

Example: ""

cityString

City

Example: ""

stateString

State

Example: ""

countryString

Country

Example: ""