Sign in

v1

latestSwagger 2.02026-08-0689081.6 KB
Service

Perform the initial search for hotels.

Perform the initial search for hotels according to params

post/hotels/search

Headers

Accept-Languagestring

Advertises which languages the client is able to understand

concur-correlationidstring required

Correlation ID to track the record across the logs

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

includeDepositRequiredboolean required

Whether to include properties where deposit is required or not

maxSearchResultsinteger

Maximum number of properties allowed to be included in search results

numGuestsinteger

No. of guests for accomodation as entered by traveler

accessViaMobileboolean

Indicates if the request is coming from mobile device

Example request

{
  "checkin": "2021-10-20",
  "checkout": "2021-10-23",
  "customFields": [
    {
      "name": "OrgUnit",
      "value": "Travel Agents"
    }
  ],
  "guestCountryCode": "CA",
  "hotelPropertyRefs": [
    {
      "chainCode": "HH",
      "propertyCode": "HH498949"
    }
  ],
  "locationSearch": {
    "location": {
      "address": {
        "addressLines": [
          "910 Mainland Street"
        ],
        "city": "Vancouver",
        "countryCode": "CA",
        "postalCode": "V5K 0A1",
        "state": "BC",
        "stateName": "British Columbia"
      },
      "geoLocation": {
        "latitude": 49.246292,
        "longitude": -123.116226
      },
      "locationType": "Hotel",
      "name": "Sheraton DFW Airport Hotel"
    },
    "maxRadius": {
      "value": 5
    },
    "radius": {
      "value": 5
    }
  },
  "maxSearchResults": 100,
  "rateCategories": [
    {
      "otaCode": 1,
      "value": "AAA"
    }
  ],
  "requestorInfo": {
    "bookingForSelf": true,
    "loginId": "abc@concur.com",
    "posRequestorId": "abc1234",
    "travelerUuid": "123e4567-e89b-12d3-a456-426614174000",
    "pcc": "ABC123"
  }
}

Response

Search results that meet criteria

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 response

{
  "hotelProperties": [
    {
      "address": {
        "addressLines": [
          "910 Mainland Street"
        ],
        "city": "Vancouver",
        "countryCode": "CA",
        "postalCode": "V5K 0A1",
        "state": "BC",
        "stateName": "British Columbia"
      },
      "altPropertyCode": {
        "catalogCode": "HH498949"
      },
      "amenities": [
        {
          "cost": {
            "amount": 190.95,
            "currencyCode": "USD"
          }
        }
      ],
      "chainCode": "HH",
      "contactInfo": {
        "faxNumber": "+1-555-555-5678",
        "phoneNumbers": [
          "+1-555-555-1234"
        ]
      },
      "hotelName": "JW Marriott Parq",
      "leadImageURI": "https://images.samplehost.com/samplepath/leadimage.jpg",
      "leadRate": {
        "avgNightlyRate": {
          "amount": 190.95,
          "currencyCode": "USD"
        }
      },
      "totalPrice": {
        "totalOverStay": {
          "amount": 190.95,
          "currencyCode": "USD"
        }
      },
      "onRequest": true,
      "position": {
        "latitude": 49.246292,
        "longitude": -123.116226
      },
      "propertyCode": "HH498949",
      "rating": {
        "source": "NORTHSTAR",
        "value": 4,
        "name": "My Custom Source"
      },
      "superChainCode": "EM",
      "sustainabilityAwards": [
        {
          "label": "EARTH_CHECK",
          "level": "Gold",
          "name": "Custom"
        }
      ],
      "emissionInfo": {
        "emissions": 1.3141592722321,
        "sustainabilityScore": 40
      },
      "exactMatch": true,
      "acceptedPayments": "VISA",
      "propertyTypeCode": 19,
      "recommendationReasons": "MOST_BOOKED_BY_COMPANY"
    }
  ]
}