Retrieve Meal Plan Supplements Price
Query Overview
The priceMealPlanSupplements query allows you to retrieve the price of specific meal plan supplements in Inventory. The returned fields include:
successmealPlanSupplementsrateCoderoomspaxTypemealPlanamountPerPaxdateRangestartend
applicableWeekdaysallmondaytuesdaywednesdaythursdayfridaysaturdaysunday
adviseMessagescodedescriptionlevelcorrelationIDexternalcodemessage
1. Criteria
When building your query, you need to provide the following input fields:
Mandatory Input
clientCodesupplierCodehotelCodemealPlanSupplementsrateCoderoomsdateRangestartend
2. Settings
This query allows retrieving prices for specific meal plan supplements by defining relevant details such as clientCode, supplierCode, hotelCode, mealPlan, rooms, and dateRange.
{
"input": {
"clientCode": "ABC123",
"supplierCode": "SUP001",
"hotelCode": "HTL567",
"mealPlanSupplements": [
{
"rateCode": "RATE001",
"rooms": ["ROOM1", "ROOM2"],
"dateRange": {
"start": "2024-03-01",
"end": "2024-03-10"
}
}
]
}
}
Response Considerations
The query returns the meal plan supplement prices along with success status and possible advise messages.
PriceMealPlanSupplementsRs (OBJECT)
mealPlanSupplements(MealPlanSupplementLoad) - List of meal plan supplements with pricing information.rateCode(String) - The rate code for the supplement.dateRange(DateRangeProduct) - Date range applied.start(DateTime) - Start date.end(DateTime) - End date.
amountPerPax(Float) - Price per passenger.paxType(Enum of InventoryPaxType) - Type of passenger (INFANT, CHILD, ADULT).
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.
Query Inputs
InventoryPriceMealPlanSupplementsInput (INPUT_OBJECT)
Retrieve meal plan supplements price query input
Retrieve meal plan supplements price query input
clientCode * (String)
Client code.
Client code.
supplierCode * (String)
Travelgate Supplier/Channel code.
Travelgate Supplier/Channel code.
mealPlanSupplements * (MealPlanSupplementRetrieveInput)
Hotel meal plan supplements input data.
Hotel meal plan supplements input data.
rateCode (String)
Rate code to be retrieved.
Rate code to be retrieved.
rooms (String)
List of rooms to be retrieved.
List of rooms to be retrieved.
dateRange (DateRangeProductInput)
Date range to apply
Date range to apply
start * (DateTime)
Start date.
Start date.
end * (DateTime)
End date.
End date.
hotelCode * (String)
Code associated with the hotel.
Code associated with the hotel.
contextCode (String)
Context code.
Context code.
Returned Fields
PriceMealPlanSupplementsRs (OBJECT)
Represents the response data for meal plan supplements price operations.
Represents the response data for meal plan supplements price operations.
mealPlanSupplements (MealPlanSupplementLoad)
List of meal plan supplements prices. See MealPlanSupplementLoad.
List of meal plan supplements prices. See MealPlanSupplementLoad.
rateCode (String)
Code associated with the rate.
Code associated with the rate.
rooms (String)
List of room codes associated with the meal plan supplement.
List of room codes associated with the meal plan supplement.
applicableWeekdays (ApplicableWeekdays)
Weekdays when the meal plan supplement is applicable. See ApplicableWeekdays.
Weekdays when the meal plan supplement is applicable. See ApplicableWeekdays.
all (Boolean)
Indicates whether the price or rate is applicable on all days.
Indicates whether the price or rate is applicable on all days.
monday (Boolean)
Indicates whether the price or rate is applicable on Mondays.
Indicates whether the price or rate is applicable on Mondays.
tuesday (Boolean)
Indicates whether the price or rate is applicable on Tuesdays.
Indicates whether the price or rate is applicable on Tuesdays.
wednesday (Boolean)
Indicates whether the price or rate is applicable on Wednesdays.
Indicates whether the price or rate is applicable on Wednesdays.
thursday (Boolean)
Indicates whether the price or rate is applicable on Thursdays.
Indicates whether the price or rate is applicable on Thursdays.
friday (Boolean)
Indicates whether the price or rate is applicable on Fridays.
Indicates whether the price or rate is applicable on Fridays.
saturday (Boolean)
Indicates whether the price or rate is applicable on Saturdays.
Indicates whether the price or rate is applicable on Saturdays.
sunday (Boolean)
Indicates whether the price or rate is applicable on Sundays.
Indicates whether the price or rate is applicable on Sundays.
paxType * (Enum of InventoryPaxType)
Type of passenger for the meal plan supplement. See PaxType.
Possible values:
INFANT
CHILD
ADULT
Type of passenger for the meal plan supplement. See PaxType.
Possible values:
INFANTCHILDADULTmealPlan * (Int)
Meal plan associated with the supplement.
Meal plan associated with the supplement.
amountPerPax * (Float)
Amount per passenger for the meal plan supplement.
Amount per passenger for the meal plan supplement.
dateRange (DateRangeProduct)
Date range to apply
Date range to apply
start * (DateTime)
Start date.
Start date.
end * (DateTime)
End date.
End date.
adviseMessages (AdviseMessage)
List of advise messages associated with the operation. See AdviseMessage.
List of advise messages associated with the operation. See AdviseMessage.
code * (ID)
AM code: The following codes can be returned:
AM code: The following codes can be returned:
description * (String)
Error description
Error description
level * (Enum of AdviseMessageLevel)
Indicates the level of importance of the message.
Possible values: ERROR, WARN, INFO.
Possible values:
WARN
ERROR
INFO
Indicates the level of importance of the message. Possible values: ERROR, WARN, INFO.
Possible values:
WARNERRORINFOexternal (ExternalMessage)
Specify the external message.
Specify the external message.
code (String)
External code.
External code.
message * (String)
External message.
External message.
correlationID * (ID)
Identifier to investigate the cause of the error.
Identifier to investigate the cause of the error.
success * (Boolean)
Indicates whether the operation was successful.
Indicates whether the operation was successful.
Examples
Retrieve price for a specific meal plan supplement
With this example, we are going to retrieve the price for a specific meal plan supplement within a specific date range.
Retrieve price for multiple meal plan supplements
In this example, we are going to retrieve the price for multiple meal plan supplements for more than one room and a specific rate within a certain date range.