OWownerrez
Bookings

Create a new booking.

Changed on
post/v2/bookings

Request

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

Request body

adultsinteger

The number of adults on this booking. At least 1 is required when generate_charges is true, because per-person rates, taxes, and guest-count surcharges are all calculated from the guest counts.

arrivalstring date

Arrival date in property time zone in yyyy-MM-dd format, e.g. 2024-10-31.

check_instring nullable

Check-in time in property time zone in 24 hour HH:mm format, e.g. 16:00. Not supported for blocks.

check_in_endstring nullable

Check-in end time in property time zone in 24 hour HH:mm format, e.g. 21:00 (optional). Not supported for blocks.

check_outstring nullable

Check-out time in property time zone in 24 hour HH:mm format, e.g. 09:00. Not supported for blocks.

childreninteger

The number of children on this booking.

cleaning_datestring date-time nullable

Scheduled cleaning date and time in property time zone.

departurestring date

Departure date in property time zone in yyyy-MM-dd format, e.g. 2024-10-31.

generate_chargesboolean

Whether to calculate the property's default charges. On create they are added to the new booking; on update they replace the booking's existing charges. Default is false. Not supported for blocks, and requires adults to be at least 1, since the charges are calculated from the guest counts. On create it also enforces the property's rules (maximum occupancy, minimum and maximum nights).

guest_idinteger nullable

The contact related to this booking. Required for bookings, not allowed for blocked-off times. An owner booking's contact is set by OwnerRez and changes only with its owner, so creating one with guest_id, or changing guest_id afterwards, returns a validation error.

infantsinteger

The number of infants on this booking.

is_blockboolean

Deprecated: use type instead. If this booking is a simple blocked-off time booking (true), or a full guest booking (false).

listing_site_idinteger nullable

The listing site this booking is attributed to. Use the Id from the listing sites endpoints.

notesstring nullable

Internal notes for this booking.

petsinteger

The number of pets on this booking.

property_idinteger

The Id of the property for this booking.

titlestring nullable

Title or label for this booking. Typically used for blocked-off times.

type'booking' | 'block' | 'quote_hold' | 'linked_availability' | 'owner'

Response

A model representing the booking created.

idinteger

The ID of this record.

tagsstring[]

A collection of tag names.

adultsinteger
arrivalstring date

Arrival date in property time zone.

booked_utcstring date-time nullable
canceled_utcstring date-time nullable
cancellation_policy_descriptionstring
cancellation_policy_idinteger nullable
check_instring

Check-in time in property time zone in 24 hour HH:mm format, e.g. 16:00.

check_in_endstring

Check-in end time in property time zone in 24 hour HH:mm format, e.g. 21:00 (optional).

check_outstring

Check-out time in property time zone in 24 hour HH:mm format, e.g. 09:00.

childreninteger
cleaning_datestring date-time nullable

Scheduled cleaning date and time in property time zone.

created_utcstring date-time

The date this booking was created in the system.

currency_codestring
departurestring date

Departure date in property time zone.

form_keystring

Public form key for reference in guest form URL's.

guest_idinteger nullable
infantsinteger
is_blockboolean

Deprecated: use type instead. If this booking is a simple blocked-off time booking (true), or a full guest booking (false).

listing_sitestring

The name of the listing site this booking is attributed to.

listing_site_idinteger nullable

The Id of the listing site this booking is attributed to. Use the Id from the listing sites endpoints.

notesstring
owner_idinteger nullable
pending_until_utcstring date-time nullable
petsinteger
platform_email_addressstring

A proxy email address provided by the OTA specifically for this booking.

platform_phone_numberstring

A temporary phone number provided by the OTA specifically for this booking. Null after midnight in the property's time zone 2 days after departure, or when the booking is canceled.

platform_reservation_numberstring

The OTA reservation number, if applicable.

property_idinteger
quote_idinteger nullable
status'active' | 'canceled' | 'pending'
thread_idsinteger[]

Message threads for this booking. Read a thread's messages with GET /v2/messages?threadId={id}.

titlestring
total_amountnumber nullable
total_host_feesnumber nullable
total_owednumber nullable
total_paidnumber nullable
total_refundednumber nullable
type'booking' | 'block' | 'quote_hold' | 'linked_availability' | 'owner'
updated_utcstring date-time nullable

The date this booking was last updated in the system.

Changes

  • 97584999cbe1Revision changes
    • info

      added the optional property / to the response with the status

  • 35db8ad62f61Revision changes
    • breaking

      the request property format changed from date-time to date

    • breaking

      the request property format changed from date-time to date