Airship Developers
HomeAcademy
  • Welcome
  • Rest API
    • Overview
    • Authentication
    • API Reference
    • Accreditation
  • Basics
    • Contacts
      • Write a contact
      • Append feedback
      • Append purchase history
      • Append booking data
      • Append WiFi data
      • Append Stay data
      • Append Loyalty data
      • Append ticket data
      • Append other PoPs
    • Bookings
      • Booking Search by reference
      • Booking Search by data_element
      • Booking Update
    • Search Contact
      • Search PoPs by contact
      • Search contact by Email, Mobile, Name
      • Search contact by voucher
    • Vouchers
      • Redeem voucher code
      • Check voucher code
      • Create Unique Code Group
    • Anonymous purchase data
      • Add anonymous purchase data
    • Units
    • Postman collection
  • SOAP API (legacy)
    • Overview
Powered by GitBook
On this page
  • Overview
  • Endpoint
  • Configuration
  • Basic booking search payload
  1. Basics
  2. Bookings

Booking Search by reference

Overview

Airship allows partners to query bookings on certain fields. If a booking reference is provided when the data is passed to Airship, then the /bookings endpoint can be used to search for that booking, and return key information about it.

Endpoint

https://api.airship.co.uk/v1/bookings?account_id={account_id}&booking_reference={your_ref}

Configuration

Path Parameters

Field

Notes

account_id

The account ID represents the account that you are searching bookings in. If you are unsure of what your account ID is, ask our support team to confirm.

booking_reference

The booking reference is the reference you have previously provided against the booking. Note, this must have been provided in the booking_reference field when creating the booking

Headers

Field

Notes

Authentication (bearer token)

The authentication token is linked to the account that you are searching bookings in. If you are unsure of what your Authentication token is, ask our support team to confirm.

Basic booking search payload

{
    "booking_contact_id": "87534364",
    "booking_reference": "test-booook1",
    "id": 44922318,
    "account_id": "806",
    "contact_id": "87534364",
    "unit_id": "13835",
    "stage_value": "69",
    "type_id": "51",
    "datetime": "2021-04-27 20:30:00",
    "source_id": "6",
    "party_datetime": "2022-07-20 20:30:00",
    "party_size": "10",
    "deposit_paid": "501.00",
    "hpbr_food": "0.00",
    "hpbr_drink": "0.00",
    "hpbr_entertainment": "0.00",
    "updated_at": "2021-04-27 20:30:00"
}
PreviousBookingsNextBooking Search by data_element

Last updated 1 year ago