Delete an item from a Web Order

Use this method to delete an item from a Web Order.

Valid Tokens: Customer and User.


Related Articles

Request


URL: https://api.kometsales.com/api/web-order-item.delete

Method: POST

Content-Type: application/JSON


Headers

X-ACCOUNT (required)(integer:20)

Company ID that is 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.

Use this parameter to search orders from a specific Customer.

You can get this value from the customer.list API method.


webOrderId (required)(integer:20)

Komet Sales internal Web Order ID.


webOrderItemId (required)(integer:20)

Komet Sales internal Web Order Item ID.


webOrderItemType (required)(integer:1)  

Item source.

Valid values: 0 = Invoice | 1 = Prebook


{ "customerId": "7349", "webOrderId": "47", "webOrderItemId": "928330", "webOrderItemType": "1" }

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


webOrderItemId (integer)

Komet Sales internal Web Order Item ID.


{ "message": "The Web Order item was successfully deleted.", "webOrderId": "47", "status": "1", "webOrderItemId": "928330" }
Peacock