• Docs
  • Guides
  • API Status

Core Guides


Getting Started

Request Your SignupKey

Please contact the PackageHub support team at support.packagehub@maersk.com to request your SignupKey.


Set Up a New PackageHub Account

A PackageHub account must be created to transact with the PackageHub API. The SignupKey is required to create a PackageHub account, but alone, does not authorize you to make API calls to the PackageHub API.

A username and password allows PackageHub account-holders to sign into the PackageHub Portal, where you can retrieve their shipper apiKey and apiSecret, update payment information and view reports.

Steps

  1. Create a new account and approve terms and conditions
  2. Enter payment information
  3. Add funds to your account

1. Sign Up for a New Account and Accept T&Cs

There are 2 methods to sign up for a new account.

  1. PackageHub Portal Account Signup Page to enter your customer information and accept terms and conditions
  2. User Signup and Approve Terms and Conditions methods

2. Enter Payment Information

On the Portal Billing Page, you can enter your credit card or ACH details under Payment Method. Account funds are required for you to generate labels for built-in PackageHub carriers.

3. Fund the Shipping Account

There are 2 methods to fund a shipping account:

  1. One-time Purchase: A manual method to fund your account
  2. Auto Buy: Automatically fund your account
    • Auto Buy Amount is the amount you intend to purchase automatically when your account balance reaches a threshold you define
    • When Balance Reaches is the threshold amount

Generate a Token

Generate your JSON Web Token (JWT) via the Account Token method.

Steps:

  1. Retrieve your apiKey and apiSecret from the PackageHub Portal in your Apps Page
  2. Gather your user-defined username and password from the account signup process
  3. Generate your token

Rates

Shipment Rates provide estimates about the base costs and additional fees to be incurred prior to generating a shipping label. If you are unsure of which service to use for your package, or if you want to rate shop between all carriers, or service levels within a carrier, you have an option to retrieve a list of shipment rates.

There are 3 options for retrieving rates:

  1. Multiple shipment rates - all carriers
    • Addresses: toAddress and fromAddress
    • Name of any optional specialService
    • Package Details: packageType, length, width, height, and weight
    • token
  2. Multiple shipment rates - single carrier account
    • Specify carrier account using CarrierAccountId
  3. Single shipment rate
    • Indicate the carrier service level

Label Generation

Shipments and generating labels are the core of PackageHub. Our API allows you to create shipping labels in a single request. The POST Shipment method is used to create a new shipment with its corresponding rate and label.

Steps:

  1. Get the information needed to generate a shipping label
    • Addresses: toAddress and fromAddress
    • Carrier Details: carrierAccountId, carrier service level, and any optional specialService
    • Package Details: packageType, length, width, height and weight
    • token
    • transactionId
  2. Download, store or distribute the label
    • With the labelType of url or Base64 the label can be downloaded and printed, displayed, stored, or distributed to another the end-user
    • Available labelFileType are PDF, TIF, PNG and ZPL.

Carrier Guides


USPS (eVS)

Services

Name service Transit Time Max Dimensions Max Weight
Priority Mail PriorityMail 2 to 3 business days 108" 70 lbs
Priority Mail Express PriorityMailExpress 1 to 2 business days 108" 70 lbs
Parcel Select ParcelSelect 2 to 8 business days 130" 70 lbs
First Class Package Service FirstClass 1 to 3 business days 108" 15.99 oz
Ground Advantage GroundAdvantage 2 to 5 business days 108" 70 lbs
Priority Mail International PriorityMailIntl 3 to 5 business days 108" 70 lbs
Priority Mail Express International PriorityMailExpressIntl 6 to 10 business days 108" 70 lbs
First Class Package International Service FirstClassIntl 7 to 21 business days 108" 64 oz
Library Mail LibraryMail 2 to 8 business days 108" 70 lbs
Media Mail MediaMail 2 to 8 business days 108" 70 lbs
Parcel Select Destination Entry ParcelSelectDE 2 to 8 business days 130" 70 lbs

Special Services (Domestic)

specialService Priority Mail Priority Mail Express First Class Parcel Select Library Mail Media Mail Ground Advantage Parcel Select DE
AdultSignature ✓ ✓ ✓ ✓ ✓
CertifiedMail ✓ ✓
ElectronicReturnReceipt ✓
Insurance ✓ ✓ ✓ ✓ ✓ ✓
RestrictedDelivery ✓ ✓ ✓ ✓ ✓ ✓ ✓
SignatureConfirmation ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Tracking ✓ ✓ ✓ ✓ ✓ ✓ ✓
HAZMAT ✓ ✓ ✓ ✓ ✓
SundayDelivery ✓
CrematedRemains ✓
HolidayDelivery ✓
Returns ✓ ✓ ✓ ✓ ✓

Special Services (International)

specialService Priority Mail International Priority Mail Express International First Class Package International Service
AdultSignature
CertifiedMail
ElectronicReturnReceipt
Insurance ✓ ✓
RestrictedDelivery
SignatureConfirmation
Tracking ✓ ✓ ✓
HAZMAT
Returns

Package Types

Name packageType Dimensions Max Weight
Parcel Parcel Custom 70 lbs
Soft Pack SoftPack Custom 20 lbs
Flat Rate Envelope FlatRateEnvelope 12 1/2″ x 9 1/2″ 70 lbs
Legal Flat Rate Envelope LegalFlatRateEnvelope 15″ x 9 1/2″ 70 lbs
Padded Flat Rate Envelope PaddedFlatRateEnvelope 12 1/2″ x 9 1/2″ 70 lbs
Small Flat Rate Box SmallFlatRateBox 8 11/16″ x 5 7/16″ x 1 3/4″ 70 lbs
Medium Flat Rate Box 1 MediumFlatRateBox1 11 1/4″ x 8 3/4″ x 6″ 70 lbs
Medium Flat Rate Box 2 MediumFlatRateBox2 14″ x 12″ x 3 1/2″ 70 lbs
Large Flat Rate Box LargeFlatRateBox 12 1/4″ x 12 1/4″ x 6″ 70 lbs

Additional Info

  • First-Class and Parcel Select are translated into Ground Advantage service.
  • Return shipments are done through MRA API. To use Returns, please add your MRA MID and account code in the desired carrier account. This feature is only availabe for postpaid users. Please contact support to enable postpaid.

USPS (Ship)

Services

Name service Transit Time Max Dimensions Max Weight
Priority Mail PriorityMail 2 to 3 business days 108" 70 lbs
Priority Mail Express PriorityMailExpress 1 to 2 business days 108" 70 lbs
Parcel Select ParcelSelect 2 to 8 business days 130" 70 lbs
First Class Package Service FirstClass 1 to 3 business days 108" 15.99 oz
Ground Advantage GroundAdvantage 2 to 5 business days 108" 70 lbs
Library Mail LibraryMail 2 to 8 business days 108" 70 lbs
Media Mail MediaMail 2 to 8 business days 108" 70 lbs
Parcel Select Destination Entry ParcelSelectDE 2 to 8 business days 130" 70 lbs
Priority Mail International PriorityMailIntl 3 to 5 business days 108" 70 lbs
Priority Mail Express International PriorityMailExpressIntl 6 to 10 business days 108" 70 lbs
First Class Package International Service FirstClassIntl 7 to 21 business days 108" 64 oz

Special Services (Domestic)

specialService Priority Mail Priority Mail Express First Class Parcel Select Library Mail Media Mail Ground Advantage Parcel Select DE
AdultSignature ✓ ✓ ✓ ✓ ✓
CertifiedMail ✓
ElectronicReturnReceipt ✓
Insurance ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
RestrictedDelivery ✓ ✓ ✓ ✓ ✓ ✓ ✓
SignatureConfirmation ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Tracking ✓ ✓ ✓ ✓ ✓ ✓ ✓
HAZMAT ✓ ✓ ✓ ✓ ✓
Returns ✓ ✓ ✓ ✓ ✓

Special Services (International)

specialService Priority Mail International Priority Mail Express International First Class Package International Service
AdultSignature
CertifiedMail
ElectronicReturnReceipt
Insurance ✓ ✓
RestrictedDelivery
SignatureConfirmation
Tracking ✓ ✓ ✓
HAZMAT
Returns

Package Types

Name packageType Dimensions Max Weight
Parcel Parcel Custom 70 lbs
Soft Pack SoftPack Custom 20 lbs
Flat Rate Envelope FlatRateEnvelope 12 1/2″ x 9 1/2″ 70 lbs
Legal Flat Rate Envelope LegalFlatRateEnvelope 15″ x 9 1/2″ 70 lbs
Padded Flat Rate Envelope PaddedFlatRateEnvelope 12 1/2″ x 9 1/2″ 70 lbs
Small Flat Rate Box SmallFlatRateBox 8 11/16″ x 5 7/16″ x 1 3/4″ 70 lbs
Medium Flat Rate Box 1 MediumFlatRateBox1 11 1/4″ x 8 3/4″ x 6″ 70 lbs
Medium Flat Rate Box 2 MediumFlatRateBox2 14″ x 12″ x 3 1/2″ 70 lbs
Large Flat Rate Box LargeFlatRateBox 12 1/4″ x 12 1/4″ x 6″ 70 lbs

Additional Info

  • Returns Shipments are done through Returns special service.
  • USPS-Ship also supports printing QR code for return label by setting returnsImageType attribute to labelBroker in specialServiceparam object.
  • If LabelBroker is used, the response will include the label broker ID in the ReturnsLabelBrokerID field within the Option object.

USPS (ePostage)

Services

Name service Transit Time Max Dimensions Max Weight
Priority Mail PriorityMail 2 to 3 business days 108" 70 lbs
Priority Mail Express PriorityMailExpress 1 to 2 business days 108" 70 lbs
Parcel Select ParcelSelect 2 to 8 business days 130" 70 lbs
First Class Package Service FirstClass 1 to 3 business days 108" 15.99 oz
Ground Advantage GroundAdvantage 2 to 5 business days 108" 70 lbs
Priority Mail International PriorityMailIntl 3 to 5 business days 108" 70 lbs
Priority Mail Express International PriorityMailExpressIntl 6 to 10 business days 108" 70 lbs
First Class Package International Service FirstClassIntl 7 to 21 business days 108" 64 oz
Library Mail LibraryMail 2 to 8 business days 108" 70 lbs
Media Mail MediaMail 2 to 8 business days 108" 70 lbs

Special Services (Domestic)

specialService Priority Mail Priority Mail Express First Class Parcel Select Library Mail Media Mail Ground Advantage
AdultSignature ✓ ✓ ✓ ✓ ✓
CertifiedMail ✓ ✓
ElectronicReturnReceipt ✓
Insurance ✓ ✓ ✓ ✓ ✓
RestrictedDelivery ✓ ✓ ✓ ✓ ✓ ✓ ✓
SignatureConfirmation ✓ ✓ ✓ ✓ ✓ ✓ ✓
Tracking ✓ ✓ ✓ ✓ ✓ ✓
HAZMAT ✓ ✓ ✓ ✓ ✓
SundayDelivery ✓
CrematedRemains ✓
HolidayDelivery ✓
Returns ✓ ✓ ✓ ✓ ✓

Special Services (International)

specialService Priority Mail International Priority Mail Express International First Class Package International Service
AdultSignature
CertifiedMail
ElectronicReturnReceipt
Insurance ✓ ✓
RestrictedDelivery
SignatureConfirmation
Tracking ✓ ✓ ✓
HAZMAT
Returns

Package Types

Name packageType Dimensions Max Weight
Parcel Parcel Custom 70 lbs
Soft Pack SoftPack Custom 20 lbs
Flat Rate Envelope FlatRateEnvelope 12 1/2″ x 9 1/2″ 70 lbs
Legal Flat Rate Envelope LegalFlatRateEnvelope 15″ x 9 1/2″ 70 lbs
Padded Flat Rate Envelope PaddedFlatRateEnvelope 12 1/2″ x 9 1/2″ 70 lbs
Small Flat Rate Box SmallFlatRateBox 8 11/16″ x 5 7/16″ x 1 3/4″ 70 lbs
Medium Flat Rate Box 1 MediumFlatRateBox1 11 1/4″ x 8 3/4″ x 6″ 70 lbs
Medium Flat Rate Box 2 MediumFlatRateBox2 14″ x 12″ x 3 1/2″ 70 lbs
Large Flat Rate Box LargeFlatRateBox 12 1/4″ x 12 1/4″ x 6″ 70 lbs

Additional Info

  • First-Class and Parcel Select are translated into Ground Advantage service.
  • Return shipments are done through MRA API. To use Returns, please add your MRA MID and account code in the desired carrier account. This feature is only availabe for postpaid users. Please contact support to enable postpaid.

USPS (PC-Postage)

Services

Name service Transit Time Max Dimensions Max Weight
Priority Mail PriorityMail 2 to 3 business days 108" 70 lbs
Priority Mail Express PriorityMailExpress 1 to 2 business days 108" 70 lbs
Parcel Select ParcelSelect 2 to 8 business days 130" 70 lbs
First-Class FirstClass 1 to 3 business days 108" 15.99 oz
Ground Advantage GroundAdvantage 2 to 5 business days 108" 70 lbs
Priority Mail International PriorityMailIntl 3 to 5 business days 108" 70 lbs
Priority Mail Express International PriorityMailExpressIntl 6 to 10 business days 108" 70 lbs
First-Class International FirstClassIntl 7 to 21 business days 108" 64 oz
Library Mail LibraryMail 2 to 8 business days 108" 70 lbs
Media Mail MediaMail 2 to 8 business days 108" 70 lbs

Special Services (Domestic)

specialService Priority Mail Priority Mail Express First Class Parcel Select Library Mail Media Mail Ground Advantage
AdultSignature ✓ ✓ ✓ ✓ ✓
CertifiedMail ✓ ✓
ElectronicReturnReceipt ✓
Insurance ✓ ✓ ✓ ✓ ✓
RestrictedDelivery ✓ ✓ ✓ ✓ ✓ ✓ ✓
SignatureConfirmation ✓ ✓ ✓ ✓ ✓ ✓ ✓
HAZMAT ✓ ✓ ✓ ✓ ✓
SundayDelivery ✓
HolidayDelivery ✓
RegisteredMail ✓
CollectOnDelivery ✓ ✓ ✓

Special Services (International)

specialService Priority Mail International Priority Mail Express International First Class Package International Service
AdultSignature
CertifiedMail
ElectronicReturnReceipt
Insurance ✓ ✓
RestrictedDelivery
SignatureConfirmation
Tracking ✓ ✓ ✓
HAZMAT
Returns

Package Types

Name packageType Dimensions Max Weight
Parcel Parcel Custom 70 lbs
Soft Pack SoftPack Custom 20 lbs
Flat Rate Envelope FlatRateEnvelope 12 1/2″ x 9 1/2″ 70 lbs
Legal Flat Rate Envelope LegalFlatRateEnvelope 15″ x 9 1/2″ 70 lbs
Padded Flat Rate Envelope PaddedFlatRateEnvelope 12 1/2″ x 9 1/2″ 70 lbs
Small Flat Rate Box SmallFlatRateBox 8 11/16″ x 5 7/16″ x 1 3/4″ 70 lbs
Medium Flat Rate Box 1 MediumFlatRateBox1 11 1/4″ x 8 3/4″ x 6″ 70 lbs
Medium Flat Rate Box 2 MediumFlatRateBox2 14″ x 12″ x 3 1/2″ 70 lbs
Large Flat Rate Box LargeFlatRateBox 12 1/4″ x 12 1/4″ x 6″ 70 lbs
Flat Flat Min: 11 1/2″ x 6 1/8″ x 1/4″
Max: 15″ x 12″ x 3/4″
3.5 oz
Letter Letter Min: 5″ x 3 1/2″ x 0.007″
Max: 11 1/2″ x 6 1/8″ x 1/4″
13 oz

Additional Info

  • First-Class and First-Class International service with package type Letter or Flat internally translates to First-Class Mail or First-Class Mail International respectively.
  • First-Class and First-Class International service with package type Parcel internally translates to First-Class Package Service or First-Class Package International Service respectively.
  • First-Class Mail and First-Class Mail International service with package type Letter supports additional label size of 6x4 and 7x3.
  • First-Class Mail and First-Class Mail International service with package type Flat supports additional label size of 6x4.

USPS (eVS-Native)

Services

Name service Transit Time Max Dimensions Max Weight
Priority Mail PriorityMail 2 to 3 business days 108" 70 lbs
Ground Advantage GroundAdvantage 2 to 5 business days 108" 70 lbs
Parcel Select Destination Entry ParcelSelectDE 2 to 8 business days 130" 70 lbs

Special Services (Domestic)

specialService Priority Mail Ground Advantage Parcel Select DE
AdultSignature ✓ ✓
Insurance ✓ ✓ ✓
SignatureConfirmation ✓ ✓ ✓
Tracking ✓ ✓ ✓
RestrictedDelivery ✓ ✓

Package Types

Name packageType Dimensions Max Weight
Parcel Parcel Custom 70 lbs

Additional Info

  • Carrier USPS-eVS-Native only supports PDF, ZPL LabelFileType(s).
  • Shipments are automatically manifested at 8 PM CST.

DHL Express

Services

Name service Transit Time
Express Worldwide Non Doc ExpressWorldwide Next possible business day
Express 9:00 Doc Express9:00DOC Next possible business day
Express 9:00 Non Doc Express9:00 Next possible business day
Express 12:00 Doc Express12:00DOC Next possible business day
Express 12:00 Non Doc Express12:00 Next possible business day

Special Services

  • No special services are supported for DHL Express in PackageHub.

Package Types

Name packageType Dimensions Max Weight
Parcel Parcel Custom 70 lbs

Additional Info

  • Generating labels via Shipment endpoint is supported but additional functions like Refund and Manifest are not supported.

Pitney Bowes Standard

Services

Name service
Parcel Select LightWeight ParcelSelectLightweight
Parcel Select ParcelSelect
First Class FirstClass
Priority Mail PriorityMail
Bound Printed Matter BoundPrintedMatter

Special Services (Domestic)

specialService Parcel Select LightWeight Parcel Select First Class Priority Mail Bound Printed Matter
SignatureConfirmation ✓ ✓ ✓ ✓ ✓
Tracking ✓ ✓ ✓ ✓ ✓

Package Types

Name packageType Dimensions Max Weight
Parcel Parcel Custom 70 lbs

UPS

Services

Name service Transit Time
Next Day Air® NextDayAir 1 Day
Next Day Air Saver® NextDayAirSaver 1 Day
Second Day Air® SecondDayAir 2 Days
Second Day Air A.M.® SecondDayAirAM 2 Days
Three-Day Select® ThreeDaySelect 3 Days
Ground Ground Within 5 Days
Standard to Canada StandardToCanada Day-Definite
Standard to Mexico StandardToMexico Day-Definite
Worldwide Express® WorldWideExpress 1-3 Days
Worldwide Express Plus® WorldWideExpressPlus 1-3 Days
Worldwide Saver® WorldWideSaver 1-3 Days
Worldwide Expedited® WorldWideExpedited 2-5 Days

Special Services

  • No special services are supported for UPS in PackageHub.

Package Types

Name packageType Dimensions Max Weight
Parcel Parcel Custom 70 lbs

UPS Mail Innovations (UPS-MI)

Services

Name service
First Class Mail FirstClass
Priority Mail PriorityMail
Expedited Mail Innovations ExpeditedMailInnovations
Priority Mail Innovations PriorityMailInnovations
Economy Mail Innovations EconomyMailInnovations

Special Services

  • No special services are supported for UPS-MI in PackageHub.

Package Types

Name packageType Dimensions Max Weight
Parcel Parcel Custom 70 lbs

FedEx

Services

Name service Transit Time
Priority Overnight® PriorityOverNight 1 business day
Standard Overnight® StandardOverNight 1 business day
First Overnight® FirstOverNight 1 business day
2Day® TwoDay 2 business days
2Day® A.M. TwoDayAM 2 business days
Express Saver® ExpressSaver 3 business days
Ground® Ground 1–5 business days
Home Delivery® HomeDelivery 1–5 business days
International Economy® InternationalEconomy 2–5 business days
International Priority® InternationalPriority 1-3 business days
International First® InternationalFirst 1-3 business days

Special Services

  • No special services are supported for FedEx in PackageHub.

Package Types

Name packageType Dimensions Max Weight
Parcel Parcel Custom 70 lbs

FedEx (FUSE)

Services

Name service Transit Time
Priority Overnight® PriorityOverNight 1 business day
Standard Overnight® StandardOverNight 1 business day
First Overnight® FirstOverNight 1 business day
2Day® TwoDay 2 business days
2Day® A.M. TwoDayAM 2 business days
Express Saver® ExpressSaver 3 business days
Ground® Ground 1–5 business days
Home Delivery® HomeDelivery 1–5 business days

Special Services (Domestic)

specialService Priority Overnight® Standard Overnight® First Overnight® 2Day® 2Day® A.M. Express Saver® Ground® Home Delivery®
SignatureConfirmation ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

Package Types

Name packageType Dimensions Max Weight
Parcel Parcel Custom 70 lbs

Additional Info

  • Carrier FedEx-Native only supports ZPL LabelFileType(s).

Landmark Global

Services

Name service
Standard Standard
Expedited Expedited
Standard DDU StandardDDU

Special Services

  • No special services are supported for Landmark Global in PackageHub.

Package Types

Name packageType Dimensions Max Weight
Parcel Parcel Custom 70 lbs

Additional Info

  • Landmark always returns $0 rate in ShipmentRate endpoint.
  • ItemCode (SKU/UPC of the item) is required for Landmark shipment.
  • Generating labels via Shipment endpoint is supported but additional functions like Tracking, Refund and Manifest are not supported.


Extras


HAZMAT

Packagehub supports hazardous material shipping via USPS carriers. In order to ship a hazardous material please pass HAZMAT in SpecialService[] and set hazmatDescription and hazmatPhone in SpecialServiceParam as described in API Docs > Special Service Params.

Additionally when using HAZMAT with USPS-PC-Postage you also need to set one of the following values of hazmatType in specialServiceParam.

HAZMAT Type

Value Description
AirEligibleEthanol Air Eligible Ethanol Package
Class1 Class 1 - Toy Propellant Or Safety Fuse Package
Class3 Class 3 – Package
Class7_Radioactive Class 7 - Radioactive Materials Package
Class8_Corrosive Class 8 - Corrosive Materials Package
Class8_WetBattery Class 8 - Nonspillable Wet Battery Package
Class9_LithiumGroundOnly Class 9 - Lithium Battery Marked - Ground Only Package
Class9_LithiumReturns Class 9 - Lithium Battery - Returns Package
Class9_LithiumMarked Class 9 - Lithium batteries, Marked Package
Class9_DryIce Class 9 - Dry Ice Package
Class9_LithiumUnmarked Class 9 - Lithium batteries, Unmarked Package
Class9_Magnetize Class 9 - Magnetized Materials Package
Div4.1 Division 4.1 - Mailable Flammable Solids and Safety Matches Package
Div5.1 Division 5.1 - Oxidizers Package
Div5.2 Division 5.2 - Organic Peroxides Package
Div6.1 Division 6.1 - Toxic Materials Package (with an LD50 of 50 mg/kg or less)
Div6.2 Division 6.2 Hazardous Materials
ExceptedQuantityProvision Excepted Quantity Provision Package
GroundOnly Ground Only Hazardous Materials
ConsumerCommodity ID8000 Consumer Commodity Package
Lighters Lighters Package
LimitedQuantity LTD QTY Ground Package
SmallQuantityProvision Small Quantity Provision Package

Back to top © A.P. Moller - Maersk