Megaventory API v2017a

<back to all web services

SalesOrderCancel

Cancels a sales orderUses your API Key, the Number of the sales order you want to cancel (mvSalesOrderNoToCancel) and cancels the specified sales order if its status is Pending or Verified. Optionally, you can use mvInsertUpdateDeleteSourceApplication when an external application ( eg Magento ) is the one that triggers the SalesOrderCancel call.

Examples:



A.

Cancel a sales order. First use The SalesOrderGet to find the Sales Order number

Value: 

{
   "mvSalesOrderNoToCancel": "83",
   "mvInsertUpdateDeleteSourceApplication": "WooCommerce"
}


Response: 

{
   "result": true,
   "ResponseStatus": {
      "ErrorCode": "0"
   }
}

B.

Trying to cancel an order that is Closed.

Value: 

{
   "mvSalesOrderNoToCancel": 19,
   "mvInsertUpdateDeleteSourceApplication": "Magento"
}


Response: 

 {
   "result": false,
   "ResponseStatus": {
      "ErrorCode": "500",
      "Message": "A Sales Order can only be Cancelled when the SalesOrderStatus is Pending or Verified. Sales Order Cancel Failed"
   },
   "InternalErrorCode": ""
}

To override the Content-type in your clients HTTP Accept Header, append the .soap12 suffix or ?format=soap12

HTTP + SOAP12

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap12 HTTP/1.1 
Host: api.megaventory.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<SalesOrderCancel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <APIKEY>String</APIKEY>
  <mvSalesOrderNoToCancel>String</mvSalesOrderNoToCancel>
  <mvSalesOrderTypeId>0</mvSalesOrderTypeId>
  <mvInsertUpdateDeleteSourceApplication>String</mvInsertUpdateDeleteSourceApplication>
</SalesOrderCancel>

    </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<SalesOrderCancelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <result>false</result>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <InternalErrorCode>String</InternalErrorCode>
</SalesOrderCancelResponse>

    </soap12:Body>
</soap12:Envelope>