Contents
On this page

Get Loyalty Balance - Plugixa POS for WooCommerce

GET /plugixa-pos/v1/loyalty/{customer_id}

The customer’s points and what they are worth now.

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.

Request

GET https://your-site.example/wp-json/plugixa-pos/v1/loyalty/88

Path parameters

Name Type Description
customer_id integer The customer’s user id

Responses

200 OK.

{
  "success": true,
  "data": {
    "customer_id": 88,
    "points": 8657,
    "value": "86.57",
    "value_of_100": "1.00"
  }
}
Field Type Meaning
data.points integer Points held
data.value string What they are worth
data.value_of_100 string What 100 points are worth, from the loyalty_point_value setting

Errors

This endpoint has no errors of its own.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-pos/v1/loyalty/88" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/loyalty/88');
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/loyalty/88', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share