Sign in

v1

latestSwagger 2.02026-08-0689081.6 KB
Service

Retrieve hotel rate details

Retrieve hotel rate details for rates of a property - used when rate details are missing from /rates call and/or during checkout process.

post/hotels/ratedetails

Headers

Accept-Languagestring

Advertises which languages the client is able to understand

concur-correlationidstring required

This unique code can be used during troubleshooting as it identifies the API call in the log files.

Request body

checkinstring date required

Check in date as entered by traveler

checkoutstring date required

Check out date as entered by traveler

guestCountryCodestring

Two-character ISO code (ISO ALPHA-2) for country

numGuestsinteger

No. of guests for accomodation as entered by traveler

ratePlanIdsstring[] required

Rate Product Ids for which detail rates are requested

accessViaMobileboolean

Indicates if the request is coming from mobile device

searchSessionTokenstring uuid

Session token to be generated and provided by server on initial "search" call that can be referenced back for future api calls on the same session.

Example request

{
  "checkin": "2021-10-20",
  "checkout": "2021-10-23",
  "guestCountryCode": "CA",
  "hotelPropertyRef": {
    "chainCode": "HH",
    "propertyCode": "HH498949"
  },
  "rateCategories": [
    {
      "otaCode": 1,
      "value": "AAA"
    }
  ],
  "ratePlanIds": [
    "44SM3FAsfvgcZs9ehGlNOQ"
  ],
  "requestorInfo": {
    "bookingForSelf": true,
    "loginId": "abc@concur.com",
    "posRequestorId": "abc1234",
    "travelerUuid": "123e4567-e89b-12d3-a456-426614174000",
    "pcc": "ABC123"
  },
  "reshopInfo": {
    "gdsRecordLocator": {
      "pcc": "ABC123",
      "recordLocator": "ABC123"
    },
    "confirmationCodes": [
      {
        "code": "3704188022P5683"
      }
    ]
  },
  "customFields": [
    {
      "name": "OrgUnit",
      "value": "Travel Agents"
    }
  ]
}

Response

Hotel rates for requested properties

checkinstring date required
checkoutstring date required

Example response

{
  "checkin": "2021-10-20",
  "checkout": "2021-10-23",
  "roomRates": [
    {
      "cancelPenalties": {
        "description": "Free cancellation up to 1 week before checkin",
        "penalties": [
          {
            "amountPercent": {
              "amount": {
                "amount": 190.95,
                "currencyCode": "USD"
              },
              "feesInclusive": true,
              "numberOfNights": 5,
              "percent": 10.05,
              "taxInclusive": true
            },
            "cancelDeadline": "2017-07-21T17:32:28Z07:00 or 2017-07-21T17:32:28 or 2017-07-21 17:32:28",
            "description": "Free cancellation up to 1 week before checkin"
          }
        ]
      },
      "guarantee": {
        "acceptedPayments": [
          "VISA"
        ],
        "amountPercent": {
          "amount": {
            "amount": 190.95,
            "currencyCode": "USD"
          },
          "feesInclusive": true,
          "numberOfNights": 5,
          "percent": 10.05,
          "taxInclusive": true
        }
      },
      "nightlyPrices": [
        {
          "basePrice": 89.95,
          "currencyCode": "USD",
          "endDate": "2021-12-31",
          "fees": {
            "amount": 10.95,
            "feeBreakdown": [
              {
                "amount": 8.05,
                "fttCode": 15,
                "inclusive": true
              }
            ]
          },
          "startDate": "2021-12-01",
          "taxes": {
            "amount": 5.55,
            "taxBreakdown": [
              {
                "amount": 8.05,
                "fttCode": 15,
                "inclusive": true
              }
            ]
          },
          "totalPrice": 100.05
        }
      ],
      "prepayRequired": true,
      "rateCategory": {
        "otaCode": 1,
        "value": "AAA"
      },
      "loyaltyMembershipRequired": true,
      "rateDescription": [
        "Promotional Rate"
      ],
      "prepaymentDetails": {
        "paymentDate": "2021-10-20T17:32:28Z",
        "termsAndConditionsUrl": "https://terms-and-condition-example-url"
      },
      "ratePlanId": "44SM3FAsfvgcZs9ehGlNOQ",
      "refundable": true,
      "roomId": "kVNU66KLxuggtu2H",
      "totalPrice": {
        "currencyCode": "USD",
        "fees": 10,
        "feesBreakdown": [
          {
            "amount": 8.05,
            "fttCode": 15,
            "inclusive": true
          }
        ],
        "isTotalBeforeTaxDisplayEligible": true,
        "taxes": 10,
        "taxesBreakdown": [
          {
            "amount": 8.05,
            "fttCode": 15,
            "inclusive": true
          }
        ],
        "totalAfterTax": 190.95,
        "totalBeforeTax": 170.95
      },
      "rateDetailsCallRequired": true
    }
  ]
}