USPS | EasyStore - Documentation | JoomShaper
🎃 Halloween Sale is Live! Get 35% OFF on all plans. Sale ends soon! Get Offer

EasyStore

Updated Last: 23 September 2025

USPS

EasyStore integrates with USPS, one of the most popular shipping carriers in the United States. This integration enables merchants to offer it as a reliable shipping option at checkout. After setup, they can manage shipping rates and generate shipping labels directly from EasyStore.

Before You Begin

To integrate USPS, ensure you have the following:

  • An active USPS merchant account
  • API credentials (Account Number and Password for both Live and Test modes)
  • Shipping regions configured in EasyStore

Adding USPS As Your Shipping Carrier

  1. Log in to your Joomla Dashboard and navigate to Components > EasyStore > Settings > Shipping.

    Navigate to EasyStore Shipping
  2. If your region is already set up, click the three-dot icon next to it and select Edit. If you haven't set up your regions yet, you'll need to configure them first before you can add any shipping carriers.

    Choose Your Country
  3. Scroll down to the Add Shipping Carrier section and click on the Add Carrier button to open the list of available shipping providers.

    Add Shipping Carrier
  4. Locate USPS in the list and click the Add button.

    Add USPS Shipping Carrier
  5. After completing the setup, click the "Back to the list" button. USPS will now be added to your store’s available shipping options. 

    Enable USPS Shipping Carrier

Enable the toggle switch to make USPS visible as a shipping option on the checkout page. 

Note: For the shipping carrier to appear at checkout, make sure your Store Address in General Settings is complete and includes the correct Country and ZIP Code.

Configuring USPS Shipping Carrier

Configuring USPS Shipping Carrier


After adding USPS as your preferred shipping carrier, locate it in the list and click the "Setup" button next to it.

This will open a pop-up window where you can configure the USPS settings for smooth integration with your store’s shipping process.

Title

Give your integration a title (e.g., "USPS"). This is a user-defined title that helps you identify this integration within your Joomla Dashboard.

Environment

Choose either "Live" or "Test" mode based on your needs. Select "Live" to process actual shipments in a production environment, or "Test" to simulate shipping for setup and testing purposes.

Sandbox Client ID/Production Client ID

Insert your Live or Test client ID you received while creating your USPS account.

Sandbox Client ID/Production Client Secret

Enter the Live or Test client password that you set when creating your USPS account.

Default Origin ZIP

Choose the default origin ZIP code. This is the ZIP code of the region you are operating or shipping from.

Default Package Weight

Set the default package weight.

Default Package Length

Set the default package length.

Default Package Width

Set the default package width.

Default Package Height

Set the default package height.

Pricing based on package weight is pre-configured to match USPS’s standard pricing rates. For the most up-to-date information on USPS’s Shipping Services, refer to the official USPS website

After configuring the USPS shipping carrier, click "Save and Close" to apply and save your changes.

Displaying USPS as the Shipping Method on the Checkout

Once USPS is selected as the shipping carrier, customers will be able to choose a shipping method based on the enabled services.

For example, if a customer selects New York as their city and enters the zip code 10001, the available pickup points corresponding to that location will be displayed in the pickup point list. 

Please note that for USPS to appear as a shipping method during checkout, customers must select a city and provide a valid zip code.

Currency Rates

By default, the US currency rate will be set for the products. However, if you are shipping internationally, you can set the rates. Refer to the USPS official website to learn more about shipping rate changes.

How To Get API Key, Secret Key, and Account Number

To get your Client API Key, Secret Key, and Account Number, you will need to head over to the official USPS Developers website and sign up for a DHL account or log in to an existing account. Then, you will have to follow the given steps:

  • From the left menu on the developers dashboard, navigate to Apps and click Add App.
  • Fill up the required fields, such as “App Name”, and select the required APIs. You particularly require the Shipping Options 3.0 API. Click Add App to save.
  • Open the App you just created and go to the Credentials section.
  • Retrieve your Consumer Key (Client ID) and Consumer Secret (Client Secret). These credentials are used to generate OAuth tokens and grant your app access to USPS APIs.
  • You may also need to enter your CRID (Customer Registration ID), MID (Mailer ID), Manifest MID, and USPS Account Number, depending on which APIs you plan to use.

To learn more about how to acquire your API credentials, please refer to the official USPS documentation.