Get Parcels

Fetch a list of parcels available for a user.

/parcels

GET https://api.terminal.africa/v1/parcels

This endpoint allows you to get a list of all parcels available for a user.

Query Parameters

Name	Type	Description
perPage	Number	Specify how many records will be returned in a single request. Defaults to 100.
page	Number	Specify what page of records will be sent in response. Defaults to 1.

Headers

Name	Type	Description
Authorization*	string	Set value to Bearer SECRET_KEY

200 Parcels retrieved successfully.

{
    "status": true,
    "message": "Parcels retrieved successfully",
    "data": {
        "parcels": [
            {
                "_id": "6353c7f49f186020811fa296",
                "description": "Apple MacBook Pro with Charger, Wireless mouse and Keyboard",
                "items": [
                    {
                        "description": "Apple MacBook Pro with Charger, Wireless mouse and Keyboard",
                        "name": "0% off on Offer on deals",
                        "currency": "NGN",
                        "value": 1399,
                        "quantity": 1,
                        "weight": 2
                    }
                ],
                "packaging": "PA-12668277208",
                "total_weight": 2,
                "user": "USER-22498158801",
                "weight_unit": "kg",
                "parcel_id": "PC-13423942661",
                "created_at": "2022-10-22T10:37:40.804Z",
                "updated_at": "2022-10-22T10:37:40.804Z",
                "__v": 0,
                "id": "6353c7f49f186020811fa296"
            }
        ],
        "pagination": {
            "page": 1,
            "perPage": 1,
            "prevPage": null,
            "nextPage": 2,
            "currentPage": 1,
            "total": 2,
            "pageCount": 2,
            "pagingCounter": 1,
            "hasPrevPage": false,
            "hasNextPage": true
        }
    }
}