Purge Recipient - Plugixa Inventory for WordPress

Purge Recipient - Plugixa Inventory

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

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

Note. Purging does not ask whether the recipient has stock history, and it works on a live recipient as well as a trashed one. The checks that stop Delete Recipient do not run here. The ledger keeps the name it recorded.

Request

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

Path parameters

Name	Type	Description
`id`	`integer`	The recipient’s id

Responses

`200` OK. The recipient is gone.

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

Errors

Status	Code	When
`404`	`plugixa_inventory_not_found`	No recipient with that id, live or trashed.

Plus the errors every endpoint can return.

Examples

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

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