POST api/Shipping/PrintReturnLabel
Prints a return label from USPS or UPS
Request Information
URI Parameters
None.
Body Parameters
The label request object. The API will determine where and how the data will be parsed.
ReturnLabelRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerName | string |
None. |
|
| CustomerAddress1 | string |
None. |
|
| CustomerAddress2 | string |
None. |
|
| CustomerCity | string |
None. |
|
| CustomerState | string |
None. |
|
| CustomerPostalCode | string |
None. |
|
| CustomerCountry | string |
None. |
|
| Weight | decimal number |
None. |
|
| Carrier | string |
None. |
|
| ClientName | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"CustomerName": "sample string 1",
"CustomerAddress1": "sample string 2",
"CustomerAddress2": "sample string 3",
"CustomerCity": "sample string 4",
"CustomerState": "sample string 5",
"CustomerPostalCode": "sample string 6",
"CustomerCountry": "sample string 7",
"Weight": 8.0,
"Carrier": "sample string 9",
"ClientName": "sample string 10"
}
application/xml, text/xml
Sample:
<ReturnLabelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SubmissionAPI.Models"> <Carrier>sample string 9</Carrier> <ClientName>sample string 10</ClientName> <CustomerAddress1>sample string 2</CustomerAddress1> <CustomerAddress2>sample string 3</CustomerAddress2> <CustomerCity>sample string 4</CustomerCity> <CustomerCountry>sample string 7</CustomerCountry> <CustomerName>sample string 1</CustomerName> <CustomerPostalCode>sample string 6</CustomerPostalCode> <CustomerState>sample string 5</CustomerState> <Weight>8</Weight> </ReturnLabelRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |