> ## Documentation Index
> Fetch the complete documentation index at: https://docs.d-edge.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> This site documents the D-EDGE APIs for technology partners (web agencies, OTAs, PMS and RMS vendors, booking and CRM tools). It is written for developers integrating with hotels that use the D-EDGE platform.
> Seven APIs, grouped by domain. Connectivity: Channel Manager API (distribute a hotel's inventory to your channel and send bookings back). Pricing & Availability: Best Price API (best offers to highlight), Quotation API (all bookable offers for a stay), Daily Rates API (daily availability between two dates). Booking: Booking Engine API (a hotel's full direct booking funnel), Gift Shop API (gift vouchers from catalogue to payment). Guest Management: CRM API (guest profiles).
> Pick the API by the need: to display prices, use the Best Price API or the Daily Rates API; to quote a specific stay, use the Quotation API; to book, use the Booking Engine API; to sell gift vouchers, use the Gift Shop API; to manage guest profiles, use the CRM API; to receive hotel inventory and send bookings back as a distribution channel, use the Channel Manager API.
> Base URLs, hotel identifiers, and credentials are delivered by the D-EDGE partnership team during onboarding. Do not invent base URLs, endpoints, parameters, or example credentials that do not appear on these pages.
> Authentication differs per API: OAuth 1.0 for Best Price, Quotation, Daily Rates, and Booking Engine; an X-API-KEY header for Gift Shop; OAuth 2.0 client credentials for CRM; partner-defined credentials carried in the XML message for the Channel Manager API. Read each API's Authentication page before writing code.
> A mock environment returns realistic but fictitious data without credentials. The Postman and Insomnia collections on the API collections page target it by default. Use it for exploration and tests, never for production traffic.
> Use the official names exactly: D-EDGE, D-EDGE platform, Channel Manager API, partnership team. Do not use Back Office or Extranet.
> Each API has a Changelog page. Check it for the current behaviour before relying on an older answer. For questions these pages do not answer, direct the reader to the Contact us page.

# Provides hotels availabilities

> Provides hotels availabilities matching the session context



## OpenAPI

````yaml booking-engine-api/open-api/booking-engine-api.json GET /v2/{sessionId}/search/hotels
openapi: 3.0.1
info:
  title: Booking Engine API
  version: v2
servers:
  - url: https://{apiBaseUrl}
    variables:
      apiBaseUrl:
        default: api.example.com
        description: Base URL delivered by D-EDGE during partnership setup
security: []
tags:
  - name: Basket
  - name: Booking
  - name: Configuration
  - name: Description
  - name: Loyalty
  - name: Promotion
  - name: Resources
  - name: Search
  - name: Session
paths:
  /v2/{sessionId}/search/hotels:
    get:
      tags:
        - Search
      summary: Provides hotels availabilities matching the session context.
      description: "Hotels availabilities could be searched only if a selectedHotelId has NOT been specified in the session context.\r\n            \r\nThe **X-AVP-Properties** header attribute  can contain some or all the following values, separated with | character:\r\n* `Description`\r\n* `UnavailableHotels`\r\n            \r\nThe **X-AVP-DescriptionType** header attribute can contain one of the following values:\r\n* `text/html` (default)\r\n* `text/plain`\r\n* `text/x-markdown`\r\n            \r\nThe **X-AVP-PictureTemplates** should contains the list of picture templates requested, separated with | character."
      operationId: Search_GetHotels
      parameters:
        - name: X-AVP-Properties
          in: header
          description: The properties required in the response.
          required: false
          schema:
            type: string
        - name: X-AVP-DescriptionType
          in: header
          description: Mime type of the descriptions.
          required: false
          schema:
            type: string
        - name: X-AVP-PictureTemplates
          in: header
          description: The picture templates.
          required: false
          schema:
            type: string
        - name: pageNumber
          in: query
          description: The number of the requested page.
          required: false
          schema:
            format: int32
            type: integer
        - name: pageSize
          in: query
          description: The number of results per response.
          required: false
          schema:
            format: int32
            type: integer
        - name: X-AVP-Impersonation
          in: header
          description: ''
          required: false
          schema:
            type: string
        - name: sessionId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Search.Hotel.HubSearchHotelResult'
              examples:
                response:
                  value:
                    hotels:
                      - hotelId: '10123'
                        name: Hotel 1
                        description:
                          summary:
                            - text: Best hotel in the area
                              value: PlainText
                          pictures:
                            - templates:
                                - name: XLarge
                                  url: >-
                                    http://www.example.com/files/images/XLarge.jpg
                              sortOrder: 1
                          amenities:
                            - text: Air Conditioning
                              value: AirConditioning
                            - text: Bar
                              value: Bar
                          rating: FourStars
                          location:
                            city: Paris
                            postalCode: '75009'
                            country:
                              code: FR
                              name: France
                            gpsPosition:
                              latitude: 48.8713379
                              longitude: 2.3441099
                            directions:
                              - text: Go left and than turn right.
                                value: PlainText
                            distance:
                              text: 1,2 km
                              value: 1.2
                            addressLines:
                              - 17 Cherry Tree Lane
                            district: ''
                          roomCount: 200
                          cardTypes:
                            - AmericanExpress
                            - MasterCard
                            - Visa
                          checkInTime:
                            text: 15h00
                            value: '15:00:00'
                          checkOutTime:
                            text: 10h00
                            value: '10:00:00'
                          openingHours:
                            text: 00h00 - 23h59
                            value:
                              openingTime: '00:00:00'
                              closureTime: '23:59:00'
                          websites:
                            - https://test.fr
                          phones:
                            - '+33279278242'
                          emails:
                            - hello@test.fr
                          hotelPaymentMethods:
                            supportedCardTypes:
                              - AmericanExpress
                              - MasterCard
                              - Visa
                            supportedPaymentMethods:
                              - IDeal
                              - Paypal
                        availabilityPrice:
                          lowest:
                            price:
                              totalPrice:
                                converted:
                                  text: 113 $
                                  value:
                                    amount: 113
                                    currency: USD
                                original:
                                  text: 100 €
                                  value:
                                    amount: 100
                                    currency: EUR
                              crossedOutPrice:
                                converted:
                                  text: 226 $
                                  value:
                                    amount: 226
                                    currency: USD
                                original:
                                  text: 200 €
                                  value:
                                    amount: 200
                                    currency: EUR
                              discountType: CrossedOut
                              promoCode:
                                offerCodeId: 4b06847c-2901-43c9-ab90-34cf4ce152aa
                                code: ''
                                description: Last minute discount
                                nominal:
                                  converted:
                                    text: 113 $
                                    value:
                                      amount: 113
                                      currency: USD
                                  original:
                                    text: 100 €
                                    value:
                                      amount: 100
                                      currency: EUR
                                percent:
                                  text: ''
                                  value: 0
                                calculationMode: Nominal
                                isPublic: true
                                isApplied: true
                                isMobile: false
                                isFlashSales: false
                                displayCountdown: false
                                endDate: '2026-06-03T08:05:26.9388436Z'
                            additionalFees: 30
                            additionalTaxes: 10
                            includedTaxes: 5
                            includedFees: 5
                            availabilityType: Available
                        promotions:
                          - id: 00000000-0000-0000-0000-000000000000
                            code: DISCOUNT
                            isPublic: false
                            isMobile: false
                            isFlashSales: false
                        isPrivateRateCode: false
                    unavailabilityType: None
                    filters:
                      - type:
                          text: Rating
                          value: Rating
                        values:
                          - text: Four stars hotel
                            value: FourStars
                    sortOrders:
                      - text: Relevance
                        value: Default
                      - text: Ascending price
                        value: AscendingPrice
                      - text: Descending price
                        value: DescendingPrice
                      - text: Rating
                        value: Rating
                    paging:
                      currentPageNumber: 1
                      pageSize: 10
                      resultsCount: 30
                      totalResultsCount: 50
            text/json:
              schema:
                $ref: '#/components/schemas/Search.Hotel.HubSearchHotelResult'
              examples:
                response:
                  value:
                    hotels:
                      - hotelId: '10123'
                        name: Hotel 1
                        description:
                          summary:
                            - text: Best hotel in the area
                              value: PlainText
                          pictures:
                            - templates:
                                - name: XLarge
                                  url: >-
                                    http://www.example.com/files/images/XLarge.jpg
                              sortOrder: 1
                          amenities:
                            - text: Air Conditioning
                              value: AirConditioning
                            - text: Bar
                              value: Bar
                          rating: FourStars
                          location:
                            city: Paris
                            postalCode: '75009'
                            country:
                              code: FR
                              name: France
                            gpsPosition:
                              latitude: 48.8713379
                              longitude: 2.3441099
                            directions:
                              - text: Go left and than turn right.
                                value: PlainText
                            distance:
                              text: 1,2 km
                              value: 1.2
                            addressLines:
                              - 17 Cherry Tree Lane
                            district: ''
                          roomCount: 200
                          cardTypes:
                            - AmericanExpress
                            - MasterCard
                            - Visa
                          checkInTime:
                            text: 15h00
                            value: '15:00:00'
                          checkOutTime:
                            text: 10h00
                            value: '10:00:00'
                          openingHours:
                            text: 00h00 - 23h59
                            value:
                              openingTime: '00:00:00'
                              closureTime: '23:59:00'
                          websites:
                            - https://test.fr
                          phones:
                            - '+33279278242'
                          emails:
                            - hello@test.fr
                          hotelPaymentMethods:
                            supportedCardTypes:
                              - AmericanExpress
                              - MasterCard
                              - Visa
                            supportedPaymentMethods:
                              - IDeal
                              - Paypal
                        availabilityPrice:
                          lowest:
                            price:
                              totalPrice:
                                converted:
                                  text: 113 $
                                  value:
                                    amount: 113
                                    currency: USD
                                original:
                                  text: 100 €
                                  value:
                                    amount: 100
                                    currency: EUR
                              crossedOutPrice:
                                converted:
                                  text: 226 $
                                  value:
                                    amount: 226
                                    currency: USD
                                original:
                                  text: 200 €
                                  value:
                                    amount: 200
                                    currency: EUR
                              discountType: CrossedOut
                              promoCode:
                                offerCodeId: 4b06847c-2901-43c9-ab90-34cf4ce152aa
                                code: ''
                                description: Last minute discount
                                nominal:
                                  converted:
                                    text: 113 $
                                    value:
                                      amount: 113
                                      currency: USD
                                  original:
                                    text: 100 €
                                    value:
                                      amount: 100
                                      currency: EUR
                                percent:
                                  text: ''
                                  value: 0
                                calculationMode: Nominal
                                isPublic: true
                                isApplied: true
                                isMobile: false
                                isFlashSales: false
                                displayCountdown: false
                                endDate: '2026-06-03T08:05:26.9388436Z'
                            additionalFees: 30
                            additionalTaxes: 10
                            includedTaxes: 5
                            includedFees: 5
                            availabilityType: Available
                        promotions:
                          - id: 00000000-0000-0000-0000-000000000000
                            code: DISCOUNT
                            isPublic: false
                            isMobile: false
                            isFlashSales: false
                        isPrivateRateCode: false
                    unavailabilityType: None
                    filters:
                      - type:
                          text: Rating
                          value: Rating
                        values:
                          - text: Four stars hotel
                            value: FourStars
                    sortOrders:
                      - text: Relevance
                        value: Default
                      - text: Ascending price
                        value: AscendingPrice
                      - text: Descending price
                        value: DescendingPrice
                      - text: Rating
                        value: Rating
                    paging:
                      currentPageNumber: 1
                      pageSize: 10
                      resultsCount: 30
                      totalResultsCount: 50
        '400':
          description: The session code is invalid
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BookingEngine.Hub.Service.Examples.Session.InvalidSessionErrorResponse
              examples:
                response:
                  value:
                    code: InvalidHotelId
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/BookingEngine.Hub.Service.Examples.Session.InvalidSessionErrorResponse
              examples:
                response:
                  value:
                    code: InvalidHotelId
        '401':
          description: >-
            Authentication header is invalid or does not give access to the
            operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BookingEngine.Hub.Service.Controllers.ErrorResponse_BookingEngine.Hub.Service.Config.SecurityErrorType_
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/BookingEngine.Hub.Service.Controllers.ErrorResponse_BookingEngine.Hub.Service.Config.SecurityErrorType_
components:
  schemas:
    Search.Hotel.HubSearchHotelResult:
      required:
        - hotels
        - filters
        - sortOrders
        - paging
        - unavailabilityType
      type: object
      properties:
        hotels:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/Search.Hotel.HubSearchHotelResultHotel'
        unavailabilityType:
          $ref: '#/components/schemas/Search.Hotel.HubSearchHotelUnavailabilityType'
        filters:
          default: []
          type: array
          items:
            $ref: >-
              #/components/schemas/Search.HubSearchFilter_Search.HubSearchHotelFilterType_
        sortOrders:
          default: []
          type: array
          items:
            $ref: >-
              #/components/schemas/Common.HubValueText_Search.Hotel.HubHotelSortType_
        paging:
          default:
            currentPageNumber: 0
            pageSize: 0
            resultsCount: 0
            totalResultsCount: 0
          allOf:
            - $ref: '#/components/schemas/Search.HubSearchResultPaging'
    BookingEngine.Hub.Service.Examples.Session.InvalidSessionErrorResponse:
      required:
        - code
      type: object
      properties:
        code:
          default: InvalidSessionId
          type: string
        message:
          type: string
    BookingEngine.Hub.Service.Controllers.ErrorResponse_BookingEngine.Hub.Service.Config.SecurityErrorType_:
      allOf:
        - $ref: >-
            #/components/schemas/BookingEngine.Hub.Service.Controllers.ErrorResponse
        - required:
            - code
          type: object
          properties:
            code:
              $ref: >-
                #/components/schemas/BookingEngine.Hub.Service.Config.SecurityErrorType
    Search.Hotel.HubSearchHotelResultHotel:
      required:
        - description
        - availabilityPrice
        - promotions
        - hotelId
        - isPrivateRateCode
      type: object
      properties:
        hotelId:
          $ref: '#/components/schemas/Common.HubHotelId'
        name:
          type: string
        description:
          default:
            summary: []
            pictures: []
            amenities: []
            rating: NoStar
            location:
              country:
                code: ''
                name: ''
              gpsPosition:
                latitude: 0
                longitude: 0
              directions: []
              addressLines: []
            roomCount: 0
            cardTypes: []
            checkInTime: {}
            checkOutTime: {}
            openingHours: {}
            websites: []
            phones: []
            emails: []
            hotelPaymentMethods:
              supportedCardTypes: []
              supportedPaymentMethods: []
          allOf:
            - $ref: >-
                #/components/schemas/Search.Hotel.HubSearchHotelResultDescription
        availabilityPrice:
          default:
            lowest:
              price:
                totalPrice:
                  converted:
                    value:
                      amount: 0
                  original:
                    value:
                      amount: 0
                crossedOutPrice:
                  converted:
                    value:
                      amount: 0
                  original:
                    value:
                      amount: 0
                discountType: None
              availabilityType: NotAvailable
          allOf:
            - $ref: >-
                #/components/schemas/Search.Hotel.HubSearchHotelAvailabilityPrice
        promotions:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/Promotion.HubSearchHotelPromoResult'
        isPrivateRateCode:
          type: boolean
    Search.Hotel.HubSearchHotelUnavailabilityType:
      description: >-
        Reason why a hotel appears as unavailable in the search result.


        - **None** — No unavailability reason applies.

        - **NoAvailability** — The hotel has no availability for the requested
        search context.

        - **NoAvailabilityWithFilters** — The hotel has no availability once the
        current search filters are applied.
      enum:
        - None
        - NoAvailability
        - NoAvailabilityWithFilters
      type: string
    Search.HubSearchFilter_Search.HubSearchHotelFilterType_:
      allOf:
        - $ref: '#/components/schemas/Search.HubSearchFilter'
        - required:
            - type
          type: object
          properties:
            type:
              $ref: >-
                #/components/schemas/Common.HubValueText_Search.HubSearchHotelFilterType_
    Common.HubValueText_Search.Hotel.HubHotelSortType_:
      allOf:
        - $ref: '#/components/schemas/Common.HubValueText'
        - required:
            - value
          type: object
          properties:
            value:
              $ref: '#/components/schemas/Search.Hotel.HubHotelSortType'
    Search.HubSearchResultPaging:
      required:
        - currentPageNumber
        - pageSize
        - resultsCount
        - totalResultsCount
      type: object
      properties:
        currentPageNumber:
          format: int32
          type: integer
        pageSize:
          format: int32
          type: integer
        resultsCount:
          format: int32
          type: integer
        totalResultsCount:
          format: int32
          type: integer
    BookingEngine.Hub.Service.Controllers.ErrorResponse:
      type: object
      properties:
        message:
          type: string
    BookingEngine.Hub.Service.Config.SecurityErrorType:
      description: >-
        Category of security failure returned when authentication or
        authorization is rejected.
      enum:
        - InvalidUserAuthentication
        - InvalidUserRoles
        - InvalidPermissions
      type: string
    Common.HubHotelId:
      type: string
    Search.Hotel.HubSearchHotelResultDescription:
      required:
        - summary
        - pictures
        - amenities
        - location
        - cardTypes
        - checkInTime
        - checkOutTime
        - openingHours
        - websites
        - phones
        - emails
        - hotelPaymentMethods
        - rating
        - roomCount
      type: object
      properties:
        summary:
          default: []
          type: array
          items:
            $ref: >-
              #/components/schemas/Common.HubValueText_Common.HubDescriptionType_
        pictures:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/Common.HubPicture'
        amenities:
          default: []
          type: array
          items:
            $ref: >-
              #/components/schemas/Common.HubValueText_Description.Hotel.HubHotelAmenityId_
        rating:
          $ref: '#/components/schemas/Common.HubHotelRating'
        location:
          default:
            country:
              code: ''
              name: ''
            gpsPosition:
              latitude: 0
              longitude: 0
            directions: []
            addressLines: []
          allOf:
            - $ref: '#/components/schemas/Search.Hotel.HubSearchHotelResultLocation'
        roomCount:
          format: int32
          type: integer
        cardTypes:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/HotelBusiness.Cards.CardType'
        checkInTime:
          default: {}
          allOf:
            - $ref: >-
                #/components/schemas/Common.HubValueText_System.Nullable_System.TimeSpan_
        checkOutTime:
          default: {}
          allOf:
            - $ref: >-
                #/components/schemas/Common.HubValueText_System.Nullable_System.TimeSpan_
        openingHours:
          default: {}
          allOf:
            - $ref: >-
                #/components/schemas/Common.HubValueText_Description.Hotel.HubHotelOpeningHours_
        websites:
          default: []
          type: array
          items:
            type: string
        phones:
          default: []
          type: array
          items:
            type: string
        emails:
          default: []
          type: array
          items:
            type: string
        hotelPaymentMethods:
          default:
            supportedCardTypes: []
            supportedPaymentMethods: []
          allOf:
            - $ref: '#/components/schemas/Description.Hotel.HubHotelPaymentMethods'
    Search.Hotel.HubSearchHotelAvailabilityPrice:
      required:
        - lowest
      type: object
      properties:
        lowest:
          default:
            price:
              totalPrice:
                converted:
                  value:
                    amount: 0
                original:
                  value:
                    amount: 0
              crossedOutPrice:
                converted:
                  value:
                    amount: 0
                original:
                  value:
                    amount: 0
              discountType: None
            availabilityType: NotAvailable
          allOf:
            - $ref: >-
                #/components/schemas/Search.Hotel.HubSearchHotelResultAvailability
        highest:
          $ref: '#/components/schemas/Search.Hotel.HubSearchHotelResultAvailability'
    Promotion.HubSearchHotelPromoResult:
      required:
        - id
        - isPublic
        - isMobile
        - isFlashSales
      type: object
      properties:
        id:
          $ref: '#/components/schemas/HotelBusiness.OfferCode.Common.OfferCodeId'
        code:
          type: string
        isPublic:
          type: boolean
        isMobile:
          type: boolean
        isFlashSales:
          type: boolean
    Search.HubSearchFilter:
      type: object
      properties:
        values:
          type: array
          items:
            $ref: '#/components/schemas/Common.HubValueText_System.String_'
    Common.HubValueText_Search.HubSearchHotelFilterType_:
      allOf:
        - $ref: '#/components/schemas/Common.HubValueText'
        - required:
            - value
          type: object
          properties:
            value:
              $ref: '#/components/schemas/Search.HubSearchHotelFilterType'
    Common.HubValueText:
      type: object
      properties:
        text:
          type: string
    Search.Hotel.HubHotelSortType:
      description: Sort order applied to a hotel search result.
      enum:
        - Default
        - DescendingPrice
        - AscendingPrice
        - Rating
        - Name
      type: string
    Common.HubValueText_Common.HubDescriptionType_:
      allOf:
        - $ref: '#/components/schemas/Common.HubValueText'
        - required:
            - value
          type: object
          properties:
            value:
              $ref: '#/components/schemas/Common.HubDescriptionType'
    Common.HubPicture:
      required:
        - templates
        - sortOrder
      type: object
      properties:
        templates:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/Common.HubPictureTemplate'
        sortOrder:
          format: int32
          type: integer
    Common.HubValueText_Description.Hotel.HubHotelAmenityId_:
      allOf:
        - $ref: '#/components/schemas/Common.HubValueText'
        - required:
            - value
          type: object
          properties:
            value:
              $ref: '#/components/schemas/Description.Hotel.HubHotelAmenityId'
    Common.HubHotelRating:
      description: Official star rating of the hotel.
      enum:
        - NoStar
        - OneStar
        - TwoStars
        - ThreeStars
        - FourStars
        - FiveStars
      type: string
    Search.Hotel.HubSearchHotelResultLocation:
      required:
        - country
        - gpsPosition
        - directions
        - addressLines
      type: object
      properties:
        city:
          type: string
        postalCode:
          type: string
        country:
          default:
            code: ''
            name: ''
          allOf:
            - $ref: '#/components/schemas/Description.Hotel.HubHotelCountry'
        gpsPosition:
          default:
            latitude: 0
            longitude: 0
          allOf:
            - $ref: '#/components/schemas/Common.HubGpsPosition'
        directions:
          default: []
          type: array
          items:
            $ref: >-
              #/components/schemas/Common.HubValueText_Common.HubDescriptionType_
        distance:
          $ref: '#/components/schemas/Common.HubValueText_System.Double_'
        addressLines:
          default: []
          type: array
          items:
            type: string
        district:
          type: string
    HotelBusiness.Cards.CardType:
      enum:
        - Visa
        - MasterCard
        - AmericanExpress
        - DinersClub
        - Jcb
        - Undefined
      type: string
    Common.HubValueText_System.Nullable_System.TimeSpan_:
      allOf:
        - $ref: '#/components/schemas/Common.HubValueText'
        - type: object
          properties:
            value:
              format: time
              type: string
    Common.HubValueText_Description.Hotel.HubHotelOpeningHours_:
      allOf:
        - $ref: '#/components/schemas/Common.HubValueText'
        - type: object
          properties:
            value:
              $ref: '#/components/schemas/Description.Hotel.HubHotelOpeningHours'
    Description.Hotel.HubHotelPaymentMethods:
      required:
        - supportedCardTypes
        - supportedPaymentMethods
      type: object
      properties:
        supportedCardTypes:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/Common.SupportedCardType'
        supportedPaymentMethods:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/Common.SupportedPaymentMethod'
    Search.Hotel.HubSearchHotelResultAvailability:
      required:
        - price
        - availabilityType
      type: object
      properties:
        price:
          default:
            totalPrice:
              converted:
                value:
                  amount: 0
              original:
                value:
                  amount: 0
            crossedOutPrice:
              converted:
                value:
                  amount: 0
              original:
                value:
                  amount: 0
            discountType: None
          allOf:
            - $ref: '#/components/schemas/Search.HubAvailabilityPrice'
        taxes:
          $ref: '#/components/schemas/Common.HubSearchTaxes'
        additionalFees:
          format: decimal
          type: number
        additionalTaxes:
          format: decimal
          type: number
        includedTaxes:
          format: decimal
          type: number
        includedFees:
          format: decimal
          type: number
        availabilityType:
          $ref: '#/components/schemas/Search.Hotel.HubHotelAvailabilityType'
    HotelBusiness.OfferCode.Common.OfferCodeId:
      format: uuid
      type: string
    Common.HubValueText_System.String_:
      allOf:
        - $ref: '#/components/schemas/Common.HubValueText'
        - type: object
          properties:
            value:
              type: string
    Search.HubSearchHotelFilterType:
      description: Facet used to narrow down a hotel search result.
      enum:
        - Undefined
        - City
        - Country
        - Localisation
        - Rating
        - Budget
        - Amenities
      type: string
    Common.HubDescriptionType:
      description: Markup format used for rich-text description fields returned by the API.
      enum:
        - Html
        - Markdown
        - PlainText
      type: string
    Common.HubPictureTemplate:
      type: object
      properties:
        name:
          type: string
        url:
          type: string
    Description.Hotel.HubHotelAmenityId:
      description: >-
        Hotel-level amenity or service. Values are grouped in numeric ranges by
        category (reception, restauration, leisure, communication, transport,
        custom, security).
      enum:
        - MoneyExchange
        - ReceptionAvailable24Hours
        - LocalTaxNotIncluded
        - PetsWelcome
        - WheelchairAccess
        - MembershipCardRequired
        - MembershipCardSoldOnSite
        - Garden
        - Terrace
        - Elevator
        - CentralHeating
        - LinenIncluded
        - LinenAvailable
        - TowelIncluded
        - TowelAvailable
        - Laundry
        - BreakfastFacilities
        - MealFacilities
        - TakeAway
        - Cafeteria
        - Restaurant
        - NoAlcoholBar
        - BarbecueAvailable
        - Bar
        - FoodStore
        - AirConditioning
        - HotShower
        - BilliardRoom
        - TelevisionRoom
        - GamesRoom
        - Playground
        - ReadingRoom
        - BooksAvailable
        - NightClub
        - Excursions
        - Tennis
        - IndoorSwimmingPool
        - OutdoorSwimmingPool
        - Sauna
        - Jacuzzi
        - FitnessRoom
        - PosteRestante
        - MessageBoard
        - InternationalPhone
        - LocalPhone
        - Fax
        - InternetAccess
        - FreeInternetAccess
        - InternetCafe
        - LuggageRoom
        - SecureCarPark
        - TwoWheelerCarPark
        - CoachStationShuttle
        - TrainStationShuttle
        - AirportShuttle
        - BicycleRental
        - MotorbikeRental
        - CarRental
        - CustomService1
        - CustomService2
        - CustomService3
        - CustomService4
        - CustomService5
        - SafetyBox
      type: string
    Description.Hotel.HubHotelCountry:
      required:
        - code
        - name
      type: object
      properties:
        code:
          default: ''
          type: string
        name:
          default: ''
          type: string
    Common.HubGpsPosition:
      description: Describe geo coordinates.
      required:
        - latitude
        - longitude
      type: object
      properties:
        latitude:
          format: double
          type: number
        longitude:
          format: double
          type: number
    Common.HubValueText_System.Double_:
      allOf:
        - $ref: '#/components/schemas/Common.HubValueText'
        - required:
            - value
          type: object
          properties:
            value:
              format: double
              type: number
    Description.Hotel.HubHotelOpeningHours:
      type: object
      properties:
        openingTime:
          format: time
          type: string
        closureTime:
          format: time
          type: string
    Common.SupportedCardType:
      description: Credit or debit card brand accepted by the hotel.
      enum:
        - Visa
        - MasterCard
        - AmericanExpress
        - DinersClub
        - Jcb
        - UnionPay
        - Tunion
        - Discover
        - RuPay
        - InterPayment
        - Maestro
        - Dankort
        - Mir
        - Uatp
        - Undefined
      type: string
    Common.SupportedPaymentMethod:
      description: Alternative online payment method accepted alongside credit cards.
      enum:
        - Paypal
        - IDeal
      type: string
    Search.HubAvailabilityPrice:
      required:
        - totalPrice
        - crossedOutPrice
        - discountType
      type: object
      properties:
        totalPrice:
          default:
            converted:
              value:
                amount: 0
            original:
              value:
                amount: 0
          allOf:
            - $ref: '#/components/schemas/Common.ConvertedMoney'
        crossedOutPrice:
          default:
            converted:
              value:
                amount: 0
            original:
              value:
                amount: 0
          allOf:
            - $ref: '#/components/schemas/Common.ConvertedMoney'
        discountType:
          $ref: '#/components/schemas/Search.HubSearchResultRoomRateDiscountType'
        promoCode:
          $ref: '#/components/schemas/Search.HubAvailabilityPriceOfferCode'
    Common.HubSearchTaxes:
      required:
        - included
        - excluded
        - onSite
      type: object
      properties:
        included:
          default:
            amount:
              value:
                amount: 0
            details: []
          allOf:
            - $ref: '#/components/schemas/Common.HubTax'
        excluded:
          default:
            amount:
              value:
                amount: 0
            details: []
          allOf:
            - $ref: '#/components/schemas/Common.HubTax'
        onSite:
          default:
            amount:
              value:
                amount: 0
            details: []
          allOf:
            - $ref: '#/components/schemas/Common.HubTax'
    Search.Hotel.HubHotelAvailabilityType:
      description: >-
        Availability status of a hotel in a search result.


        - **Available** — Hotel is available for the requested stay.

        - **BookingRequest** — Booking must be confirmed with the hotel
        (on-request).

        - **ExtendedStay** — Hotel is available only if the stay is extended
        beyond the requested dates.

        - **NotAvailable** — Hotel is not available for the requested stay.

        - **ReducedStay** — Hotel is available only if the stay is shortened
        compared with the requested dates.
      enum:
        - Available
        - BookingRequest
        - ExtendedStay
        - NotAvailable
        - ReducedStay
      type: string
    Common.ConvertedMoney:
      required:
        - converted
        - original
      type: object
      properties:
        converted:
          default:
            value:
              amount: 0
          allOf:
            - $ref: '#/components/schemas/Common.HubValueText_Library.Money_'
        original:
          default:
            value:
              amount: 0
          allOf:
            - $ref: '#/components/schemas/Common.HubValueText_Library.Money_'
    Search.HubSearchResultRoomRateDiscountType:
      description: >-
        Type of discount displayed on a room rate in the search result.


        - **None** — No discount is displayed.

        - **DiscountCode** — Discount granted by a promotional code entered by
        the end user.

        - **CrossedOut** — Original price.

        - **FreeNight** — Discount is expressed as one or more free nights.
      enum:
        - None
        - DiscountCode
        - CrossedOut
        - FreeNight
      type: string
    Search.HubAvailabilityPriceOfferCode:
      required:
        - offerCodeId
        - calculationMode
        - isPublic
        - isApplied
        - isMobile
        - isFlashSales
        - displayCountdown
        - endDate
      type: object
      properties:
        offerCodeId:
          $ref: '#/components/schemas/HotelBusiness.OfferCode.Common.OfferCodeId'
        code:
          type: string
        description:
          type: string
        nominal:
          $ref: '#/components/schemas/Common.ConvertedMoney'
        percent:
          $ref: '#/components/schemas/Common.HubValueText_HotelBusiness.Percent_'
        calculationMode:
          $ref: '#/components/schemas/Common.HubDiscountCalculationMode'
        isPublic:
          type: boolean
        isApplied:
          type: boolean
        isMobile:
          type: boolean
        isFlashSales:
          type: boolean
        displayCountdown:
          type: boolean
        endDate:
          format: date-time
          type: string
    Common.HubTax:
      required:
        - amount
        - details
      type: object
      properties:
        amount:
          default:
            value:
              amount: 0
          allOf:
            - $ref: '#/components/schemas/Common.HubValueText_Library.Money_'
        details:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/Common.HubTaxDetail'
    Common.HubValueText_Library.Money_:
      allOf:
        - $ref: '#/components/schemas/Common.HubValueText'
        - type: object
          properties:
            value:
              $ref: '#/components/schemas/Library.Money'
    Common.HubValueText_HotelBusiness.Percent_:
      allOf:
        - $ref: '#/components/schemas/Common.HubValueText'
        - required:
            - value
          type: object
          properties:
            value:
              $ref: '#/components/schemas/HotelBusiness.Percent'
    Common.HubDiscountCalculationMode:
      description: >-
        How a discount amount is computed against the base price.


        - **None** — No discount computation applies.

        - **PercentageWithoutExtras** — Percentage discount applied to the rate
        excluding extras.

        - **Percentage** — Percentage discount applied to the whole basket
        including extras.

        - **Nominal** — Flat monetary amount subtracted from the price.
      enum:
        - None
        - PercentageWithoutExtras
        - Percentage
        - Nominal
      type: string
    Common.HubTaxDetail:
      required:
        - type
        - applyToEntity
      type: object
      properties:
        name:
          type: string
        type:
          $ref: '#/components/schemas/Common.HubTaxType'
        description:
          type: string
        amount:
          $ref: '#/components/schemas/Common.ConvertedMoney'
        dailyTotalAmounts:
          type: array
          items:
            $ref: >-
              #/components/schemas/Search.Room.TemporalValue_Common.ConvertedMoney_
        applyToEntity:
          type: boolean
    Library.Money:
      required:
        - amount
        - currency
      type: object
      properties:
        amount:
          format: decimal
          type: number
        currency:
          type: string
    HotelBusiness.Percent:
      format: decimal
      type: number
    Common.HubTaxType:
      description: >-
        Category of tax or fee applied to a booking. Values map 1:1 to the
        underlying CRS tax classification.


        - **RateTax** — Tax computed on the room rate amount.

        - **ExtraTax** — Tax computed on a booking extra.

        - **OtherTax** — Fallback bucket for taxes that do not map to a more
        specific type.

        - **TouristTax** — Tourist tax collected on behalf of a tourism
        authority.

        - **CityTax** — Tax levied by the city hosting the hotel.

        - **StateTax** — Tax levied at the state or regional level.

        - **StayTax** — Tax computed on the stay (typically per person per
        night).

        - **VAT** — Value-added tax.

        - **LocalTax** — Locally-defined tax collected by the hotel.

        - **GeneralServiceTax** — General service tax as defined by local tax
        regulation.

        - **GovernmentTax** — Tax levied by the national or federal government.

        - **ServiceCharge** — Service charge added by the hotel (distinct from a
        general service tax).

        - **AccommodationTax** — Tax computed on the accommodation portion of
        the booking.

        - **ConsumptionTax** — Consumption tax as defined by local tax
        regulation.

        - **Custom** — Custom tax freely defined by the hotel.

        - **ResortFee** — Mandatory resort fee (common in US properties).

        - **ServiceFee** — Fixed service fee applied to the booking.

        - **CleaningFee** — Housekeeping or cleaning fee.

        - **CustomFee** — Custom fee freely defined by the hotel.
      enum:
        - RateTax
        - ExtraTax
        - OtherTax
        - TouristTax
        - CityTax
        - StateTax
        - StayTax
        - VAT
        - LocalTax
        - GeneralServiceTax
        - GovernmentTax
        - ServiceCharge
        - AccommodationTax
        - ConsumptionTax
        - Custom
        - ResortFee
        - ServiceFee
        - CleaningFee
        - CustomFee
      type: string
    Search.Room.TemporalValue_Common.ConvertedMoney_:
      allOf:
        - $ref: '#/components/schemas/Search.Room.TemporalValue'
        - type: object
          properties:
            value:
              $ref: '#/components/schemas/Common.ConvertedMoney'
    Search.Room.TemporalValue:
      type: object
      properties:
        start:
          type: string
          readOnly: true
        end:
          type: string
          readOnly: true

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.