A create label response body
| Name | Type | Description | Notes |
|---|---|---|---|
| BatchId | string | If this label was created as part of a batch, then this is the unique ID of that batch. | [readonly] |
| CarrierCode | string | The shipping carrier who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. | [readonly] |
| CarrierId | string | The unique ID of the carrier account that was used to create this label | [readonly] |
| ChargeEvent | LabelChargeEvent | The label charge event. | |
| CreatedAt | DateTimeOffset | The date and time that the label was created in ShipEngine. | [readonly] |
| DisplayScheme | DisplayScheme | The display format that the label should be shown in. | |
| InsuranceCost | MonetaryValue | The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. | [readonly] |
| IsInternational | bool | Indicates whether this is an international shipment. That is, the originating country and destination country are different. | [readonly] |
| IsReturnLabel | bool | Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. | |
| LabelDownload | LabelDownload | [readonly] | |
| LabelFormat | LabelFormat | The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. | |
| LabelId | string | A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. | [readonly] |
| LabelLayout | LabelLayout | The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5" x 11") is only supported for `pdf` format. | |
| PackageCode | string | The package type, such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. | [readonly] |
| Packages | List<LabelPackagesInner> | The label's package(s). > Note: Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. | [readonly] |
| ServiceCode | string | The carrier service used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [readonly] |
| ShipDate | DateTimeOffset | The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [readonly] |
| ShipTo | ShippingAddressTo | The recipient's mailing address | [readonly] |
| ShipmentCost | MonetaryValue | The cost of shipping, delivery confirmation, and other carrier charges. This amount does not include insurance costs. | [readonly] |
| ShipmentId | string | The shipment that this label is for. ShipEngine can create a shipment for you automatically when you create a label, or you can create your own shipment and then use it to print a label | [readonly] |
| Status | LabelStatus | [readonly] | |
| Trackable | bool | Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. | [readonly] |
| TrackingNumber | string | The tracking number for the package. Tracking number formats vary across carriers. | [readonly] |
| TrackingStatus | TrackingStatus | The current status of the package, such as `in_transit` or `delivered` | [readonly] |
| Voided | bool | Indicates whether the label has been voided | [readonly] |
| AlternativeIdentifiers | List<AlternativeIdentifier> | Additional information some carriers may provide by which to identify a given label in their system. | [optional] [readonly] |
| Confirmation | DeliveryConfirmation | The type of delivery confirmation that is required for this shipment. | [optional] [readonly] |
| ExternalOrderId | string | ID that the Order Source assigne | [readonly] |
| ExternalShipmentId | string | A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. | [readonly] |
| FormDownload | Link | The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it. | [readonly] |
| InsuranceClaim | Link | The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission. | [readonly] |
| LabelDownloadType | LabelDownloadType | [optional] | |
| LabelImageId | string | The label image resource that was used to create a custom label image. | |
| OutboundLabelId | string | The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. | [optional] |
| PaperlessDownload | PaperlessDownload | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [readonly] |
| QrCodeDownload | OptionalLink | The QR code download for the package | [readonly] |
| RateDetails | List<RateDetail> | A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. | [optional] [readonly] |
| RequestedComparisonAmount | MonetaryValue | The total shipping cost for the specified comparison_rate_type. | [optional] [readonly] |
| RmaNumber | string | An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. | |
| Shipment | Shipment | The shipment information used to generate the label | [optional] |
| TestLabel | bool | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false] |
| TrackingUrl | string | The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. | [optional] [readonly] |
| ValidateAddress | ValidateAddress | [optional] | |
| VoidedAt | DateTimeOffset | The date and time that the label was voided, or `null` if the label has not been voided | [optional] [readonly] |