Contents
On this page

Export Orders - Plugixa Multi Currency for WooCommerce

GET /plugixa-multi-currency/v1/pro/orders/export

Orders of a period with their amounts in the order currency and in your store currency, for your accountant. See Order export.

Needs a user with the plugixa_multi_currency_export capability (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Administrators hold it; see Capabilities. The user also needs WooCommerce’s view_woocommerce_reports.

Note. Pro only: on the free plugin this route answers 404 rest_no_route.

Request

GET https://your-store.example/wp-json/plugixa-multi-currency/v1/pro/orders/export?from=2026-11-01&to=2026-11-20

Query parameters

Field Type Required Description
from string Yes First day, YYYY-MM-DD, in your site’s time zone.
to string Yes Last day, included. At most one year after from.
statuses string[] No Order statuses without the wc- prefix. Defaults to completed, processing, on-hold, refunded. Send it as statuses[]=completed&statuses[]=refunded.

Responses

200 OK. The CSV comes as text inside the JSON.

{
  "success": true,
  "data": {
    "filename": "orders-2026-11-01-to-2026-11-20.csv",
    "csv": "order_id,order_number,date,status,billing_country,currency,total,tax,shipping,discount,refunded,rate,store_currency,total_store,tax_store,shipping_store,discount_store,refunded_store\n858,858,\"2026-11-01 06:16:48\",completed,CA,CAD,100.24,0,9.62,0,0,1.3942,USD,71.90,0.00,6.90,0.00,0.00\n850,850,\"2026-11-02 13:59:38\",completed,GB,GBP,17.45,0,5.5,0,0,0.796991,USD,21.89,0.00,6.90,0.00,0.00\n...",
    "rows": 62
  }
}
Field Type Meaning
filename string A file name with the period
csv string One line per order, oldest first. rate is the factor the order was converted with, margin included; the _store columns are the amounts in the store currency
rows integer Orders in the file

Store-currency amounts are those saved at checkout. For an order without them, they are worked out from the saved factor. The response is sent with Cache-Control: no-store, private.

Errors

Status Code When
401 / 403 rest_forbidden The caller lacks the capability: Sorry, you are not allowed to do that.
400 plugixa_multi_currency_bad_range Pick a start date before the end date. or Export at most one year at a time.
400 plugixa_multi_currency_bad_status No known status left: Pick at least one order status.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-store.example/wp-json/plugixa-multi-currency/v1/pro/orders/export?from=2026-11-01&to=2026-11-20" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-store.example/wp-json/plugixa-multi-currency/v1/pro/orders/export?from=2026-11-01&to=2026-11-20');
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/pro/orders/export?from=2026-11-01&to=2026-11-20', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();
// data.csv is the file, data.rows the number of orders

Quick Links

Share