openapi-directory/api/amadeus.com/amadeus-hotel-search.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Before using this API, we recommend you read our **[Authorization Guide](https://developers.amadeus.com/self-service/apis-docs/guides/authorization-262)** for more information on how to generate an access token. \n\nPlease also be aware that our test environment is based on a subset of the production for this API it may change dynamically. For your tests, use big cities like LON (London) or NYC (New-York).","title":"Hotel Search API","version":"3.0.8","x-logo":{"url":"https://amadeus.com/images/en/technology/mobile-tablet/mobile-woman-office-city.jpg.transform/medium/img.jpg"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/amadeus4dev/amadeus-open-api-specification/main/spec/json/HotelSearch_v3_swagger_specification.json","version":"2.0"}],"x-providerName":"amadeus.com","x-serviceName":"amadeus-hotel-search"},"tags":[{"description":"","name":"shopping"}],"paths":{"/shopping/hotel-offers":{"get":{"deprecated":false,"description":"","operationId":"getMultiHotelOffers","parameters":[{"description":"Amadeus property codes on 8 chars. Mandatory parameter for a search by predefined list of hotels.","in":"query","name":"hotelIds","required":true,"example":["MCLONGHM"],"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":20,"uniqueItems":false}},{"description":"Number of adult guests (1-9) per room.","in":"query","name":"adults","required":false,"example":1,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":9,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":1}},{"description":"Check-in date of the stay (hotel local date). Format YYYY-MM-DD. The lowest accepted value is the present date (no dates in the past). If not present, the default value will be today's date in the GMT time zone.","in":"query","name":"checkInDate","required":false,"example":"2025-04-15T13:49:53.295Z","schema":{"type":"string","format":"date"}},{"description":"Check-out date of the stay (hotel local date). Format YYYY-MM-DD. The lowest accepted value is checkInDate+1. If not present, it will default to checkInDate +1.","in":"query","name":"checkOutDate","required":false,"schema":{"type":"string","format":"date"}},{"description":"Code of the country of residence of the traveler expressed using ISO 3166-1 format.","in":"query","name":"countryOfResidence","required":false,"schema":{"type":"string","pattern":"[A-Z]{2}"}},{"description":"Number of rooms requested (1-9).","in":"query","name":"roomQuantity","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":9,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":1}},{"description":"Filter hotel offers by price per night interval (ex: 200-300 or -300 or 100).\nIt is mandatory to include a currency when this field is set.","in":"query","name":"priceRange","required":false,"schema":{"type":"string"}},{"description":"Use this parameter to request a specific currency. ISO currency code (http://www.iso.org/iso/home/standards/currency_codes.htm).\nIf a hotel does not support the requested currency, the prices for the hotel will be returned in the local currency of the hotel.","in":"query","name":"currency","required":false,"schema":{"type":"string","pattern":"^[A-Z]{3}$"}},{"description":"Filter the response based on a specific payment type. NONE means all types (default).","in":"query","name":"paymentPolicy","required":false,"schema":{"type":"string","enum":["GUARANTEE","DEPOSIT","NONE"],"default":"NONE"}},{"description":"Filter response based on available meals:\n        * ROOM_ONLY = Room Only\n        * BREAKFAST = Breakfast\n        * HALF_BOARD = Diner & Breakfast (only for Aggregators)\n        * FULL_BOARD = Full Board (only for Aggregators)\n        * ALL_INCLUSIVE = All Inclusive (only for Aggregators)","in":"query","name":"boardType","required":false,"schema":{"type":"string","enum":["ROOM_ONLY","BREAKFAST","HALF_BOARD","FULL_BOARD","ALL_INCLUSIVE"]}},{"description":"Show all properties (include sold out) or available only. For sold out properties, please check availability on other dates.","in":"query","name":"includeClosed","required":false,"schema":{"type":"boolean"}},{"description":"Used to return only the cheapest offer per hotel or all available offers.","in":"query","name":"bestRateOnly","required":false,"schema":{"type":"boolean","default":true}},{"description":"Requested language of descriptive texts. \nExamples: FR , fr , fr-FR.\nIf a language is not available the text will be returned in english.\nISO language code (https://www.iso.org/iso-639-language-codes.html).","in":"query","name":"lang","required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9-]{2,5}$"}}],"responses":{"200":{"description":"OK","content":{"application/vnd.amadeus+json":{"schema":{"$ref":"#/components/schemas/MultiResponse"}}}},"400":{"description":"Bad request:\n\n| Code | Title  |\n|-----|-----|\n| 23   | PASSENGER TYPE NOT SUPPORTED   |\n| 61 | INVALID CURRENCY CODE|\n| 137 | INVALID ADULTS OCCUPANCY REQUESTED|\n| 145 | DURATION PERIOD OR DATES INCORRECT|\n| 195 | SERVICE RESTRICTION|\n| 249 | INVALID RATE CODE|\n| 377 | MAX STAY DURATION IS EXCEEDED|\n| 381 | INVALID CHECK-IN DATE|\n| 382 | INVALID CHECK-OUT DATE|\n| 383 | INVALID CITY CODE|\n| 392 | INVALID HOTEL CODE|\n| 397 | INVALID NUMBER OF ADULTS|\n| 400 | INVALID PROPERTY CODE|\n| 404 | CHECK_OUT DATE MUST BE FURTHER IN THE FUTURE THAN CHECK-IN DATE|\n| 424 | NO HOTELS FOUND WHICH MATCH THIS INPUT|\n| 431 | CHECK-OUT DATE IS TOO FAR IN THE FUTURE THAN CHECK-IN DATE|\n| 424 | NO HOTELS FOUND WHICH MATCH THIS INPUT|\n| 431 | CHECK-OUT DATE IS TOO FAR IN THE FUTURE|\n| 450 | INVALID PROVIDER RESPONSE|\n| 451 | INVALID CREDENTIALS|\n| 562 | RESTRICTED ACCESS FOR THE REQUESTED RATES AND CHAINS|\n| 784 | PROVIDER TIME OUT|\n| 790 | RATE SECURITY NOT LOADED| ","content":{"application/vnd.amadeus+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"500":{"description":"Internal server error.","content":{"application/vnd.amadeus+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"summary":"getMultiHotelOffers","tags":["shopping"]}},"/shopping/hotel-offers/{offerId}":{"get":{"deprecated":false,"description":" ","operationId":"getOfferPricing","parameters":[{"description":"Unique identifier of an offer. Either the GDS booking code or the aggregator offerId with a limited lifetime.","in":"path","name":"offerId","required":true,"example":"TSXOJ6LFQ2","schema":{"type":"string","pattern":"^[A-Z0-9]*$"}},{"description":"Requested language of descriptive texts. \nExamples: FR , fr , fr-FR.\nIf a language is not available the text will be returned in english.\nISO language code (https://www.iso.org/iso-639-language-codes.html).","in":"query","name":"lang","required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9-]{2,5}$"}}],"responses":{"200":{"description":"OK","content":{"application/vnd.amadeus+json":{"schema":{"$ref":"#/components/schemas/PricingResponse"}}}},"400":{"description":"Bad Request:\ncode| title\n------- | -------------------------------------\n23 | PASSENGER TYPE NOT SUPPORTED\n61 |INVALID CURRENCY CODE\n137 | INVALID ADULTS OCCUPANCY REQUESTED\n145 | DURATION PERIOD OR DATES INCORRECT\n195 | SERVICE RESTRICTION\n249 | INVALID RATE CODE\n377 | MAX STAY DURATION IS EXCEEDED\n381 | INVALID CHECK-IN DATE\n382 | INVALID CHECK-OUT DATE\n383 | INVALID CITY CODE\n392 | INVALID HOTEL CODE\n397 | INVALID NUMBER OF ADULTS\n400 | INVALID PROPERTY CODE\n402 | INVALID ROOM TYPE\n404 | CHECK_OUT DATE MUST BE FURTHER IN THE FUTURE THAN CHECK-IN DATE\n424 | NO HOTELS FOUND WHICH MATCH THIS INPUT\n431 | CHECK-OUT DATE IS TOO FAR IN THE FUTURE\n450 | INVALID PROVIDER RESPONSE\n451 | INVALID CREDENTIAL\n562 | RESTRICTED ACCESS FOR THE REQUESTED RATES AND CHAINS\n784 | PROVIDER TIME OUT\n790 | NO PROPERTIES FOUND WITHIN THIS RADIUS\n795 | NO SIMILAR NAME FOUND, PLEASE ENLARGE YOUR SEARCH CRITERIA\n842 | RATE SECURITY NOT LOADED","content":{"application/vnd.amadeus+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"404":{"description":"Hotel or offer not found","content":{"application/vnd.amadeus+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"500":{"description":"Internal server error.","content":{"application/vnd.amadeus+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"summary":"getOfferPricing","tags":["shopping"]}}},"servers":[{"url":"https://test.api.amadeus.com/v3"}],"components":{"schemas":{"BoardType":{"description":"The included Breakfast/Meals","enum":["ROOM_ONLY","BREAKFAST","HALF_BOARD","FULL_BOARD","ALL_INCLUSIVE","BUFFET_BREAKFAST","CARIBBEAN_BREAKFAST","CONTINENTAL_BREAKFAST","ENGLISH_BREAKFAST","FULL_BREAKFAST","DINNER_BED_AND_BREAKFAST","LUNCH","DINNER","FAMILY_PLAN","AS_BROCHURED","SELF_CATERING","BERMUDA","AMERICAN","FAMILY_AMERICAN","MODIFIED"],"title":"BoardType","type":"string"},"CancellationType":{"description":"* FULL_STAY: the Penalty amount equals the `total` price.","enum":["FULL_STAY"],"title":"CancellationType","type":"string"},"Error":{"description":"The Error Definition","properties":{"code":{"description":"A machine-readable error code from the Amadeus Canned Messages table, that will enable the API Consumers code to handle this type of error","format":"int32","type":"integer"},"detail":{"description":"An easy-to-read explanation specific to this occurrence of the problem. It should give the API consumer an idea of what went wrong and how to recover from it. Like the title, this field’s value can be localized.","type":"string"},"documentation":{"description":"A link to a web page or file with further documentation to help the API consumer resolve this error","type":"string"},"source":{"$ref":"#/components/schemas/Error_Source"},"status":{"description":"The [HTTP status code](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) of this response. This is present only in terminal errors which cause an unsuccessful response. In the case of multiple errors, they must all have the same status.","format":"int32","type":"integer"},"title":{"description":"An error title from the Canned Messages table with a 1:1 correspondence to the error code. This may be localized","type":"string"}},"title":"Error","type":"object"},"Error_Source":{"properties":{"example":{"description":"A sample input to guide the user when resolving this issue","type":"string"},"parameter":{"description":"The key of the URI path or query parameter that caused the error","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request body that caused this error","type":"string"}},"title":"Error_Source","type":"object"},"Errors":{"description":"A set of errors","properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"type":"array"}},"title":"Errors","type":"object"},"Hotel":{"description":"Hotel Content","properties":{"brandCode":{"description":"Brand (RT...) (Amadeus 2 chars Code). Small Properties distributed by Merchants may not have a Brand.\nExample - AD (Value Hotels) is the Provider/Merchant, and RT (Accor) is the Brand of the Property","example":"RT","pattern":"^[A-Z]{2}$","type":"string"},"chainCode":{"description":"Brand (RT...) or Merchant (AD...) (Amadeus 2 chars Code)","example":"AD","pattern":"^[A-Z]{2}$","type":"string"},"cityCode":{"description":"Warning: The IATA city code associated to the hotel (not necessary the real Hotel City)","example":"PAR","pattern":"^[A-Z]{3}$","type":"string"},"dupeId":{"description":"Unique Property identifier of the physical hotel.\nOne physical hotel can be represented by different Providers, each one having its own `hotelID`.\nThis attribute allows a client application to group together hotels that are actually the same.","example":"501132260","type":"string"},"hotelId":{"description":"Amadeus Property Code (8 chars)","example":"ADPAR001","pattern":"^[A-Z0-9]{8}$","type":"string"},"name":{"description":"Hotel Name","example":"Hotel de Paris","type":"string"}},"title":"Hotel","type":"object"},"HotelOffer":{"description":"Hotel Offer","properties":{"boardType":{"$ref":"#/components/schemas/BoardType"},"category":{"description":"Special Rate Category\nExamples:\n  ASSOCIATION\n  FAMILY_PLAN","example":"FAMILY_PLAN","type":"string"},"checkInDate":{"description":"check-in date of the stay (hotel local date). Format YYYY-MM-DD\nThe lowest accepted value is today date (no dates in the past).","example":"2025-04-15T13:49:53.295Z","format":"date","type":"string"},"checkOutDate":{"description":"check-out date of the stay (hotel local date). Format YYYY-MM-DD\nThe lowest accepted value is `checkInDate`+1.","example":"2025-04-15T13:49:53.295Z","format":"date","type":"string"},"commission":{"$ref":"#/components/schemas/HotelProduct_Commission"},"description":{"$ref":"#/components/schemas/QualifiedFreeText"},"guests":{"$ref":"#/components/schemas/HotelProduct_Guests"},"id":{"description":"Unique identifier of this offer. Might be valid for a temporary period only.","example":"TSXOJ6LFQ2","maxLength":100,"minLength":2,"pattern":"^[A-Z0-9]*$","type":"string"},"policies":{"$ref":"#/components/schemas/HotelProduct_PolicyDetails"},"price":{"$ref":"#/components/schemas/HotelProduct_HotelPrice"},"rateCode":{"description":"Special Rate - Provider Response Code (3 chars)\nExamples\n\n  * RAC - Rack\n\n  * BAR - Best Available Rate\n\n  * PRO - Promotional\n\n  * COR - Corporate\n\n  * GOV - Government (qualified)\n\n  * AAA - AAA (qualified)\n\n  * BNB - Bed and Breakfast\n\n  * PKG - Package\n\n  * TVL - Travel Industry\n\n  * SPC - Special Promo Rate\n\n  * WKD - Weekend\n\n  * CON - Convention\n\n  * SNR - Senior (Europe) (qualified)\n\n  * ARP - AARP - American Association of Retired People (50+) (qualified)\n\n  * SRS - Senior (qualified)\n\n  * ROR - Room Only Rate (no breakfast)\n\n  * FAM - Family\n\n  * DAY - Day rate","example":"RAC","maxLength":3,"minLength":3,"pattern":"^[A-Z0-9*]{3}$","type":"string"},"rateFamilyEstimated":{"$ref":"#/components/schemas/HotelProduct_RateFamily"},"room":{"$ref":"#/components/schemas/HotelProduct_RoomDetails"},"roomQuantity":{"description":"number of rooms (1-9)","example":"1","type":"string"},"self":{"description":"A self link to the object. Use this to refresh the Offer price","example":"https://test.travel.api.amadeus.com/v2/shopping/hotel-offers/63A93695B58821ABB0EC2B33FE9FAB24D72BF34B1BD7D707293763D8D9378FC3","type":"string"},"type":{"$ref":"#/components/schemas/Type"}},"required":["id","rateCode","room","price"],"title":"HotelOffer","type":"object"},"HotelOffers":{"properties":{"available":{"type":"boolean"},"hotel":{"$ref":"#/components/schemas/Hotel"},"offers":{"items":{"$ref":"#/components/schemas/HotelOffer"},"type":"array"},"self":{"type":"string"},"type":{"description":"the type of the object (hotel-offers)","type":"string"}},"title":"HotelOffers","type":"object"},"HotelProduct_CancellationPolicy":{"properties":{"amount":{"description":"Amount of the cancellation fee.","pattern":"^\\\\d+(\\\\.\\\\d+)?$","type":"string"},"deadline":{"description":"Represents the deadline after which the penalty applies. DateTime is in ISO 8601 [https://www.w3.org/TR/NOTE-datetime].\nExample: 2010-08-14T12:00:00+01:00\nExample: 2010-08-14T12:00:00Z\nExample: 2010-08-14T12:00:00-01:00\nThe value is expressed in the hotel local time zone, with the added time zone difference. So you can compute the deadline in UTC(GMT) if desired.","format":"date-time","type":"string"},"description":{"$ref":"#/components/schemas/QualifiedFreeText"},"numberOfNights":{"description":"Number of nights due as fee in case of cancellation.","format":"int32","minimum":0,"type":"integer"},"percentage":{"description":"Percentage of the total stay amount to be paid in case of cancellation. Value is between 0 and 100.","pattern":"^\\\\d+(\\\\.\\\\d+)?$","type":"string"},"type":{"$ref":"#/components/schemas/CancellationType"}},"title":"HotelProduct_CancellationPolicy","type":"object"},"HotelProduct_CheckInOutPolicy":{"properties":{"checkIn":{"description":"Check-in From time limit in ISO-8601 format [http://www.w3.org/TR/xmlschema-2/#time]","example":46800,"type":"string"},"checkInDescription":{"$ref":"#/components/schemas/QualifiedFreeText"},"checkOut":{"description":"Check-out Until time limit in ISO-8601 format [http://www.w3.org/TR/xmlschema-2/#time]","example":39600,"type":"string"},"checkOutDescription":{"$ref":"#/components/schemas/QualifiedFreeText"}},"title":"HotelProduct_CheckInOutPolicy","type":"object"},"HotelProduct_Commission":{"properties":{"amount":{"description":"Amount of the commission paid to the travel seller. The amount is always linked to the currency code of the offer","pattern":"^\\\\d+(\\\\.\\\\d+)?$","type":"string"},"description":{"$ref":"#/components/schemas/QualifiedFreeText"},"percentage":{"description":"Percentage of the commission paid to the travel seller. Value is between 0 and 100","pattern":"^\\\\d+(\\\\.\\\\d+)?$","type":"string"}},"title":"HotelProduct_Commission","type":"object"},"HotelProduct_DepositPolicy":{"description":"the deposit/prepay policy information applicable to the offer. It includes accepted payments, deadline and the amount due","properties":{"acceptedPayments":{"$ref":"#/components/schemas/HotelProduct_PaymentPolicy"},"amount":{"description":"Deposit-Prepay amount","pattern":"^\\\\d+(\\\\.\\\\d+)?$","type":"string"},"deadline":{"description":"The date and time of the deadline in ISO 8601[https://www.w3.org/TR/NOTE-datetime]. \n Example: 2010-08-14T13:00:00\n Please note that this value is expressed in the hotels local time zone","format":"date-time","type":"string"},"description":{"$ref":"#/components/schemas/QualifiedFreeText"}},"title":"HotelProduct_DepositPolicy","type":"object"},"HotelProduct_EstimatedRoomType":{"description":"estimated room category, bed type and number of beds in the room. This information has been parsed from the room description, and is thus only provided for informational purposes","properties":{"bedType":{"description":"Type of the bed","type":"string"},"beds":{"description":"Number of beds in the room (1-9)","format":"int32","type":"integer"},"category":{"description":"Category code","type":"string"}},"title":"HotelProduct_EstimatedRoomType","type":"object"},"HotelProduct_GuaranteePolicy":{"description":"the guarantee policy information applicable to the offer. It includes accepted payments","properties":{"acceptedPayments":{"$ref":"#/components/schemas/HotelProduct_PaymentPolicy"},"description":{"$ref":"#/components/schemas/QualifiedFreeText"}},"title":"HotelProduct_GuaranteePolicy","type":"object"},"HotelProduct_Guests":{"properties":{"adults":{"description":"number of adult guests (1-9) per room","example":2,"format":"int32","maximum":9,"minimum":1,"type":"integer"},"childAges":{"description":"Comma separated list of ages of each child at the time of check-out from the hotel. If several children have the same age, the ages will be repeated.","items":{"format":"int32","maximum":20,"minimum":0,"type":"integer"},"type":"array"}},"title":"HotelProduct_Guests","type":"object"},"HotelProduct_HoldPolicy":{"description":"the hold policy","properties":{"deadline":{"description":"The date and time of the deadline in ISO 8601[https://www.w3.org/TR/NOTE-datetime]. \n Example: 2010-08-14T13:00:00\n Please note that this value is expressed in the hotels local time zone","format":"date-time","type":"string"}},"required":["deadline"],"title":"HotelProduct_HoldPolicy","type":"object"},"HotelProduct_HotelPrice":{"description":"price information","properties":{"base":{"type":"string"},"currency":{"description":"currency Code apply to all elements of the price","type":"string"},"markups":{"items":{"$ref":"#/components/schemas/Markup"},"type":"array"},"sellingTotal":{"description":"sellingTotal = Total + margins + markup + totalFees - discounts","type":"string"},"taxes":{"items":{"$ref":"#/components/schemas/Tax"},"type":"array"},"total":{"description":"total = base + totalTaxes","type":"string"},"variations":{"$ref":"#/components/schemas/HotelProduct_PriceVariations"}},"title":"HotelProduct_HotelPrice","type":"object"},"HotelProduct_PaymentPolicy":{"description":"Accepted Payment Methods and Card Types. Several Payment Methods and Card Types may be available.","properties":{"creditCards":{"description":"Accepted Payment Card Types for the `method` CREDIT_CARD","items":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"array"},"methods":{"description":"Accepted Payment Methods","items":{"$ref":"#/components/schemas/Method"},"type":"array"}},"title":"HotelProduct_PaymentPolicy","type":"object"},"HotelProduct_PolicyDetails":{"description":"Booking Rules","properties":{"cancellation":{"$ref":"#/components/schemas/HotelProduct_CancellationPolicy"},"checkInOut":{"$ref":"#/components/schemas/HotelProduct_CheckInOutPolicy"},"deposit":{"$ref":"#/components/schemas/HotelProduct_DepositPolicy"},"guarantee":{"$ref":"#/components/schemas/HotelProduct_GuaranteePolicy"},"holdTime":{"$ref":"#/components/schemas/HotelProduct_HoldPolicy"},"paymentType":{"$ref":"#/components/schemas/PaymentType"},"prepay":{"$ref":"#/components/schemas/HotelProduct_DepositPolicy"}},"title":"HotelProduct_PolicyDetails","type":"object"},"HotelProduct_PriceVariation":{"description":"Some prices may vary during a stay, thus here you can see the daily price per period of the stay","properties":{"base":{"type":"string"},"currency":{"description":"currency Code apply to all elements of the price","type":"string"},"endDate":{"description":"End date of the period\nFormat: YYYY-MM-DD","format":"date","type":"string"},"markups":{"items":{"$ref":"#/components/schemas/Markup"},"type":"array"},"sellingTotal":{"description":"sellingTotal = Total + margins + markup + totalFees - discounts","type":"string"},"startDate":{"description":"Begin date of the period\nFormat: YYYY-MM-DD","format":"date","type":"string"},"total":{"description":"total = base + totalTaxes","type":"string"}},"required":["startDate","endDate"],"title":"HotelProduct_PriceVariation","type":"object"},"HotelProduct_PriceVariations":{"description":"Daily price variations and the average daily price (when available) is shown here","properties":{"average":{"$ref":"#/components/schemas/Price"},"changes":{"description":"A collection of price periods if the daily price changes during the stay","items":{"$ref":"#/components/schemas/HotelProduct_PriceVariation"},"type":"array"}},"title":"HotelProduct_PriceVariations","type":"object"},"HotelProduct_RateFamily":{"description":"The estimated rate code family of the offer. Grouping various rate plan codes that belongs to the same family and indicates the type of the rate","properties":{"code":{"description":"The estimated rate family (PRO,FAM,GOV)","pattern":"[A-Z0-9]{3}","type":"string"},"type":{"description":"The type of the rate (public=P, negotiated=N, conditional=C)","pattern":"[PNC]","type":"string"}},"title":"HotelProduct_RateFamily","type":"object"},"HotelProduct_RoomDetails":{"properties":{"description":{"$ref":"#/components/schemas/QualifiedFreeText"},"type":{"description":"Room type code, 3 character identifier of the room.\nThe first character identifies the room type category. \nThe second numeric character identifies the number of beds. \nThe third character identifies the bed type. \nThere is a special case where ROH is returned, this value stands for Run Of House.","pattern":"^[A-Z0-9*]{3}$","type":"string"},"typeEstimated":{"$ref":"#/components/schemas/HotelProduct_EstimatedRoomType"}},"title":"HotelProduct_RoomDetails","type":"object"},"Markup":{"description":"Markup applied to provide a service or a product to the client. The markup can be introduced by any stakeholder. Typical use case is to convey markup information set by the travel agent or in case of merchant mode.","properties":{"amount":{"description":"Defines the monetary value with decimal position as a String.","example":"10","type":"string"}},"title":"Markup","type":"object"},"Method":{"description":"The Payment Methods\n * CREDIT_CARD (CC) - Payment Cards in `creditCards` are accepted\n * AGENCY_ACCOUNT - Agency Account (Credit Line) is accepted. Agency is Charged at CheckOut\n * TRAVEL_AGENT_ID - Agency IATA/ARC Number is accepted to Guarantee the booking\n * CORPORATE_ID (COR-ID) - Corporate Account is accepted to Guarantee the booking\n * HOTEL_GUEST_ID - Hotel Chain Rewards Card Number is accepted to Guarantee the booking\n * CHECK - Checks are accepted\n * MISC_CHARGE_ORDER - Miscellaneous Charge Order is accepted\n * ADVANCE_DEPOSIT - Cash is accepted for Deposit/PrePay\n * COMPANY_ADDRESS - Company Billing Address is accepted to Guarantee the booking","enum":["CREDIT_CARD","AGENCY_ACCOUNT","TRAVEL_AGENT_ID","CORPORATE_ID","HOTEL_GUEST_ID","CHECK","MISC_CHARGE_ORDER","ADVANCE_DEPOSIT","COMPANY_ADDRESS","VCC_BILLBACK","VCC_B2B_WALLET","DEFERED_PAYMENT","TRAVEL_AGENT_IMMEDIATE"],"title":"Method","type":"string"},"MultiResponse":{"example":{"data":[{"available":true,"hotel":{"chainCode":"MC","cityCode":"LON","dupeId":"700031300","hotelId":"MCLONGHM","latitude":51.50988,"longitude":-0.15509,"name":"JW Marriott Grosvenor House London","type":"hotel"},"offers":[{"checkInDate":"2025-04-15T13:49:53.295Z","checkOutDate":"2025-04-15T13:49:53.295Z","guests":{"adults":1},"id":"TSXOJ6LFQ2","policies":{"cancellation":{"description":{"text":"NON-REFUNDABLE RATE"},"type":"FULL_STAY"},"paymentType":"deposit"},"price":{"base":"716.00","currency":"GBP","total":"716.00","variations":{"average":{"base":"716.00"},"changes":[{"endDate":"2025-04-15T13:49:53.295Z","startDate":"2025-04-15T13:49:53.295Z","total":"716.00"}]}},"rateCode":"V  ","rateFamilyEstimated":{"code":"PRO","type":"P"},"room":{"description":{"lang":"EN","text":"Prepay Non-refundable Non-changeable, prepay in full\nExecutive King Room, Executive Lounge Access,\n1 King, 35sqm/377sqft-40sqm/430sqft, Wireless"},"type":"ELE","typeEstimated":{"bedType":"DOUBLE","beds":1,"category":"EXECUTIVE_ROOM"}},"self":"https://test.api.amadeus.com/v3/shopping/hotel-offers/TSXOJ6LFQ2"}],"self":"https://test.api.amadeus.com/v3/shopping/hotel-offers?hotelIds=MCLONGHM&adults=1&checkInDate=2023-11-22&paymentPolicy=NONE&roomQuantity=1","type":"hotel-offers"}]},"properties":{"data":{"$ref":"#/components/schemas/HotelOffers"}},"title":"MultiResponse","type":"object"},"PaymentType":{"description":"payment type. Guarantee means Pay at Check Out. Check the `methods` in `guarantee` or `deposit` or `prepay`.","enum":["GUARANTEE","DEPOSIT","PREPAY","HOLDTIME"],"title":"PaymentType","type":"string"},"Price":{"description":"Price valuation information","properties":{"base":{"type":"string"},"currency":{"description":"currency Code apply to all elements of the price","type":"string"},"markups":{"items":{"$ref":"#/components/schemas/Markup"},"type":"array"},"sellingTotal":{"description":"sellingTotal = Total + margins + markup + totalFees - discounts","type":"string"},"total":{"description":"total = base + totalTaxes","type":"string"}},"title":"Price","type":"object"},"PricingResponse":{"example":{"data":{"available":true,"hotel":{"address":{"countryCode":"GB"},"amenities":["CRIBS_AVAILABLE"],"chainCode":"MC","cityCode":"LON","hotelId":"MCLONGHM","name":"JW MARRIOTT GROSVENOR HOUSE","type":"hotel"},"offers":[{"checkInDate":"2025-04-15T13:49:53.295Z","checkOutDate":"2025-04-15T13:49:53.295Z","description":{"lang":"EN","text":"Executive King Room, Executive Lounge Access, 1 King, 35sqm/377sqft-40sqm/430sqft, Wireless in ternet, for a fee, Wired internet, for a fee, C A credit card is required for payment to guarantee the Prepay Non-refundable Non-changeable rate. Prepay rates will be charged the full cost of the reservation within 24 hours of making the reservation. If payment is unsuccessful within 48 hours of making the reservation, the hotel reserves the right to cancel the reservation. Date changes to the reservation are not allowed. Cancellation will result in forfeiture of the prepayment. The credit card used at the time of making the reservation must be valid for the entire stay."},"guests":{"adults":1},"id":"TSXOJ6LFQ2","policies":{"cancellation":{"description":{"text":"NON-REFUNDABLE RATE"},"type":"FULL_STAY"},"paymentType":"deposit"},"price":{"base":"716.00","currency":"GBP","total":"716.00","variations":{"changes":[{"base":"716.00","endDate":"2025-04-15T13:49:53.295Z","startDate":"2025-04-15T13:49:53.295Z"}]}},"rateCode":"V  ","rateFamilyEstimated":{"code":"PRO","type":"P"},"room":{"description":{"lang":"EN","text":"Prepay Non-refundable Non-changeable, prepay in full"},"type":"ELE","typeEstimated":{"bedType":"DOUBLE","beds":1}}}],"type":"hotel-offers"},"meta":{"lang":"EN"}},"properties":{"data":{"$ref":"#/components/schemas/HotelOffers"}},"title":"PricingResponse","type":"object"},"QualifiedFreeText":{"description":"Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language","properties":{"lang":{"description":"see RFC 5646","example":"fr-FR","type":"string"},"text":{"description":"Free Text","example":"A description","type":"string"}},"title":"QualifiedFreeText","type":"object"},"Tax":{"description":"IATA Tax definition: An impost for raising revenue for the general treasury and which will be used for general public purposes.","properties":{"amount":{"description":"Defines amount with decimal separator.","type":"string"},"code":{"description":"International Standards Organization (ISO) Tax code.It is a two-letter country code.","type":"string"},"currency":{"description":"Defines a monetary unit. It is a three alpha code (iata code). Example: EUR for Euros, USD for US dollar, etc.","maxLength":3,"minLength":1,"type":"string"},"description":{"description":"Example - \"Governement tax\"","type":"string"},"included":{"description":"Indicates if tax is included or not","type":"boolean"},"percentage":{"description":"In the case of a tax on TST value, the percentage of the tax will be indicated in this field.","type":"string"},"pricingFrequency":{"description":"Specifies if the tax applies per stay or per night\n  - PER_STAY\n  - PER_NIGHT","type":"string"},"pricingMode":{"description":"Specifies if the tax applies per occupant or per room\n  - PER_OCCUPANT\n  - PER_PRODUCT","type":"string"}},"title":"Tax","type":"object"},"Type":{"description":"data type","enum":["hotel-offer"],"title":"Type","type":"string"}}}}