WMS Unified Serviceability API

Overview

The WMS Unified Serviceability API allows you to get EDD for specific SKUs based on drop location and WMS mapping. It can also optionally validate rider availability.

This API is useful for:

  • Store-wise serviceability checks
  • Checking SKU-level availability at different pickup stores
  • Rider availability validation (optional)

Pre-requisites

Before a brand can be onboarded to this API, both of the following must be in place. The API call will not succeed otherwise.

1. The WMS must be supported

The brand's warehouse management system must be one of the WMSes Clickpost supports (see table below). Onboarding requests for any other WMS cannot be served until support is added.

WMSwms_codeWMS URL scope
VinculumvinculumEnterprise-specific
EasyEcomeasyecomCommon / same for all enterprises
UnicommerceunicommerceEnterprise-specific
IncreffincreffEnterprise-specific

wms_code is matched against this list. A misspelt or unsupported wms_code is treated as "service not subscribed" (see Possible Meta Statuses).

2. The brand must share valid upstream WMS credentials

Clickpost calls the brand's WMS on their behalf, so the brand must provide valid upstream credentials during onboarding. These are stored against the brand's enterprise profile and used at request time. The required fields differ per WMS:

Vinculum

Field keyLabelTypeRequired
wms_urlWMS URLstringYes
wms_usernameAPI OwnerstringYes
wms_keyAPI KeystringYes

EasyEcom

Field keyLabelTypeRequired
oauth_usernameAuthentication EmailstringYes
oauth_passwordAuthentication PasswordstringYes
oauth_keyLocation KeystringYes
wms_keyX API KeystringYes

Unicommerce

Field keyLabelTypeRequired
oauth_usernameAuthentication UsernamestringYes
oauth_passwordAuthentication PasswordstringYes
wms_urlWMS URLstringYes

Increff

Field keyLabelTypeRequired
wms_usernameWMS UsernamestringYes
wms_passwordWMS PasswordstringYes

Note on WMS URLs: For EasyEcom, the WMS URL is common to all enterprises. For Vinculum and Unicommerce, the WMS URL is enterprise-specific and must be provided by the brand.


Endpoint

POST http://ds.clickpost.in/api/v1/wms_unified_serviceability_api/

Authentication

Authentication is passed as query parameters.

ParameterTypeRequiredDescription
keystringYesClickpost API Key
usernamestringYesClickpost Username

Query Parameters

ParameterTypeRequiredDescription
rider_availabilitybooleanNoIf true, validates rider availability along with serviceability. Default: false

Headers

HeaderValue
Content-Typeapplication/json

Request Body

The request body must be a JSON array of objects.

Schema

FieldTypeRequiredDescription
skustringYesProduct SKU
pickup_store_idsarrayNoList of specific pickup store IDs. Leave empty ([]) for auto-selection
drop_pincodestringYesDestination pincode
wms_codestringYesWMS system code (e.g., increff, unicommerce)
drop_latitudestringNoDestination latitude
drop_longitudestringNoDestination longitude

Sample Request

curl --location 'http://ds.clickpost.in/api/v1/wms_unified_serviceability_api/?key=*****&username=*****&rider_availability=false' \
--header 'Content-Type: application/json' \
--data-raw '[
  {
    "sku": "8904413454561",
    "pickup_store_ids": [],
    "drop_pincode": "421302",
    "wms_code": "increff",
    "drop_latitude": "19.3559",
    "drop_longitude": "73.0641"
  }
]'

Response JSON Format

Field NameData TypeDescriptionValue Constraints
metaJSON ObjectMetadata about the request, such as status codes and messages describing success or errors. Refer to the Possible Meta Statuses section below.Cannot be null
resultJSON ObjectIncludes the serviceability results at account level.Can be null or string if meta.success is false

meta object fields

Field NameData TypeDescriptionValue Constraints
messagestringHuman-readable message indicating success or describing the error.Can be null or empty
statusintegerStatus code representing the result of the request (may include standard HTTP status codes).Cannot be null
successbooleanIndicates whether the request was processed successfully (true) or not (false).Cannot be null

result object fields

Field NameData TypeDescriptionValue Constraints
hld_etaJSON ObjectMinimum and maximum delivery ETA (in minutes) across HLD stores. A given store might have multiple carriers servicing it. It takes into account the max and min across all the stores.Cannot be empty
slaJSON ObjectMinimum and maximum committed delivery SLA (in days) (carrier-uploaded SLA) across all the serviceable carrier accounts. Calculated from all serviceable accounts' overall_sla value.Cannot be empty
eddJSON ObjectMinimum and maximum EDD across all the serviceable carrier accounts. Calculated from all serviceable accounts' overall_edd value.Cannot be empty
serviceable_accountsJSON ArrayList of hyperlocal and standard serviceable accounts with ETA (for hyperlocal) / SLA and Pricing (for standard).Can be empty
request_idstringThe unique request identifier generated by ClickPost for each API request, used for tracing and debugging logs.Cannot be null

hld_eta, sla & edd object fields

Field NameData TypeDescriptionValue Constraints
minintegerMinimum ETA (in minutes) / SLA (in days) / EDD (in days) value across all serviceable accounts foundCan be null
maxintegerMaximum ETA (in minutes) / SLA (in days) / EDD (in days) value across all serviceable accounts foundCan be null

serviceable_accounts object fields

Field NameData TypeDescriptionValue Constraints
cp_idintegerCarrier Partner ID. This can be found on the dashboard.Cannot be null
service_typestring enumSupported Values: FORWARD, RVP. If no value is passed, default FORWARD is considered.Cannot be null
account_codestringCarrier partner account name configured on the Clickpost dashboard.Cannot be null
account_idintegerThe identifier for the particular account configured under the carrier partner.Cannot be null
mode_of_shipmentstringShipment mode supported in the account.Can be null or empty
pickup_pincodestringPincode of the pickup location.Can be null
drop_pincodestringPincode of the drop location.Can be null
is_hldbooleanWhether account is HLD (for hyperlocal) or not.Cannot be null
delivery_etaintegerDelivery ETA in minutes supported by the account's carrier. This value is populated based on the static config present in ClickPost. This stays null when is_hld is false.Can be null
store_idstringIdentifier of the HLD store. The pickup_store_ids field in the request will have this value only. This stays null when is_hld is false.Can be null
serviceableJSON ObjectIndicates whether pickup is available when PICKUP is true and serviceability for other order types: COD, PREPAID, EXCHANGE.Cannot be null
committed_slaintegerCarrier-committed SLA (in days) uploaded in the system. Null if is_hld is true.Can be null
order_to_shipintegerShipping readiness in days (0 = today, 1 = tomorrow). It depends on the configuration done in the Clickpost system.Can be null
overall_slaintegerSum of committed_sla and order_to_ship (in days).Can be null
eddintegerEstimated delivery (based on Clickpost DS model) in days.Can be null
overall_eddintegerSum of edd and order_to_ship (in days).Can be null
shipping_chargeJSON ObjectIndicates the shipping charge for the delivery for a given order type (default is PREPAID).Cannot be null

shipping_charge object fields

Field NameData TypeDescriptionValue Constraints
<OrderType>floatField name / key is a variable — it can either be PREPAID or COD. Value is the shipping charge for that order type.Can be null
zonestringZone identified to calculate shipping charges.Can be null

Possible Meta Statuses

HTTP Status Codemeta.statusmeta.message
200200Request is executed successfully
4004001Invalid request json
4004002Request for invalid entity
4004003Invalid or missing query parameter
4004005User is not subscribed to the service
4014013Invalid API key
403403Access is not allowed
4044007API Not Found
500500Something went wrong in Clickpost server

Sample example response

{
    "result": {
        "hld_eta": {
            "min": 30,
            "max": 75
        },
        "sla": {
            "min": 2,
            "max": 4
        },
        "edd": {
            "min": 3,
            "max": 4
        },
        "serviceable_accounts": [
            {
                "cp_id": 180,
                "service_type": "FORWARD",
                "account_code": "delhivery_hld_test",
                "account_id": 187852,
                "mode_of_shipment": "HYPERLOCAL",
                "pickup_pincode": "560055",
                "drop_pincode": "110094",
                "is_hld": true,
                "delivery_eta": 75,
                "store_id": "store_1",
                "serviceable": {
                    "COD": null,
                    "PREPAID": null,
                    "EXCHANGE": null,
                    "PICKUP": null
                },
                "committed_sla": null,
                "overall_sla": null,
                "order_to_ship": null,
                "edd": null,
                "overall_edd": null,
                "shipping_charge": {
                    "PREPAID": null,
                    "zone": null
                }
            },
            {
                "cp_id": 364,
                "service_type": "FORWARD",
                "account_code": "porter_hld_test",
                "account_id": 141231,
                "mode_of_shipment": "",
                "pickup_pincode": "560054",
                "drop_pincode": null,
                "is_hld": true,
                "delivery_eta": 30,
                "store_id": "store_2",
                "serviceable": {
                    "COD": null,
                    "PREPAID": null,
                    "EXCHANGE": null,
                    "PICKUP": null
                },
                "committed_sla": null,
                "overall_sla": null,
                "order_to_ship": null,
                "edd": null,
                "overall_edd": null,
                "shipping_charge": {
                    "PREPAID": null,
                    "zone": null
                }
            },
            {
                "cp_id": 9,
                "service_type": "FORWARD",
                "account_code": "test1",
                "account_id": 231412,
                "mode_of_shipment": "SURFACE",
                "pickup_pincode": "560055",
                "drop_pincode": "110094",
                "is_hld": false,
                "delivery_eta": null,
                "store_id": null,
                "serviceable": {
                    "COD": true,
                    "PREPAID": true,
                    "EXCHANGE": false,
                    "PICKUP": true
                },
                "committed_sla": 4,
                "overall_sla": 5,
                "order_to_ship": 1,
                "edd": null,
                "overall_edd": null,
                "shipping_charge": {
                    "PREPAID": 76.5,
                    "zone": "CITY"
                }
            },
            {
                "cp_id": 9,
                "service_type": "FORWARD",
                "account_code": "test1",
                "account_id": 231412,
                "mode_of_shipment": "SURFACE",
                "pickup_pincode": "560054",
                "drop_pincode": "110094",
                "is_hld": false,
                "delivery_eta": null,
                "store_id": null,
                "serviceable": {
                    "COD": true,
                    "PREPAID": false,
                    "EXCHANGE": false,
                    "PICKUP": true
                },
                "committed_sla": 2,
                "overall_sla": 3,
                "order_to_ship": 1,
                "edd": null,
                "overall_edd": null,
                "shipping_charge": {
                    "PREPAID": null,
                    "zone": null
                }
            }
        ],
        "request_id": "8668f578-35bd-4a54-8bb2-329e4376e9a5"
    },
    "meta": {
        "status": 200,
        "success": true,
        "message": "Request is executed successfully"
    }
}

Sample error response for "not serviceable" pincodes

{
  "meta": {
    "status": 356,
    "message": "No Data FoundPincode not serviceable",
    "success": false
  }
}

Sample error response

{
  "result": "Both drop_latitude and drop_longitude must be provided together",
  "meta": {
    "status": 4001,
    "success": false,
    "message": "Invalid request json"
  }
}

Did this page help you?