> ## Documentation Index > Fetch the complete documentation index at: https://aisa.one/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create Stay Search > Create Stay Search via the Duffel Stays API ## OpenAPI ````yaml openapi/duffel-stays.json POST /apis/v1/duffel/stays/search/create openapi: 3.1.0 info: description: '' title: Duffel Stays version: '1' x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-configured-paths: - /apis/v1/duffel/stays/bookings/create - /apis/v1/duffel/stays/bookings/list - /apis/v1/duffel/stays/bookings/{id} - /apis/v1/duffel/stays/bookings/{id}/cancel - /apis/v1/duffel/stays/loyalty-programmes/list - /apis/v1/duffel/stays/quotes/create - /apis/v1/duffel/stays/quotes/{id} - /apis/v1/duffel/stays/search-results/{id} - /apis/v1/duffel/stays/search-results/{id}/rates - /apis/v1/duffel/stays/search/create x-aisa-document: facts_hash: 035cd7385d62556c97d5b218e0eef016f91ccb9042ea2f62378f3ccef2ee40d0 generator_version: '2' protocol_version: '1' schema_version: '1' composer_version: '13' response_pending: - operation_id: get_duffel_stays_apis_v1_duffel_stays_search_results_id path: /apis/v1/duffel/stays/search-results/{id} method: GET statuses: - '200' reason: public success response has no authoritative payload declaration - operation_id: get_duffel_stays_apis_v1_duffel_stays_search_resu_1d74a6 path: /apis/v1/duffel/stays/search-results/{id}/rates method: GET statuses: - '200' reason: public success response has no authoritative payload declaration document_hash: sha256:f36663c8b85de47c0cb6e65719645d579a7536f4a5df9e3eb7d0f420ba2a28fc x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-provider: duffel-stays x-aisa-catalogs: duffel-stays: title: Duffel Stays description: '' x-aisa-document: facts_hash: 035cd7385d62556c97d5b218e0eef016f91ccb9042ea2f62378f3ccef2ee40d0 generator_version: '2' protocol_version: '1' schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote servers: - url: https://api.aisa.one security: - bearerAuth: [] paths: /apis/v1/duffel/stays/search/create: post: tags: - duffel-stays summary: Create Stay Search description: Create Stay Search via the Duffel Stays API operationId: post_duffel_stays_apis_v1_duffel_stays_search_create requestBody: required: true content: application/json: schema: type: object required: - data properties: data: properties: accommodation: description: >- The accommodation to search for. You must use either this object or the `location` object in your request properties: fetch_rates: default: false description: >- Indicates if the accommodation search should return rooms and rates for each search result example: false type: boolean ids: description: >- The unique identifiers of the accommodation to search for. The maximum number of IDs is 10 when fetching room and rates, otherwise the maximum number of IDs is 200. items: type: string type: array required: - ids type: - object - 'null' check_in_date: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the guest wants to check in. Check-in date can be no more than 330 days in the future. example: '2023-06-04' format: date type: string check_out_date: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the guest wants to check out. A stay can be up to 99 nights. example: '2023-06-07' format: date type: string free_cancellation_only: description: >- Whether this search is only for rates with free cancellation available. This can affect the rates and accommodation which are returned. If this is false, or omitted, all rates will be searched for. example: false type: boolean guests: description: The list of guests travelling. example: - type: adult - age: 7 type: child items: additionalProperties: false properties: age: description: >- The age of the guest at the time of booking. Required for guests of type `child`. Child age must be between 0 and 17. Do not supply an age for guests of type `adult`. example: 7 format: integer type: - number - 'null' type: description: >- The type of guest. An age is required for guests with a type `child`. enum: - child - adult example: adult type: string title: Guest type: object type: array instant_payment: description: >- When `true`, only accommodation and rates are returned where payment is collected at the time of booking by Duffel or the source. When `false`, only rates where payment is collected by the accommodation are returned. When omitted, all rates are returned. example: false type: boolean x-preview: true location: description: >- Descriptor for an area to search for a stay. Accepts latitude-longitude paired with radius. You must use either this object or the `accommodation` object in your request properties: geographic_coordinates: description: >- The center of the search criteria's radius. Represented by an object containing latitude and longitude. properties: latitude: description: >- The latitude position of the search's center, represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 51.5071 format: float type: number longitude: description: >- The longitude position of the search's center, represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -0.1416 format: float type: number required: - latitude - longitude type: object radius: default: 5 description: >- The search area's extent from the provided coordinates in kilometers. Can only be between 1 and 100. Default of 5km is subject to change. example: 5 type: integer required: - geographic_coordinates type: - object - 'null' mobile: description: >- Whether this search has come from a mobile device. This can affect rates and content returned for this search. example: false type: boolean negotiated_rate_ids: description: > A list of [negotiated rate ids](https://duffel.com/docs/api/v2/negotiated-rates#negotiated-rates-schema-id) to perform the search with. Will return negotiated alongside public rates on a best effort basis for matching [accommodation ids](https://duffel.com/docs/api/v2/negotiated-rates#negotiated-rates-schema-accommodation-ids) on the negotiated rate. example: - nre_0000ATOwpuYnZohiSmlmym items: type: string type: array x-preview: true rooms: description: The number of rooms required example: 1 type: integer required: - check_in_date - check_out_date - guests - rooms type: object title: Body parameters responses: default: content: application/json: schema: {} description: >- Error response; upstream passthrough responses may use provider formats 2XX: content: application/json: schema: type: object required: - data properties: data: additionalProperties: false properties: created_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime on which the search was requested example: '2022-12-20T15:21:01Z' format: date-time type: string results: description: A list of Search Results items: additionalProperties: false properties: accommodation: additionalProperties: false description: >- The accommodation associated with the search result properties: amenities: description: > The amenities for this accommodation. This can be null when we are unable to retrieve amenity data. Accommodation amenities aid guests in identifying the accommodation that suits their needs. These are intended for programmatic use to support filtering or promoting specific accommodation attributes. items: properties: description: description: >- Label-friendly description of the amenity type example: Parking type: string type: description: The amenity type. enum: - parking - gym - wifi - 24_hour_front_desk - accessibility_hearing - accessibility_mobility - adult_only - business_centre - cash_machine - childcare_service - concierge - laundry - lounge - pets_allowed - pool - restaurant - room_service - spa example: parking type: string type: object type: - array - 'null' brand: additionalProperties: false description: The brand associated with the accommodation. properties: id: description: The unique ID for this hotel brand. example: bra_0000Alr8BYNsbmDMThHSbI type: string name: description: The name of the hotel brand. example: Duffel Test type: string title: Brands type: - object - 'null' chain: additionalProperties: false description: >- The chain or group brand the accommodation is a member of properties: id: description: The unique ID for this hotel chain. example: chn_0000Alr8BYNsbmDMThHSbI type: string name: description: The name of the hotel chain. example: Accor Hotels type: string title: Chains type: - object - 'null' check_in_information: description: Check in and check out related information properties: check_in_after_time: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format for the earliest time a guest can check in to their room. example: '14:30' format: time type: - string - 'null' check_in_before_time: description: > The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format for the latest time a guest can check in to their room. Customers who require a late check-in time should request this using the [`accommodation_special_requests`](https://duffel.com/docs/api/v2/bookings/create-booking#bookings-creating-a-booking-body-parameters-accommodation-special-requests) when creating the booking to avoid issues checking in, such as being considered a 'no-show' and the room being offered to someone else. example: '00:00' format: time type: - string - 'null' check_out_before_time: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format for the latest time a guest can check out of their room. example: '11:30' format: time type: - string - 'null' type: - object - 'null' description: description: Description of the accommodation. example: >- Ornate quarters, some with grand pianos, in a luxurious hotel offering acclaimed dining & a spa. type: - string - 'null' email: description: > The accommodation email address. This field can only be populated on the accommodation for a completed booking. Note that this data may differ from the accommodation records if it was updated directly by the accommodation after the booking was created. example: reservations@duffel-hotel-group.com format: email type: - string - 'null' id: description: >- The unique ID for this accommodation. This ID stays consistent between searches — the same accommodation will always have the same ID. example: acc_0000AWr2VsUNIF1Vl91xg0 type: string key_collection: additionalProperties: false description: >- The key collection details for the accommodation. properties: instructions: description: >- The key collection instructions for the accommodation. example: >- Please collect the keys from accommodation's reception. type: string type: - object - 'null' location: additionalProperties: false description: Information on the accommodation's location properties: address: additionalProperties: false description: The accommodation's address properties: city_name: description: >- The name of the city or metropolitan area where the address is located. example: London type: string country_code: description: "The\_[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\_code for the country where the address is located." example: GB type: string line_one: description: First line of the address example: 100 Clifton Street type: string postal_code: description: Postal (or zip code) of the address example: EC2A 4TP type: string region: description: Region or state of the address example: England type: - string - 'null' type: object geographic_coordinates: description: >- The exact latitude-longitude position of the accommodation. Useful for map views. properties: latitude: description: > The latitude position of the accommodation represented in Decimal degrees with 6 decimal points with a range between -90° and 90° example: 51.5071 format: float type: number longitude: description: >- The longitude position of the accommodation represented in Decimal degrees with 6 decimal points with a range between -180° and 180° example: -0.1416 format: float type: number type: object type: object name: description: The accommodation's name example: Duffel Test Hotel type: string payment_instruction_supported: description: >- Indicates whether the accommodation may hold rates that support [supplying payment instructions](/docs/api/v2/booking-payment-instructions/create-booking-payment-instruction) example: false type: boolean phone_number: description: > The accommodation phone number. This field can only be populated on the accommodation for a completed booking. This is provided directly by the accommodation and the format is not guaranteed. Note that this data may differ from the accommodation records if it was updated directly by the accommodation after the booking was created." example: '+442074938181' type: - string - 'null' photos: description: Photos of the accommodation items: additionalProperties: false properties: url: description: > The URL to the photo. Supplied photos of the stay. These may consist of photos of the property, rooms, room amenities and local attractions. example: >- https://assets.duffel.com/img/stays/image.jpg format: url type: string title: Photo type: object type: array rating: description: > A "star rating" of this accommodation. If available, this is an integer from 1 to 5 "stars". This value is consolidated by Duffel based on data provided by our sources and accommodation providers. For more detailed rating information, see `ratings`. example: 3 format: integer type: - number - 'null' ratings: description: > Ratings given to an accommodation by a rating source. This can be empty if the accommodation does not have any ratings. This can also be null if we are unable to retrieve ratings. These are commonly represented as "stars". In Duffel Stays, they have a 1-5 scale. They can come from multiple sources. Currently available rating sources are: - `"priceline"`: [Priceline.com star rating](https://pricelinepartnernetwork.com/developers/guides/id/hotel-content#star-rating). These should be displayed as "stars". While Priceline.com can add half a star to a rating, these ratings are rounded down to the nearest full star in Duffel Stays. - `"bookingcom"`: [Booking.com star rating](https://www.booking.com/content/how_we_work.en-gb.html). These should be displayed as "stars". While Booking.com can add half a star to a rating, these ratings are rounded down to the nearest full star in Duffel Stays. - `"expedia"`: [Expedia star rating](https://developers.expediagroup.com/docs/products/rapid/resources/reference/star-ratings#using-star-ratings). These should be displayed as "stars". While Expedia can add half a star to a rating, these ratings are rounded down to the nearest full star in Duffel Stays. - `"aaa"`: [American Automobile Association Diamonds](https://www.aaa.com/diamonds/). These should be displayed as "diamonds". - `"northstar"`: [Northstar Travel Media Hotel Crown Rating](http://www.hospitalityeducators.com/articles/20110215_4#.ZDPo2C8w1f0). These should be displayed as "crowns". items: properties: source: description: The source of this rating. enum: - priceline - aaa - northstar - bookingcom - expedia type: string value: description: The value of this rating. enum: - 1 - 2 - 3 - 4 - 5 type: integer title: Rating type: object type: - array - 'null' review_count: description: > The number of reviews that contributed to the aggregated review score example: 336 format: integer type: - number - 'null' review_score: description: > A review score of this accommodation, aggregated from guest reviews. If available, the value is a score from the 1.0-10.0 range. This value is consolidated by Duffel based on user review data from multiple sources. example: 8.8 format: float type: - number - 'null' rooms: description: >- Bookable rooms for this accommodation. A room is a single accommodation unit. It might contain multiple beds. items: additionalProperties: false description: > A type of room at an accommodation, containing its characteristics and a range of bookable rates. To learn more about accommodation, rooms and rates and presenting them to customers, check out [Stays Key Concepts](https://duffel.com/docs/api/overview/stays-key-concepts). properties: beds: description: >- Available beds in the room. Bed availability is relayed from the supplier at a best-effort basis, and may not be honoured at the hotel if actual availability does not permit. items: additionalProperties: false properties: count: description: >- The number of beds of this type in the room. example: 2 type: integer type: description: > The type of beds available in the room Available types: "single", "double", "queen", "king", "sofabed", "bunk" enum: - single - double - queen - king - sofabed - bunk example: king type: string title: Bed type: object type: - array - 'null' name: description: The room name. example: Double Suite type: string photos: description: Supplied photos for the room. items: additionalProperties: false properties: url: description: > The URL to the photo. Supplied photos of the stay. These may consist of photos of the property, rooms, room amenities and local attractions. example: >- https://assets.duffel.com/img/stays/image.jpg format: url type: string title: Photo type: object type: - array - 'null' rates: description: >- The available rates for a specific room, including commission, distribution, payment and included services information. items: additionalProperties: false description: > A bookable rate for a stay. To learn more about accommodation, rooms and rates and presenting them to customers, check out [Stays Key Concepts](https://duffel.com/docs/api/overview/stays-key-concepts). properties: available_payment_methods: description: > Available payment methods are the forms of payment supported for this rate. A rate with `balance` as an available payment method can be paid for using your Duffel Balance. A rate with `card` as an available payment method can be paid for with card details provided at time of booking. items: description: > NOTE: Please refer to [available_payment_methods](/docs/api/v2/search-result/schema#search-result-schema-accommodation-accommodation-rooms-accommodation-rooms-rates-accommodation-rooms-rates-available-payment-methods) instead. The payment method is the form of payment supported for this rate. A rate with the `balance` payment method will be paid for using your Duffel Balance. A rate with the `card` payment method will be paid for with card details provided at time of booking. enum: - balance - card example: - balance title: Payment Method type: string type: array base_amount: description: > The base amount for this rate, excluding taxes and fees. Will be `null` if the base amount is unknown. This is included in the `total_amount`. example: '665.83' type: - string - 'null' base_currency: description: "The currency of the\_`base_amount`, as an\_[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)\_currency code.\nThis is always the same as `total_currency`.\n" example: GBP format: ISO 4217 type: string benefits: description: > The inclusions provided as part of this rate. Only populated on rates that carry benefits and where Duffel is the source. items: additionalProperties: false properties: description: description: >- The full description of the benefit, including restrictions and any availability conditions. Suitable for display in a tooltip or expanded detail view. example: >- Daily full breakfast for up to two guests, served in the restaurant. type: string title: description: >- The name of the benefit as it should appear to the traveller. example: Daily breakfast type: string type: description: >- The type of benefit included with the rate. enum: - breakfast_included - property_credit - room_upgrade - early_check_in - late_check_out example: breakfast_included type: string title: Benefit type: object x-preview: true type: - array - 'null' x-preview: true board_type: description: > Board type is a standard way for the hospitality industry to describe the meals and drinks that are included in the rate. The possible board types are: - `'all_inclusive'` - All meals (breakfast, lunch, dinner and snacks) are included, as well as all drinks (soft drinks, tea, coffee, and in some cases, alcoholic beverages). - `'full_board'` - All meals (breakfast, lunch, dinner) are included, but excludes snacks and drinks. - `'half_board'` - Two meals a day are included in the price of the rate. Usually breakfast and dinner, but depending on the hotel, breakfast and lunch may be possible instead. - `'breakfast'` - Only breakfast is included in the price of the rate. - `'room_only'` - No food or drinks are included in the price of the rate. enum: - room_only - breakfast - half_board - full_board - all_inclusive example: room_only type: - string - 'null' cancellation_timeline: description: > A timeline that contains policies, such as possible refunds, once this rate has been booked. This is sorted in ascending chronological order. In the event we get no cancellation information for a rate, we return these as non-refundable - the most conservative cancellation scenario. In reality, there may sometimes be some refund due. The cancellation timeline may differ across different steps of the booking process as we get more precise cancellation information. Complete cancellation timeline is only guaranteed to be available at the quote step. items: additionalProperties: false properties: before: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime for the deadline of a refund. It can either be in UTC, or have an offset. example: '2023-05-23T13:00:00Z' format: date-time type: string currency: description: "The currency of the\_`amount`, as an\_[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)\_currency code." example: GBP format: ISO 4217 type: string refund_amount: description: >- The amount refundable up until the specified `before` date example: '799.00' type: string title: Cancellation timeline type: object type: array code: description: >- A rate code is an alphanumeric identifier of specific negotiated pricing and booking conditions. Rate codes are only returned when special contracted rates are available through the hotel provider, distinguishing them from standard public rates. example: ABC type: - string - 'null' conditions: description: > The conditions or policies that apply to the rate. The information provided should be treated as mandatory and displayed to the guest during and after the booking process. items: additionalProperties: false properties: description: description: >- One or more paragraphs that outline policy, amenity or refundability conditions for the rate. Take note that this may contain links expressed as HTML tags. example: >- Public parking is available nearby for £15 per day type: string title: description: The condition title example: Parking type: string title: Condition type: object type: array deal_types: description: > The deal type that applied to the rate. Deals may include benefits beyond a suppliers public rate, such as discounted price or different conditions. This will be an empty list if no deals apply, and null if there are no known deals. example: - closed_user_group - corporate - mobile items: enum: - closed_user_group - mobile - seasonal - promotion - corporate type: string type: - array - 'null' description: description: > The rate description provided by the rate supplier. This typically includes important information about what's included in the rate, such as meal plans, amenities, credits, upgrades, or special benefits. This field is returned exactly as provided by the supplier and is not normalised or standardised across sources. It's intended for internal use or agent review rather than direct display to the guest, as formatting and content quality may vary significantly between suppliers. example: >- Complimentary Breakfast 2Ppl, 100Usd Htl Crdt Person Stay Or Lcl Curr Equiv Or 100 Fb Crdt, Nxt Cat Upgrd Subj To Available. type: - string - 'null' x-preview: true due_at_accommodation_amount: description: > Mandatory fees or taxes that are due by the guest at the accommodation. Depending on the accommodation these may be payable on check in or check out. These fees are not collected during the booking process. Will be `null` if the amount due at accommodation is unknown. This is not included in the `total_amount`. example: '39.95' type: - string - 'null' due_at_accommodation_currency: description: "The currency of the\_`due_at_accommodation_amount`, as an\_[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)\_currency code.\nThis can be different from `total_currency`.\n" example: GBP format: ISO 4217 type: string estimated_commission_amount: description: >- This is the gross commission amount for this rate, before profit share being applied as per your order form. The estimate is supplied on a best-effort basis, and the accuracy depends on the rate supplier. Will be `null` if the estimated commission amount is unknown. example: '100.00' type: - string - 'null' estimated_commission_currency: description: >- The currency of the [estimated_commission_amount](/docs/api/v2/accommodation/schema#accommodation-schema-rooms-rooms-rates-rooms-rates-estimated-commission-amount), as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. example: GBP format: ISO 4217 type: - string - 'null' expires_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the rate will expire example: '2023-05-28T12:00:00Z' format: date-time type: string fee_amount: description: | The fee amount for this rate. This is included in the `total_amount`. example: '50.94' type: - string - 'null' fee_currency: description: "The currency of the\_`fee_amount`, as an\_[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)\_currency code.\nThis is always the same as `total_currency`.\n" example: GBP format: ISO 4217 type: string id: description: The `id` of a given rate example: rat_0000BTVRuKZTavzrZDJ4cb type: string loyalty_programme_required: description: >- Whether this rate requires you to be a member of the supported loyalty programme. If true, you must supply a [loyalty_programme_account_number](/docs/api/v2/bookings/create-booking#bookings-creating-a-booking-body-parameters-loyalty-programme-account-number) when creating a booking for this rate. example: false type: boolean name: description: > The rate name provided by the rate supplier. This is suitable for display in a rate card or search result. May be null if the hotel or supplier does not return a rate name. example: Best Available Rate type: - string - 'null' x-preview: true negotiated_rate_id: description: >- The `id` of the negotiated rate used to obtain this rate example: nre_0000ATOwpuYnZohiSmlmyz type: - string - 'null' x-preview: true payment_instruction_allowed: description: >- Whether it will be possible to submit a [payment instruction](/docs/api/v2/booking-payment-instructions) for a booking created from this rate. type: boolean x-preview: true payment_type: description: > The payment type for this rate. It describes how and when the payment_method will be charged. `pay_now` rates require full prepayment at the time of creating a booking or before check-in. `deposit` rates require a prepayment which will be taken at the time of booking or before check-in. The customer is required to pay for the remainder at the accommodation. The refundability of the deposit depends on the accommodation's cancellation conditions. `guarantee` rates are only supported for card as the payment method. The card may be charged by the accommodation, i.e. in the event of a no-show. Another form of payment may be requested by the accommodation for payment at check-in or check-out. enum: - pay_now - guarantee - deposit example: pay_now type: string public_amount: description: > The public price for the same rate if purchased via the hotel website, or the Online Travel Agency website. If public_amount matches the [total_amount](/docs/api/v2/accommodation/schema#accommodation-schema-rooms-rooms-rates-rooms-rates-total-amount) for the rate, then the rate you have is a public rate. If public_amount is greater than the [total_amount](/docs/api/v2/accommodation/schema#accommodation-schema-rooms-rooms-rates-rooms-rates-total-amount), then you have a discounted rate. public_amount will be null if no information is available. example: '699.99' type: - string - 'null' public_currency: description: > The currency of the [public_amount](/docs/api/v2/accommodation/schema#accommodation-schema-rooms-rooms-rates-rooms-rates-public-amount), as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. This is always the same as `total_currency`. example: GBP format: ISO 4217 type: string quantity_available: description: >- The quantity of rooms available to be booked at this rate. This number is not guaranteed to be accurate. Will be `null` if this information is unknown. example: 12 type: - integer - 'null' source: description: The source provider of this rate enum: - sabre - expedia - bookingcom - travelport - priceline - duffel_hotel_group - duffel type: string supported_loyalty_programme: description: > The loyalty programme that this rate supports. While the accommodation the rate comes from might support a loyalty programme in general (shown in its `supported_loyalty_programme` property), not all rates will. The rate's `supported_loyalty_programme` allows you to check loyalty programme support on a per-rate basis. Note that different rates from an accommodation won't have different supported loyalty programmes — it will always be the same one as the accommodation's. If the accommodation does not support a loyalty programme, this will always be `null`. enum: - wyndham_rewards - choice_privileges - marriott_bonvoy - best_western_rewards - world_of_hyatt - hilton_honors - ihg_one_rewards - leaders_club - stash_rewards - omni_select_guest - i_prefer - accor_live_limitless - my_6 - jumeirah_one - global_hotel_alliance_discovery - duffel_hotel_group_rewards example: duffel_hotel_group_rewards title: Loyalty Programme Reference type: - string - 'null' tax_amount: description: > The tax amount for this rate. Will be `null` if the tax amount is unknown. This is included in the `total_amount`. example: '82.23' type: - string - 'null' tax_currency: description: "The currency of the\_`tax_amount`, as an\_[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)\_currency code.\nThis is always the same as `total_currency`.\n" example: GBP format: ISO 4217 type: string total_amount: description: > The total price for the room for all nights and for all guests. This always equals `base_amount` + `tax_amount` + `fee_amount`. Please note, the guest may be required to pay mandatory fees and taxes at the accommodation. These are not included in the `total_amount`, and are included in `due_at_accommodation_amount`. example: '799.00' type: string total_currency: description: "The currency of the\_`total_amount`, as an\_[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)\_currency code." example: GBP format: ISO 4217 type: string title: Rate type: object type: array title: Room type: object type: array supported_loyalty_programme: description: > The loyalty programme that is supported by the accommodation. Note that while the accommodation might support a loyalty programme in general, not all rates will. See the rate's `supported_loyalty_programme` property to check this on a per-rate basis. enum: - wyndham_rewards - choice_privileges - marriott_bonvoy - best_western_rewards - world_of_hyatt - hilton_honors - ihg_one_rewards - leaders_club - stash_rewards - omni_select_guest - i_prefer - accor_live_limitless - my_6 - jumeirah_one - global_hotel_alliance_discovery - duffel_hotel_group_rewards example: duffel_hotel_group_rewards title: Loyalty Programme Reference type: - string - 'null' title: Accommodation type: object cheapest_rate_base_amount: description: > The `cheapest_rate_base_amount` is for search result display purposes. It is equivalent to the cheapest rate [base_amount](/docs/api/v2/search-result/schema#search-result-schema-accommodation-accommodation-rooms-accommodation-rooms-rates-accommodation-rooms-rates-base-amount) for the cheapest room at this accommodation. The rate amount is a best effort computation during the time a search is made, and can change when [fetching the rates](/docs/api/v2/search-result/fetch-all-rates). It is not guaranteed to be accurate. This can be `null` if the base amount is unknown. example: '699.00' type: - string - 'null' cheapest_rate_base_currency: description: "The currency for `cheapest_rate_base_amount` for this accommodation, as an\_[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)\_currency code.\n" example: GBP format: ISO 4217 type: - string - 'null' cheapest_rate_currency: description: "The currency for `cheapest_rate_total_amount` for this accommodation, as an\_[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)\_currency code.\n" example: GBP format: ISO 4217 type: string cheapest_rate_due_at_accommodation_amount: description: > The `cheapest_rate_due_at_accommodation_amount` is for search result display purposes. It is equivalent to the cheapest rate [due_at_accommodation_amount](/docs/api/v2/search-result/schema#search-result-schema-accommodation-accommodation-rooms-accommodation-rooms-rates-accommodation-rooms-rates-due-at-accommodation-amount) for the cheapest room at this accommodation. The rate amount is a best effort computation during the time a search is made, and can change when [fetching the rates](/docs/api/v2/search-result/fetch-all-rates). It is not guaranteed to be accurate. This can be `null` if the due at the accommodation amount is unknown. example: '699.00' type: - string - 'null' cheapest_rate_due_at_accommodation_currency: description: "The currency for `cheapest_rate_due_at_accommodation_amount` for this accommodation, as an\_[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)\_currency code.\n" example: GBP format: ISO 4217 type: - string - 'null' cheapest_rate_public_amount: description: > The `cheapest_rate_public_amount` is for search result display purposes. It is equivalent to the cheapest rate [public_amount](/docs/api/v2/search-result/schema#search-result-schema-accommodation-accommodation-rooms-accommodation-rooms-rates-accommodation-rooms-rates-public-amount) for the cheapest room at this accommodation. The rate amount is a best effort computation during the time a search is made, and can change when [fetching the rates](/docs/api/v2/search-result/fetch-all-rates). It is not guaranteed to be accurate. The amount will usually be higher than the `cheapest_rate_total_amount`, but can be lower. This can be `null` if the public amount is unknown. example: '899.00' type: - string - 'null' cheapest_rate_public_currency: description: "The currency for `cheapest_rate_public_amount` for this accommodation, as an\_[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)\_currency code.\n" example: GBP format: ISO 4217 type: - string - 'null' cheapest_rate_total_amount: description: > The `cheapest_rate_total_amount` is for search result display purposes. It is equivalent to the cheapest rate [total_amount](/docs/api/internal/rates/schema#rates-schema-total-amount) for the cheapest room at this accommodation. The rate amount is a best effort computation during the time a search is made, and can change when [fetching the rates](/docs/api/v2/search-result/fetch-all-rates). It is not guaranteed to be accurate. It will always show a value, even when rooms data is empty in the initial Search response. example: '799.00' type: string check_in_date: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the guest wants to check in example: '2023-05-24' format: date type: string check_out_date: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the guest wants to check out example: '2023-05-28' format: date type: string expires_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the search result will expire example: '2023-05-28T12:00:00Z' format: date-time type: string guests: description: The list of guests travelling items: additionalProperties: false properties: age: description: >- The age of the guest at the time of booking. Required for guests of type `child`. Child age must be between 0 and 17. Do not supply an age for guests of type `adult`. example: 7 format: integer type: - number - 'null' type: description: >- The type of guest. An age is required for guests with a type `child`. enum: - child - adult example: adult type: string title: Guest type: object type: - array - 'null' id: description: The ID for this search result example: srr_0000ASVBuJVLdmqtZDJ4ca type: string rooms: description: The number of rooms required example: 1 type: integer supported_negotiated_rates: description: >- The list of negotiated rates supported by this search result. Any negotiated rates in this list were used when searching. items: additionalProperties: false properties: display_name: description: The display name of the negotiated rate example: 2025 Negotiated Rate type: string id: description: >- The ID of the negotiated rate which has been searched for example: nre_0000AvtkNoC81yBytDM9PE type: string title: Supported Negotiated Rate type: object type: array x-preview: true title: Search Result type: object type: array title: Search type: object meta: type: object properties: limit: type: number before: type: string after: type: - string - 'null' description: Successful JSON response; SDK accepts the successful HTTP range. components: securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.