Delete Coupon - Plugixa Car Wash for WordPress

Delete Coupon - Plugixa Car Wash

DELETE /plugixa-carwash/v1/coupons/{id}

Move a coupon to the trash. It can be restored. Bookings already made with it keep their discount.

Needs the Coupons app on, and the plugixa_carwash_delete capability.

Request

DELETE https://your-site.example/wp-json/plugixa-carwash/v1/coupons/9

Path parameters

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

Restore or delete for good

A trashed coupon stays in the database and out of every list unless you ask for view=trash. Two more routes act on it, with the same plugixa_carwash_delete capability:

Method and path	Answer	Does
`POST /plugixa-carwash/v1/coupons/{id}/restore`	`{"restored": true}`	Takes the coupon out of the trash. One that is not in the trash answers `404`. Refused with `409` `plugixa_carwash_duplicate_code` when another coupon took the code meanwhile.
`DELETE /plugixa-carwash/v1/coupons/{id}/purge`	`{"purged": true}`	Deletes the coupon for good. It does not need the coupon to be in the trash first, and it skips the in-use checks of the trash route: a live coupon that other records depend on is deleted at once.

Responses

`200` OK. The coupon is in the trash.

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

Field	Type	Meaning
`data.trashed`	`boolean`	Always `true`

Errors

Status	Code	When
`404`	`plugixa_carwash_not_found`	No coupon with that id, or it is already in the trash.

Plus the errors every endpoint can return.

Examples

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

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/coupons/9');
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 = Buffer.from(`admin:${process.env.WP_APP_PASSWORD}`).toString('base64');
const response = await fetch('https://your-site.example/wp-json/plugixa-carwash/v1/coupons/9', {
  method: 'DELETE',
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data } = await response.json();