Contents
On this page

List Cashiers - Plugixa POS for WooCommerce

GET /plugixa-pos/v1/staff/cashiers

Staff who may sell on this register, for the cashier switch and manager approvals. Still answers while the till is locked.

Needs a user with the plugixa_pos_sell 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. The user must also be allowed to use the register (register access).

Request

GET https://your-site.example/wp-json/plugixa-pos/v1/staff/cashiers?register_id=1

Query parameters

Field Type Required Description
register_id integer Yes The register.

Responses

200 OK.

{
  "success": true,
  "data": [
    {
      "id": 87,
      "name": "Emma Laurent",
      "has_pin": true,
      "can_switch": true,
      "current": true,
      "can_approve": ["discount", "discount_limit", "refund"]
    },
    {
      "id": 102,
      "name": "Léa (test cashier)",
      "has_pin": true,
      "can_switch": true,
      "current": false,
      "can_approve": []
    }
  ]
}
Field Type Meaning
data[].has_pin boolean A PIN is set
data[].can_switch boolean May be switched to with a PIN. Administrators and other powerful accounts sign in with their password instead
data[].can_approve string[] Approvals this person can give: discount, discount_limit, refund

Errors

Status Code When
403 plugixa_pos_register_forbidden The register is missing or archived, or the user may not use it.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-pos/v1/staff/cashiers?register_id=1" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/staff/cashiers?register_id=1');
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/staff/cashiers?register_id=1', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share