Purge Warehouse - Plugixa Inventory

DELETE /plugixa-inventory/v1/warehouses/{id}/purge

Delete a warehouse permanently. This cannot be undone.

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 warehouse.

Note. Purging does not ask whether the warehouse still holds stock, and it works on a live warehouse as well as a trashed one. The checks that stop Delete Warehouse do not run here. Trash first, and purge only warehouses that never held stock.

Request

DELETE https://your-site.example/wp-json/plugixa-inventory/v1/warehouses/1/purge

Path parameters

Responses

200 OK. The warehouse is gone.

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

Errors

Plus the errors every endpoint can return.

Examples

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

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