Skip to main content

RoomOption

Room on a search option (Room proto). Cancel policy lives on the option, not the room.

occupancyRefIdinteger<int32>

Occupancy index matching search criteria

codestring

Mapped / type room code (may be coarse taxonomy)

descriptionstring

Room description

providerCodestring

Provider-native room id

roomPrice object

Price information. Three independent prices coexist: provider cost (net), provider retail (gross/suggested), and the org selling price (markupGross). The org margin configured per connection is applied on top of the provider gross, never on net. When no margin is configured, markupGross equals the provider gross.

netnumber<float>

Provider cost (what the agency pays the supplier).

currencystring

Currency code

bindingboolean

Provider binding flag. When true the provider gross/suggested is the minimum selling price and must be respected (cannot be sold below it).

suggestednumber<float>

Provider suggested retail / minimum selling price (preserved from provider, not overwritten by markup).

grossnumber<float>

Provider retail price before any org markup (falls back to net when the provider does not send a suggested price).

markupGrossnumber<float>

Customer selling price = provider gross + org margin. Equals the provider gross when no margin is configured.

markupNetnumber<float>

Provider net cost plus the org margin amount (mandatory field).

markupCurrencystring

Currency of the markup (usually same as currency)

markupBindingboolean

Indicates if the markup price must be respected (mandatory field).

marginAmountnumber<float>

Org margin amount applied on provider gross (markupGross - gross).

marginPercentnumber<float>

Effective margin percentage applied on provider gross.

marginTypestring

Type of margin applied - FIXED or PERCENTAGE

ratePlan object

Rate plan when provided

codestring
namestring
providerCodestring
promotions object[]
  • Array [
  • codestring
    namestring
    amountstring
  • ]
  • RoomOption
    {
    "occupancyRefId": 0,
    "code": "string",
    "description": "string",
    "providerCode": "string",
    "roomPrice": {
    "net": 0,
    "currency": "string",
    "binding": true,
    "suggested": 0,
    "gross": 0,
    "markupGross": 0,
    "markupNet": 0,
    "markupCurrency": "string",
    "markupBinding": true,
    "marginAmount": 0,
    "marginPercent": 0,
    "marginType": "string"
    },
    "ratePlan": {
    "code": "string",
    "name": "string",
    "providerCode": "string"
    },
    "promotions": [
    {
    "code": "string",
    "name": "string",
    "amount": "string"
    }
    ]
    }