Manage Stay Controls | SynXis Developer Portal

What is it?

The Manage Stay Control operations allow a hotelier to create, edit, delete and retrieve stay restrictions configured in Synxis CR at multiple levels e.g. hotel, product, room, room category, rate, rate category, rate category and room, rate category and room category, room upsell and coupon offer on desired stay dates.

The default rate stay controls are not date sensitive. Once set, they apply for all dates.

Why use it?

Stay Controls are used to execute revenue management strategies through restrictions that are commonly used such as closing a hotel, room type or rate; establishing minimum lengths of stay, restricting arrival and/or departure dates, oversell limits, etc. These stay controls can be configured as channel agnostic or channel specific.

How to use

Retrieve Hotel level Stay Restrictions

Specify the restriction level

Hotel: Return a list of Hotel level stay restrictions.
Rate: Return a list of Rate level stay restrictions. @rateCode is a required input parameter.
Product: Return a list of Product stay restrictions. @roomCode and @rateCode are required input parameters.
RateCategory: Return a list of Rate Category level stay restrictions. @rateCategoryCode is a required input parameter.
RoomUpsell: Return a list of Room Upsell stay restrictions. @roomCode is a required input parameter.
RoomCategoryUpsell: Return a list of Room Category Upsell stay restrictions. @roomCategoryCode is a required input parameter.
RateCategoryAndRoomCategory: Return a list of Rate Category + Room Category level stay restrictions. @rateCategoryCode and @roomCategoryCode are required input parameters.
RateCategoryAndRoom: Return a list of Rate Category + Room Type level stay restrictions. @rateCategoryCode and @roomCode are required input parameters.

Specify the Control type

IsClosed
NoArrival
NoDeparture
MinimumStayArrive
MinimumStayThrough
MaximumStayArrive
MaximumStayThrough
LeadDays
StartTime
EndTime
SameDay
MaxSellDate
SellThreshold
SellLimit
FullPatternLengthOfStayArrival
MaximumLeadDays
MinSellDate
TotalHotelSellThreshold
NoSellDay
Suspended
SeasonalClosure
ByRequestOnly

[GET] /v1/api/admin/product/stayControls?hotelId=13098&chainId=12723&channelCode=WEB&startDate=2020-12-03&endDate=2020-12-05&level=Hotel

{
    "paging": {
        "Size": 49,
        "Start": 0,
        "Total": 49
    },
    "StayControlList": [
        {
            "Hotel": {
                "Id": 13098
            },
            "Chain": {
                "Id": 12723
            },
            "Channel": {
                "Code": "WEB"
            },
            "StartDate": "2019-11-21",
            "EndDate": "2020-02-21",
            "DayofWeek": "Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday",
            "Level": "Hotel",
            "Type": "IsClosed",
            "Value": "True",
            "ValueType": "Boolean"
        },
        {
            "Hotel": {
                "Id": 13098
            },
            "Chain": {
                "Id": 12723
            },
            "Channel": {
                "Code": "WEB"
            },
            "StartDate": "2019-11-21",
            "EndDate": "2020-02-21",
            "DayofWeek": "Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday",
            "Level": "Hotel",
            "Type": "MinimumStayArrive",
            "Value": "1",
            "ValueType": "Number"
        },
        {
            "Hotel": {
                "Id": 13098
            },
            "Chain": {
                "Id": 12723
            },
            "Channel": {
                "Code": "WEB"
            },
            "StartDate": "2019-11-21",
            "EndDate": "2020-02-21",
            "DayofWeek": "Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday",
            "Level": "Hotel",
            "Type": "SellThreshold",
            "Value": "-7",
            "ValueType": "Number"
        },
        {
            "Hotel": {
                "Id": 13098
            },
            "Chain": {
                "Id": 12723
            },
            "Channel": {
                "Code": "WEB"
            },
            "StartDate": "2019-11-21",
            "EndDate": "2020-02-21",
            "DayofWeek": "Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday",
            "Level": "Hotel",
            "Type": "SellLimit",
            "Value": "4",
            "ValueType": "Number"
        }
    ],
    "ContentList": {
        "ChannelList": [
            {
                "Code": "WEB",
                "Name": "Booking Engine"
            }
        ]
    }
}

Create or Update Hotel level Stay Restrictions

[POST] /v1/api/admin/product/stayControls

{
  "criteria": {
    "chain": {
      "id": 12723
    },
    "hotel": {
      "id": 13098
    },
    "startDate": "2020-01-28",
    "endDate": "2020-02-22",
    "channelList": [
      {
        "code": "WEB"
      }
    ],
    "controlType": [
      "IsClosed"
    ],
    "dayOfWeek": [
      "M"
    ]
  },
  "valueList": [
    {
      "dayOfWeek": "M",
      "controlType": "IsClosed"
      "hotel": {
        "id": 13098
      },
      "rate": {
        "contextType": "Seasonal",
        "code": "ADV",
        "categoryCode": "DISC"
      },
      "room": {
        "code": "ROOMSP1"
      }
    }
  ]
}

Delete Stay Restrictions

[DELETE] /v1/api/admin/product/stayControls

{
  "criteria": {
    "chain": {
      "id": 12723
    },
    "hotel": {
      "id": 13098
    },
    "startDate": "2020-01-28",
    "endDate": "2020-02-22",
    "channelList": [
      {
        "code": "WEB"
      }
    ],
    "controlType": [
      "IsClosed"
    ],
    "dayOfWeek": [
      "M"
    ]
  },
  "valueList": [
    {
      "hotel": {
        "id": 13098
      },
      "rate": {
        "code": "ADV",
        "categoryCode": "DISC"
      },
      "room": {
        "code": "ROOMSP1"
      },
      "couponOffer": {
        "code": "SAVE25%"
      },
      "roomUpsell": {
        "code": "UP2"
      }
    }
  ]
}