Contents
On this page

List Locations - Plugixa Car Wash

GET /plugixa-carwash/v1/locations

List locations, one page at a time, with search, sorting and filters.

Needs the plugixa_carwash_view capability.

Request

GET https://your-site.example/wp-json/plugixa-carwash/v1/locations?status__in=published

Query parameters

Name Type Default Description
status__in string Comma-separated: published, unpublished.
mode__in string Comma-separated: stationary, mobile, hybrid.
city__contains string Part of the city name.

Plus the list parameters every paged list accepts. search matches name, city, address and postcode. orderby accepts id, name, city, mode, status, sort_order, created_at, modified_at. Each filter is a field name and a comparison joined by two underscores: see Filters.

Responses

200 OK. data is one page of locations.

{
  "success": true,
  "data": [
    {
      "id": 3,
      "name": "Riverside",
      "description": "Two drive-through bays.",
      "mode": "stationary",
      "address": "48 River Street",
      "city": "Springfield",
      "postcode": "62701",
      "country": "US",
      "latitude": 39.7990175,
      "longitude": -89.6439575,
      "phone": "+1 217 555 0142",
      "email": "riverside@your-site.example",
      "timezone": "America/Chicago",
      "currency": "USD",
      "tax_rate": 6.25,
      "prices_include_tax": false,
      "schedule": {
        "mon": [
          {
            "start": "08:00",
            "end": "18:00"
          }
        ],
        "tue": [
          {
            "start": "08:00",
            "end": "18:00"
          }
        ],
        "wed": [
          {
            "start": "08:00",
            "end": "18:00"
          }
        ],
        "thu": [
          {
            "start": "08:00",
            "end": "18:00"
          }
        ],
        "fri": [
          {
            "start": "08:00",
            "end": "18:00"
          }
        ],
        "sat": [
          {
            "start": "08:00",
            "end": "18:00"
          }
        ],
        "sun": []
      },
      "slot_minutes": 30,
      "buffer_minutes": 10,
      "lead_minutes": 60,
      "window_days": 30,
      "image_id": null,
      "sort_order": 0,
      "status": "published",
      "created_by": 1,
      "modified_by": 1,
      "created_at": "2026-11-10 08:15:00",
      "modified_at": "2026-11-12 09:30:00",
      "deleted_at": null,
      "image_url": null
    }
  ],
  "meta": {
    "total": 2,
    "pages": 1
  }
}
Field Type Meaning
data[].id integer The location’s id
data[].mode string stationary, mobile or hybrid
data[].latitude number|null Optional
data[].timezone string Empty means the site’s time zone
data[].currency string Empty means the site’s currency
data[].tax_rate number Percent
data[].prices_include_tax boolean Whether prices already contain the tax
data[].schedule object Opening hours: one key per day, mon to sun, each a list of {start, end} periods
data[].slot_minutes integer The time grid customers book on
data[].buffer_minutes integer Kept free after each wash
data[].lead_minutes integer Minimum notice for an online booking
data[].window_days integer How many days ahead customers can book
data[].image_url string|null Medium-size URL of image_id
data[].created_at string UTC datetime
data[].modified_at string UTC datetime of the last change. Send it back on an update to be warned about a conflicting edit
data[].deleted_at string|null null unless the record is in the trash
meta.total integer Locations matching the search and filters, before paging
meta.pages integer Number of pages at this per_page

Errors

Status Code When
400 plugixa_carwash_unknown_filter A filter names a field this list cannot filter on.
400 plugixa_carwash_unknown_operator A comparison that does not work on that field.
400 plugixa_carwash_missing_value A filter that needs a value has none.
400 plugixa_carwash_invalid_date A date filter value is not a date.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-carwash/v1/locations?status__in=published" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query([
    'status__in' => 'published',
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/locations?' . $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 auth = Buffer.from(`admin:${process.env.WP_APP_PASSWORD}`).toString('base64');
const query = new URLSearchParams({ status__in: 'published' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-carwash/v1/locations?${query}`, {
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data, meta } = await response.json();

Quick Links

Share