Delete Unit - Plugixa Inventory

DELETE /plugixa-inventory/v1/units/{id}

Move a unit to the trash. It can be brought back with Restore Unit.

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.

A unit that other live units convert through cannot be trashed: point them at another base unit first.

Request

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

Path parameters

Responses

200 OK. The unit is in the trash.

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

From now on it is left out of lists and single reads, and appears in List Units with view=trash.

Errors

Plus the errors every endpoint can return.

Examples

curl -s -X DELETE "https://your-site.example/wp-json/plugixa-inventory/v1/units/4" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-inventory/v1/units/4');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'DELETE',
    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', {
  method: 'DELETE',
  headers: { 'Authorization': auth },
});
const { data } = await response.json();