Follow the steps below to obtain your USPS API credentials and integrate them with the ShipX app.
How to generate and connect USPS API credentials to the ShipX app
Step 1: Visit the USPS Developer Portal and Sign in or Sign up
- Go to the official USPS Developer Portal.
- Log in using your existing USPS Developer account.
- If you do not have one, click Sign Up and complete the registration form to create a new account.
Step 2: Create a new app
- After logging in, navigate to the Apps tab and click on Add App.
- Enter an app name (e.g., ShipX Integration).
- Leave the remaining fields blank.
- Check the box for Enable Public Access, then click Add App.
Step 3: View your USPS credentials
- Once the app is created, click the Edit button next to your newly created app.
- Switch to the View tab to access your API credentials.
- Under the Credentials section, copy the following details:
- Customer Key (Client ID)
- Consumer Secret (Client Secret Key)
These credentials are required for integration with the ShipX app.
Migration from Older USPS API (Optional)
If you are switching from the legacy USPS API (User ID-based), click Migrate to the New USPS API and then paste your new credentials to complete the transition.
Note: Ensure that your credentials are entered correctly to avoid validation errors. If you encounter issues, refer to the USPS Developer documentation or contact our support team for assistance.
How to sync USPS with ShipX
Follow the steps below to connect your USPS account and fetch live carrier rates in ShipX.
1. Go to Rates and click View on Scenarios.
2. Select the scenario where you want to add USPS rates.
3. Under shipping rates, click Add shipping rate on the preferred shipping zone.
4. Select Live carriers as your rate type.
5. Enter a name for your shipping rate.
6. Choose USPS as your live carrier and click Sync.
7. Enter your USPS credentials:
- Client ID
- Client secret key
After entering the details, click Save.
8. Under shipping location, choose Use Shopify location, or Specify different location.
9. Under service by carrier, select how you want to display services:
- Show all services
- Show service with highest rate
- Show service with lowest rate
10. Enable commercial rates option to request commercial rates and services from USPS.
11. Select the services you want to offer from USPS.
12. Choose your packaging method:
- Pack by cart attributes: Create packages based on weight, volume, quantity, or total value.
- Pack each product separately: Every product is packed individually.
- AI-based packaging algorithm: Automatically finds the most efficient box combination using item dimensions and weights.
13. If you selected Pack by cart attributes or AI-based packaging algorithm, click Add package to add your packaging boxes.
14. Enter your package details:
- Package name
- Package max limit
- Package dimensions (Length x Width x Height)
- Empty box weight
Click Add package or Add.
Note: For AI-based packaging algorithm, enter the inner and outer dimensions of packages to calculate the shipping rates.
13. Set a fallback rate to prevent shipping losses if the carrier fails to fetch a live rate.
14. Click Save to complete the setup.
If you need further assistance, please contact our customer support team.