Contents
On this page

Get Booking by Token - Plugixa Car Wash

GET /plugixa-carwash/v1/public/bookings/{token}

Read a booking with the private token from its confirmation link: the page the customer lands on after booking.

Open to anyone: no sign-in. Rate-limited per visitor address to 600 requests an hour, shared by every public read route (bucket carwash_read). See Public routes.

Note. With Pro Stripe, this is also where the customer comes back after paying: the query string Stripe adds is checked and, when the payment went through, the booking is confirmed before it is returned.

Request

GET https://your-site.example/wp-json/plugixa-carwash/v1/public/bookings/9f1c2e7a5b3d4c6e8f0a1b2c3d4e5f60

Path parameters

Name Type Description
token string The booking’s 32-character token, lowercase letters a to f and digits

Responses

200 OK. data is the booking as the customer sees it.

{
  "success": true,
  "data": {
    "number": "CW2026-0043",
    "token": "9f1c2e7a5b3d4c6e8f0a1b2c3d4e5f60",
    "status": "confirmed",
    "location": "Riverside",
    "date": "2026-11-14",
    "time": "09:00",
    "start_at": "2026-11-14 15:00:00",
    "end_at": "2026-11-14 16:00:00",
    "duration": 60,
    "items": [
      {
        "name": "Deluxe",
        "price": 49.0,
        "role": "package"
      },
      {
        "name": "Coupon SPRING10",
        "price": -4.9,
        "role": "discount"
      }
    ],
    "subtotal": 44.1,
    "tax": 2.76,
    "total": 46.86,
    "currency": "USD",
    "first_name": "Emma",
    "email": "emma@example.com",
    "payment_status": "unpaid",
    "payment_method": "cash",
    "discount": 4.9,
    "paid": 0.0,
    "due": 46.86,
    "can_cancel": true
  }
}
Field Type Meaning
data.number string The booking reference
data.token string The booking’s private 32-character key. Whoever has it can read and cancel the booking: treat it like a password
data.status string hold (waiting for an online payment), pending, confirmed, in_progress, completed, cancelled or no_show
data.location string The location’s name
data.date string Local date, Y-m-d
data.time string Local start time, H:i
data.start_at string UTC start
data.duration integer Minutes
data.items array The priced lines: name, price, role
data.total number What the booking costs
data.paid number Paid so far, less refunds
data.due number Still to pay
data.can_cancel boolean Whether Cancel Booking would be accepted now: the booking is hold, pending or confirmed and the cancellation cut-off has not passed

Errors

Status Code When
404 plugixa_carwash_not_found No booking with that token, or it is in the trash. A token that is not 32 lowercase hex characters answers 404 rest_no_route.
429 plugixa_carwash_rate_limited This address has used up its requests for the hour.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-carwash/v1/public/bookings/9f1c2e7a5b3d4c6e8f0a1b2c3d4e5f60"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/public/bookings/9f1c2e7a5b3d4c6e8f0a1b2c3d4e5f60');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-carwash/v1/public/bookings/9f1c2e7a5b3d4c6e8f0a1b2c3d4e5f60');
const { data } = await response.json();

Quick Links

Share