Contents
On this page

Restore Unit - Plugixa Inventory

POST /plugixa-inventory/v1/units/{id}/restore

Bring a trashed unit back.

The user needs the plugixa_inventory_delete capability (administrators have every inventory capability). With Pro Roles and permissions enforcing, their role must also allow deleting this unit. Needs Plugixa Inventory Pro with the Units of measurement app on in Plugixa Inventory -> App Manager; with it off, this route answers 404.

Request

POST https://your-site.example/wp-json/plugixa-inventory/v1/units/4/restore

Path parameters

Name Type Description
id integer The unit’s id

Responses

200 OK. The unit is live again.

{
  "success": true,
  "data": {
    "restored": true
  }
}

Errors

Status Code When
404 plugixa_inventory_not_found No unit with that id, or the unit is not in the trash.
409 plugixa_inventory_duplicate_code Another live unit now uses this unit’s code. Rename that one first.

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-inventory/v1/units/4/restore" \
  -u "admin:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-inventory/v1/units/4/restore');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const auth = 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`);
const response = await fetch('https://your-site.example/wp-json/plugixa-inventory/v1/units/4/restore', {
  method: 'POST',
  headers: { 'Authorization': auth },
});
const { data } = await response.json();

Quick Links

Share