Contents
On this page

Get Promotion Options - Plugixa POS for WooCommerce

GET /plugixa-pos/v1/promotions/options

The roles and categories a promotion can be limited to.

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/promotions/options

Responses

200 OK.

{
  "success": true,
  "data": {
    "roles": [
      {
        "slug": "customer",
        "name": "Customer"
      },
      {
        "slug": "shop_manager",
        "name": "Shop manager"
      }
    ],
    "categories": [
      {
        "id": 126,
        "name": "Accessories"
      },
      {
        "id": 123,
        "name": "Candles"
      }
    ]
  }
}

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

Quick Links

Share