Manage Rate Plan

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

The following table provides a quick overview of which POST body elements are supported for the Default Rate type and which are supported for the Group type:

Post Body Parameters

The following table describes the parameters to include in your post request. To make the response structure easier to follow, this table prefixes every element with the object and array structure that contains it, like this: ArrayOne.ArrayTwo.ArrayThree.Element:

Post Body Example

The following is an example of the body for this post request:

{
  "Attributes": {
    "accrual": false,
    "allowSingleUseCreditCards": false,
    "bestOnlyRatesExcluded": false,
    "barApplies": false,
    "breakfastIncluded": true,
    "commissionable": false,
    "controlledLocallyOnly": false,
    "credentialRequired": false,
    "excludeFromAvailRatesPush": true,
    "isMandatory": false,
    "isNegotiated": false,
    "lastRoomAvailable": false,
    "managedBookingPolicy": false,
    "managedCancelPolicy": false,
    "managedRateSeason": false,
    "mapAsNegotiatedRateGDSIDS": false,
    "redeemable": false,
    "restrictPricingUpdate": true,
    "secondaryRateNotAllowed": false,
    "suppressed": false,
    "taxInclusiveByDefault": false,
    "useProductAllocation": false,
    "restrictInPropertyHub": false
  },
  "BookingPolicy": {
    "code": "GUA"
  },
  "CancelPolicy": {
    "code": "1D"
  },
  "ChannnelList": [
    {
      "code": "WEB",
      "confidential": true,
      "action": "AddEdit"
    }
  ],
  "CommissionPolicy": {
    "code": "CP"
  },
  "CompanyProfile": {
    "Chain": {
      "id": 1000
    },
    "CompanyProfileList": [
      {
        "code": "Aven",
        "action": "AddEdit",
        "level": "Chain"
      }
    ]
  },
  "ControlTypeList": [
    {
      "type": "MinimumStayThrough"
    }
  ],
  "Criteria": {
    "code": "grpRt",
    "hotel": {
      "id": 13098
    },
    "chain": {
      "id": 8001027
    },
    "brand": {
      "id": 8002801
    },
    "id": "112413B0-1C0B-42A9-B677-72CE18F05E35",
    "type": "Default"
  },
  "GroupHeader": {
    "alias": "SmithWedding",
    "bookingMethodCode": "META",
    "contactID": "C6E50D08-38BD-45CD-A201-C3C9B10B7RFD",
    "externalCateringCode": "RC3",
    "statusFollowupDate": "2021-12-10T18:25:43.511Z"
  },
  "GroupContactInfo": {
    "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": "Mc",
    "namePrefix": "Mr.",
    "primaryPhone": "555-123-1234",
    "secondaryPhone": "555-123-1235",
    "url": "https://mywebsite.com/"
  },
  "GroupPaymentMethod": {
    "type": "Cash",
    "Payments": [
      {
        "type": "Cash",
        "Primary": true,
        "DirectBill": {
          "AccountNumber": "8365920440",
          "ProjectNumber": "112234"
        },
        "PaymentCard": {
          "CardCode": "VI",
          "CardNumber": "4111111111111111",
          "ExpireDate": "1229",
          "CardHolder": "Guest Name",
          "Token": "cjzHiunsdfjnkkIbgoinN",
          "ConsentToStoreCardData": false
        }
      }
    ]
  },
  "Header": {
    "active": true,
    "categoryCode": "NEG",
    "class": "Unassigned",
    "rateTypeUse": "DailyRate",
    "code": "grpRt2",
    "redemptionType": "NonRedeemable",
    "pointAndCashLevel": "5PCT",
    "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"
  },
  "Hurdle": {
    "code": "Rt101"
  },
  "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"
  },
  "RoutingList": [
    {
      "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",
    "namePrefix": "Mr.",
    "primaryPhone": "555-123-1234",
    "secondaryPhone": "555-123-1235",
    "url": "https://mywebsite.com/"
  },
  "GroupStatus": {
    "status": "Tentative",
    "CancelReason": {
      "code": "CXLOne"
    }
  },
  "TaxList": [
    {
      "code": "ServiceTax",
      "action": "AddEdit"
    }
  ],
  "PackageList": [
    {
      "code": "pkg",
      "action": "AddEdit"
    }
  ],
  "GroupSource": {
    "channelCode": "G360"
  }
}

Response

The success response for this endpoint is:

200 OK

▲ Back to top

DELETE a rate or group rate #

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

[DELETE] /v1/api/admin/product/ratePlan

Delete Body Parameters

The following table describes the parameters to include in your delete request:

Delete Body Example

The following is an example of the body for this post request:

{
  "code": "grpRt",
  "hotelid": 13098
}

Response

The success response for this endpoint is:

200 OK

▲ Back to top