Installation

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.

USPS account

To integrate with USPS APIs in both Production and Test environments, developer registration is required. Follow these steps to proceed:

1. Register for a free account at USPS.com.

2. Access the Business Customer Gateway and complete the setup process for a USPS business account.

3. Log in to the USPS Developer Portal using your USPS credentials via the Sign Up / Login interface.

4. Register your application within the Developer Portal to obtain your consumer key and consumer secret, available under the Credentials section of your account dashboard.

Get API credentials

1. Using your USPS credentials to log in to the USPS Developer Portal

2. Click on link "Apps" on header of the page.

3. Enter button "Add app".

4. Fill in your "App name", enable "Public access 1" and save the form.

5. Copy the "Consumer Key" and the "Consumer Secret". You need them in the extension.

Install & configure 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.

General properties

In this area you can choose your zipcode and the unit of weight of the products.

Field	Type	Description
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
Show message why a shipping method is not available	Toggle	Display a hint why USPS shipping methods are not available. It only shows a message on an error. For instance: Missing weight of products or invalid format of address.
Log Level	Dropdown	Select whether only errors should be recorded in a log file or also debug information.

USPS api access

Enter you API credentials and check if they are working.

Field	Type	Description
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.

Configure shipping methods

Follow the Shopware 6 documentation 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.

If you have multiple languages then don't forgett to save the shipping method for every language by choosing the language in the dropdown, selecting the USPS shipping method and clicking Save button. Otherwise the USPS shipping methods could not be detected correctly in checkout.

Available Shipping Methods

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

Add an additional shipping fee

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.

Availability shipping rules

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 your USPS shipping method is not shown after register/ login please check the following points:

• Have you checked the API crendentials in extension configuration?

• Have you defined a zipcode of United States, Puerto Rico or US Virgin Islands in extension configuration?

• Do the products in cart have a weight?

• Are your shipping rules matching the current customer?

• Did you assign your new shipping methods to your shops sales channel?

Error and Debug Logfile

If an error with API connection occured it is logged into a file located at folder var/log of Shopware base dir. In extension configuration you can also define, that debug information will be logged.