Contents
On this page

List Apps - Plugixa Multi Currency for WooCommerce

GET /plugixa-multi-currency/v1/apps

The parts of the plugin and whether each is on, as the App manager shows them. With Pro, its apps are listed too. See App manager.

Needs manage_options: a site administrator (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Switching parts of the plugin on and off is kept for administrators on purpose.

Request

GET https://your-store.example/wp-json/plugixa-multi-currency/v1/apps

Responses

200 OK.

{
  "success": true,
  "data": {
    "apps": [
      {
        "id": "rates",
        "order": 4,
        "category": "operations",
        "core": false,
        "deps": ["currencies"],
        "default": true,
        "icon": "sync",
        "label_key": "app_rates",
        "desc_key": "app_rates_desc",
        "flag": true,
        "enabled": true,
        "can_toggle": true,
        "blocker": null,
        "usage": ["Last update 19 seconds ago"]
      },
      "..."
    ],
    "categories": ["core", "operations", "insight", "configuration", "tools"]
  }
}
Field Type Meaning
apps[].id string The app’s id, for example rates
apps[].category string core, operations, insight, configuration or tools
apps[].core boolean Part of the core: always on
apps[].deps string[] Apps it needs
apps[].default boolean Whether it is on in a fresh install
apps[].enabled boolean Whether it is on now
apps[].can_toggle boolean Whether it can be switched on or off
apps[].blocker string|null Why it cannot be switched now, when something stops it
apps[].usage string[] Short lines for its card, for example Last update 19 seconds ago
apps[].order integer Its place in the grid
apps[].icon string Icon name used by the admin app
apps[].label_key string Key of its translated name in the admin app
apps[].desc_key string Key of its translated description
apps[].flag boolean Internal
categories string[] The categories, in display order

Errors

Status Code When
401 / 403 plugixa_multi_currency_forbidden The caller lacks the capability.

Plus the errors every endpoint can return.

Examples

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

Quick Links

Share