APIs

The Service Standards Directory provides a secure and efficient way to return service standard data for 3 or 5-digit ZIP Codes. Utilize the /zip5codes and /reporter endpoints to return paginated Service Standards data.

The Service Standards File Download API provides an efficient way for mailers to download Service Standards files so they can be consumed programmatically and not require manual intervention.

The Ship Enrollment API allows a user to check if their MID is enrolled in USPS Ship. If enrolled, the enrolled programs (such as Outbound and Returns) and the date the MID was enrolled will be returned in the response.

Receive a comprehensive list of pricing, service standards, and shipping options for USPS products within a single API call.

This API allows customers to create and manage their subscriptions for any adjustments on their packages.  This also includes the listener endpoint specifications for the webhook to receive adjustment event notifications per package.

Adjustments are any changes or discrepancies detected in the mailstream against a package's manifested characteristics that affect the package's pricing.  For example, if a package was manifested with one weight and mailed with another, an adjustment may be issued for the difference in pricing.

This API allows customers to create and manage their subscriptions for any disputes on their packages.  This also includes the listener endpoint specifications for the webhook to receive dispute event notifications per package.

Disputes are filed when a postage adjustment needs to be reviewed. For example, if discrepancies were detected by mail processing equipment and an adjustment was issued, a dispute can be filed to review the detected pricing discrepancy. If the dispute is granted, the pricing will be adjusted based on the results of the dispute.

The Subscription NCOA+ API uses a secure dataset built from the names and addresses of individuals, families, and businesses that have submitted a change of address request to the Postal ServiceTM. It allows mailers to receive updated change of address information for subscriptions so they can update their mailing list with the most current addresses before sending mail. This also includes the listener endpoint specifications for the webhook to receive change of address event notifications per subscription.

The Subscriptions-Package Transaction Details API enables users to create a subscription to receive USPS Ship package transaction details by Customer Registration ID. When a package transaction detail event occurs for a package associated to the Customer Registration ID, a notification will be sent to the Listener URL provided in the subscription. The notification will contain details about the package transaction including any adjustments made to the postage amount.

Note: All new development for tracking should be done toward the Tracking 3.2 API instead of Tracking 3.0. This ensures your application has access to the most up-to-date features and long-term support.

Create a subscription to receive tracking events by mailer ID or tracking number. Manage all tracking subscriptions, in one place, by providing your server URL to receive Postal Service tracking events.  This also includes the listener URL specifications for the webhook to receive tracking notifications per package.

This is the modernized Subscriptions - Tracking API, where the notification event payload follows the modernized Tracking API response. The modernized API introduces the Scan Event Extract tracking event type for MID-based subscriptions, which includes additional attributes in the notification event payload . Create a subscription to receive tracking events by mailer ID or tracking number. Manage all tracking subscriptions, in one place, by providing your server URL to receive Postal Service tracking events.

This API allows a customer to create a subscription to receive information for packages that do not have an associated payment record when scanned on mail processing equipment to gain an understanding of what pieces are at risk of intercept and to quickly pay for any unpaid pieces.  This also includes the listener URL specifications for the webhook to receive unpaid package event notifications per mailpiece.

Note: All new development for tracking should be done toward the Tracking 3.2 API instead of Tracking 3.0. This ensures your application has access to the most up-to-date features and long-term support.

This API returns tracking status and related details for a given USPS package, including scan events and their date, time, and location. The Tracking APIs allow you to integrate the status of your shipment into your customer-facing experience and internal fulfillment processes that will benefit your company by:

• Providing your customers with the latest status and delivery expectations while keeping them within your company’s or organization’s website.

• Integrating status and delivery information for incoming packages or customer returns directly into your systems and processes so that you know when a package will arrive at your facilities.