Skip to main content

Verify Pickup Code

Verify the pickup code presented by the rider upon package collection at the sender location.


Endpoint

POST/v1/shipments/verify-pickup

Required permission: shipments:verify


Request Body

FieldTypeRequiredDescription
idStringUnique shipment ID (e.g., SHP_Z8F9A2B3C4).
codeStringThe 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.

FieldTypeDescription
idStringInternal shipment ID.
trackingCodeStringCustomer-facing tracking code.
senderNameStringSender's name.
senderPhoneStringSender's phone.
senderEmailString?Sender's email, if provided.
receiverNameStringRecipient's name.
receiverPhoneStringRecipient's phone.
receiverEmailString?Recipient's email, if provided.
originAddressStringPickup address.
destinationAddressStringDelivery address.
packageTitleStringPackage label.
totalCostIntegerAmount charged in ₦.
statusStringCurrent status. PENDING, SCHEDULED, CANCELED, or DELIVERED.
createdAtStringISO 8601 creation timestamp.

Error Responses

CodeStatusMessage
BAD_REQUEST400Invalid verification code | Shipment must be in Scheduled status before pickup verification can occur | Shipment has already been verified and picked up
NOT_FOUND404Shipment not found
ACCESS_DENIED403Forbidden

{
"id": "SHP_Z8F9A2B3C4",
"code": "682914"
}