Get Courier Recommendation

Outbound | POST | /shipping-label/get-courier-recommendation

Sample Request Payload

{
   "pickupPincode": "560102",
   "dropPincode": "110019",
   "deliveryType": "FORWARD",
   "invoiceValue": 1200,
   "isCod": true,
   "weight": 10
}

The delivery type passed could be ‘FORWARD' or 'RETURN’.
Although, weight is not a mandatory field, Clickpost’s recommendation engine decides courier priority on the weight of the shipment too.

Parameter Name	Data Type	Description	Mandatory
`pickupPincode`	String	Pincode from where shipment is to be picked	yes
`dropPincode`	String	Pincode of area where shipment is to be delivered	yes
`deliveryType`	String	Can be FORWARD or RETURN, based on the order type	yes
`invoiceValue`	Double	The total amount in invoice	no
`isCod`	Boolean	Whether the order has Cash-on-delivery or not	yes
`weight`	Double	Total weight of the shipment	no

Sample Response Payload

{
  "courierData": [
    {
      "courierId": 1001,
      "courierName": "Delhivery",
      "priority": 1
    },
    {
      "courierId": 1002,
      "courierName": "Fedex",
      "priority": 2
    }
  ]
}

Parameter Name	Data Type	Description	Mandatory
`courierData`	Object	Data of the couriers that are available	yes
`courierData.courierId`	String	Id of the courier configured in Clickpost/Shiprocket	yes
`courierData.courierName`	String	Name of the courier	yes
`courierData.priority`	Integer	Priority of the courier as per Clickpost/ Shiprockets recommendation engine.	yes