Contents
List Layaways - Plugixa POS for WooCommerce
GET /plugixa-pos/v1/layaways
Goods put aside for a customer who pays in instalments.
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.
Request
GET https://your-site.example/wp-json/plugixa-pos/v1/layaways?status=open
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
status |
string |
No | open (default), completed, cancelled, or empty for all. |
search |
string |
No | Customer or order number. |
page |
integer |
No | Page to return, from 1. Defaults to 1. |
per_page |
integer |
No | Rows per page, 1 to 100. Defaults to 50. |
Responses
200 OK.
{
"success": true,
"data": [
{
"id": 4460,
"number": "4460",
"status": "open",
"customer_id": 88,
"customer": "Camille Martin",
"phone": "06 10 20 31 40",
"register_id": 1,
"total": "27.00",
"paid": "10.00",
"balance": "17.00",
"lines": [
{
"name": "French press 1 L",
"qty": 1,
"total": "27.00"
}
],
"deposits": [
{
"ticket": 315,
"amount": "10.00",
"methods": "Cash",
"at": "2026-11-18T20:00:35+00:00"
}
],
"refund": null,
"created_at": "2026-11-18T21:00:35+01:00"
}
],
"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/layaways?status=open" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/layaways?status=open');
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/layaways?status=open', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share