Sign in
Rules

Return hotel rules (full payload).

Hotel Rules retrieves the rules associated with a specific rate. The full payload request in this topic sends all required rate details, while the reference payload Rules request references rate details from a previous Availability response by sending the offer ID from that response. The response for both the reference and full payload is the same.

post/hotel/rules/offershospitality/buildfromrequest

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

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

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
    }
  }
}