Bulk Rates & Inventory Logs (Future Date)

The Bulk Rates & Inventory Log call is used to retrieve the information on Rates & Inventory (availability) for specific property for requested future date range.


Endpoint

POST

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

Sample Request (Specific Date Range)

Please find an example input message below.

{
  "hotelid": "KN-2",
  "date": {
    "from": "2021-02-24",
    "to": "2021-02-24"
  }
}

Sample Request (Full Year)

Please find an example input message below.

 {
  "hotelid": "KN-2",
  "fullyear": "1"
}

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 / ClientID

IT provider's hotel id for which retrieving rates and inventory logs.

date

Provide date range of future. Max 90 days of date range allowed per request

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

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

Element name - fullyear

Description
The element to get full year's rates & inventory log (every rate and room type - for a year starting from today).

Type

numeric (Accepted Value: 1)

Children

n/a

Response (Specific Date Range)

Response Model

Success Response

{
  "2021-02-19": {
    "11": {
      "inventory": "10",
      "rateplan": {
        "547": {
          "stopsell": false,
          "closedonarrival": false,
          "closedondeparture": false,
          "minimumstay": "1",
          "maximumstay": "30",
          "rate": [
            {
              "guest": "2",
              "rate": "2000"
            }
          ]
        },
        "548": {
          "stopsell": false,
          "closedonarrival": false,
          "closedondeparture": false,
          "minimumstay": "1",
          "maximumstay": "30",
          "rate": [
            {
              "guest": "2",
              "rate": "2000"
            }
          ]
        }
      }
    },
    "12": {
      "inventory": "10",
      "rateplan": {
        "547": {
          "stopsell": false,
          "closedonarrival": false,
          "closedondeparture": false,
          "minimumstay": "1",
          "maximumstay": "30",
          "rate": [
            {
              "guest": "3",
              "rate": "2200"
            }
          ]
        },
        "548": {
          "stopsell": false,
          "closedonarrival": false,
          "closedondeparture": false,
          "minimumstay": "1",
          "maximumstay": "30",
          "rate": [
            {
              "guest": "3",
              "rate": "2200"
            }
          ]
        }
      }
    }
  }
}

Response (Full Year)

Response Model

Result will include property's all room and rate plan combination ARI data for an entire year starting from current date.

Success Response

7P1bb+NcliyK/pd6rgQ4r5xcb7TFz1YlLSUoZiaMjfPQOLvPwQLWZaNXrw0cbNR/
P5ZtUWN68qK8iBGqnG+vPwQLWZaNV.....................
7P1bb+NcliyK/pd6rgQ4r5xcb7TFz1YlLSUoZiaMjfPQfPQOLvPwBd6rgQ4r5xcb7TFz1YlLSUoZiaMjfPQOLvPwQLWZ
  • The response for Full Year Data will be both encoded and Zipped

  • The result must be decoded using Base 64

  • The decoded result than must be unzipped

  • Decoded and Unzipped result will be in exact format as of the specific date range API call

Errors Response


Errors due to invalid parameters (400)

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

Error - 975

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

{
  "Errors": {
    "Code": "975",
    "ShortText": "Date: range should be less than 90 days"
  },
  "Status": "Fail"
}

Error - 943

This error will be received if provided with larger range than 90 days.

{
  "Errors": {
    "Code": "943",
    "ShortText": "Enter From Date"
  },
  "Status": "Fail"
}

This error will be received if not allocated with date/s.

Last updated

Was this helpful?