Contents
On this page

Get Role Discounts - Plugixa Extra Product Options

GET /plugixa-epo/v1/role-discounts

The percent off option prices for each role, and the site’s roles. See Discounts by role.

Needs a user with the plugixa_epo_manage capability (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Administrators and shop managers hold it; see Permissions. Pro only: on the free plugin this route answers 404 rest_no_route.

Request

GET https://your-store.example/wp-json/plugixa-epo/v1/role-discounts

Responses

200 OK.

{
  "success": true,
  "data": {
    "discounts": {
      "wholesale_customer": 20
    },
    "roles": [
      {
        "id": "administrator",
        "label": "Administrator"
      },
      {
        "id": "customer",
        "label": "Customer"
      },
      {
        "id": "shop_manager",
        "label": "Shop manager"
      },
      {
        "id": "wholesale_customer",
        "label": "Wholesale customer"
      }
    ]
  }
}
Field Type Meaning
discounts object Role slug => percent off, 0 to 100. Roles without a discount are left out; {} for none
roles array Every role of the site, each { id, label }

Errors

Status Code When
401 / 403 plugixa_epo_forbidden The caller lacks the capability: You are not allowed to do that.

Plus the errors every endpoint can return.

Examples

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

Quick Links

Share