Contents
Get Purchase Order - Plugixa POS for WooCommerce
GET /plugixa-pos/v1/purchase-orders/{id}
One order, with the goods receipts recorded against it.
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/3
Path parameters
| Name | Type | Description |
|---|---|---|
id |
integer |
The purchase order’s id |
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": []
}
}
| Field | Type | Meaning |
|---|---|---|
data.status |
string |
draft, ordered, partial, received, closed, cancelled |
data.items |
object[] |
qty_ordered, qty_received, unit_cost, total per line |
data.receipts |
object[] |
Goods receipts: id, received_at, note, received_by |
Errors
| Status | Code | When |
|---|---|---|
404 |
plugixa_pos_not_found |
No purchase order with that id. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-site.example/wp-json/plugixa-pos/v1/purchase-orders/3" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/purchase-orders/3');
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/3', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share