Skip to main content

Cheapest Price

The Cheapest Price plugin allows you to find the most affordable choice among your Suppliers using various aggregation criteria. This means you can, for example, aggregate the supplier options to discover the least expensive choice for each meal plan and hotel, or even the most budget-friendly option for each hotel, supplier, and room.

note

You don't need to create any files for this plugin. Just specify it in the settings > plugins field in your search query.

1. Execute Cheapest Price Plugin in your Query​

To use the plugin add the following field to the settings node of your request. Note that cheapest price plugin can just be executed in search query. In order to successfully execute the cheapest price plugin, you will need to create the request with the following variables.

  • step: "RESPONSE"
  • type: "PRE_STEP"
  • name: "cheapest_price"
  • parameters:

    • primaryKey: Criteria used to aggregate, separated by commas. For example: "hotel, supplier, board". Possible values are:

      • hotel
      • supplier
      • board
      • binding
      • cancelPolicy
      • currency
      • market
      • payment
      • promotion
      • rateRules
      • refundable
      • room
      • supplement
      • surcharges
      • ratePlan
      • status

    • optionsPerKey: Limits the number of options per aggregation group, this being defined by the previous primakyKey parameter. Value: Integer.

Remember

primaryKey is a mandatory parameter in order to activate the plugin. optionsPerKey is optional and complementary of the first.

For instance, if you want to find the most affordable option for each hotel, supplier, and room:

"settings": {
    "plugins" : [
        {
            "step" : "RESPONSE",
            "pluginsType" : [
                {
                    "type" : "PRE_STEP",
                    "name" : "cheapest_price",
                    "parameters" : [
                        {
                            "key" : "primaryKey",
                            "value" : "hotel,supplier,room"
                        },
                        {
                            "key" : "optionsPerKey",
                            "value" : "1"
                        }
                    ]
                }
            ]
        }
    ]
}

Special Aggregation Key: eqRates​

There is a special value for the aggregation key "eqRates" that will combine the rateRules and ratePlans of an option and group all of the options, based on the file uploaded in the SFTP with the name:

sftp.xmltravelgate.com

📁HotelX
     📁HotelX_0000
         📁BusinessRules
             **📄SupplierContext_rateplanraterule.csv **

With this uploaded CSV file, all the options with the ratePlan code "NOREEMBOLSABLE" and no rateRules will be compared with each other. Similarly, all the options without a ratePlan code or without a mapped ratePlan and with rateRules set to "NON_REFUNDABLE" will also be compared with each other.