--- title: "getOfferPricing" method: GET path: "/shopping/hotel-offers/{offerId}" tags: ["shopping"] --- # getOfferPricing `GET /shopping/hotel-offers/{offerId}` ## Request - Base URL: `https://test.api.amadeus.com/v3` - URL: `https://test.api.amadeus.com/v3/shopping/hotel-offers/{offerId}` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `offerId` string, required ## Query parameters - `lang` string ## Response `200` OK - PricingResponse - `data` HotelOffers - `type` string: the type of the object (hotel-offers) - `available` boolean - `self` string - `offers` HotelOffer[] - `type` 'hotel-offer': data type - `id` string, required: Unique identifier of this offer. Might be valid for a temporary period only. - `checkInDate` string, date: check-in date of the stay (hotel local date). Format YYYY-MM-DD The lowest accepted value is today date (no dates in the past). - `checkOutDate` string, date: check-out date of the stay (hotel local date). Format YYYY-MM-DD The lowest accepted value is `checkInDate`+1. - `roomQuantity` string: number of rooms (1-9) - `rateCode` string, required: Special Rate - Provider Response Code (3 chars) Examples * RAC - Rack * BAR - Best Available Rate * PRO - Promotional * COR - Corporate * GOV - Government (qualified) * AAA - AAA (qualified) * BNB - Bed and Breakfast * PKG - Package * TVL - Travel Industry * SPC - Special Promo Rate * WKD - Weekend * CON - Convention * SNR - Senior (Europe) (qualified) * ARP - AARP - American Association of Retired People (50+) (qualified) * SRS - Senior (qualified) * ROR - Room Only Rate (no breakfast) * FAM - Family * DAY - Day rate - `rateFamilyEstimated` HotelProductRateFamily: 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 - `code` string: The estimated rate family (PRO,FAM,GOV) - `type` string: The type of the rate (public=P, negotiated=N, conditional=C) - `category` string: Special Rate Category Examples: ASSOCIATION FAMILY_PLAN - `description` QualifiedFreeText: Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language - `text` string: Free Text - `lang` string: see RFC 5646 - `commission` HotelProductCommission - `percentage` string: Percentage of the commission paid to the travel seller. Value is between 0 and 100 - `amount` string: Amount of the commission paid to the travel seller. The amount is always linked to the currency code of the offer - `description` QualifiedFreeText: Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language - `text` string: Free Text - `lang` string: see RFC 5646 - `boardType` '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': The included Breakfast/Meals - `room` HotelProductRoomDetails, required - `type` string: Room type code, 3 character identifier of the room. The first character identifies the room type category. The second numeric character identifies the number of beds. The third character identifies the bed type. There is a special case where ROH is returned, this value stands for Run Of House. - `typeEstimated` HotelProductEstimatedRoomType: 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 - `category` string: Category code - `beds` integer: Number of beds in the room (1-9) - `bedType` string: Type of the bed - `description` QualifiedFreeText: Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language - `text` string: Free Text - `lang` string: see RFC 5646 - `guests` HotelProductGuests - `adults` integer: number of adult guests (1-9) per room - `childAges` integer[]: 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. - `price` HotelProductHotelPrice, required: price information - `currency` string: currency Code apply to all elements of the price - `sellingTotal` string: sellingTotal = Total + margins + markup + totalFees - discounts - `total` string: total = base + totalTaxes - `base` string - `taxes` Tax[] - `amount` string: Defines amount with decimal separator. - `currency` string: Defines a monetary unit. It is a three alpha code (iata code). Example: EUR for Euros, USD for US dollar, etc. - `code` string: International Standards Organization (ISO) Tax code.It is a two-letter country code. - `percentage` string: In the case of a tax on TST value, the percentage of the tax will be indicated in this field. - `included` boolean: Indicates if tax is included or not - `description` string: Example - "Governement tax" - `pricingFrequency` string: Specifies if the tax applies per stay or per night - PER_STAY - PER_NIGHT - `pricingMode` string: Specifies if the tax applies per occupant or per room - PER_OCCUPANT - PER_PRODUCT - `markups` Markup[] - `amount` string: Defines the monetary value with decimal position as a String. - `variations` HotelProductPriceVariations: Daily price variations and the average daily price (when available) is shown here - `average` Price: Price valuation information - `currency` string: currency Code apply to all elements of the price - `sellingTotal` string: sellingTotal = Total + margins + markup + totalFees - discounts - `total` string: total = base + totalTaxes - `base` string - `markups` Markup[] - … - `changes` HotelProductPriceVariation[]: A collection of price periods if the daily price changes during the stay - `startDate` string, date, required: Begin date of the period Format: YYYY-MM-DD - `endDate` string, date, required: End date of the period Format: YYYY-MM-DD - `currency` string: currency Code apply to all elements of the price - `sellingTotal` string: sellingTotal = Total + margins + markup + totalFees - discounts - `total` string: total = base + totalTaxes - `base` string - `markups` Markup[] - … - `policies` HotelProductPolicyDetails: Booking Rules - `paymentType` 'GUARANTEE' | 'DEPOSIT' | 'PREPAY' | 'HOLDTIME': payment type. Guarantee means Pay at Check Out. Check the `methods` in `guarantee` or `deposit` or `prepay`. - `guarantee` HotelProductGuaranteePolicy: the guarantee policy information applicable to the offer. It includes accepted payments - `description` QualifiedFreeText: Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language - `text` string: Free Text - `lang` string: see RFC 5646 - `acceptedPayments` HotelProductPaymentPolicy: Accepted Payment Methods and Card Types. Several Payment Methods and Card Types may be available. - `creditCards` string[]: Accepted Payment Card Types for the `method` CREDIT_CARD - `methods` Method[]: Accepted Payment Methods - `deposit` HotelProductDepositPolicy: the deposit/prepay policy information applicable to the offer. It includes accepted payments, deadline and the amount due - `amount` string: Deposit-Prepay amount - `deadline` string, date-time: The date and time of the deadline in ISO 8601[https://www.w3.org/TR/NOTE-datetime]. Example: 2010-08-14T13:00:00 Please note that this value is expressed in the hotels local time zone - `description` QualifiedFreeText: Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language - `text` string: Free Text - `lang` string: see RFC 5646 - `acceptedPayments` HotelProductPaymentPolicy: Accepted Payment Methods and Card Types. Several Payment Methods and Card Types may be available. - `creditCards` string[]: Accepted Payment Card Types for the `method` CREDIT_CARD - `methods` Method[]: Accepted Payment Methods - `prepay` HotelProductDepositPolicy: the deposit/prepay policy information applicable to the offer. It includes accepted payments, deadline and the amount due - `amount` string: Deposit-Prepay amount - `deadline` string, date-time: The date and time of the deadline in ISO 8601[https://www.w3.org/TR/NOTE-datetime]. Example: 2010-08-14T13:00:00 Please note that this value is expressed in the hotels local time zone - `description` QualifiedFreeText: Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language - `text` string: Free Text - `lang` string: see RFC 5646 - `acceptedPayments` HotelProductPaymentPolicy: Accepted Payment Methods and Card Types. Several Payment Methods and Card Types may be available. - `creditCards` string[]: Accepted Payment Card Types for the `method` CREDIT_CARD - `methods` Method[]: Accepted Payment Methods - `holdTime` HotelProductHoldPolicy: the hold policy - `deadline` string, date-time, required: The date and time of the deadline in ISO 8601[https://www.w3.org/TR/NOTE-datetime]. Example: 2010-08-14T13:00:00 Please note that this value is expressed in the hotels local time zone - `cancellations` HotelProductCancellationPolicy[] - `type` 'FULL_STAY': * FULL_STAY: the Penalty amount equals the `total` price. - `amount` string: Amount of the cancellation fee. - `numberOfNights` integer: Number of nights due as fee in case of cancellation. - `percentage` string: Percentage of the total stay amount to be paid in case of cancellation. Value is between 0 and 100. - `deadline` string, date-time: Represents the deadline after which the penalty applies. DateTime is in ISO 8601 [https://www.w3.org/TR/NOTE-datetime]. Example: 2010-08-14T12:00:00+01:00 Example: 2010-08-14T12:00:00Z Example: 2010-08-14T12:00:00-01:00 The 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. - `description` QualifiedFreeText: Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language - `text` string: Free Text - `lang` string: see RFC 5646 - `checkInOut` HotelProductCheckInOutPolicy - `checkIn` string: Check-in From time limit in ISO-8601 format [http://www.w3.org/TR/xmlschema-2/#time] - `checkInDescription` QualifiedFreeText: Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language - `text` string: Free Text - `lang` string: see RFC 5646 - `checkOut` string: Check-out Until time limit in ISO-8601 format [http://www.w3.org/TR/xmlschema-2/#time] - `checkOutDescription` QualifiedFreeText: Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language - `text` string: Free Text - `lang` string: see RFC 5646 - `self` string: A self link to the object. Use this to refresh the Offer price - `hotel` Hotel: Hotel Content - `hotelId` string: Amadeus Property Code (8 chars) - `chainCode` string: Brand (RT...) or Merchant (AD...) (Amadeus 2 chars Code) - `brandCode` string: Brand (RT...) (Amadeus 2 chars Code). Small Properties distributed by Merchants may not have a Brand. Example - AD (Value Hotels) is the Provider/Merchant, and RT (Accor) is the Brand of the Property - `dupeId` string: Unique Property identifier of the physical hotel. One physical hotel can be represented by different Providers, each one having its own `hotelID`. This attribute allows a client application to group together hotels that are actually the same. - `name` string: Hotel Name - `cityCode` string: Warning: The IATA city code associated to the hotel (not necessary the real Hotel City) ## Other responses - `400`: Bad Request: code| title ------- | ------------------------------------- 23 | PASSENGER TYPE NOT SUPPORTED 61 |INVALID CURRENCY CODE 137 | INVALID ADULTS OCCUPANCY REQUESTED 145 | DURATION PERIOD OR DATES INCORRECT 195 | SERVICE RESTRICTION 249 | INVALID RATE CODE 377 | MAX STAY DURATION IS EXCEEDED 381 | INVALID CHECK-IN DATE 382 | INVALID CHECK-OUT DATE 383 | INVALID CITY CODE 392 | INVALID HOTEL CODE 397 | INVALID NUMBER OF ADULTS 400 | INVALID PROPERTY CODE 402 | INVALID ROOM TYPE 404 | CHECK_OUT DATE MUST BE FURTHER IN THE FUTURE THAN CHECK-IN DATE 424 | NO HOTELS FOUND WHICH MATCH THIS INPUT 431 | CHECK-OUT DATE IS TOO FAR IN THE FUTURE 450 | INVALID PROVIDER RESPONSE 451 | INVALID CREDENTIAL 562 | RESTRICTED ACCESS FOR THE REQUESTED RATES AND CHAINS 784 | PROVIDER TIME OUT 790 | NO PROPERTIES FOUND WITHIN THIS RADIUS 795 | NO SIMILAR NAME FOUND, PLEASE ENLARGE YOUR SEARCH CRITERIA 842 | RATE SECURITY NOT LOADED - `404`: Hotel or offer not found - `500`: Internal server error. --- [API](https://skmtc.dev/amadeus4dev/apis/hotel-search-api.md) - [All operations](https://skmtc.dev/amadeus4dev/apis/hotel-search-api/llms.txt) - [OpenAPI document](https://skmtc.dev/amadeus4dev/apis/hotel-search-api/revisions/0a9d7796f36e?raw)