Schedule a carrier pickup

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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
origin
object
required

Pickup address information

shipment
object
required

Shipment information

Response
200

Pickup scheduled successfully

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!