Skip to main content

Retrieve Rate Price

The priceRates query allows you to retrieve the price of specific rates in the Inventory.

Query Fields​

  • success
  • rates
    • rateCode
    • currency
    • rooms
    • dateRange
      • start
      • end
    • prices
      • pricePerRoom
        • amount
        • additionalGuestsSupplements
          • additionalAdults
            • additionalGuestType
            • guestPosition
            • amount
            • type
          • additionalChildren
            • additionalGuestType
            • guestPosition
            • amount
            • type
          • additionalInfants
            • additionalGuestType
            • guestPosition
            • amount
            • type
      • pricePerStandardOccupancy
        • amount
        • pricesUnderStandardOccupancy
          • amount
          • guests
        • additionalGuestsSupplements
          • additionalAdults
            • additionalGuestType
            • guestPosition
            • amount
            • type
          • additionalChildren
            • additionalGuestType
            • guestPosition
            • amount
            • type
          • additionalInfants
            • additionalGuestType
            • guestPosition
            • amount
            • type
      • pricesPerOccupancy
        • prices
          • amount
          • numberOfAdults
          • numberOfChildren
          • numberOfInfants
    • applicableWeekdays
      • all
      • monday
      • tuesday
      • wednesday
      • thursday
      • friday
      • saturday
      • sunday
  • adviseMessages
    • code
    • description
    • level
    • correlationID
    • external
      • code
      • message

Returned Field Explanations​

  • success: A boolean that indicates whether the query was successful.
  • rates: The details of the rates for which the price was retrieved. It includes the rateCode of the rate, the rooms available, and the prices.
  • rateCode: The code of the rate for which the price is being retrieved.
  • currency: The currency in which the price is being retrieved.
  • rooms: The number of rooms available for the rate.
  • dateRange: The date range during which the conditions will be applied. It includes the start and end dates.
  • prices: This field contains the price details for the rate. It includes the pricePerRoom, pricePerStandardOccupancy, and pricesPerOccupancy.
  • applicableWeekdays: The days of the week for which the price is being retrieved. It includes the all, monday, tuesday, wednesday, thursday, friday, saturday, and sunday fields.
  • adviseMessages: An array of messages that provide information about the query. Each message includes a code, description, level, correlationID, and external fields, which indicate whether the message is internal or external and provide the code and message of the external message.

Query Inputs​

When building your priceRates query, you have 1 input to fill based on your specific needs:

  1. Criteria

1. Criteria​

This query will allow you to enter specific details in the fields clientCode, supplierCode, rates, and hotelCode to retrieve the price of specific rates.

Mandatory input

  • clientCode
  • supplierCode
  • hotelCode
  • rates
    • rateCode
    • dateRange
      • start
      • end

Field Explanations​

  • clientCode, supplierCode, hotelCode: These fields identify the client, supplier, and hotel for which the rate price is being retrieved.
  • rates: This field contains the details of the rates for which the price is being retrieved. It includes the rateCode of the rate and the dateRange for which the price is being retrieved.
  • dateRange: This field specifies the date range for which the price is being retrieved.

Requests Examples​

Retrieve price for a specific rate​

With this example, we are going to retrieve the price for a specific rate within a specific date range.

Retrieve price for multiple rates​

With this example, we are going to retrieve the price for multiple rates within a specific date range.