Request shipping rates

Things to note:

• Shipments rates requested after 6 PM (GMT +1) will be scheduled for processing the following day.

• You can only request a shipment for a maximum of 3 days from the current date of request.

• The successful rate response will indicate which courier is the cheapest, fastest and best value for money, which is a combination of speed, price, and reliability.

• A rate request token expires after 7 days of lookup.

• For each courier rate returned, the value rate_card_amount is what you are meant to display or charge your customers while total is what will deducted from your Shipbubble wallet.

• Typically they are same amount but they become different in cases of you connecting your personal carrier accounts.

• Both values are inclusive of VAT.

For your package items

Strive to be as accurate as possible when shipping! The more accurate your information is, the better the rate quote you will receive from the couriers.

Additionally, if the shipping information is incorrect, most carriers will follow up with a charge to make up the difference.

POST https://api.shipbubble.com/v1/shipping/fetch_rates

Request Body

Name	Type	Description
sender_address_code*	int	address code of label pickup (gotten from Addresses API)
reciever_address_code*	int	address code of label pickup (gotten from Addresses API)
pickup_date*	string	specified date for shipment processing(format: "yyyy-mm-dd")
category_id*	int	package item category
package_items*	Array	An array of items to be shipped, a sample package item object looks like { name:'Jameson', description:'Too sweet', unit_weight:'0.002', unit_amount:'5000', quantity:'2' }, all object items are required, item weight unit is in KG
service_type	string	filter rates by their service types ex. dropoff or pickup
delivery_instructions	string	additional delivery instructions for package
package_dimension*	Object	Dimension pf package to be delivered (in CM), if you are not sure of your dimension, you can make use of the Package Dimensions API { "length":12, "width":10, "height":10 }

200: OK request_token is used to uniquely identify each rates API request

{
    "status": "success",
    "message": "Retrieved successfully",
    "data": {
        "request_token": "b6130ff493a30a6065f677a45b0ee1dd92edd07e80e473837248e99edaa029cd",
        "couriers": [
            {
                "courier_id": "sendstack",
                "courier_name": "Sendstack",
                "courier_image": "https://res.cloudinary.com/delivry/image/upload/v1653144587/courier_images/sendstack_ijfbxw.png",
                "service_code": "sendstack",
                "insurance": {
                    "code": "not available",
                    "fee": 0
                },
                "discount": {
                    "percentage": 10,
                    "symbol": "%",
                    "discounted": 95
                },
                "service_type": "pickup",
                "waybill": false,
                "tracking_level": 7,
                "pickup_eta": "Next day pickup",
                "pickup_eta_time": "2022-07-26 11:29:53",
                "dropoff_station": null,
                "pickup_station": null,
                "delivery_eta": "Next day delivery",
                "delivery_eta_time": "2022-07-27 11:29:53",
                "info": [
                    "Shipment will be processed by Sendstack for next day pickup July 26th 2022 ",
                    "Shipment estimated delivery time is 24hrs (July 27th 2022) from day of pickup"
                ],
                "currency": "NGN",
                "vat": 71,
                "ratings": 4.4,
                "total": 1121
            },
            {
                "courier_id": "N",
                "courier_name": "DHL Nigeria",
                "courier_image": "https://res.cloudinary.com/delivry/image/upload/v1639728337/courier_images/dhl.png",
                "service_code": "dhl-nigeria",
                "insurance": {
                    "code": "not available",
                    "fee": 0
                },
                "discount": {
                    "percentage": 50,
                    "symbol": "%",
                    "discounted": 5835
                },
                "service_type": "pickup",
                "waybill": true,
                "tracking_level": 7,
                "pickup_eta": "Before 17:00 (GMT +1) July 25th 2022",
                "pickup_eta_time": "2022-07-25 17:01:00",
                "dropoff_station": null,
                "pickup_station": null,
                "delivery_eta": "Estimated 1 day (s)",
                "delivery_eta_time": "2022-07-26 10:00:00",
                "info": [
                    "Shipment placed after 4 PM (GMT +1) will be processed to the next day",
                    "Download waybill document from shipments page after shipment has been processed",
                    "Attach waybill document to your packaged items",
                    "Items to be shipped must be wrapped or packaged before pickup"
                ],
                "currency": "NGN",
                "vat": 437.63,
                "ratings": 4.6,
                "total": 6272.63
            }
        ],
        "fastest_courier": {
                "courier_id": "N",
                "courier_name": "DHL Nigeria",
                "courier_image": "https://res.cloudinary.com/delivry/image/upload/v1639728337/courier_images/dhl.png",
                "service_code": "dhl-nigeria",
                "insurance": {
                    "code": "not available",
                    "fee": 0
                },
                "discount": {
                    "percentage": 50,
                    "symbol": "%",
                    "discounted": 5835
                },
                "service_type": "pickup",
                "waybill": true,
                "tracking_level": 7,
                "pickup_eta": "Before 17:00 (GMT +1) July 25th 2022",
                "pickup_eta_time": "2022-07-25 17:01:00",
                "dropoff_station": null,
                "pickup_station": null,
                "delivery_eta": "Estimated 1 day (s)",
                "delivery_eta_time": "2022-07-26 10:00:00",
                "info": [
                    "Shipment placed after 4 PM (GMT +1) will be processed to the next day",
                    "Download waybill document from shipments page after shipment has been processed",
                    "Attach waybill document to your packaged items",
                    "Items to be shipped must be wrapped or packaged before pickup"
                ],
                "currency": "NGN",
                "vat": 437.63,
                "ratings": 4.6,
                "total": 6272.63
            },
        "cheapest_courier": {
                "courier_id": "N",
                "courier_name": "DHL Nigeria",
                "courier_image": "https://res.cloudinary.com/delivry/image/upload/v1639728337/courier_images/dhl.png",
                "service_code": "dhl-nigeria",
                "insurance": {
                    "code": "not available",
                    "fee": 0
                },
                "discount": {
                    "percentage": 50,
                    "symbol": "%",
                    "discounted": 5835
                },
                "service_type": "pickup",
                "waybill": true,
                "tracking_level": 7,
                "pickup_eta": "Before 17:00 (GMT +1) July 25th 2022",
                "pickup_eta_time": "2022-07-25 17:01:00",
                "dropoff_station": null,
                "pickup_station": null,
                "delivery_eta": "Estimated 1 day (s)",
                "delivery_eta_time": "2022-07-26 10:00:00",
                "info": [
                    "Shipment placed after 4 PM (GMT +1) will be processed to the next day",
                    "Download waybill document from shipments page after shipment has been processed",
                    "Attach waybill document to your packaged items",
                    "Items to be shipped must be wrapped or packaged before pickup"
                ],
                "currency": "NGN",
                "vat": 437.63,
                "ratings": 4.6,
                "total": 6272.63
            },
        "checkout_data": {
            "ship_from": {
                "name": "Lebron James",
                "phone": "[phone]",
                "email": "[email protected]",
                "address": "Alh. Masha Rd, Surulere 101241, Lagos, Nigeria"
            },
            "ship_to": {
                "name": "Lebron James",
                "phone": "[phone]",
                "email": "[email protected]",
                "address": "Kafayat Abdulrasaq Street, Lekki Phase I 106104, Logos, Nigeria"
            },
            "package_amount": "₦1,510,000",
            "package_weight": "2.00KG",
            "pickup_time": "December 19th 2022, 10:57:44 PM"
        }
    }
}

There are currently two types of service delivery types, pickup, and dropoff.

If a service type is marked as pickup, it means the selected courier would pickup the package at the sender's address and deliver it to the receiver's address

If a service type is marked as dropoff, it means that the sender must deliver the package to a courier dropoff station. In this case, a dropoff station and pickup station object will be included in the response. it will contain the name and address of the dropoff station.

Check the example response for object definition