Set booking details


set dates

Endpoint

POST https://yourdomain.com/bookyflow/api/booking/set/dates/

Mandatory endpoint.

Dates must be sent in YYYY-MM-DD format

Request Headers

Header Value Required Description
X-BOOKYFLOW-BOOKING-SESSION-ID YOUR_SESSION_ID Yes

Form Data Parameters

Parameter Type Required Description
arrivalDate text Yes
departureDate text Yes

set guest numbers

Endpoint

POST https://yourdomain.com/bookyflow/api/booking/set/guest/numbers

Mandatory endpoint

Must be sent after dates have been sent.

Request Headers

Header Value Required Description
X-BOOKYFLOW-BOOKING-SESSION-ID YOUR_SESSION_ID Yes

Form Data Parameters

Parameter Type Required Description
adults text Yes
children text Yes

set address

Endpoint

POST https://yourdomain.com/bookyflow/api/booking/set/address

Mandatory endpoint.

Validation for this endpoint will confirm that required fields (configured in property configuration) have been populated, and that the country code and region id stored against the booking correspond to country codes and region ids in BookyFlow.

Request Headers

Header Value Required Description
X-BOOKYFLOW-BOOKING-SESSION-ID YOUR_SESSION_ID Yes

Form Data Parameters

Parameter Type Required Description
firstname text Yes
surname text Yes
house text Yes
street text Yes
town text Yes
postcode text Yes
country text Yes
region text Yes
tel_mobile text Yes
email text Yes

set property booking

Endpoint

POST https://yourdomain.com/bookyflow/api/booking/set/property/booking

Mandatory endpoint.

This endpoint will configure the room id/tariff id hatPair automatically. Once it has been visited you will be ready to validate the booking, and then get the booking prices.

Request Headers

Header Value Required Description
X-BOOKYFLOW-BOOKING-SESSION-ID YOUR_SESSION_ID Yes

Form Data Parameters

Parameter Type Required Description
selectedRooms text Yes
`` text Yes

set note

Endpoint

POST https://yourdomain.com/bookyflow/api/booking/set/note/

Optional note field. Notes added are stored against the booking once the booking has been created.

Request Headers

Header Value Required Description
X-BOOKYFLOW-BOOKING-SESSION-ID YOUR_SESSION_ID Yes

Form Data Parameters

Parameter Type Required Description
note text Yes