Table of contents

Getting Started

Create your first label

To retrieve create a shipping label based on an available rate, you need to follow these simple steps:

  1. Setup a new PackageHub Account (blue objects below).
  2. Optional - Get shipping rates for all available rates (yellow object below).
  3. Create a shipping label (green object below).

Step 1: Set up a new PackageHub Account

Setting up a PackageHub Account will allow you to put a credit card or ACH payment information on file in order to fund your generated labels. To ensure that the labels and funds are managed appropriately for the account, make sure to send the EmailAddress, FirstName, LastName, UserName, Password, and CompanyName for the account holder. Auto Renew can be enabled when opening a new account so that can automatically purchase additional postage when the balance falls below a set threshold. For more information see our Add Funds to Account Methond in the API Docs.

1.1 Approve Terms and Conditions

After an account has been created successfully, you will get the response with your newly assigned Visible Account Number. You will also see a message stating, “You must accept the Terms And Conditions before this new account is activated." To do this you will make a call to the approvetermsandconditions method and provide the approver name and the VisibleAccountNumber. You will receive a response that your Terms & Conditions have been accepted and your account is now active.

1.2 Add Funds to Account

Your next step is to add funds to your account. You can do this during the initial account set up by Enabling the AutoRenewEnabled, providing the AutoRenewAmount and AutoRenewThreshold. If AutoNewEnabled is set to true, you must provide payment information in the form of a credit card or ACH Payment. If payment was not configured at the time of opening the account, you can update the account and provide the payment details you wish to store for this account. Enabling AutoRenew is an option. If you opt out of setting this up, you can manually add funds to your account by making a request in the Add Funds to Account method. Here you will provide the amount of postage you wish to purchase, as well as, your VisibleAccountNumber.

Step 2: Optional - Get shipping rates for all available rates

IF you aren’t sure of which service to use for your package, or if you want to rate shop, you have the option to retrieve a list of available services including shipping rates. From there you can determine which service best fits your needs to the package. To do this you will provide the

ShipToAddress
,
ShipFromAddress
, Packages Object Details (
PackageType
, Dimensions – Height, Width, Length, UnitOfMeasure, Weight – Value, UnitOfMeasure and the VisibleAccountNumber. The Rate a Shipment method has additional properties that you can find in our API Docs.

Step 3: Create Shipping Label

Once you know which service you will be using for your package, you are ready to create a shipment. Use the Create Shipment method to create a new shipment with its corresponding rate and label. You will need to send the name of the Carrier being used for the shipment, the ServiceType, OrderNumber, ShipToAddress, ShipFromAddress, ShipDate,

Name
of any Shipment Options that are being used, if any, Packages Object Details (PackageType, Dimensions – Height, Width, Length, UnitOfMeasure, Weight – Value, UnitOfMeasure and the VisibleAccountNumber. The Create Shipment method has additional properties that you can find in our API Docs.

Next Steps

For detailed guides on advanced functionalities or to explore all of our supported services see our API Docs.

We recommend looking deeper into the functionalities of:

  • Rate A Shipment
  • Verify Address
  • International Shipping Labels
  • Create Manifests
  • Track Packages