Get rates for a return shipment request

Fetch rates for a return request

Return requests can only be processed within 7 days after a shipment has been completed.

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

Path Parameters

NameTypeDescription

order_id*

String

order id of shipment to be returned

Request Body

NameTypeDescription

pickup_date*

String

specified date for shipment processing(format: "yyyy-mm-dd")

delivery_instructions

String

additional delivery instructions for package

sender_phone

String

New sender phone number in case of a change

reciever_phone

String

New receiver phone number in case of a change

{
    "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": "+2348057575855",
                "email": "lebron@james.com",
                "address": "Alh. Masha Rd, Surulere 101241, Lagos, Nigeria"
            },
            "ship_to": {
                "name": "Lebron James",
                "phone": "+2348057575855",
                "email": "lebron@james.com",
                "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"
        }
    }
}

Last updated