Contents
On this page
Get Register Bootstrap - Plugixa POS for WooCommerce
GET /plugixa-pos/v1/register/bootstrap
Everything the register screen loads before it can sell: the store, the registers the user may use, the shop’s money format, the tax rates and the payment methods.
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. When you pass a register_id, the user must also be allowed to use that register (register access).
Request
GET https://your-site.example/wp-json/plugixa-pos/v1/register/bootstrap?register_id=1
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
register_id |
integer |
No | The register you are about to use. Its store is returned as outlet. Without it, the store of the first usable register. |
Responses
200 OK. data is the bootstrap payload.
{
"success": true,
"data": {
"outlet": {
"id": 1,
"name": "Maison Plugixa Marais",
"address": {
"address_1": "12 rue des Archives",
"city": "Paris",
"postcode": "75004",
"country": "FR",
"address_2": ""
},
"phone": "",
"email": "marais@your-site.example",
"tax_id": "FR 40 123 456 789",
"settings": [],
"status": "active",
"created_at": "2026-11-16 15:52:08",
"updated_at": "2026-11-16 15:52:08"
},
"registers": [
{
"id": 1,
"outlet_id": 1,
"code": "R1",
"name": "Front counter",
"settings": {
"favourites": [3728, 3720]
},
"status": "active",
"created_at": "2026-11-16 15:52:08",
"updated_at": "2026-11-18 10:02:48",
"outlet_name": "Maison Plugixa Marais"
}
],
"money": {
"currency": "EUR",
"symbol": "€",
"position": "right_space",
"decimals": 2,
"decimal_separator": ",",
"thousands_separator": " "
},
"taxes": {
"enabled": true,
"prices_include_tax": true,
"round_at_subtotal": false,
"rates": {
"standard": [
{
"id": 8,
"rate": "20.0000",
"label": "TVA",
"compound": false
}
],
"reduced-rate": [],
"zero-rate": []
},
"classes": [
{
"slug": "",
"name": "Standard rate"
},
{
"slug": "reduced-rate",
"name": "Reduced rate"
},
{
"slug": "zero-rate",
"name": "Zero rate"
}
]
},
"payment_methods": [
{
"id": "cash",
"type": "cash",
"label": "Cash",
"opens_drawer": true,
"allow_change": true
},
{
"id": "card",
"type": "other",
"label": "Card (terminal)",
"opens_drawer": false,
"allow_change": false
}
],
"server_time": "2026-11-19T14:05:40+00:00"
}
}
| Field | Type | Meaning |
|---|---|---|
data.outlet |
object |
The store, fields as in Get Store |
data.registers |
object[] |
Active registers the user may use, each with outlet_name |
data.money |
object |
WooCommerce currency and number format |
data.taxes |
object |
Whether taxes are on, whether prices include tax, the rates of the store’s address per tax class, and the tax classes |
data.payment_methods |
object[] |
id, type, label, opens_drawer, allow_change |
data.server_time |
string |
Server time, ISO 8601 UTC |
Pro modules add keys through the plugixa_pos_register_bootstrap filter, for example promotions, modifier_groups, receipt_template, gift_card_product_id, store_credit_product_id, fiscal_devices and customer_display, and payment methods such as adyen_terminal or foreign cash.
Errors
| Status | Code | When |
|---|---|---|
403 |
plugixa_pos_register_forbidden |
The register is missing or archived, or the user may not use it. |
409 |
plugixa_pos_no_outlet |
No active store is set up yet. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-site.example/wp-json/plugixa-pos/v1/register/bootstrap?register_id=1" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/register/bootstrap?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/register/bootstrap?register_id=1', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share