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