Contents
On this page

Cancel Layaway - Plugixa POS for WooCommerce

POST /plugixa-pos/v1/layaways/{id}/cancel

Cancel a layaway: what was paid is refunded and the goods go back to stock.

Needs a user with the plugixa_pos_refund 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. The user must also be allowed to use the register (register access).

Request

POST https://your-site.example/wp-json/plugixa-pos/v1/layaways/4460/cancel

Path parameters

Name Type Description
id integer The layaway’s order id

Request body

Content type: application/json

Field Type Required Description
register_id integer Yes The register, with an open session.
reason string No Up to 200 characters.
{
  "register_id": 1,
  "reason": "Customer changed their mind"
}

Responses

200 OK. data.receipt.refund_ticket is the refund’s ticket number.

{
  "success": true,
  "data": {
    "layaway": {
      "id": 4460,
      "number": "4460",
      "status": "cancelled",
      "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"
    },
    "receipt": {
      "order_id": 4460,
      "order_number": "4464",
      "ticket": 319,
      "date": "November 19, 2026 3:12 pm",
      "store": {
        "name": "Maison Plugixa Marais",
        "address": {
          "address_1": "12 rue des Archives",
          "city": "Paris",
          "postcode": "75004",
          "country": "FR",
          "address_2": ""
        },
        "phone": "",
        "tax_id": "FR 40 123 456 789"
      },
      "register": "R1",
      "cashier": "Emma Laurent",
      "customer": "Camille Martin",
      "currency": "EUR",
      "lines": [
        {
          "name": "Canvas tote - Natural",
          "options": [],
          "qty": 1,
          "subtotal": "25.00",
          "total": "25.00"
        },
        {
          "name": "Greeting card",
          "options": [],
          "qty": 1,
          "subtotal": "4.00",
          "total": "4.00"
        }
      ],
      "discount": "0.00",
      "coupons": [],
      "taxes": [
        {
          "label": "TVA",
          "rate": "20%",
          "amount": "4.83"
        }
      ],
      "tax_total": "4.83",
      "total": "29.00",
      "payments": [
        {
          "method": "cash",
          "label": "Cash",
          "amount": "30.00"
        }
      ],
      "tendered": "30.00",
      "change": "1.00",
      "fiscal": {
        "hash_short": "EC60-5CEF",
        "software": "Plugixa POS 1.0.0"
      },
      "header": "Maison Plugixa\n12 rue des Archives, 75004 Paris",
      "footer": "Exchanges within 30 days with this receipt.\nThank you and see you soon!",
      "refunded": "0.00",
      "status": "completed",
      "refund_ticket": 321
    }
  }
}

Errors

Status Code When
404 plugixa_pos_not_found No layaway with that id.
403 plugixa_pos_register_forbidden The register is missing or archived, or the user may not use it.
409 plugixa_pos_layaway_closed Already paid or cancelled.
409 plugixa_pos_session_closed No open session.

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-pos/v1/layaways/4460/cancel" \
  -u "$WP_USER:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"register_id":1,"reason":"Customer changed their mind"}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/layaways/4460/cancel');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'register_id' => 1,
        'reason'      => 'Customer changed their mind',
    ]),
]);
$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/cancel', {
  method: 'POST',
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ register_id: 1, reason: 'Customer changed their mind' }),
});
const { data } = await response.json();

Quick Links

Share