Loyalty Rates

A chain with a Loyalty Program may choose to create Loyalty specific rates. The rates could provide a discount (i.e. 10% off BAR) or provide the ability to use points as a form of payment. Rates associated with a loyalty program and level are considered protected and not accessible unless the matching loyalty program and level are included in the request.

Parameter	Description	Type
loyaltyProgram	Loyalty program code	String
loyaltyLevel	Code associated with a loyalty program level (i.e. SILVER, GOLD, PLATINUM)	[String]
onlyCheckRequested	If true, the system will only check for product availability based upon the requested parameters.	Boolean

Samples Request

A chain has a loyalty program code of 'MyLoyalty' and assigned the rate code 'GoldRt' to the loyalty level of 'GOLD'. To check availability for this rate, loyaltyProgram=MyLoyalty&loyaltyLevel=GOLD must be included in the request.

Note: The request must include content=full for the response to include the contentLists node

/v1/api/hotel/availability?hotelId=100319&chainId=14161022&adults=2&startDate=2022-12-17&endDate=2022-12-20&numRooms=1&primaryChannel=WEB&secondaryChannel=WEB&adults=2&onlyCheckRequested=true&content=full&loyaltyProgram=MyLoyalty&loyaltyLevel=GOLD

Response (partial)

Response attributes related to Loyalty rates.

Parameter	Description	Type
contentLists/RateList/Details/CustLoyaltyList	Contains information for loyalty programs assigned to the rate.	[Array]
contentLists/RateList/Details/CustLoyaltyList/@Name	Name of the loyalty program	String
contentLists/RateList/Details/CustLoyaltyList/@ProgramID	Code associated to the loyalty program	String
contentLists/RateList/Details/CustLoyaltyList/Level/@Code	Code associated to a loyalty program level	String
contentLists/RateList/Details/CustLoyaltyList/Level/@Name	Name associated to a loyalty program level	String
contentLists/RateList/Details/Indicators/@Loyalty	If true, indicates that the rates is assigned to a loyalty program and level	Boolean
productAvailability/Prices/Product/@Ref	Reference type for the price. If this is a loyalty rate then the value will be Loyalty. Values: AccessCode, AccessGeoLocation, Agent, ChannelizedRateAccessCode, Corporate, Group, Loyalty, Rate, RateClass, RateFilter, Room, RoomFeature, Template	String
productAvailability/Prices/Product/@RefValue	Reference for the price. For Loyalty rates, this value will be the Loyalty Program.	String

{
    "contentLists": {
        "RateList": [
            {
                "Details": {
                    "Description": "Gold Reward Rate",
                    "CustLoyaltyList": [
                        {
                            "Level": [
                                {
                                    "Code": "GOLD",
                                    "Name": "Gold Level Membership"
                                }
                            ],
                            "Name": "Thank You Rewards!",
                            "ProgramID": "MyLoyalty"
                        }
                    ],
                    "DetailedDescription": "Gold Level Reward Rate",
                    "DisplayName": "Gold Reward Rate",
                    "Indicators": {
                        "Loyalty": true
                    },
                    "RateClass": "Promotional"
                },
                "Code": "GoldRt",
                "CurrencyCode": "USD",
                "Name": "Gold Reward Rate"
            }
        ]
    },
    "productAvailability": {
        "Prices": [
            {
                "Product": {
                    "CommissionPolicy": {},
                    "BookingPolicy": {},
                    "CancelPolicy": {},
                    "Prices": {},
                    "Rate": {
                        "Code": "GoldRt"
                    },
                    "Room": {
                        "Code": "DElQUE"
                    },
                    "MealPlanList": [],
                    "StayLimits": {},
                    "Ref": "Loyalty",
                    "RefValue": "MyLoyalty"
                },
                "Available": true,
                "AvailableInventory": 22
            }
        ]
    }
}

Note: Loyalty rates are easily identified in the response by looking for contentLists/RateList/Details/Indicators/@Loyalty=true