Booking line

The Booking Line object represents the reservation/purchase of a specific activity, service, room or other product from your inventory by one Guest. It holds prices, dates and it's related to Guest and Booking

The Booking line object

{
    "id": 30369743,
    "starts_at": "2024-04-09 14:00:00",
    "ends_at": "2024-04-16 10:00:00",
    "status": "confirmed",
    "slot": 0,
    "qty": 7,
    "product_id": "9d84ae87-4365-4b3f-b337-b054657df53e",
    "package_id": null,
    "booking_id": "3d084b8e-032d-4edc-88f9-e9c15e164a80",
    "guest_id": "98194687-4737-48f8-8edc-540bafde9fd5",
    "cart_id": "ced956e4-281b-4cf3-8918-b40c8e82c04e",
    "currency": "EUR",
    "unit_price_excl_tax": 16.8067,
    "unit_price_incl_tax": 20,
    "total_price_excl_tax": 117.65,
    "total_price_incl_tax": 140,
    "final_price_excl_tax": 100,
    "final_price_incl_tax": 119,
    "discounted_price": 17.65,
    "tax_component": 22.35,
    "discounted_tax": 3.35,
    "discount_total": 21,
    "final_tax_component": 19,
    "cancelled_at": null,
    "created_at": "2024-03-28T16:45:01+00:00",
    "updated_at": "2024-03-29T08:14:49+00:00"
},

id

Unique ID of the person.

starts_at nullable

The start date and time of the booking line. Formatted as "YYYY-MM-DD HH:MM:SS". Null when it's dateless purchase like T-shirt or unscheduled activity.

ends_at nullable

The end date and time of the booking line. Formatted as "YYYY-MM-DD HH:MM:SS". Null when it's dateless purchase like T-shirt or unscheduled activity.

slot nullable

An integer representing the sequence or position of the booking line within calendar. Important for accommodations.

qty

Quantity of the booked item or service.

product_id expandable

A unique identifier for the product associated with this booking line.

package_id nullable, expandable

A unique identifier for the package, if applicable, associated with this booking line.

booking_id expandable

A unique identifier for the booking associated with this booking line.

guest_id expandable

The unique ID of the guest associated with this booking line.

cart_id

A unique identifier for the cart associated with this purchase.

currency

A code representing the currency used for the transaction. In ISO 4217 format.

unit_price_excl_tax

Unit price of the item excluding tax. This is the price for one unit of the item before any taxes are applied.

unit_price_incl_tax

Unit price of the item including tax. This is the price for one unit of the item after all applicable taxes have been added.

total_price_excl_tax

Total price of the items excluding tax. This is the aggregate price of all units of the item before any taxes are applied.

total_price_incl_tax

Total price of the items including tax. This is the aggregate price of all units of the item after all applicable taxes have been added.

final_price_excl_tax

The final price excluding tax, after applying any discounts or adjustments to the total price excluding tax.

final_price_incl_tax

The final price including tax, after applying any discounts or adjustments to the total price including tax.

discounted_price

The value of the discount applied to the original price, not including taxes.

tax_component

The amount of tax that has been added before discount.

discounted_tax

Tax component of discount.

discount_total

The total amount saved due to discounts applied on the total price.

final_tax_component

The amount of tax that has been added after discount.

booking_status

An indicator of the reservation or purchase status, such as confirmed, pending, or cancelled.

cancelled_at nullable

The timestamp indicating when the booking line was cancelled, if applicable. This field can be null if the booking line has not been cancelled.

created_at

The timestamp indicating when the booking line was initially created.

updated_at

The timestamp showing the most recent update made to the booking.

Endpoints

List all booking lines

GET https://api.bookinglayer.io/private/booking_lines

Fetches a list of all booking lines in the system. List can be filtered and sorted by custom parameters.

Query Parameters

Name
Type
Description

expand

string[]

Possible values: product, package, booking

booking_status

string[]

Possible values: draft, request, pending, confirmed, deposit_paid, paid, cancelled, expired, waiting_list

booking_id

uuid[]

Only return booking lines for this bookings.

starts_at

date range

Only return booking lines that starts during the given date range.

start_time*

time

Format "HH:MM"

ends_at

date range

Only return booking lines that ends during the given date range.

end_time*

time

Format "HH:MM"

cancelled_at

date range

Only return booking lines that were cancelled during the given date range.

onsite_at

date range

Only return booking lines that running onsite during the given date range.

product_id

uuid[]

Only return booking lines for this products.

product_type

string[]

Possible values: accommodation, activity, package, service, item, rental, bundle, gift_certificate, donation, transfer

location_id

int[]

Only return booking lines for this locations.

*start_time and end_time filter are useful when we are looking for, for example, activities reserved for a specific time in a given week.

{
    "data": [
        {
            "id": 30369743,
            "starts_at": "2024-04-09 14:00:00",
            "ends_at": "2024-04-16 10:00:00",
            "status": "confirmed",
            "slot": 0,
            "qty": 7,
            "product_id": "9d84ae87-4365-4b3f-b337-b054657df53e",
            "package_id": null,
            "booking_id": "3d084b8e-032d-4edc-88f9-e9c15e164a80",
            "guest_id": "98194687-4737-48f8-8edc-540bafde9fd5",
            "cart_id": "ced956e4-281b-4cf3-8918-b40c8e82c04e",
            "currency": "EUR",
            "unit_price_excl_tax": 16.8067,
            "unit_price_incl_tax": 20,
            "total_price_excl_tax": 117.65,
            "total_price_incl_tax": 140,
            "final_price_excl_tax": 100,
            "final_price_incl_tax": 119,
            "discounted_price": 17.65,
            "tax_component": 22.35,
            "discounted_tax": 3.35,
            "discount_total": 21,
            "final_tax_component": 19,
            "cancelled_at": null,
            "created_at": "2024-03-28T16:45:01+00:00",
            "updated_at": "2024-03-29T08:14:49+00:00"
        }
    ],
    "current_page": 1,
    "from": 1,
    "last_page": 15403,
    "links": {
        "first": "https://api.bookinglayer.io/private/booking_lines?page=1",
        "last": "https://api.bookinglayer.io/private/booking_lines?page=10",
        "prev": "https://api.bookinglayer.io/private/booking_lines?page=3",
        "next": "https://api.bookinglayer.io/private/booking_lines?page=5"
    },
    "path": "https://api.bookinglayer.io/private/booking_lines",
    "per_page": 15,
    "to": 15,
    "total": 231041
}

Fetch a single Person

Fetch a single booking line

GET https://api.bookinglayer.io/private/booking_lines/{booking_line_id}

Fetches a single Booking line from the system.

Path Parameters

Name
Type
Description

booking_line_id*

Int

ID of the desired person

{
    "data": {
        "id": 30369743,
            "starts_at": "2024-04-09 14:00:00",
            "ends_at": "2024-04-16 10:00:00",
            "status": "confirmed",
            "slot": 0,
            "qty": 7,
            "product_id": "9d84ae87-4365-4b3f-b337-b054657df53e",
            "package_id": null,
            "booking_id": "3d084b8e-032d-4edc-88f9-e9c15e164a80",
            "guest_id": "98194687-4737-48f8-8edc-540bafde9fd5",
            "cart_id": "ced956e4-281b-4cf3-8918-b40c8e82c04e",
            "currency": "EUR",
            "unit_price_excl_tax": 16.8067,
            "unit_price_incl_tax": 20,
            "total_price_excl_tax": 117.65,
            "total_price_incl_tax": 140,
            "final_price_excl_tax": 100,
            "final_price_incl_tax": 119,
            "discounted_price": 17.65,
            "tax_component": 22.35,
            "discounted_tax": 3.35,
            "discount_total": 21,
            "final_tax_component": 19,
            "cancelled_at": null,
            "created_at": "2024-03-28T16:45:01+00:00",
            "updated_at": "2024-03-29T08:14:49+00:00"
    }
}

Webhooks

Webhooks are a mechanism for Bookinglayer to notify other apps when something happens in the system. They are described in detail in a dedicated Webhooks document.

BookingLinesCreated

Sends new booking line IDs via a webhook call when a booking line gets created.

{
    "event": "BookingLinesCreated",
    "data": {
        "ids": [30369743, 30369745]
    }
}

BookingLinesUpdates

Sends booking line IDs via a webhook call when an existing booking line gets updated.

{
    "event": "BookingLinesUpdates",
    "data": {
        "ids": [30369743, 30369745]
    }
}

BookingLinesDeleted

Sends deleted booking line IDs via a webhook call when a booking line gets deleted.

    "event": "BookingLinesDeleted",
    "data": {
        "ids": [30369743, 30369745]
    }
}

BookingLinesCancelled

Sends cancelled booking line IDs via a webhook call when a booking line gets cancelled.

    "event": "BookingLinesCancelled",
    "data": {
        "ids": [30369743, 30369745]
    }
}

BookingLinesReinstated

Sends reinstated booking line IDs via a webhook call when a booking line gets reinstated.

    "event": "BookingLinesReinstated",
    "data": {
        "ids": [30369743, 30369745]
    }
}

PreviousBookingNextProducts

Last updated