> ## 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 rates descriptions

> Gets rates descriptions



## OpenAPI

````yaml booking-engine-api/open-api/booking-engine-api.json GET /v2/{sessionId}/description/rates
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}/description/rates:
    get:
      tags:
        - Description
      summary: Gets rates descriptions.
      description: "The **X-AVP-Properties** header attribute  can contain some or all the following values, separated with | character:\r\n* `Information`\r\n* `Constraints`\r\n* `Offers`\r\n* `SellingConditions`\r\n* `CancelConditions`\r\n* `Rooms`\r\n* `Extras`\r\n* `Occupancies`\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: Description_GetRates
      parameters:
        - name: X-AVP-Properties
          in: header
          description: The properties.
          required: false
          schema:
            type: string
        - name: X-AVP-DescriptionType
          in: header
          description: Type of the description.
          required: false
          schema:
            type: string
        - name: X-AVP-PictureTemplates
          in: header
          description: The picture templates.
          required: false
          schema:
            type: string
        - 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/Description.Rate.HubRatesResult'
              examples:
                response:
                  value:
                    rates:
                      - rateId: 12345
                        hotelId: '12345'
                        code: RACKPRI
                        name: Default rate
                        currencyCode: EUR
                        forceDisplayName: false
                        information:
                          type:
                            text: Prix public
                            value: PublicPrice
                          qualifier:
                            text: Petit déjeuner inclus
                            value: BreakfastIncluded
                          currency: ''
                          summary:
                            - text: Description du prix public
                              value: PlainText
                          pictures:
                            - templates:
                                - name: TEMPLATE1
                                  url: http://url/to/template1/image1
                                - name: TEMPLATE2
                                  url: http://url/to/template2/image1
                              sortOrder: 1
                            - templates:
                                - name: TEMPLATE1
                                  url: http://url/to/template1/image2
                                - name: TEMPLATE2
                                  url: http://url/to/template2/image2
                              sortOrder: 2
                          isPrivate: false
                          sortOrder: 1
                        gratuitounessPeriods:
                          - period:
                              start: '2026-06-09'
                              end: '2026-06-10'
                            paidNightCount: 1
                            freeNightCount: 1
                        stay:
                          lastMinuteDayCount: 2
                          earlyBookingDayCount: 20
                          periods:
                            - daysOfWeek: All
                        salePeriods:
                          - period:
                              start: '2026-06-09'
                              end: '2026-06-12'
                            daysOfWeek: All
                        sellingConditions:
                          deposit:
                            depositType: CreditCardNumber
                            percent: 100
                          useOnlinePayment: true
                          bookingFees:
                            percent: 0
                            nominal: 0
                          allowFullOnlinePayment: true
                          allowCallOption: true
                          paymentBalance:
                            - text: Paiement intégral à la réservation
                              value: PlainText
                        cancelConditions:
                          cancelConditions:
                            - delay: 0
                              nightCount: 3
                              nominal: 0
                              percent: 100
                              hour: '22:00:00'
                            - delay: 3
                              nightCount: 0
                              nominal: 0
                              percent: 0
                              hour: '00:00:00'
                          description:
                            - text: >-
                                Annulation gratuite 3 jours avant la date
                                d'arrivée
                              value: PlainText
                          usePlanningConditions: true
                          isGuestModificationEnabled: false
                          isModificationEnabled: false
                        roomIds:
                          - 1111
                          - 2222
                          - 3333
                        occupancyIds:
                          - 1111
                          - 2222
                          - 3333
                        extraIds:
                          - 1111
                          - 2222
                          - 3333
            text/json:
              schema:
                $ref: '#/components/schemas/Description.Rate.HubRatesResult'
              examples:
                response:
                  value:
                    rates:
                      - rateId: 12345
                        hotelId: '12345'
                        code: RACKPRI
                        name: Default rate
                        currencyCode: EUR
                        forceDisplayName: false
                        information:
                          type:
                            text: Prix public
                            value: PublicPrice
                          qualifier:
                            text: Petit déjeuner inclus
                            value: BreakfastIncluded
                          currency: ''
                          summary:
                            - text: Description du prix public
                              value: PlainText
                          pictures:
                            - templates:
                                - name: TEMPLATE1
                                  url: http://url/to/template1/image1
                                - name: TEMPLATE2
                                  url: http://url/to/template2/image1
                              sortOrder: 1
                            - templates:
                                - name: TEMPLATE1
                                  url: http://url/to/template1/image2
                                - name: TEMPLATE2
                                  url: http://url/to/template2/image2
                              sortOrder: 2
                          isPrivate: false
                          sortOrder: 1
                        gratuitounessPeriods:
                          - period:
                              start: '2026-06-09'
                              end: '2026-06-10'
                            paidNightCount: 1
                            freeNightCount: 1
                        stay:
                          lastMinuteDayCount: 2
                          earlyBookingDayCount: 20
                          periods:
                            - daysOfWeek: All
                        salePeriods:
                          - period:
                              start: '2026-06-09'
                              end: '2026-06-12'
                            daysOfWeek: All
                        sellingConditions:
                          deposit:
                            depositType: CreditCardNumber
                            percent: 100
                          useOnlinePayment: true
                          bookingFees:
                            percent: 0
                            nominal: 0
                          allowFullOnlinePayment: true
                          allowCallOption: true
                          paymentBalance:
                            - text: Paiement intégral à la réservation
                              value: PlainText
                        cancelConditions:
                          cancelConditions:
                            - delay: 0
                              nightCount: 3
                              nominal: 0
                              percent: 100
                              hour: '22:00:00'
                            - delay: 3
                              nightCount: 0
                              nominal: 0
                              percent: 0
                              hour: '00:00:00'
                          description:
                            - text: >-
                                Annulation gratuite 3 jours avant la date
                                d'arrivée
                              value: PlainText
                          usePlanningConditions: true
                          isGuestModificationEnabled: false
                          isModificationEnabled: false
                        roomIds:
                          - 1111
                          - 2222
                          - 3333
                        occupancyIds:
                          - 1111
                          - 2222
                          - 3333
                        extraIds:
                          - 1111
                          - 2222
                          - 3333
        '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:
    Description.Rate.HubRatesResult:
      type: object
      properties:
        rates:
          type: array
          items:
            $ref: '#/components/schemas/Description.Rate.HubRateDescription'
    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
    Description.Rate.HubRateDescription:
      required:
        - information
        - gratuitounessPeriods
        - stay
        - salePeriods
        - sellingConditions
        - cancelConditions
        - roomIds
        - occupancyIds
        - extraIds
        - rateId
        - hotelId
        - forceDisplayName
      type: object
      properties:
        rateId:
          $ref: '#/components/schemas/HotelBusiness.RateId'
        hotelId:
          $ref: '#/components/schemas/Common.HubHotelId'
        code:
          type: string
        name:
          type: string
        currencyCode:
          type: string
        forceDisplayName:
          type: boolean
        information:
          default:
            type:
              value: PublicPrice
            qualifier:
              value: RoomOnly
            summary: []
            pictures: []
            isPrivate: false
            sortOrder: 0
          allOf:
            - $ref: '#/components/schemas/Description.Rate.HubRateInformation'
        gratuitounessPeriods:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/Description.Rate.HubRateGratuitounessPeriod'
        stay:
          default:
            lastMinuteDayCount: 0
            earlyBookingDayCount: 0
          allOf:
            - $ref: '#/components/schemas/Description.Rate.HubRateStay'
        salePeriods:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/Description.Common.HubWeekPeriod'
        sellingConditions:
          default:
            deposit:
              depositType: Nothing
              percent: 0
            useOnlinePayment: false
            bookingFees:
              percent: 0
              nominal: 0
            allowFullOnlinePayment: false
            allowCallOption: false
            paymentBalance: []
          allOf:
            - $ref: '#/components/schemas/Description.Rate.HubRateSellingConditions'
        cancelConditions:
          default:
            cancelConditions: []
            description: []
            usePlanningConditions: false
            isGuestModificationEnabled: false
            isModificationEnabled: false
          allOf:
            - $ref: '#/components/schemas/Description.Rate.HubRateCancelConditions'
        roomIds:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/HotelBusiness.RoomId'
        occupancyIds:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/HotelBusiness.OccupancyId'
        extraIds:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/HotelBusiness.ExtraId'
    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
    HotelBusiness.RateId:
      format: int32
      type: integer
    Common.HubHotelId:
      type: string
    Description.Rate.HubRateInformation:
      required:
        - type
        - qualifier
        - summary
        - pictures
        - isPrivate
        - sortOrder
      type: object
      properties:
        type:
          default:
            value: PublicPrice
          allOf:
            - $ref: >-
                #/components/schemas/Common.HubValueText_Description.Rate.HubRateType_
        qualifier:
          default:
            value: RoomOnly
          allOf:
            - $ref: >-
                #/components/schemas/Common.HubValueText_Description.Rate.HubRateQualifier_
        currency:
          type: string
        summary:
          default: []
          type: array
          items:
            $ref: >-
              #/components/schemas/Common.HubValueText_Common.HubDescriptionType_
        pictures:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/Common.HubPicture'
        isPrivate:
          type: boolean
        sortOrder:
          format: int32
          type: integer
    Description.Rate.HubRateGratuitounessPeriod:
      required:
        - paidNightCount
        - freeNightCount
      type: object
      properties:
        period:
          $ref: '#/components/schemas/Description.Common.HubPeriod'
        paidNightCount:
          format: int32
          type: integer
        freeNightCount:
          format: int32
          type: integer
    Description.Rate.HubRateStay:
      required:
        - lastMinuteDayCount
        - earlyBookingDayCount
      type: object
      properties:
        lastMinuteDayCount:
          format: int32
          type: integer
        earlyBookingDayCount:
          format: int32
          type: integer
        periods:
          type: array
          items:
            $ref: '#/components/schemas/Description.Common.HubWeekPeriod'
    Description.Common.HubWeekPeriod:
      required:
        - daysOfWeek
      type: object
      properties:
        period:
          $ref: '#/components/schemas/Description.Common.HubPeriod'
        daysOfWeek:
          $ref: '#/components/schemas/Library.DaysOfWeek'
    Description.Rate.HubRateSellingConditions:
      required:
        - deposit
        - bookingFees
        - paymentBalance
        - useOnlinePayment
        - allowFullOnlinePayment
        - allowCallOption
      type: object
      properties:
        deposit:
          default:
            depositType: Nothing
            percent: 0
          allOf:
            - $ref: >-
                #/components/schemas/Description.Rate.HubRateSellingConditionsDeposit
        useOnlinePayment:
          type: boolean
        bookingFees:
          default:
            percent: 0
            nominal: 0
          allOf:
            - $ref: >-
                #/components/schemas/Description.Rate.HubRateSellingConditionsBookingFees
        allowFullOnlinePayment:
          type: boolean
        allowCallOption:
          type: boolean
        paymentBalance:
          default: []
          type: array
          items:
            $ref: >-
              #/components/schemas/Common.HubValueText_Common.HubDescriptionType_
    Description.Rate.HubRateCancelConditions:
      required:
        - cancelConditions
        - description
        - usePlanningConditions
        - isGuestModificationEnabled
        - isModificationEnabled
      type: object
      properties:
        cancelConditions:
          default: []
          type: array
          items:
            $ref: '#/components/schemas/Description.Common.HubCancelCondition'
        description:
          default: []
          type: array
          items:
            $ref: >-
              #/components/schemas/Common.HubValueText_Common.HubDescriptionType_
        usePlanningConditions:
          type: boolean
        isGuestModificationEnabled:
          type: boolean
        isModificationEnabled:
          type: boolean
    HotelBusiness.RoomId:
      format: int32
      type: integer
    HotelBusiness.OccupancyId:
      format: int32
      type: integer
    HotelBusiness.ExtraId:
      format: int32
      type: integer
    Common.HubValueText_Description.Rate.HubRateType_:
      allOf:
        - $ref: '#/components/schemas/Common.HubValueText'
        - required:
            - value
          type: object
          properties:
            value:
              $ref: '#/components/schemas/Description.Rate.HubRateType'
    Common.HubValueText_Description.Rate.HubRateQualifier_:
      allOf:
        - $ref: '#/components/schemas/Common.HubValueText'
        - required:
            - value
          type: object
          properties:
            value:
              $ref: '#/components/schemas/Description.Rate.HubRateQualifier'
    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
    Description.Common.HubPeriod:
      required:
        - start
        - end
      type: object
      properties:
        start:
          format: date
          type: string
        end:
          format: date
          type: string
    Library.DaysOfWeek:
      enum:
        - None
        - Sunday
        - Monday
        - Tuesday
        - Wednesday
        - Thursday
        - Friday
        - Saturday
        - All
      type: string
    Description.Rate.HubRateSellingConditionsDeposit:
      required:
        - depositType
        - percent
      type: object
      properties:
        depositType:
          $ref: >-
            #/components/schemas/Description.Rate.HubRateSellingConditionsDepositType
        percent:
          $ref: '#/components/schemas/HotelBusiness.Percent'
    Description.Rate.HubRateSellingConditionsBookingFees:
      required:
        - percent
        - nominal
      type: object
      properties:
        percent:
          $ref: '#/components/schemas/HotelBusiness.Percent'
        nominal:
          format: decimal
          type: number
    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
    Common.HubValueText:
      type: object
      properties:
        text:
          type: string
    Description.Rate.HubRateType:
      description: >-
        Commercial classification of a rate (public, promotional, package,
        etc.).


        - **PublicPrice** — Standard public rate.

        - **Promotional** — Rate with a promotional discount.

        - **ThreeNightPackage** — Package rate covering a fixed three-night
        stay.

        - **BestAvailable** — Best available rate at the moment of the search.

        - **LastMinute** — Last-minute rate, typically discounted close to the
        arrival date.

        - **EarlyBooking** — Early-booking rate, typically discounted when
        booked well in advance.

        - **Seasonal** — Seasonal rate valid for a specific period of the year.

        - **WeekEnd** — Weekend rate.

        - **FreeFourthNight** — Fourth night is offered free of charge.

        - **FreeFifthNight** — Fifth night is offered free of charge.

        - **Corporate** — Corporate rate reserved for business partners.

        - **FacebookSpecialOffer** — Special offer distributed through Facebook.
      enum:
        - PublicPrice
        - Promotional
        - ThreeNightPackage
        - BestAvailable
        - LastMinute
        - EarlyBooking
        - Seasonal
        - WeekEnd
        - FreeFourthNight
        - FreeFifthNight
        - Corporate
        - FacebookSpecialOffer
      type: string
    Description.Rate.HubRateQualifier:
      description: >-
        Meal-plan and package qualifier attached to a rate.


        - **RoomOnly** — Room only, no meals or services included.

        - **BreakfastIncluded** — Breakfast included.

        - **HalfBoard** — Half board included (breakfast plus one other main
        meal).

        - **FullBoard** — Full board included (breakfast, lunch and dinner).

        - **AllInclusive** — All-inclusive: meals and most beverages included.

        - **SelfCatering** — Self-catering accommodation with cooking
        facilities.

        - **Package** — Non-refundable package rate.

        - **BreakfastIncludedPackage** — Package rate with breakfast included.

        - **HalfBoardPackage** — Package rate with half board included.

        - **FullBoardPackage** — Package rate with full board included.

        - **AllInclusivePackage** — All-inclusive package rate.

        - **SelfCateringPackage** — Self-catering package rate.
      enum:
        - RoomOnly
        - BreakfastIncluded
        - HalfBoard
        - FullBoard
        - AllInclusive
        - SelfCatering
        - Package
        - BreakfastIncludedPackage
        - HalfBoardPackage
        - FullBoardPackage
        - AllInclusivePackage
        - SelfCateringPackage
      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.Rate.HubRateSellingConditionsDepositType:
      description: >-
        How the deposit required to guarantee a booking is defined.


        - **Nothing** — No deposit required.

        - **CreditCardNumber** — Credit card number is collected but no funds
        are captured up-front.

        - **FirstNightWithoutExtras** — Amount of the first night excluding
        extras is captured as deposit.

        - **PercentageWithoutExtras** — A percentage of the room rate (excluding
        extras) is captured as deposit.

        - **PercentageWithExtras** — A percentage of the full booking (including
        extras) is captured as deposit.
      enum:
        - Nothing
        - CreditCardNumber
        - FirstNightWithoutExtras
        - PercentageWithoutExtras
        - PercentageWithExtras
      type: string
    HotelBusiness.Percent:
      format: decimal
      type: number
    HotelBusiness.CancelDelay:
      format: int32
      type: integer

````

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