Contents
On this page

Find Attribute Values - Plugixa Extra Product Options

GET /plugixa-epo/v1/lookup/attributes

Values of your global attributes (Products > Attributes), to pick in a group’s targets.attributes. The label names the attribute, so two attributes with a Large value can be told apart. 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. Pro only: on the free plugin this route answers 404 rest_no_route.

Request

GET https://your-store.example/wp-json/plugixa-epo/v1/lookup/attributes?search=red

Query parameters

Field Type Required Description
search string No Part of a name.
include string No Comma-separated ids to read, for example 17,25. Used instead of search.

Responses

200 OK.

{
  "success": true,
  "data": [
    {
      "id": 25,
      "label": "Color: Red",
      "count": 9
    },
    {
      "id": 31,
      "label": "Glaze: Red clay",
      "count": 4
    }
  ]
}
Field Type Meaning
id integer Term id
label string Attribute and value
count integer Products with 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/attributes?search=red" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-store.example/wp-json/plugixa-epo/v1/lookup/attributes?search=red');
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/attributes?search=red', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share