Contents
On this page

List Bookings - Plugixa Car Parking

GET /plugixa-car-parking/v1/bookings

List bookings, one page at a time, with a search over the reference, the customer and the licence plate, and filters on status, dates, location and more.

The user needs the plugixa_carparking_view capability.

Request

GET https://your-site.example/wp-json/plugixa-car-parking/v1/bookings?status__in=pending,confirmed&orderby=entry_datetime&order=asc

Query parameters

The list parameters every paged list accepts: page, per_page, search, orderby, order and view.

  • search matches the booking reference, the customer name, the customer e-mail and the licence plate.
  • orderby accepts id, booking_ref, status, payment_status, entry_datetime, exit_datetime, customer_name, total, created_at and modified_at. Anything else sorts by id.
  • view=trash lists trashed bookings only.

Plus filters, written <field>__<operator>=<value>:

Field Kind Operators
status One of the booking statuses in, ne, empty, not_empty
payment_status unpaid, deposit_paid, paid (and overdue with Pro) in, ne, empty, not_empty
location_id A location id in, ne, empty, not_empty
space_type_id A space type id in, ne, empty, not_empty
entry_datetime Date between, gte, gt, lte, lt, eq, empty, not_empty
exit_datetime Date between, gte, gt, lte, lt, eq, empty, not_empty
total Number between, gte, gt, lte, lt, eq, ne, empty, not_empty
created_at Date between, gte, gt, lte, lt, eq, empty, not_empty
modified_at Date between, gte, gt, lte, lt, eq, empty, not_empty

The booking statuses are pending, confirmed, paid, completed, cancelled, refunded, no_show and expired, unless the site has changed its list of statuses in the settings.

Responses

200 OK. data is one page of bookings.

{
  "success": true,
  "data": [
    {
      "id": 57,
      "booking_ref": "PKG-3F9A1C",
      "language_code": null,
      "location_id": 3,
      "space_type_id": 2,
      "space_id": null,
      "booking_form_id": 1,
      "user_id": 14,
      "status": "confirmed",
      "billing_type": "day",
      "entry_datetime": "2026-12-01 08:00:00",
      "exit_datetime": "2026-12-04 08:00:00",
      "quantity": 1,
      "hold_expires_at": null,
      "license_plate": "AB-123-CD",
      "vehicle": null,
      "customer_name": "Lucas Bernard",
      "customer_email": "lucas@example.com",
      "customer_phone": "+33 6 12 34 56 78",
      "billing": null,
      "currency": "EUR",
      "subtotal": 37.5,
      "discount_total": 0,
      "tax_total": 0,
      "deposit_amount": 0,
      "total": 37.5,
      "amount_paid": 10,
      "coupon_id": null,
      "payment_method": "offline",
      "payment_status": "deposit_paid",
      "notes": null,
      "meta": { "flight_number": "AF1234", "_labels": { "flight_number": "Flight number" } },
      "created_by": 1,
      "modified_by": 1,
      "created_at": "2026-11-12 09:30:00",
      "updated_at": null,
      "modified_at": "2026-11-12 10:05:00",
      "deleted_at": null,
      "location_name": "Airport North",
      "space_type_name": "Standard"
    }
  ],
  "meta": { "total": 1, "pages": 1 }
}
Field Type Meaning
data[].id integer The booking’s id
data[].booking_ref string The reference customers see: the prefix set in the settings (PKG- by default) and six characters
data[].status string The booking status
data[].payment_status string unpaid, deposit_paid or paid, worked out from the payments (Pro adds overdue)
data[].entry_datetime string Entry, in the site’s own time zone
data[].exit_datetime string Exit, in the site’s own time zone
data[].hold_expires_at string|null When an unpaid pending booking stops holding its space, in the site’s time zone
data[].quantity integer Number of spaces
data[].space_id integer|null The numbered space held, when the location counts spaces one by one
data[].vehicle object|null Vehicle details as key-value pairs
data[].billing object|null Billing details as key-value pairs
data[].meta object|null Answers to the booking form’s custom fields, keyed by field, with their labels under _labels
data[].total number What the booking costs
data[].amount_paid number Net of refunds, from the payments ledger
data[].location_name string|null The location’s name, null if it no longer exists
data[].space_type_name string|null The space type’s name, null if it no longer exists
data[].created_at string UTC datetime
meta.total integer Bookings matching the search and filters, before paging
meta.pages integer Number of pages at this per_page

List rows do not carry the price lines or the custom_fields list: Get Booking adds them.

Errors

Status Code When
400 plugixa_carparking_unknown_filter A filter names a field this list cannot filter on.
400 plugixa_carparking_unknown_operator The operator does not work on that field.
400 plugixa_carparking_missing_value A filter is missing its value.
400 plugixa_carparking_invalid_date A date filter’s value is not a date.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-car-parking/v1/bookings?status__in=pending,confirmed&orderby=entry_datetime&order=asc" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query([
    'status__in' => 'pending,confirmed',
    'orderby'    => 'entry_datetime',
    'order'      => 'asc',
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-car-parking/v1/bookings?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const query = new URLSearchParams({ status__in: 'pending,confirmed', orderby: 'entry_datetime', order: 'asc' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-car-parking/v1/bookings?${query}`, {
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data, meta } = await response.json();

Quick Links

Share