mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-07 20:57:47 +00:00
16 lines
14 KiB
Markdown
16 lines
14 KiB
Markdown
# ShipmentCreateRequest
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `address_from` | [components.AddressCreateRequest](../../models/components/addresscreaterequest.md) | :heavy_check_mark: | N/A | |
|
|
| `address_to` | [components.AddressCreateRequest](../../models/components/addresscreaterequest.md) | :heavy_check_mark: | N/A | |
|
|
| `parcels` | List[[components.ParcelCreateRequest](../../models/components/parcelcreaterequest.md)] | :heavy_check_mark: | N/A | |
|
|
| `customs_declaration` | *Optional[str]* | :heavy_minus_sign: | ID of the Customs Declarations object for an international shipment. | adcfdddf8ec64b84ad22772bce3ea37a |
|
|
| `extra` | [Optional[components.ShipmentExtra]](../../models/components/shipmentextra.md) | :heavy_minus_sign: | An object holding optional extra services to be requested. | |
|
|
| `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. | Customer ID 123456 |
|
|
| `shipment_date` | *Optional[str]* | :heavy_minus_sign: | Date the shipment will be tendered to the carrier. Must be in the format `2014-01-18T00:35:03.463Z`. <br/>Defaults to current date and time if no value is provided. Please note that some carriers require this value to<br/>be in the future, on a working day, or similar. | 2021-03-22T12:00:00Z |
|
|
| `address_return` | [Optional[components.AddressCreateRequest]](../../models/components/addresscreaterequest.md) | :heavy_minus_sign: | N/A | |
|
|
| `async_` | *Optional[bool]* | :heavy_minus_sign: | N/A | | |