GET api/ShippingLabels/Void?OrderId={OrderId}

Voids all shipping labels on an order. Requires OrderId from api/ShippingLabels/Print.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrderId

The order to void.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

VoidShippingLabel_Response
NameDescriptionTypeAdditional information
IsSuccess

Indicates if the label voided successfully.

 boolean

None.
Message

If there was an error, this is where it will be displayed.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsSuccess": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<ShippingController.VoidShippingLabel_Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCAPI2.Controllers">
  <IsSuccess>true</IsSuccess>
  <Message>sample string 2</Message>
</ShippingController.VoidShippingLabel_Response>