Contents
Find Categories - Plugixa Extra Product Options
GET /plugixa-epo/v1/lookup/categories
Product categories by name, to pick in a group’s targets.categories. Empty categories included, sorted by name, 30 at most.
Needs a user with the plugixa_epo_manage capability (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Administrators and shop managers hold it; see Permissions.
Request
GET https://your-store.example/wp-json/plugixa-epo/v1/lookup/categories?search=gift
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
search |
string |
No | Part of a name. |
include |
string |
No | Comma-separated ids to read, for example 21,34. Used instead of search. |
Responses
200 OK.
{
"success": true,
"data": [
{
"id": 21,
"label": "Gifts",
"count": 18
},
{
"id": 34,
"label": "Gift cards",
"count": 3
}
]
}
| Field | Type | Meaning |
|---|---|---|
id |
integer |
Category id |
label |
string |
Category name |
count |
integer |
Products in it |
Errors
| Status | Code | When |
|---|---|---|
401 / 403 |
plugixa_epo_forbidden |
The caller lacks the capability: You are not allowed to do that. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-store.example/wp-json/plugixa-epo/v1/lookup/categories?search=gift" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-store.example/wp-json/plugixa-epo/v1/lookup/categories?search=gift');
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-epo/v1/lookup/categories?search=gift', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share