### Subscriptions - Adjustments API Source: https://developers.usps.com/apis?page=2 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. ```APIDOC ## Subscriptions - Adjustments ### Description 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. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Subscriptions - Tracking 3.0 - Legacy API Source: https://developers.usps.com/apis?page=2 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. ```APIDOC ## Subscriptions - Tracking 3.0 - Legacy ### Description **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. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Subscriptions - Disputes API Source: https://developers.usps.com/apis?page=2 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. ```APIDOC ## Subscriptions - Disputes ### Description 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. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Appointments 3.0 API Source: https://developers.usps.com/apis The Appointments API provides an interface to allow users to schedule and manage their appointments through the Facility Access and Shipment Tracking (FAST) system for drop-ship and other appointments. ```APIDOC ## Appointments 3.0 ### Description The Appointments API provides an interface to allow users to schedule and manage their appointments through the Facility Access and Shipment Tracking (FAST) system for drop-ship and other appointments. Users can provide details of what items are being dropped off and look up available appointment slots at a requested facility. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Service Standards File Download API Source: https://developers.usps.com/apis?page=2 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. ```APIDOC ## Service Standards File Download ### Description 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. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Subscriptions - Package Transaction Details API Source: https://developers.usps.com/apis?page=2 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. ```APIDOC ## Subscriptions - Package Transaction Details ### Description 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. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Disputes 3.0 API Source: https://developers.usps.com/apis The Disputes API provides an interface to allow users to create disputes for USPS pricing. This API is designed to provide users a path to submit a tracking number and transaction for mailer review. ```APIDOC ## Disputes 3.0 ### Description The Disputes API provides an interface to allow users to create disputes for USPS pricing. This API is designed to provide users a path to submit a tracking number and transaction for mailer review in the event that the assessed package charges are not aligned with what the user claimed and mailed. By leveraging this API, users can submit a reason for mailer review and justification for why the assessed pricing was incorrect to receive an adjustment or adjudication on their claim. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Informed Delivery Package Campaigns 3.0 API Source: https://developers.usps.com/apis An interface for shippers to manage interactive Informed Delivery campaigns associated with physical packages. Shippers can submit, edit, cancel, or view details for campaigns displayed to Informed Delivery registered users. ```APIDOC ## Informed Delivery Package Campaigns 3.0 The Informed Delivery Package Campaigns API provides an interface for shippers to manage interactive Informed Delivery campaigns that are associated with physical packages and displayed to Informed Delivery registered users. Shippers can submit new Informed Delivery package campaigns as well as edit, cancel, or view details for previously submitted campaigns using this API. REST View Documentation ``` -------------------------------- ### Every Door Direct Mail API Source: https://developers.usps.com/apis Offers geoprocessing resources for the Simplified Mailing Process. It allows selection of mailing routes by neighborhood, ZIP Code, city, or custom area, and provides statistics like active households and businesses for postage estimation. ```APIDOC ## Every Door Direct Mail The Every Door Direct Mail™ API provides geoprocessing resources to U.S. Postal Service® partners for implementing the Simplified Mailing Process. It enables selection of mailing routes by neighborhood, ZIP Code™, city, or custom area, and returns statistics such as the number of active households and businesses for postage estimation and mailing statements. REST View Documentation ``` -------------------------------- ### Service Standards Directory API Source: https://developers.usps.com/apis?page=2 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. ```APIDOC ## Service Standards Directory ### Description 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. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Carrier Pickup 3.0 API Source: https://developers.usps.com/apis The API supports customers scheduling a carrier to pick up your packages on the next USPS delivery day (Monday through Saturday, excluding holidays) for free. ```APIDOC ## Carrier Pickup 3.0 ### Description The API supports customers scheduling a carrier to pick up your packages on the next USPS delivery day (Monday through Saturday, excluding holidays) for free. Carrier Pickup is available for sending packages using Priority Mail Express, Priority Mail, First Class Package Service Commercial, international delivery services, or for returned merchandise. You are able check availability, schedule, change, cancel and inquire on a carrier pickup. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Subscriptions - NCOA - COMING SOON API Source: https://developers.usps.com/apis?page=2 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. ```APIDOC ## Subscriptions - NCOA - COMING SOON ### Description 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. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Shipping Options 3.0 API Source: https://developers.usps.com/apis?page=2 Receive a comprehensive list of pricing, service standards, and shipping options for USPS products within a single API call. ```APIDOC ## Shipping Options 3.0 ### Description Receive a comprehensive list of pricing, service standards, and shipping options for USPS products within a single API call. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Ship Enrollment 3.0 API Source: https://developers.usps.com/apis?page=2 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. ```APIDOC ## Ship Enrollment 3.0 ### Description 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. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Service Standards 3.0 API Source: https://developers.usps.com/apis?page=2 This API supports the service standards for the number of days between the acceptance and delivery of a piece of mail that the Postal Service™ considers to be timely delivery. ```APIDOC ## Service Standards 3.0 ### Description This API supports the service standards for the number of days between the acceptance and delivery of a piece of mail that the Postal Service™ considers to be timely delivery. Service standards are delivery benchmarks for how long customers can expect for the Postal Service to deliver different types of mail from origin to destination — Point A to Point B. Service standards are not necessarily the same as the actual service performance. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Domestic Labels 3.0 API Source: https://developers.usps.com/apis The Domestic Labels API supports creation of domestic shipping labels with Intelligent Mail Package Barcodes (IMpb). ```APIDOC ## Domestic Labels 3.0 ### Description The Domestic Labels API supports creation of domestic shipping labels with Intelligent Mail Package Barcodes (IMpb). Along with label and barcode creation in PDF, TIFF, SVG, JPG, ZPL203DPI, or ZPL300DPI format, this API validates addresses, confirms product availability, calculates postage, and generates the required Shipping Services File in accordance with USPS Publication 199. The Domestic Labels API allows you to integrate USPS shipping label creation and postage payment fully into your customer-facing or internal fulfillment systems and processes. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Informed Delivery Mail Campaigns 3.0 API Source: https://developers.usps.com/apis An interface for mailers to manage interactive Informed Delivery campaigns associated with physical mailpieces. Mailers can submit, edit, cancel, or view details for campaigns displayed to Informed Delivery registered users. ```APIDOC ## Informed Delivery Mail Campaigns 3.0 The Informed Delivery Mail Campaigns API provides an interface for mailers to manage interactive Informed Delivery campaigns that are associated with physical mailpieces and displayed to Informed Delivery registered users. Mailers can submit new Informed Delivery mail campaigns as well as edit, cancel, or view details for previously submitted campaigns using this API. REST View Documentation ``` -------------------------------- ### Addresses 3.0 API Source: https://developers.usps.com/apis The Addresses API validates and corrects address information, eliminating errors, improving package delivery service and package pricing. This suite of APIs provides different utilities for addressing components. ```APIDOC ## Addresses 3.0 ### Description The Addresses API validates and corrects address information, eliminating errors, improving package delivery service and package pricing. This suite of APIs provides different utilities for addressing components: - The Address Standardization API validates and standardizes USPS domestic addresses, city and state names, and ZIP Codes in accordance with USPS addressing standards. - The City/State lookup provides the valid cities and states for a provided ZIP Code. - The ZIP Code lookup finds valid ZIP Codes for a City and State. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Containers 3.0 API Source: https://developers.usps.com/apis The Intelligent Mail Container barcode (IMcb) provides visibility at the mail aggregate level. It is used on mailer-generated pallet labels to uniquely identify pallets and similar containers. ```APIDOC ## Containers 3.0 ### Description The Intelligent Mail Container barcode (IMcb) provides visibility at the mail aggregate level. It is used on mailer-generated pallet labels to uniquely identify pallets and similar containers (i.e. All Purpose Containers, hampers, pallet boxes, etc.) in addition to identifying the mail owner and, it provides a link between the electronic mailing record and the physical mail aggregate. ### Method REST ### Endpoint View Documentation ``` -------------------------------- ### Domestic Prices 3.0 API Source: https://developers.usps.com/apis Provides Domestic USPS product pricing based on shipment characteristics. It calculates postage prices given inputs like origin and destination ZIP Codes, package weight and dimensions, and mail class. ```APIDOC ## Domestic Prices 3.0 This API provides Domestic USPS product pricing based on the characteristics of what is being shipped for Parcel Select, Parcel Select Lightweight, Priority Mail, Priority Mail Express, USPS Ground Advantage, Library Mail, Media Mail, and Bound Printed Matter. Given inputs, such as origin and destination ZIP Codes, package weight and dimensions, processing category, destination rate indicator, price type, and desired Mail Class and Extra Services, this API will return the price of postage. REST View Documentation ``` -------------------------------- ### Adjustments 3.0 API Source: https://developers.usps.com/apis The Adjustments API provides an interface for retrieving USPS shipping adjustments based on a Package Identification Code (PIC), commonly referred to as a tracking number. ```APIDOC ## Adjustments 3.0 ### Description The Adjustments API provides an interface for retrieving USPS shipping adjustments based on a Package Identification Code (PIC), commonly referred to as a tracking number. This API is designed to help users identify and understand discrepancies in shipping charges, such as those caused by weight, dimensions, packaging, or zone miscalculations. ### Method REST ### Endpoint View Documentation ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.