Contents
On this page

Return Items - Plugixa POS for WooCommerce

POST /plugixa-pos/v1/orders/{id}/return

A partial refund: some items, some quantities. The refund is written to the fiscal journal and a refund ticket is given.

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

Path parameters

Name Type Description
id integer The order’s id

Request body

Content type: application/json

Field Type Required Description
register_id integer Yes The register, with an open session.
lines object[] Yes 1 to 500 rows: item_id (the order line, from Get Refundable Items) and qty.
restock boolean No Put the items back in stock. Defaults to true.
method string Yes How the money goes back: a payment method id such as cash. A method tied to the original payment (card reader, gift card, pay link) only works when the sale was paid that way.
reason string No Up to 200 characters.
{
  "register_id": 1,
  "lines": [
    {
      "item_id": 8989,
      "qty": 1
    }
  ],
  "restock": true,
  "method": "cash",
  "reason": "Faulty lid"
}

Responses

201 Created. data is the receipt plus refund_ticket and refund_amount.

{
  "success": true,
  "data": {
    "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": "27.00",
    "status": "completed",
    "refund_ticket": 322,
    "refund_amount": "27.00"
  }
}

Errors

Status Code When
404 plugixa_pos_not_found Not a register order.
403 plugixa_pos_register_forbidden The register is missing or archived, or the user may not use it.
409 plugixa_pos_session_closed No open session.
409 plugixa_pos_not_sold Not a completed sale.
422 plugixa_pos_invalid_line A line is not on this sale.
422 plugixa_pos_nothing_refunded No quantity chosen.
422 plugixa_pos_invalid_payment No valid way to pay back.

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-pos/v1/orders/4460/return" \
  -u "$WP_USER:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"register_id":1,"lines":[{"item_id":8989,"qty":1}],"restock":true,"method":"cash","reason":"Faulty lid"}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/orders/4460/return');
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,
        'lines'       => [
            [
                'item_id' => 8989,
                'qty'     => 1,
            ],
        ],
        'restock'     => true,
        'method'      => 'cash',
        'reason'      => 'Faulty lid',
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-pos/v1/orders/4460/return', {
  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, lines: [{ item_id: 8989, qty: 1 }], restock: true, method: 'cash', reason: 'Faulty lid' }),
});
const { data } = await response.json();

Quick Links

Share