Drop Pincode Serviceability

Overview

By entering the drop_pincode, the enterprises can determine whether the Pincode is serviceable by any of their active carriers or not

The enterprise will be able to know which types of services are available for the particular drop-up Pincode or combination of pickup or 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

1. Enterprises can use the serviceability API to trigger order creation/ order manifestation based on the API response

2. Lightweight API just to check whether the drop Pincode is serviceable or not. (If there are multiple warehouses, then pass the combination of pickup and drop pincode)

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

1. India

👍

Note

Enterprise can put a check on the serviceable field which they get in the response from Clickpost

🚧

Note

If the enterprise does not pass the service_type field, then Clickpost will be assume it to FORWARD shipment

Request Payload

Mandatory Field

optional [optional parameters]

Response

meta [meta parameters]

result [result parameters]

{
    "meta": {
        "success": true,
        "message": "SUCCESS",
        "status": 200
    },
    "result": {
        "serviceable": true,
        "COD": false,
        "PREPAID": true,
        "EXCHANGE": false
    }
}