Schedule a carrier pickup at a specified address and time window so a driver collects your packages.
When to use: Call this endpoint after generating labels when you need the carrier to pick up packages from your warehouse or location instead of dropping them off at a service point.
Prerequisites:
- Valid JWT authentication token (Bearer)
- At least one generated shipment label (tracking number)
- A pickup origin address
- A preferred pickup date and time window
Key behaviors:
- Returns a pickup confirmation number on success
- Pickup availability and time windows depend on the carrier and location
- You can include multiple tracking numbers in a single pickup request
- Some carriers require a minimum number of packages or weight for pickup eligibility
- Pickup rules vary by carrier — consult the Pickups concept guide for details
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Schedules a carrier pickup at a specified address and time window so a driver collects your packages. This endpoint validates the pickup request, charges the applicable pickup fee, and registers the pickup with the carrier.
New to pickups? Read the Pickups concept guide first to understand how pickup works across different carriers, when to use this endpoint vs
shipment.pickupin Generate, and how to check what each carrier supports.
Use Case
Use this endpoint for carriers with the pickup action flag. Call it after generating one or more shipping labels when you need the carrier to collect packages from your location. Provide the carrier name, tracking numbers, and your preferred pickup date and time window. The response returns a pickup confirmation number.
Not sure if your carrier supports this endpoint? Call Get Carrier Actions and look for the
pickupaction. Some carriers usepickup_on_generateinstead — see the Pickups concept guide for details.
Preconditions
- At least one generated shipment label (tracking number) for the specified carrier
- The carrier must have the
pickupaction (verify via Get Carrier Actions) - A valid pickup origin address
- A preferred pickup date and time window within the carrier's allowed range
- Sufficient account balance for the pickup fee
Side Effects
- Charges a pickup fee to your account
- Registers the pickup schedule with the carrier
- Creates a pickup record linked to the specified tracking numbers
Notes
- Pickup availability, time windows, and minimum package/weight requirements vary by carrier.
- You can include multiple tracking numbers in a single request — all must belong to the same carrier and originate from the same address.
- To check existing pickups for your account, use the Queries API endpoint Get Company Pickups.