Installation
Last updated
Was this helpful?
EN
Last updated
Was this helpful?
First of all you need an USPS account and create API credentials. After that you can install and configure the extension and the shipping methods in your shop.
To integrate with USPS APIs in both Production and Test environments, developer registration is required. Follow these steps to proceed:
Register for a free account at .
Access the and complete the setup process for a USPS business account.
Log in to the using your USPS credentials via the Sign Up / Login interface.
Register your application within the Developer Portal to obtain your consumer key and consumer secret, available under the Credentials section of your account dashboard.
Using your USPS credentials to log in to the
Click on link "Apps" on header of the page.
Enter button "Add app".
Fill in your "App name", enable "Public access 1" and save the form.
Copy the "Consumer Key" and the "Consumer Secret". You need them in the extension.
Install the extension via Extensions > My Extensions.
Before you enable the extension, check the settings in this section and ensure they meet your requirements. Make any changes to individual fields as described below by selecting My extensions > USPS Shipping Rates > Configure.
In this area you can choose your zipcode and the unit of weight of the products.
Sender zip
Textfield
Please enter you zipcode. It must be a zip of United States, Puerto Rico or US Virgin Islands.
Unit of weight
Dropdown
Please select which unit of weights you use for your products in shop
Log Level
Dropdown
Select whether only errors should be recorded in a log file or also debug information.
Enter you API credentials and check if they are working.
Consumer Key
Password field
Enter your USPS Consumer Key here.
Consumer Secret
Password field
Enter your USPS Consumer Secret here.
Mode
Dropdown
Choose if you want to test the credentials in Test or Live mode
Check credentials
Button
After entering Consumer Key and Consumer Secret click this button to check the credentials.
The following USPS mailings are supported:
Parcel Select
Priority Mail Express
Priority Mail
Library Mail
Media Mail
Bound Printed Matter
USPS connect local
USPS Connect Mail
USPS Connect Regional
USPS Ground Advantage
First Class Package International Service
Priority Mail International
Priority Mail Express International
Additionally to the shipping rates you got from USPS, you can also define an additional fee for your shipping methods. Just use the Add price matrix at a shipping method in Shopware administration. If you define a price here, it will be added to the USPS price of the shipping method.
By extension default USPS shipping methods are hidden if a customer is not logged in or no valid USPS mailings were found for the current order. Additionally you can define further shipping rules. For instance to enable shipping only for specific customer groups.
If an error with API connection occured it is logged in a file located in folder var/log of Shopware base dir. You can also define in extension configuration, that debug information will be logged in that file.
Follow the Shopware 6 to create a shipping method for each USPS shipping type you want to support. After saving and re-opening a shipping method in Shopware admin, you can assign it to an USPS shipping method by selecting the related USPS method in the custom fields area.
