Newer Version Available

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

Adjust Points Actions

Adjust loyalty points for a specified program member or journal transaction.

This object 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/adjustPoints
Formats
JSON, XML
HTTP Methods
GET, HEAD, POST
Authentication
Authorization: Bearer token

Inputs

Input Details
LoyaltyProgramMemberId
Type
ID
Description
ID of the loyalty program member to whom the points must be adjusted.
JournalId
Type
ID
Description
ID of the transaction journal.
LoyaltyProgramCurrencyId
Type
ID
Description
ID of the loyalty program currency.
Points
Type
Float
Description
The points available for the loyalty program member.
AdjustmentType
Type
string
Description
The type of adjustment required.
ReasonforChange
Type
string
Description
The reason for adjustment.
AdjustmentCategory
Type
String
Description
The category of adjustment.

Outputs

Output Details
AdjustmentTransactionJournalId
Type
string
Description
The ID of the adjustment transaction journal generated after the request is successful.

Example

Sample Request

1{
2
3   "inputs":[ 
4      {
5        LoyaltyProgramMemberId:0lmxx00004000001AAB
6        LoyaltyProgramCurrencyId:0lpxx00004000001AAB
7        Points:10.50
8        AdjustmentType:"Credit"
9        ReasonForChange:"Compensation"
10      }
11   ]
12}

Sample Response

1{
2   "errors":null,
3   "isSuccess":true,
4   "outputValues":{
5        "AdjustmentTransactionJournalId":"0lvxx00004000001AAB"}
6   }
7}