Manage Rate Plan

SynXis CRS
Rates
Groups
REST API
CRS Administration

What is it?

With the Manage Rate Plan API, hoteliers can create, edit, and delete rate or group headers for a specified hotel and code.

Before You Begin

  • You must authenticate before you can use this API. For full instructions, see Authentication for the REST APIs.
  • At any time, you can go to this API's Reference Documentation tab, where you can make test calls with the following endpoints.

Create or Update This Content

You can create or update the following Content for a Rate or a Group:

Header: The Header section takes the header information common to both rate and group, such as the following:

  • Rate/Group Name
  • Short/Long Description
  • Currency Code
  • PMS code
  • PMS group code
  • Group from rate code: The groupFromRateCode parameter specifies the rate code from which the Group is based. Configuration from that rate is copied to the Group. The rate must be enabled for Use with Groups (useWithGroups). This is applicable only for Group creation.

Group Header: The Group Header section applies to only groups. It includes group information, such as the following:

Sales Manager: The Sales Manager section applies to only groups. It includes contact information for the sales manager, such as the following:

  • Contact name
  • Primary/secondary phone
  • Address

Attributes: The Attributes section includes attributes for a particular rate or group, such as the following:

  • Accrual
  • Bar Applies
  • Breakfast Included
  • Exclude from the Availability, Rates and Inventory Push, etc.
  • Last Room Available
  • Negotiated
  • Redeemable
  • Restricted Pricing Updates
  • Suppress rate
  • Redeemable
  • Tax Inclusive

Translations: The Translations section manages the channelize and language translations, such as the following:

  • Rate/Group Name
  • Short/Long Description

Market Segments: The Market Segments section includes the market segments that are assigned or unassigned to the rate or group.

Market Sources: The Market Sources section includes the market sources that are assigned or unassigned to the rate or group.

Routing Code: The Routing Code section assigns or clears the routing code assignments (routing code and folio number).

Group Payment Method: The Group Payment Method section defines the Group Payment Method (cash, check, credit card, direct bill). It applies only to a group.

Individual Payment Method: The Individual Payment Method section defines the individual payment method (whether the group pays some, all, or none). It applies only to a group.

For creating, editing or deleting, be sure to choose the correct rate plan type, because rates or groups have their own sets of elements containing information associated to them. For example, Sales Manager or Group Header are not available for default rate type.

Use Get Rates with this API

To fully manage rates and group rates, use the Get Rates endpoint in conjunction with this API's endpoints:

  • Use [GET] /hotel/rates to retrieve rate and group information, as detailed here.
  • Use [POST] /admin/product/ratePlans/ to create or update rates or groups.
  • Use [DELETE] /admin/product/ratePlans/ to delete rates or groups.

How to use

This section covers the endpoints for this API and examples of how to use them.

POST a rate or group rate

This endpoint enables you to create or update a rate or a group rate.

[POST] /v1/api/admin/product/ratePlans
{
  "Attributes": {
    "accrual": false,
    "barApplies": false,
    "breakfastIncluded": true,
    "controlledLocallyOnly": false,
    "excludeFromAvailRatesPush": true,
    "isNegotiated": false,
    "lastRoomAvailable": false,
    "redeemable": false,
    "restrictPricingUpdate": true,
    "suppressed": false,
    "taxInclusiveByDefault": false
  },
  "Criteria": {
    "code": "grpRt",
    "hotel": {
      "id": 13098
    },
    "type": "Group"
  },
  "GroupHeader": {
    "alias": "SmithWedding",
    "bookingMethodCode": "META",
    "contactID": "C6E50D08-38BD-45CD-A201-C3C9B10B7RFD",
    "externalCateringCode": "RC3",
    "status": "Tentative"
  },
  "GroupPaymentMethod": {
    "type": "Cash"
  },
  "Header": {
    "active": true,
    "categoryCode": "NEG",
    "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.",
    "groupFromRateCode": "ratecode"
  },
  "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": "LEISURE"
  },
  "MarketSource": {
    "code": "REFERRAL"
  },
  "Routing": {
    "folioNumber": "01",
    "routingCode": "ABA"
  },
  "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",
    "primaryPhone": "555-123-1234",
    "secondaryPhone": "555-123-1235",
    "url": "https://mywebsite.com/"
  }
}

DELETE a rate or group rate

This endpoint enables you to delete a rate or a group rate.

[DELETE] /v1/api/admin/product/ratePlan
{
  "code": "grpRt",
  "hotelid": 13098
}