Reservation object
The reservation returned by Create a reservation and Get a reservation.
Create a reservation shows a full example.
Fields
| Field | Type | Description |
|---|---|---|
id | UUID | OnSeason reservation ID. Use it to read and cancel the reservation. |
listingID | UUID | OnSeason listing ID. |
unitID | UUID or null | Unit booked, when the listing has units. |
integrationAccountID | UUID | The property's connected PMS account. |
providerReservationID | string | Booking reference in the PMS. Store it for support and reconciliation. |
providerID | string | Listing ID in the PMS. |
parentPropertyID | string or null | Parent property in the PMS, when there is one. |
checkInDate, checkOutDate | string | Stay dates. |
guests | number | Total guests. |
guest | object | Lead guest. email and phone can each be a string or an array of strings. |
adults, children, infants, pets | number | Party breakdown, when available. |
status | enum | Current status. See below. |
source | string | The source sent at booking. |
notes | string | Notes for the host. |
currency | string | Currency of the amounts. |
originalCurrency | string | Currency the reservation was first stored in. |
totalPrice | number | Booked total in currency. |
components | object | basePrice, fees, taxes, discounts, and the optional commission, as price components. |
salesChannel | string | The sales channel the stay was sold on: your channel name in lowercase. |
cancellationPolicy | object | The cancellation terms the stay was booked under. They don't change after booking. |
cancelledBy | enum or null | CHANNEL when you cancelled it through the API. null when it is not cancelled or was cancelled outside the API. |
cancellationCharge | object or null | The charge under the booked terms when you cancelled it through the API. See Cancel a reservation. |
createdAt, updatedAt | date-time | When OnSeason created and last changed the reservation. |
confirmedAt | date-time or null | When the booking was confirmed. |
cancelledAt | date-time or null | When the booking was cancelled. |
Statuses
A reservation you create starts as CONFIRMED. These statuses come from the API itself:
| Status | Meaning |
|---|---|
CONFIRMED | Booked. The only status you can cancel from. |
CANCELLATION_PENDING | You cancelled it, and the booking is being cancelled by hand in a PMS that has no cancellation API. Treat it as cancelled. It moves to CANCELLED once the PMS confirms. |
CANCELLED | Cancelled, through the API or in the PMS. |
OnSeason keeps reservations in sync with the PMS, so a reservation can also move to a status the PMS reports: STAYING, POST_STAY, NO_SHOW, MODIFIED, MOVED, PENDING, INQUIRY, EXPIRED, BLOCKED, or UNKNOWN. Route any status you don't handle to your support team.