Adjust Points

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

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/adjustPointsAction
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
AdjustmentCategory	Type String Description The category of adjustment.
AdjustmentType	Type string Description Required. The type of adjustment required.
JournalId	Type ID Description ID of the transaction journal.
LoyaltyProgramCurrencyId	Type ID Description ID of the loyalty program currency.
LoyaltyProgramMemberId	Type ID Description Required. ID of the loyalty program member to whom the points must be adjusted.
Points	Type Float Description Required. The points available for the loyalty program member.
PointsExpirationDate	Type string Description The date on which fixed-model non-qualifying points credited by the action expire. Points expiration date is only applicable when the adjustment is crediting points to the member. This input is available in API version 55.0 and later.
ReasonforChange	Type string Description Required. The reason for 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   "inputs":[{
3      "LoyaltyProgramMemberId": "0lmxx00004000001AAB",
4      "LoyaltyProgramCurrencyId": "0lpxx00004000001AAB",
5      "Points": 500.0,
6      "PointsExpirationDate": "2022-08-12",
7      "AdjustmentType": "Credit",
8      "ReasonForChange": "Compensation"
9   }]
10}

Sample Response

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

Loyalty Management Developer Guide

Adjust Points

Supported REST HTTP Methods

Inputs

Outputs

Example