Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sample Request Payload

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

...

The delivery type passed could be ‘FORWARD' or 'RETURN’.

...

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. Although, weight is not a mandatory field, Clickpost’s recommendation engine decides courier priority on the weight of the shipment too. For Clickpost, it will be in grams and for Shiprocket, it will be in kgs.

no

Sample Response Payload

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

...