Newer Version Available

This content describes an older version of this product. View Latest

Get Tier

Retrieve the current tier for a specified loyalty program member.

This action is available in API version 51.0 and later for users with Loyalty Management license.

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/standard/getTier
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
LoyaltyProgramMemberId
Type
string
Description
Required. ID of the loyalty program member to whom the tier details needs to be fetched.
ProgramName
Type
string
Description
Required. The loyalty program name associated with the tier.
TierGroupName
Type
string
Description
Required. The name of the tier group.

Outputs

Output Details
LoyaltyProgramMemberId
Type
string
Description
The ID of the loyalty program member.
SequenceNumber
Type
integer
Description
The ranking of the tier.
TierGroupName
Type
string
Description
The name of the tier group.
TierName
Type
string
Description
The name of the loyalty tier associated with the program member.

Example

Sample Request

1{
2   "inputs":[{
3      "TierGroupName":"QualifyingGroup",
4      "ProgramName":"baLoyalty",
5      "LoyaltyProgramMemberId":"0lcxx00004000001AAA"
6   }]
7}

Sample Response

1{
2   "errors":null,
3   "isSuccess":true,
4   "outputValues":{ 
5        "LoyaltyProgramMemberId":"0lMxx0000A000001EAA",
6        "TierGroupName":"QualifyingGroup"
7        "TierName":"Gold",
8        "ProgramName":"baLoyalty",
9        "SequenceNumber":4
10   }
11}