POST /carrier-pickup
Schedule a carrier pickup on a specified date. You can schedule pickups Monday - Saturday until 2:00 AM CT on the day of the pickup. After 2:00 AM CT, same-day pickup is not available. If the address is eligible for carrier pickup, then you can schedule your pickup up to one year in advance.
Servers
- https://api.usps.com/pickup/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
pickupAddress |
Object | Yes |
This is the point of contact information for a potential pickup. |
pickupAddress.contact[] |
Array | Yes |
One or more contact methods used to facilitate package pickup. |
pickupAddress.lastName |
String | No |
This is the last name corresponding to the address. |
pickupAddress.firstName |
String | No |
This is the first name corresponding to the address. |
pickupAddress.firm |
String | No |
This is the firm corresponding to the address. Firm is required for all domestic addresses in international label requests due to customs form requirements. |
packages[] |
Array | Yes |
The details on the types and amounts of packages ready for pick-up. |
packages[].packageType |
String | Yes |
This is the type of package ready for pick-up Possible values:
|
packages[].packageCount |
Integer | Yes |
Number of packages ready for pick-up for the associated Mail Class. |
estimatedWeight |
Number | Yes |
Estimated aggregate weight (in pounds) of all packages ready for pick-up. |
pickupDate |
String | Yes |
This is the requested pickup date. You can schedule pickups Monday - Saturday until 2:00 AM CT on the day of the pickup. After 2:00 AM CT, same-day pickup is not available. |
pickupLocation |
Object | Yes |
Details of where to pickup packages. |
pickupLocation.packageLocation |
String | Yes |
This is the location of the packages ready for pick-up at the pickup address. Possible values:
|
pickupLocation.specialInstructions |
String | No |
Additional details on where the packages can be picked-up. This is required when the package location is 'OTHER'. |
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.