Contents
On this page
List Products - Plugixa POS for WooCommerce
GET /plugixa-pos/v1/products
One page of the catalogue as the register sees it: published products with their variations, prices and stock. The register keeps a copy of this list and refreshes it with List Catalogue Changes.
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. When you pass a register_id, the user must also be allowed to use that register (register access).
Request
GET https://your-site.example/wp-json/plugixa-pos/v1/products?register_id=1&search=tote&per_page=1
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
search |
string |
No | Words to look for. |
category |
integer |
No | A product category id. 0 (default) for all. |
register_id |
integer |
No | Price and stock as this register’s store sees them (Pro multi-store). |
include |
integer[] |
No | Only these product ids, up to 500. |
modified_after |
string |
No | ISO 8601 date-time: only products changed after it. |
page |
integer |
No | Page to return, from 1. Defaults to 1. |
per_page |
integer |
No | Products per page. Defaults to 100. |
Responses
200 OK. data is one page of products.
{
"success": true,
"data": [
{
"id": 3800,
"name": "Canvas tote",
"sku": "ACC-TOTE",
"barcode": "",
"price": "25",
"regular_price": "",
"sale_price": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": false,
"stock_quantity": null,
"stock_status": "instock",
"backorders": "no",
"image": "https://your-site.example/wp-content/uploads/2026/11/acc-tote-7-300x300.jpg",
"description": "Heavy canvas tote with an inside pocket.",
"type": "variable",
"category_ids": [126],
"modified_at": "2026-11-16T17:26:28+01:00",
"attributes": [
{
"key": "attribute_pa_color",
"name": "Colour",
"options": [
{
"value": "natural",
"label": "Natural"
},
{
"value": "black",
"label": "Black"
}
]
}
],
"variations": [
{
"id": 3801,
"name": "Canvas tote - Natural",
"sku": "ACC-TOTE-NAT",
"barcode": "3760123450478",
"price": "25",
"regular_price": "25",
"sale_price": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": true,
"stock_quantity": 21,
"stock_status": "instock",
"backorders": "no",
"image": "https://your-site.example/wp-content/uploads/2026/11/acc-tote-7-300x300.jpg",
"description": "",
"parent_id": 3800,
"attributes": {
"pa_color": "natural"
}
}
]
}
],
"meta": {
"total": 1,
"pages": 1,
"cursor": 3974
}
}
| Field | Type | Meaning |
|---|---|---|
data[].id |
integer |
Product id |
data[].name |
string |
Name |
data[].sku |
string |
SKU |
data[].barcode |
string |
Barcode (GTIN), empty when none |
data[].price |
string |
Current price, as WooCommerce stores it. With Pro, the register’s store price when one is set |
data[].regular_price |
string |
Regular price |
data[].sale_price |
string |
Sale price, empty when none |
data[].tax_status |
string |
taxable, shipping or none |
data[].tax_class |
string |
Tax class slug, empty for the standard rate |
data[].manage_stock |
boolean |
Stock is tracked |
data[].stock_quantity |
integer|null |
Stock, null when not tracked. With Pro, the register’s store stock |
data[].stock_status |
string |
instock, outofstock or onbackorder |
data[].image |
string |
Image URL |
data[].type |
string |
WooCommerce product type |
data[].category_ids |
integer[] |
Category ids |
data[].modified_at |
string |
Last change, ISO 8601 |
data[].attributes |
object[] |
Variable products: the attributes and their options |
data[].variations |
object[] |
Variable products: each variation, with the same fields plus parent_id and attributes |
meta.total |
integer |
Rows matching the filters |
meta.pages |
integer |
Pages at this per_page |
meta.cursor |
integer |
The change-log position when this page was read: pass it to List Catalogue Changes |
The answer carries an ETag header. Send it back in If-None-Match and an unchanged page answers 304 with no body.
Errors
| Status | Code | When |
|---|---|---|
403 |
plugixa_pos_register_forbidden |
The register is missing or archived, or the user may not use it. |
400 |
rest_invalid_param |
A parameter is out of range, for example more than 500 ids in include. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-site.example/wp-json/plugixa-pos/v1/products?register_id=1&search=tote&per_page=1" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/products?register_id=1&search=tote&per_page=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/products?register_id=1&search=tote&per_page=1', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share