Register shipment for tracking: V3
Using this API enterprises can register an AWB for tracking updates with Clickpost. It takes the AWB number, carrier partner ID, shipment information, pick-up and drop information and additional details as input and returns the Clickpost tracking ID in response.
Overview
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. This API is supported globally, including cross-border shipments.
Usecase
This is a standard API that supports MPS (Multi-Piece Shipment) and SPS (Single Piece Shipment) orders
Geography
This API is supported globally
Path
POST https://www.clickpost.in/api/v3/tracking/awb-register/?key=<key>
Query Parameters
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
key | String | Mandatory | Unique license key | Provided by Clickpost team |
Body Payload
Payload encapsulates details regarding the AWB to be registered, and its details. Unknown fields are ignored. key is not read from the body.
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
waybill | String | Mandatory | AWB to be registered | 100 | "TESTAWB00001" |
courier_partner | Integer | Mandatory | Each carrier partner has a unique identifier (Integer value) in the Clickpost system, which will be used to identify the courier partner and track the shipment. Must be greater than 0. List: https://carriers.clickpost.ai/ | 215 | |
account_code | String | Mandatory | Courier partner account name configured on the Clickpost dashboard | 100 | "test_account" |
consumer_details | Object | Optional | Fallback contact details, used when the same value is not set on pickup or drop info | ||
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 | ||
appointment_info | Object | Optional | Appointment window for the shipment |
Consumer Details (consumer_details)
consumer_details)Optional fallback for contact name, phone, and email. Values on pickup_info and drop_info take priority. The messaging consumer stored for the shipment is built from drop_info on a forward shipment, and from pickup_info when the courier account is reverse.
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
name | String | Mandatory | Name of the consumer | "Test Customer" | |
phone | String | Mandatory | Phone number of the consumer | "8080808080" | |
email | String | Optional | Email of the consumer | "[email protected]" |
name and phone are mandatory when consumer_details is sent.
Pickup Info (pickup_info)
pickup_info)This object takes in the data for the warehouse/pickup location for the shipment.
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
name | String | Optional | Contact name of the consignor of the shipment | 100 | "John Smith" |
phone | String | Optional | Contact number of the pickup contact | 11 | "9876543210" |
phone_code | String | Optional | Country calling code, with or without a leading + | "966" | |
email | String | Optional | Email of the pickup contact | "[email protected]" | |
address | String | Optional | Address of the pickup location | 500 | "123, ABC Street" |
city | String | Optional | City of the pickup location | 200 | "Riyadh" |
state | String | Optional | State/province of the pickup location | 200 | "Al-Riyadh" |
district | String | Optional | District of the pickup location | 200 | "XYZ" |
pincode | String | Optional | Pickup pincode | "12211" | |
postal_code | String | Optional | Postal code of the pickup location. Used before pincode when both are sent | 50 | "12211" |
country_code | String | Optional | Alpha-2 ISO country code of the pickup location | 2 | "SA" |
lat | Float | Optional | Latitude of the pickup location | 24.7136 | |
long | Float | Optional | Longitude of the pickup location | 46.6753 | |
pickup_organisation | String | Optional | Pickup organisation name | 100 | "Warehouse A" |
time | Date | Optional | Pickup time. Accepted formats: YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS%z, YYYY-MM-DD HH:MM:SS%z | "2025-06-14T10:00:00+03:00" |
Drop Info (drop_info)
drop_info)This object takes in the data for the delivery/consignee location for the shipment.
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
name | String | Optional | Contact name of the consignee of the shipment | 100 | "John Smith" |
phone | String | Optional | Contact number of the drop contact | 11 | "9876543210" |
phone_code | String | Optional | Country calling code, with or without a leading + | "971" | |
email | String | Optional | Email of the drop contact | "[email protected]" | |
address | String | Optional | Address of the drop location | 500 | "123, ABC Street" |
city | String | Optional | City of the drop location | 200 | "Dubai" |
state | String | Optional | State/province of the drop location | 200 | "Dubai" |
district | String | Optional | District of the drop location | 200 | "XYZ" |
landmark | String | Optional | Landmarks to help find the drop location | 200 | "Near XYZ Towers" |
pincode | String | Optional | Drop pincode | "00000" | |
postal_code | String | Optional | Postal code of the drop location. Used before pincode when both are sent | 50 | "00000" |
country_code | String | Optional | Alpha-2 ISO country code of the drop location | 2 | "AE" |
lat | Float | Optional | Latitude of the drop location | 25.2048 | |
long | Float | Optional | Longitude of the drop location | 55.2708 | |
drop_organisation | String | Optional | Drop organisation name | 100 | "Acme LLC" |
drop_start_time | Date | Optional | Drop window start. Accepted formats: YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS%z, YYYY-MM-DD HH:MM:SS%z | "2025-06-14T10:00:00+04:00" | |
drop_end_time | Date | Optional | Drop window end. Accepted formats: YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS%z, YYYY-MM-DD HH:MM:SS%z | "2025-06-14T18:00:00+04:00" | |
user_category | String | Optional | User category | 50 | "VIP" |
collection_point_id | String | Optional | Collection point ID | 100 | "CP-1001" |
Additional Fields (additional)
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 | Max Length | Example |
|---|---|---|---|---|---|
order_date | Date | Optional | Date of placing the order. Accepted formats: YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS%z, YYYY-MM-DD HH:MM:SS%z | "2022-10-01" | |
ship_date | Date | Optional | Date of shipping the order. Accepted formats: YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS%z, YYYY-MM-DD HH:MM:SS%z | "2022-10-01" | |
language_code | String | Optional | ISO 639-2 (3-letter) or ISO 639-1 (2-letter) language code | 3 | "eng" |
min_edd | Integer | Optional | Minimum committed estimated delivery duration (in days) of the shipment | 5 | |
max_edd | Integer | Optional | Maximum committed estimated delivery duration (in days) of the shipment | 5 | |
channel_name | String | Optional | The channel through which the order was placed. Example: Unicommerce, EasyEcom, Shopify, Retail Store | Unicommerce | |
zone | String | Optional | Zone name used to group pickup and drop pin codes | 200 | "NORTH" |
estimated_delivery_date | Date | Optional | The date of estimated delivery has been shared with the customer. This field can be used to measure carrier performance by comparing it with the actual date of delivery in the Clickpost reports. Accepted formats: YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS%z, YYYY-MM-DD HH:MM:SS%z | "2025-06-14" | |
allocation_date | Date | Optional | Allocation date. Accepted formats: YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS%z, YYYY-MM-DD HH:MM:SS%z | "2017-02-14T18:00:00+05:30" | |
channel_order_id | String | Optional | Channel order ID | "channel_order_id" | |
order_id | String | Optional | Order ID. Used when shipment_info.order_id is not sent | "ORDER-12" | |
from_wh | String | Optional | Source warehouse. Used when shipment_info.source_warehouse is not sent | 200 | "SOURCE WAREHOUSE" |
to_wh | String | Optional | Destination warehouse | "DESTINATION WAREHOUSE" | |
enable_whatsapp | Boolean | Optional | Enable WhatsApp updates for the registered contact | false | |
user_type | String | Optional | Drop user type. Used when drop_info.user_category is not sent | 100 | "VIP" |
is_pudo | Boolean | Optional | Whether the shipment is a pick-up/drop-off (PUDO) shipment | false | |
bogo_order | Boolean | Optional | Whether the order is a buy-one-get-one order | false | |
is_trynow | Boolean | Optional | Whether the order is a try-now order | false | |
user_defined_field_array | List[Object] | Optional | Custom user-defined fields. Supported names: udf_1 to udf_10. Each object contains name, type, and value. Other names are ignored | [{"name":"udf_1","type":"string","value":"high"}] | |
cp_specific_fields | Object | Optional | Carrier-specific key-value fields. Values are strings | {"vendor_code":"ABC"} |
Shipment Info (shipment_info)
shipment_info)In the shipment_info field, the details regarding all items, and important order details like payment type, delivery type, package dimensions, etc. are added.
Pickup and drop values sent on pickup_info and drop_info take priority over the same values sent inside shipment_info. Item rows are sent on shipment_info.items.
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
item | String | Optional | Short description of the item / package. Stored up to 500 characters | "Shirt" | |
items | List[Object] | Optional | List of items in the shipment. See Item Level details | ||
height | Integer | Optional | Height of the overall package (in cms) | 25 | |
breadth | Integer | Optional | Width of the overall package (in cms) | 45 | |
length | Integer | Optional | Length of the overall package (in cms) | 75 | |
weight | Integer | Optional | Weight of the package (in gms) | 500 | |
reference_number | String | Optional | Reference number of the order | 500 | "TestOrder00001" |
cod_amount | Float | Optional | Cash to be given to the carrier. Currency is determined by currency_code | 25.25 | |
order_id | String | Optional | Identification string for the order | 500 | "TestOrderID00001" |
order_type | String | Optional | Type of payment of the shipment. Accepted values: "COD", "PREPAID", "EXCHANGE" | "COD" | |
delivery_type | String | Optional | Type of delivery. Accepted values: "FORWARD", "REVERSE". "RVP" is accepted as an alias of "REVERSE". When omitted, forward accounts are stored as forward and reverse accounts as reverse | "FORWARD" | |
invoice_value | Float | Optional | Value of the shipment as mentioned in the invoice | 256.29 | |
invoice_number | String | Optional | Invoice number of the shipment | 500 | "INV-1001" |
invoice_url | String | Optional | URL of the invoice | ||
currency_code | String | Optional | ISO 4217 currency code for monetary fields | "SAR" | |
shipping_charges | Float | Optional | Shipping charges for the shipment | 50.0 | |
sku_code | String | Optional | SKU code at shipment level. Stored up to 500 characters | "SKU0001" | |
source_warehouse | String | Optional | Source warehouse identifier | "WH-RUH" | |
box_count | Integer | Optional | Number of boxes in the shipment. Stored as 1 when omitted and shipment_info is sent | 1 | |
pickup_name | String | Optional | Pickup contact name | "John Smith" | |
pickup_phone | String | Optional | Pickup contact phone | "9876543210" | |
pickup_email | String | Optional | Pickup contact email | "[email protected]" | |
pickup_address | String | Optional | Pickup address | "123, ABC Street" | |
pickup_city | String | Optional | Pickup city | "Riyadh" | |
pickup_state | String | Optional | Pickup state | "Al-Riyadh" | |
pickup_pincode | String | Optional | Pickup pincode | "12211" | |
pickup_pin_code | String | Optional | Pickup pin code. Used when pickup_pincode is not sent | "12211" | |
pickup_country_code | String | Optional | Alpha-2 ISO country code of the pickup location | "SA" | |
pickup_organisation | String | Optional | Pickup organisation name | "Warehouse A" | |
pickup_lat | Float | Optional | Latitude of the pickup location | 24.7136 | |
pickup_long | Float | Optional | Longitude of the pickup location | 46.6753 | |
drop_name | String | Optional | Drop contact name | "John Smith" | |
drop_phone | String | Optional | Drop contact phone | "9876543210" | |
drop_email | String | Optional | Drop contact email | "[email protected]" | |
drop_address | String | Optional | Drop address | "123, ABC Street" | |
drop_city | String | Optional | Drop city | "Dubai" | |
drop_state | String | Optional | Drop state | "Dubai" | |
drop_pincode | String | Optional | Drop pincode | "00000" | |
drop_pin_code | String | Optional | Drop pin code. Used when drop_pincode is not sent | "00000" | |
drop_country_code | String | Optional | Alpha-2 ISO country code of the drop location | "AE" | |
drop_organisation | String | Optional | Drop organisation name | "Acme LLC" | |
drop_lat | Float | Optional | Latitude of the drop location | 25.2048 | |
drop_long | Float | Optional | Longitude of the drop location | 55.2708 | |
drop_start_time | Date | Optional | Drop window start. Accepted formats: YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS%z, YYYY-MM-DD HH:MM:SS%z | "2025-06-14T10:00:00+04:00" | |
drop_end_time | Date | Optional | Drop window end. Accepted formats: YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS%z, YYYY-MM-DD HH:MM:SS%z | "2025-06-14T18:00:00+04:00" |
Item Level details (shipment_info.items)
shipment_info.items)The details for each item to be delivered are passed in the items array on shipment_info.
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
sku | String | Optional | Stock-keeping unit of the item | 500 | "SKU0001" |
description | String | Optional | Brief description of the item | "Brown Cotton Socks - 1 pair" | |
quantity | Integer | Optional | Number of units of the item | 5 | |
weight | Integer | Optional | Weight of each unit of the item (in gms) | 500 | |
price | Float | Optional | Price of each unit of the item (currency is determined by currency_code) | 64.99 | |
cat | String | Optional | Category of the item | "Footwear" | |
return_days | Integer | Optional | Number of days within which the item can be returned | 5 | |
exchange_days | Integer | Optional | Number of days within which the item can be exchanged | 5 | |
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 | "http://link1.to.product, http://link2.to.product" | |
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 | 1000 | "http://link.to.product.image1, http://link.to.product.image2" |
length | Integer | Optional | Length of the item (in cms) | 10 | |
breadth | Integer | Optional | Breadth of the item (in cms) | 10 | |
height | Integer | Optional | Height of the item (in cms) | 10 | |
brand | String | Optional | Brand of the item | "Nike" | |
color | String | Optional | Color of the item | "Brown" | |
discount | Float | Optional | Discount amount | 10.0 | |
store_credits_used | Float | Optional | Store credits used for the item | 0 | |
final_amount_paid | Float | Optional | Final amount paid for the item | 54.99 | |
payment_gateway | String | Optional | Payment gateway used for the item | "stripe" | |
gift_voucher | Float | Optional | Gift voucher amount applied to the item | 0 | |
loyalty_points | Float | Optional | Loyalty points applied to the item | 0 | |
serial_no | String | Optional | Serial number of the item | "SN0001" | |
imei | String | Optional | IMEI of the item | "490154203237518" | |
product_id | String | Optional | Product ID | "P-1001" | |
variant_id | String | Optional | Variant ID | "V-1001" | |
combo_product_id | String | Optional | Combo product ID | "C-1001" | |
combo_variant_id | String | Optional | Combo variant ID | "CV-1001" | |
bundle_sku | String | Optional | Bundle SKU of the item | "BUNDLE-1" | |
is_subscription | Boolean | Optional | Whether the item is a subscription item | false | |
is_trynow | Boolean | Optional | Whether the item is a try-now item | false | |
extras | Object | Optional | Custom key-value data for the item. Values are strings | {"hsn_code":"6109"} |
Appointment Info (appointment_info)
appointment_info)Optional appointment window. Both start_time and end_time are needed for the appointment to be saved. start_time must be in the future, and end_time must be later than start_time. If those conditions are not met, the AWB is still registered and the appointment is skipped.
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
appointment_id | String | Optional | Appointment identifier | 500 | "appt-1" |
start_time | Date | Optional | Appointment start. Accepted formats: YYYY-MM-DDTHH:MM:SSZ, YYYY-MM-DDTHH:MM:SS%z | "2025-06-14T10:00:00+04:00" | |
end_time | Date | Optional | Appointment end. Accepted formats: YYYY-MM-DDTHH:MM:SSZ, YYYY-MM-DDTHH:MM:SS%z | "2025-06-14T18:00:00+04:00" |
Response
The sample response can have the following fields. Authentication and authorization failures return meta only.
| Field Name | Data Type | Description |
|---|---|---|
meta | Object | Metadata for the result, e.g. status code, error messages |
result | Object | Actual result of the request. null when the request fails after the payload is accepted |
errorDetail | List[Object] | Detailed error messages on handler failures. null on success. Each object has message, bucket, and recommendedActions |
meta.status is the business status code. A new registration and an already-registered waybill both use HTTP 200. Payload, account, and courier errors use HTTP 400, with the specific code in meta.status.
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
On success, result contains tracking_id, security_key, consumer_details, and shipment_info. On an already-registered waybill (meta.status 303), result contains only tracking_id and security_key.
| Field Name | Data Type | Description |
|---|---|---|
tracking_id | Integer | Tracking ID of the registered waybill stored in our database |
security_key | String | UUID string for the security key of the order |
shipment_info | Object or False | An object that contains only a single field: id, the ID of the shipment. Returned as Boolean false when shipment_info was not passed |
consumer_details | Object or False | An object that contains only a single field: id, the ID of the consumer. Built from drop info on forward shipments and pickup info on reverse shipments. Returned as Boolean false when that contact has neither phone nor email |
Error Detail
Returned on handler failures. null on success.
| Field Name | Data Type | Description |
|---|---|---|
message | String | Field-level or business error message |
bucket | String | Failure classification |
recommendedActions | String | What to change before retrying |
Status Codes
| HTTP | meta.status | success | When |
|---|---|---|---|
| 200 | 200 | true | New waybill registered |
| 200 | 303 | false | Waybill already registered for this courier account |
| 200 | 332 | false | Reference number already exists. Returned when duplicate reference checks are enabled |
| 400 | 400 | false | Query key is missing or not a UUID, or a field value failed validation |
| 400 | 328 | false | Body is not a valid JSON object |
| 400 | 4007 | false | Payload structure or data type is invalid, or a mandatory field is missing |
| 400 | 302 | false | Courier partner id is not a supported carrier |
| 400 | 351 | false | No Clickpost account exists for this courier partner and account code |
| 400 | 353 | false | Clickpost account for this courier partner and account code is inactive |
| 401 | 301 | false | License key is not a known enterprise key |
| 403 | 301 | false | Tracking is not subscribed, or the user is inactive |
| 500 | 500 | false | Internal server error |
| 500 | 5002 | false | AWB registration could not be saved |
Sample Request
{
"waybill": "ABCDEFGHIJKL0001",
"courier_partner": 246,
"account_code": "test_account",
"consumer_details": {
"name": "Test Customer",
"phone": "9876543210",
"email": "[email protected]"
},
"shipment_info": {
"order_type": "COD",
"delivery_type": "FORWARD",
"invoice_value": 12345,
"cod_amount": 1000,
"currency_code": "SAR",
"reference_number": "123XYZ",
"order_id": "ORDER-12",
"invoice_number": "INV-1001",
"length": 10,
"height": 10,
"weight": 10,
"breadth": 10,
"box_count": 1,
"items": [
{
"sku": "XYZ1",
"description": "item1",
"quantity": 1,
"price": 200,
"images": "<Image URL>",
"return_days": 2,
"exchange_days": 5,
"length": 10,
"height": 10,
"breadth": 10,
"weight": 100,
"brand": "Tesla",
"cat": "Electronic Vehicle",
"extras": {
"hsn_code": "6109"
}
}
]
},
"pickup_info": {
"name": "DEFG",
"email": "[email protected]",
"phone_code": "966",
"phone": "1234567890",
"address": "Some Address",
"postal_code": "12211",
"city": "Riyadh",
"district": "XYZ",
"state": "Al-Riyadh",
"country_code": "SA",
"lat": 24.7136,
"long": 46.6753,
"time": "2025-06-14T10:00:00+03:00"
},
"drop_info": {
"name": "ABCD",
"email": "[email protected]",
"phone_code": "971",
"phone": "9876443210",
"address": "ABCD TOWERS",
"postal_code": "00000",
"city": "Dubai",
"district": "XYZ",
"state": "Dubai",
"landmark": "Near XYZ Towers",
"country_code": "AE",
"lat": 25.2048,
"long": 55.2708
},
"additional": {
"enable_whatsapp": false,
"order_date": "2017-02-14",
"ship_date": "2017-02-14",
"min_edd": 2,
"max_edd": 4,
"estimated_delivery_date": "2025-06-14",
"language_code": "eng",
"order_id": "ORDER-12",
"allocation_date": "2017-02-14T18:00:00+05:30",
"channel_order_id": "channel_123",
"from_wh": "SOURCE WAREHOUSE",
"to_wh": "DESTINATION WAREHOUSE"
},
"appointment_info": {
"appointment_id": "appt-1",
"start_time": "2025-06-14T10:00:00+04:00",
"end_time": "2025-06-14T18:00:00+04:00"
}
}Sample Response
Success
When shipment_info is omitted, result.shipment_info is false. When the forward drop contact, or the reverse pickup contact, has neither phone nor email, result.consumer_details is false. An already-registered waybill is the same waybill on the same courier account.
{
"meta": {
"status": 200,
"message": "SUCCESS",
"success": true
},
"result": {
"consumer_details": {
"id": 475565855
},
"shipment_info": {
"id": 456652061
},
"tracking_id": 494235601,
"security_key": "35aae392-5009-436a-b29b-7ddb2db518ab"
},
"errorDetail": null
}{
"meta": {
"status": 303,
"message": "Waybill already registered",
"success": false
},
"result": {
"tracking_id": 267984163,
"security_key": "37317af1-f3c3-4c41-b563-99b5c601e59d"
},
"errorDetail": [
{
"message": "Waybill already registered",
"bucket": "AWB_ALREADY_REGISTERED",
"recommendedActions": "This waybill is already registered. Use a different AWB, or look up the existing shipment."
}
]
}{
"meta": {
"status": 332,
"message": "Reference Number already exists",
"success": false
},
"result": null,
"errorDetail": [
{
"message": "Reference Number already exists",
"bucket": "DUPLICATE_REFERENCE_NUMBER",
"recommendedActions": "This reference number already exists. Use a unique reference number and retry."
}
]
}Authentication Errors
{
"meta": {
"status": 400,
"message": "Query parameter 'key' is required",
"success": false
}
}{
"meta": {
"status": 400,
"message": "Error: Invalid API request data",
"success": false
}
}{
"meta": {
"status": 301,
"message": "Authentication Failed: Invalid API Key",
"success": false
}
}Authorization Errors
{
"meta": {
"status": 301,
"message": "Authorization Failed: Service not subscribed",
"success": false
}
}{
"meta": {
"status": 301,
"message": "Authorization Failed: User is inactive",
"success": false
}
}Account Errors
{
"meta": {
"status": 353,
"success": false,
"message": "Clickpost Account: Inactive"
},
"result": null,
"errorDetail": [
{
"message": "Clickpost Account: Inactive for courier partner 4 and account code shop3",
"bucket": "ACCOUNT_INACTIVE",
"recommendedActions": "The Clickpost account for this courier partner and account code is inactive. Activate it, then retry."
}
]
}{
"meta": {
"status": 351,
"success": false,
"message": "Clickpost Account: Does not exist"
},
"result": null,
"errorDetail": [
{
"message": "Clickpost Account: Does not exist for courier partner 4 and account code shop213456781",
"bucket": "ACCOUNT_NOT_FOUND",
"recommendedActions": "No Clickpost account exists for this courier partner and account code. Create the courier account or correct the account code, then retry."
}
]
}{
"meta": {
"status": 302,
"success": false,
"message": "Invalid CP ID"
},
"result": null,
"errorDetail": [
{
"message": "Invalid CP ID",
"bucket": "INVALID_COURIER_PARTNER",
"recommendedActions": "The courier partner id is invalid. Pass a supported courier partner and retry."
}
]
}Validation Errors
{
"meta": {
"status": 400,
"message": "Error: Invalid API request data",
"success": false
},
"result": null,
"errorDetail": [
{
"message": ".waybill: waybill is required and cannot be blank",
"bucket": "CLICKPOST_PAYLOAD_VALIDATION_FAILURE",
"recommendedActions": "The request data is invalid. Correct the fields in the payload and retry."
}
]
}{
"meta": {
"status": 400,
"message": "Error: Invalid API request data",
"success": false
},
"result": null,
"errorDetail": [
{
"message": ".shipmentInfo.orderType: shipment_info.order_type must be COD, PREPAID or EXCHANGE",
"bucket": "CLICKPOST_PAYLOAD_VALIDATION_FAILURE",
"recommendedActions": "The request data is invalid. Correct the fields in the payload and retry."
}
]
}{
"meta": {
"status": 4007,
"message": "Error: Please pass the the correct payload structure and all the mandatory fields",
"success": false
},
"result": null,
"errorDetail": [
{
"message": "courier_partner: Expected type Integer, but received String. Passed value: abc",
"bucket": "CLICKPOST_PAYLOAD_VALIDATION_FAILURE",
"recommendedActions": "The payload structure or datatype is invalid. Send the correct payload structure with all mandatory fields and retry."
}
]
}{
"meta": {
"status": 328,
"message": "Invalid Payload. Please pass a valid json",
"success": false
},
"result": null,
"errorDetail": [
{
"message": "Unexpected JSON token at offset 0",
"bucket": "CLICKPOST_PAYLOAD_VALIDATION_FAILURE",
"recommendedActions": "The request body is not valid JSON. Send a valid JSON payload and retry."
}
]
}Internal Errors
{
"meta": {
"status": 500,
"message": "Error: Internal server error",
"success": false
},
"result": null,
"errorDetail": [
{
"message": "Error: Internal server error",
"bucket": "CLICKPOST_INTERNAL_FAILURE",
"recommendedActions": "Something went wrong on Clickpost. Retry once. If it continues, contact Clickpost support with your waybill."
}
]
}{
"meta": {
"status": 5002,
"message": "Error: Awb Registration data storage failed. Please contact clickpost support",
"success": false
},
"result": null,
"errorDetail": [
{
"message": "Error: Awb Registration data storage failed. Please contact clickpost support",
"bucket": "CLICKPOST_INTERNAL_FAILURE",
"recommendedActions": "The AWB registration could not be saved on Clickpost. Retry once. If it continues, contact Clickpost support with your waybill."
}
]
}Updated 13 days ago
