Guides
English
Guides
  1. Documentation
  2. Search API 2.0
  3. API reference

The extra parameters

  • The following table shows the possible values that you can pass in the features.extra field of the Search 2.0 API request.
extra request field valueExtra response node added/affectedDescription
HOTEL_CONTENTproperties[].content.nameLocalized hotel name
ROOM_CONTENTrooms[].content.nameLocalized room name
RATE_DETAILoffers[].capacityAllowed capacity for room rate with normal and extra bed counts.
offers[].isRoomTypeGuaranteedA boolean indicating if the room type is guaranteed with rate.
offers[].remainingRoomCountNumber of rooms available with rate.
offers[].payment.modelPayment model. See the API reference to learn more.
SURCHARGE_DETAILpricing.*.surchargeItemized surcharge details. See the API reference to learn more.
definitions.surcharges[]The surcharges array will be populated to reflect the possible surcharge ID/name dictionary.
CANCELLATION_DETAILoffers[].policies.cancellationCancellation details.
See the API reference to learn more.
BENEFIT_DETAILoffers[].benefits[]Rate benefits.
DAILY_RATEpricing.display.dailyRates[]Nightly rate breakdown per date.
Useful for multi-night stays to show nightly price variations.
TAX_DETAILpricing.*.price.tax.breakdown[]Itemized taxes breakdown for the rate
pricing.*.price.fees.breakdown[]Itemized fees breakdown for the rate
definitions.taxes,definitions.fees[]These data arrays will be populated to reflect the possible taxes/fees ID and names dictionary.
PROMOTION_DETAILdefinitions.promotions[]This array will be populated to reflect the possible promotions ID/names dictionary if promotions are available
META_SEARCHoffer.landingUrlDeeplink URL
freeCancellation.beforeDateTimeThe date until which free cancellation is allowed, if applicable.
payment.isPayAtPropertyIf pay at property is allowed.
CROSSEDOUT_DETAILprice.strikeThroughRateStrikethrough price details.
PER_BOOK_RATEpricing.display.perBasis[]APER_BOOK basis entry depicting the booking total price breakdown
PER_NIGHT_RATEpricing.display.perBasis[]A PER_NIGHT basis entry depicting the average per-night price breakdown
PER_ROOM_RATEpricing.display.perBasis[]A PER_ROOM basis entry depicting the per-room price breakdown
PER_ROOM_PER_NIGHT_RATEpricing.display.perBasis[]APER_ROOM_PER_NIGHT basis entry depicting the average per-room > per-night rate breakdown

Extra response data with HOTEL_CONTENT

  • Contact your account manager to enable this content in Search API.
  • Response excerpt:
"properties": [
  {
    "id": 12157,
    "content": {
      "name": {
        "en-us": "Medhufushi Island Resort"
      }
    }
  }
]

Extra response data with ROOM_CONTENT

  • Contact your account manager to enable this content in Search API.
  • Response excerpt: The extra content field is returned.
"rooms": [
  {
    "id": 3134583,
    "parentId": 3134583,
    "content": {
      "name": {
        "en-us": "Beach Villa"
      }
    },
  }
]

Extra response data with RATE_DETAIL

  • Response excerpt: See the API reference to learn more about the response schema fields.
"remainingRoomCount": 37,
"isRoomTypeGuaranteed": true,
"capacity": {
  "normalBedCount": 1,
  "extraBedCount": 0
},
"payment": {
  "model": "MERCHANT"
},

Extra response data with SURCHARGE_DETAIL

Response excerpts:

  • The surcharge details returned with the extra pricing.*.surcharge field.
  • See the API reference to learn more about the response schema fields.
"surcharge": {
  "included": [
    {
      "id": 460,
      "isMargin": false,
      "price": {
        "inclusiveAmount": 72.00,
        "exclusiveAmount": 0.00,
        "tax": {
          "amount": 72.00
        },
        "fees": {
          "amount": 0.00
        }
      }
    },
    {
      "id": 462,
      "isMargin": false,
      "price": {
        "inclusiveAmount": 214.16,
        "exclusiveAmount": 183.04,
        "tax": {
          "amount": 31.12
        },
        "fees": {
          "amount": 0.00
        }
      }
    }
  ]
},
  • The definitions dictionary populated for the available surcharge ID/name mapping.
"definitions": {
  "surcharges": [
    {
      "id": 460,
      "name": {
        "en-us": "Green Tax"
      }
    },
    {
      "id": 462,
      "name": {
        "en-us": "Service Charge"
      }
    }
  ],
  "taxes": [],
  "fees": [],
  "promotions": []
}

Extra response data with CANCELLATION_DETAIL

Response excerpt:

  • The cancellation policy information will be returned both as a human-readable text and in machine-readable format.
  • See the API reference to learn more about the response schema fields.
"policies": {
  "cancellation": {
    "freeCancellation": {
      "isAllowed": true
    },
    "code": "7D1N_3D100P_100P",
    "description": {
      "en-us": "Stay flexible! Cancel for free before 2026-11-26​ Any cancellation received within 7 days prior to the arrival date will incur the first night's charge. Any cancellation received within 3 days prior to the arrival date will be charged for the entire stay. Failure to arrive at your hotel or property will be treated as a No-Show and will incur a charge of 100% of the booking value (Hotel policy)."
    },
    "parameter": [
      {
        "days": 8,
        "charge": "NIGHT",
        "value": 0.0
      },
      {
        "days": 7,
        "charge": "NIGHT",
        "value": 1.0
      },
      {
        "days": 3,
        "charge": "PERCENTAGE",
        "value": 100.0
      },
      {
        "days": 0,
        "charge": "PERCENTAGE",
        "value": 100.0
      }
    ],
    "segments": [
      {
        "dateTime": "2026-11-26T00:00:00.000+05:00",
        "type": "BEFORE",
        "rates": [
          {
            "currency": "USD",
            "price": {
              "inclusiveAmount": 0.00,
              "exclusiveAmount": 0.00,
              "tax": {
                "amount": 0.00
              },
              "fees": {
                "amount": 0.00
              }
            }
          }
        ]
      },
      {
        "dateTime": "2026-11-30T00:00:00.000+05:00",
        "type": "BEFORE",
        "rates": [
          {
            "currency": "USD",
            "price": {
              "inclusiveAmount": 1290.12,
              "exclusiveAmount": 1102.68,
              "tax": {
                "amount": 187.44
              },
              "fees": {
                "amount": 0.00
              }
            }
          }
        ]
      },
      {
        "dateTime": "2026-12-03T00:00:00.000+05:00",
        "type": "BEFORE",
        "rates": [
          {
            "currency": "USD",
            "price": {
              "inclusiveAmount": 2866.40,
              "exclusiveAmount": 2388.40,
              "tax": {
                "amount": 478.00
              },
              "fees": {
                "amount": 0.00
              }
            }
          }
        ]
      },
      {
        "dateTime": "2026-12-03T00:00:00.000+05:00",
        "type": "ONWARD",
        "rates": [
          {
            "currency": "USD",
            "price": {
              "inclusiveAmount": 2866.40,
              "exclusiveAmount": 2388.40,
              "tax": {
                "amount": 478.00
              },
              "fees": {
                "amount": 0.00
              }
            }
          }
        ]
      }
    ]
  }
},

Extra response data with BENEFIT_DETAIL

  • Response excerpt: The extra offers[].benefits[] array lists the benefits included with the rate.
"benefits": [
  {
    "id": 1,
    "name": {
      "en-us": "Breakfast"
    }
  },
  {
    "id": 10,
    "name": {
      "en-us": "Welcome drink"
    }
  },
  {
    "id": 34,
    "name": {
      "en-us": "Express check-in"
    }
  },
  {
    "id": 95,
    "name": {
      "en-us": "Free WiFi"
    }
  },
  {
    "id": 230,
    "name": {
      "en-us": "Drinking water"
    }
  },
  {
    "id": 115,
    "name": {
      "en-us": "Free fitness center access"
    }
  }
],

Extra response data with DAILY_RATE

  • Response excerpt: See the API reference to learn more about the response schema fields.
"dailyRates": [
  {
    "date": "2026-12-03",
    "rates": [
      {
        "currency": "USD",
        "price": {
          "inclusiveAmount": 1460.92,
          "exclusiveAmount": 1248.66,
          "tax": {
            "amount": 212.26
          },
          "fees": {
            "amount": 0.00
          }
        }
      }
    ]
  },
  {
    "date": "2026-12-04",
    "rates": [
      {
        "currency": "USD",
        "price": {
          "inclusiveAmount": 1460.92,
          "exclusiveAmount": 1248.66,
          "tax": {
            "amount": 212.26
          },
          "fees": {
            "amount": 0.00
          }
        }
      }
    ]
  }
]

Extra response data with TAX_DETAIL

Response excerpts:

  • See the API reference to learn more about the response schema fields.
  • The extra breakdown array is returned under each price.tax and price.fees detail.
"price": {
  "inclusiveAmount": 3236.36,
  "exclusiveAmount": 2704.60,
  "tax": {
    "amount": 531.76,
    "breakdown": [
      {
        "id": 1,
        "amount": 424.52,
        "percent": 17.0,
        "isBase": false,
        "isTaxable": false
      }
    ]
  },
  "fees": {
    "amount": 0.00,
    "breakdown": [
      {
        "id": 2,
        "amount": 0,
        "percent": 0,
        "isBase": false,
        "isTaxable": false
      }
    ]
  }
},
  • The definitions dictionary is populated for the available ID/name mapping for taxes and fees.
"definitions": {
  "surcharges": [],
  "taxes": [
    {
      "id": 1,
      "name": {
        "en-us": "Sales tax"
      }
    }
  ],
  "fees": [
    {
      "id": 2,
      "name": {
        "en-us": "Fee"
      }
    }
  ],
  "promotions": []
}

Extra response data with PROMOTION_DETAIL

  • Response excerpt:
"definitions": {
  "surcharges": [],
  "taxes": [],
  "fees": [],
  "promotions": []
}

Extra response data with CROSSEDOUT_DETAIL

  • Response excerpt: See the API reference to learn more about the response schema fields.
  • The extra strikeThroughRate object is returned under the price detail.
"price": {
  "inclusiveAmount": 3236.36,
  "exclusiveAmount": 2704.60,
  "strikeThroughRate": {
    "inclusiveAmount": 3619.87,
    "savingAmount": 383.51
  }
},

Extra response data with PER_BOOK_RATE

  • Response excerpt: Shows the total price for the entire booking before surcharges.
"perBasis": [
  {
    "basis": "PER_BOOK",
    "rates": [
      {
        "currency": "USD",
        "price": {
          "inclusiveAmount": 2580.24,
          "exclusiveAmount": 2205.36,
          "tax": {
            "amount": 374.88
          },
          "fees": {
            "amount": 0.00
          }
        }
      }
    ]
  }
],

Extra response data with PER_NIGHT_RATE

  • Response excerpt: Shows the average nightly price breakdown for the entire booking.
"perBasis": [
  {
    "basis": "PER_NIGHT",
    "rates": [
      {
        "currency": "USD",
        "price": {
          "inclusiveAmount": 1290.12,
          "exclusiveAmount": 1102.68,
          "tax": {
            "amount": 187.44
          },
          "fees": {
            "amount": 0.00
          }
        }
      }
    ]
  }
],

Extra response data with PER_ROOM_RATE

  • Response excerpt: Shows the average per-room total price breakdown before surcharges.
"perBasis": [
  {
    "basis": "PER_ROOM",
    "rates": [
      {
        "currency": "USD",
        "price": {
          "inclusiveAmount": 1290.12,
          "exclusiveAmount": 1102.68,
          "tax": {
            "amount": 187.44
          },
          "fees": {
            "amount": 0.00
          }
        }
      }
    ]
  }
],

Extra response data with PER_ROOM_PER_NIGHT_RATE

  • Response excerpt: Shows the average per-room, per-night breakdown.
"perBasis": [
  {
    "basis": "PER_ROOM_PER_NIGHT",
    "rates": [
      {
        "currency": "USD",
        "price": {
          "inclusiveAmount": 645.06,
          "exclusiveAmount": 551.34,
          "tax": {
            "amount": 93.72
          },
          "fees": {
            "amount": 0.00
          }
        }
      }
    ]
  }
],

Updated 3 days ago

Did this page help you?