Restore Transfer - Plugixa Inventory for WordPress

Restore Transfer - Plugixa Inventory

POST /plugixa-inventory/v1/transfers/{id}/restore

Bring a trashed draft transfer back.

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 transfer. Needs Plugixa Inventory Pro with the Warehouse transfers app on in Plugixa Inventory -> App Manager; with it off, this route answers 404.

Request

POST https://your-site.example/wp-json/plugixa-inventory/v1/transfers/12/restore

Path parameters

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

Responses

`200` OK. The draft is live again, with its lines.

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

Errors

Status	Code	When
`404`	`plugixa_inventory_not_found`	No transfer with that id, or it is not in the trash.

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-inventory/v1/transfers/12/restore" \
  -u "admin:$WP_APP_PASSWORD"

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