Contents
List Purchase Orders - Plugixa POS for WooCommerce
GET /plugixa-pos/v1/purchase-orders
Purchase orders, newest first.
Needs a user with the plugixa_pos_purchase capability (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Unlike the other capabilities, Pro gives this one to administrators and to the WooCommerce Shop manager role.
Request
GET https://your-site.example/wp-json/plugixa-pos/v1/purchase-orders?status=ordered&per_page=1
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
status |
string |
No | draft, ordered, partial, received, closed, cancelled, or empty for all. |
supplier_id |
integer |
No | One supplier. |
page |
integer |
No | Page to return, from 1. Defaults to 1. |
per_page |
integer |
No | Rows per page, 1 to 100. Defaults to 25. |
Responses
200 OK.
{
"success": true,
"data": [
{
"id": 3,
"number": "PO-000003",
"supplier_id": 2,
"supplier_name": "Atelier Grès & Terre",
"outlet_id": 1,
"outlet_name": "Maison Plugixa Marais",
"status": "ordered",
"expected_at": "2026-11-21",
"note": "",
"created_at": "2026-11-05 09:00:00",
"ordered_at": "2026-11-05 09:30:00",
"closed_at": null,
"total": "58.80",
"items": [
{
"id": 11,
"product_id": 3745,
"name": "Ceramic bowl",
"sku": "KIT-BOWL",
"qty_ordered": 12,
"qty_received": 0,
"unit_cost": "4.9000",
"total": "58.80"
}
],
"receipts": []
}
],
"meta": {
"total": 1,
"pages": 1
}
}
| Field | Type | Meaning |
|---|---|---|
meta.total |
integer |
Rows matching the filters |
meta.pages |
integer |
Pages at this per_page |
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/purchase-orders?status=ordered&per_page=1" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/purchase-orders?status=ordered&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/purchase-orders?status=ordered&per_page=1', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share