POST api/DeleteOrdersInAggregation_V1

Delete All orders that are aggregated by aggregation key

Request Information

URI Parameters

None.

Body Parameters

The request is presented below!

WS_Repository.Models.Requests.OrderAggregation.DeleteOrdersInAggregationRequest

Name	Description	Type	Additional information
WS_Key	(Mandatory) Webservice Key provided by 2ship support	string	None.
AggregationKey	(Mandatory) AggregationKey returned by AggregateOrders function	string	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1",
  "AggregationKey": "sample string 2"
}

application/xml, text/xml

Sample:

<DeleteOrdersInAggregationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.OrderAggregation">
  <AggregationKey>sample string 2</AggregationKey>
  <WS_Key>sample string 1</WS_Key>
</DeleteOrdersInAggregationRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'WS_Repository.Models.Requests.OrderAggregation.DeleteOrdersInAggregationRequest'.

Response Information

Resource Description

WS_Repository.Models.Responses.OrderAggregation.DeleteOrdersInAggregationResponse

Name	Description	Type	Additional information
Success	Flag that specify if the delete was done	boolean	None.
Message	The Message when the Success = false	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<DeleteOrdersInAggregationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.OrderAggregation">
  <Message>sample string 2</Message>
  <Success>true</Success>
</DeleteOrdersInAggregationResponse>