Contents
On this page

Pair Customer Display - Plugixa POS for WooCommerce

POST /plugixa-pos/v1/customer-display/pair

The 8-character code and the address to open on the customer-facing screen. The same code is returned until you ask for a new one.

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/customer-display/pair

Request body

Content type: application/json

Field Type Required Description
register_id integer Yes The register.
renew boolean No Make a new code; the old one stops working.
{
  "register_id": 1
}

Responses

200 OK.

{
  "success": true,
  "data": {
    "code": "K7MP2QXR",
    "url": "https://your-site.example/?plugixa_pos_display=K7MP2QXR"
  }
}

Errors

Status Code When
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 -X POST "https://your-site.example/wp-json/plugixa-pos/v1/customer-display/pair" \
  -u "$WP_USER:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"register_id":1}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/customer-display/pair');
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,
    ]),
]);
$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/pair', {
  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 }),
});
const { data } = await response.json();

Quick Links

Share