United States Postal Service


Download 31.3 Kb.
NameUnited States Postal Service
A typeDocumentation
manual-guide.com > manual > Documentation


United States Postal Serviceunited states postal service logo

Web Tools Frequently Asked Questions

Document Version 1.0 (1/22/2015)

Table of Contents

Frequently Asked Questions 3

General Questions 3

Are the USPS APIs free? 3

How do I get access to USPS APIs and receive my Web Tools user ID? 3

How do I gain access to Label Printing and Package Pickup APIs 3

How do I pay for the postage for my labels? 3

Why are my Web Tools credentials not working when I try to login on usps.com? 4

I have registered for Web Tools, what are the next steps? 4

Why are the production server URLs I received not working when I click on them? 4

[Labels] – The label I generated displays “Postage Required,” how do I pay for the label? 5

[Labels] – The labels I am able to print contain a “SAMPLE-DO NOT MAIL” watermark. How can I print actual labels? 5

[EDDM] – Does USPS have an EDDM API available? 5

Troubleshooting Questions 5

I am using a third party ecommerce software to connect to USPS APIs and I am having issues retrieving prices or services from USPS. 5

I have contacted my software provider and I still have questions for USPS, how do I proceed? 5

Have there been any recent or upcoming changes to Web Tools API? 6



Frequently Asked Questions



General Questions

Are the USPS APIs free?


Yes, we allow all customers who have registered for a Web Tools account and agreed to the terms and conditions of use access to USPS APIs free of charge.

How do I get access to USPS APIs and receive my Web Tools user ID?


The first step to gaining access to USPS APIs is to register for a Web Tools user account located at https://www.usps.com/business/web-tools-apis/web-tools-registration.htm. Upon successful registration, you will automatically receive an email containing your assigned Web Tools User ID. Upon receiving this email users will can begin using the following APIs:

  • Price Calculators

  • Package Tracking

  • Service Standards

  • Commitments

  • Address Information

How do I gain access to Label Printing and Package Pickup APIs


Permissions for creating shipping labels without postage and scheduling Package Pickups are added separately. To obtain these permissions contact our Internet Customer Care Center (uspstechnicalsupport@mailps.custhelp.com) and include "Web Tools API Access" in the subject line. An agent will be happy to assist you. For Label API permission requests, indicate in the body of the email:

  • Which Label APIs you would like to access

  • If you will be modifying the label image

  • How you intend to pay for label postage as payment cannot currently be remitted directly to USPS through the API (For information on postage payment options visit: https://www.usps.com/business/postage-options.htm)

How do I pay for the postage for my labels?


We do not currently offer the ability to pay for postage directly to USPS through Web Tools APIs. For lower-volume customers, you can pay for postage at your local retail location, through a 3rd party PC postage provider or print and pay for labels directly through Click-N-Ship at https://www.usps.com/ship/print-a-label.htm. For information on postage payment options visit: https://www.usps.com/business/postage-options.htm

Why are my Web Tools credentials not working when I try to login on usps.com?


This is a common misconception with our users. There is no "log in" functionality for your Web Tools credentials. Your username and password will allow you to gain access to the Web Tools servers. Your credentials are only intended to be or input into, 1.) the login interface of your third party software or 2.) incorporated into your back-end programming in the API, XML request. The login page shown on the usps.com website is not associated to APIs. Please review the technical documentation at https://www.usps.com/business/web-tools-apis/technical-documentation.htm if you need more information about integration.

I have registered for Web Tools, what are the next steps?


For shippers using a third party shipping software or shopping cart provider we recommend you refer to your software provider for instructions to begin offering USPS services, take note of relevant information provided in the registration email and links below. For developers integrating Web Tools into a custom application we specifically recommend:

  • Step-by-Step Instructions for All USPS Web Tools (important information when getting started): https://www.usps.com/business/web-tools-apis/general-api-developer-guide.pdf

  • API User’s Guides (API specific technical/integration information): https://www.usps.com/business/web-tools-apis/technical-documentation.htm

  • USPS Web Tools website: (contains all these resources and more): https://www.usps.com/business/web-tools-apis/welcome.htm

Why are the production server URLs I received not working when I click on them?


The production URLs included in the email confirming your registration with Web Tools are not links to a viewable website. These URLs must be included in the XML Request used to connect to our APIs (please refer to our technical documents for more information https://www.usps.com/business/web-tools-apis/welcome.htm). If you are using a third party ecommerce software it’s possible that these URLs are not required and therefore do not apply to all customers using our APIs. Please contact your specific software provider for more specific details concerning integration requirements.

[Labels] – The label I generated displays “Postage Required,” how do I pay for the label?


The Web Tools APIs only print labels without postage and the APIs are not linked to your USPS.com account or payment methods. Lack of integrated payment through our APIs is a common complaint and we are working hard to add this, however, we are still in the very early stages. For information on our partners who offer payment integration, please follow this link:

https://www.usps.com/business/online-postage.htm. Due to the fact that our APIs are not directly connected to a payment account, we recommend customers pay for postage using either a third party postage meter or at the post office.

[Labels] – The labels I am able to print contain a “SAMPLE-DO NOT MAIL” watermark. How can I print actual labels?


The API containing "certify" is our testing API and will print labels with the sample watermark. In order to generate actual labels you must remove "Certify" from all of your Web Tools requests.

[EDDM] – Does USPS have an EDDM API available?


We currently only offer EDDM services through our online application at: https://eddm.usps.com/eddm/customer/routeSearch.action . We are evaluation adding EDDM capabilities. Please keep up to date with new APIs at www.usps.com/webtools.

Troubleshooting Questions

I am using a third party ecommerce software to connect to USPS APIs and I am having issues retrieving prices or services from USPS.


Due to the fact that USPS has no insight into the specific integration requirements of all the possible software options available, we recommend that customers first contact their specific provider to troubleshoot integration-specific questions.

I have contacted my software provider and I still have questions for USPS, how do I proceed?


The USPS will be happy to assist all customers provided the following information is included when contacting our Internet Customer Care Center at uspstechnicalsupport@mailps.custhelp.com. Customers must provide:

  • Copy of a sample XML request resulting in the issue or error, pasted into the body of the email

  • Complete description of exact issue you are experiencing

  • Name of API

  • Name of third party software provider

Please note that without the above information, our USPS agents will not have sufficient information to investigate Web Tools API issues properly.

Have there been any recent or upcoming changes to Web Tools API?


In order to provide the very best API offering, we periodically update our systems which may require current customers to update their software. To determine if these changes/updates apply to you, please refer to our most recent Release Notes posted in our ‘Announcements’ section on the Web Tools website: https://www.usps.com/business/web-tools-apis/welcome.htm. This document contains all new changes and steps to resolve if you are affected. Please remember to first contact your software provider for any integration-related questions.

Share in:

Related:

United States Postal Service iconUsps, United States Postal Service, First-Class Mail, Standard Mail,...

United States Postal Service iconUnited states postal service chief foia officer’s report for 2017

United States Postal Service icon[usps official’s name and title] United States Postal Service “Heart...

United States Postal Service iconPlan The United States Federal Government should rule that the President’s...

United States Postal Service iconAbstract the United States Coast Guard plans to provide a Differential...

United States Postal Service iconSent via U. S. Postal Service Certified/Registered mail #

United States Postal Service iconPostal scale instructions eX3 / eX5 / eX10 Electronic Postal Scales

United States Postal Service iconUnited states

United States Postal Service iconHistory Alive! The United States

United States Postal Service iconUnited states department of education

United States Postal Service iconSupreme court of the united states

United States Postal Service iconSupreme court of the united states

United States Postal Service iconCity Directories of the United States

United States Postal Service iconUnited states master specification

United States Postal Service iconThe united states bankruptcy court

United States Postal Service iconIn the united states district court

United States Postal Service iconIn the Supreme Court of the United States

United States Postal Service iconPrinted in the united states of america

United States Postal Service iconUnited states district court

United States Postal Service iconHandbook for immigrants to the United States




manual


When copying material provide a link © 2017
contacts
manual-guide.com
search