Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

Code Block
languagejson
{
    "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.

...