A purchase label request body
| Name | Type | Description | Notes |
|---|---|---|---|
| Shipment | ShipmentRequest | The shipment information used to generate the label | |
| ChargeEvent | LabelChargeEvent | The label charge event. | [optional] |
| DisplayScheme | DisplayScheme | The display format that the label should be shown in. | [optional] |
| 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. | [optional] |
| LabelDownloadType | LabelDownloadType | [optional] | |
| 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. | [optional] |
| LabelImageId | string | The label image resource that was used to create a custom label image. | [optional] |
| 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. | [optional] |
| 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] |
| RmaNumber | string | An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. | [optional] |
| ShipFromServicePointId | string | A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address. | [optional] |
| ShipToServicePointId | string | A unique identifier for a carrier service point where the shipment will be delivered by the carrier. This will take precedence over a shipment's ship to address. | [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] |
| ValidateAddress | ValidateAddress | [optional] |