POST api/OrderManagement/CancelShipment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
businessId	integer	None.
userId	integer	None.
shipmentId	string	None.
pickListId	string	None.
cancelOrders	boolean	None.
cancelReason	string	None.

Request Formats

application/json, text/json

Sample:

{
  "businessId": 1,
  "userId": 2,
  "shipmentId": "sample string 3",
  "pickListId": "sample string 4",
  "cancelOrders": true,
  "cancelReason": "sample string 6"
}

application/xml, text/xml

Sample:

<CancelShipmentRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <businessId>1</businessId>
  <userId>2</userId>
  <shipmentId>sample string 3</shipmentId>
  <pickListId>sample string 4</pickListId>
  <cancelOrders>true</cancelOrders>
  <cancelReason>sample string 6</cancelReason>
</CancelShipmentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/12/16 08:35:55",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StatusCode>1</StatusCode>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
</VCAPIResponse>