Load Meal Plan Supplements Price

Mutation Overview

The loadPriceMealPlanSupplements mutation allows you to load the price of meal plan supplements in Inventory. The returned fields include:

success
mealPlanSupplements
- rateCode
- rooms
- paxType
- mealPlan
- amountPerPax
- dateRange
  - start
  - end
- 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
mealPlanSupplements
- rateCode
- paxType
- mealPlan
- amountPerPax
- rooms
- dateRange
  - start
  - end

2. Settings

This mutation allows loading prices for specific meal plan supplements by defining relevant details such as clientCode, supplierCode, hotelCode, mealPlan, amountPerPax, and dateRange.

{
  "input": {
    "clientCode": "ABC123",
    "supplierCode": "SUP001",
    "hotelCode": "HTL567",
    "mealPlanSupplements": [
      {
        "rateCode": "RATE001",
        "paxType": "ADULT",
        "mealPlan": 3,
        "amountPerPax": 25.00,
        "rooms": ["ROOM1", "ROOM2"],
        "dateRange": {
          "start": "2024-03-01",
          "end": "2024-03-10"
        }
      }
    ]
  }
}

Response Considerations

The mutation returns the processed 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.

Mutation Inputs

InventoryLoadPriceMealPlanSupplementsInput (INPUT_OBJECT)
Load price meal plan supplements mutation input

clientCode * (String)
Client code.

supplierCode * (String)
Travelgate Supplier/Channel code.

mealPlanSupplements * (MealPlanSupplementLoadInput)
Hotel meal plan supplements input data.

rateCode (String)
Code associated with the rate.

rooms (String)
List of room codes associated with the meal plan supplement.

applicableWeekdays (ApplicableWeekdaysInput)
Weekdays when the meal plan supplement 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.

paxType * (Enum of InventoryPaxType)
Type of passenger for the meal plan supplement. See PaxType.
Possible values:
INFANT
CHILD
ADULT

mealPlan * (Int)
Meal plan associated with the supplement.

amountPerPax * (Float)
Amount per passenger for the meal plan supplement.

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

PriceMealPlanSupplementsRs (OBJECT)
Represents the response data for meal plan supplements price operations.

mealPlanSupplements (MealPlanSupplementLoad)
List of meal plan supplements prices. See MealPlanSupplementLoad.

rateCode (String)
Code associated with the rate.

rooms (String)
List of room codes associated with the meal plan supplement.

applicableWeekdays (ApplicableWeekdays)
Weekdays when the meal plan supplement is applicable. See ApplicableWeekdays.