Sign in

v1

latestOpenAPI 3.0.02026-08-0617434432.8 KB
Search and Details

Search hotels by property ID.

The Search by ID request searches for specific hotels by their property ID. You can send up to 250 property IDs. The response returns a list of properties based on the ID/s sent. The Search by ID response format is the same as for Search by Location. The response returns up to 100 properties, or all requested properties if less than 100. If more than 100 properties were requested and are available, you can request the next page with the Search Pagination API.

post/hotel/search/properties

Headers

TraceIdstring
Example:TraceID_123456789

Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response.

XAUTH_TRAVELPORT_ACCESSGROUPstring
Example:19Y88702-C27A-4E5D-829A-89D7016688B1

Identifies the Travelport access group with which the caller is associated

TVP-PCC-Corestring
Example:DU7_1G

Allows user to pass PCC instead of Access Group ID

TVP-Correlation-Idstring uuid
Example:382c74c3-721d-4f34-80e5-57657b6cbc27

Identifier used to correlate hotel API invocations across a multi-call business flows.

Request body

Example request

{
  "PropertiesQuerySpecificPropertyList": {
    "@type": "PropertiesQuerySpecificPropertyList",
    "PropertyKey": [
      {
        "chainCode": "UR",
        "propertyCode": "G3375"
      }
    ],
    "RateCandidates": {
      "@type": "RateCandidates",
      "RateCandidate": [
        {
          "@type": "RateCandidateDetail",
          "rateCode": "HL123",
          "rateCategory": "Discount",
          "chainCode": "UR",
          "propertyCode": "G3375",
          "masterRateCode": "1ABC23"
        }
      ]
    },
    "imageSize": "Small",
    "RoomStayCandidates": {
      "RoomStayCandidate": [
        {
          "GuestCounts": {
            "@type": "GuestCounts",
            "GuestCount": [
              {
                "@type": "GuestCount",
                "age": 21,
                "count": 2,
                "ageQualifyingCode": "10"
              }
            ]
          },
          "RoomAmenity": [
            {
              "description": "WiFi",
              "Name": "24 hour Room Service"
            }
          ]
        }
      ]
    }
  }
}

Response

OK - Successful Response - 200

Example response

{
  "PropertiesResponse": {
    "@type": "response",
    "transactionId": "49f58f5f-c443-43b4-9f5d-be405fd00a01",
    "traceId": "TraceID_123456",
    "Result": {
      "@type": "Result",
      "status": "Complete",
      "Error": [
        {
          "@type": "ErrorDetail",
          "StatusCode": 200,
          "Message": "No flights found.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ],
      "Warning": [
        {
          "@type": "WarningDetail",
          "StatusCode": 200,
          "Message": "Customer Loyalty could not be applied.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ]
    },
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    },
    "NextSteps": {
      "id": "5",
      "NextStep": [
        {
          "value": "www.resourcelocation.com",
          "id": "2",
          "action": "cancel",
          "description": "remove offer from the order"
        }
      ]
    },
    "ReferenceList": [
      {
        "@type": "ReferenceListFlight"
      }
    ],
    "CurrencyRateConversion": [
      {
        "SourceCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "TargetCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "ConversionRate": {
          "rateAuthority": "ISO 4217",
          "rateAsOf": "2026-08-07T12:12:00Z"
        }
      }
    ],
    "Pagination": {
      "@type": "Pagination",
      "page": 1,
      "pageSize": 20,
      "totalPages": 5,
      "totalItems": 100
    }
  }
}