Skip to main content

MemberDetailsResponse

ReturnCodeinteger

Zero indicates success.

loyaltyCardNumberstring
RewardCodestring

Encrypted code used to burn the reward.

MemberProfile object[]
  • Array [
  • FirstNamestring
    LastNamestring
    BirthMonthstring
    BirthYearstring
    PhoneNostring
    PhoneVerifiedStatusboolean
    EmailAddressemail
    EmailVerifiedStatusboolean
    Addresses object[]
  • Array [
  • Typestring
    Address1string
    Address2string
    Citystringnullable
    Statestring
    PostalCodestring
    Regionstring
    Countrystringnullable
  • ]
  • ]
  • MemberRewards object[]
  • Array [
  • MemberRewardIdinteger
    RewardTypeExternalReferencestring
    RewardValuenumber
    RewardBarcodestring
    RewardBarcodePINstring
    ExpireEndOfDaydate
    RewardTypestring

    Cash_Voucher, Retail_RO, Retail_UMO, etc.

    RewardCompanystring
    DisplayPrioritystringnullable
    PromotionCodestring
    Metadata object
    property name*string
    RewardBrandstring
  • ]
  • MemberDetailsResponse
    {
    "ReturnCode": 0,
    "loyaltyCardNumber": "string",
    "RewardCode": "string",
    "MemberProfile": [
    {
    "FirstName": "string",
    "LastName": "string",
    "BirthMonth": "string",
    "BirthYear": "string",
    "PhoneNo": "string",
    "PhoneVerifiedStatus": true,
    "EmailAddress": "user@example.com",
    "EmailVerifiedStatus": true,
    "Addresses": [
    {
    "Type": "string",
    "Address1": "string",
    "Address2": "string",
    "City": "string",
    "State": "string",
    "PostalCode": "string",
    "Region": "string",
    "Country": "string"
    }
    ]
    }
    ],
    "MemberRewards": [
    {
    "MemberRewardId": 0,
    "RewardTypeExternalReference": "string",
    "RewardValue": 0,
    "RewardBarcode": "string",
    "RewardBarcodePIN": "string",
    "ExpireEndOfDay": "2024-07-29",
    "RewardType": "string",
    "RewardCompany": "string",
    "DisplayPriority": "string",
    "PromotionCode": "string",
    "Metadata": {},
    "RewardBrand": "string"
    }
    ]
    }