Pincode Carrier Serviceability
The API takes the pickup and drop Pincode and returns an array of all the serviceable courier partners and their corresponding shipping charges and committed SLAs
Overview
By entering the pick_up and drop pin codes, the enterprises can determine whether the carrier partner will be able to service the delivery or not.
-
Enterprise will be able to know which types of services are available for the particular pick-up and drop pincode.
- They can know if COD (Cash on Delivery), PREPAID (payment done in advance) or EXCHANGE (Deliver one good and take one good back to the warehouse) are serviceable or not by the carrier partner
-
Enterprise can use the serviceability API to trigger order creation/ order manifestation based on the API response
-
Enterprise can get the shipping charge for carrier partners who are servicing the particular pin codes
Usecase
This is a standard API which applies to all MPS (Multi-Piece Shipment) and SPS (Single Piece Shipment) orders
Geography
This is a standard API which supports all shipments created and transported within
- India
NOTE
The API will give an array of carrier partners in response only when either one of
COD,PREPAIDorEXCHANGEis available for a particular carrier partner
comitted_slais populated only when the SLA has been uploaded and the service is enabled.
Request Payload
Mandatory Field
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
drop_pincode | num | Mandatory | The drop pincode for which the serviceability needs to be ascertained | 6 char | 380001 |
pickup_pincode | num | Mandatory | The pickup pincode for which the serviceability needs to be ascertained | 6 char | 380015 |
optional [optional parameters]
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
length | float | Optional | The length of the shipment in centimeter. This field becomes mandatory if enterprise wants to calculate shipping_charge | 8 | 10.25 |
breadth | float | Optional | The breadth of the shipment in centimeter. This field becomes mandatory if enterprise wants to calculate shipping_charge | 8 | 20.50 |
height | float | Optional | The height of the shipment in centimeter. This field becomes mandatory if enterprise wants to calculate shipping_charge | 8 | 20.50 |
invoice_value | float | Optional | The invoice value of the shipment in INR. | 10 | 200.75 |
weight | float | Optional | The weight of the shipment in kilograms. This field becomes mandatory if enterprise wants to calculate shipping_charge | 8 | 2.75 |
cp_id | num | Optional | Carrier Partner ID. This can be found on the dashboard or you can refer it to here. If you pass a cp_id, then the API will return the serviceability of that particular carrier partner | 4 | 4 |
service_type | enum | Optional | 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 | 7 | FORWARD |
Response
meta [meta parameters]
| Field Name | Data Type | Description | Example |
|---|---|---|---|
success | Boolean | Indicates the success of the API request | true |
message | String | The message from cCickpost. In case of success, it will be "SUCCESS". In case there are no carrier partners that are servicing the pincodes it will be”Pin code not serviceable" | "SUCCESS" |
status | HTTP Code | The HTTP response status code of the API request | 200 |
result [result parameters]
| Field Name | Data Type | Description | Example |
|---|---|---|---|
cp_id | num | Carrier Partner ID. This can be found on the dashboard or you can refer it to here | 4 |
service_type | String | The order type for which serviceability needs to be determined. Forward if the shipments need to be delivered to the customer from the enterprises warehouse. RVP if the shipment needs to picked up from the customer’s location and delivered to the enterprise’s warehouse | FORWARD |
account_code | num | The account code configured for a particular carrier partner on the Clickpost dashboard | Bluedart Surface |
account_id | num | The identifier for the particular carrier account | 1938 |
serviceable [serviceable parameters]
| Field Name | Data Type | Description | Example |
|---|---|---|---|
COD | Boolean | Field indicates whether Cash on Delivery is supported by the particular carrier to the particular pincode | true |
PREPAID | Boolean | Field indicates whether Prepaid is supported by the particular carrier to the particular pincode | true |
EXCHANGE | Boolean | Field indicates whether Exchange is supported by the particular carrier to the particular pincode | true |
comitted_sla [comitted_sla parameters]
| Field Name | Data Type | Description | Example |
|---|---|---|---|
comitted_sla | num | The committed Service Level Agreement that is given the corresponding carrier partner in days | 3 |
shipping_charge [shipping_charge parameters]
| Field Name | Data Type | Description | Example |
|---|---|---|---|
PREPAID | float | Shipping Charges in INR for Prepaid type shipments for the corresponding pincodes | 50.50 |
COD | float | Shipping Charges in INR for Cash on Delivery type shipments for the corresponding pincodes | 50.50 |
zone [zone parameters]
| Field Name | Data Type | Description | Example |
|---|---|---|---|
zone | string | The zone which has been mapped with pincodes on the Clickpost dashboard under the carrier integration section | "North" |
Enterprise will be able to get the
shipping_chargeandzonewhere pricing has been configured on a carrier level
Home > Settings > Carrier > Integrations > Accounts > Configuration > Pricing
Updated over 1 year ago