Contents
On this page

REST API - Plugixa Extra Product Options

The plugin’s admin screens work through one REST namespace, plugixa-epo/v1. You can call the same routes yourself: to create option groups from your own system, copy groups between stores, publish a seasonal group on a date, or set the stock of an option from your warehouse software. There are 28 endpoints.

Base URL

https://your-store.example/wp-json/plugixa-epo/v1

On a site with plain permalinks, pass the route as a parameter instead:

https://your-store.example/?rest_route=/plugixa-epo/v1/groups

Products, orders and customers stay WooCommerce’s: read them with the WooCommerce REST API. An order line’s options are part of its meta_data there, under the field labels.

Authentication

The plugin has no API keys of its own. A request runs as a WordPress user.

Caller How it signs in What it reaches
A script or another server An Application Password, with HTTP Basic authentication What the user’s permissions allow
A page on the same site The login cookie plus an X-WP-Nonce header The same
A visitor Nothing Only Upload a File PRO, which the product page calls

Application Passwords

Create one under Users > Profile > Application Passwords for the WordPress user the script should act as, then send it with HTTP Basic authentication:

curl -s "https://your-store.example/wp-json/plugixa-epo/v1/groups" \
  -u "$WP_USER:$WP_APP_PASSWORD"

Application Passwords are a WordPress feature, not the plugin’s: WordPress offers them on sites served over HTTPS, and a security plugin or host can switch them off. To cut a script off, revoke its password.

The admin app uses the visitor’s login cookie and sends the REST nonce in an X-WP-Nonce header; WordPress checks the nonce before the route runs. Without the header, a cookie request is treated as signed out.

Permissions

Every route but the upload one needs the plugixa_epo_manage capability. On activation the plugin gives it to Administrators and Shop managers. Give it to another role with a role editor plugin, or in code:

get_role( 'editor' )->add_cap( 'plugixa_epo_manage' );

Uninstalling the plugin with Delete all option groups when the plugin is uninstalled on takes the capability back from every role.

Responses

A successful call answers with this envelope:

{
  "success": true,
  "data": { },
  "meta": { "total": 2 }
}

data holds the answer. meta is only there when a route has something to add, such as the number of groups. Dates are UTC, as 2026-11-21T09:14:02.

Drafts and publishing

A group has two copies: the draft you edit and the published copy customers see. Create Group and Update Group only change the draft. Publish Group checks it and makes it live. A typical script creates or updates, then publishes.

Sending a group document

When you send a group document, the plugin cleans it before saving: unknown field types are dropped, unknown price types become none, texts are sanitized and missing ids are filled in. Pro field and price types are only kept while Pro is active. Always read the group back from the response rather than assuming your copy was stored as sent.

Errors

An error answers with an HTTP status and a body like this:

{
  "code": "plugixa_epo_title_required",
  "message": "Give the group a name.",
  "data": { "status": 400 }
}

message is written for a person and is translated with the plugin. Test code in your code. Every endpoint can also return:

Status Code When
401 plugixa_epo_forbidden Not signed in
401 incorrect_password WordPress refused the Application Password
403 plugixa_epo_forbidden Signed in without the capability: You are not allowed to do that.
400 rest_invalid_param A parameter has the wrong type or form
400 rest_missing_callback_param A required parameter is missing
404 rest_no_route The route does not exist, for example a Pro route on the free plugin
500 internal_server_error A PHP error. Check the site’s error log

Endpoints

Resource Endpoints
Groups List Groups, Create Group, Get Group, Update Group, Delete Group, Publish Group, Disable Group, Duplicate Group
Lookups Find Products, Find Categories, Find Tags PRO, Find Attribute Values PRO, List Roles PRO
Settings Get Settings, Update Settings
Library PRO Export Groups, Import Groups, List Templates, Create Group from Template
Importers PRO List Import Sources, Run Import
Placement PRO Get Form Placement, Update Form Placement
Role Discounts PRO Get Role Discounts, Update Role Discounts
Stock PRO Get Option Stock, Set Option Stock
Uploads PRO Upload a File
  • Hooks reference: run your own PHP code inside WordPress, for example to add a check before publishing or change an option price.

Quick Links

Share