> ## 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. # Get an existing session > Get an existing session ## OpenAPI ````yaml booking-engine-api/open-api/booking-engine-api.json GET /v2/{sessionId}/session 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}/session: get: tags: - Session summary: Get an existing session description: "This action Gives access to the configuration of the user session. Some of the data in the session can be updated:\r\n* `context`\r\n* `filters`\r\n* `sortType`\r\n* `display`\r\n \r\nSome other properties cannot be updated, like\r\n* `sessionId`\r\n* `scope`, it is defined dynamically regarding the session context\r\n* `activePromoCode`, as it provides the status of the property in `session.context.promoCode`" operationId: Session_GetSession parameters: - name: X-AVP-Impersonation in: header description: The impersonation. required: false schema: type: string - name: sessionId in: path required: true schema: type: string responses: '200': description: Returns the user session details content: application/json: schema: $ref: '#/components/schemas/Session.HubSession' examples: response: value: sessionId: 924f66dc-1706-4f13-968f-4a35293e8d2b engineId: 2MIS groupId: '12345' display: culture: fr-FR currency: EUR countryCode: FR context: stayPeriod: arrivalDate: '2026-06-08T00:00:00Z' departureDate: '2026-06-13T00:00:00Z' guests: - adults: 2 children: 0 infants: 0 position: 1 memberLevel: 0 selectedHotelId: '10133' selectedRoomCode: '29513' highlightedRateCode: '32643' promoCode: DISCOUNT excludeMixedRates: false disableCrossSell: false isMobile: false basket: rooms: [] hotelExtras: [] referenceRateIds: cancelConditionsRateId: 0 sellingConditionsRateId: 0 qualifierRateId: 0 cancelConditions: [] isBookingRequest: false isMixedRate: false hasOfferCode: false hasPublicOffer: false offerCodeId: 00000000-0000-0000-0000-000000000000 isComplete: false roomFilters: - type: RoomTypes values: - Single - Double hotelFilters: - type: Localisation values: - - - '[range in meters]' - type: Budget values: - - '[price max]' - type: Rating values: - NoStar - OneStar - TwoStars - ThreeStars - FourStars - FiveStars - type: Amenities values: - 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 - SafetyBox - type: City values: - Paris - type: Country values: - FR roomSortType: Default hotelSortType: Default bookingEngineMode: engineMode: SingleHotel guestSelectionMode: Default defaultDistance: 0 text/json: schema: $ref: '#/components/schemas/Session.HubSession' examples: response: value: sessionId: 924f66dc-1706-4f13-968f-4a35293e8d2b engineId: 2MIS groupId: '12345' display: culture: fr-FR currency: EUR countryCode: FR context: stayPeriod: arrivalDate: '2026-06-08T00:00:00Z' departureDate: '2026-06-13T00:00:00Z' guests: - adults: 2 children: 0 infants: 0 position: 1 memberLevel: 0 selectedHotelId: '10133' selectedRoomCode: '29513' highlightedRateCode: '32643' promoCode: DISCOUNT excludeMixedRates: false disableCrossSell: false isMobile: false basket: rooms: [] hotelExtras: [] referenceRateIds: cancelConditionsRateId: 0 sellingConditionsRateId: 0 qualifierRateId: 0 cancelConditions: [] isBookingRequest: false isMixedRate: false hasOfferCode: false hasPublicOffer: false offerCodeId: 00000000-0000-0000-0000-000000000000 isComplete: false roomFilters: - type: RoomTypes values: - Single - Double hotelFilters: - type: Localisation values: - - - '[range in meters]' - type: Budget values: - - '[price max]' - type: Rating values: - NoStar - OneStar - TwoStars - ThreeStars - FourStars - FiveStars - type: Amenities values: - 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 - SafetyBox - type: City values: - Paris - type: Country values: - FR roomSortType: Default hotelSortType: Default bookingEngineMode: engineMode: SingleHotel guestSelectionMode: Default defaultDistance: 0 '400': description: The session is invalid or does not exist 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: Session.HubSession: required: - display - context - basket - roomFilters - hotelFilters - bookingEngineMode - sessionId - engineId - groupId - roomSortType - hotelSortType - defaultDistance type: object properties: sessionId: description: "The unique identifier of the session.\r\nThe session is used to identify the end user. \r\nThe `sessionId` is used to identify the session for all of the other operations on this API." allOf: - $ref: '#/components/schemas/Session.HubSessionId' engineId: description: The D-EDGE reference of the booking engine. allOf: - $ref: '#/components/schemas/Common.HubBookingEngineId' groupId: description: The D-EDGE group id of the booking engine. allOf: - $ref: '#/components/schemas/Common.HubGroupId' display: default: {} allOf: - $ref: '#/components/schemas/Session.HubSessionDisplay' context: default: stayPeriod: arrivalDate: '0001-01-01' departureDate: '0001-01-01' guests: [] selectedHotelId: '0' excludeMixedRates: false disableCrossSell: false isMobile: false allOf: - $ref: '#/components/schemas/Session.HubSearchContext' basket: description: The current basket of the user. default: rooms: [] hotelExtras: [] referenceRateIds: cancelConditionsRateId: 0 sellingConditionsRateId: 0 qualifierRateId: 0 cancelConditions: [] isBookingRequest: false isMixedRate: false hasOfferCode: false hasPublicOffer: false offerCodeId: 00000000-0000-0000-0000-000000000000 isComplete: false allOf: - $ref: '#/components/schemas/Basket.HubBasket' roomFilters: description: The room filters configured by the end user. default: [] type: array items: $ref: >- #/components/schemas/Session.HubSessionFilter_Search.HubSearchRoomFilterType_ hotelFilters: description: The hotel filters configured by the end user. default: [] type: array items: $ref: >- #/components/schemas/Session.HubSessionFilter_Search.HubSearchHotelFilterType_ roomSortType: description: Define the way room results are sorted when performing a search. allOf: - $ref: '#/components/schemas/Search.Room.HubRoomSortType' hotelSortType: description: Define the way hotel results are sorted when performing a search. allOf: - $ref: '#/components/schemas/Search.Hotel.HubHotelSortType' bookingEngineMode: description: Define the modes for a booking engine. default: engineMode: SingleHotel guestSelectionMode: Default allOf: - $ref: '#/components/schemas/Session.HubBookingEngineMode' defaultDistance: format: double type: number 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 Session.HubSessionId: format: uuid type: string Common.HubBookingEngineId: type: string Common.HubGroupId: type: string Session.HubSessionDisplay: type: object properties: culture: description: The culture name, used to localize results of other endpoints. type: string currency: description: >- The ISO code of the currency requested, used to configure price in the results. type: string countryCode: description: The country code from client browser. type: string example: culture: fr-FR currency: EUR countryCode: FR Session.HubSearchContext: description: "This represent the parameters used to configure future call to the service.\r\nIt represents more or less the data entered by the final customer." required: - stayPeriod - guests - selectedHotelId - excludeMixedRates - disableCrossSell - isMobile type: object properties: stayPeriod: default: arrivalDate: '0001-01-01' departureDate: '0001-01-01' allOf: - $ref: '#/components/schemas/Session.HubStayPeriod' guests: default: [] type: array items: $ref: '#/components/schemas/Session.HubBookingGuests' selectedHotelId: description: "The currently selected hotel id.\r\nCould be zero when starting a session for a multi hotel booking engine.\r\nAutomatically set when starting a session for a mono hotel booking engine." allOf: - $ref: '#/components/schemas/Common.HubHotelId' selectedRoomCode: type: string selectedRateCode: type: string highlightedRateCode: type: string highlightedRoomCode: type: string highlightedHotelCode: type: string promoCode: description: "The promo code requested for the session.\r\nIt could be either an OfferCode or a RateCode." type: string excludeMixedRates: description: >- Configure whether the search results should include mixed rates or not. type: boolean disableCrossSell: description: >- Configure whether the search results should return cross sell configuration when no rooms are available. type: boolean gpsPosition: description: If defined the search results should be based on user's location. allOf: - $ref: '#/components/schemas/Common.HubGpsPosition' isMobile: description: Configure whether the request came from a mobile or not. type: boolean example: stayPeriod: arrivalDate: '2026-06-08T00:00:00Z' departureDate: '2026-06-13T00:00:00Z' guests: - adults: 2 children: 0 infants: 0 position: 1 memberLevel: 0 selectedHotelId: '10133' selectedRoomCode: '29513' highlightedRateCode: '32643' promoCode: DISCOUNT excludeMixedRates: false disableCrossSell: false isMobile: false Basket.HubBasket: description: Describes the hub basket. required: - rooms - hotelExtras - referenceRateIds - isBookingRequest - isMixedRate - hasOfferCode - hasPublicOffer - offerCodeId - isComplete type: object properties: rooms: description: Gets or sets the rooms in the basket. default: [] type: array items: $ref: '#/components/schemas/Basket.HubBasketRoom' hotelExtras: description: Gets or sets the hotel extras. default: [] type: array items: $ref: '#/components/schemas/Basket.HubBasketExtra' referenceRateIds: description: Gets or sets the reference rate ids. default: cancelConditionsRateId: 0 sellingConditionsRateId: 0 qualifierRateId: 0 cancelConditions: [] allOf: - $ref: '#/components/schemas/Common.HubReferenceRateIds' isBookingRequest: description: Gets or sets a value indicating whether basket is booking request. type: boolean isMixedRate: description: Gets or sets a value indicating whether the rate is mixed. type: boolean hasOfferCode: description: Gets or sets a value indicating whether basket has offer code. type: boolean hasPublicOffer: description: Gets or sets a value indicating whether basket has public odder. type: boolean offerCodeId: description: Gets or sets the offer code id. allOf: - $ref: '#/components/schemas/HotelBusiness.OfferCode.Common.OfferCodeId' isComplete: description: Gets or sets a value indicating whether basket is complete. type: boolean Session.HubSessionFilter_Search.HubSearchRoomFilterType_: allOf: - $ref: '#/components/schemas/Session.HubSessionFilter' - required: - type type: object properties: type: $ref: '#/components/schemas/Search.HubSearchRoomFilterType' Session.HubSessionFilter_Search.HubSearchHotelFilterType_: allOf: - $ref: '#/components/schemas/Session.HubSessionFilter' - required: - type type: object properties: type: $ref: '#/components/schemas/Search.HubSearchHotelFilterType' Search.Room.HubRoomSortType: description: Sort order applied to a room search result. enum: - Default - DescendingPrice - AscendingPrice type: string Search.Hotel.HubHotelSortType: description: Sort order applied to a hotel search result. enum: - Default - DescendingPrice - AscendingPrice - Rating - Name type: string Session.HubBookingEngineMode: required: - engineMode - guestSelectionMode type: object properties: engineMode: description: Engine mode `SingleHotel` or `MultiHotel`. allOf: - $ref: '#/components/schemas/Session.HubEngineMode' guestSelectionMode: description: Guest selection mode handling mode `PerBooking` or `PerRoom`. allOf: - $ref: '#/components/schemas/Session.HubGuestSelectionMode' 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 Session.HubStayPeriod: description: >- Describe a period of stay by specifying the arrival date and the departure date. required: - arrivalDate - departureDate type: object properties: arrivalDate: format: date-time type: string departureDate: format: date-time type: string Session.HubBookingGuests: description: Describes the details of the guests count. required: - adults - children - infants - position - memberLevel type: object properties: adults: format: int32 type: integer children: format: int32 type: integer infants: format: int32 type: integer childrenAges: type: array items: format: int32 type: integer position: $ref: '#/components/schemas/Common.HubGuestPosition' memberLevel: format: int32 type: integer Common.HubHotelId: type: string Common.HubGpsPosition: description: Describe geo coordinates. required: - latitude - longitude type: object properties: latitude: format: double type: number longitude: format: double type: number Basket.HubBasketRoom: description: Describes the hub basket room. required: - itemNumber - quantitiesByOccupancyId - extras - roomId - guestPosition type: object properties: roomId: description: Gets or sets the room id. allOf: - $ref: '#/components/schemas/HotelBusiness.RoomId' itemNumber: format: int32 description: Gets or sets the item number. default: 1 type: integer guestPosition: description: Gets or sets the guest position. allOf: - $ref: '#/components/schemas/Common.HubGuestPosition' quantitiesByOccupancyId: description: Gets or sets the room occupancies list. default: [] type: array items: $ref: '#/components/schemas/Basket.HubBasketRoomOccupancy' extras: description: Gets or sets the extras. default: [] type: array items: $ref: '#/components/schemas/Basket.HubBasketExtra' beddingConfigurationId: format: uuid description: Gets or sets the bedding configuration id. type: string example: 00000000-0000-0000-0000-000000000000 Basket.HubBasketExtra: description: Describes the hub basket extra. required: - extraId - quantity - originalPriceAtSelection type: object properties: extraId: description: Gets or sets the extra id. allOf: - $ref: '#/components/schemas/HotelBusiness.ExtraId' quantity: format: int32 description: Gets or sets the quantity. type: integer originalPriceAtSelection: $ref: '#/components/schemas/Library.Money' Common.HubReferenceRateIds: required: - cancelConditions - cancelConditionsRateId - sellingConditionsRateId - qualifierRateId type: object properties: cancelConditionsRateId: $ref: '#/components/schemas/HotelBusiness.RateId' sellingConditionsRateId: $ref: '#/components/schemas/HotelBusiness.RateId' qualifierRateId: $ref: '#/components/schemas/HotelBusiness.RateId' cancelConditions: default: [] type: array items: $ref: '#/components/schemas/Description.Common.HubCancelCondition' HotelBusiness.OfferCode.Common.OfferCodeId: format: uuid type: string Session.HubSessionFilter: type: object properties: values: description: The values defined for this category. type: array items: type: string Search.HubSearchRoomFilterType: description: Facet used to narrow down a room search result. enum: - Undefined - RoomTypes - AccommodationTypes - RateTypes - BedTypes - Amenities type: string Search.HubSearchHotelFilterType: description: Facet used to narrow down a hotel search result. enum: - Undefined - City - Country - Localisation - Rating - Budget - Amenities type: string Session.HubEngineMode: description: >- Whether the booking engine is scoped to a single hotel or spans multiple hotels of a group. enum: - SingleHotel - MultiHotel type: string Session.HubGuestSelectionMode: description: >- How guests are declared by the end user during the search — once for the whole booking or independently per room. enum: - Default - PerRoom - PerBooking type: string Common.HubGuestPosition: format: int32 type: integer HotelBusiness.RoomId: format: int32 type: integer Basket.HubBasketRoomOccupancy: description: Describes the hub basket room occupancy. required: - rateId - occupancyId - quantity - originalPriceAtSelection type: object properties: occupancyId: description: Gets or sets the occupancy id. allOf: - $ref: '#/components/schemas/HotelBusiness.OccupancyId' quantity: format: int32 description: Gets or sets the quantity. type: integer rateId: description: Gets or sets the rate id. default: '' allOf: - $ref: >- #/components/schemas/Library.Temporality.ITemporal_HotelBusiness.RateId_ originalPriceAtSelection: $ref: '#/components/schemas/Library.Money' HotelBusiness.ExtraId: format: int32 type: integer Library.Money: required: - amount - currency type: object properties: amount: format: decimal type: number currency: type: string HotelBusiness.RateId: format: int32 type: integer Description.Common.HubCancelCondition: required: - delay - nightCount - nominal - percent - hour type: object properties: delay: $ref: '#/components/schemas/HotelBusiness.CancelDelay' nightCount: format: int32 type: integer nominal: format: decimal type: number percent: $ref: '#/components/schemas/HotelBusiness.Percent' hour: format: time type: string HotelBusiness.OccupancyId: format: int32 type: integer Library.Temporality.ITemporal_HotelBusiness.RateId_: pattern: ^(\d{8};\d{8};\d+)(#(\d{8};\d{8};\d+))*$ type: string HotelBusiness.CancelDelay: format: int32 type: integer HotelBusiness.Percent: format: decimal type: number ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.