Booking Search by data_element

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.

Airship can store up to 20 dynamic fields against a booking, and any of these values can be used with the booking search.

Endpoint

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

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.

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.

Query Parameters

Field

Notes

element_01

Dynamic field provided by 3rd party at the point of creating the booking in airship. This is typically the booking reference

element_02

Dynamic field

...

Dynamic field

element_20

Dynamic field

Basic booking search payload

{
    "data": {
            "element_01": "My-Booking-Reference"
    }
}

{
    "current_page": 1,
    "data": [
        {
            "stage_value_status": "Deposit Secured",
            "data_element_01": "My-Booking-Reference",
            "data_element_03": "Large Party",
            "data_element_20": "beef",
            "id": 12116500,
            "account_id": "806",
            "contact_id": "47426742",
            "unit_id": "13835",
            "stage_value": "69",
            "type_id": "51",
            "datetime": "2021-04-27 20:30:00",
            "source_id": "16",
            "party_datetime": "2021-04-27 20:30:00",
            "party_size": "10",
            "deposit_paid": "10.00",
            "hpbr_food": "0.00",
            "hpbr_drink": "0.00",
            "hpbr_entertainment": "0.00",
            "updated_at": "2021-04-27 20:30:00"
        }
    ],
    "first_page_url": "https://api.airship.co.uk/v1/bookings?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://api.airship.co.uk/v1/bookings?page=1",
    "next_page_url": null,
    "path": "https://api.airship.co.uk/v1/bookings",
    "per_page": 100,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

PreviousBooking Search by reference NextBooking Update

Last updated 2 years ago

{
    "current_page": 1,
    "data": [
        {
            "stage_value_status": "Deposit Secured",
            "data_element_01": "My-Booking-Reference",
            "data_element_03": "Large Party",
            "data_element_20": "beef",
            "id": 12116500,
            "account_id": "806",
            "contact_id": "47426742",
            "unit_id": "13835",
            "stage_value": "69",
            "type_id": "51",
            "datetime": "2021-04-27 20:30:00",
            "source_id": "16",
            "party_datetime": "2021-04-27 20:30:00",
            "party_size": "10",
            "deposit_paid": "10.00",
            "hpbr_food": "0.00",
            "hpbr_drink": "0.00",
            "hpbr_entertainment": "0.00",
            "updated_at": "2021-04-27 20:30:00"
        }
    ],
    "first_page_url": "https://api.airship.co.uk/v1/bookings?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://api.airship.co.uk/v1/bookings?page=1",
    "next_page_url": null,
    "path": "https://api.airship.co.uk/v1/bookings",
    "per_page": 100,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}