Rate Level

Manage Stay Controls - Rate Level

The following examples show how to Create, Retrieve and Delete Stay Controls at the Rate level

For the complete list of Stay Controls Click Here.

Create/Update stay controls

Create/Update Rate level stay controls for SellLimit and MaximumStayThrough for two different rates.

{
    "criteria": {
        "startDate": "2021-08-01",
        "endDate": "2021-08-07",
        "Hotel": {
            "id": 13098
        },
        "ChannelList": [{
            "code": "ALL"
        }]
    },
    "valueList": [{
            "Rate": {
                "code": "50PCTDISC",
                "contextType": "Seasonal"
            },
            "controlType": "SellLimit",
            "dayofWeek": "M,Tu,W,Th,F,Sa,Su",
            "value": "454",
            "valueType": "Number"
        },
        {
            "Rate": {
                "code": "ADV"
            },
            "controlType": "MaximumStayThrough",
            "dayofWeek": "W",
            "value": "222",
            "valueType": "Number"
        }
    ]
}

Retrieve all stay controls

Retrieve a list of Rate level stay controls.

GET /v1/api/admin/product/stayControls?rateCode=ADV&level=Rate&hotelId=13098&startDate=2023-06-01&endDate=2023-06-07

Response

{
    "paging": {
        "Size": 4,
        "Start": 0,
        "Total": 4
    },
    "StayControlList": [{
            "Hotel": {
                "Id": 13098
            },
            "Channel": {
                "Code": "ALL"
            },
            "Rate": {
                "Code": "BAR"
            },
            "StartDate": "2023-06-01T00:00:00",
            "EndDate": "2023-06-07T00:00:00",
            "DayofWeek": "Sunday",
            "Level": "Rate",
            "Type": "MaximumStayThrough",
            "Value": "3",
            "ValueType": "Number"
        },
        {
            "Hotel": {
                "Id": 13098
            },
            "Channel": {
                "Code": "ALL"
            },
            "Rate": {
                "Code": "BAR"
            },
            "StartDate": "2023-06-01T00:00:00",
            "EndDate": "2023-06-07T00:00:00",
            "DayofWeek": "Wednesday, Thursday, Friday",
            "Level": "Rate",
            "Type": "SellLimit",
            "Value": "55",
            "ValueType": "Number"
        }
    ],
    "ContentList": {
        "ChannelList": [{
            "Code": "ALL",
            "Name": "Channel Independent"
        }],
        "RoomList": [],
        "RateList": [{
            "Code": "BAR",
            "Name": "Best Available Rate"
        }],
        "ChainList": [],
        "HotelList": [{
            "Code": "CRSPROD1",
            "ID": 13098,
            "Name": "CRS Product Management Hotel I DO NOT TOUCH"
        }],
        "CouponOfferList": [],
        "RoomUpsellList": []
    }
}

Retrieve a specified stay control

Retrieve SellLimit Rate level stay control.

GET /v1/api/admin/product/stayControls?controlType=SellLimit&rateCode=ADV&level=Rate&hotelId=13098&startDate=2023-06-01&endDate=2023-06-07

Response

{
    "paging": {
        "Size": 3,
        "Start": 0,
        "Total": 3
    },
    "StayControlList": [{
        "Hotel": {
            "Id": 13098
        },
        "Channel": {
            "Code": "ALL"
        },
        "Rate": {
            "Code": "BAR"
        },
        "StartDate": "2023-06-01T00:00:00",
        "EndDate": "2023-06-07T00:00:00",
        "DayofWeek": "Wednesday, Thursday, Friday",
        "Level": "Rate",
        "Type": "SellLimit",
        "Value": "55",
        "ValueType": "Number"
    }],
    "ContentList": {
        "ChannelList": [{
            "Code": "ALL",
            "Name": "Channel Independent"
        }],
        "RoomList": [],
        "RateList": [{
            "Code": "BAR",
            "Name": "Best Available Rate"
        }],
        "ChainList": [],
        "HotelList": [{
            "Code": "CRSPROD1",
            "ID": 13098,
            "Name": "CRS Product Management Hotel I DO NOT TOUCH"
        }],
        "CouponOfferList": [],
        "RoomUpsellList": []
    }
}

Delete a stay control

Delete the SellLimit stay control.

{
    "criteria": {
        "chain": {
            "id": 12723
        },
        "hotel": {
            "id": 13098
        },
        "startDate": "2023-06-01",
        "endDate": "2023-06-03",
        "channelList": [{
            "code": "ALL"
        }]
    },
    "valueList": [{
        "Rate": {
            "code": "BAR"
        },
        "controlType": "SellLimit"
    }]
}

Delete stay controls for multiple rates

Delete multiple stay controls by using a comma separated list.

{
    "criteria": {
        "hotel": {
            "id": 100319
        },
        "startDate": "2023-06-01",
        "endDate": "2023-06-07",
        "channelList": [{
            "code": "ALL"
        }],
        "controlType": "SellLimit,MaximumLeadDays,NoArrival"
    },
    "valueList": [{
        "Rate": {
            "code": "ADV"
        },
        "Rate": {
            "code": "BAR"
        }       
    }]
}

Delete all rate level stay controls

Delete all rate level stay controls by ommiting @controlType.

{
    "criteria": {
        "hotel": {
            "id": 100319
        },
        "startDate": "2023-06-01",
        "endDate": "2023-06-07",
        "channelList": [{
            "code": "ALL"
        }]
    },
    "valueList": [{
        "Rate": {
            "code": "ADV"
        },
        "Rate": {
            "code": "BAR"
        }       
    }]
}