PUT /carrier-pickup/{confirmationNumber}
Update information contained in a previously scheduled carrier pickup such as the pickup date, the types and counts of packages for the carrier to pick up, the weight or the pickup location.
Servers
- https://api.usps.com/pickup/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
confirmationNumber |
String | Yes |
This is the Carrier Pickup confirmation number. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
If-Match |
String | Yes |
The value of the entity tag indicating the version of the resource to get or update. All DELETE and PUT operations require an ETag to be supplied as the If-Match parameter. The ETag is returned in the GET operation and is good for one hour or until it is used in a DELETE or PUT operation. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
pickupDate |
String | No |
This is the scheduled pick-up date. |
carrierPickupRequest |
Object | No |
The Schedule Carrier Pickup Request includes all of the necessary information to schedule a package pickup from your carrier. |
carrierPickupRequest.pickupAddress |
Object | Yes |
This is the point of contact information for a potential pickup. |
carrierPickupRequest.pickupAddress.contact[] |
Array | Yes |
One or more contact methods used to facilitate package pickup. |
carrierPickupRequest.pickupAddress.lastName |
String | No |
This is the last name corresponding to the address. |
carrierPickupRequest.pickupAddress.firstName |
String | No |
This is the first name corresponding to the address. |
carrierPickupRequest.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. |
carrierPickupRequest.packages[] |
Array | Yes |
The details on the types and amounts of packages ready for pick-up. |
carrierPickupRequest.packages[].packageType |
String | Yes |
This is the type of package ready for pick-up Possible values:
|
carrierPickupRequest.packages[].packageCount |
Integer | Yes |
Number of packages ready for pick-up for the associated Mail Class. |
carrierPickupRequest.estimatedWeight |
Number | Yes |
Estimated aggregate weight (in pounds) of all packages ready for pick-up. |
carrierPickupRequest.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. |
carrierPickupRequest.pickupLocation |
Object | Yes |
Details of where to pickup packages. |
carrierPickupRequest.pickupLocation.packageLocation |
String | Yes |
This is the location of the packages ready for pick-up at the pickup address. Possible values:
|
carrierPickupRequest.pickupLocation.specialInstructions |
String | No |
Additional details on where the packages can be picked-up. This is required when the package location is 'OTHER'. |
confirmationNumber |
String | No |
This is the USPS assigned confirmation number of the pick-up. |
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.