Reverse Earned Points - Fabric
Reverse Earned Points
cURL
curl --request POST \
--url https://vanilla-dev02-loyalty.fabric.zone/api/v2/earn/reverse \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"profileId": "67460e74-02e3-11e8-b443-00163e990bdb",
"entityReference": "LIBERTY_STORE",
"reverseTransactionExternalRef": "LOYALTY-12345",
"transactionTypeExternalReference": "RETURN",
"activityTimestamp": "2020-02-08 09:30:26",
"transactionExternalReference": "LOYALTY-8675",
"checkForDuplicateTransaction": 1,
"fetchUpdatedMemberPointTotals": 1,
"transactionGrossAmount": -100,
"discountValue": -20,
"totalAmountPaid": -80,
"totalTax": -10,
"netAmount": -70,
"discounts": [
{
"id": 2345,
"value": 20,
"type": "promotion",
"description": "Black Friday discount"
}
],
"issueAuditUser": "Joe",
"cancelAuditUser": "Mia",
"redemptionCode": [],
"setToPending": true,
"reasonCode": "9393",
"reasonDescription": "returning item",
"transactionItems": [
{
"grossAmount": 100,
"taxAmount": 10,
"totalAmountPaid": 100,
"netAmount": 90,
"itemPrice": 45,
"itemQuantity": 2,
"SKU": "12345",
"lineNumber": 1,
"discounts": [],
"categories": [
"Supplements"
],
"itemName": "demo item",
"UOM": "unit",
"couponCodes": []
}
],
"isCompanyUser": false
}
'
Example Response
{
"status": 201,
"message": "earn reversed",
"errors": {},
"data": {
"profileId": "67460e74-02e3-11e8-b443-00163e990bdb",
"transactionNumber": "LOYALTY-8675",
"transactionType": "EARN_REVERSE",
"transactionCode": "62660e74-02e3-11e8-b443-00163e990abc",
"transactionDateTime": "2020-03-20T14:28:23.382748",
"activityTimestamp": "2020-03-20T14:28:23.382748",
"totalAmountPaid": -80,
"totalTax": -10,
"transactionNetAmount": -70,
"points": -70,
"basePoints": 70,
"bonusPoints": 0,
"promotionalPoints": 0,
"currentPointsBalance": 500,
"reasonCode": "9393",
"reasonDescription": "returning item",
"discounts": [
{
"id": 2345,
"value": 20,
"type": "promotion",
"description": "Black Friday discount"
}
],
"discountValue": 20,
"transactionItems": [
{
"grossAmount": 100,
"taxAmount": 10,
"netAmount": 90,
"categories": [
"Supplements"
],
"itemPrice": 45,
"itemQuantity": 2,
"SKU": "12345",
"lineNumber": 1,
"discounts": [],
"itemName": "demo item",
"UOM": "unit",
"couponCodes": []
}
],
"issueAuditUser": "Joe",
"cancelAuditUser": "Mia",
"deviceId": "D10626",
"transactionActivityType": "TRANS_CANCEL",
"transactionTypeExternalReference": "RETURN",
"transactionExternalReference": "LOYALTY-8675",
"transactionEntityReference": "LIBERTY_STORE"
}
}
Error Responses
{
"message": "Error message string",
"errors": {
"ExceptionString": ["Invalid Field"]
},
"data": null,
"status": 400
}
{
"detail": "Authentication Failed"
}
Authorizations
- Type:
Bearer String | Required: Yes
Body Parameters
profileId: String (uuid) | Required
entityReference: String | Required
reverseTransactionExternalRef: String | Required
transactionTypeExternalReference: String | Required
activityTimestamp: String (date-time) | Required
transactionExternalReference: String | Required
checkForDuplicateTransaction: Integer | Required
fetchUpdatedMemberPointTotals: Integer | Required
transactionGrossAmount: Number (float) | Required
discountValue: Number (float) | Required
totalAmountPaid: Number (float) | Required
totalTax: Number (float) | Required
netAmount: Number (float) | Required
discounts: Array of objects | Optional
issueAuditUser: String | Optional
cancelAuditUser: String | Optional
redemptionCode: Array of strings | Optional
setToPending: Boolean | Optional
reasonCode: String | Optional
reasonDescription: String | Optional
transactionItems: Array of objects | Required
isCompanyUser: Boolean | Optional