Contents
Get Vendor Settlement - Plugixa PDF Vouchers for WooCommerce
GET /plugixa-pdf-vouchers/v1/reports/vendors
The Vendor settlement report for Dokan and WCFM marketplaces. A row “sold by A, spent at B” is money A collected for goods B delivered.
Needs a user with the plugixa_pdfv_export capability (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Administrators and shop managers get it when the plugin is activated; see Staff access.
Note. Pro only: on the free plugin this route answers
404rest_no_route.
Request
GET https://your-store.example/wp-json/plugixa-pdf-vouchers/v1/reports/vendors?from=2026-10-01&to=2026-11-20
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
from |
string |
No | YYYY-MM-DD, your store’s calendar day. Defaults to 29 days before to. |
to |
string |
No | YYYY-MM-DD, included. Defaults to today. |
Responses
200 OK.
{
"success": true,
"data": {
"from": "2026-10-01",
"to": "2026-11-20",
"sold": [
{
"vendor_id": 0,
"vendor": "Maison Willow",
"currency": "EUR",
"vouchers": 72,
"value": 4747
}
],
"settled": [
{
"seller": 0,
"redeemer": 0,
"currency": "EUR",
"amount": 2512,
"count": 81,
"seller_name": "Maison Willow",
"redeemer_name": "Maison Willow",
"cross": false
}
]
}
}
| Field | Type | Meaning |
|---|---|---|
data.sold |
object[] |
Per vendor and currency: vendor_id (0 is the marketplace itself, named after your store), vendor, currency, vouchers, value |
data.settled |
object[] |
Per seller, redeemer and currency: amount spent (net of refunds), count of redemptions, the names, and cross true when seller and redeemer differ |
The demo shop has no vendors, so everything is the store’s own. A counter redemption counts for the vendor who made it; an online one for the vendor of the order, when the order is from a single vendor.
Errors
| Status | Code | When |
|---|---|---|
401 / 403 |
plugixa_pdfv_forbidden |
The caller lacks the capability. |
400 |
rest_invalid_param |
A date is not written YYYY-MM-DD. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-store.example/wp-json/plugixa-pdf-vouchers/v1/reports/vendors?from=2026-10-01&to=2026-11-20" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-store.example/wp-json/plugixa-pdf-vouchers/v1/reports/vendors?from=2026-10-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-pdf-vouchers/v1/reports/vendors?from=2026-10-01&to=2026-11-20', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share