Append Stay data
Store Hotel Stay Interaction history as you send contact data to us
Overview
Airship can store full hotel stay booking history for each contact.
Having stay data attached to contacts is useful to measure and target recent or lapsed visitors based on their last visit.
Storing Stays
To store stay history, simply append a
stays object to your contact as you send it to us.Field
Notes
bookerTrue / False, if the contact data being provided is the Booker of the Stay
Required field
guestTrue / False, if the contact data being provided is the Guest of the Stay
Required field
unit_idThe unit_id representing the physical location for which this WIFI interaction relates
Required field
provider_idUnique ID for the integration partner. If you are a new integrator, please contact our support team to get a new ID setup
Required field
stay_referenceUnique booking reference for the stay. If the stay_reference has previously been provided by the same provider, we will interoperate this as an update to that Stay
Required field
enquiry_dateDate/time the stay was created, in the format 'yyyy-mm-dd hh:mm:ss'
Required field
checkin_dateDate/time of the stay checkin, in the format 'yyyy-mm-dd hh:mm:ss'
Required field
checkout_dateDate/time of the stay checkout, in the format 'yyyy-mm-dd hh:mm:ss'
Required field
room_type_id1 = Basic
2 = Standard
3 = Premium
The classification of the room type booked
Required field
total_guestsThis is a sum of the total guests booked for the stay (adults + children)
Required field
total_childrenThis is the total children booked for the stay
booking_enquiry_source_id1 = Website
9 = In house
10 = 3rd Party
You can also retrieve booking source IDs from the
/booking/sources endpoint.
Required fielddeposit_amountDeposit paid for Stay
room_gross_valueGross room value for stay
room_net_valueNet room value for Stay
extras_gross_valueExtras gross value for Stay
extras_net_valueExtras net value for Stay
booking_status_id1 = Enquiry
2 = Provisional
3 = Confirmed
4 = Checked in
5 = Cancelled
6 = No show
7 = Checked out
The latest status for the Stay
Required field
Example Payload
1
{
2
"account_id": 3,
3
"email": "[email protected]",
4
//...etc...
5
​
6
"stays": [
7
{
8
"booker": true,
9
"guest": false,
10
"provider_id": 4,
11
"stay_reference": "my-unique-ref-1",
12
"unit_id": 4123,
13
"enquiry_date": "2022-01-01 20:35:00",
14
"check_in_date": "2022-01-28 14:30:00",
15
"check_out_date": "2022-01-29 11:00:00",
16
"room_type_id": 2,
17
"total_guests": 4,
18
"total_children": 2,
19
"booking_enquiry_source_id": 10,
20
"deposit_amount": 250,
21
"room_gross_value": 400,
22
"room_net_value": 400,
23
"extras_gross_value": 210,
24
"extras_net_value": 210,
25
"booking_status_id": 1
26
}
27
]
Copied!
Update bookings
To update a booking, you can pass the same object against a contact - and if we identify the
stay_reference and provider_id against an existing stay, that stay will be updated.Last modified 4mo ago
Copy link