Pending
The endpoint makes an HTTP GET request to retrieve the pending parcels in the logistics system. The response is a JSON object with a “status” field indicating the success status, a “message” field for any additional information, and a “data” array containing details of the pending parcels.
The “data” array includes information about the pickup origin, pickup date, destinations, total amount, discounts, tracking number, payment method, status, and other relevant details for each pending parcel.
Here is the JSON schema for the response:
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"message": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pickup_origin": {
"type": "object",
"properties": {
// Properties for pickup origin details
}
},
"pickup_date": {
"type": "string"
},
"destinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
// Properties for destination details
}
}
},
"total_amount": {
"type": "number"
},
"total_discount_amount": {
"type": "number"
},
"total_amount_payable": {
"type": "number"
},
"discount_type": {
"type": "string"
},
"discount_description": {
"type": "string"
},
"tracking_number": {
"type": "string"
},
"complete_date": {
"type": "string"
},
"payment_method": {
"type": "string"
},
"status": {
"type": "string"
},
"payment_ref": {
"type": ["string", "null"]
},
"cube_ref": {
"type": ["string", "null"]
},
"ref": {
"type": ["string", "null"]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
}
}
}
}
GET
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
200 - application/json
success
Example:
[
{
"complete_date": null,
"created_at": "2024-10-08T20:44:05.000Z",
"cube_ref": null,
"destinations": [
{
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"city": "Lagos",
"country_code": "NG",
"delivery_note": null,
"dropoff_centre": {
"centre_code": "lagos-adeniji-adele",
"centre_name": "Adeniji Adele Lagos"
},
"item_weight": 1,
"items": [
{
"height": null,
"length": null,
"name": "Book",
"width": null
}
],
"price": {
"amount": 3599.89,
"amount_payable": 3599.89,
"discount_amount": 0,
"discount_description": "0% discount",
"discount_type": "Percetage",
"distance": "0 Kilometres to the drop off center ",
"duration": "1-4 days"
},
"receiver": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone": "090200",
"phone_2": null
},
"region": {
"latitude": 6.4612672,
"longitude": 3.3961466
},
"state_code": "LA",
"weight": "1"
},
{
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"city": "Lagos",
"country_code": "NG",
"delivery_note": null,
"dropoff_centre": {
"centre_code": "lagos-adeniji-adele",
"centre_name": "Adeniji Adele Lagos"
},
"item_weight": 1,
"items": [
{
"height": null,
"length": null,
"name": "Book",
"width": null
}
],
"price": {
"amount": 3599.89,
"amount_payable": 3599.89,
"discount_amount": 0,
"discount_description": "0% discount",
"discount_type": "Percetage",
"distance": "0 Kilometres to the drop off center ",
"duration": "1-4 days"
},
"receiver": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone": "090200",
"phone_2": null
},
"region": {
"latitude": 6.4612672,
"longitude": 3.3961466
},
"state_code": "LA",
"weight": "1"
},
{
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"city": "Lagos",
"country_code": "NG",
"delivery_note": null,
"dropoff_centre": {
"centre_code": "lagos-adeniji-adele",
"centre_name": "Adeniji Adele Lagos"
},
"item_weight": 1,
"items": [
{
"height": null,
"length": null,
"name": "Book",
"width": null
}
],
"price": {
"amount": 3599.89,
"amount_payable": 3599.89,
"discount_amount": 0,
"discount_description": "0% discount",
"discount_type": "Percetage",
"distance": "0 Kilometres to the drop off center ",
"duration": "1-4 days"
},
"receiver": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone": "090200",
"phone_2": null
},
"region": {
"latitude": 6.4612672,
"longitude": 3.3961466
},
"state_code": "LA",
"weight": "1"
}
],
"discount_description": "0% discount",
"discount_type": "Percetage",
"payment_method": "Mervii",
"payment_ref": null,
"pickup_date": null,
"pickup_origin": {
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"city": "Lagos",
"country_code": "NG",
"pickup_centre": {
"centre_code": "lagos-adeniji-adele",
"centre_name": "Adeniji Adele Lagos"
},
"pickup_date": null,
"pickup_note": null,
"pickup_time": null,
"region": {
"latitude": 6.4612672,
"longitude": 3.3961466
},
"sender": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone": "09020500177",
"phone_2": null
},
"state_code": "LA",
"vehicle": null
},
"ref": null,
"status": "Pending",
"total_amount": 10799.67,
"total_amount_payable": 10799.67,
"total_discount_amount": 0,
"tracking_number": "202410081827981",
"updated_at": "2024-10-08T20:44:05.000Z"
},
{
"complete_date": null,
"created_at": "2024-10-08T20:55:15.000Z",
"cube_ref": null,
"destinations": [
{
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"city": "Lagos",
"contacts": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone_number": "09020500177",
"phone_number_2": null
},
"country_code": "NG",
"delivery_note": null,
"dropoff_centre": {
"centre_code": "lagos-adeniji-adele",
"centre_name": "Adeniji Adele Lagos"
},
"item_weight": 1,
"items": [
{
"height": null,
"length": null,
"name": "Book",
"width": null
}
],
"price": {
"amount": 3599.89,
"amount_payable": 3599.89,
"discount_amount": 0,
"discount_description": "0% discount",
"discount_type": "Percetage",
"distance": "0 Kilometres to the drop off center ",
"duration": "1-4 days"
},
"region": {
"latitude": 6.4612672,
"longitude": 3.3961466
},
"state_code": "LA",
"weight": "1"
},
{
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"city": "Lagos",
"contacts": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone_number": "09020500177",
"phone_number_2": null
},
"country_code": "NG",
"delivery_note": null,
"dropoff_centre": {
"centre_code": "lagos-adeniji-adele",
"centre_name": "Adeniji Adele Lagos"
},
"item_weight": 1,
"items": [
{
"height": null,
"length": null,
"name": "Book",
"width": null
}
],
"price": {
"amount": 3599.89,
"amount_payable": 3599.89,
"discount_amount": 0,
"discount_description": "0% discount",
"discount_type": "Percetage",
"distance": "0 Kilometres to the drop off center ",
"duration": "1-4 days"
},
"region": {
"latitude": 6.4612672,
"longitude": 3.3961466
},
"state_code": "LA",
"weight": "1"
},
{
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"city": "Lagos",
"contacts": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone_number": "09020500177",
"phone_number_2": null
},
"country_code": "NG",
"delivery_note": null,
"dropoff_centre": {
"centre_code": "lagos-adeniji-adele",
"centre_name": "Adeniji Adele Lagos"
},
"item_weight": 1,
"items": [
{
"height": null,
"length": null,
"name": "Book",
"width": null
}
],
"price": {
"amount": 3599.89,
"amount_payable": 3599.89,
"discount_amount": 0,
"discount_description": "0% discount",
"discount_type": "Percetage",
"distance": "0 Kilometres to the drop off center ",
"duration": "1-4 days"
},
"region": {
"latitude": 6.4612672,
"longitude": 3.3961466
},
"state_code": "LA",
"weight": "1"
}
],
"discount_description": "0% discount",
"discount_type": "Percetage",
"payment_method": "Mervii",
"payment_ref": null,
"pickup_date": null,
"pickup_origin": {
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"city": "Lagos",
"contacts": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone_number": "09020500177",
"phone_number_2": null
},
"country_code": "NG",
"pickup_centre": {
"centre_code": "lagos-adeniji-adele",
"centre_name": "Adeniji Adele Lagos"
},
"pickup_date": null,
"pickup_note": null,
"pickup_time": null,
"region": {
"latitude": 6.4612672,
"longitude": 3.3961466
},
"state_code": "LA",
"vehicle": null
},
"ref": null,
"status": "Pending",
"total_amount": 10799.67,
"total_amount_payable": 10799.67,
"total_discount_amount": 0,
"tracking_number": "202410083370182",
"updated_at": "2024-10-08T20:55:15.000Z"
},
{
"complete_date": null,
"created_at": "2024-10-08T21:00:59.000Z",
"cube_ref": null,
"destinations": [
{
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"centre_code": "lagos-ojodu-berger",
"city": "Lagos",
"contacts": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone_number": "09020500177",
"phone_number_2": null
},
"country_code": "NG",
"delivery_note": null,
"dropoff_centre": {
"centre_code": "lagos-ojodu-berger",
"centre_name": "Ojodu Berger Lagos"
},
"item_weight": 0.5,
"items": [
{
"height": null,
"length": null,
"name": "Book",
"width": null
}
],
"price": {
"amount": 3000.67,
"amount_payable": 3000.67,
"discount_amount": 0,
"discount_description": "0% discount",
"discount_type": "Percetage",
"distance": " Kilometres to the drop off center ",
"duration": "1-4 days"
},
"state_code": "LA",
"weight": "0.5"
}
],
"discount_description": "0% discount",
"discount_type": "Percetage",
"payment_method": "Mervii",
"payment_ref": null,
"pickup_date": null,
"pickup_origin": {
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"centre_code": "ibadan-sango",
"city": "Lagos",
"contacts": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone_number": "09020500177",
"phone_number_2": null
},
"country_code": "NG",
"pickup_centre": {
"centre_code": "ibadan-sango",
"centre_name": "Sango Ibadan"
},
"pickup_date": null,
"pickup_note": null,
"pickup_time": null,
"state_code": "LA",
"vehicle": null
},
"ref": null,
"status": "Pending",
"total_amount": 3000.67,
"total_amount_payable": 3000.67,
"total_discount_amount": 0,
"tracking_number": "202410082800065",
"updated_at": "2024-10-08T21:00:59.000Z"
},
{
"complete_date": null,
"created_at": "2024-10-08T21:04:00.000Z",
"cube_ref": null,
"destinations": [
{
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"city": "Lagos",
"contacts": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone_number": "09020500177",
"phone_number_2": null
},
"country_code": "NG",
"delivery_note": null,
"dropoff_centre": {
"centre_code": "lagos-ojodu-berger",
"centre_name": "Ojodu Berger Lagos"
},
"item_weight": 1,
"items": [
{
"height": null,
"length": null,
"name": "Book",
"width": null
}
],
"price": {
"amount": 11692.520875080363,
"amount_payable": 11692.520875080363,
"discount_amount": 0,
"discount_description": "0% discount",
"discount_type": "Percetage",
"distance": "68.26634062567 Kilometres to the drop off center ",
"duration": "1-4 days"
},
"region": {
"latitude": 7.427026700000001,
"longitude": 3.8900142
},
"state_code": "LA",
"weight": "1"
}
],
"discount_description": "0% discount",
"discount_type": "Percetage",
"payment_method": "Mervii",
"payment_ref": null,
"pickup_date": null,
"pickup_origin": {
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"centre_code": "ibadan-sango",
"city": "Lagos",
"contacts": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone_number": "09020500177",
"phone_number_2": null
},
"country_code": "NG",
"pickup_centre": {
"centre_code": "ibadan-sango",
"centre_name": "Sango Ibadan"
},
"pickup_date": null,
"pickup_note": null,
"pickup_time": null,
"state_code": "LA",
"vehicle": null
},
"ref": null,
"status": "Pending",
"total_amount": 11692.52,
"total_amount_payable": 11692.52,
"total_discount_amount": 0,
"tracking_number": "202410084743311",
"updated_at": "2024-10-08T21:04:00.000Z"
},
{
"complete_date": null,
"created_at": "2024-10-08T21:07:56.000Z",
"cube_ref": null,
"destinations": [
{
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"centre_code": "ibadan-sango",
"city": "Lagos",
"contacts": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone_number": "09020500177",
"phone_number_2": null
},
"country_code": "NG",
"delivery_note": null,
"dropoff_centre": {
"centre_code": "ibadan-sango",
"centre_name": "Sango Ibadan"
},
"item_weight": 1,
"items": [
{
"height": null,
"length": null,
"name": "Book",
"width": null
}
],
"price": {
"amount": 3000.98,
"amount_payable": 3000.98,
"discount_amount": 0,
"discount_description": "0% discount",
"discount_type": "Percetage",
"distance": " Kilometres to the drop off center ",
"duration": "1-4 days"
},
"state_code": "LA",
"weight": "1"
}
],
"discount_description": "0% discount",
"discount_type": "Percetage",
"payment_method": "Mervii",
"payment_ref": null,
"pickup_date": null,
"pickup_origin": {
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"city": "Lagos",
"contacts": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone_number": "09020500177",
"phone_number_2": null
},
"country_code": "NG",
"pickup_centre": {
"centre_code": "lagos-ojodu-berger",
"centre_name": "Ojodu Berger Lagos"
},
"pickup_date": null,
"pickup_note": null,
"pickup_time": null,
"region": {
"latitude": 7.427026700000001,
"longitude": 3.8900142
},
"state_code": "LA",
"vehicle": null
},
"ref": null,
"status": "Pending",
"total_amount": 11192.94,
"total_amount_payable": 11192.94,
"total_discount_amount": 0,
"tracking_number": "202410082333947",
"updated_at": "2024-10-08T21:07:56.000Z"
},
{
"complete_date": null,
"created_at": "2024-10-08T21:09:31.000Z",
"cube_ref": null,
"destinations": [
{
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"centre_code": "ibadan-sango",
"city": "Lagos",
"contacts": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone_number": "09020500177",
"phone_number_2": null
},
"country_code": "NG",
"delivery_note": null,
"dropoff_centre": {
"centre_code": "ibadan-sango",
"centre_name": "Sango Ibadan"
},
"item_weight": 1,
"items": [
{
"height": null,
"length": null,
"name": "Book",
"width": null
}
],
"price": {
"amount": 3000.98,
"amount_payable": 3000.98,
"discount_amount": 0,
"discount_description": "0% discount",
"discount_type": "Percetage",
"distance": " Kilometres to the drop off center ",
"duration": "1-4 days"
},
"state_code": "LA",
"weight": "1"
}
],
"discount_description": "0% discount",
"discount_type": "Percetage",
"payment_method": "Mervii",
"payment_ref": null,
"pickup_date": null,
"pickup_origin": {
"address": "Ikolaba Rd, Ibadan 200285, Oyo, Nigeria",
"city": "Lagos",
"contacts": {
"email": "[email protected]",
"name": "Olakunle Olayemi",
"phone_number": "09020500177",
"phone_number_2": null
},
"country_code": "NG",
"pickup_centre": {
"centre_code": "lagos-ojodu-berger",
"centre_name": "Ojodu Berger Lagos"
},
"pickup_date": null,
"pickup_note": null,
"pickup_time": null,
"region": {
"latitude": 7.427026700000001,
"longitude": 3.8900142
},
"state_code": "LA",
"vehicle": null
},
"ref": null,
"status": "Pending",
"total_amount": 11192.94,
"total_amount_payable": 11192.94,
"total_discount_amount": 0,
"tracking_number": "202410086789949",
"updated_at": "2024-10-08T21:09:31.000Z"
}
]Example:
""
Example:
true