Overview

This method allows deleting an item from a Web Order. Keep in mind that this method only works with user's tokens.

Request

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

  • Method: POST
  • Content-Type: application/json

Headers

  • X-SALES-CHANNEL (optional) (string: 20): Valid values: "WEB_APP", "MOBILE_APP", "K2K" , "ECOMMERCE_LITE". 
  • X-ACCOUNT (required)(integer:20): Company ID that is using the API. Please ask Komet Sales team to have this ID. 
  • authenticationToken (required)(string:50): Komet Sales security token.


Input parameters:

  • customerId (required)(integer:20): customer ID, used to search orders from only one customer. You can obtain this value from the customer.list API method.
  • webOrderId (required)(integer:20): the ID of the Web Order that you want to update on Komet Sales.
  • webOrderItemId (required)(integer:20): the ID of the Web Order item that you want to delete on Komet Sales.
  • webOrderItemType (required)(integer:1):  0 if it's an invoice item (invoice), 1 if it's a prebook item. 

 

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

Response

Output:

    • message (String): description of the transaction status.
    • webOrderId: the ID of the Web Order created on Komet Sales.
    • status (integer:1): transaction status. 1 for success or 0 for failure.
    • webOrderItemId: the ID of the Web Order item created on Komet Sales.

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