Get Rate and Room Mapping

1 Overview
2 Request
- 2.1 Sample
3 Response
- 3.1 Sample

Overview

The getRateRoomMapping will return a list of rate/room mapping for the specified siteIDList.

Request

Element	Type	Description
siteIDList	Array	An optional list of property IDs for which rate/room mapping should be returned. If provided, this must be a subset of properties that are enabled for your API. Alternatively, exclude this attribute from the request to get mapping info for every property enabled for your API

Sample

{
    "userAuth": {
        "username": "username",
        "password": "password"
    },
    "operation": "getRateRoomMapping",
    "siteIDList": [
        1853
    ]
}

Response

Element				Type	Description
siteList				Array	The siteList array will contain an entry for each site as requested in the siteIDList section of the request
	siteID			String	The internal siteID of the property in the IBE.
	primaryName			String	Property name.
	timezone			String	The timezone the property is configured in.
	rates			Array	A list of rates available for this property.
		rateID		Integer	The internal rateID of the rate in the IBE.
		rateCode			The internal code of the rate in the IBE.
		externalRateCode			The external code of the rate in the IBE.
		externallyManaged		String	An indicator of whether or not this rate can be managed by a third party system.
		status		String	The internal status of this rate.
		rooms		Array	A list of rooms mapped to this rate.
			roomID	Integer	The internal roomID of this room in the IBE.
			roomCode	String	The internal code of this room in the IBE.
	upsells			Array	A list of upsells available for this property.
		upsellGroupID		Integer	The internal groupID of this upsll group in the IBE.
		upsellGroupName			The name of the upsell group.
		status			The internal status of the upsell group.
		upsellItems		Array	A list of upsell items within this upsell group.
			upsellItemID		The internal itemID for this upsell item in the IBE.
			upsellItemName		The name of the upsell item.
			externalUpsellCode		The external code for this upsell item.
			status		The status of the upsell item.

Sample

{
  "siteList": [
    {
      "siteID": "1853",
      "primaryName": "TestHotel Mahony",
      "timezone": "Europe/Dublin",
      "rates": [
        {
          "rateID": 4208974,
          "rateCode": "BARRO",
          "externalRateCode": "BARRO",
          "externallyManaged": false,
          "status": "active",
          "rooms": [
            {
              "roomID": 4194373,
              "roomCode": "SGL"
            },
            {
              "roomID": 4194374,
              "roomCode": "DBL"
            }
          ]
        },
        {
          "rateID": 4208975,
          "rateCode": "BARBB",
          "externalRateCode": "BARBB",
          "externallyManaged": false,
          "status": "active",
          "rooms": [
            {
              "roomID": 4194373,
              "roomCode": "SGL"
            },
            {
              "roomID": 4194374,
              "roomCode": "DBL"
            }
          ]
        },
      ],
      "upsells": [
        {
          "upsellGroupID": 8796093050082,
          "upsellGroupName": "Afternoon Tea",
          "status": "active",
          "upsellItems": [
            {
              "upsellItemID": 8796093050083,
              "upsellItemName": "Afternoon Tea at 13:00",
              "externalUpsellCode": "TEA1",
              "status": "active"
            },
            {
              "upsellItemID": 8796093050084,
              "upsellItemName": "Afternoon Tea at 14:00",
              "externalUpsellCode": "TEA2",
              "status": "active"
            },
            {
              "upsellItemID": 8796093050085,
              "upsellItemName": "Afternoon Tea at 15:00",
              "externalUpsellCode": "TEA3",
              "status": "active"
            }
          ]
        }
      ]
    }
  ]
}