POST
/
v2
/
earn
/
reverse
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": [
    {
      "type": "promotion",
      "description": "Black Friday discount",
      "id": 2345,
      "value": 20
    }
  ],
  "issueAuditUser": "Joe",
  "cancelAuditUser": "Mia",
  "redemptionCode": [],
  "setToPending": true,
  "reasonCode": "9393",
  "reasonDescription": "returning item",
  "transactionItems": [
    {
      "grossAmount": 100,
      "taxAmount": 10,
      "discounts": [],
      "totalAmountPaid": 100,
      "netAmount": 90,
      "categories": [
        "Supplements"
      ],
      "itemName": "demo item",
      "itemPrice": 45,
      "itemQuantity": 2,
      "SKU": "12345",
      "lineNumber": 1,
      "UOM": "unit",
      "couponCodes": []
    }
  ],
  "isCompanyUser": false
}'
{
  "status": 201,
  "message": "earn reversed",
  "errors": {},
  "data": {
    "transactionCode": "62660e74-02e3-11e8-b443-00163e990abc",
    "profileId": "67460e74-02e3-11e8-b443-00163e990bdb",
    "transactionNumber": "LOYALTY-8675",
    "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": [
      {
        "type": "promotion",
        "description": "Black Friday discount",
        "id": 2345,
        "value": 20
      }
    ],
    "discountValue": 20,
    "transactionItems": [
      {
        "grossAmount": 100,
        "taxAmount": 10,
        "discounts": [],
        "netAmount": 90,
        "categories": [
          "Supplements"
        ],
        "itemName": "demo item",
        "itemPrice": 45,
        "itemQuantity": 2,
        "SKU": "12345",
        "lineNumber": 1,
        "UOM": "unit",
        "couponCodes": []
      }
    ],
    "rewards": [],
    "issueAuditUser": "Joe",
    "cancelAuditUser": "Mia",
    "deviceId": "D10626",
    "transactionType": "EARN_REVERSE",
    "transactionActivityType": "TRANS_CANCEL",
    "transactionTypeExternalReference": "RETURN",
    "transactionExternalReference": "LOYALTY-8675",
    "transactionEntityReference": "LIBERTY_STORE"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Transaction details to reverse the earned points

​
profileId
string
required

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync. profileId is generated as part of the Enroll Member endpoint - POST /members.

Example:

"67460e74-02e3-11e8-b443-00163e990bdb"

​
entityReference
string
required

Unique name or ID of store (or entity) where the transaction took place.

Required string length: 3 - 15
Example:

"LIBERTY_STORE"

​
reverseTransactionExternalRef
string
required

External reference number of the transaction to be reversed

Required string length: 1 - 100
Example:

"LOYALTY-12345"

​
transactionTypeExternalReference
string
required

External reference for transaction type such purchase, return, or exchange (configurable as per requirement).

Required string length: 3 - 15
Example:

"RETURN"

​
activityTimestamp
string
required

Activity date (in UTC format). An activity could be enrolling a member, making a transaction, etc.

Example:

"2020-02-08 09:30:26"

​
transactionExternalReference
string
required

Order ID or receipt ID for the transaction (received from the store). This is needed to cancel or return an order.

Required string length: 1 - 100
Example:

"LOYALTY-8675"

​
checkForDuplicateTransaction
integer
required

0 indicates the system allows duplicate and 1 indicates there is a validation in place to identify duplicates.

Example:

1

​
fetchUpdatedMemberPointTotals
integer
required

A value of 1 indicates the total points (including the points earned in the latest transaction) are calculated and displayed to the member. A value of 0 indicates the total points are not calculated and the member is only notified if the earn is successful. The response is faster when the value is 0 because there is no calculations involved.

Example:

1

​
transactionGrossAmount
number
required

Transaction gross amount. For example, gross amount of item1 is 50.00 and gross amount of item2 is 100.00, then transactionGrossAmount is 150.00

Example:

-100

​
discountValue
number | null
required

Discount amount applied on the transaction.

Example:

-20

​
totalAmountPaid
number
required

Total amount paid for the items. For example, the amount paid for item1 is 100.00 and the amount of item2 is 200.00 so the total amount paid is 300.00.

Example:

-80

​
totalTax
number
required

Final tax amount based on the number of items in the transaction. Example - the tax amount of item1 is 2.00; Tax amount of item2 is 2.00. The totalTax is 4.00.

Example:

-10

​
netAmount
number
required

Net transaction amount. Example - the net amount of item1 is 100.00 and net amount of item2 is 200.00. So, the netAmount is 300.00.

Example:

-70

​
discounts
object[]

Discount details.

Discount details

​
issueAuditUser
string | null

Representative who issued the earn transaction.

Required string length: 1 - 100
Example:

"Joe"

​
cancelAuditUser
string | null

Representative who cancelled the earn transaction.

Required string length: 1 - 100
Example:

"Mia"

​
redemptionCode
string[] | null

Redemption code used to identify and link the rewards used in a specific transaction. This code is generated in the response of the Issue Variable Rewards endpoint - POST /api/v1/redeem/reward/issue.

Example:
[]
​
setToPending
boolean

true: Points in Pending status <br /> false: Points in Active status. Note: The time period for Pending state is configurable.

​
reasonCode
string | null

Reason code to categorize transactions. A parent company can configure custom codes for their stores as required.

Required string length: 1 - 4
Example:

"9393"

​
reasonDescription
string | null

When reason codes are not configured, store can make use of the reason description.

Required string length: 1 - 20
Example:

"returning item"

​
transactionItems
object[]

Details of the transaction items to be reversed.

Details of items returned

​
isCompanyUser
boolean
default:false

true: Company user is running the endpoint <br /> false: Client user is running the endpoint.

Response

200
application/json
OK

Metadata for the Earn Reverse response

​
status
integer

Status code for the call

Example:

201

​
message
string

Message corresponding to the status code.

Example:

"earn reversed"

​
errors
object

In a successful response, this is always a blank object

Example:
{}
​
data
object

Earn Reverse response details

Was this page helpful?

Earn PointsGet Transactions