Contents
On this page

REST API - Plugixa Multi Currency for WooCommerce

The plugin’s admin screens, its switchers and the Pro cache-first mode all work through one REST namespace, plugixa-multi-currency/v1. You can call the same routes yourself: to set rates from your own system, read revenue by currency into a dashboard, or copy a setup from one store to another. Every permission the screens enforce is checked again at the endpoint.

This reference lists 50 endpoints. Routes marked PRO exist only when Pro is installed and its app is on; otherwise they answer 404 rest_no_route.

Base URL

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

On a site with plain permalinks, pass the route as a parameter instead:

https://your-store.example/?rest_route=/plugixa-multi-currency/v1/currencies

Products, orders and customers stay WooCommerce’s: read them with the WooCommerce REST API. The routes below add what WooCommerce does not know: your currencies, their rates and the Pro features.

Authentication

The plugin has no API keys of its own. A request runs as a WordPress user.

Caller How it signs in What it reaches
A script or another server An Application Password, with HTTP Basic authentication What the user’s capabilities allow
A page on the same site The login cookie plus an X-WP-Nonce header The same
A visitor Nothing The public routes: Switch Shopper Currency and Get Product Prices PRO

Application Passwords

Create one under Users > Profile > Application Passwords for the WordPress user the script should act as, then send it with HTTP Basic authentication:

curl -s "https://your-store.example/wp-json/plugixa-multi-currency/v1/currencies" \
  -u "$WP_USER:$WP_APP_PASSWORD"

Application Passwords are a WordPress feature, not the plugin’s: WordPress offers them on sites served over HTTPS, and a security plugin or host can switch them off. To cut a script off, revoke its password.

The admin app uses the visitor’s login cookie and sends the REST nonce in an X-WP-Nonce header; WordPress checks the nonce before the route runs. Without the header, a cookie request is treated as signed out.

Public routes

Switch Shopper Currency and Get Product Prices PRO are open to anyone, so they protect themselves: they accept only enabled currencies, and each visitor address has a limit per hour (120 switches, 600 price requests). The address is kept only as a hash, for an hour. The plugixa_multi_currency_public_request_captcha filter lets you add a CAPTCHA check to both, and behind a proxy the plugixa_multi_currency_client_ip filter lets you give the real visitor address.

Capabilities

Each route checks a capability. They are ordinary WordPress capabilities: the plugin gives all of them to administrators when it is activated, and any role editor can grant them to other roles. A user with manage_options always holds every one.

Capability Allows
plugixa_multi_currency_view Reading currencies, rates, conversions, settings, reports PRO and currency rules PRO
plugixa_multi_currency_manage_settings Changing currencies, rates and settings, and every Pro settings route
plugixa_multi_currency_export The order export PRO, with WooCommerce’s view_woocommerce_reports

Two groups ask for more. The App manager routes need manage_options. The Pro fixed price routes also need WooCommerce’s edit_products, because they change products. Changing delete_data_on_uninstall with Update Settings also needs manage_options. Each endpoint page names what it needs.

Responses

Successful responses are wrapped the same way:

{
  "success": true,
  "data": { "code": "EUR", "rate": "0.9099181073", "margin_pct": "1" },
  "meta": { "total": 8, "pages": 1, "base": "USD" }
}

meta is only present when it has something in it. The CSV exports PRO come as text inside data, with a file name to save it under.

Rates, margins and amounts are strings with a dot for decimals ("0.9099181073", "45.86"), so no precision is lost on the way. A rate is the number of units of the currency for 1 unit of your WooCommerce store currency. Amounts you send may be strings or numbers.

Dates of the plugin’s records are UTC, written 2026-11-20 16:20:17. The rate update status uses ISO 8601 (2026-11-20T16:20:17+00:00). The report and export routes take and return your site’s calendar days.

Lists and pagination

List Currencies takes page and per_page and gives meta.total and meta.pages. List Fixed Prices PRO takes page and gives total and pages inside data. Other lists return everything at once.

Saving settings

The settings routes, /settings and each Pro feature’s, save only the keys you send and answer with the whole setting as saved. A value that is not valid is dropped or set back to its default rather than refused, so read the answer to see what was kept.

After a change

Every change to a currency rebuilds the list the shop reads, so the next page uses the new rate. A page cache may still serve pages saved before: see Page caching.

Errors

An error answers with an HTTP status and a body like this:

{
  "code": "plugixa_multi_currency_invalid_rate",
  "message": "The exchange rate must be more than zero.",
  "data": { "status": 400, "field": "rate" }
}

message is written for a person and is translated with the plugin. Test code in your code. Errors about one field name it in data.field. Every endpoint can also return:

Status Code When
401 plugixa_multi_currency_forbidden Not signed in
401 incorrect_password WordPress refused the Application Password
403 plugixa_multi_currency_forbidden Signed in without the capability: You are not allowed to do that.
401 / 403 rest_forbidden The same, on the rate routes and most Pro routes, which leave the check to WordPress: Sorry, you are not allowed to do that.
400 rest_invalid_param A parameter has the wrong type or form
400 rest_missing_callback_param A required parameter is missing
404 rest_no_route The route does not exist, for example a Pro route on the free plugin
500 internal_server_error A PHP error. Check the site’s error log

Endpoints

Resource Endpoints
Currencies List Currencies, Add Currency, Get Currency, Update Currency, Remove Currency, Reorder Currencies, List Supported Currencies, Convert Amount
Exchange rates Update Rates Now, Rate History, Rate Update Status
Settings Get Settings, Update Settings
Apps List Apps, Switch App On or Off
Storefront Switch Shopper Currency, Get Product Prices PRO
Currency rules PRO Get Currency Rules, Update Currency Rules, List Payment Methods
Rate providers PRO List Rate Providers, Update Rate Providers, Test Rate Provider
Rate alerts PRO Get Rate Alerts, Update Rate Alerts, Apply Held Rate, Dismiss Held Rate
Fixed prices PRO List Fixed Prices, Save Fixed Prices, Export Fixed Prices, Import Fixed Prices
Country detection PRO Get Detection Settings, Update Detection Settings, Get Geolocation Source
Currency URLs PRO Get Currency URLs, Update Currency URLs
Google Merchant feed PRO Get Merchant Feed, Update Merchant Feed
Price in other currencies PRO Get Other Price Display, Update Other Price Display
Prices by user role PRO Get Role Prices, Update Role Prices
Reports PRO Revenue Summary, Currency Statistics, Export Orders, Resync WooCommerce Analytics
Caching PRO Run Cache Diagnostics, Apply Cache Preset
Settings backup PRO Export Settings, Import Settings

Not covered here

The plugin registers one more route for its own screens: the admin app’s start data (/bootstrap). It may change between versions without notice: do not build on it.

  • Hooks: run your own PHP code inside WordPress, for example to change a converted price or the visitor’s currency.
  • WP-CLI PRO: the same tasks from the command line.

Quick Links

Share