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
booker	True / False, if the contact data being provided is the Booker of the Stay Required field
guest	True / False, if the contact data being provided is the Guest of the Stay Required field
unit_id	The unit_id representing the physical location for which this WIFI interaction relates Required field
provider_id	Unique 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_reference	Unique 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_date	Date/time the stay was created, in the format 'yyyy-mm-dd hh:mm:ss' Required field
checkin_date	Date/time of the stay checkin, in the format 'yyyy-mm-dd hh:mm:ss' Required field
checkout_date	Date/time of the stay checkout, in the format 'yyyy-mm-dd hh:mm:ss' Required field
room_type_id	1 = Basic 2 = Standard 3 = Premium The classification of the room type booked Required field
total_guests	This is a sum of the total guests booked for the stay (adults + children) Required field
total_children	This is the total children booked for the stay
booking_enquiry_source_id	1 = Website 9 = In house 10 = 3rd Party You can also retrieve booking source IDs from the /booking/sources endpoint. Required field
deposit_amount	Deposit paid for Stay
room_gross_value	Gross room value for stay
room_net_value	Net room value for Stay
extras_gross_value	Extras gross value for Stay
extras_net_value	Extras net value for Stay
booking_status_id	1 = Enquiry 2 = Provisional 3 = Confirmed 4 = Checked in 5 = Cancelled 6 = No show 7 = Checked out The latest status for the Stay Required field
room_rate_code	Internal Room Rate Code for the booking
room_package_code	Internal Room Package Code for the booking
used_voucher	If the booking had a voucher associated Boolean, true / false
booking_has_pets	If the booking has pets Boolean, true / false
stay_travel_agent	If the booking was an OTA, what is the travel agent provider? (i.e. Booking.com)

Example Payload

{
"account_id": 3,
"email": "[email protected]",
//...etc...

    "stays": 
          [
            {
              "booker": true,
              "guest": false,
              "provider_id": 3,
              "stay_reference": "my-unique-ref",
              "unit_id": 13822,
              "enquiry_date": "2021-04-27 20:30:00",
              "check_in_date": "2022-02-01 14:30:00",
              "check_out_date": "2021-02-03 10:30:00",
              "room_type_id": 2,
              "total_guests": 4,
              "total_children": 2,
              "booking_enquiry_source_id": 10,
              "deposit_amount": 250,
              "room_gross_value": 400,
              "room_net_value": 400,
              "extras_gross_value": 210,
              "extras_net_value": 210,
              "booking_status_id": 1,
              "room_rate_code": "DBL",
              "room_package_code": "Package-23a",
              "used_voucher": true,
              "booking_has_pets": false,
              "stay_travel_agent": "booking.com",
              "extras": [
                  {
                      "name": "Pets",
                      "reference": "PT",
                      "start_date": "2023-04-28 20:30:00",
                      "end_date": "2023-04-28 20:30:00",
                      "quantity": 4,
                      "price": 400
                  },
                  {
                      "name": "Breakfast",
                      "reference": "Break",
                      "start_date": "2023-04-28 20:30:00",
                      "end_date": "2023-04-28 20:30:00",
                      "quantity": 1,
                      "price": 1000
                  }
              ]
          }
    ]
}

Extras

Extras can now be added to a Booking to allow us to capture any additional products / purchases / upsells.

Field	Notes
name	String description of the extra Required
reference	SKU or product reference number for the extra Required
start_date	Extra start date (use stay checkin date if not applicable) Required
end_date	Extra end date (use stay check out date if not applicable) optional
price	value of the extra(s) in pence Required

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.