| Field | Type | Required | Description | Example |
|---|---|---|---|---|
Extra |
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 |
string | ➖ | N/A | Customer ID 123456 |
MassUnit |
WeightUnitEnum | ✔️ | The unit used for weight. | lb |
Weight |
string | ✔️ | Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. | 1 |
DistanceUnit |
DistanceUnitEnum | ✔️ | The measure unit used for length, width and height. | in |
Height |
string | ✔️ | Height of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. | 1 |
Length |
string | ✔️ | Length of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted. | 1 |
Width |
string | ✔️ | Width of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted. | 1 |
ObjectCreated |
DateTime | ➖ | Date and time of Parcel creation. | 2014-07-09T02:19:13.174Z |
ObjectId |
string | ➖ | Unique identifier of the given Parcel object. This ID is required to create a Shipment object. | adcfdddf8ec64b84ad22772bce3ea37a |
ObjectOwner |
string | ➖ | Username of the user who created the Parcel object. | [email protected] |
ObjectState |
ObjectState | ➖ | A Parcel will only be valid when all required values have been sent and validated successfully. | VALID |
ObjectUpdated |
DateTime | ➖ | Date and time of last Parcel update. Since you cannot update Parcels after they were created, this time stamp reflects the time when the Parcel was changed by Shippo's systems for the last time, e.g., during sorting the dimensions given. | 2014-07-09T02:19:13.174Z |
Template |
ParcelTemplateEnumSet | ➖ | If template is passed, length, width, height, and distance_unit are not required |
|
Test |
bool | ➖ | Indicates whether the object has been created in test mode. |