Sign in

v1

latestSwagger 2.02026-08-0689081.6 KB
Service

Returns detailed information about a hotel reservation.

Read reservation details. Used in a process of reserving a hotel to acknowledge receipt of booking confirmation as well as write information to Itinerary. Not invoked by user, but by automatic Concur process. Hotel Supplier should reply with the same response as provided for the book response.

post/hotels/reservation/read

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

Example request

{
  "confirmationCodes": [
    {
      "code": "3704188022P5683"
    }
  ],
  "requestorInfo": {
    "bookingForSelf": true,
    "loginId": "abc@concur.com",
    "posRequestorId": "abc1234",
    "travelerUuid": "123e4567-e89b-12d3-a456-426614174000",
    "pcc": "ABC123"
  }
}

Response

Successful read itinerary

checkinstring date
checkoutstring date
commentsstring[]

Additional information from the supplier for the traveler (e.g., whether loyalty points are applicable to the booking)

isModifiableboolean

Whether or not this reservation can be modified.

voucherUrlstring

The URL to the voucher for this booking

roomDescriptionstring[] required
status'PENDING_CONFIRMATION' | 'RESERVED' | 'CANCELLED' required
activeSegmentInConcurPNRboolean

Whether or not this reservation was added to Concur PNR as active segment (true) or not. Required if using Single PNR Solution

Example response

{
  "basicHotelProperty": {
    "address": {
      "addressLines": [
        "910 Mainland Street"
      ],
      "city": "Vancouver",
      "countryCode": "CA",
      "postalCode": "V5K 0A1",
      "state": "BC",
      "stateName": "British Columbia"
    },
    "chainCode": "HH",
    "cityCode": "DFW",
    "contactInfo": {
      "faxNumber": "+1-555-555-5678",
      "phoneNumbers": [
        "+1-555-555-1234"
      ]
    },
    "hotelName": "JW Marriott Parq",
    "position": {
      "latitude": 49.246292,
      "longitude": -123.116226
    },
    "propertyCode": "HH498949"
  },
  "checkin": "2021-10-20",
  "checkout": "2021-10-23",
  "comments": [
    "Loyalty points will be earned for this stay"
  ],
  "confirmationCodes": [
    {
      "code": "3704188022P5683"
    }
  ],
  "guests": [
    {
      "address": {
        "addressLines": [
          "910 Mainland Street"
        ],
        "city": "Vancouver",
        "countryCode": "CA",
        "postalCode": "V5K 0A1",
        "state": "BC",
        "stateName": "British Columbia"
      },
      "birthdate": "1990-04-17",
      "companyName": "SAP Concur",
      "contactInfo": {
        "faxNumber": "+1-555-555-5678",
        "phoneNumbers": [
          "+1-555-555-1234"
        ]
      },
      "firstname": "Blake",
      "middleName": "Jordan",
      "lastname": "Smith"
    }
  ],
  "isModifiable": true,
  "voucherUrl": "https://www.concur.com/voucher/voucher-id",
  "roomDescription": [
    "1 bedroom luxury suite",
    "hearing accessible",
    "workspace",
    "garden facing balcony"
  ],
  "roomRate": {
    "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
  }
}