Amadeus · Example Payload

Hotel Search Hotel Offer Example

{"lang" => "fr-FR", "text" => "A description"}

TravelTravel TechnologyReservationsFlightsHotelsAirlinesHospitalityTours and ActivitiesCars and TransfersDestination ContentItinerary ManagementTrip PlanningArtificial IntelligenceMarket Insights

Hotel Search Hotel Offer Example is an example object payload from Amadeus, with 16 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

typeidcheckInDatecheckOutDateroomQuantityrateCoderateFamilyEstimatedcategorydescriptioncommissionboardTyperoomguestspricepoliciesself

Example Payload

Raw ↑ 
{
  "type": "hotel-offer",
  "id": "TSXOJ6LFQ2",
  "checkInDate": "2020-12-30",
  "checkOutDate": "2020-12-31",
  "roomQuantity": "1",
  "rateCode": "RAC",
  "rateFamilyEstimated": {
    "code": "string-value",
    "type": "string-value"
  },
  "category": "FAMILY_PLAN",
  "description": {
    "text": "A description",
    "lang": "fr-FR"
  },
  "commission": {
    "percentage": 50,
    "amount": "199.50",
    "description": {
      "text": "A description",
      "lang": "fr-FR"
    }
  },
  "boardType": "ROOM_ONLY",
  "room": {
    "type": "string-value",
    "typeEstimated": {
      "category": "string-value",
      "beds": 1,
      "bedType": "string-value"
    },
    "description": {
      "text": "A description",
      "lang": "fr-FR"
    }
  },
  "guests": {
    "adults": 2,
    "childAges": [
      1
    ]
  },
  "price": {
    "currency": "EUR",
    "sellingTotal": "199.50",
    "total": "199.50",
    "base": "string-value",
    "taxes": [
      {
        "amount": "199.50",
        "currency": "EUR",
        "code": "string-value",
        "percentage": 50,
        "included": true,
        "description": "Sample description text.",
        "pricingFrequency": "string-value",
        "pricingMode": "string-value"
      }
    ],
    "markups": [
      {
        "amount": "10"
      }
    ],
    "variations": {
      "average": {},
      "changes": []
    }
  },
  "policies": {
    "paymentType": "GUARANTEE",
    "guarantee": {
      "description": {},
      "acceptedPayments": {}
    },
    "deposit": {
      "amount": "199.50",
      "deadline": "2026-08-15T10:30:00Z",
      "description": {},
      "acceptedPayments": {}
    },
    "prepay": {
      "amount": "199.50",
      "deadline": "2026-08-15T10:30:00Z",
      "description": {},
      "acceptedPayments": {}
    },
    "holdTime": {
      "deadline": "2026-08-15T10:30:00Z"
    },
    "cancellations": [
      {
        "amount": "199.50",
        "numberOfNights": 1,
        "percentage": 50,
        "deadline": "2026-08-15T10:30:00Z"
      }
    ],
    "checkInOut": {
      "checkIn": "13:00:00",
      "checkInDescription": {},
      "checkOut": "11:00:00",
      "checkOutDescription": {}
    }
  },
  "self": "https://test.travel.api.amadeus.com/v2/shopping/hotel-offers/63A93695B58821ABB0EC2B33FE9FAB24D72BF34B1BD7D707293763D8D9378FC3"
}