Pickups
Schedule a 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
post/ship/pickup/
Request body
Example request
{
"origin": {
"category_id": 1,
"name": "Juan Pérez",
"company": "Envia Corp",
"phone": "8180000000",
"phone_code": "+52",
"email": "juan.perez@example.com",
"country": "MX",
"district": "Centro",
"postal_code": "64000",
"postalCode": "64000",
"city": "Monterrey",
"number": "500",
"street": "Av. Revolución 500",
"interior_number": "4B",
"state": "NL",
"category": 1,
"reference": "Frente al parque",
"identificationNumber": "XAXX010101000"
},
"shipment": {
"type": 1,
"carrier": "fedex",
"pickup": {
"weightUnit": "KG",
"totalWeight": 12.5,
"totalPackages": 5,
"date": "2026-03-10",
"timeFrom": 9,
"timeTo": 17,
"carrier": "fedex",
"instructions": "Ring bell at loading dock B",
"trackingNumbers": [
"7520610403",
"7520610404"
]
}
}
}Response
Pickup scheduled successfully