Purge Adjustment - Plugixa Inventory for WordPress

Purge Adjustment - Plugixa Inventory

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

Delete a draft adjustment and its lines permanently, whether or not it is in the trash. 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 adjustment. Needs Plugixa Inventory Pro with the Inventory adjustments app on in Plugixa Inventory -> App Manager; with it off, this route answers 404.

Request

DELETE https://your-site.example/wp-json/plugixa-inventory/v1/adjustments/9/purge

Path parameters

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

Responses

`200` OK. The draft and its lines are gone.

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

Errors

Status	Code	When
`404`	`plugixa_inventory_not_found`	No adjustment with that id, live or trashed.
`409`	`plugixa_inventory_document_finalized`	The document is finalized.

Plus the errors every endpoint can return.

Examples

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

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