Cancel an Order

cancel an order

POST https://wms.eshopbox.com/api/cancel-order

This endpoint will cancel an order.

Headers

Name	Type	Description
Authentication	string	Bearer token to access the API.

Request Body

Name	Type	Description
items	array	List of items to be cancelled (R)
cancellationTime	string	Time at which the order is cancelled. eg: 2020-03-02 12:00:05
reason	string	reason for cancellation of order (R)
customerOrderNumber	string	Unique identifier against each sales channel (R)
externalChannelID	string	Sales channel name of the client (R)

200 cancel request placed successfully

{
    "status": "SUCCESS",
    "result": {
        "customerOrderNumber": "41007212",
        "reason": "Cancelled By Customer",
        "cancellationTime": "2018-07-08 22:00:05",
        "items": [
            {
                "lineItemSequenceNumber": 2331,
                "itemID": "5050406281126",
                "quantity": 1,
                "productName": "Chinley Walk",
                "remark": "cancelled by customer"
            }
        ]
    }
}

curl -X POST http://wms.eshopbox.com/api/cancel-order \
-H "Authorization: Bearer XXXX" \
    -H "Content-Type: application/json" \
    -d $'{
    "externalChannelID":"TATA CLIQ VELOCY KAPAS KRAFT",
		"customerOrderNumber":"41007212",
		"actor": "[e-mail]"
		"reason":"Cancelled By Customer",
		"cancellationTime": "2018-07-08 22:00:05",
		"items": 
		[
  		{
  				"lineItemSequenceNumber": 2331,
  				"itemID": "5050406281126",
  				"quantity": 1,
  				"productName": "Chinley Walk",
  				"remark" :"cancelled by customer"
      
  		}
	]
}