| Field | Type | Required | Description | Example |
|---|---|---|---|---|
Extra |
ShipmentExtra | ➖ | An object holding optional extra services to be requested. | |
Metadata |
string | ➖ | 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 |
ShipmentDate |
string | ➖ | 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 |
AddressFrom |
AddressFrom | ✔️ | N/A | |
AddressReturn |
AddressReturn | ➖ | N/A | |
AddressTo |
AddressTo | ✔️ | N/A | |
CustomsDeclaration |
ShipmentCreateRequestCustomsDeclaration | ➖ | N/A | |
Async |
bool | ➖ | N/A | |
CarrierAccounts |
List<string> | ➖ | List of Carrier Accounts object_ids used to filter the returned rates. If set, only rates from these carriers will be returned. |
[ "065a4a8c10d24a34ab932163a1b87f52", "73f706f4bdb94b54a337563840ce52b0" ] |
Parcels |
List<Models.Components.Parcels> | ✔️ | N/A |