Delete Warehouse - Plugixa Inventory

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

Move a warehouse to the trash. It can be brought back with Restore Warehouse.

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.

A warehouse that still holds stock cannot be trashed: transfer or remove the stock first. With Pro, neither can a warehouse at either end of a draft transfer, or the warehouse WooCommerce sells from.

Request

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

Path parameters

Responses

200 OK. The warehouse 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 Warehouses 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/warehouses/1" \
  -u "admin:$WP_APP_PASSWORD"

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