post https://www.clickpost.in/api/v3/tracking/awb-register/
Register an AWB for tracking updates with Clickpost, given the AWB number, carrier partner ID, shipment information, pick-up and drop information, and additional details as input.
Sample Request
{
"waybill": "ABCDEFGHIJKL0001",
"courier_partner": 246,
"account_code": "test.skip.mps.rvp",
"shipment_info": {
"order_type": "COD",
"invoice_value": "12345",
"cod_amount": "1000",
"currency_code": "SAR",
"reference_number": "123XYZ",
"order_id": "order_id of the shipment",
"length": 10,
"height": 10,
"weight": 10,
"breadth": 10,
"items": [
{
"sku": "XYZ1",
"description": "item1",
"quantity": 1,
"price": 200,
"images": "<Image URL>",
"return_days": 2,
"length": 10,
"height": 10,
"breadth": 10,
"weight": 100
}
]
},
"pickup_info": {
"name": "DEFG",
"email": "[email protected]",
"phone_code": "966",
"phone": "1234567890",
"address": "Some Address",
"postal_code": "JK0701",
"city": "Riyadh",
"district": "XYZ",
"state": "Al-Riyadh",
"country_code": "SA",
"lat": 10.01,
"long": 10.2
},
"drop_info": {
"name": "ABCD",
"email": "[email protected]",
"phone_code": "966",
"phone": "9876443210",
"address": "ABCD TOWERS",
"postal_code": "JK0703",
"city": "JK0703",
"district": "XYZ",
"state": "Al-Riyadh",
"country_code": "AE",
"lat": 10.01,
"long": 10.01
},
"additional": {
"enable_whatsapp": false,
"order_date": "2017-02-14",
"ship_date": "2017-02-14",
"min_edd": 2,
"max_edd": 4,
"language_code": "eng"
}
}
Sample Response
{
"meta": {
"status": 200,
"message": "Success",
"success": true
},
"result": {
"tracking_id": 491179766,
"security_key": "067238b4-7e55-4d4d-92d1-1a72028e5b64"
}
}
{
"meta": {
"status": 303,
"message": "Waybill already registered",
"success": false
},
"result": {
"tracking_id": 267984163,
"security_key": "37317af1-f3c3-4c41-b563-99b5c601e59d"
}
}
{
"meta": {
"status": 353,
"message": "Clickpost Account: Inactive",
"success": false
}
}
Important Links
Body Payload
Payload encapsulates details regarding the AWB to be registered, and its details
| Field Name | Data Type | Field | Description |
|---|---|---|---|
waybill | String | Mandatory | AWB to be registered |
courier_partner | Integer | Mandatory | Carrier partner which should be tracking the AWB |
account_code | String | Mandatory | Courier partner account name configured on the Clickpost dashboard. |
shipment_info | Object | Optional | Details of the shipment to be registered |
pickup_info | Object | Optional | Details for pickup of the shipment |
drop_info | Object | Optional | Details for delivery of the shipment |
additional | Object | Optional | Additional optional fields |
Pickup Info (pickup_info)
This object takes in the data for the warehouse/pickup location for the shipment.
| Field Name | Data Type | Field | Description |
|---|---|---|---|
lat | Float | Optional | Latitude of the pickup location |
long | Float | Optional | Longitude of the pickup location |
name | String | Optional | Contact name of the consignor of the shipment |
address | String | Optional | Address of the pickup location |
district | String | Optional | District of the pickup location |
city | String | Optional | City of the pickup location |
state | String | Optional | State/province of the pickup location |
landmark | String | Optional | Landmarks to help find the pickup location |
email | String | Optional | Email of the pickup contact |
phone | String | Optional | Contact number of the pickup contact |
time | String | Optional | Time of pickup for the order (to be provided in YYYY-MM-DDTHH:MM:SS format only) |
postal_code | String | Optional | Postal code of the pickup location |
country_code | String | Optional | Alpha ISO-2 country code of the pickup location |
Drop Info (drop_info)
This object takes in the data for the delivery/consignee location for the shipment.
| Field Name | Data Type | Field | Description |
|---|---|---|---|
lat | Float | Optional | Latitude of the drop location |
long | Float | Optional | Longitude of the drop location |
name | String | Optional | Contact name of the consignee of the shipment |
address | String | Optional | Address of the drop location |
district | String | Optional | District of the drop location |
city | String | Optional | City of the drop location |
state | String | Optional | State/province of the drop location |
landmark | String | Optional | Landmarks to help find the drop location |
email | String | Optional | Email of the drop contact |
phone | String | Optional | Contact number of the drop contact |
time | String | Optional | Estimated time of drop for the order (to be provided in YYYY-MM-DDTHH:MM:SS format only) |
postal_code | String | Optional | Postal code of the drop location |
country_code | String | Optional | Alpha ISO-2 country code of the drop location |
Additional Fields (additional)
In the "additional" object optional fields can be passed which may be used by the carrier partner, or give additional details for the order.
| Field Name | Data Type | Field | Description |
|---|---|---|---|
enable_whatsapp | Boolean | Optional | If enterprise has WhatsApp for business account, they can pass opt-in information here so Clickpost starts sending out communications to customers. |
order_date | String | Optional | Date of placing the order (in YYYY-MM-DD format) |
ship_date | String | Optional | Date of shipping the order (in YYYY-MM-DD format) |
language_code | String | Optional | 639-3 Language code for the shipment |
min_edd | Integer | Optional | Minimum committed estimated delivery duration (in days) of the shipment |
max_edd | Integer | Optional | Maximum committed estimated delivery duration (in days) of the shipment |
Shipment Details (shipment_details)
In the 'shipment_details' field, the details regarding all items, and important order details like payment type, order type, carrier partner, etc. are added.
| Field Name | Data Type | Field | Description |
|---|---|---|---|
items | List[Object] | Optional | List of items to be delivered in the shipment. Details of the items explained below. |
height | Float | Optional | Height of the overall package (in cms) |
width | Float | Optional | Width of the overall package (in cms) |
length | Float | Optional | Length of the overall package (in cms) |
weight | Float | Optional | Weight of the package (in gms) |
reference_number | String | Optional | Reference number of the order. Must be unique for every shipment, i.e. every call of this API. |
cod_value | Float | Optional | Cash to be given to the carrier (currency to be determined by currency_code). Must be non-zero for COD orders, and zero for PREPAID orders. |
order_id | String | Optional | Identification string for the order |
order_type | String | Optional | Type of payment of the shipment. Can only take values "COD" or "PREPAID". cod_value must be non-zero for COD shipments and zero for PREPAID shipments. |
invoice_value | Float | Optional | Value of the shipment as mentioned in the invoice. |
invoice_date | String | Optional | Date of issuance of the invoice of the shipment. (YYYY-MM-DD format only) |
Item Level details (items)
The details for each item to be delivered is passed in the "items" field, in "shipment_details".
| Field Name | Data Type | Field | Description | ||
|---|---|---|---|---|---|
cat | String | Optional | Category of the item in question | ||
description | String | Optional | Brief description of the item | ||
quantity | Integer | Optional | Number of units of the item | ||
weight | Float | Optional | Weight of each unit of the item | ||
price | Float | Optional | Price of each unit of the item (currency to be decided by 'currency_code' field) | ||
manufacture_country_code | String | Optional | Alpha-2 ISO Country code of manufacture of the item | ||
manufacture_country | String | Optional | Full country name of manufacture of the item | ||
sku | String | Optional | Stock-keeping unit of the item | ||
return_days | Integer | Optional | Number of days within which the item can be returned | ||
exchange_days | Integer | Optional | Number of days within which the item can be exchanged | ||
product_url | String | Optional | URL for the product. If there are multiple URLs, they can be sent as a single string with comma-separated values. | ||
images | String | Optional | URL for the image(s) of the product. If there are multiple URLs, they can be sent as a single string with comma-separated values. | ||
extra | Dict | Optional | Any custom data, in the key-value pair format, that you wish to send along with the shipment item info. Eg: Brand data, HSN Code etc | 1000 | {"brand":"Tesla"} |
Response
| Field Name | Data Type | Description |
|---|---|---|
meta | Object | Metadata for the result, e.g. status code, error messages. |
result | Object | Actual result of the 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
| Field Name | Data Type | Description |
|---|---|---|
tracking_id | Integer | Tracking ID of the newly registered waybill stored in our database. |
security_key | String | UUID string for the security key of the order |