Pickup Request: Rest of the World

Given all pickup and carriers partner details, create a new pickup request for select carriers. Applicable for all worldwide and cross-border shipments.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sample Payload

{
    "shipment_details": {
        "reference_number": "TestDHLME000001",
        "awb_number": "6276148141",
        "courier_partner_id": 159,
        "account_code": "1",
        "items": [
            {
                "sku": "S159SV8TAUXL",
                "price": 85.12,
                "weight": 2,
                "quantity": 1,
                "description": "Recycled Flared Legging - Regular",
                "height": 1,
                "length": 1,
                "breadth": 1
            }
        ],
        "height": 1,
        "length": 1,
        "weight": 10,
        "breadth": 1
    },
    "pickup_info": {
        "date": "2022-11-11",
        "start_time": "10:45",
        "end_time": "11:05",
        "email": "[email protected]",
        "phone":"8080808080",
        "phone_code": "+91",
        "name": "Warehouse Pickup POC",
        "address": "Test Pickup Warehouse Address, Pickup Locality, ",
        "city": "Test City",
        "state": "ABCD",
        "country_code":"IN",
        "postal_code": 123456
    }
}

Sample Response

{
    "meta": {
        "message": "SUCCESS",
        "success": true,
        "status": 200
    },
    "result": {
        "confirmation_number": "CBJ221111679550"
    }
}
{
    "meta": {
        "status": 400,
        "message": {
            "non_field_errors": [
                "627618141 not registered against account code 1"
            ]
        },
        "success": false
    }
}
{
    "meta": {
        "status": 400,
        "message": {
            "non_field_errors": [
                ": invalid Account Code 8"
            ]
        },
        "success": false
    }
}

Payload

The payload may consist of the following objects

Field NameData TypeFieldDescriptionMax LengthExample
shipment_detailsObjectMandatoryDetails of the shipment to generate the pickup request for
pickup_infoObjectMandatoryInformation of the location of pickup

shipment_details Object

The following fields can be a part of the shipment_details object.

Field NameData TypeFieldDescriptionMax LengthExample
reference_numberStringOptionalReference number of the shipment.
This reference Number is for logging purposes, can be used to request logs using this field
100"TESTREF00001"
awb_numberStringMandatoryAWB number of the shipment100"TESTAWB00001"
courier_partner_idStringMandatoryPartner ID of the carrier responsible for the pickup123
account_codeStringMandatoryThe name of the account configured inside of the carrier partner on the Clickpost dashboard"test_account"
itemsList[Object]OptionalList of items for which the pickup is to be initiated
heightFloatConditionalHeight of the overall shipment (in cm). To be passed if items is passed25.2
breadthFloatConditionalBreadth of the overall shipment (in cm). To be passed if items is passed25
lengthFloatConditionalLength of the overall shipment (in cm). To be passed if items is passed25
weightFloatConditionalWeight of the overall shipment (in gram). To be passed if items is passed25

pickup_info Object

Field NameData TypeFieldDescriptionMax LengthExample
nameStringOptional

Contact name of the consignor of the shipment.

If not provided, will be picked up from RVP payload.

100"Mukesh Kumar"
addressStringOptional

Address of the pickup location.

If not provided, will be picked up from RVP payload.

500"123, ABC Street"
cityStringOptional

City of the pickup location

If not provided, will be picked up from RVP payload.

100"Mumbai City"
stateStringOptional

State/province of the pickup location

If not provided, will be picked up from RVP payload.

100"Maharashtra"
emailStringOptional

Email of the pickup contact

If not provided, will be picked up from RVP payload.

50"[email protected]"
phoneStringOptional

Contact number of the pickup contact

If not provided, will be picked up from RVP payload.

11"9876543210"
start_timeStringOptionalTime when pickup should be initiated (to be provided in HH:MM format only)6"10:22"
end_timeStringOptional

Time by when pickup should be completed (to be provided in HH:MM format only)

If not provided, this will be assumed to be 2 hours after start_time

6"12:22"
postal_codeStringOptional

Postal code of the pickup location

If not provided, will be picked up from RVP payload.

6"400065"
countryStringOptional

Alpha ISO-2 country code of the pickup location.

If not provided, will be picked up from RVP payload.

2"IN"

items List

The items field will be a list of objects containing the following fields

Field NameData TypeFieldDescriptionMax LengthExample
descriptionStringOptional

Brief description of the item

If not provided, will be picked up from RVP payload.

500"Brown Cotton Socks - 1 pair"
quantityIntegerOptional

Number of units of the item

If not provided, will be picked up from RVP payload.

5
weightFloatOptional

Weight of each unit of the item

If not provided, will be picked up from RVP payload.

500
priceFloatOptional

Price of each unit of the item (currency to be decided by 'currency_code' field)

If not provided, will be picked up from RVP payload.

64.99
skuStringMandatory

Stock-keeping unit of the item

If not provided, will be picked up from RVP payload.

100"SKU0001"
heightFloatOptional

Height of the item (in cm).

If not provided, will be picked up from RVP payload.

25.2
breadthFloatOptional

Breadth of the item (in cm).

If not provided, will be picked up from RVP payload.

25.2
lengthFloatOptional

Length of the item (in cm).

If not provided, will be picked up from RVP payload.

25.2

Response

The response may contain the following fields

Field NameData TypeDescription
metaObjectMetadata for the request, e.g. status code, error messages.
resultObjectActual result of the request

Response Meta

Field NameData TypeDescription
statusIntegerStatus code for the request (including but not limited to HTTP Status codes)
messageString/ObjectError/Success messages for the request. Can also be an object containing all the errors
successBooleanWhether the order was successfully created or not

Response Result

Field NameData TypeDescription
confirmation_numberStringConfirmation number of the pickup request
Query Params
string
required

Username, unique to the enterprise profile

string
required

Unique key to verify/authenticate the enterprise profile

Body Params
string

Payload of the request, containing all details of the order

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json