Rate Calculator

This API helps determine the cost of shipping based on various parameters such as journey type, destination, weight, and payment method.

Rate Calculator

POST https://{domain}/shipping/api/v1/calculate/rate

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Mandatory	Type	Description
journeyType	yes	string	Specifies the type of journey, can be either 'forward' or 'reverse'.
pickupPincode	yes	number	The postal code of the pickup location.
dropPincode	yes	string	The postal code of the drop-off location.
orderWeight	yes	number	The weight of the order in the specified unit (in grams).
length	yes	number	The length of the package in the specified unit (in cm).
width	yes	number	The width of the package in the specified unit (in cm).
height	yes	number	The height of the package in the specified unit (in cm).
paymentMethod	yes	string	The payment method, can be either 'Cash on delivery' or 'Prepaid'.
codAmountToBeCollected	yes	number	The amount to be collected in case of Cash on Delivery (COD) orders.
doorstepQc	No	boolean	Indicates whether a doorstep quality check is required. Set to 'true' for returns if required.

Response

200

{
    "zone": "Metro",
    "essentialPlan": {
        "eshopboxStandard": {
            "estimatedDeliveryDays": 5,
            "shippingBaseFreight": 0.0,
            "expressSurcharge": 0.0,
            "CODCollectionFees": 35.0,
            "reverseShippingFees": 0.0,
            "fuelSurcharge": 0.0,
            "doorstepQCFees": 0.0,
            "GST": 6.3,
            "totalShippingCharges": 41.3
        }
    }
}

400

{
    "error": {
        "errors": [
            {
                "message": "Order weight cannot be blank"
            }
        ]
    }
}

curl --location 'https://{domain}/shipping/api/v1/calculate/rate' \
--header 'Authorization: Bearer <>' \
--header 'Content-Type: application/json' \
--data '{
    "journeyType": "forward",
    "pickupPincode": "560034",
    "dropPincode": "560034",
    "orderWeight": "5",
    "length": "12",
    "width": "12",
    "height": "33",
    "paymentMethod": "Cash on delivery",
    "codAmountToBeCollected": 100.0,
    "doorstepQc": false
}'