GET /carrier-pickup/eligibility
Check carrier pickup service availability at the specified address. Either the city and state or the ZIP Code™ is required, in addition to the street address. Successful responses include the USPS standardized address when this location is eligible for carrier pickup.
Servers
- https://api.usps.com/pickup/v3
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
ZIPPlus4 |
String | No |
This is the 4-digit component of the ZIP+4 code. Using the correct Zip+4 reduces the number of times your mail is handled and can decrease the chance of a misdelivery or error. |
streetAddress |
String | Yes |
The number of a building along with the name of the road or street on which it is located. |
secondaryAddress |
String | No |
The secondary unit designator, such as apartment(APT) or suite(STE) number, defining the exact location of the address within a building. For more information please see Postal Explorer. |
urbanization |
String | No |
This is the urbanization code relevant only for Puerto Rico addresses. |
ZIPCode |
String | No |
This is the 5-digit ZIP code. |
state |
String | Yes |
This is two-character state code of the address. |
city |
String | Yes |
This is the city name of the address. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.