Contents
On this page
Get Group - Plugixa Extra Product Options
GET /plugixa-epo/v1/groups/{id}
One group in full: both its draft and its published copy.
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/groups/7
Path parameters
| Name | Type | Description |
|---|---|---|
id |
integer |
The group’s id |
Responses
200 OK.
{
"success": true,
"data": {
"id": 7,
"title": "Gift options",
"status": "published",
"priority": 10,
"draft": {
"version": 1,
"fields": [
{
"id": "fk3q8x2ma",
"type": "radio",
"label": "Gift wrap",
"description": "",
"placeholder": "",
"required": true,
"default": "ow1n5d2kq",
"price_type": "none",
"price": 0,
"min": null,
"max": null,
"step": null,
"maxlength": null,
"options": [
{
"id": "ow1n5d2kq",
"label": "No wrapping",
"price_type": "none",
"price": 0,
"meta": []
},
{
"id": "op7r2v9tc",
"label": "Gift wrap",
"price_type": "flat",
"price": 4,
"meta": []
}
],
"logic": {
"enabled": false,
"action": "show",
"match": "all",
"rules": []
},
"meta": []
},
{
"id": "fm9d4c7wb",
"type": "textarea",
"label": "Card message",
"description": "Printed on a card in the box.",
"placeholder": "Happy birthday, Emma!",
"required": false,
"default": "",
"price_type": "none",
"price": 0,
"min": null,
"max": null,
"step": null,
"maxlength": 200,
"options": [],
"logic": {
"enabled": true,
"action": "show",
"match": "all",
"rules": [
{
"field": "fk3q8x2ma",
"op": "equals",
"value": "op7r2v9tc"
}
]
},
"meta": []
},
{
"id": "fd2h6t1ys",
"type": "date",
"label": "Deliver on",
"description": "Leave empty for the first available day.",
"placeholder": "",
"required": false,
"default": "",
"price_type": "none",
"price": 0,
"min": null,
"max": null,
"step": null,
"maxlength": null,
"options": [],
"logic": {
"enabled": false,
"action": "show",
"match": "all",
"rules": []
},
"meta": []
}
],
"targets": {
"all": false,
"products": [],
"categories": [21]
}
},
"published": {
"version": 1,
"fields": [
{
"id": "fk3q8x2ma",
"type": "radio",
"label": "Gift wrap",
"description": "",
"placeholder": "",
"required": true,
"default": "ow1n5d2kq",
"price_type": "none",
"price": 0,
"min": null,
"max": null,
"step": null,
"maxlength": null,
"options": [
{
"id": "ow1n5d2kq",
"label": "No wrapping",
"price_type": "none",
"price": 0,
"meta": []
},
{
"id": "op7r2v9tc",
"label": "Gift wrap",
"price_type": "flat",
"price": 4,
"meta": []
}
],
"logic": {
"enabled": false,
"action": "show",
"match": "all",
"rules": []
},
"meta": []
},
{
"id": "fm9d4c7wb",
"type": "textarea",
"label": "Card message",
"description": "Printed on a card in the box.",
"placeholder": "Happy birthday, Emma!",
"required": false,
"default": "",
"price_type": "none",
"price": 0,
"min": null,
"max": null,
"step": null,
"maxlength": 200,
"options": [],
"logic": {
"enabled": true,
"action": "show",
"match": "all",
"rules": [
{
"field": "fk3q8x2ma",
"op": "equals",
"value": "op7r2v9tc"
}
]
},
"meta": []
},
{
"id": "fd2h6t1ys",
"type": "date",
"label": "Deliver on",
"description": "Leave empty for the first available day.",
"placeholder": "",
"required": false,
"default": "",
"price_type": "none",
"price": 0,
"min": null,
"max": null,
"step": null,
"maxlength": null,
"options": [],
"logic": {
"enabled": false,
"action": "show",
"match": "all",
"rules": []
},
"meta": []
}
],
"targets": {
"all": false,
"products": [],
"categories": [21]
}
},
"dirty": false,
"published_at": "2026-11-21T09:14:02",
"created_at": "2026-11-20T16:41:37",
"modified_at": "2026-11-21T09:14:02"
}
}
| Field | Type | Meaning |
|---|---|---|
id |
integer |
The group’s id |
title |
string |
The group’s name. Only staff see it |
status |
string |
draft (never published), published or disabled |
priority |
integer |
The group’s place when several show on one product: lower comes first |
draft |
object |
The editable copy of the group: a group document, see below |
published |
object |
The copy customers see, or null while the group was never published |
dirty |
boolean |
true when the draft has changes that are not published yet |
published_at |
string |
When it was last published, UTC, or null |
created_at |
string |
UTC |
modified_at |
string |
When it was last saved, UTC |
The group document
draft and published share this shape.
| Field | Type | Meaning |
|---|---|---|
version |
integer |
The document format, 1 |
fields |
array |
The fields, in the order customers see them: see Field below |
targets.all |
boolean |
Shows on every product |
targets.products |
integer[] |
Product ids |
targets.categories |
integer[] |
Product category ids. A category includes its sub-categories |
targets.tags, targets.attributes |
integer[] |
Pro. Product tag ids and attribute term ids |
targets.exclude_products, targets.exclude_categories |
integer[] |
Pro. Never shown on these, whatever else matches |
targets.roles |
string[] |
Pro. Only for these role slugs; guest is a visitor who is not signed in. Empty: everyone |
layout |
string |
Pro. list, steps or tabs |
Field
| Field | Type | Meaning |
|---|---|---|
id |
string |
The field’s id, letters, digits, _ and -, up to 32. Rules and formulas refer to it |
type |
string |
text, textarea, number, select, radio, checkbox, heading, date, email, tel or url. Pro adds upload, time, color, range, calculated and repeater |
label |
string |
Shown on the product page, in the cart and on the order |
description |
string |
Help text under the field. Simple HTML |
placeholder |
string |
Sample text in an empty box; for select, the text of the empty first line |
required |
boolean |
Customers must fill it in. Always false for heading |
default |
string |
Filled in when the page opens. For select and radio, a choice id |
price_type |
string |
none, flat or percent for fields without choices (choice fields price per option). Pro adds formula, lookup, per_char, per_unit and once |
price |
number |
The amount, or the percentage for percent |
min, max |
number |
For number: the limits. For checkbox: how many choices must and may be ticked. null for none |
step |
number |
Pro. The step of a number or range field, null for none |
maxlength |
integer |
For text and textarea: the most characters accepted, null for none |
options |
array |
For select, radio and checkbox: each { id, label, price_type, price, meta }. Option price types: none, flat, percent; Pro adds once and product |
logic |
object |
Show/hide rules: enabled, action (show or hide), match (all or any) and rules, each { field, op, value }. op is equals, not_equals, contains, empty, not_empty, gt or lt; field is another field’s id or, in Pro, @quantity, @role or @attr_<attribute> |
meta |
object |
Settings of Pro features (sale price, swatches, upload limits, formula and so on). An empty list when there are none |
Errors
| Status | Code | When |
|---|---|---|
401 / 403 |
plugixa_epo_forbidden |
The caller lacks the capability: You are not allowed to do that. |
404 |
plugixa_epo_not_found |
No group has this id: Not found. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-store.example/wp-json/plugixa-epo/v1/groups/7" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-store.example/wp-json/plugixa-epo/v1/groups/7');
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/groups/7', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share