Rates & Inventory Logs (Future Date)

The Rates & Inventory Log call is used to retrieve the information on Rates & Inventory (availability) for the property for specified Room Type and its related Rate Plan for requested future date range.

---

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/invratedetails  

Mandatory elements

Element name - request

Description	The request element is the root of every rate and inventory listing call.
Type	structural element
Children	n/a

Attribute Name

Attribute	Description
hotelid / hotel_id / Client ID	IT provider's hotel id for which retrieving rates and inventory logs.
roomid / room_id / ListingID	Provided property's Room Type Id for which retrieving rates and inventory logs.
rateplanid / rate_id	Provided property's Rate Plan Id related to room type for which retrieving rates and inventory logs.

Attribute Name - hotelid/ hotel_id / ClientID

Description	IT provider's unique hotel id / Client id.
Type	alphanumeric
Constraints	needs to be a property registered in the STAAH (Existing)
Amount of elements possible within parent	1

Attribute Name - roomid / room_id / ListingID

Description	IT providers' unique room id / listing id.
Type	alphanumeric
Constraints	needs to be an active room type in the STAAH system for property
Amount of elements possible within parent	Min:1 Max:unbounded

Element name - rateplanid / rate_id

Description	IT provider's rate plan ID associated with room type
Type	alphanumeric
Constraints	rate plan related to room type for property
Amount of elements possible within parent	Min:1 Max:unbounded
Format Parent	date

Element name - date

Description	Specifying a value in requests will give log for entire range given as value.
Type	datetime
Constraints	only current date to max up to 730 days in the future
Amount of elements possible within parent	Min:0 Max:1
Format	YYYY-MM-DD

Attribute Name - from

Description	Specifying a range in requests will get the log of date from and including the date specified.
Type	datetime
Constraints	only current date to max upto 730 days in the future
Amount of elements possible within parent	Min:0 Max:1
Format	YYYY-MM-DD

Attribute Name - to

Description	Specifying a range in requests will get the log of date until and including the date specified.
Type	datetime
Constraints	only current date to max upto 730 days in the future
Amount of elements possible within parent	Min:0 Max:1
Format	YYYY-MM-DD

---

Sample Request

Please find an example input message below:

{
   "hotelid": "65",
   "roomid": "293",
   "rateplanid": "2655:4158",
   "date": {
      "from": "2019-03-06",
      "to": "2019-10-02"
   }
}

---

Response

Response Model — No Rates and Inventory Found

In the case where there is no rates or inventory found for provider based on the parameters provided.

{
  "Status": "Fail",
  "Errors": {
    "Code": "952",
    "ShortText": "Inventory not found"
  }
}

Success

{
  "RateInventories": [
    {
      "date": "2019-03-06",
      "inventory": "1",
      "rate": [
        {
          "NumberOfGuests": "1",
          "rate": "300.0000"
        },
        {
          "NumberOfGuests": "4",
          "rate": "300.0000"
        }
      ]
    },
    {
      "date": "2019-03-07",
      "inventory": "1",
      "rate": [
        {
          "NumberOfGuests": "1",
          "rate": "300.0000"
        },
        {
          "NumberOfGuests": "4",
          "rate": "300.0000"
        }
      ]
    },
    {
      "date": "2019-03-08",
      "inventory": "1",
      "rate": [
        {
          "NumberOfGuests": "1",
          "rate": "300.0000"
        },
        {
          "NumberOfGuests": "4",
          "rate": "300.0000"
        }
      ]
    }
  ]
}

Errors

Errors due to invalid parameters

Error - 400

{
  "Status": "Fail",
  "Errors": {
    "Code": "400",
    "ShortText": "Invalid HotelCode (6)"
  }
}

---

This error will be received if allocated with incorrect Hotel id / Client id.

Error - 941

{
  "Status": "Fail",
  "Errors": {
    "Code": "941",
    "ShortText": "Invalid Room Id"
  }
}

---

This error will be received if provided with incorrect Room Type id / listing id.

Error - 942

{
  "Status": "Fail",
  "Errors": {
    "Code": "942",
    "ShortText": "Invalid Rate Id"
  }
}

---

This error will be received if provided incorrect Rate Plan id.

Error - 945

{
  "Status": "Fail",
  "Errors": {
    "Code": "945",
    "ShortText": "Date must be present or future"
  }
}

---

This error will be received if allocated incorrect value in date field. Date must be of current or future date.

Error - 946

{
  "Status": "Fail",
  "Errors": {
    "Code": "946",
    "ShortText": "To date must be greater than from date"
  }
}

---

To date value must be equal or greater than from date value.

Error - 935

{
  "Status": "Fail",
  "Errors": {
    "Code": "935",
    "ShortText": "Invalid date or format must be 'YYYY-MM-DD'"
  }
}

---

Date format must be YYYY-MM-DD.

Error - 921

{
  "Status": "Fail",
  "Errors": {
    "Code": "921",
    "ShortText": "Date: value should be less than 730 days from current date"
  }
}

---

Date range value must be within 730 days of future date counting from current date.