List Flat Rate Routes - Plugixa Chauffeur for WordPress

List Flat Rate Routes - Plugixa Chauffeur

GET /plugixa-chauffeur/v1/routes

List the fixed-price routes, such as airport to city centre.

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/routes?search=CDG

Query parameters

Name	Type	Default	Description
`search`	`string`		Matches part of the name, the pickup label or the drop-off label.

Plus the list parameters every list accepts. orderby and order are ignored: routes come by display_order, then id.

Responses

`200` OK. `data.items` is one page of routes.

{
  "success": true,
  "message": "",
  "data": {
    "items": [
      {
        "id": "2",
        "name": "CDG to Paris centre",
        "pickup_label": "Paris Charles de Gaulle Airport",
        "dropoff_label": "Paris city centre",
        "price": 75.0,
        "status": "active",
        "display_order": "0",
        "created_at": "2026-11-12 09:30:00"
      }
    ],
    "total": 4,
    "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 route, as in Get Flat Rate Route

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-chauffeur/v1/routes?search=CDG" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query([
    'search' => 'CDG',
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-chauffeur/v1/routes?' . $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({ search: 'CDG' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-chauffeur/v1/routes?${query}`, {
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data } = await response.json();