| Excerpt | ||
|---|---|---|
Use this method to delete Web Orders.
|
Web Orders may contain items coming from Prebooks or Purchase Orders, there are two possible scenarios:
Prebooks. The system will remove the items from the Prebook but will not delete the Prebook.
Purchase Orders. The system will remove the items and void the order. However, if the order contains items from different Web Orders or items added through another method, the system will not void the whole order.
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Request
URL: https://api.kometsales.com/api/web-order.delete
Method: POST
Content-Type: application/JSON
Headers
X-ACCOUNT (required)(integer:20)
Company ID from the Company using the API.
Please ask the Komet Sales team to get this ID.
authenticationToken (required)(string:50)
Komet Sales security token.
Input parameters
customerId (required)(integer:20)
Customer ID.
You can get this value from the customer.list API method.
webOrderId (required)(integer:20)
Komet Sales internal Web Order ID.
| Code Block |
|---|
{
"customerId": "738",
"webOrderId": "47"
} |
Response
message (string)
Transaction status description.
webOrderId (integer)
Komet Sales internal Web Order ID.
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
| Code Block |
|---|
{
"message": "The Web Order was successfully canceled.",
"webOrderId": "47",
"status": "1"
} |