Load Rate Price Per Standard Occupancy

Mutation Overview

The loadPriceRates mutation allows you to load the price of specific rates per standard occupancy in Inventory. The returned fields include:

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

1. Criteria

When building your mutation, you need to provide the following input fields:

Mandatory Input

clientCode
supplierCode
hotelCode
rates
- rateCode
- currency
- rooms
- prices
  - pricePerStandardOccupancy
    - amount
    - pricesUnderStandardOccupancy
      - guests
      - amount
    - additionalGuestsSupplements
      - additionalAdults
        
        additionalGuestType
        
        guestPosition
        
        amount
        
        type
      - additionalChildren
        
        additionalGuestType
        
        guestPosition
        
        amount
        
        type
      - additionalInfants
        
        additionalGuestType
        
        guestPosition
        
        amount
        
        type
- dateRange
  - start
  - end

note

AdditionalGuestsSupplements: There is a limitation of up to three additional passengers for the different age groups: adult, child, and infant.

2. Settings

This mutation allows loading rate prices per standard occupancy by defining relevant details such as clientCode, supplierCode, hotelCode, rooms, prices, and dateRange.

{
  "input": {
    "clientCode": "ABC123",
    "supplierCode": "SUP001",
    "hotelCode": "HTL567",
    "rates": [
      {
        "rateCode": "RATE001",
        "currency": "USD",
        "rooms": ["ROOM1", "ROOM2"],
        "prices": {
          "pricePerStandardOccupancy": {
            "amount": 150.0,
            "pricesUnderStandardOccupancy": [
              {
                "guests": 2,
                "amount": 120.0
              }
            ],
            "additionalGuestsSupplements": {
              "additionalAdults": [
                {
                  "additionalGuestType": "ADULT",
                  "guestPosition": 1,
                  "amount": 30.0,
                  "type": "ADDITIVE"
                }
              ],
              "additionalChildren": [
                {
                  "additionalGuestType": "CHILD",
                  "guestPosition": 1,
                  "amount": 20.0,
                  "type": "ADDITIVE"
                }
              ]
            }
          }
        },
        "dateRange": {
          "start": "2024-03-01",
          "end": "2024-03-10"
        }
      }
    ]
  }
}

Response Considerations

The mutation returns the loaded rate prices along with success status and possible advise messages.

`PriceRatesRs` (OBJECT)

rates (RatePriceLoad) - List of rate prices with details.
- rateCode (String) - The rate code for the price.
- currency (String) - The currency used.
- dateRange (DateRangeProduct) - Date range applied.
  - start (DateTime) - Start date.
  - end (DateTime) - End date.
- prices (PricePerStandardOccupancy) - Price details per standard occupancy.
  - amount (Float) - Price amount.
  - pricesUnderStandardOccupancy (Array) - Prices per guest.
  - additionalGuestsSupplements (AdditionalGuestsSupplements) - Additional guest pricing.
success (Boolean) - Indicates whether the operation was successful.
adviseMessages (AdviseMessage) - Messages related to the operation.
- code (ID) - AM code.
- type (String) - Error type.
- description (String) - Error description.
- level (Enum of AdviseMessageLevel) - Importance level (ERROR, WARN, INFO).
- external (ExternalMessage) - External message details.
- correlationID (ID) - Identifier for debugging.

Mutation Inputs

InventoryLoadPriceRatesInput (INPUT_OBJECT)
Load price rates mutation input

clientCode * (String)
Client code.

supplierCode * (String)
Travelgate Supplier/Channel code.

rates * (RatePriceLoadInput)
Hotel rates input data.

rateCode (String)
Code associated with the rate.

currency * (Currency)
Currency of the rate price. See Currency.

applicableWeekdays (ApplicableWeekdaysInput)
Weekdays when the rate price is applicable. See ApplicableWeekdays.

all (Boolean)
Indicates whether the price or rate is applicable on all days.

monday (Boolean)
Indicates whether the price or rate is applicable on Mondays.

tuesday (Boolean)
Indicates whether the price or rate is applicable on Tuesdays.

wednesday (Boolean)
Indicates whether the price or rate is applicable on Wednesdays.

thursday (Boolean)
Indicates whether the price or rate is applicable on Thursdays.

friday (Boolean)
Indicates whether the price or rate is applicable on Fridays.

saturday (Boolean)
Indicates whether the price or rate is applicable on Saturdays.

sunday (Boolean)
Indicates whether the price or rate is applicable on Sundays.

rooms (String)
List of rooms associated with the rate price.

prices (PricesLoadInput)
Prices to be loaded. See PricesLoad.

pricePerRoom (PricePerRoomInput)
Price per room. See PricePerRoom.

amount * (Float)
Amount associated with the room. This is the price for the room.

additionalGuestsSupplements (AdditionalGuestsSupplementsInput)
Price supplements for additional passengers. See AdditionalGuestsSupplements.

additionalAdults (AdditionalGuestInput)
List of additional adults. See AdditionalGuest.

additionalGuestType * (Enum of AdditionalGuestType)
Type of the additional guest. See AdditionalGuestType.
Possible values:
ADULT
CHILD
INFANT

guestPosition * (Int)
Position of the guest.

amount * (Float)
Amount associated with the additional guest.

type (Enum of AmountApplyType)
Type of the amount application. See AmountApplyType.
Possible values:
PERCENTAGE
ADDITIVE
ABSOLUTE

pricePerStandardOccupancy (PricePerStandardOccupancyInput)
Price per standard occupancy. See PricePerStandardOccupancy.

amount * (Float)
Amount associated with the standard occupancy of the room. This is the price for the standard guests.

pricesUnderStandardOccupancy (PriceUnderStandardOccupancyInput)
List of prices for passengers under the standard occupancy. See PriceUnderStandardOccupancy.

amount * (Float)
Amount associated with the occupancy of the room. This is the price for the guests.

guests * (Int)
Number of guests for occupancy.

pricesPerOccupancy (PricesPerOccupancyInput)
Prices per occupancy. See PricesPerOccupancy.

prices (PricePerOccupancyInput)
List of prices per occupancy. See PricePerOccupancy.

amount * (Float)
Amount associated with the occupancy. This is the price for the occupancy.

numberOfAdults * (Int)
Number of adults in the occupancy.

numberOfChildren (Int)
Number of children in the occupancy.

numberOfInfants (Int)
Number of children in the occupancy.

dateRange (DateRangeProductInput)
Date range to apply

start * (DateTime)
Start date.

end * (DateTime)
End date.

hotelCode * (String)
Code associated with the hotel.

contextCode (String)
Context code.

Returned Fields

PriceRatesRs (OBJECT)
Represents the response data for rates price operations.

rates (RatePriceLoad)
List of rates prices. See RatePriceLoad.

rateCode (String)
Code associated with the rate.

currency * (Currency)
Currency of the rate price. See Currency.

applicableWeekdays (ApplicableWeekdays)
Weekdays when the rate price is applicable. See ApplicableWeekdays.