deductLoyaltyPoints
Deduct the specified number of Loyalty Points from the account.
Arguments
Input fields for deducting Loyalty Points.
Possible Errors
- KT-CT-1111: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-5420: Unauthorized.
- KT-CT-7899: An internal error occurred.
- KT-CT-9204: Negative or zero points set.
- KT-CT-9205: Insufficient Loyalty Points.
- KT-CT-9208: Invalid posted at datetime.
- KT-CT-9211: Invalid reason for loyalty points award.
- KT-CT-9219: Loyalty points user not found.
- KT-CT-9221: Idempotency key already used on ledger entry.
Allowed Viewers
Required Permissions
Can deduct loyalty pointsQuery Complexity
1Examples
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
mutation DeductLoyaltyPoints($input: DeductLoyaltyPointsInput!) {
deductLoyaltyPoints(input: $input) {
ledgerEntry {
...LoyaltyPointLedgerEntryTypeFragment
}
pointsDeducted
}
}
Variables
{
"input": DeductLoyaltyPointsInput
}
Response
{
"data": {
"deductLoyaltyPoints": {
"ledgerEntry": LoyaltyPointLedgerEntryType,
"pointsDeducted": 71
}
}
}