1. Shipments
  2. Packages & Labels

Shipments

Packages & Labels

There may be times when you want to ship an item in courier-specific packages. In that case, instead of passing the dimensions of the parcel, you can provide the ID of a predefined package.

WARNING

Make sure that the courier for which you are providing a predefined package is turned on for your account!

When you provide a predefined package, you will only get results from that provider and any other couriers who are agnostic of the package branding. This is typically true with most on-demand providers.

Predefined Packages

Below are the predefined packages that are currently supported in the system.

USPS

ID Name Dimensions (inches) Max Weight (lbs) Domestic / International
usps_flat_rate_envelope USPS Flat Rate Envelope 12.5 x 0 x 9.5 70 / 4
usps_flat_rate_window_envelope USPS Flat Rate Window Envelope 10 x 0 x 6 70 / 4
usps_small_flat_rate_envelope USPS Small Flat Rate Envelope 10 x 0 x 6 70 / 4
usps_flat_rate_padded_envelope USPS Flat Rate Padded Envelope 12.5 x 0 x 10.5 70 / 4
usps_flat_rate_legal_envelope USPS Flat Rate Legal Envelope 15 x 0 x 9.5 70 / 4
usps_small_flat_rate_box USPS Small Flat Rate Box 8.6 x 4.4 x 1.75 70 / 4
usps_medium_flat_rate_box_1 USPS Medium Flat Rate Box (11x8x6) 11.25 x 8.75 x 3.5 70 / 4
usps_medium_flat_rate_box_2 USPS Medium Flat Rate Box (14x12x3) 14 x 12 x 3 70 / 4
usps_large_flat_rate_box_1 USPS Large Flat Rate Box (12x12x6) 12.25 x 12.25 x 6 70 / 4
usps_large_flat_rate_box_2 USPS Large Flat Rate Box (24x12x3) 24.0625 x 11.875 x 3.125 70 / 4
usps_large_flat_rate_box_apo_fpo USPS Large Flat Rate Box (APO/FPO) 12.25 x 12.25 x 6 70 / 4


FedEx

ID Name Dimensions (inches) Max Weight (lbs) Domestic / International
fedex_envelope FedEx Envelope 9.252 x 0 x 13.189 1.1 / 1.1
fedex_pak FedEx Pak 12 x 0 x 15.5 5.5 / 5.5
fedex_tube FedEx Tube 38 x 6 x 6 20 / 20
fedex_small_box_1 FedEx Small Box (12x11x2) 12.25 x 10.9 x 1.5 20 / 20
fedex_small_box_2 FedEx Small Box (11x9x2) 11.25 x 8.75 x 2.625 20 / 20
fedex_medium_box_1 FedEx Medium Box (13x11x2 13.25 x 11.5 x 2.38 20 / 20
fedex_medium_box_2 FedEx Medium Box (11x9x4) 11.25 x 8.75 x 2.38 20 / 20
fedex_large_box_1 FedEx Large Box (17x12x3) 17.88 x 12.38 x 3 20 / 20
fedex_large_box_2 FedEx Large Box (11x8x8) 11.25 x 8.75 x 7.75 20 / 20
fedex_extra_large_box_1 FedEx Extra Large Box (12x11x11) 11.875 x 10.75 x 11 20 / 20
fedex_extra_large_box_2 FedEx Extra Large Box (16x14x6) 15.75 x 14.125 x 6 20 / 20


UPS

ID Name Dimensions (inches) Max Weight (lbs) Domestic / International
ups_letter UPS Letter 15 x 0 x 9.5 1 / 1
ups_25kg_box UPS 55lb Box 19.75 x 17.75 x 13.25 55 / 55
ups_10kg_box UPS 22lb Box 16.5 x 13.25 x 10.75 22 / 22
ups_tube UPS Tube 38 x 6 x 6 55 / 55
ups_pak UPS Pak 16 x 0 x 12.75 5 / 5
ups_express_box UPS Express Box 12.5 x 3.75 x 18 30 / 30
ups_small_express_box UPS Small Express Box 13 x 11 x 2 30 / 30
ups_medium_express_box UPS Medium Express Box 16 x 11 x 3 30 / 30
ups_large_express_box UPS Large Express Box 18 x 13 x 3 30 / 30

Custom (Coming Soon)

NOTE

Coming soon, you'll be able to create your own custom predefined packages.

Label Sizes

When creating shipments via the API, you are able to dynamically specify the label size that you want. If you don't specify a label size, we'll default to the one you have set up on your Dispatch app settings from the PackageX dashboard.

Enum Description
4x6 Most common size for thermal printers
letter Useful if using a standard printer to print the labels
4x8 Prints 4x8 labels. Basically a 4x6 label with extra space below
a4 Will generate an A4 label
a6 Will generate an A6 label
Previous <- Statuses & Events
Next Providers & Service ->