Contents
List Supplier Returns - Plugixa POS for WooCommerce
GET /plugixa-pos/v1/supplier-returns
Supplier returns, 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/supplier-returns
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
status |
string |
No | draft, sent, cancelled, or empty for all. |
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": 1,
"number": "RT-000001",
"supplier_id": 1,
"supplier_name": "Torréfaction du Marais",
"outlet_id": 1,
"outlet_name": "Maison Plugixa Marais",
"status": "draft",
"reason": "Damaged in transit",
"created_at": "2026-10-13 08:00:00",
"sent_at": null,
"total": "7.60",
"items": [
{
"product_id": 3720,
"name": "House espresso beans 250 g",
"sku": "COF-HOUSE",
"qty": 2,
"unit_cost": "3.8000",
"total": "7.60"
}
]
}
],
"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/supplier-returns" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/supplier-returns');
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/supplier-returns', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share