How to Create USPS API Credentials

How to Create USPS API Credentials

Overview

This article walks you through the steps for creating USPS API credentials using the USPS Developer Portal↗. These credentials allow your your Spirit Sale stores to securely access USPS APIs for services such live shipping rates.

Steps to Create API Credentials

1. Onboard via the Customer Onboarding Portal (COP)

  2. Click Customer Onboarding Portal (COP).

  3. Log in with your USPS Business Customer Gateway account or click Create New Account to register.

  4. Complete the profile with your email, company address, and contact information.

  5. If required, add your Enterprise Payment Account.


2. Log into the USPS Developer Portal

  2. Sign in using your USPS Business Account credentials.

  3. You’ll land on the Developer Portal Dashboard.


3. Create an App

  1. In the left-hand menu, click Apps.

  2. Select Add App.

  3. Complete the form:

    • App Name (required)

    • Callback URL (leave blank)

    • Description (optional)

    • Select one or more of the available API Products 

  4. Click Add App.


4. Retrieve Your API Credentials

  • After creating your app, open the Credentials tab.

  • Copy your Consumer Key and Consumer Secret.

  • Store them securely.


4. Save Your USPS API Credentials to Spirit Sale

  • Login to your Spirt Sale account.

  • From the Dashboard go to Setting --> Shipping Setup --> Select USPS under

  • Store them securely (for example, in environment variables or a secrets manager).

  • Enter your Consumer Key into the USPS Consumer Key field then the Secret into the Consumer Secret field. 

  • Press the Green Up button.

Alert
Users should not toggle on "USE USPS LEGACY SERVER" unless your USPS API credentials were created under the USPS Legacy Developer portal at developer.usps.com, and not at developers.usps.com. 


  • If your USPS credentials are successful accepted, you see the follow message in the bottom right-hand of the screen.  If not, verify that your Consumer and Secret keys are correctly entered.



Helpful Tips

  • Your default app subscription typically includes base API and with a quota of ~60 calls/hour. Contact USPS API Support to increase this. 

  • Support: For issues, use the “Email Us” form in the Developer Portal or contact USPS API support at apisupport@usps.gov.


    • Related Articles

    • Updating Your USPS Credentials in Spirit Sale (Migration to New USPS APIs)

      Who Does This Apply To This information only applies to Spirit Sale stores still using the older USPS Web Tools (Legacy) API for live shipping rates. You do NOT need to follow this guide if: You don't use USPS for shipping. You already migrated to ...

    • How to Set Up Your Stripe API Keys With Spirit Sale

      Overview Spirit Sale integrates directly with Stripe to process payments. To connect your store, you’ll need your live publishable key and live secret key from Stripe. Important Notes: Only standard live keys are supported. Restricted keys will not ...

    • Promo Codes: Apply Taxes Before or After Discount

      About We’ve added a toggle on each promo code that lets you choose how sales tax is calculated relative to the discount. You can now apply promo discounts before taxes (traditional) or after taxes (taxes calculated on the pre-discount subtotal). This ...

    • Setting an upcharge for Customization

      Create the product with the logo and the text for personalization. Then go to manage variants. Click on Set Global Price. Enter the price for all variants Then the up charge for the name. click update. On the store you will see

    • How to add upcharges for optional designs on a product

      Either create a new product or find and open a product you would like to edit by going to Products --> Products from your Spirit Sale dashboard, then open a product. In the properties of a product click the Manage Variants tab. Under the Manage ...