POST api/shipping-label/void

Void a shipping label

Request Information

URI Parameters

None.

Body Parameters

Shipping label cancel request

ShippingLabelCancelRequestV4
Name Type Description Additional information
TransactionId string

TrackingNumber string

Request Formats

application/json, text/json

Sample: 
{
  "TransactionId": "sample string 1",
  "TrackingNumber": "sample string 2",
  "Options": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample: 
<ShippingLabelCancelRequestV4 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TransactionId>sample string 1</TransactionId>
  <TrackingNumber>sample string 2</TrackingNumber>
</ShippingLabelCancelRequestV4>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShippingLabelCancelResponseV4
Name Type Description Additional information
TrackingNumber string

TransactionID string

ClientName string

ResultCode string

ResultMessage string

ExecutionTimeInMS integer

MetaData Dictionary of string [key] and string [value]

Response Formats

application/json, text/json

Sample: 
{
  "TrackingNumber": "sample string 1",
  "TransactionID": "sample string 2",
  "ClientName": "sample string 3",
  "ResultCode": "sample string 4",
  "ResultMessage": "sample string 5",
  "ExecutionTimeInMS": 6,
  "MetaData": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample: 
<ShippingLabelCancelResponseV4 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/InvectioApi.Models.PackageHub.v4">
  <ClientName>sample string 3</ClientName>
  <ExecutionTimeInMS>6</ExecutionTimeInMS>
  <MetaData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </MetaData>
  <ResultCode>sample string 4</ResultCode>
  <ResultMessage>sample string 5</ResultMessage>
  <TrackingNumber>sample string 1</TrackingNumber>
  <TransactionID>sample string 2</TransactionID>
</ShippingLabelCancelResponseV4>