Loyalty API - Winrest
- Lopes da Costa, Valentina
- Silva, Carlos
Owned by Lopes da Costa, Valentina
Contents
- 1 Overview
- 2 Identify
- 2.1 Example request
- 2.2 Example response
- 3 Validate
- 4 Update
- 4.1 Example Request
- 4.2 Example Response
- 5 Void
- 5.1 Example Request
- 5.2 Example Response
Overview
The Winrest integration to the Loyalty API uses the same endpoints listed under Loyalty API v1 - Endpoint Reference, however it returns prices for rewards in the Identify request. Therefore, when calling Loyalty API v1 - Identify :
The price of the reward will be returned if a reward with price is pre-selected.
See examples in the next section below.
Â
Identify
Example request
{
"identifier": "123456",
"posVendor": {
"operator": "300",
"posType": "Winrest" or "Tillster",
"supportingPos": "Partner",
"storeId": "9999",
"terminal": "0",
"transactionId": "000000000257"
}
}
Example response
{
"balances": [
{
"amount": 14464,
"currency": "points"
}
],
"loyaltyUser": {
"created": "2021-08-10T12:18:39.180Z",
"id": "4711fc2a-3a8f-414f-a9e7-44dd5231dca7",
"name": "Farhan"
},
"order": [
{
"productId": "$incentivePlu",
"incentiveId": "sanity id of reward or offer",
"quantity": "1"
"referenceId": "00",
"productType": "REWARD or OFFER",
"price": "300"
},
],
"transactionId": "f4190848-169d-4c69-9f53-f916318c432b"
}
Â
Validate
Expected Request
{
"channel": "Restaurant",
"created": "2021-05-04T13:39:47Z",
"serviceMode": "Eatin",
"status": "CLAIMED",
"transactionDetails": {
"currency": "USD",
"order": [
{
"name": "some incentive name",
"price": 5.00,
"productId": "$incentivePlu",
"productType": "offer",
"quantity": 1,
"referenceId": "1",
"tax": 0
},
{
"name": "med whopper combo",
"price": 5.00,
"productId": "$plu",
"productType": "combo",
"quantity": 1,
"referenceId": "1",
"tax": 0
},
{
"name": "whopper",
"parentReferenceId"?: "1",
"price": 0,
"productId": "$plu:,
"productType": "item",
"quantity": 1,
"referenceId": "2",
"tax": 0
},
{
"name": "med fries",
"parentReferenceId"?: "1",
"price": 0,
"productId": "$plu",
"productType": "item",
"quantity": 1,
"referenceId": "3",
"tax": 0
}
],
"payments": [
{
"amount": 500,
"type": "CASH" or "CARD",
"ccToken": "optional PAN token"
}
],
"posVendor": {
"operator": "300",
"posType": "POS/Kiosk vendor name",
"storeId": "9999",
"terminal": "0",
"transactionId": "000000000257"
},
}
}
Example Response
Example Error Response
 Note: A more thorough list of error codes can be found here: Loyalty API v1 - Error Responses
Â
Update
Example Request
Example Response
Â
Void
Example Request
Example Response
Â