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.

Run in Postman API Reference

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 NameData TypeFieldDescriptionMax LengthExample
keyStringMandatoryUnique license keyProvided 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 NameData TypeFieldDescriptionMax LengthExample
waybillStringMandatoryAWB to be registered100"TESTAWB00001"
courier_partnerIntegerMandatoryEach 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_codeStringMandatoryCourier partner account name configured on the Clickpost dashboard100"test_account"
consumer_detailsObjectOptionalFallback contact details, used when the same value is not set on pickup or drop info
shipment_infoObjectOptionalDetails of the shipment to be registered
pickup_infoObjectOptionalDetails for pickup of the shipment
drop_infoObjectOptionalDetails for delivery of the shipment
additionalObjectOptionalAdditional optional fields
appointment_infoObjectOptionalAppointment window for the shipment

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 NameData TypeFieldDescriptionMax LengthExample
nameStringMandatoryName of the consumer"Test Customer"
phoneStringMandatoryPhone number of the consumer"8080808080"
emailStringOptionalEmail of the consumer"[email protected]"

name and phone are mandatory when consumer_details is sent.

Pickup Info (pickup_info)

This object takes in the data for the warehouse/pickup location for the shipment.

Field NameData TypeFieldDescriptionMax LengthExample
nameStringOptionalContact name of the consignor of the shipment100"John Smith"
phoneStringOptionalContact number of the pickup contact11"9876543210"
phone_codeStringOptionalCountry calling code, with or without a leading +"966"
emailStringOptionalEmail of the pickup contact"[email protected]"
addressStringOptionalAddress of the pickup location500"123, ABC Street"
cityStringOptionalCity of the pickup location200"Riyadh"
stateStringOptionalState/province of the pickup location200"Al-Riyadh"
districtStringOptionalDistrict of the pickup location200"XYZ"
pincodeStringOptionalPickup pincode"12211"
postal_codeStringOptionalPostal code of the pickup location. Used before pincode when both are sent50"12211"
country_codeStringOptionalAlpha-2 ISO country code of the pickup location2"SA"
latFloatOptionalLatitude of the pickup location24.7136
longFloatOptionalLongitude of the pickup location46.6753
pickup_organisationStringOptionalPickup organisation name100"Warehouse A"
timeDateOptionalPickup 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)

This object takes in the data for the delivery/consignee location for the shipment.

Field NameData TypeFieldDescriptionMax LengthExample
nameStringOptionalContact name of the consignee of the shipment100"John Smith"
phoneStringOptionalContact number of the drop contact11"9876543210"
phone_codeStringOptionalCountry calling code, with or without a leading +"971"
emailStringOptionalEmail of the drop contact"[email protected]"
addressStringOptionalAddress of the drop location500"123, ABC Street"
cityStringOptionalCity of the drop location200"Dubai"
stateStringOptionalState/province of the drop location200"Dubai"
districtStringOptionalDistrict of the drop location200"XYZ"
landmarkStringOptionalLandmarks to help find the drop location200"Near XYZ Towers"
pincodeStringOptionalDrop pincode"00000"
postal_codeStringOptionalPostal code of the drop location. Used before pincode when both are sent50"00000"
country_codeStringOptionalAlpha-2 ISO country code of the drop location2"AE"
latFloatOptionalLatitude of the drop location25.2048
longFloatOptionalLongitude of the drop location55.2708
drop_organisationStringOptionalDrop organisation name100"Acme LLC"
drop_start_timeDateOptionalDrop 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_timeDateOptionalDrop 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_categoryStringOptionalUser category50"VIP"
collection_point_idStringOptionalCollection point ID100"CP-1001"

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 NameData TypeFieldDescriptionMax LengthExample
order_dateDateOptionalDate 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_dateDateOptionalDate 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_codeStringOptionalISO 639-2 (3-letter) or ISO 639-1 (2-letter) language code3"eng"
min_eddIntegerOptionalMinimum committed estimated delivery duration (in days) of the shipment5
max_eddIntegerOptionalMaximum committed estimated delivery duration (in days) of the shipment5
channel_nameStringOptionalThe channel through which the order was placed. Example: Unicommerce, EasyEcom, Shopify, Retail StoreUnicommerce
zoneStringOptionalZone name used to group pickup and drop pin codes200"NORTH"
estimated_delivery_dateDateOptionalThe 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_dateDateOptionalAllocation 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_idStringOptionalChannel order ID"channel_order_id"
order_idStringOptionalOrder ID. Used when shipment_info.order_id is not sent"ORDER-12"
from_whStringOptionalSource warehouse. Used when shipment_info.source_warehouse is not sent200"SOURCE WAREHOUSE"
to_whStringOptionalDestination warehouse"DESTINATION WAREHOUSE"
enable_whatsappBooleanOptionalEnable WhatsApp updates for the registered contactfalse
user_typeStringOptionalDrop user type. Used when drop_info.user_category is not sent100"VIP"
is_pudoBooleanOptionalWhether the shipment is a pick-up/drop-off (PUDO) shipmentfalse
bogo_orderBooleanOptionalWhether the order is a buy-one-get-one orderfalse
is_trynowBooleanOptionalWhether the order is a try-now orderfalse
user_defined_field_arrayList[Object]OptionalCustom 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_fieldsObjectOptionalCarrier-specific key-value fields. Values are strings{"vendor_code":"ABC"}

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 NameData TypeFieldDescriptionMax LengthExample
itemStringOptionalShort description of the item / package. Stored up to 500 characters"Shirt"
itemsList[Object]OptionalList of items in the shipment. See Item Level details
heightIntegerOptionalHeight of the overall package (in cms)25
breadthIntegerOptionalWidth of the overall package (in cms)45
lengthIntegerOptionalLength of the overall package (in cms)75
weightIntegerOptionalWeight of the package (in gms)500
reference_numberStringOptionalReference number of the order500"TestOrder00001"
cod_amountFloatOptionalCash to be given to the carrier. Currency is determined by currency_code25.25
order_idStringOptionalIdentification string for the order500"TestOrderID00001"
order_typeStringOptionalType of payment of the shipment. Accepted values: "COD", "PREPAID", "EXCHANGE""COD"
delivery_typeStringOptionalType 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_valueFloatOptionalValue of the shipment as mentioned in the invoice256.29
invoice_numberStringOptionalInvoice number of the shipment500"INV-1001"
invoice_urlStringOptionalURL of the invoice
currency_codeStringOptionalISO 4217 currency code for monetary fields"SAR"
shipping_chargesFloatOptionalShipping charges for the shipment50.0
sku_codeStringOptionalSKU code at shipment level. Stored up to 500 characters"SKU0001"
source_warehouseStringOptionalSource warehouse identifier"WH-RUH"
box_countIntegerOptionalNumber of boxes in the shipment. Stored as 1 when omitted and shipment_info is sent1
pickup_nameStringOptionalPickup contact name"John Smith"
pickup_phoneStringOptionalPickup contact phone"9876543210"
pickup_emailStringOptionalPickup contact email"[email protected]"
pickup_addressStringOptionalPickup address"123, ABC Street"
pickup_cityStringOptionalPickup city"Riyadh"
pickup_stateStringOptionalPickup state"Al-Riyadh"
pickup_pincodeStringOptionalPickup pincode"12211"
pickup_pin_codeStringOptionalPickup pin code. Used when pickup_pincode is not sent"12211"
pickup_country_codeStringOptionalAlpha-2 ISO country code of the pickup location"SA"
pickup_organisationStringOptionalPickup organisation name"Warehouse A"
pickup_latFloatOptionalLatitude of the pickup location24.7136
pickup_longFloatOptionalLongitude of the pickup location46.6753
drop_nameStringOptionalDrop contact name"John Smith"
drop_phoneStringOptionalDrop contact phone"9876543210"
drop_emailStringOptionalDrop contact email"[email protected]"
drop_addressStringOptionalDrop address"123, ABC Street"
drop_cityStringOptionalDrop city"Dubai"
drop_stateStringOptionalDrop state"Dubai"
drop_pincodeStringOptionalDrop pincode"00000"
drop_pin_codeStringOptionalDrop pin code. Used when drop_pincode is not sent"00000"
drop_country_codeStringOptionalAlpha-2 ISO country code of the drop location"AE"
drop_organisationStringOptionalDrop organisation name"Acme LLC"
drop_latFloatOptionalLatitude of the drop location25.2048
drop_longFloatOptionalLongitude of the drop location55.2708
drop_start_timeDateOptionalDrop 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_timeDateOptionalDrop 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)

The details for each item to be delivered are passed in the items array on shipment_info.

Field NameData TypeFieldDescriptionMax LengthExample
skuStringOptionalStock-keeping unit of the item500"SKU0001"
descriptionStringOptionalBrief description of the item"Brown Cotton Socks - 1 pair"
quantityIntegerOptionalNumber of units of the item5
weightIntegerOptionalWeight of each unit of the item (in gms)500
priceFloatOptionalPrice of each unit of the item (currency is determined by currency_code)64.99
catStringOptionalCategory of the item"Footwear"
return_daysIntegerOptionalNumber of days within which the item can be returned5
exchange_daysIntegerOptionalNumber of days within which the item can be exchanged5
product_urlStringOptionalURL 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"
imagesStringOptionalURL for the image(s) of the product. If there are multiple URLs, they can be sent as a single string with comma-separated values1000"http://link.to.product.image1, http://link.to.product.image2"
lengthIntegerOptionalLength of the item (in cms)10
breadthIntegerOptionalBreadth of the item (in cms)10
heightIntegerOptionalHeight of the item (in cms)10
brandStringOptionalBrand of the item"Nike"
colorStringOptionalColor of the item"Brown"
discountFloatOptionalDiscount amount10.0
store_credits_usedFloatOptionalStore credits used for the item0
final_amount_paidFloatOptionalFinal amount paid for the item54.99
payment_gatewayStringOptionalPayment gateway used for the item"stripe"
gift_voucherFloatOptionalGift voucher amount applied to the item0
loyalty_pointsFloatOptionalLoyalty points applied to the item0
serial_noStringOptionalSerial number of the item"SN0001"
imeiStringOptionalIMEI of the item"490154203237518"
product_idStringOptionalProduct ID"P-1001"
variant_idStringOptionalVariant ID"V-1001"
combo_product_idStringOptionalCombo product ID"C-1001"
combo_variant_idStringOptionalCombo variant ID"CV-1001"
bundle_skuStringOptionalBundle SKU of the item"BUNDLE-1"
is_subscriptionBooleanOptionalWhether the item is a subscription itemfalse
is_trynowBooleanOptionalWhether the item is a try-now itemfalse
extrasObjectOptionalCustom key-value data for the item. Values are strings{"hsn_code":"6109"}

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 NameData TypeFieldDescriptionMax LengthExample
appointment_idStringOptionalAppointment identifier500"appt-1"
start_timeDateOptionalAppointment start. Accepted formats: YYYY-MM-DDTHH:MM:SSZ, YYYY-MM-DDTHH:MM:SS%z"2025-06-14T10:00:00+04:00"
end_timeDateOptionalAppointment 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 NameData TypeDescription
metaObjectMetadata for the result, e.g. status code, error messages
resultObjectActual result of the request. null when the request fails after the payload is accepted
errorDetailList[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 NameData TypeDescription
statusIntegerStatus code of the response (including, but not limited to HTTP Status codes)
messageStringError message (if any errors) for the request
successBooleanWhether 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 NameData TypeDescription
tracking_idIntegerTracking ID of the registered waybill stored in our database
security_keyStringUUID string for the security key of the order
shipment_infoObject or FalseAn object that contains only a single field: id, the ID of the shipment. Returned as Boolean false when shipment_info was not passed
consumer_detailsObject or FalseAn 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 NameData TypeDescription
messageStringField-level or business error message
bucketStringFailure classification
recommendedActionsStringWhat to change before retrying

Status Codes

HTTPmeta.statussuccessWhen
200200trueNew waybill registered
200303falseWaybill already registered for this courier account
200332falseReference number already exists. Returned when duplicate reference checks are enabled
400400falseQuery key is missing or not a UUID, or a field value failed validation
400328falseBody is not a valid JSON object
4004007falsePayload structure or data type is invalid, or a mandatory field is missing
400302falseCourier partner id is not a supported carrier
400351falseNo Clickpost account exists for this courier partner and account code
400353falseClickpost account for this courier partner and account code is inactive
401301falseLicense key is not a known enterprise key
403301falseTracking is not subscribed, or the user is inactive
500500falseInternal server error
5005002falseAWB 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."
        }
    ]
}

Did this page help you?