Manage Rate Plan

The Manage Rate Plan operations allow a hotelier to create or edit a rate or group rate.

REST API Tokens

How to Construct and Use security tokens

 

REST Method/Endpoint

MethodEndpoint
POSThttps://[environment]/v1/api/admin/product/ratePlans/

 

Header Parameters

ParameterDescriptionType
ContextBusiness context for callerString
ActivityIDUnique Id per request for system tracingString

 

Request

 

Attributes

Attributes are specific configurations that applies to a rate or group.

ParameterDescriptionType
accrualIf true, indicates that the rate is eligible for the accrual of loyalty points.boolean
allowSingleUseCreditCardsIf true, indicates that the rate allows single use credit cardboolean
bestOnlyRatesExcludedIf true, indicates that the rate is excluded from best only product shopping results.boolean
barAppliesIf true, indicates that the rate applies to BAR.boolean
breakfastIncludedIf true, indicates that breakfast is included in the rate.boolean
commissionableIndicates that commissionable policy applies. This will be set to active (true) when rate commission policy code is specified.boolean
controlledLocallyOnlyIf true, indicates that the rate can only be managed in the CR.boolean
credentialRequiredIf true, indicates that credential is required for this rate.boolean
excludeFromAvailRatesPushIf true, indicates that the rate should be excluded from the Availability, Rates and Inventory Push to OTAs and partners.boolean
isNegotiatedIf true, indicates that the rate is a corporate negotiated rate.boolean
lastRoomAvailableIf true, indicates that the rate plan will remain open as long as there is room inventory available at the property.boolean
managedBookingPolicyIf true, indicates that booking or guarantee policy will be managed in CRS.boolean
managedCancelPolicyIf true, indicates that cancellation policy will be managed in CRS.boolean
managedRateSeasonIf true, indicates that seasonal rates will be managed in CRS.boolean
mapAsNegotiatedRateGDSIDSIf true, indicates that the rate should be considered confidential in the GDS/IDS. Suggest use is for Channel Connect Public rates that you want to sell as a Negotiated Rate in the GDS/IDS.boolean
redeemableIf true, indicates that the rate is eligible for loyalty point redemption.boolean
restrictPricingUpdateIf true, indicates that only users with specific access can edit the rate.boolean
secondaryRateNotAllowedIf true, indicates that the rate is only available as primary in multiple rate reservations.boolean
suppressedIf true, indicates that the rate does not display price values during availability checks in the SynXis Booking Engine, SynXis Voice Agent or guest emails.boolean
taxInclusiveByDefaultIf true, indicates that taxes are included in the rate for all room types.boolean
useProductAllocationIf true, indicates that the rate uses product allocation or merchant flag is on.boolean

 

{
    "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": false
    }
}

 

Basic Information

ParameterDescriptionType
codeCode that uniquely identifies a rate or group.string
hotel/@idCode that uniquely identifies a single hotel property in Control Center.integer
typeIndicates the rate type (default rate or group). 
Values: Values: Default, Group		string

 

{
  "Criteria": {
    "code": "grpRt",
    "hotel": {
      "id": 13098
    },
    "type": "Default"
  }
}

Booking Policy

{
  "BookingPolicy": {
    "code": "GUA"
  }
}

Cancel Policy

{
  "CancelPolicy": {
    "code": "1D"
  }
}

Commission Policy

{
  "CommissionPolicy": {
    "code": "CP"
  }
}

Company

{
  "CompanyProfile": {
    "Chain": {
      "id": 1000
    },
    "CompanyProfileList": [
      {
        "code": "Sabre",
        "action": "AddEdit"
      }
    ]
  }
}

Control Type

{
  "ControlTypeList": [
    {
      "type": "MinimumStayThrough"
    }
  ]
}

Group Header

{
  "GroupHeader": {
    "alias": "SmithWedding",
    "bookingMethodCode": "META",
    "contactID": "C6E50D08-38BD-45CD-A201-C3C9B10B7RFD",
    "externalCateringCode": "RC3"
  }
}

Group Status

{
  "GroupStatus": {
    "status": "Tentative",
    "CancelReason": {
      "code": "CXLOne"
    }
  }
}

Header

{
  "Header": {
    "active": true,
    "categoryCode": "NEG",
    "class": "Association",
    "code": "grpRt2",
    "currencyCode": "USD",
    "longDescription": "If group book is used, call meeting organizer Mr. Amorim 555 634 8146.",
    "name": "Smith Wedding",
    "pmsCode": "SMITH1",
    "pmsGroupCode": "SMITHWED",
    "shortDescription": "Wedding party.",
    "specialInstructions": "Group would like all rooms on the same floor."
  }
}

Hurdle

{
  "Hurdle": {
    "code": "Rt101"
  }
}

Multi-Lingual Content

{
  "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"
    }
  ]
}

Market Segment

{
  "MarketSegment": {
    "code": "LEISURE"
  }
}

Market Source

{
  "MarketSource": {
    "code": "REFERRAL"
  }
}

Packages

Add or Remove Static Packages from a Rate Plan.

{
  "PackageList": [
    {
      "code": "pkg",
      "action": "AddEdit"
    }
  ]
}

Payment

{
  "GroupPaymentMethod": {
    "type": "Cash"
  },
  "IndividualPaymentMethod": {
    "type": "GroupPaysAll"
  }
}

Routing List

Note: This content only applies to SynXis Property Hub.

{
  "RoutingList": [
    {
      "folioNumber": "01",
      "routingCode": "ABA"
    }
  ]
}

Sales Manager

{
  "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/"
  }
}

Taxes

{
  "TaxList": [
    {
      "code": "ServiceTax",
      "action": "AddEdit"
    }
  ]
}