Skip to main content

Get Shipment Details

Retrieve the full detail record of a specific shipment by its internal ID or tracking code.


Endpoints

There are two ways to retrieve the complete details of a shipment:

1. By Shipment ID

GET/v1/shipments/:id

Required permission: shipments:get

2. By Tracking Code

GET/v1/shipments/tracking/:code

Required permission: shipments:get


Path Parameters

ParameterTypeRequiredDescription
idStringThe internal shipment ID (e.g. SHP_Z8F9A2B3C4).
codeStringThe customer-facing tracking code (e.g. GDJJETYEJ).

Response

Returns the complete shipment record including pricing breakdown and event history.

FieldTypeDescription
idStringInternal shipment ID.
trackingCodeStringCustomer-facing tracking code.
senderNameStringSender's full name.
senderPhoneStringSender's phone number.
senderEmailString?Sender's email, if provided.
receiverNameStringRecipient's full name.
receiverPhoneStringRecipient's phone number.
receiverEmailString?Recipient's email, if provided.
originAddressStringResolved origin street address.
destinationAddressStringResolved destination street address.
packageTitleStringPackage label.
packageDescriptionString?Package description, if provided.
packageCategoryStringSize tier. SMALL, MEDIUM, LARGE, or EXTRA_LARGE.
itemValueFloat?Declared item value in ₦, if provided.
enableInsuranceBoolean?Whether insurance coverage was enabled.
distanceKmFloatRoute distance in kilometers.
baseFareIntegerFlat base charge in ₦.
distanceFeeIntegerDistance-based charge in ₦.
weightSurchargeIntegerWeight-tier surcharge in ₦.
valueSurchargeIntegerInsurance surcharge in ₦.
totalCostIntegerTotal amount deducted from the wallet in ₦.
statusStringCurrent status. PENDING, SCHEDULED, CANCELED, or DELIVERED.
noteString?Internal operator note, if attached.
userNoteString?Note left by the sender, if provided.
createdAtStringISO 8601 creation timestamp.

{
"statusCode": 200,
"message": "Success",
"data": {
"id": "SHP_Z8F9A2B3C4",
"trackingCode": "TCL-SB-3891829",
"senderName": "Grace Adegoke",
"senderPhone": "+2348031234567",
"senderEmail": "grace@marketify.ng",
"receiverName": "John Doe",
"receiverPhone": "+2348123456789",
"originAddress": "12 Allen Avenue, Ikeja, Lagos",
"destinationAddress": "Ring Road, Ibadan, Oyo",
"packageTitle": "Laptop & Charger",
"packageCategory": "MEDIUM",
"itemValue": 450000,
"enableInsurance": true,
"distanceKm": 135.2,
"baseFare": 1000,
"distanceFee": 27040,
"weightSurcharge": 500,
"valueSurcharge": 4500,
"totalCost": 33040,
"status": "PENDING",
"createdAt": "2026-07-01T17:42:00Z"
}
}