GET orders/{orderKey}/return-label
Get the existing return label for the given order. This never generates a new label.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| orderKey | Unique identifier - either OrderNumber or OrderGuid | string | Required |
Body Parameters
None.
Response Information
Resource Description
Get the existing return label for the given order. This never generates a new label.
OrderReturnLabelResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| TimeLimitedUrl | A short lived URL from which the return label can be downloaded | string | None. |
| ContentType | The media type of the document at TimeLimitedUrl | string | None. |
| TrackingNumber | The tracking number of the return shipment the label belongs to | string | None. |
| ErrorMessages | If anything goes wrong with the operation, error messages will appear here in a human readable format | Collection of string | None. |
| Message | A single human readable message | string | None. |
| ErrorCode | A machine readable error code | string | None. |
Response Formats
application/json, text/json
Sample:
{
"TimeLimitedUrl": "example.com/return-label/1234",
"ContentType": "application/pdf",
"TrackingNumber": "AB123456789GB",
"ErrorMessages": [],
"Message": "Return label found"
}