HTE JSON clients (OTA Only)

The below is designed to aid partners in connecting to Hilton’s APIs. It provides additional info to supplement the other instructions, guidelines and technical information in this Developer Portal. If you have additional questions, we are here to help. Email us and we’ll respond as soon as we can.

DC Shop

Response size/ # of products returned on single property availability

  • There is no limit on the number of response records returned. The response size depends on how many rates were requested and how many room types are available at the property. It is possible to see 100+ products return which would result in response body size of approximately 10KB.
  • Single property shop requests will return up to 14 available rate plans.
  • There is no limit on the number of response records returned; it is based on the rates and room types included.
  • See Check for Available Rooms for additional information.

DC Res

Guest Name Record (GNR)

  • Modify/Cancel Requests require GNR # to be passed. GNR is the Hilton stay ID, and there can be multiple stays under a single Hilton confirmation #.
  • A retrieve (GET) has the ability to return all stays under a confirmation # or the request can target a specific GNR to return.

GNR Numbers: Legacy applications only supported one stay per confirmation. The API allows multiple stays for one confirmation number.

Modify Logic

  • A modify requires that the complete booking information be passed in on the modify request which includes the reservation data that changed.

General Information

Request Fields

  • bookingCode – For use by GDS clients only
  • cxlPolicyCode – These Hilton policy codes should not be necessary for client to interpret however in case of non-refundable code ‘NREF’ will be returned that can be used as non-refundable indicator. For example: "cxlPolicyCode": "CX1", "cxlPolicyCode": "NREF"
  • displayCurrency – If not populated the default will return as the currency of the rate plan.
  • gdsChainCode – Required use by GDS clients only
  • promoCode – Field is exposed in schema but not currently used by third parties
  • primaryGdsCode – Required use by GDS clients only
  • pseudoCityCode – Required use by GDS clients only
  • secondaryGdsCode – Optional use by GDS clients only
  • singleProduct – Object found within DC Shop to allow client to shop for a specific rate code/room type. This can be used to make live check calls to Hilton during booking process to validate inventory. Note: This does not include support of GDS rate/room codes.
  • travelAgentId – Field is not required but must be populated when booking corporate rates so that Hilton can properly report commissions.

Response Fields

  • rateDisplayOrder
    • Field indicates default Hilton rate order
    • This is not necessary for majority of clients, who will return products in order shown by the roomRates object
  • roomDisplayOrder
    • Field indicates default Hilton room order
    • This is not necessary for majority of clients, who will return products in order shown by the roomRates object

Supported characters

  • ASCII range 32-122