POST https://yourdomain.com/bookyflow/api/booking/set/dates/
Mandatory endpoint.
Dates must be sent in YYYY-MM-DD format
| Header | Value | Required | Description |
|---|---|---|---|
X-BOOKYFLOW-BOOKING-SESSION-ID |
YOUR_SESSION_ID |
Yes |
| Parameter | Type | Required | Description |
|---|---|---|---|
arrivalDate |
text | Yes | |
departureDate |
text | Yes |
POST https://yourdomain.com/bookyflow/api/booking/set/guest/numbers
Mandatory endpoint
Must be sent after dates have been sent.
| Header | Value | Required | Description |
|---|---|---|---|
X-BOOKYFLOW-BOOKING-SESSION-ID |
YOUR_SESSION_ID |
Yes |
| Parameter | Type | Required | Description |
|---|---|---|---|
adults |
text | Yes | |
children |
text | Yes |
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.
| Header | Value | Required | Description |
|---|---|---|---|
X-BOOKYFLOW-BOOKING-SESSION-ID |
YOUR_SESSION_ID |
Yes |
| 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 |
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.
| Header | Value | Required | Description |
|---|---|---|---|
X-BOOKYFLOW-BOOKING-SESSION-ID |
YOUR_SESSION_ID |
Yes |
| Parameter | Type | Required | Description |
|---|---|---|---|
selectedRooms |
text | Yes | |
| `` | text | Yes |
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.
| Header | Value | Required | Description |
|---|---|---|---|
X-BOOKYFLOW-BOOKING-SESSION-ID |
YOUR_SESSION_ID |
Yes |
| Parameter | Type | Required | Description |
|---|---|---|---|
note |
text | Yes |