Verify Pickup Code
Verify the pickup code presented by the rider upon package collection at the sender location.
Endpoint
POST
/v1/shipments/verify-pickupRequired permission: shipments:verify
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
id | String | ✅ | Unique shipment ID (e.g., SHP_Z8F9A2B3C4). |
code | String | ✅ | The pickup verification code presented by the rider. |
Response
On success, returns 200 OK with the updated shipment object. The status will be transitioned to PICKED_UP and a new "Package Picked Up" event appended to the event timeline.
| Field | Type | Description |
|---|---|---|
id | String | Internal shipment ID. |
trackingCode | String | Customer-facing tracking code. |
senderName | String | Sender's name. |
senderPhone | String | Sender's phone. |
senderEmail | String? | Sender's email, if provided. |
receiverName | String | Recipient's name. |
receiverPhone | String | Recipient's phone. |
receiverEmail | String? | Recipient's email, if provided. |
originAddress | String | Pickup address. |
destinationAddress | String | Delivery address. |
packageTitle | String | Package label. |
totalCost | Integer | Amount charged in ₦. |
status | String | Current status. PENDING, SCHEDULED, CANCELED, or DELIVERED. |
createdAt | String | ISO 8601 creation timestamp. |
Error Responses
| Code | Status | Message |
|---|---|---|
BAD_REQUEST | 400 | Invalid verification code | Shipment must be in Scheduled status before pickup verification can occur | Shipment has already been verified and picked up |
NOT_FOUND | 404 | Shipment not found |
ACCESS_DENIED | 403 | Forbidden |
{
"id": "SHP_Z8F9A2B3C4",
"code": "682914"
}