Contents
List Suppliers - Plugixa POS for WooCommerce
GET /plugixa-pos/v1/suppliers
Suppliers, active ones by default.
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/suppliers?per_page=1
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
search |
string |
No | Words to look for. |
status |
string |
No | active (default), archived, or empty for both. |
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": 2,
"name": "Atelier Grès & Terre",
"contact": "",
"email": "contact@gres-terre.test",
"phone": "",
"address": {
"address_1": "",
"address_2": "",
"postcode": "",
"city": "",
"country": ""
},
"tax_id": "",
"lead_time_days": 10,
"notes": "",
"status": "active"
}
],
"meta": {
"total": 4,
"pages": 4
}
}
| 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/suppliers?per_page=1" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/suppliers?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/suppliers?per_page=1', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share