Get shipments

Retrieve a list of all shipping labels created on your integration

Some couriers require that a waybill document be attached to the package before pickup or collection. In that case, we would include a waybill_document property which contains a downloadable URL for the requested document.

GET https://api.shipbubble.com/v1/shipping/labels

200: OK check below for the types of order status codes

{
    "status": "success",
    "message": "Retrieved successfully",
    "data": {
        "results": [
            {
                "order_id": "SB-BB7EDE9F",
                "status": "picked_up",
                "courier": {
                    "name": "Kwik",
                    "email": "[e-mail]",
                    "phone": "08029274847",
                    "tracking_code": "12106AF828-2898",
                    "tracking_message": null,
                    "rider_info": null
                },
                "ship_from": {
                    "name": "Lebron James",
                    "phone": "[phone]",
                    "email": "[e-mail]",
                    "address": "Phase 1, 4 Michael Olawale-Cole Dr, Lekki Phase I 106104, Lagos, Nigeria",
                    "latitude": 6.459056599999999,
                    "longitude": 3.4769383
                },
                "package_status": [
                    {
                        "status": "Pending",
                        "datetime": "2022-02-14 22:58:02"
                    }
                ],
                "ship_to": {
                    "name": "Lebron James",
                    "email": "[e-mail]",
                    "phone": "[phone]",
                    "address": "Alh. Masha Rd, Surulere 101241, Lagos, Nigeria",
                    "latitude": 6.499872799999999,
                    "longitude": 3.3609343
                },
                "dropoff_station": null,
                "pickup_station": null,
                "waybill_document":null,
                "events": [],
                "tracking_url": "https://localhost:5000/orders/tracking/GET-BB7EDE9F",
                "date": "2022-01-28T01:17:46.000Z"
            },
            {
                "order_id": "SB-SSS7EDE9F",
                "status": "picked_up",
                "courier": {
                    "name": "DHL",
                    "email": "[e-mail]",
                    "phone": "08029274847",
                    "tracking_code": "12106AF828-2898",
                    "tracking_message": null,
                    "rider_info": null
                },
                "ship_from": {
                    "name": "Lebron James",
                    "phone": "[phone]",
                    "email": "[e-mail]",
                    "address": "Phase 1, 4 Michael Olawale-Cole Dr, Lekki Phase I 106104, Lagos, Nigeria",
                    "latitude": 6.459056599999999,
                    "longitude": 3.4769383
                },
                "ship_to": {
                    "name": "Lebron James",
                    "email": "[e-mail]",
                    "phone": "[phone]",
                    "address": "Alh. Masha Rd, Surulere 101241, Lagos, Nigeria",
                    "latitude": 6.499872799999999,
                    "longitude": 3.3609343
                },
                "package_status": [
                    {
                        "status": "Pending",
                        "datetime": "2022-02-14 22:58:02"
                    }
                ],
                "dropoff_station": null,
                "pickup_station": null,
                "events": [
                    {
	                "location": "IBADAN GATEWAY",
	                "message": "Shipment Departs Collation Center",
	                "captured": "2022-06-10T11:16:20.337"
                    }
                ],
                "waybill_document":"https://storage.googleapis.com/get-web-app-assets/1274529970.pdf",
                "tracking_url": "https://localhost:5000/orders/tracking/GET-BB7EDE9F",
                "date": "2022-01-28T01:17:46.000Z"
            }
        ],
        "pagination": {
            "current": 1,
            "perPage": 1,
            "previous": 0,
            "next": 7,
            "total": 8
        }
    }
}

Shipment status definitions

pending: the shipment request has been processed to the selected courier service

confirmed: the shipment request has been acknowledged and accepted by the courier.

picked_up: the shipment package has been picked up from the sender's location by the courier.

in_transit: the shipment package is on its way to the receiver's location.

completed: the shipment package has been delivered to the receiver's location by the courier.

cancelled: the shipment request has been cancelled