v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the loyalty points history of a guest

This API helps you to retrieve the loyalty points history of the specified guest.

You must specify the unique identifier of the guest as guest_id in the API request. You can also leverage the pagination feature by passing page_num and num_records query parameters if you have a large number of records to be displayed. By default, page_num is set as 1 and num_records is set as 10. num_records cannot be more than 100: which means that the maximum records per page cannot be more than 100.

get/v1/guests/{guestId}/points?view_grooming_points={view_grooming_points}&page_num={page_num}&num_records={num_records}&expand[0]={expand[0]}

Path parameters

guestidstring required

Unique identifier of the guest for whom we are retrieving the loyalty points.

Query parameters

view_grooming_pointsinteger

Optional Indicates whether grooming-related LPs are to be viewed.

page_numinteger

Optional Number of the display page. Default value is 1.

num_recordsinteger

Optional Number of records per page. Default value is 10.

sort_ascendingboolean

Optional Indicates whether the displayed records are to be sorted in ascending order. Default value is true.

Response

200

{"stackTrail":"paths:/v1/guests/{guestId}/points?view_grooming_points={view_grooming_points}&page_num={page_num}&num_records={num_records}&expand[0]={expand[0]}:get:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "guest_points": {
    "balance_points": 35,
    "balance_amount": 35,
    "exchange_rate": 1,
    "guest_points_details": [
      {
        "earned_on": "2019-05-06T00:00:00",
        "program": "Manually Added",
        "points_earned": 15,
        "balance": 15,
        "redemption_end": "2019-05-16T00:00:00",
        "center": "South Granville's"
      }
    ]
  }
}