Contents
On this page
List Pricing Rules - Plugixa Chauffeur
GET /plugixa-chauffeur/v1/pricing-rules
List pricing rules in the order they run.
Needs Plugixa Chauffeur Pro with an active licence. Needs a signed-in user with the plugixa_chauffeur_manage capability (administrators have it after activation).
Request
GET https://your-site.example/wp-json/plugixa-chauffeur/v1/pricing-rules
Query parameters
| Name | Type | Default | Description |
|---|---|---|---|
search |
string |
Matches part of the rule name. |
Plus the list parameters every list accepts. orderby and order are ignored: rules always come in running order, by priority, then display_order, then id.
Responses
200 OK. data.items is one page of rules.
{
"success": true,
"message": "",
"data": {
"items": [
{
"id": "4",
"name": "Weekend surcharge",
"status": "active",
"priority": 10,
"conditions": {
"service_types": [
"distance",
"hourly"
],
"days_of_week": [
0,
6
]
},
"adjustment_type": "increase_percent",
"adjustment_value": 15.0,
"apply_to": "total",
"stop_processing": false,
"display_order": 0,
"created_at": "2026-11-12 09:30:00"
}
],
"total": 3,
"limit": 20,
"offset": 0
}
}
| Field | Type | Meaning |
|---|---|---|
data.items |
array |
One page of rows |
data.total |
integer |
Rows matching the filters, before paging |
data.limit |
integer |
Rows per page used. 999999 when you asked for every row |
data.offset |
integer |
Rows skipped |
data.items[] |
object |
A rule, as in Get Pricing Rule |
Errors
Plus the errors every endpoint can return.
Examples
curl -s "https://your-site.example/wp-json/plugixa-chauffeur/v1/pricing-rules" \
-u "admin:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-chauffeur/v1/pricing-rules');
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-chauffeur/v1/pricing-rules', {
headers: {
'Authorization': `Basic ${auth}`,
},
});
const { data } = await response.json();
Quick Links
Share