SpotRates

Create and/or partially update multiple spot rates.

Changed on
patch/v2/spotrates

Request

  • Base URL
    https://api.ownerrez.com
  • URL
    https://api.ownerrez.com/v2/spotrates
  • Auth
    • HTTP bearer
    • or HTTP basic

Request body

amountnumber nullable

The nightly rate. (NULL use seasonal default)

currencystring

The 3-character currency in which the amount is specified.

This field is used only on PATCH. The currency supplied must match the currency configured for the property in OwnerRez. It is not included in responses.

datestring date required

The date on which this spot rate is effective. Forms a unique key along with PropertyId.

is_arrival_disallowedboolean nullable

Disallow arrival. (NULL use season or property rule)

is_departure_disallowedboolean nullable

Disallow departure. (NULL use season or property rule)

is_gap_requiredboolean nullable

Only allow either arrival or departure on this day, not both. If this property is set to true, arrival and departure values will be ignored.

max_nightsinteger nullable

The maximum number of nights. (NULL use season or property rule)

min_nightsinteger nullable

The minimum number of nights. (NULL use season or property rule)

overrides_gap_arrivalboolean nullable

Should the arrival rule apply even if there are gap rules.

overrides_gap_departureboolean nullable

Should the departure rule apply even if there are gap rules.

overrides_gap_min_nightsboolean nullable

Should the minimum number of nights apply even if there are gap rules.

property_idinteger required

The ID of the property to which this spot rate applies. Forms a unique key along with Date.

Response

A collection of models representing the updated spot rates.

amountnumber nullable

The nightly rate. (NULL use seasonal default)

currencystring

The 3-character currency in which the amount is specified.

This field is used only on PATCH. The currency supplied must match the currency configured for the property in OwnerRez. It is not included in responses.

datestring date required

The date on which this spot rate is effective. Forms a unique key along with PropertyId.

is_arrival_disallowedboolean nullable

Disallow arrival. (NULL use season or property rule)

is_departure_disallowedboolean nullable

Disallow departure. (NULL use season or property rule)

is_gap_requiredboolean nullable

Only allow either arrival or departure on this day, not both. If this property is set to true, arrival and departure values will be ignored.

max_nightsinteger nullable

The maximum number of nights. (NULL use season or property rule)

min_nightsinteger nullable

The minimum number of nights. (NULL use season or property rule)

overrides_gap_arrivalboolean nullable

Should the arrival rule apply even if there are gap rules.

overrides_gap_departureboolean nullable

Should the departure rule apply even if there are gap rules.

overrides_gap_min_nightsboolean nullable

Should the minimum number of nights apply even if there are gap rules.

property_idinteger required

The ID of the property to which this spot rate applies. Forms a unique key along with Date.

Changes

    • breaking

      the / request property format changed from date-time to date

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status