/pricelist/{priceListId}/delete v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Price Lists
priceListIdDelete
Code samples
const headers = {
Accept: "application/json",
};
fetch("https://goldleaf.app/api/v1/pricelist/{priceListId}/delete", {
method: "POST",
headers: headers,
})
.then(function (res) {
return res.json();
})
.then(function (body) {
console.log(body);
});
POST /pricelist/{priceListId}/delete
Mark a price list as deleted
Updates flags and fields to mark the specified price list as deleted. Requires admin role.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| priceListId | path | string(mongoId) | true | ID of the price list to delete |
Example responses
200 Response
{
"type": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Price list successfully marked as deleted | string |
| 500 | Internal Server Error | Internal server error | string |
