Loyalty API pointsBalance field

Answered

May 12, 2021 21:48

I am sending the following in the response to a loyalty inquire:

{
    "checkResponse": {
        "accountInfo": {
            "firstName": "Jonathan",
            "identifier": "17881000190019",
            "lastName": "Watts",
            "pointsBalance": "Points: 1\nVisits: 2"
        },
        "appliedRedemptions": [],
        "offers": [
            {
                "amount": 0.0,
                "applicable": false,
                "expiration": [],
                "identifier": "px_120_13_1_4",
                "itemApplication": [],
                "name": "Reward Test",
                "quantity": 10.0,
                "selectionType": "ITEM"
            }
        ],
        "rejectedRedemptions": []
    },
    "result": "success",
    "transactionStatus": "ACCEPT",
    "transactionType": "LOYALTY_INQUIRE"
}

I was expecting to see the pointsBalance somewhere on the popup display but this is what I see.

Where should I expect to see the pointsBalance display?

Comments

10 comments

Liz Jackson

May 13, 2021 17:41 Edited
(Post removed. Information updated and clarified in later post.)
0

Jonathan Watts

May 13, 2021 17:31

So in this case where I have an applicable offer I should be seeing the points balance or am I misunderstanding?

{
    "checkResponse": {
        "accountInfo": {
            "firstName": "Jonathan",
            "identifier": "17881000190019",
            "lastName": "Watts",
            "pointsBalance": "Points: 1\nVisits: 2"
        },
        "appliedRedemptions": [],
        "offers": [
            {
                "amount": 8.99,
                "applicable": true,
                "expiration": [],
                "identifier": "px_250_9_1_1",
                "itemApplication": [
                    {
                        "amount": 8.99,
                        "selectionIdentifier": "bfce357b-ba7c-4bda-b3d8-1038321d55c2"
                    }
                ],
                "name": "Crab Cake Reward",
                "quantity": 1.0,
                "selectionType": "ITEM"
            },
            {
                "amount": 0.0,
                "applicable": false,
                "expiration": [],
                "identifier": "px_120_13_1_4",
                "itemApplication": [],
                "name": "Reward Test",
                "quantity": 10.0,
                "selectionType": "ITEM"
            },
            {
                "amount": 0.0,
                "applicable": false,
                "expiration": [],
                "identifier": "px_155_22_1_2",
                "itemApplication": [],
                "name": "Appetizers Reward",
                "quantity": 5.0,
                "selectionType": "ITEM"
            }
        ],
        "rejectedRedemptions": []
    },
    "result": "success",
    "transactionStatus": "ACCEPT",
    "transactionType": "LOYALTY_INQUIRE"
}

Liz Jackson

May 13, 2021 17:54 Edited
Hi Jonathan,

Oh, I see what you mean. I just took a deeper look at our code and see that we actually convert the points balance you send into a double down the line. The points balance should display with or without applicable offers, but it does need to be a number. Sorry for confusion there. I'll edit my post above, and will make a corresponding update to our docs about the need for points balance to be a number.

Do you see a points balance when you send a numeric value?
0
Liz Jackson

May 13, 2021 21:21
Hi Jonathan,

To confirm, were you able to get the points balance to display after sending a numeric points balance? (With or without an applicable redemption in the response.)

Thanks!
0

Jonathan Watts

May 15, 2021 19:14

I am now returning a decimal balance and am seeing it displayed:

        "accountInfo": {
            "firstName": "Jonathan",
            "identifier": "17881000190019",
            "lastName": "Watts",
            "pointsBalance": "15.00"
        }

Liz Jackson

May 17, 2021 16:28
Excellent! I'm in the process of updating our documentation to clarify that pointsBalance must be numeric. The update should be in the docs within the next few days.
0
Jonathan Watts

May 17, 2021 17:23
So the implicit assumption is that the guest only has a single points balance. If the loyalty program tracked dollars spent and bagels bought for example we could only show the guest one of those. And it's always going to show up as "You have: X points". It's not possible to brand this in any way like saying "You have: X Coffee Stars".
0
Liz Jackson

May 17, 2021 20:23
That's right. That's a good call-out. I'll update our docs to reflect this info as well – glad you're finding areas that need clarification.

In a perfect world, what do you think is the ideal way the points section should display? I'll pass this feedback along to our product team.
0
Khurram Saleem

October 11, 2022 15:38
Hi .. can you please help me with Loyality Program. Im struggling to figure it out from where I can get the API End Points for this?
```
curl -i -X POST \
  https://toast-api-server/yourapiname/v1/yourendpointname \
```
0
Peter Desjardins

October 18, 2022 02:29
Khurram Saleem, in a loyalty program integration, your API implementation includes a single endpoint. You can choose any name for that single endpoint.

Does this implementation overview explain what you need?

In your implementation of the Toast loyalty integration API, you create a single HTTPS REST endpoint, named in any way you choose. For example: https://myapi.mycompany.com/myendpointname. The Toast platform sends requests to that single endpoint (host name and path) for all loyalty program transactions. You can identify the requests for specific transaction types using the Toast-Transaction-Type HTTP header parameter for each request that you receive.
0

Please sign in to leave a comment.

Loyalty API pointsBalance field

Comments

Didn't find what you were looking for?