Delete Recipient - Plugixa Inventory

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

Move a recipient to the trash. It can be brought back with Restore Recipient.

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

A recipient who has ever had stock checked out to them cannot be trashed: that history is part of the audit trail. Neither can one named on a draft check-out. Set status to unpublished instead.

Request

DELETE https://your-site.example/wp-json/plugixa-inventory/v1/recipients/8

Path parameters

Responses

200 OK. The recipient 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 Recipients 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/recipients/8" \
  -u "admin:$WP_APP_PASSWORD"

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