LabelRecoveryResponseLabelResults
Container that stores the label results. Information containing the results of the user's Label Recovery Request.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| tracking_number | str | ❌ | Package Tracking number. Package 1Z number. Returned only if TrackingNumber or Combination of Reference Number and Shipper Number present in request. |
| label_image | LabelResultsLabelImage | ❌ | The elements needed to render a label on a printer or in a browser. Specifies the format in which GraphicImage is represented. If LabelImageFormat is GIF, LabelImage contains GraphicImage and HTMLImage. Otherwise, it contains only GraphicImage. If LabelImageFormat is PDF, LabelImage is only returned at the first package result. If entered in the request, the response mirrors, else the default values are returned. Returned only if TrackingNumber or Combination of Reference Number and Shipper Number present in request. |
| mail_innovations_tracking_number | str | ❌ | Mail Innovations Tracking Number. Applicable for Single Mail Innovations Returns and Dual Mail Innovations Returns shipment. Returned only if MailInnovationsTrackingNumber is provided in request. |
| mail_innovations_label_image | LabelResultsMailInnovationsLabelImage | ❌ | Container to hold Mail Innovations shipments label. The elements needed to render a label on a printer or in a browser. Specifies the format in which GraphicImage is represented. If LabelImageFormat is GIF, LabelImage contains GraphicImage and HTMLImage. Otherwise, it contains only GraphicImage. Applicable for Single Mail Innovations Returns and Dual Mail Innovations Returns shipment. Returned only if MailInnovationsTrackingNumber is provided in request. If LabelImageFormat requested was PDF and TrackingNumber was present along with MailInnovationsTrackingNumber in the request, only LabelImage container is returned. MailInnovationsLabelImage will not be returned. In that case, the labels for Small Package Tracking Number and Mail Innovations Tracking Number will be stitched in single PDF file. |
| receipt | LabelResultsReceipt | ❌ | Container for the HTML receipt and the receipt link. |
| form | LabelResultsForm | ❌ | Container tag for the International Forms. Currently, represents UPS Premium Care Form for Electronic Returns Label and Electronic Import Control Label. UPS Premium Care Form for Forward shipment if Subverion is 1903 or greater Applicable for Electronic Return Label and Electronic Import Control Label shipments only. Applies only for Canada domestic shipments. Returned for request with SubVersion greater than or equal to 1707. UPS Premium Care Form for Forward shipment if Subverion is 1903 or greater |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs