Label Recovery Example Request
POST {{base_url}}/api/labels/:version/recovery
This HTTP POST request takes in a TrackingNumber and returns the associated label and documents in Base64 encoding.
Request Body
{"LabelRecoveryRequest "=>{"Request "=>{"RequestOption "=>"Non_Validate ", "SubVersion "=>"1903 ", "TransactionReference "=>{"CustomerContext "=>" ", "TransactionIdentifier "=>" "}}, "LabelSpecification "=>{"HTTPUserAgent "=>"Mozilla/4.5 ", "LabelImageFormat "=>{"Code "=>"ZPL "}, "LabelStockSize "=>{"Height "=>"6 ", "Width "=>"4 "}}, "Translate "=>{"LanguageCode "=>"eng ", "DialectCode "=>"US ", "Code "=>"01 "}, "LabelDelivery "=>{"LabelLinkIndicator "=>" ", "ResendEmailIndicator "=>" "}, "TrackingNumber "=>"1Z12345E8791315509 "}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
transId | null | An identifier unique to the request. Length 32 | |
transactionSrc | string | An identifier of the client/source application that is making the request.Length 512 | |
Content-Type | string |
RESPONSES
status: OK
{"LabelRecoveryResponse":{"LabelResults":{"LabelImage":{"GraphicImage":"Cl5YQV5MUk5eTU5ZXk1GTixOX...","InternationalSignatureGraphicImage":"Cl5YQV5MUk5eTU5ZXk1GTixOXkxIMTAsMTJeTUNZXlBP...","LabelImageFormat":{"Code":"zpl"},"URL":"https://www.ups.com/uel/llp/1Z12345E8791315413/link/labelAll/XLBR/5jypHwwiOHml02HH6IUGJtBCdaRly8nwdfEPuvEVjece/en_US?loc=en_US\u0026pdr=false"},"Receipt":"","TrackingNumber":"1Z12345E8791315413"},"Response":{"ResponseStatus":{"Code":"1","Description":"Success"},"TransactionReference":""},"ShipmentIdentificationNumber":"1Z12345E8791315413"}}