USPS Direct

Configure your account to use USPS Direct service methods.

USPS Direct requirements

To start using USPS Direct service methods within the Shipium platform, you'll need to ensure your account is authorized to interact with USPS's APIs.

A USPS business account is required to use the USPS Direct service methods. You'll need to provide your:

  • company name;
  • contact name; and
  • contact email address.

You also can create a business account and generate a Mailer ID for label generation via the USPS Customer Onboarding Portal: https://cop.usps.com.

If you already have a USPS business account, you should reach out to your USPS account representative for USPS API onboarding support.

Configure USPS Direct for your account

To set up a carrier contract for USPS Direct, you'll need to access the Shipium Console and follow instructions for adding a carrier contract to a fulfillment context. If your organization doesn't use fulfillment contexts for configuration, you can use the fulfillment configuration workflow.

For either approach, once you reach the step to edit or add a carrier account for USPS Direct, you'll be asked to enter credentials required by USPS, in addition to the fields Shipium requires. All fields are required unless noted as optional.

  • Credentials. You'll select USPS Direct Standard Credentials from the dropdown menu.
  • USPS Direct Consumer Key. Your USPS account Consumer Key
  • USPS Direct Consumer Secret. Your USPS account Consumer Secret
  • USPS Direct CRID. Your USPS account Customer Reference/Registration ID
  • USPS Direct MID. Your USPS account Mailer ID
  • USPS Direct Manifest MID. Your USPS account Mailer ID for manifesting
  • USPS Direct Account Number. Optional but required if not providing a permit number and permit ZIP. Your USPS account number; you must provide either an account number OR a permit number and permit ZIP.
  • USPS Direct Permit Number. Optional but required if not providing an account number. Your USPS permit number; you must provide either an account number OR a permit number and permit ZIP.
  • USPS Direct Permit ZIP. Optional but required if providing the USPS Direct Permit Number. The ZIP code associated with your permit number; you must provide either an account number OR a permit number and permit ZIP.
  • USPS Direct Consumer Key (Test Mode). Your USPS account Consumer Key for test mode
  • USPS Direct Consumer Secret (Test Mode). Your USPS account Consumer Secret for test mode
  • USPS Direct CRID (Test Mode). Your USPS account Customer Reference/Registration ID for test mode
  • USPS Direct MID (Test Mode). Your USPS account Mailer ID for test mode
  • USPS Direct Manifest MID (Test Mode). Your USPS account Mailer ID for manifesting for test mode
  • USPS Direct Account Number (Test Mode). Optional but required if not providing a permit number and permit ZIP. Your USPS account number for test mode; you must provide either an account number OR a permit number and permit ZIP.
  • USPS Direct Permit Number (Test Mode). Optional but required if not providing an account number. Your USPS permit number for test mode; you must provide either an account number OR a permit number and permit ZIP.
  • USPS Direct Permit ZIP (Test Mode). Optional but required if providing the USPS Direct Permit Number. The ZIP code associated with your permit number for test mode; you must provide either an account number OR a permit number and permit ZIP.

Shipping options

Packaging types

Priority Mail Flat RateĀ®

USPS Priority Mail Flat Rate is a flat-rate shipping option that lets your organization ship packages that weigh 70 pounds or less to anywhere in the U.S. for a fixed price. You can find more details about this shipping method in USPS's Priority Mail documentation. Shipium supports selection of the Priority Mail Flat Rate shipping method.

To use the USPS Priority Mail Flat Rate shipping method, you'll first need to set up a carrier contract for the USPS Priority Mail Flat Rate in the Shipium Console.

Configure USPS Priority Mail Flat Rate for your account

To start using USPS Priority Mail Flat Rate within the Shipium platform, you'll need to set up your account in the Shipium Console to include the USPS Priority Mail Flat Rate service method. You can find instructions for establishing a fulfillment context for your organization and attaching a carrier service method and rate to that context in the Fulfillment Contexts documentation.

Specifically, once you have configured a fulfillment context with an origin (or fulfillment center), you'll follow the guidance in the Carrier Contracts documentation to establish carrier contracts, accounts, and rates. The carrier rates configuration is where you'll select the USPS Priority Mail Flat Rate service method from a dropdown menu, as shown in the following screenshot.

After completing this configuration, you can designate USPS Priority Mail Flat Rate as your shipping method.

Designate USPS Priority Mail Flat Rate as your shipping method

USPS Priority Mail Flat Rate allows you to use designated packaging and pay one flat rate. The maximum allowed weight is 70 pounds.

To use USPS's packaging for the Priority Mail Flat Rate, you'll need to designate the type of USPS Priority Mail Flat Rate packaging that you wish to use. The following is a snippet of a JSON request call to Shipium's APIs. The minimum required fields for successfully selecting a USPS Priority Mail Flat Rate delivery method are included in the sample request and are defined in the table below. These fields are included in the shipmentParameters or multiParcelShipmentParameters of the call.

"packagingType": {
        "packagingMaterial": "usps_large_box"
      },
      "totalWeight": {
        "weightUnit": "lb",
        "weight": 0.5
FieldRequired / OptionalTypeDescription
shipmentParameters .packagingType .packagingMaterialRequiredString
Values can be:

- usps_large_box
- usps_large_box_to_apo_fpo_dpo
- usps_medium_box
- usps_small_box
- usps_legal_envelope
- usps_envelope
- usps_padded_envelope
The applicable USPS Priority Mail Flat Rate packaging type should be included as the packagingMaterial value.
shipmentParameters .packagingType .totalWeight .weightUnitRequiredString
Weight units include:

- g (gram)
- kg (kilogram)
- lb (pound)
- oz (ounce)
The unit in which weight values are provided
shipmentParameters .packagingType .totalWeight.weightRequiredNumber ($float)
Ex.: 50
The value of the weight; weight is limited to 70 pounds using the USPS Priority Mail Flat Rate service method.

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful: