Schedule a pickup
Schedule a USPS carrier pickup at a specified address
Schedule a carrier pickup to have USPS collect packages from your address. Currently supports USPS only.
Label Verification Required
You must have at least one active USPS label (status: generated or printed) with a ship-from address matching the pickup ZIP code. Requests without matching labels will return a NO_ACTIVE_LABELS error.
Parameters
Request Body
carrier
string (USPS)
Carrier code. Currently only USPS is supported. Defaults to USPS.
pickup_date
string
Required
Pickup date in YYYY-MM-DD format. Must be today or a future date.
pickup_address
object
Required
Pickup location with name, street1, city, state, zip, and phone.
package_count
integer
Number of packages to pick up. Defaults to number of matching active labels.
total_weight
number
Total weight of all packages in oz.
packages
array
Breakdown by service type. Each item: { service_type, count, weight }.
pickup_time_window
object
Preferred time window: { start_time, end_time } in HH:MM format. Defaults to 08:00-18:00.
special_instructions
string
Instructions for the carrier driver (e.g., "Packages at front desk").
Returns
201
Pickup scheduled successfully
400
Invalid request or no active USPS labels at pickup address
401
Authentication required
422
Pickup validation failed
Related
pickup
usps
schedule
POST/api/v1/pickups