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 update booking payload
  1. Basics
  2. Bookings

Booking Update

PreviousBooking Search by data_elementNextSearch Contact

Last updated 3 years ago

Overview

Airship allows partners to update bookings within the airship platform, to enable booking updates / cancelations / no shows to be updated.

To update a booking, you'll need an Airship booking ID to be passed in the URL, which can be found from the .

Endpoint

https://api.airship.co.uk/v1/bookings/{booking_id}

Configuration

Path Parameters

Field

Notes

booking_id

Headers

Field

Notes

Authentication (bearer token)

Query parameters

The booking fields which can be accepted in this section can be found in the section, with the addition of account_id (required)

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.

Basic update booking payload

{
    "account_id": 3,
    "enquiry_datetime": "2021-04-27 20:30:00",
    "updated_at": "2021-04-27 20:30:00",
    "source_id": 16,
    "party_size": 10,
    "stage_value": 69,
    "type_id": 51,
    "unit_id": 67,
    "party_datetime": "2021-04-27 20:30:00",
    "party_enquirytime": "2021-04-27 21:00:06",
    "deposit_paid": 0.01,
    "hpbr_drink": 0,
    "hpbr_food": 0,
    "hpbr_entertainment": 0,
    "data": {
      "element_01": "My-Booking-Reference",
      "element_03": "juice",
      "element_20": "chicken"
    },
    "notes": [
      {
        "text": "Test note on bookingID",
        "time": "2021-04-27 21:00:06"
      }
    ]
}
{
    "stage_value_status": "Deposit Secured",
    "data_element_01": "My-Booking-Reference",
    "data_element_03": "juice",
    "data_element_20": "chicken",
    "comments": [
        {
            "id": 455628,
            "text": "Test note on bookingID",
            "created_at": "2021-08-13 15:24:54"
        },
        {
            "id": 457554,
            "text": "Test note on bookingID",
            "created_at": "2021-08-26 13:43:49"
        }
    ],
    "id": 12116500,
    "account_id": "3",
    "contact_id": "47426742",
    "unit_id": 67,
    "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": 0.01,
    "hpbr_food": 0,
    "hpbr_drink": 0,
    "hpbr_entertainment": 0,
    "updated_at": "2021-04-27 20:30:00"
}

The booking ID is Airships unique reference for the booking, and represents the booking that you are attempting to update. The booking ID can be found via the endpoint

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. More details on authentication can be found

booking search
Append Booking Data
Booking Search
here