POST api/Order/VoidOrder

Voids a given order.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserId		integer	None.
AuthToken		string	None.
OrderId	The list of order IDs for which the user needs to retrieve the status. OrderIdList is required.	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "AuthToken": "sample string 2",
  "OrderId": 3
}

application/xml, text/xml

Sample:

<ApproveOrderRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <AuthToken>sample string 2</AuthToken>
  <OrderId>3</OrderId>
  <UserId>1</UserId>
</ApproveOrderRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

Sample not available.

application/octet-stream

Sample:

Sample not available.

Response Information

Resource Description

Response model which confirms whether order was successfully voided

VoidOrderResponseModel

Name	Description	Type	Additional information
OrderVoided		boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderVoided": true
}

application/xml, text/xml

Sample:

<VoidOrderResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <OrderVoided>true</OrderVoided>
</VoidOrderResponseModel>