Contents
On this page
List Packages - Plugixa Car Wash
GET /plugixa-carwash/v1/packages
List packages, 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/packages
Query parameters
| Name | Type | Default | Description |
|---|---|---|---|
price__between |
number |
min,max. Also __gte, __lte and the other number comparisons. |
|
status__in |
string |
Comma-separated: published, unpublished. |
Plus the list parameters every paged list accepts. search matches the name. orderby accepts id, name, duration, price, featured, 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 packages.
{
"success": true,
"data": [
{
"id": 4,
"name": "Deluxe",
"tagline": "Inside and out",
"description": "",
"duration": 45,
"price": 39.0,
"badge": "Most popular",
"color": "#F59E0B",
"featured": true,
"image_id": null,
"sort_order": 1,
"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": 3,
"pages": 1
}
}
| Field | Type | Meaning |
|---|---|---|
data[].id |
integer |
The package’s id |
data[].duration |
integer |
Minutes, before the vehicle type’s multiplier |
data[].price |
number |
Base price, before the vehicle type’s fee |
data[].badge |
string |
Short ribbon on the card |
data[].featured |
boolean |
Lifted on the booking form |
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 |
Packages 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/packages" \
-u "admin:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/packages');
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 response = await fetch('https://your-site.example/wp-json/plugixa-carwash/v1/packages', {
headers: {
'Authorization': `Basic ${auth}`,
},
});
const { data, meta } = await response.json();
Quick Links
Share