USPS

Overview

The Pitney Bowes Complete Shipping APIs let you integrate USPS (U.S. Postal Service) shipping services seamlessly into your platform.

Onboarding a Merchant to use USPS

When you add a merchant to your developer account, the merchant has access to print USPS labels. For adding merchants and for the different enrollment models, see Merchant Accounts.


Shipping Operations

The PB Complete Shipping APIs provide full-featured integration with USPS shipping services:


Supported Services

The following tables provide the service IDs for the supported shipping services. The tables are alphabetized by the “Service” column.

Domestic

ID Service
FCM First-Class Mail
LIB Library Mail
MEDIA Media Mail
PRCLSEL Parcel Select
PM Priority Mail
EM Priority Mail Express
PMOD Priority Mail Open and Distribute
STDPOST Standard Post

International

ID Shipping Service
FCMI First-Class Mail International
FCPIS First-Class Package International Service. For overseas tracking, see Do the APIs support E-USPS DELCON?
EMI Priority Mail Express International
PMI Priority Mail International


Supported Special Services

  • Important: Do not include a special service unless you intend to apply it.

  • Important: The table’s third column lists the services that can use the special service, but use of a special service might be subject to further restrictions, such as compatible parcel types or compatibility with other special services. To determine such restrictions, use the Carrier Rules API.

  • For FCM, if you do not want any special services, either leave out the specialServices array or pass an empty array:

    "specialServices": []
    
  • Input Parameters: A special service can take input parameters, as shown in the example below. The available parameters depend on the carrier rules for the specific combination of service, parcel type, and special service. For more information, see How do I know the input parameters for a special service? The following are example input parameters:

    {
        "specialServiceId": "Ins",
        "inputParameters": [ {
            "name": "INPUT_VALUE",
            "value": "50"
        } ]
    }
    

The following are the available special services. The table is alphabetized by the “Special Service” column.

ID Special Service Services Supporting the Special Service [2]
ADSIG Adult Signature Required FCM, PM, EM, PRCLSEL
ADSIGRD Adult Signature with Restricted Delivery FCM, PM, EM, PRCLSEL
Cert Certified Mail FCM, PM
CERTAD Certified Mail with Adult Signature FCM, PM
CERTADRD Certified Mail with Adult Signature and Restricted Delivery FCM, PM
CertRD Certified Mail with Restricted Delivery FCM, PM
COD Collect On Delivery (COD) FCM, PM, EM, MEDIA, PRCLSEL, STDPOST, LIB
CODRD Collect On Delivery with Restricted Delivery FCM, PM, EM, MEDIA, PRCLSEL, STDPOST, LIB
DelCon Delivery Confirmation FCM, PM, MEDIA, PRCLSEL, STDPOST, LIB
ERR Electronic Return Receipt FCM, PM, MEDIA, PRCLSEL, STDPOST, LIB
hazmat Hazardous Materials FCM, PM, EM, PRCLSEL, STDPOST
holiday Holiday Delivery. EM
Ins Insured Mail FCM, PM, EM, MEDIA, PRCLSEL, STDPOST, LIB, PMI, EMI
InsRD Insured Mail with Restricted Delivery FCM, PM, EM, MEDIA, PRCLSEL, STDPOST, LIB
liveanimal-poultry Live Animal-Day Old Poultry Surcharge FCM, PM, EM, PRCLSEL, STDPOST
liveanimal Live Animal Surcharge FCM, PM, EM, PRCLSEL, STDPOST
PMOD_OPTIONS Priority Mail Open and Distribute PMOD
Reg Registered Mail FCM, PM
RegCOD Registered Mail with COD FCM, PM
RegIns Registered Mail with Insurance FCM, PM
RegInsRD Registered Mail with Insurance and Restricted Delivery FCM, PM
RegRD Registered Mail with Restricted Delivery FCM, PM
RR Return Receipt FCM, PM, EM, MEDIA, PRCLSEL, STDPOST, LIB
RRM Return Receipt for Merchandise FCM, PM, MEDIA, PRCLSEL, STDPOST, LIB
Sig Signature Confirmation FCM, PM, EM, MEDIA, PRCLSEL, STDPOST, LIB
SigRD Signature with Restricted Delivery FCM, PM, MEDIA, PRCLSEL, STDPOST, LIB
SH Special Handling - Fragile FCM, PM, EM, MEDIA, PRCLSEL, STDPOST, LIB
sunday Sunday Delivery EM
sunday-holiday Sunday holiday Delivery EM
[2]A given combination might be further restricted. For all possible restrictions, use the Carrier Rules API.


Supported Parcel Types

The following tables provide the IDs for the supported parcel types. The tables are alphabetized by the “ID” column.

Letters and Flats

ID Parcel Type Services Supporting the Parcel Type
FLAT

Large Envelope/Flat. If you specify FLAT, you must set label size to DOC_6X4 and service ID to FCM. The generated label has an IMb (Intelligent Mail barcode). The label does not display the return address. For additional considerations, please see this IMb FAQ.

Note: Advise shippers to ensure that none of the adhesive backing is exposed when attaching the label. Exposed backings can interfere with mail-processing equipment. Please see What is the correct placement for a shipping label?

FCM
FRE Flat Rate Envelope PM, EM, PMI, EMI
LGENV

Large Envelope/Flat.

Note: Support for the FCM service with this parcel type is deprecated. For the FCM service, use the FLAT parcel type instead.

PM, EM, MEDIA, LIB, FCMI
LGLFRENV Legal Flat Rate Envelope PM, EM, PMI, EMI
LETTER

Letter. If you specify LETTER, you must set label size to DOC_6X4 and service ID to FCM. The generated label has an IMb. For additional considerations, see this IMb FAQ.

Note: Advise shippers to affix the label to the upper right of the envelope and to ensure that none of the adhesive backing is exposed. Exposed backings can interfere with mail processing equipment. Please see What is the correct placement for a shipping label?

FCM
PFRENV Padded Flat Rate Envelope PM, EM, PMI, EMI
SOFTPACK Soft Pack Envelope. For additional information, see this FAQ. PM

Packages

ID Parcel Type Services Supporting the Parcel Type
DVDBOX DVD Flat Rate Box PMI
FRB Medium Flat Rate Box 2 PM, PMI
LFRB Large Flat Rate Box PM, PMI
LP (deprecated) Large Package (deprecated) Support for the LP parcel type is deprecated.
MLFRB Military Large Flat Rate Box PM
PKG Package FCM, PM, EM, STDPOST, PRCLSEL, MEDIA, LIB, FCPIS, PMI, EMI
RBA Regional Box A PM
RBB Regional Box B PM
SFRB Small Flat Rate Box PM, PMI
VIDEOBOX Large Video Flat Rate Box PMI

PMOD Shipments

ID Parcel Type Services Supporting the Parcel Type
EMMTB Extended Managed Mail Tray Box PMOD
FTB Full Tray Box PMOD
FTTB Flat Tub Tray PMOD
HTB Half Tray Box PMOD
SACK Sack PMOD


Supported Label Sizes and Formats

  • Label size uses upper-case X. Using lower case will result in an error.
  • A URL document is available for 24 hours after the document is created.
  • Advise shippers on correct label placement. Please see What is the correct placement for a shipping label?
  • International shipments use customs forms CN 22, CP72-A, and CP72-B. For more information, see this FAQ.
  • By default, the APIs print ZPL2 labels using the Unicode character set. If you have an older printer that does not support Unicode, see this Troubleshooting topic.
Label Size File Format Content Type
DOC_4X6 PDF

PNG

ZPL2 [1]
URL

BASE64

BASE64
DOC_4X8 PDF

PNG

ZPL2 [1]
URL

BASE64

BASE64
DOC_6X4 PDF

PNG

ZPL2 [1]
URL

BASE64

BASE64
DOC_8X11 PDF

PNG
URL

BASE64
[1](1, 2, 3) By default, the APIs print ZPL2 labels using the Unicode character set.
If you have an older printer that does not support Unicode, see
this troubleshooting topic.

Example documents object:

"documents": [ {
    "type": "SHIPPING_LABEL",
    "size": "DOC_4X6",
    "fileFormat": "PDF",
    "contentType": "URL",
    "printDialogOption": "EMBED_PRINT_DIALOG"
} ]