| Name | Type | Description | Notes |
|---|---|---|---|
| shipment_id | str | Shipment Id<br />Tracking Number or Unique Id of the shipment involved. | [optional] |
| label_image | str | Label Image<br />Depends on Label Image Format<br /> <br />PDF<br />Base 64 encoded PDF<br /> <br />PNG<br />Base 64 encoded PNG<br /> <br />ZPL 300 / 203 dpi<br />Base 64 encoded PRN (text file)<br /> <br />Data stream<br />Not Included | [optional] |
| label_image_format | str | Label Image Format | [optional] |
| tracking_number | str | Shipment Tracking Number<br />Final Mile carrier tracking number | [optional] |
| unique_id | str | Unique Shipment ID | [optional] |
| tracking_url | str | Tracking URL<br />Final Mile Tracking, if available | [optional] |
| carrier_code | str | Carrier Code<br />The allocated carrier. | [optional] |
| primary2_d_barcode_image | str | Primary 2D Barcode Image<br />Only populated for Data Stream response.<br />Base64 Encoded PNG Image of the 2D data matrix barcode. | [optional] |
| primary2_d_barcode_data | str | Primary 2D Barcode Data - Base 64 Encoded<br />Only populated for Data Stream response.<br />Data required to create your own 2D data matrix barcode. Please decode before use. | [optional] |
| formatted_unique_id | str | Formatted Unique Id<br />Only populated for Data Stream response.<br />Label for 2D data matrix barcode. | [optional] |
| high_volume_barcode_data | str | High Volume Barcode Data<br />Only populated for Data Stream response where the service requires the barcode on the label.<br />Data required to create your own High Volume barcode. | [optional] |
| high_volume_barcode_image | str | High Volume Barcode Image<br />Only populated for Data Stream response where the service requires the barcode on the label.<br />Base64 Encoded PNG Image of the High Volume barcode. | [optional] |
| high_volume_sort_code | str | High Volume Sort Code<br />Only populated for Data Stream response where the service requires the sort code on the label. | [optional] |
| primary1_d_barcode_data | str | Primary 1D Barcode Data<br />Only populated for Data Stream response where the service requires the barcode on the label.<br />Data required to create your own 1D barcode. | [optional] |
| primary1_d_barcode_image | str | Primary 1D Barcode Image<br />Only populated for Data Stream response where the service requires the barcode on the label.<br />Base64 Encoded PNG Image of the 1D barcode. | [optional] |
| return_label_image_format | str | Return Label Image Format | [optional] |
| return_label_image | str | Return Label Image<br />Any return label that have been created as a result of the request and label option settings.<br />Depends on ReturnLabelImageFormat.<br /> <br />PDF<br />Base 64 encoded PDF<br /> <br />PNG<br />Base 64 encoded PNG<br /> <br />ZPL 300 / 203 dpi<br />Base 64 encoded PRN (text file) | [optional] |
| http_status_code | int | HTTP Status Code | |
| http_status_description | str | HTTP Status Description | |
| message | str | Message<br />Successful response may include a success message.<br />Failure responses will have general reason as to why. Further details may be contained in the list of errors. | [optional] |
| errors | list[ErrorDetail] | Errors<br />Details about why a request failed. | [optional] |