mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-08 12:47:46 +00:00
17 lines
19 KiB
Markdown
17 lines
19 KiB
Markdown
# ParcelRequest
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `distance_unit` | [components.DistanceUnitTemplate](../../models/components/distanceunittemplate.md) | :heavy_check_mark: | The measure unit used for length, width and height. Required if template is not specified. | in |
|
|
| `height` | *str* | :heavy_check_mark: | Required if template is not specified. Height of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. | 1 |
|
|
| `length` | *str* | :heavy_check_mark: | Required if template is not specified. Length of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted. | 1 |
|
|
| `mass_unit` | [components.WeightUnit](../../models/components/weightunit.md) | :heavy_check_mark: | The unit used for weight. | lb |
|
|
| `weight` | *str* | :heavy_check_mark: | Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. | 1 |
|
|
| `width` | *str* | :heavy_check_mark: | Required if template is not specified. Width of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted. | 1 |
|
|
| `extra` | [Optional[components.ParcelExtra]](../../models/components/parcelextra.md) | :heavy_minus_sign: | An object holding optional extra services to be requested for each parcel in a multi-piece shipment. <br/>See the <a href="#section/Parcel-Extras">Parcel Extra table below</a> for all available services. | |
|
|
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you want to attach to the object. | |
|
|
| `template` | [Optional[Union[components.ParcelTemplateFedEx, components.ParcelTemplateUPS, components.ParcelTemplateUSPS, components.ParcelTemplateDHLeCommerce, components.ParcelTemplateDPDUK, components.ParcelTemplateCouriersPlease, components.ParcelTemplateAramexAustralia]]](../../models/components/parceltemplateenumset.md) | :heavy_minus_sign: | If template is passed, `length`, `width`, `height`, and `distance_unit` are not required | |
|
|
| `test` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether the object has been created in test mode. | | |