POST api/Centers/VoidShippingLabel

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
OrderNumber	string	None.
ExternalShippingLabelID	string	None.
WarehouseCount	integer	None.
OrderItemIDs	Collection of integer	None.
RequestedByUserName	string	None.
SiteCode	string	None.
WarehouseCode	string	None.
CarrierName	string	None.
UserName	string	None.
LocaleId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderNumber": "sample string 1",
  "ExternalShippingLabelID": "sample string 2",
  "WarehouseCount": 1,
  "OrderItemIDs": [
    1,
    2
  ],
  "RequestedByUserName": "sample string 3",
  "SiteCode": "sample string 4",
  "WarehouseCode": "sample string 5",
  "CarrierName": "sample string 6",
  "UserName": "sample string 7",
  "LocaleId": 8
}

application/xml, text/xml

Sample:

<VoidShippingLabelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API.Centers">
  <CarrierName>sample string 6</CarrierName>
  <ExternalShippingLabelID>sample string 2</ExternalShippingLabelID>
  <LocaleId>8</LocaleId>
  <OrderItemIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </OrderItemIDs>
  <OrderNumber>sample string 1</OrderNumber>
  <RequestedByUserName>sample string 3</RequestedByUserName>
  <SiteCode>sample string 4</SiteCode>
  <UserName>sample string 7</UserName>
  <WarehouseCode>sample string 5</WarehouseCode>
  <WarehouseCount>1</WarehouseCount>
</VoidShippingLabelRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VoidShippingLabelResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
IsSuccess	boolean	None.
OrderNumber	string	None.
WarehouseCount	integer	None.
ErrorMessage	string	None.
SuccessMessage	string	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "IsSuccess": true,
  "OrderNumber": "sample string 3",
  "WarehouseCount": 4,
  "ErrorMessage": "sample string 5",
  "SuccessMessage": "sample string 6",
  "CorrelationId": "sample string 7"
}

application/xml, text/xml

Sample:

<VoidShippingLabelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API.Centers">
  <CorrelationId>sample string 7</CorrelationId>
  <ErrorMessage>sample string 5</ErrorMessage>
  <IsSuccess>true</IsSuccess>
  <Message>sample string 1</Message>
  <OrderNumber>sample string 3</OrderNumber>
  <ResponseCode>Success</ResponseCode>
  <SuccessMessage>sample string 6</SuccessMessage>
  <WarehouseCount>4</WarehouseCount>
</VoidShippingLabelResponse>