Important Links

Payload Example

[{
    "pickup_pincode": "110017",
    "drop_pincode": "110019",
    "order_type": "PREPAID",
    "reference_number": "1",
    "item": "bottle",
		"item_count": 2,
    "invoice_value": 1245,
    "delivery_type": "FORWARD",
    "weight": 10,
    "height": 10,
    "length": 10,
    "breadth": 10,
    "additional": {
        "custom_fields": [{
            "key": "ptl_or_ftl",
            "value": "PTL"
        }, {
            "key": "truck_size",
            "value": "14 feet"
        }]
    }
}]

[
    {
        "item": "HealthcareProducts",
        "height": "10",
        "length": "10",
        "weight": "10",
        "breadth": "10",
        "additional": null,
        "order_type": "COD",
        "drop_pincode": "123456",
        "delivery_type": "FORWARD",
        "invoice_value": 2187.0,
        "pickup_pincode": "400078",
        "reference_number": "FL1023075027",
      	"item_count": 2
    }
]

Request Payload

Field Name	Data Type	Field	Description
`length`	`float`	Optional	The length of the shipment in centimeter. This field becomes mandatory if enterprise wants to calculate `shipping_charge`
`pickup_pincode`	`string`	Mandatory	The pickup pincode where the shipment needs to be picked up
`drop_pincode`	`string`	Mandatory	The drop pincode where the shipment needs to be delivered
`breadth`	`float`	Optional	The breadth of the shipment in centimeter. This field becomes mandatory if enterprise wants to calculate `shipping_charge`
`height`	`float`	Optional	The height of the shipment in centimeter. This field becomes mandatory if enterprise wants to calculate `shipping_charge`
`invoice_value`	`float`	Optional	The invoice value of the shipment in INR. This field becomes mandatory if enterprise wants to calculate `PRICING`
`weight`	`float`	Optional	The weight of the shipment in kilograms. This field becomes mandatory if enterprise wants to calculate `shipping_charge`
`delivery_type`	`enum`	Mandatory	The order type for which serviceability needs to be determined. Enter `FORWARD` if the shipments need to be delivered to the customer from the enterprise's warehouse. Enter `RVP` if the shipment needs to picked up from the customer’s location and delivered to the enterprise’s warehouse
`reference_number`	`string`	Mandatory	The reference number for the API request. It has to be unique for each API request
`order_type`	`enum`	Mandatory	The order type for the particular shipment 1. `PREPAID` 2. `COD`
`item_count`	`integer`	Optional	The number of items in the shipment

additional [additional parameters] [optional]

Field Name	Data Type	Field	Description
`additional`	`JSON OBJECT`	Optional	The JSON Object of the additional parameter
`key`	`string`	Optional	The enterprise defined field's key. This will come into picture, if enterprise want to set Enterprise defined allocation rules
`value`	`string`	Optional	The enterprise defined field's value. This will come into picture, if enterprise want to set Enterprise defined allocation rules

Response

meta [meta parameters]

Field Name	Data Type	Description
`success`	`Boolean`	Indicates the success of the API request
`message`	`String`	The message from clickpost. In case of success it will be "SUCCESS". In case that there are no carrier partners that are servicing the pincodes it will be”Pin code not serviceable"
`status`	HTTP Code	The HTTP response status code of the API request

result [result parameters]

Field Name	Data Type	Description
`preference_array`	`array`	The preference list of eligible carrier partners
`cp_name`	`String`	The name of the carrier partner
`cp_id`	`num`	Carrier Partner ID. This can be found on the dashboard or you can refer it to here
`account_code`	`string`	The name of the account configured inside of the carrier partner on the Clickpost dashboard
`async`	`Boolean`	Whether the carrier partner supports asynchronous order creation or not
`account_id`	`num`	The identifier for the particular account configured under the carrier partner
`priority`	`num`	The priority of the carrier partner, this will be according to the Allocation rule set up by the enterprise on the Clickpost dashboard
`scores_computation`	`JSON Object`	The scoring of the carrier partner
`scoring_params`	`JSON Object`	The scoring parameters on which carrier partners are to be ranked
`PRICING`	`num`	The pricing of the carrier partner
`zone`	`String`	The zone which has been mapped with pincodes on the clickpost dashboard under the courier integration section.This can be configured in the Pricing section in courier partner account configuration section. (Settings>Courier>Integrations>Accounts> Configuration > Pricing)
`total_score`	`num`	The total score for the particular carrier partner
`shipping_charge`	`num`	The total shipping charge that the carrier partner will charge for the particular shipment
`filters_ran`	`JSON Object`	The JSON object of all the filters that have applied
`1_active_accounts_filter`	`array`	The list of active carriers that are there on Clickpost account
`2_serviceable_accounts_filter`	`array`	The list of serviceable carrier partners for the particular pickup and drop pincode
`2_1_serviceable_oda_accounts_filter`	`array`