Shop Availability at Multiple Properties for Direct Connect Partners
This request message provides functionality for direct connect partners including GDS & ADS systems to allow shopping for available rooms at multiple Hilton properties. The query will retrieve available rooms that will accommodate the requirements specified in the shop request, such as the number of guests, arrival and departure dates, smoking or non-smoking preferences, and other criteria, along with rate plans for the available rooms.
Authentication type: Application & Application User
POST https://kapip-s.hilton.io/hospitality-partner/v2/dcshop/props
multiPropDcShop | required | MultiPropDcShop-DcShop |
Responses
200 | Successful Operation | < PropDcShop-DcShop > array |
400 | Bad Request | ErrorDetail-DcShop |
403 | Forbidden | No Content |
Example Request
https://kapip-s.hilton.io/hospitality-partner/v2/dcshop/props
{
"maxRateQualifier" : 0.0,
"minRateQualifier" : 0.0,
"pseudoCityCode" : "string",
"ratePlanCandidates" : [ {
"ratePlanCategory" : {
"description" : "Each code is associated with one or more Hilton rate plans."
},
"ratePlanId" : "string"
} ],
"numAdults" : 0,
"secondaryGdsCode" : "string",
"roomAmenities" : [ {
"description" : "The room amenities array, when used, will restrict the availability\nsearch so that only room types that match the list of attributes\nwill be included in the response.\n"
} ],
"primaryGdsCode" : "string",
"props" : [ {
"propCode" : "string",
"gdsChainCode" : "string"
} ],
"arrivalDate" : "string",
"travelAgentId" : "string",
"numChildren" : 0,
"promoCode" : "string",
"departureDate" : "string",
"childAges" : [ 0 ],
"displayCurrency" : "string"
}
Example Response
[ {
"taxPeriods" : [ {
"taxes" : [ {
"period" : {
"description" : "Period Type."
},
"amount" : 0.0,
"type" : {
"description" : "(percent) = Percentage of tax basis, (flat) = Flat Change, (sum) = % of sum of tax basis and prior tax."
},
"basis" : {
"description" : "Basis Type."
}
} ],
"effectiveDate" : "string"
} ],
"numAdults" : 0,
"highRate" : 0.0,
"adultAge" : 0,
"lowRate" : 0.0,
"propName" : "string",
"statusMessage" : "string",
"propCode" : "string",
"arrivalDate" : "string",
"lengthOfStay" : 0,
"marketingText" : [ "string" ],
"roomTypes" : {
"roomTypeCode" : {
"adaAccessibleRoom" : true,
"roomTypeCode" : "string",
"roomTypeDesc" : [ "string" ],
"smokingRoom" : true,
"extraBedPermitted" : true,
"roomOccupancy" : 0,
"roomDisplayOrder" : 0,
"extraPersonsAllowed" : true,
"numBeds" : 0,
"crsRoomTypeCode" : "string",
"bedType" : {
"description" : "Bed Type"
}
}
},
"childAgeRanges" : [ {
"endChildAge" : 0,
"startChildAge" : 0
} ],
"numChildren" : 0,
"roomRates" : [ {
"depositAmount" : 0.0,
"averageRate" : 0.0,
"roomTypeCode" : "string",
"amountBeforeTax" : 0.0,
"merchantTotalAmount" : 0.0,
"chargeTotals" : [ {
"total" : 0.0,
"category" : "string"
} ],
"totalTaxes" : 0.0,
"rollawayRate" : 0.0,
"averageRateAfterFees" : 0.0,
"rateAmount" : 0.0,
"averageRateAfterTax" : 0.0,
"amountAfterTax" : 0.0,
"ratePlanCode" : "string",
"rateChangeIndicator" : true,
"rateDetails" : [ {
"childRates" : [ 0.0 ],
"rate3Person" : 0.0,
"rate2Person" : 0.0,
"extraChildRate" : 0.0,
"rollawayRate" : 0.0,
"rate1Person" : 0.0,
"rate4Person" : 0.0,
"extraPersonRate" : 0.0,
"cribRate" : 0.0,
"chargeDetails" : [ {
"amountType" : {
"description" : "The type of Charge rule amount that can be setup."
},
"inclusive" : true,
"amount" : 0.0,
"period" : {
"description" : "Period Type."
},
"accountingCode" : "string",
"includedInQuotedRate" : true,
"basis" : {
"description" : "Options that are part of the application criteria for a charge rule"
},
"collectedOnProperty" : true,
"sequence" : 0,
"total" : 0.0,
"appliedToRuleId" : 0,
"name" : "string",
"ruleId" : 0,
"category" : "string",
"overrideRuleId" : 0
} ],
"effectiveDate" : "string"
} ],
"serviceChargesInTaxCalc" : true,
"totalServiceCharges" : 0.0,
"amountWithFees" : 0.0,
"cribRate" : 0.0,
"bookingCode" : "string",
"numRoomsAvail" : 0,
"serviceChargeDesc" : "string",
"meals" : {
"lunch" : true,
"breakfast" : true,
"dinner" : true,
"mealPlan" : "string"
}
} ],
"departureDate" : "string",
"ageBasedPricing" : true,
"childAges" : [ 0 ],
"ratePlans" : {
"ratePlanCode" : {
"ratePlanOrder" : 0,
"cxlPolicyCode" : "string",
"advancePurchase" : true,
"ratePlanCode" : "string",
"serviceChargesAndTaxesIncluded" : true,
"promoCode" : "string",
"serviceChargePeriods" : [ {
"charges" : [ {
"period" : {
"description" : "Period Type."
},
"amount" : 0.0,
"type" : {
"description" : "Service Charge Type"
},
"basis" : {
"description" : "Basis Type."
}
} ],
"effectiveDate" : "string"
} ],
"gdsFlags" : "string",
"ratePlanDesc" : [ "string" ],
"ratePlanCategory" : {
"description" : "Each code is associated with one or more Hilton rate plans."
},
"cxlPolicyDesc" : "string",
"highRate" : 0.0,
"guarPolicyDesc" : "string",
"lowRate" : 0.0,
"clientIds" : [ "string" ],
"commissionType" : {
"description" : "Type of commission"
},
"depositDesc" : "string",
"guaranteeMethods" : [ "string" ],
"clientIdRequired" : true,
"commissionable" : true,
"guarPolicyCode" : "string",
"cxlPolicyLocalDeadline" : "string",
"displayCurrency" : "string",
"currencyCode" : "string",
"commissionAmount" : 0.0,
"cxlPolicyDeadline" : "string"
}
},
"currencyCode" : "string",
"clientAccounts" : {
"clientId" : {
"gdsRatePlanCode" : "string",
"clientId" : "string",
"clientType" : {
"description" : "Client Type (corporate, travelAgent)."
},
"clientName" : "string",
"programAccountId" : 0,
"clientRatePlanFound" : true,
"gdsRateCategory" : "string"
}
},
"statusCode" : 0,
"brandCode" : "string",
"gdsChainCode" : "string"
} ]
Definitions
AvailClientAccount-DcShop
clientId | optional | Client account ID Pattern : ^\d{1,22}$ Example : "string" |
string |
clientName | optional | Client Name Example : "string" |
string |
clientRatePlanFound | optional | Example : true |
boolean |
clientType | optional | Example : ClientType-DcShop |
ClientType-DcShop |
gdsRateCategory | optional | Example : "string" |
string |
gdsRatePlanCode | optional | GDS Rate Plan Code Example : "string" |
string |
programAccountId | optional | Internal id assigned to a Program Account Example : 0 |
integer(int64) |
BasisType-DcShop
Basis Type.
Type : enum (perRoom, perGuest)
CategoryTotal-DcShop
Summarized and grouped totals by charge rule type, taxes, fees, surcharges, etc.
category | required | Unique code that represents a specific charge category. Pattern : ^[A-Z0-9]{3,30}$ Example : "string" |
string |
total | required | Grand total of charges. Example : 0.0 |
number(double) |
CategoryTotalDetail-DcShop
Summarized and grouped totals by charge rule type, taxes, fees, surcharges, etc.
accountingCode | optional | Accounting code to be used for mapping charge rules to GL accounts. Pattern : ^((?!\|)[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,255}$ Example : "string" |
string |
amount | optional | Charge rule amount. Example : 0.0 |
number(double) |
amountType | optional | Example : ChargeRuleAmountType-DcShop |
ChargeRuleAmountType-DcShop |
appliedToRuleId | optional | For tax on tax scenarios, id of the rule that this rule was calculated upon. Example : 0 |
integer |
basis | optional | Example : ChargeRuleBasis-DcShop |
ChargeRuleBasis-DcShop |
category | required | Unique code that represents a specific charge category. Pattern : ^[A-Z0-9]{3,30}$ Example : "string" |
string |
collectedOnProperty | optional | Flag to indicate to our external partners (OTAS, etc) which taxes or fees will be collected on property. Example : true |
boolean |
includedInQuotedRate | optional | Indicates if a given charge rule is included in the quoted rate (amount before tax). Example : true |
boolean |
inclusive | optional | Indicates if the Charge Rule was included in the charge amount. Default : false Example : true |
boolean |
name | optional | Short name that identifies a charge rule. Pattern : ^((?!\|)[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,50}$ Example : "string" |
string |
overrideRuleId | optional | Charge rule override id. Indicates that this rule was overridden and which override was applied. Example : 0 |
integer |
period | optional | Example : PeriodType-DcShop |
PeriodType-DcShop |
ruleId | optional | Example : 0 |
integer |
sequence | required | Example : 0 |
integer |
total | required | Total charges for the category. Example : 0.0 |
number(double) |
ChargeRuleAmountType-DcShop
The type of Charge rule amount that can be setup.
Type : enum (flat, percent)
ChargeRuleBasis-DcShop
Options that are part of the application criteria for a charge rule
Type : enum (perRoom, perChild, perAdult, perGuest)
ChildAgeRange-DcShop
endChildAge | optional | Ending child age of child rate age range Minimum value : 0 Example : 0 |
integer |
startChildAge | optional | Starting child age of child rate age range Minimum value : 0 Example : 0 |
integer |
ClientType-DcShop
Client Type (corporate, travelAgent).
Type : enum (corporate, travelAgent)
CommissionType-DcShop
Type of commission
Type : enum (percent, amount)
DcShopProperty-DcShop
gdsChainCode | optional | GDS chain code Pattern : ^[A-Z]{2}$ Example : "string" |
string |
propCode | required | Property Code or GDS Property Code Pattern : ^[A-Z0-9]{2,6}$ Example : "string" |
string |
DcShopRateDetail-DcShop
chargeDetails | optional | Example : CategoryTotalDetail-DcShop |
< CategoryTotalDetail-DcShop > array |
childRates | optional | Child rate for a given age range Max Items : 6 Example : [ 0.0 ] |
< number(double) > array |
cribRate | optional | Daily crib rate Example : 0.0 |
number(double) |
effectiveDate | optional | The effective date as defined by full-date - RFC3339 (YYYY-MM-DD). Example : "string" |
string(date) |
extraChildRate | optional | extra child rate Example : 0.0 |
number(double) |
extraPersonRate | optional | extra person charge Example : 0.0 |
number(double) |
rate1Person | optional | Room rate for 1 person in room Example : 0.0 |
number(double) |
rate2Person | optional | Room rate for 2 persons in room Example : 0.0 |
number(double) |
rate3Person | optional | Room rate for 3 persons in room Example : 0.0 |
number(double) |
rate4Person | optional | Room rate for 4 persons in room Example : 0.0 |
number(double) |
rollawayRate | optional | Daily roll-away rate Example : 0.0 |
number(double) |
DcShopRatePlan-DcShop
advancePurchase | optional | Is this reservation fully pre-paid Example : true |
boolean |
clientIdRequired | optional | Client file (clientId) is required for booking. Example : true |
boolean |
clientIds | optional | Client account ID Pattern : ^\d{1,22}$ Example : [ "string" ] |
< string > array |
commissionAmount | optional | Amount of the commission Example : 0.0 |
number(double) |
commissionType | optional | Example : CommissionType-DcShop |
CommissionType-DcShop |
commissionable | optional | Indicates the rate plan is commissionable Example : true |
boolean |
currencyCode | optional | ISO 4217 standard currency code Pattern : ^[A-Z]{3}$ Example : "string" |
string |
cxlPolicyCode | optional | The cancellation policy for the stay Example : "string" |
string |
cxlPolicyDeadline | optional | The time stamp as defined by date-time - RFC3339 that represents the cancellation policy deadline for the property in UTC. Example : "string" |
string(date-time) |
cxlPolicyDesc | optional | The cancellation policy description Example : "string" |
string |
cxlPolicyLocalDeadline | optional | The time stamp in YYYY-MM-DDThh:mm format that represents the cancellation policy deadline for the property in the property’s local time. Pattern : ^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]$ Example : "string" |
string |
depositDesc | optional | A brief description of the deposit policy. Example : "string" |
string |
displayCurrency | optional | ISO 4217 standard currency code Pattern : ^[A-Z]{3}$ Example : "string" |
string |
gdsFlags | optional | GDS specific flags Example : "string" |
string |
guarPolicyCode | optional | The guarantee policy code for the stay Example : "string" |
string |
guarPolicyDesc | optional | The guarantee policy description Example : "string" |
string |
guaranteeMethods | optional | Guarantee method code Pattern : ^[A-Z0-9]{2}$ Example : [ "string" ] |
< string > array |
highRate | optional | Highest available rate Example : 0.0 |
number(double) |
lowRate | optional | Lowest available rate Example : 0.0 |
number(double) |
promoCode | optional | Promotion code that the rate plan is derived from. Pattern : ^[A-Z0-9]{1,6}$ Example : "string" |
string |
ratePlanCategory | optional | Example : RatePlanCategory-DcShop |
RatePlanCategory-DcShop |
ratePlanCode | optional | A rate plan. May describe any of the following: SRP, Rate levels (0-9) Pattern : ^[A-Z0-9]{2,6}$ Example : "string" |
string |
ratePlanDesc | optional | Rate plan description. The first line of the rateplan description is the rateplan name. Example : [ "string" ] |
< string > array |
ratePlanOrder | optional | Rate Plan Disply Order Example : 0 |
integer |
serviceChargePeriods | optional | Example : ServiceChargePeriod-DcShop |
< ServiceChargePeriod-DcShop > array |
serviceChargesAndTaxesIncluded | optional | Indicates if service charges and taxes are included in the rates Example : true |
boolean |
DcShopRoomRate-DcShop
Polymorphism : Composition
amountAfterTax | optional | The total amount including all associated taxes and service charges. Does not include crib or rollaway charges. Example : 0.0 |
number(double) |
amountBeforeTax | optional | The total amount not including any associated taxes or service charges. Does not include crib or rollaway charges. Example : 0.0 |
number(double) |
amountWithFees | optional | Amount for the stay including service charges. Calculated as sum of amountBeforeTax and service charge, rounded up to rate plan currency precision. Example : 0.0 |
number(double) |
averageRate | optional | Average rate for the stay. Calculated by dividing amountBeforeTax by length of the stay, rounded up to rate plan currency precision. Example : 0.0 |
number(double) |
averageRateAfterFees | optional | Average rate for the stay including service charges. Calculated by dividing sum of amountBeforeTax and service charge by length of the stay, rounded up to rate plan currency precision. Example : 0.0 |
number(double) |
averageRateAfterTax | optional | Average rate for the stay including taxes and service charges. Calculated by dividing amountAfterTax by length of the stay, rounded up to rate plan currency precision. Example : 0.0 |
number(double) |
bookingCode | optional | GDS booking code Pattern : ^[A-Z0-9]{6}$ Example : "string" |
string |
chargeTotals | optional | Example : CategoryTotal-DcShop |
< CategoryTotal-DcShop > array |
cribRate | optional | Daily crib rate Example : 0.0 |
number(double) |
depositAmount | optional | Deposit Amount Example : 0.0 |
number(double) |
meals | optional | Example : MealsIncluded-DcShop |
MealsIncluded-DcShop |
merchantTotalAmount | optional | Total to indicate to OTA partners the total amount they need to collect during shopping. Minimum value : 0.0 Example : 0.0 |
number(double) |
numRoomsAvail | optional | Number of rooms available in inventory Example : 0 |
integer(int64) |
rateAmount | optional | Rate amount value determined by the displayRateType field in the request Example : 0.0 |
number(double) |
rateChangeIndicator | optional | Indicates if a rate changes occurs during the stay Example : true |
boolean |
rateDetails | optional | Example : DcShopRateDetail-DcShop |
< DcShopRateDetail-DcShop > array |
ratePlanCode | optional | A rate plan. May describe any of the following: SRP, Rate levels (0-9) Pattern : ^[A-Z0-9]{2,6}$ Example : "string" |
string |
rollawayRate | optional | Daily roll-away rate Example : 0.0 |
number(double) |
roomTypeCode | optional | Room Type Code Pattern : ^[A-Z0-9]{2,6}$ Example : "string" |
string |
serviceChargeDesc | optional | Service charge description Example : "string" |
string |
serviceChargesInTaxCalc | optional | Indicates if the service charges are included in the tax calculation. Example : true |
boolean |
totalServiceCharges | optional | Total service charges for the stay. If rate plan is tax inclusive, this value will be 0.0. Example : 0.0 |
number(double) |
totalTaxes | optional | Total taxes for the stay. If rate plan is tax inclusive, this value will be 0.0. Example : 0.0 |
number(double) |
DcShopRoomType-DcShop
adaAccessibleRoom | optional | Indicates if room is marked as ADA accessible. Example : true |
boolean |
bedType | optional | Example : RoomBedType-DcShop |
RoomBedType-DcShop |
crsRoomTypeCode | optional | CRS room type code, populated for GDS channels only. Pattern : ^[A-Z0-9]{2,6}$ Example : "string" |
string |
extraBedPermitted | optional | Indicates if an extra bed is permitted in the the room. Example : true |
boolean |
extraPersonsAllowed | optional | Indicates whether or not a room can have extra guests. Example : true |
boolean |
numBeds | optional | Indicates the number of beds in the room. Minimum value : 0 Example : 0 |
integer |
roomDisplayOrder | optional | Sequential integer indicating the room display order Example : 0 |
integer |
roomOccupancy | optional | The maximum allowed occupancy of the room Example : 0 |
integer |
roomTypeCode | optional | Room Type Code Pattern : ^[A-Z0-9]{2,6}$ Example : "string" |
string |
roomTypeDesc | optional | Room Type Description Example : [ "string" ] |
< string > array |
smokingRoom | optional | Indicates smoking is allowed or has been requested. Example : true |
boolean |
ErrorDetail-DcShop
code | required | Example : 0 |
integer |
context | required | Example : "string" |
string |
message | required | Example : "string" |
string |
notifications | optional | Example : ErrorNotification-DcShop |
< ErrorNotification-DcShop > array |
ErrorNotification-DcShop
code | optional | Error Notification Code or identifier Example : "string" |
string |
fields | optional | Example : [ "string" ] |
< string > array |
message | required | Example : "string" |
string |
otaErrorCode | optional | Online travel agency error code. Example : 0 |
integer |
MealsIncluded-DcShop
Defines which meals are included with this rate plan
breakfast | optional | Does the restaurant serve breakfast Example : true |
boolean |
dinner | optional | Does the restaurant serve dinner Example : true |
boolean |
lunch | optional | Does the restaurant serve lunch Example : true |
boolean |
mealPlan | optional | Meal plan Pattern : [A-Z0-9]{1} Example : "string" |
string |
MultiPropDcShop-DcShop
arrivalDate | required | The arrival date as defined by full-date - RFC3339 (YYYY-MM-DD). Example : "string" |
string(date) |
childAges | optional | Child Age Min Items : 1 Max Items : 8 Example : [ 0 ] |
< integer > array |
departureDate | required | The departure date as defined by full-date - RFC3339 (YYYY-MM-DD). Example : "string" |
string(date) |
displayCurrency | optional | ISO 4217 standard currency code Pattern : ^[A-Z]{3}$ Example : "string" |
string |
maxRateQualifier | optional | The maximum rate qualifier element filters room types based on the rate. Example : 0.0 |
number(double) |
minRateQualifier | optional | The minimum rate qualifier element filters room types based on the rate. Example : 0.0 |
number(double) |
numAdults | required | The number of adults per room. Minimum value : 0 Example : 0 |
integer |
numChildren | optional | The number of children per room. Minimum value : 0 Example : 0 |
integer |
primaryGdsCode | optional | The primary GDS code identifies a Global Distribution System (GDS). Pattern : ^[A-Z0-9]{2}$ Example : "string" |
string |
promoCode | optional | Promotion code that the rate plan is derived from. Pattern : ^[A-Z0-9]{1,6}$ Example : "string" |
string |
props | required | Unique Items : true Min Items : 1 Max Items : 30 Example : DcShopProperty-DcShop |
< DcShopProperty-DcShop > array |
pseudoCityCode | optional | Identification code of office/agency of a GDS Pattern : ^[A-Z0-9]{1,16}$ Example : "string" |
string |
ratePlanCandidates | optional | Min Items : 1 Max Items : 20 Example : RatePlanCandidate-DcShop |
< RatePlanCandidate-DcShop > array |
roomAmenities | optional | Unique Items : true Min Items : 1 Max Items : 5 Example : RoomAmenity-DcShop |
< RoomAmenity-DcShop > array |
secondaryGdsCode | optional | The secondary GDS code. Pattern : ^[A-Z0-9]{2}$ Example : "string" |
string |
travelAgentId | optional | Travel Agent Client Id Pattern : ^[A-Z0-9]{1,22}$ Example : "string" |
string |
PeriodType-DcShop
Period Type.
Type : enum (perNight, perStay)
PropDcShop-DcShop
adultAge | optional | Minimum age of person considered an adult Minimum value : 0 Example : 0 |
integer |
ageBasedPricing | optional | Indicates that property participates in age-based pricing Example : true |
boolean |
arrivalDate | optional | The arrival date as defined by full-date - RFC3339 (YYYY-MM-DD). Example : "string" |
string(date) |
brandCode | optional | Brand Code Pattern : ^[A-Z]{2}$ Example : "string" |
string |
childAgeRanges | optional | Array of child age ranges defined for the property, returned in order from youngest to oldest. The rate for each age range can be determined by indexing into the childRates array with the same array index value for that particular range. Max Items : 6 Example : ChildAgeRange-DcShop |
< ChildAgeRange-DcShop > array |
childAges | optional | Child Age Max Items : 8 Example : [ 0 ] |
< integer > array |
clientAccounts | optional | Key/Value HashMap of clientId = { ClientAccount Object }. Please refer to the ClientAccount object for attribute details. Example : AvailClientAccount-DcShop |
AvailClientAccount-DcShop |
currencyCode | optional | ISO 4217 standard currency code Pattern : ^[A-Z]{3}$ Example : "string" |
string |
departureDate | optional | The departure date as defined by full-date - RFC3339 (YYYY-MM-DD). Example : "string" |
string(date) |
gdsChainCode | optional | GDS chain code Pattern : ^[A-Z]{2}$ Example : "string" |
string |
highRate | optional | Highest available rate Example : 0.0 |
number(double) |
lengthOfStay | optional | Length of Stay Maximum value : 90 Example : 0 |
integer |
lowRate | optional | Lowest available rate Example : 0.0 |
number(double) |
marketingText | optional | Availability marketing text for specific chain and airline, returned only for GDS transactions. Example : [ "string" ] |
< string > array |
numAdults | optional | The number of adults per room. Minimum value : 0 Example : 0 |
integer |
numChildren | optional | The number of children per room. Minimum value : 0 Example : 0 |
integer |
propCode | optional | Property Code Pattern : ^[A-Z0-9]{2,6}$ Example : "string" |
string |
propName | optional | property short name Example : "string" |
string |
ratePlans | optional | Key/Value HashMap of ratePlanCode = { RatePlan Object }. Please refer to the RatePlan object for attribute details. Example : DcShopRatePlan-DcShop |
DcShopRatePlan-DcShop |
roomRates | optional | Example : DcShopRoomRate-DcShop |
< DcShopRoomRate-DcShop > array |
roomTypes | optional | Key/Value HashMap of roomTypeCode = { RoomType Object }. Please refer to the RoomType object for attribute details. Example : DcShopRoomType-DcShop |
DcShopRoomType-DcShop |
statusCode | optional | Status code for this property Example : 0 |
integer |
statusMessage | optional | Status message for this property Example : "string" |
string |
taxPeriods | optional | Example : TaxPeriod-DcShop |
< TaxPeriod-DcShop > array |
RatePlanCandidate-DcShop
ratePlanCategory | required | Example : RatePlanCategory-DcShop |
RatePlanCategory-DcShop |
ratePlanId | optional | A special ID code that is associated with the ratePlanCategory. Examples are Corporate ID. Pattern : ^[A-Z0-9]{1,30}$ Example : "string" |
string |
RatePlanCategory-DcShop
Each code is associated with one or more Hilton rate plans.
Type : enum (association, club, family, government, military, weekend, promotional, rack, corporate, seniorCitizen, tour, travelIndustry, package, convention, netRates, token)
RoomAmenity-DcShop
The room amenities array, when used, will restrict the availability search so that only room types that match the list of attributes will be included in the response.
Type : enum (accessibleRoom, smoking, nonSmoking, cribs, rollawayBed)
RoomBedType-DcShop
Bed Type
Type : enum (double, king, queen, twin)
ServiceCharge-DcShop
amount | optional | Service Charge Amount Example : 0.0 |
number(double) |
basis | optional | Example : BasisType-DcShop |
BasisType-DcShop |
period | optional | Example : PeriodType-DcShop |
PeriodType-DcShop |
type | optional | Example : ServiceChargeType-DcShop |
ServiceChargeType-DcShop |
ServiceChargePeriod-DcShop
charges | optional | Example : ServiceCharge-DcShop |
< ServiceCharge-DcShop > array |
effectiveDate | optional | The effective date as defined by full-date - RFC3339 (YYYY-MM-DD). Example : "string" |
string(date) |
ServiceChargeType-DcShop
Service Charge Type
Type : enum (percent, flat)
Tax-DcShop
amount | optional | Tax amount Example : 0.0 |
number(double) |
basis | optional | Example : BasisType-DcShop |
BasisType-DcShop |
period | optional | Example : PeriodType-DcShop |
PeriodType-DcShop |
type | optional | Example : TaxType-DcShop |
TaxType-DcShop |
TaxPeriod-DcShop
effectiveDate | optional | The effective date as defined by full-date - RFC3339 (YYYY-MM-DD). Example : "string" |
string(date) |
taxes | optional | Example : Tax-DcShop |
< Tax-DcShop > array |
TaxType-DcShop
(percent) = Percentage of tax basis, (flat) = Flat Change, (sum) = % of sum of tax basis and prior tax.
Type : enum (percent, flat, sum)