Create a Pickup
Endpoint: POST /v1/pickups
Description: Books a new courier pickup for one or more consignments.
Request Example
Response Example (201 Created)
Field Notes
| Field |
Description |
accountNumber |
Freightways account number for pickup billing |
pickupDate |
Date the pickup should occur |
readyTime / closeTime
|
Time window for courier arrival |
contact |
On-site contact details |
address |
Pickup address |
consignmentIds |
One or more consignments associated with this pickup |
specialInstructions |
Optional field for courier guidance |
Error Responses
| Code |
Example |
Description |
| 400 |
Invalid time window |
Validation error |
| 404 |
Account not found |
Missing or invalid account |
| 500 |
Internal error |
Unable to schedule pickup |
🔎 Retrieve a Pickup
Endpoint: GET /v1/pickups/{pickupId}
Description: Retrieves details and current status for a previously scheduled pickup.
Example Request
Response Example (200 OK)
Common Status Values
| Status |
Meaning |
Scheduled |
Pickup booked and awaiting collection |
In Progress |
Courier en route |
Completed |
Consignments collected successfully |
Cancelled |
Pickup cancelled before completion |
