Looking for the old docs? View our old docs site.

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 object

id
string
Unique, begins with "prcl_"
object
string
"Parcel"
mode
string
"test" or "production"
length
float (inches)
Required if width and/or height are present
width
float (inches)
Required if width and/or height are present
height
float (inches)
Required if width and/or height are present
predefined_package
string
Optional, one of our predefined packages
weight
float (oz)
Always required
created_at
datetime
When the Parcel was created
updated_at
datetime
When the Parcel was last updated
Parcel Object
{
  "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"
}

Predefined Packages

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.

Accurate

No predefined packages for Accurate.

Amazon MWS

No predefined packages for Amazon MWS.

APC

No predefined packages for APC.

Asendia USA

No predefined packages for Asendia USA.

Australia Post
  • CARTON
  • PALLET
  • SATCHEL
  • BAG
  • ENVELOPE
  • ITEM
  • JIFFYBAG
  • SKID
  • Better Trucks

    No predefined packages for Better Trucks.

    Canada Post

    No predefined packages for Canada Post.

    Canpar

    No predefined packages for Canpar.

    CDL Last Mile Solutions

    No predefined packages for CDL Last Mile Solutions.

    Chronopost

    No predefined packages for Chronopost.

    Cirro E-Commerce

    No predefined packages for Cirro E-Commerce.

    CloudSort

    No predefined packages for CloudSort.

    Courier Express

    No predefined packages for Courier Express.

    Couriers Please

    No predefined packages for Couriers Please.

    DAI Post

    No predefined packages for DAI Post.

    Deliver-It

    No predefined packages for Deliver-It.

    Deutsche Post

    No predefined packages for Deutsche Post.

    Deutsche Post UK

    No predefined packages for Deutsche Post UK.

    DHL eCommerce Solutions

    No predefined packages for DHL eCommerce Solutions.

    DHL Express
  • JumboDocument
  • JumboParcel
  • Document
  • DHLFlyer
  • Domestic
  • ExpressDocument
  • DHLExpressEnvelope
  • JumboBox
  • JumboJuniorDocument
  • JuniorJumboBox
  • JumboJuniorParcel
  • OtherDHLPackaging
  • Parcel
  • YourPackaging
  • DHL Paket

    No predefined packages for DHL Paket.

    DPD

    No predefined packages for DPD.

    DPD NL

    No predefined packages for DPD NL.

    DPD UK
  • Parcel
  • Pallet
  • ExpressPak
  • FreightParcel
  • Freight
  • ePostGlobal

    No predefined packages for ePostGlobal.

    Estafeta
  • ENVELOPE
  • PARCEL
  • Evri

    No predefined packages for Evri.

    Fastway
  • Parcel
  • A2
  • A3
  • A4
  • A5
  • BOXSML
  • BOXMED
  • BOXLRG
  • FedEx
  • FedExEnvelope
  • FedExBox
  • FedExPak
  • FedExTube
  • FedEx10kgBox
  • FedEx25kgBox
  • FedExSmallBox
  • FedExMediumBox
  • FedExLargeBox
  • FedExExtraLargeBox
  • FedEx Cross Border

    No predefined packages for FedEx Cross Border.

    FedEx Ground Economy

    No predefined packages for FedEx Ground Economy.

    FedEx SmartPost

    No predefined packages for FedEx SmartPost.

    First Choice

    No predefined packages for First Choice.

    First Mile

    No predefined packages for First Mile.

    Flexport

    No predefined packages for Flexport.

    Gio

    No predefined packages for Gio.

    GLS

    No predefined packages for GLS.

    Hailify

    No predefined packages for Hailify.

    Henry

    No predefined packages for Henry.

    Interlink Express
  • Parcel
  • Pallet
  • ExpressPak
  • FreightParcel
  • Freight
  • Jet

    No predefined packages for Jet.

    Jitsu

    No predefined packages for Jitsu.

    JP Post

    No predefined packages for JP Post.

    Kuroneko Yamato

    No predefined packages for Kuroneko Yamato.

    La Poste

    No predefined packages for La Poste.

    LaserShip
  • Envelope
  • Custom
  • Loomis Express

    No predefined packages for Loomis Express.

    LSO

    No predefined packages for LSO.

    Maergo

    No predefined packages for Maergo.

    Newgistics

    No predefined packages for Newgistics.

    Ontrac
  • Letter
  • Optima

    No predefined packages for Optima.

    OSM Worldwide
  • parcel
  • irregularparcel
  • softpack
  • Pandion

    No predefined packages for Pandion.

    Parcelforce

    No predefined packages for Parcelforce.

    Passport

    No predefined packages for Passport.

    PostNL

    No predefined packages for PostNL.

    Purolator
  • CUSTOMERPACKAGING
  • EXPRESSPACK
  • EXPRESSBOX
  • EXPRESSENVELOPE
  • Royal Mail
  • LARGELETTER
  • SMALLPARCEL
  • MEDIUMPARCEL
  • LETTER
  • PRINTEDPAPER
  • SEKO OmniParcel
  • Bag
  • Box
  • Carton
  • Container
  • Crate
  • Envelope
  • Pail
  • Pallet
  • Satchel
  • Tub
  • Sendle

    No predefined packages for Sendle.

    SF Express

    No predefined packages for SF Express.

    SmartKargo

    No predefined packages for SmartKargo.

    Sonic

    No predefined packages for Sonic.

    Spee-Dee

    No predefined packages for Spee-Dee.

    Swyft

    No predefined packages for Swyft.

    TForce Logistics

    No predefined packages for TForce Logistics.

    Toll

    No predefined packages for Toll.

    UDS

    No predefined packages for UDS.

    UPS
  • UPSLetter
  • UPSExpressBox
  • UPS25kgBox
  • UPS10kgBox
  • Tube
  • Pak
  • SmallExpressBox
  • MediumExpressBox
  • LargeExpressBox
  • UPS iParcel

    No predefined packages for UPS iParcel.

    UPS Mail Innovations

    No predefined packages for UPS Mail Innovations.

    USPS
  • Card
  • Letter
  • Flat
  • FlatRateEnvelope
  • FlatRateLegalEnvelope
  • FlatRatePaddedEnvelope
  • FlatRateWindowEnvelope
  • FlatRateCardboardEnvelope
  • SmallFlatRateEnvelope
  • Parcel
  • SoftPack
  • SmallFlatRateBox
  • MediumFlatRateBox
  • LargeFlatRateBox
  • LargeFlatRateBoxAPOFPO
  • FlatTubTrayBox
  • EMMTrayBox
  • FullTrayBox
  • HalfTrayBox
  • PMODSack
  • Veho

    No predefined packages for Veho.

    Yanwen

    No predefined packages for Yanwen.


    Create a Parcel

    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

    length
    i.e. 20.2
    width
    i.e. 10.9
    height
    i.e. 5
    weight
    i.e. 65.9
    POST /parcels
    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  }'
    Response
    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

    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.

    GET /parcels/:id
    1curl -X GET https://api.easypost.com/v2/parcels/prcl_... \
    2  -u "EASYPOST_API_KEY":
    Response
    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}