Contents
On this page
Read Display State - Plugixa POS for WooCommerce
GET /plugixa-pos/v1/customer-display/{code}
The display screen polls this with its code. No sign-in: the code is the credential.
Public: no sign-in. The route checks its own credential instead, described below. The 8-character pairing code identifies the register. Calls are limited to 240 a minute per address.
Request
GET https://your-site.example/wp-json/plugixa-pos/v1/customer-display/K7MP2QXR?since=41
Path parameters
| Name | Type | Description |
|---|---|---|
code |
string |
The pairing code from Pair Customer Display |
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
since |
integer |
No | The last version you have. When nothing changed, only version and unchanged: true come back. |
Responses
200 OK. Sent with Cache-Control: no-store.
{
"success": true,
"data": {
"version": 42,
"state": {
"status": "cart",
"lines": [
{
"name": "Canvas tote - Natural",
"detail": "",
"qty": 1,
"total": "25,00 €"
}
],
"store": "Maison Plugixa Marais",
"total": "25,00 €"
}
}
}
Errors
| Status | Code | When |
|---|---|---|
404 |
plugixa_pos_not_found |
The code is not valid: pair the display again. |
429 |
plugixa_pos_rate_limited |
Too many calls from one address. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-site.example/wp-json/plugixa-pos/v1/customer-display/K7MP2QXR?since=41"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/customer-display/K7MP2QXR?since=41');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-pos/v1/customer-display/K7MP2QXR?since=41');
const { data } = await response.json();
Quick Links
Share