Manage Rate Plans
Supported Attributes by Rate Type (Default or Group)
Attribute/Element | Default (Rate) | Group |
---|---|---|
Attributes | Yes | Yes |
Header | Yes | Yes |
BookingPolicy | Yes | Yes |
CancelPolicy | Yes | Yes |
CommissionPolicy | Yes | Yes |
Translations | Yes | Yes |
MarketSegment | Yes | Yes |
MarketSource | Yes | Yes |
RoutingList | Yes | Yes |
GroupStatus | No | Yes |
GroupHeader | No | Yes |
GroupPaymentMethod | No | Yes |
IndividualPaymentMethod | No | Yes |
SalesManager | No | Yes |
Request Message - Create / Update Rate Plan
{
"Criteria": {
"Code": "EMPLOYEEDISC",
"Hotel": {
"Id": 13098
},
"Type": "Default"
},
"Header": {
"Active": true,
"Class": "Promotional",
"CategoryCode": "PROMO",
"CurrencyCode": "USD",
"LongDescription": "Employee Rewards for service.",
"Name": "Employee Rate",
"PmsCode": "EMPLOYAL",
"ShortDescription": "Employee Recognition Rate"
},
"Attributes": {
"Accrual": false,
"AllowSingleUseCreditCards": false,
"BestOnlyRatesExcluded": false,
"BarApplies": false,
"BreakfastIncluded": true,
"Commissionable": false,
"ControlledLocallyOnly": false,
"CredentialRequired": false,
"ExcludeFromAvailRatesPush": true,
"IsNegotiated": false,
"LastRoomAvailable": false,
"ManagedBookingPolicy": false,
"ManagedCancelPolicy": false,
"ManagedRateSeason": false,
"MapAsNegotiatedRateGDSIDS": false,
"Redeemable": false,
"RestrictPricingUpdate": false,
"SecondaryRateNotAllowed": false,
"Suppressed": false,
"TaxInclusiveByDefault": false,
"UseProductAllocation": true
},
"BookingPolicy": {
"code": "GUA"
},
"CancelPolicy": {
"code": "48H"
},
"CommissionPolicy": {
"code": "10H"
},
"GroupPaymentMethod": {
"type": "CreditCard"
},
"IndividualPaymentMethod": {
"Type": "GroupPaysAll"
},
"Translations": [{
"Channel": {
"code": "WEB"
},
"Language": {
"code": "fr-FR"
},
"longDescription": "Récompenses des employés pour le service",
"name": "Tarif employé",
"shortDescription": "Taux de reconnaissance des employés"
}],
"MarketSegment": {
"code": "REWARDS"
},
"MarketSource": {
"code": "EMP"
},
"RoutingList": [{
"FolioNumber": "EMP101",
"RoutingCode": "0201"
}, {
"FolioNumber": "EMP102",
"RoutingCode": "021-2"
}]
}
Request Message - Create/Update a Group Rate
{
"Criteria": {
"Code": "SWedding",
"Hotel": {
"Id": 13098
},
"Type": "Group"
},
"Header": {
"Active": true,
"Class": "Association",
"CategoryCode": "WKSHP",
"CurrencyCode": "USD",
"LongDescription": "If group book is used, call meeting organizer Mr. Amorim 555 634 8146.",
"Name": "Smith Wedding",
"PmsCode": "SMITH1",
"PmsGroupCode": "SMITHWEDGR1",
"ShortDescription": "Smith Wedding party",
"SpecialInstructions": "Group would like all rooms on the same floor."
},
"GroupStatus": {
"status": "Tentative"
},
"GroupHeader": {
"Alias": "SmithWedding1",
"BookingMethodCode": "CASH",
"ExternalCateringCode": "RC3"
},
"Attributes": {
"Accrual": false,
"AllowSingleUseCreditCards": false,
"BestOnlyRatesExcluded": false,
"BarApplies": false,
"BreakfastIncluded": true,
"Commissionable": false,
"ControlledLocallyOnly": false,
"CredentialRequired": false,
"ExcludeFromAvailRatesPush": true,
"IsNegotiated": false,
"LastRoomAvailable": false,
"ManagedBookingPolicy": false,
"ManagedCancelPolicy": false,
"ManagedRateSeason": false,
"MapAsNegotiatedRateGDSIDS": false,
"Redeemable": false,
"RestrictPricingUpdate": true,
"SecondaryRateNotAllowed": false,
"Suppressed": false,
"TaxInclusiveByDefault": false,
"UseProductAllocation": true
},
"BookingPolicy": {
"code": "GUA"
},
"CancelPolicy": {
"code": "48H"
},
"CommissionPolicy": {
"code": "10H"
},
"GroupPaymentMethod": {
"type": "CreditCard"
},
"IndividualPaymentMethod": {
"Type": "GroupPaysAll"
},
"Translations": [
{
"Channel": {
"code": "WEB"
},
"Language": {
"code": "fr-FR"
},
"longDescription": "Si un livre de groupe est utilisé, appeler l'organisateur de la réunion M. Amorim 555 634 8146",
"name": "Mariage Smith",
"shortDescription": "Mariage"
}
],
"MarketSegment": {
"code": "GLEI"
},
"MarketSource": {
"code": "REFERRAL"
},
"SalesManager": {
"contactAddress": {
"addressLine": [
"123 Main St."
],
"city": "Denver",
"country": {
"code": "US"
},
"postalCode": "80012",
"stateProv": {
"code": "CO"
}
},
"email": "larry.walker@email.com",
"fax": "555-123-4567",
"firstName": "Larry",
"lastName": "Walker",
"middleInitial": "W",
"namePrefix": "Mr.",
"primaryPhone": "555-123-1234",
"secondaryPhone": "555-123-1235",
"url": "https://mywebsite.com/"
},
"RoutingList": [{
"FolioNumber": "ABA101",
"RoutingCode": "01101"
}, {
"FolioNumber": "ABA102",
"RoutingCode": "011-2"
}]
}
REST API Tokens
How to Construct and Use security tokens
Header Parameters
Parameter | Description | Type | Example |
---|---|---|---|
Accept-Language | Language code with optional culture code. Use to request content in the specified language. | String | en-US |
Context | Business context for caller | String | WBSVC |
ActivityID | Unique Id per request for system tracing | String | MyCompany_123sdjwiiw456 |