You should call this API whenever there are changes in the reservation (e.g. dates, owing, room, state changes ...).
The main usage of this API is automating the check-in process by generating PIN and SmartKey. As soon as the state of a reservation is changed to "started", Goki will generate generate them.
For PIN/SmartKey generation, Goki uses your spaceId as explained below. You need to make sure you have provided the getSpaces
endpoint for this to work. You can read more at Keyless Check-in.
Create or Update a Reservation
[environmentBaseUrl]/v1/reservations
It is important to use this API to have a copy of your reservation on Goki. Make sure you call it as soon as there is any update on the reservation.
Body Parameters
Code or number of the reservation in your system.
Booker Info (please read Reservation page)
Reservation state (please read Reservation page)
Goki SpaceID
of the reservation. (If you do not have the Goki SpaceID
can provide parentSpaceId
or spaceId
in pmsMeta
)
Start date of reservation in YYYY-MM-DD format
End date of reservation in YYYY-MM-DD format
Name of the Company that mediated the reservation. (i.e. booking.com)
Name of the Channel manager (i.e. AvailPro, SiteMinder, TravelClick, etc).
Number of the reservation within the Channel (i.e. OTA, GDS, CRS, etc) in case the reservation group originates there (i.e. Booking.com confirmation number).
Owing amount of the reservation.
Currency of the owing amount.
Reservation info in the third-party app. (please read Reservations page)
Reservation successfully changed.
{
"data": {
...ReservationDocument
}
}
Goki parent space not found.
{
"error": {
"code": 5,
"title": "NOT_FOUND",
"status": 404,
"message": "Parent space not found!"
}
}