Create Booking - Plugixa Boat Rental

POST /pbr/v1/bookings

Create a booking for one boat, checked and priced the way a booking made in the office is.

An API key PRO with Read and write access, or a signed-in user with the plugixa_boatrental_create capability.

Note. A booking made here skips the booking widget’s own rules: it is not held to a booking form, and it is not refused because the marina or the boat is marked inactive. It is still refused for a past or too-distant departure, closed hours, a window the boat does not allow, too many guests, or no free boat.

Request

POST https://your-site.example/wp-json/pbr/v1/bookings

Request body

Content type: application/json

payment_status and amount_paid cannot be sent: they come from the payments ledger, and sending either is refused. Record money with Record Payment.

A booking is always for one boat: a quantity is checked for being a positive number and otherwise ignored. The total and the line items are worked out from the boat’s prices for the window, the same way the booking widget prices it. The booking is recorded with the source admin, and the usual booking emails and booking.created webhooks follow.

{
  "location_id": 2,
  "boat_id": 5,
  "start": "2026-11-20 10:00",
  "end": "2026-11-20 14:00",
  "guests": 4,
  "customer_name": "Ana Silva",
  "customer_email": "ana@example.com",
  "customer_phone": "+351 912 345 678",
  "status": "confirmed"
}

Responses

201 Created. data is the new booking.

{
  "success": true,
  "data": {
    "id": 412,
    "booking_ref": "BOAT-7F3A91",
    "language_code": null,
    "location_id": 2,
    "boat_id": 5,
    "unit_id": 9,
    "booking_form_id": null,
    "user_id": null,
    "status": "confirmed",
    "billing_type": "hour",
    "start_datetime": "2026-11-20 10:00:00",
    "end_datetime": "2026-11-20 14:00:00",
    "start_utc": "2026-11-20 10:00:00",
    "end_utc": "2026-11-20 14:00:00",
    "buffer_before": 0,
    "buffer_after": 30,
    "block_start_utc": "2026-11-20 10:00:00",
    "block_end_utc": "2026-11-20 14:30:00",
    "quantity": 1,
    "guests": 4,
    "source": "admin",
    "hold_expires_at": null,
    "customer_name": "Ana Silva",
    "customer_email": "ana@example.com",
    "customer_phone": "+351 912 345 678",
    "billing": null,
    "currency": "EUR",
    "subtotal": 380.0,
    "discount_total": 0.0,
    "tax_total": 0.0,
    "deposit_amount": 0.0,
    "total": 380.0,
    "amount_paid": 0.0,
    "payment_method": "offline",
    "payment_status": "unpaid",
    "notes": null,
    "meta": null,
    "created_by": 0,
    "modified_by": 0,
    "created_at": "2026-11-12 09:30:00",
    "updated_at": null,
    "modified_at": "2026-11-12 09:30:00",
    "deleted_at": null,
    "items": [
      {
        "id": 977,
        "booking_id": 412,
        "type": "rental",
        "reference_id": 5,
        "label": "1 boat × 4 hours",
        "quantity": 4.0,
        "unit_price": 95.0,
        "total": 380.0,
        "tax_rate_id": null,
        "meta": null
      }
    ],
    "custom_fields": [],
    "location_name": "Lisbon Marina",
    "boat_name": "Sea Ray 230"
  }
}

Errors

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/pbr/v1/bookings" \
  -H "Authorization: Bearer $PBR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"location_id":2,"boat_id":5,"start":"2026-11-20 10:00","end":"2026-11-20 14:00","guests":4,"customer_name":"Ana Silva","customer_email":"ana@example.com","customer_phone":"+351 912 345 678","status":"confirmed"}'

<?php
$ch = curl_init('https://your-site.example/wp-json/pbr/v1/bookings');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer ' . getenv('PBR_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'location_id'    => 2,
        'boat_id'        => 5,
        'start'          => '2026-11-20 10:00',
        'end'            => '2026-11-20 14:00',
        'guests'         => 4,
        'customer_name'  => 'Ana Silva',
        'customer_email' => 'ana@example.com',
        'customer_phone' => '+351 912 345 678',
        'status'         => 'confirmed',
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/pbr/v1/bookings', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.PBR_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    location_id: 2,
    boat_id: 5,
    start: '2026-11-20 10:00',
    end: '2026-11-20 14:00',
    guests: 4,
    customer_name: 'Ana Silva',
    customer_email: 'ana@example.com',
    customer_phone: '+351 912 345 678',
    status: 'confirmed',
  }),
});
const { data } = await response.json();