Contents
On this page
List Held Sales - Plugixa POS for WooCommerce
GET /plugixa-pos/v1/held-carts
The carts put on hold in the register’s store, newest first. Any register of the same store sees them.
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. The user must also be allowed to use the register (register access).
Request
GET https://your-site.example/wp-json/plugixa-pos/v1/held-carts?register_id=1
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
register_id |
integer |
Yes | The register asking. Its store decides which carts come back. |
Responses
200 OK. data is the list, at most 100.
{
"success": true,
"data": [
{
"id": 12,
"register_id": 1,
"label": "Lady in the green coat",
"cashier": "Emma Laurent",
"cart": {
"lines": [
{
"product_id": 3800,
"variation_id": 3801,
"qty": 1
}
]
},
"created_at": "2026-11-19 14:20:11"
}
]
}
| Field | Type | Meaning |
|---|---|---|
data[].id |
integer |
The held cart’s id |
data[].register_id |
integer |
Register it was held at |
data[].label |
string |
Label typed by the cashier |
data[].cashier |
string |
Who held it |
data[].cart |
object |
The cart as the register saved it |
data[].created_at |
string |
UTC, Y-m-d H:i:s |
Errors
| Status | Code | When |
|---|---|---|
404 |
plugixa_pos_no_register |
No register with that id. |
403 |
plugixa_pos_register_forbidden |
The register is missing or archived, or the user may not use it. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-site.example/wp-json/plugixa-pos/v1/held-carts?register_id=1" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/held-carts?register_id=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/held-carts?register_id=1', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share