Parcel
Parcel
objects represent the physical container being shipped.
Dimensions can be supplied either as length
, width
, and height
dimensions, or a predefined_package
string. Only weight
is required, but since many carriers charge different rates for packages with large dimensions, we strongly recommend including all dimensions if available.
Weights are in OUNCES (OZ) and go to one decimal point.
Dimensions are in INCHES (IN) and go to one decimal point.
Parcel
was createdParcel
was last updated{
"id": "prcl_b35e1e715f30402b9eed234372505f7c",
"object": "Parcel",
"created_at": "2024-01-24T00:06:01Z",
"updated_at": "2024-01-24T00:06:01Z",
"length": 20.2,
"width": 10.9,
"height": 5,
"predefined_package": null,
"weight": 65.9,
"mode": "test"
}
If you provide a predefined_package
the associated Shipment
will fetch rates from carriers for which that is a valid predefined_package
. Some carriers share predefined_package
names. If you wish to restrict your rating to a specific carrier, we recommend passing the carrier_accounts
field when creating a Shipment
.
For most predefined packages, it is not necessary to specify parcel dimensions, only weight.
No predefined packages for Accurate.
No predefined packages for Amazon Shipping.
No predefined packages for APC.
No predefined packages for Asendia USA.
No predefined packages for Better Trucks.
No predefined packages for Bluestreak.
No predefined packages for Canada Post.
No predefined packages for Canpar.
No predefined packages for CDL Last Mile Solutions.
No predefined packages for Chronopost.
No predefined packages for Cirro E-Commerce.
No predefined packages for Courier Express.
No predefined packages for Couriers Please.
No predefined packages for CSLogistics.
No predefined packages for DAI Post.
No predefined packages for Deliver-It.
No predefined packages for Deutsche Post.
No predefined packages for Deutsche Post UK.
No predefined packages for DHL eCommerce.
No predefined packages for DHL Paket.
No predefined packages for DoorDash.
No predefined packages for Douglas.
No predefined packages for DPD.
No predefined packages for DPD NL.
No predefined packages for ePostGlobal.
No predefined packages for EPostGlobalV2.
No predefined packages for Evri.
No predefined packages for FedEx Cross Border.
No predefined packages for FedEx Ground Economy.
No predefined packages for FedEx SmartPost.
No predefined packages for First Choice.
No predefined packages for First Mile.
No predefined packages for Flexport.
No predefined packages for Gio.
No predefined packages for GLS.
No predefined packages for Hailify.
No predefined packages for Henry.
No predefined packages for Jet.
No predefined packages for Jitsu.
No predefined packages for JP Post.
No predefined packages for Kuroneko Yamato.
No predefined packages for La Poste.
No predefined packages for Loomis Express.
No predefined packages for LSO.
No predefined packages for NextDayExpress.
No predefined packages for Optima.
No predefined packages for Pandion.
No predefined packages for Parcelforce.
No predefined packages for Passport Global.
No predefined packages for PostNL.
No predefined packages for Quick.
No predefined packages for Rover.
No predefined packages for Sendle.
No predefined packages for SF Express.
No predefined packages for SmartKargo.
No predefined packages for Sonic.
No predefined packages for Spee-Dee.
No predefined packages for SpeedX.
No predefined packages for Sway.
No predefined packages for Swyft.
No predefined packages for TCC.
No predefined packages for TForce Logistics.
No predefined packages for UDS.
No predefined packages for UPS iParcel.
No predefined packages for UPS Mail Innovations.
No predefined packages for Veho.
No predefined packages for Yanwen.
Include the weight
, and either a predefined_package
or length
, width
and height
if applicable.
A Parcel object is immutable once created. All information must be provided during creation; it cannot be modified later.
Request Parameters
1curl -X POST https://api.easypost.com/v2/parcels \
2 -u "EASYPOST_API_KEY": \
3 -H 'Content-Type: application/json' \
4 -d '{
5 "parcel": {
6 "length": "20.2",
7 "width": "10.9",
8 "height": "5",
9 "weight": "65.9"
10 }
11 }'
1{
2 "id": "prcl_b35e1e715f30402b9eed234372505f7c",
3 "object": "Parcel",
4 "created_at": "2024-01-24T00:06:01Z",
5 "updated_at": "2024-01-24T00:06:01Z",
6 "length": 20.2,
7 "width": 10.9,
8 "height": 5.0,
9 "predefined_package": null,
10 "weight": 65.9,
11 "mode": "test"
12}
Retrieve a Parcel
by its id
. In general you should not need to use this in your automated solution. A Parcel
object's id
can be inlined into the creation call to other objects. This allows you to only create one Parcel
for each package you will be using.
1curl -X GET https://api.easypost.com/v2/parcels/prcl_... \
2 -u "EASYPOST_API_KEY":
1{
2 "id": "prcl_85acf9cc4cb54eeabebda7e6f7a18e99",
3 "object": "Parcel",
4 "created_at": "2024-01-24T00:06:01Z",
5 "updated_at": "2024-01-24T00:06:01Z",
6 "length": 20.2,
7 "width": 10.9,
8 "height": 5.0,
9 "predefined_package": null,
10 "weight": 65.9,
11 "mode": "test"
12}