Overview

This API enables customers to create a new pickup request for select carriers, given all pickup and carrier partner details. This is useful whenever the AWB is already registered but the customer wants to issue a pickup request.

Important Links

Usecase

This is a standard API which applies to MPS (Multi-Piece Shipment) and SPS (Single Piece Shipment) orders which are open (where the pickup_time has not been defined yet but are just created in carrier's database). Only the following Indian couriers support pickup requests (as of 9th December 2022):

Courier Partner	Partner ID
Delhivery	4
Fedex	1
Bluedart	5
XpressBees Cargo	61

Geography

This is a standard API which supports shipments created and transported within India.

URL

POST <https://www.clickpost.in/api/v1/create-pickup/>

Query Parameters

Field Name	Data Type	Field	Description	Max Length	Example
`username`	String	Mandatory	Username of the registered enterprise	100	"test-enterprise"
`key`	String	Mandatory	Unique license key for the enterprise user	100	"a537d832-f22b-459a-838d-d3bc71d34768"

Request Payload

Field Name	Data Type	Field	Description	Max Length	Example
`pickup_date`	String	Mandatory	Time of pickup for the order (to be provided in `YYYY-MM-DDTHH:MM:SS` format only)	200	"2018-10-23T15:30:39"
`courier_partner`	Integer	Mandatory	Partner ID of the carrier partner that will facilitate the pickup		123
`pickup_name`	String	Mandatory	Contact name of the consignor of the shipment	100	"Mukesh Kumar"
`pickup_address`	String	Mandatory	Address of the pickup location	500	"123, ABC Street"
`pickup_city`	String	Mandatory	City of the pickup location	100	"Mumbai City"
`pickup_state`	String	Mandatory	State/province of the pickup location	100	"Maharashtra"
`pickup_email`	String	Mandatory	Email of the pickup contact	50	"[email protected]"
`pickup_phone`	String	Mandatory	Contact number of the pickup contact	11	"9876543210"
`pickup_pincode`	String	Mandatory	6-digit Pin code of the pickup location	6	"400065"
`pickup_country`	String	Mandatory	ISO-2 Code of the country of the pickup location	2	"IN"
`items`	String	Mandatory	Description of the items to be picked up by the carrier	500	"3 boxes of Faber-Castell Crayons, 24 colours"
`account_code`	String	Mandatory	Courier partner account name configured on the Clickpost dashboard	100	"test_account"
`expected_package_count`	Integer	Optional	Total number of packages Courier partner need to pickup		3

Response

The sample response can have the following fields

Field Name	Data Type	Description
`meta`	Object	Metadata for the result, e.g. status code, error messages.
`result`	Object	The actual result of the pickup request

Response Meta

Field Name	Data Type	Description
`status`	Integer	Status code of the response (including, but not limited to HTTP Status codes)
`message`	String	Error message (if any errors) for the request.
`success`	Boolean	Whether the request is successful or not.

Response Result Object

Each object in the result list may consist of the following fields.

Field Name	Data Type	Description
`location`	String	Location ID of pickup, shared by the carrier partner
`confirmation_number`	String	The confirmation number of the pickup

Sample Payload

{
    "items": "1 package(s), 500 grams",
    "pickup_city": "Surat",
    "pickup_date": "2022-12-08T14:00:00",
    "pickup_name": "ABCD",
    "account_code": "test_account",
    "pickup_email": "[email protected]",
    "pickup_phone": "1234567890",
    "pickup_state": "GUJARAT",
    "pickup_address": "123, ABC Street",
    "pickup_country": "IN",
    "pickup_pincode": "123456",
    "courier_partner": 4,
    "expected_package_count": 3
}

Sample Response

{
    "meta": {
        "status": 200,
        "message": "SUCCESS",
        "success": true
    },
    "result": {
        "location": "Surat_Kacholi_GW",
        "confirmation_number": "101847200"
    }
}

{
    "meta": {
        "status": 400,
        "message": "Error message",
        "success": false
    }
}