Contents
On this page

List Store Credit - Plugixa POS for WooCommerce

GET /plugixa-pos/v1/store-credit

Customers with a store credit balance, or customers matching a search.

Needs a user with the plugixa_pos_manage_settings 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/store-credit?per_page=1

Query parameters

Field Type Required Description
search string No Name or email.
page integer No Page to return, from 1. Defaults to 1.
per_page integer No Rows per page, 1 to 100. Defaults to 25.

Responses

200 OK.

{
  "success": true,
  "data": [
    {
      "customer_id": 88,
      "name": "Camille Martin",
      "email": "camille.martin@example.com",
      "balance": "25.00"
    }
  ],
  "meta": {
    "total": 2,
    "pages": 2
  }
}
Field Type Meaning
meta.total integer Rows matching the filters
meta.pages integer Pages at this per_page

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

Quick Links

Share