Contents
On this page
Hold Sale - Plugixa POS for WooCommerce
POST /plugixa-pos/v1/held-carts
Put a cart on hold. The cart is stored as you send it (64 KB at most) and must have lines.
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
POST https://your-site.example/wp-json/plugixa-pos/v1/held-carts
Request body
Content type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
register_id |
integer |
Yes | The register. |
label |
string |
No | A label, up to 190 characters. |
cart |
object |
Yes | The cart, with a non-empty lines array. |
{
"register_id": 1,
"label": "Lady in the green coat",
"cart": {
"lines": [
{
"product_id": 3800,
"variation_id": 3801,
"qty": 1
}
]
}
}
Responses
201 Created.
{
"success": true,
"data": {
"id": 12
}
}
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. |
422 |
plugixa_pos_empty_cart |
The cart has no lines. |
413 |
plugixa_pos_cart_too_large |
The cart is larger than 64 KB. |
Plus the errors every endpoint can return.
Examples
curl -s -X POST "https://your-site.example/wp-json/plugixa-pos/v1/held-carts" \
-u "$WP_USER:$WP_APP_PASSWORD" \
-H "Content-Type: application/json" \
-d '{"register_id":1,"label":"Lady in the green coat","cart":{"lines":[{"product_id":3800,"variation_id":3801,"qty":1}]}}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/held-carts');
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,
'label' => 'Lady in the green coat',
'cart' => [
'lines' => [
[
'product_id' => 3800,
'variation_id' => 3801,
'qty' => 1,
],
],
],
]),
]);
$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', {
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, label: 'Lady in the green coat', cart: { lines: [{ product_id: 3800, variation_id: 3801, qty: 1 }] } }),
});
const { data } = await response.json();
Quick Links
Share