Skip to main content

Load Rate Availability

The loadAvailRates mutation allows you to load the availability of specific rates in the Inventory.

Mutation Fields​

  • success
  • rates
    • rateCode
    • dateRange
      • start
      • end
    • rooms
    • restrictions
      • bookingLimit
      • minRelease
      • maxRelease
      • freeSales
      • lengthOfStay
        • fullStay
          • minimum
          • maximum
        • arrival
          • minimum
          • maximum
      • stopSales
        • closeMaster
        • closeOnArrival
        • closeOnDeparture
    • 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 mutation was successful.
  • rates: The details of the rates for which the availability was loaded. It includes the rateCode of the rate, the rooms available, and any restrictions.
  • restrictions: This field contains conditions that can restrict the availability of the rate.
    • bookingLimit: The maximum number of rooms that can be booked.
    • minRelease: The minimum number of days before the arrival date that the rate can be booked.
    • maxRelease: The maximum number of days before the arrival date that the rate can be booked.
    • freeSales: A boolean that indicates whether the rate is available for free sale.
    • lengthOfStay: The minimum and maximum length of stay for the rate.
    • stopSales: This field contains conditions that can restrict the availability of the rate.
      • closeMaster: A boolean that indicates whether the rate is closed for the entire date range.
      • closeOnArrival: A boolean that indicates whether the rate is closed on arrival.
      • closeOnDeparture: A boolean that indicates whether the rate is closed on departure.
  • dateRange: The date range during which the conditions will be applied. It includes the start and end dates.
  • adviseMessages: An array of messages that provide information about the mutation. 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.

Mutation Inputs​

When building your loadAvailRates mutation, you have 1 input to fill based on your specific needs:

  1. Criteria

1. Criteria​

This mutation will allow you to enter specific details in the fields clientCode, supplierCode, rates, and hotelCode to load the availability of specific rates.

Mandatory input

  • clientCode
  • supplierCode
  • hotelCode
  • rates
    • rateCode
    • rooms
    • restrictions
      • bookingLimit
      • lengthOfStay
        • fullStay
          • minimum
          • maximum
        • arrival
          • minimum
          • maximum
      • minRelease
      • maxRelease
    • dateRange
      • start
      • end

Field Explanations​

  • clientCode, supplierCode, hotelCode: These fields identify the client, supplier, and hotel for which the rate availability is being loaded.
  • rates: This field contains the details of the rates for which the availability is being loaded. It includes the rateCode of the rate, the rooms available, and any restrictions.
  • restrictions: This field contains conditions that can restrict the availability of the rate.
    • bookingLimit: The maximum number of rooms that can be booked.
    • minRelease: The minimum number of days before the arrival date that the rate can be booked.
    • maxRelease: The maximum number of days before the arrival date that the rate can be booked.
    • freeSales: A boolean that indicates whether the rate is available for free sale.
    • lengthOfStay: The minimum and maximum length of stay for the rate.
    • stopSales: This field contains conditions that can restrict the availability of the rate.
      • closeMaster: A boolean that indicates whether the rate is closed for the entire date range.
      • closeOnArrival: A boolean that indicates whether the rate is closed on arrival.
      • closeOnDeparture: A boolean that indicates whether the rate is closed on departure.
  • dateRange: This field specifies the date range during which the conditions will be applied.

Requests Examples​

Load availability for a specific rate​

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