Contents
On this page

List Serial Numbers - Plugixa POS for WooCommerce

GET /plugixa-pos/v1/serials

Serial numbers and where each unit went.

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. Selling staff may read it, to answer “who bought this unit?” at the counter.

Request

GET https://your-site.example/wp-json/plugixa-pos/v1/serials?search=MW-2026

Query parameters

Field Type Required Description
search string No Part of a number.
status string No available, sold, returned, or empty for all.
product_id integer No One product.
page integer No Page to return, from 1. Defaults to 1.
per_page integer No Rows per page, 1 to 200. Defaults to 50.

Responses

200 OK.

{
  "success": true,
  "data": [
    {
      "id": 7,
      "serial": "MW-2026-00417",
      "status": "sold",
      "product": {
        "id": 3819,
        "name": "Minimal watch",
        "sku": "ACC-WATCH"
      },
      "outlet_id": 1,
      "order": {
        "id": 4437,
        "number": "4437",
        "url": "https://your-site.example/wp-admin/admin.php?page=wc-orders&action=edit&id=4437"
      },
      "customer": {
        "id": 88,
        "name": "Camille Martin",
        "email": "camille.martin@example.com"
      },
      "sold_at": "2026-11-14 12:45:03",
      "note": "",
      "updated_at": "2026-11-14 12:45:03"
    }
  ],
  "meta": {
    "total": 1,
    "pages": 1,
    "require_known": false
  }
}
Field Type Meaning
data[].status string available, sold or returned
data[].customer object|null Who bought it
meta.require_known boolean The serials_require_known setting: only numbers received beforehand can be sold

Errors

This endpoint has no errors of its own.

Plus the errors every endpoint can return.

Examples

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

Quick Links

Share