Contents
On this page

Get Staff Report - Plugixa POS for WooCommerce

GET /plugixa-pos/v1/reports/staff

Sales per cashier for a period, with commission at each person’s rate.

Needs a user with the plugixa_pos_view_reports capability (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Administrators hold it; other roles only when you grant it.

Request

GET https://your-site.example/wp-json/plugixa-pos/v1/reports/staff?from=2026-11-01&to=2026-11-19

Query parameters

Field Type Required Description
from string Yes First day, YYYY-MM-DD.
to string Yes Last day, at most 400 days after from.
outlet_id integer No One store. 0 (default) for all.

Responses

200 OK.

{
  "success": true,
  "data": {
    "from": "2026-11-13",
    "to": "2026-11-19",
    "default_rate": "3",
    "staff": [
      {
        "user_id": 87,
        "name": "Emma Laurent",
        "tickets": 20,
        "items": 39,
        "sales": "830.70",
        "refunds": "53.50",
        "refund_count": 2,
        "net": "777.20",
        "net_ex_tax": "651.82",
        "average": "41.54",
        "discount": "0.00",
        "rate": "5",
        "own_rate": true,
        "commission": "32.59"
      }
    ],
    "totals": {
      "tickets": 61,
      "sales": "2465.71",
      "refunds": "84.00",
      "net": "2381.71",
      "net_ex_tax": "1997.24",
      "discount": "34.46",
      "commission": "72.95"
    }
  }
}
Field Type Meaning
data.default_rate string Default commission rate, percent
data.staff[].rate string The rate used for this person
data.staff[].own_rate boolean The person has their own rate
data.staff[].commission string net_ex_tax times the rate
data.totals object Totals of all cashiers

Errors

Status Code When
422 plugixa_pos_bad_range from is after to.
422 plugixa_pos_range_too_long More than 400 days.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-pos/v1/reports/staff?from=2026-11-01&to=2026-11-19" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/reports/staff?from=2026-11-01&to=2026-11-19');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-pos/v1/reports/staff?from=2026-11-01&to=2026-11-19', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share