Return hotel rules (reference payload).
Available January 2023. Hotel Rules retrieves the rules associated with a specific rate. The reference payload references an offer by sending the unique offer ID from an Availability response, instead of sending all required offer details as in the full payload Rules request. The response for both the reference and full payload is the same.
Request
- Base URLhttps://api.pp.travelport.net/11
- AuthHTTP bearer
Headers
Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response.
Identifies the Travelport access group with which the caller is associated
Allows user to pass PCC instead of Access Group ID
Identifier used to correlate hotel API invocations across a multi-call business flows.
Request body
Example request
{
"OfferQueryBuildFromCatalogOffering": {
"@type": "OfferQueryBuildFromCatalogOffering",
"BuildFromCatalogOfferingHospitality": {
"@type": "BuildFromCatalogOfferingHospitality",
"CatalogOfferingIdentifier": {
"value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
"authority": "TVPT"
},
"SpecialInstruction": "Guest prefers room on first floor.",
"NumberOfRooms": 1
}
}
}Response
OK - Successful Response - 200
Example response
{
"OfferHospitalityResponse": {
"@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
}
}
}Changes
No recorded changes to this operation across all 2 revisions of this API.