Contents
On this page

Get Layaway - Plugixa POS for WooCommerce

GET /plugixa-pos/v1/layaways/{id}

One layaway.

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/4460

Path parameters

Name Type Description
id integer The layaway’s order id

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"
  }
}
Field Type Meaning
data.status string open, completed or cancelled
data.paid string Paid so far
data.balance string Left to pay
data.deposits object[] ticket, amount, methods, at per payment
data.refund object|null When cancelled: what was paid back

Errors

Status Code When
404 plugixa_pos_not_found No layaway with that id, or not reachable for this user.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-pos/v1/layaways/4460" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/layaways/4460');
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/4460', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share