mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-08 12:47:46 +00:00
19 KiB
19 KiB
ParcelRequest
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
distance_unit |
components.DistanceUnitTemplate | ✔️ | The measure unit used for length, width and height. Required if template is not specified. | in |
height |
str | ✔️ | 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 | ✔️ | 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 | ✔️ | The unit used for weight. | lb |
weight |
str | ✔️ | Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. | 1 |
width |
str | ✔️ | 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] | ➖ | An object holding optional extra services to be requested for each parcel in a multi-piece shipment. See the Parcel Extra table below for all available services. |
|
metadata |
Optional[str] | ➖ | 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]] | ➖ | If template is passed, length, width, height, and distance_unit are not required |
|
test |
Optional[bool] | ➖ | Indicates whether the object has been created in test mode. |