mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-07 20:57:47 +00:00
15 lines
16 KiB
Markdown
15 lines
16 KiB
Markdown
# ParcelCreateRequest
|
|
|
|
|
|
## 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**<br><br/>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**<br><br/>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**<br><br/>Width of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted. | 1 |
|
|
| `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 | |
|
|
| `metadata` | *Optional[str]* | :heavy_minus_sign: | N/A | Customer ID 123456 | |