> ## 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.

# Gets the engine configuration

> Gets the engine configuration attached to the client session



## OpenAPI

````yaml booking-engine-api/open-api/booking-engine-api.json GET /v2/{sessionId}/configuration/engine
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}/configuration/engine:
    get:
      tags:
        - Configuration
      summary: Gets the engine configuration attached to the client session.
      description: "Returns the booking engine settings including available hotels, currencies,\r\ncard types, planning constraints, payment methods, and custom parameters."
      operationId: Configuration_GetEngine
      parameters:
        - 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/Configuration.HubEngineConfig'
              examples:
                response:
                  value:
                    engineId: 2MIS
                    groupId: '12345'
                    websiteUrl: http://hotel-website.com
                    customSalesTermsConditionsUrl: http://hotel-website.com/terms.pdf
                    hotels:
                      - hotelId: '1234'
                        rating: 0
                    constraints:
                      guests:
                        adults:
                          isVisible: true
                          maxCount: 20
                          minAge: 12
                          maxAge: 2147483647
                        children:
                          isVisible: true
                          maxCount: 20
                          minAge: 2
                          maxAge: 12
                        infants:
                          isVisible: true
                          maxCount: 20
                          minAge: 0
                          maxAge: 2
                        checkinTime: None
                        address: None
                        occupancyDetails: None
                      planning:
                        minDate: '2026-06-07T00:00:00Z'
                        maxDate: '2028-05-27T00:00:00Z'
                      engine:
                        maxStayLength: 10
                        isOfferCodeVisible: true
                        isGuestAuthenticationVisible: true
                        isCrossSellEnabled: true
                        bookingLimits:
                          bookingLimit: 1
                          defaultRoomLimit: 2
                          roomLimits:
                            '1111': 2
                            '2222': 5
                      display:
                        rooms: 4
                        rates: 4
                        roomExtras: 2
                        hotelExtras: 3
                        pricingDisplayMethod: Lowest
                      marketing:
                        isOptinHotelVisible: true
                        isOptinPartnersVisible: true
                      navigation:
                        consentManagementPlatformEnabled: false
                        isHomeOfficialWebSite: false
                    cardTypes:
                      - AmericanExpress
                      - Visa
                    bookingEngineType: Classic
                    convergenceActivated: false
                    currencies:
                      - EUR
                      - USD
                    rateIds:
                      - 1111
                      - 2222
                      - 3333
                    customParameters:
                      param1: value1
                    defaultCurrency: EUR
                    defaultCulture: fr-FR
                    hotelPaymentMethods:
                      supportedCardTypes:
                        - AmericanExpress
                        - Visa
                      supportedPaymentMethods:
                        - IDeal
                        - Paypal
                    occupancyPerRoom: false
                    title: My First Hotel
            text/json:
              schema:
                $ref: '#/components/schemas/Configuration.HubEngineConfig'
              examples:
                response:
                  value:
                    engineId: 2MIS
                    groupId: '12345'
                    websiteUrl: http://hotel-website.com
                    customSalesTermsConditionsUrl: http://hotel-website.com/terms.pdf
                    hotels:
                      - hotelId: '1234'
                        rating: 0
                    constraints:
                      guests:
                        adults:
                          isVisible: true
                          maxCount: 20
                          minAge: 12
                          maxAge: 2147483647
                        children:
                          isVisible: true
                          maxCount: 20
                          minAge: 2
                          maxAge: 12
                        infants:
                          isVisible: true
                          maxCount: 20
                          minAge: 0
                          maxAge: 2
                        checkinTime: None
                        address: None
                        occupancyDetails: None
                      planning:
                        minDate: '2026-06-07T00:00:00Z'
                        maxDate: '2028-05-27T00:00:00Z'
                      engine:
                        maxStayLength: 10
                        isOfferCodeVisible: true
                        isGuestAuthenticationVisible: true
                        isCrossSellEnabled: true
                        bookingLimits:
                          bookingLimit: 1
                          defaultRoomLimit: 2
                          roomLimits:
                            '1111': 2
                            '2222': 5
                      display:
                        rooms: 4
                        rates: 4
                        roomExtras: 2
                        hotelExtras: 3
                        pricingDisplayMethod: Lowest
                      marketing:
                        isOptinHotelVisible: true
                        isOptinPartnersVisible: true
                      navigation:
                        consentManagementPlatformEnabled: false
                        isHomeOfficialWebSite: false
                    cardTypes:
                      - AmericanExpress
                      - Visa
                    bookingEngineType: Classic
                    convergenceActivated: false
                    currencies:
                      - EUR
                      - USD
                    rateIds:
                      - 1111
                      - 2222
                      - 3333
                    customParameters:
                      param1: value1
                    defaultCurrency: EUR
                    defaultCulture: fr-FR
                    hotelPaymentMethods:
                      supportedCardTypes:
                        - AmericanExpress
                        - Visa
                      supportedPaymentMethods:
                        - IDeal
                        - Paypal
                    occupancyPerRoom: false
                    title: My First Hotel
        '400':
          description: The session code is invalid
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BookingEngine.Hub.Service.Examples.Session.InvalidSessionErrorResponse
              examples:
                response:
                  value:
                    code: InvalidSessionId
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/BookingEngine.Hub.Service.Examples.Session.InvalidSessionErrorResponse
              examples:
                response:
                  value:
                    code: InvalidSessionId
        '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:
    Configuration.HubEngineConfig:
      required:
        - hotels
        - constraints
        - cardTypes
        - currencies
        - rateIds
        - customParameters
        - engineId
        - groupId
        - bookingEngineType
        - convergenceActivated
        - occupancyPerRoom
      type: object
      properties:
        engineId:
          $ref: '#/components/schemas/Common.HubBookingEngineId'
        groupId:
          $ref: '#/components/schemas/Common.HubGroupId'
        bookingEngineUrl:
          type: string
        websiteUrl:
          type: string
        customSalesTermsConditionsUrl:
          type: string
        hotels:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/Configuration.HubEngineConfigHotelSummary'
        constraints:
          default:
            guests:
              adults:
                isVisible: false
                maxCount: 0
                minAge: 0
                maxAge: 0
              children:
                isVisible: false
                maxCount: 0
                minAge: 0
                maxAge: 0
              infants:
                isVisible: false
                maxCount: 0
                minAge: 0
                maxAge: 0
              checkinTime: None
              address: None
              occupancyDetails: None
            planning:
              minDate: '0001-01-01'
              maxDate: '0001-01-01'
            engine:
              maxStayLength: 0
              isOfferCodeVisible: false
              isGuestAuthenticationVisible: false
              isCrossSellEnabled: false
              bookingLimits:
                bookingLimit: 2147483647
                defaultRoomLimit: 0
                roomLimits: {}
            display:
              rooms: 0
              rates: 0
              roomExtras: 0
              hotelExtras: 0
              pricingDisplayMethod: Lowest
            marketing:
              isOptinHotelVisible: false
              isOptinPartnersVisible: false
            navigation:
              consentManagementPlatformEnabled: false
              isHomeOfficialWebSite: false
          allOf:
            - $ref: '#/components/schemas/Configuration.HubEngineConfigConstraints'
        cardTypes:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/HotelBusiness.Cards.CardType'
        bookingEngineType:
          $ref: '#/components/schemas/HotelBusiness.BookingEngine.BookingEngineType'
        convergenceActivated:
          type: boolean
        currencies:
          default: []
          type: array
          items:
            type: string
        rateIds:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/HotelBusiness.RateId'
        customParameters:
          default: {}
          type: object
          additionalProperties:
            type: string
        defaultCurrency:
          type: string
        defaultCulture:
          type: string
        defaultCountryCode:
          type: string
        referenceRateCode:
          type: string
        hotelPaymentMethods:
          $ref: '#/components/schemas/Description.Hotel.HubHotelPaymentMethods'
        occupancyPerRoom:
          type: boolean
        bookingModificationUrl:
          type: string
        googleAnalyticsId:
          type: string
        clientDomain:
          type: string
        title:
          type: string
        tracking:
          $ref: '#/components/schemas/Configuration.Tracking.HubTracking'
    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
    Common.HubBookingEngineId:
      type: string
    Common.HubGroupId:
      type: string
    Configuration.HubEngineConfigHotelSummary:
      required:
        - hotelId
        - rating
      type: object
      properties:
        name:
          type: string
        hotelId:
          $ref: '#/components/schemas/Common.HubHotelId'
        rating:
          format: int32
          type: integer
        timeZone:
          $ref: '#/components/schemas/Library.TimeZone'
        cityName:
          type: string
        countryCode:
          type: string
        bookingProperties:
          $ref: '#/components/schemas/Description.Hotel.HubHotelBooking'
    Configuration.HubEngineConfigConstraints:
      required:
        - guests
        - planning
        - engine
        - display
        - marketing
        - navigation
      type: object
      properties:
        guests:
          default:
            adults:
              isVisible: false
              maxCount: 0
              minAge: 0
              maxAge: 0
            children:
              isVisible: false
              maxCount: 0
              minAge: 0
              maxAge: 0
            infants:
              isVisible: false
              maxCount: 0
              minAge: 0
              maxAge: 0
            checkinTime: None
            address: None
            occupancyDetails: None
          allOf:
            - $ref: '#/components/schemas/Configuration.GuestsConstraints'
        planning:
          default:
            minDate: '0001-01-01'
            maxDate: '0001-01-01'
          allOf:
            - $ref: '#/components/schemas/Configuration.PlanningConstraints'
        engine:
          default:
            maxStayLength: 0
            isOfferCodeVisible: false
            isGuestAuthenticationVisible: false
            isCrossSellEnabled: false
            bookingLimits:
              bookingLimit: 2147483647
              defaultRoomLimit: 0
              roomLimits: {}
          allOf:
            - $ref: '#/components/schemas/Configuration.EngineConstraints'
        display:
          default:
            rooms: 0
            rates: 0
            roomExtras: 0
            hotelExtras: 0
            pricingDisplayMethod: Lowest
          allOf:
            - $ref: '#/components/schemas/Configuration.DisplayConstraints'
        marketing:
          default:
            isOptinHotelVisible: false
            isOptinPartnersVisible: false
          allOf:
            - $ref: '#/components/schemas/Configuration.MarketingConstraints'
        navigation:
          default:
            consentManagementPlatformEnabled: false
            isHomeOfficialWebSite: false
          allOf:
            - $ref: '#/components/schemas/Configuration.NavigationConstraints'
    HotelBusiness.Cards.CardType:
      enum:
        - Visa
        - MasterCard
        - AmericanExpress
        - DinersClub
        - Jcb
        - Undefined
      type: string
    HotelBusiness.BookingEngine.BookingEngineType:
      enum:
        - Classic
        - Mobile
        - Facebook
        - Corporate
        - DirectClick
        - Diamond
        - Smart
        - CentralReservationOffice
      type: string
    HotelBusiness.RateId:
      format: int32
      type: integer
    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'
    Configuration.Tracking.HubTracking:
      type: object
      properties:
        trackers:
          type: array
          items:
            $ref: >-
              #/components/schemas/Configuration.Tracking.HubBookingEngineTracker
    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
    Library.TimeZone:
      type: string
      example: Etc/UTC
    Description.Hotel.HubHotelBooking:
      required:
        - adults
        - children
        - infants
        - cardTypes
        - paymentMethods
        - currencies
      type: object
      properties:
        adults:
          default:
            maxCount: 0
            minAge: 0
            maxAge: 0
          allOf:
            - $ref: >-
                #/components/schemas/Description.Hotel.HubBookingGuestConstraints
        children:
          default:
            maxCount: 0
            minAge: 0
            maxAge: 0
          allOf:
            - $ref: >-
                #/components/schemas/Description.Hotel.HubBookingGuestConstraints
        infants:
          default:
            maxCount: 0
            minAge: 0
            maxAge: 0
          allOf:
            - $ref: >-
                #/components/schemas/Description.Hotel.HubBookingGuestConstraints
        cardTypes:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/HotelBusiness.Cards.CardType'
        paymentMethods:
          default:
            supportedCardTypes: []
            supportedPaymentMethods: []
          allOf:
            - $ref: '#/components/schemas/Description.Hotel.HubHotelPaymentMethods'
        currencies:
          default: []
          type: array
          items:
            type: string
        defaultCurrency:
          type: string
    Configuration.GuestsConstraints:
      required:
        - adults
        - children
        - infants
        - checkinTime
        - address
        - occupancyDetails
      type: object
      properties:
        adults:
          default:
            isVisible: false
            maxCount: 0
            minAge: 0
            maxAge: 0
          allOf:
            - $ref: '#/components/schemas/Configuration.GuestTypeConstraint'
        children:
          default:
            isVisible: false
            maxCount: 0
            minAge: 0
            maxAge: 0
          allOf:
            - $ref: '#/components/schemas/Configuration.GuestTypeConstraint'
        infants:
          default:
            isVisible: false
            maxCount: 0
            minAge: 0
            maxAge: 0
          allOf:
            - $ref: '#/components/schemas/Configuration.GuestTypeConstraint'
        checkinTime:
          $ref: '#/components/schemas/Configuration.FeatureUsage'
        address:
          $ref: '#/components/schemas/Configuration.FeatureUsage'
        occupancyDetails:
          $ref: '#/components/schemas/Configuration.FeatureUsage'
    Configuration.PlanningConstraints:
      required:
        - minDate
        - maxDate
      type: object
      properties:
        minDate:
          format: date-time
          type: string
        maxDate:
          format: date-time
          type: string
    Configuration.EngineConstraints:
      required:
        - bookingLimits
        - maxStayLength
        - isOfferCodeVisible
        - isGuestAuthenticationVisible
        - isCrossSellEnabled
      type: object
      properties:
        maxStayLength:
          format: int32
          type: integer
        isOfferCodeVisible:
          type: boolean
        isGuestAuthenticationVisible:
          type: boolean
        isCrossSellEnabled:
          type: boolean
        bookingLimits:
          default:
            bookingLimit: 2147483647
            defaultRoomLimit: 0
            roomLimits: {}
          allOf:
            - $ref: '#/components/schemas/Configuration.EngineBookingLimits'
    Configuration.DisplayConstraints:
      required:
        - rooms
        - rates
        - roomExtras
        - hotelExtras
        - pricingDisplayMethod
      type: object
      properties:
        rooms:
          format: int32
          type: integer
        rates:
          format: int32
          type: integer
        roomExtras:
          format: int32
          type: integer
        hotelExtras:
          format: int32
          type: integer
        pricingDisplayMethod:
          $ref: '#/components/schemas/Configuration.HubPricingDisplayMethod'
        ratePriceDisplayMode:
          $ref: '#/components/schemas/Configuration.HubRatePriceDisplayModes'
    Configuration.MarketingConstraints:
      required:
        - isOptinHotelVisible
        - isOptinPartnersVisible
      type: object
      properties:
        isOptinHotelVisible:
          type: boolean
        isOptinPartnersVisible:
          type: boolean
    Configuration.NavigationConstraints:
      required:
        - consentManagementPlatformEnabled
        - isHomeOfficialWebSite
      type: object
      properties:
        consentManagementPlatformEnabled:
          type: boolean
        isHomeOfficialWebSite:
          type: boolean
    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
    Configuration.Tracking.HubBookingEngineTracker:
      required:
        - enabled
        - type
      type: object
      properties:
        id:
          type: string
        enabled:
          type: boolean
        type:
          $ref: '#/components/schemas/Configuration.Tracking.HubTrackerType'
        accountType:
          type: string
        version:
          type: string
        domainUrl:
          type: string
    Description.Hotel.HubBookingGuestConstraints:
      required:
        - maxCount
        - minAge
        - maxAge
      type: object
      properties:
        maxCount:
          format: int32
          type: integer
        minAge:
          format: int32
          type: integer
        maxAge:
          format: int32
          type: integer
    Configuration.GuestTypeConstraint:
      required:
        - isVisible
        - maxCount
        - minAge
        - maxAge
      type: object
      properties:
        isVisible:
          type: boolean
        maxCount:
          format: int32
          type: integer
        minAge:
          format: int32
          type: integer
        maxAge:
          format: int32
          type: integer
    Configuration.FeatureUsage:
      description: >-
        Whether a feature is required, optional or disabled on the booking
        engine.
      enum:
        - Required
        - Optional
        - None
      type: string
    Configuration.EngineBookingLimits:
      required:
        - bookingLimit
        - roomLimits
        - defaultRoomLimit
      type: object
      properties:
        bookingLimit:
          format: int32
          default: 2147483647
          type: integer
        defaultRoomLimit:
          format: int32
          type: integer
        roomLimits:
          default: {}
          type: object
          additionalProperties:
            format: int32
            type: integer
    Configuration.HubPricingDisplayMethod:
      description: Strategy used to display room prices on rate lists.
      enum:
        - Lowest
        - Interval
      type: string
    Configuration.HubRatePriceDisplayModes:
      description: |-
        How the rate price is presented to the end user.

        - **Average** — Show the average price per night.
        - **Total** — Show the total price for the whole stay.
      enum:
        - Average
        - Total
      type: string
    Configuration.Tracking.HubTrackerType:
      description: Analytics or tracking provider wired into the booking engine.
      enum:
        - GoogleAnalytics
        - VeInteractive
        - GoogleTagManager
        - AvailproTracker
        - CustomRoiTracking
      type: string

````

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