Register shipment for tracking: V2

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":"ABCDRESDEFGHIJKL1257679",
   "cp_id":1,
   "key":"42d42a34-ae09-4693-b20c-ae2624218a329",
   "account_code":"Fedex Domestic",
   "consumer_details":{
      "name":"Test Customer",
      "phone":"8080808080",
      "email":"[email protected]"
   },
   "shipment_info":{
      "item":"Shirt",
      "order_type":"COD",
      "invoice_value":1000,
      "reference_number":"123XYZ",
      "length":10,
      "height":10,
      "weight":10,
      "breadth":10,
      "drop_pincode":"110001",
      "pickup_pincode":"110001",
      "delivery_type":"FORWARD",
      "cod_amount":1000.10,
      "drop_address":"Roots hacker Home, R 28, Second Floor, Nehru Enclace, Opposite Nehru Place, New Delhi 110001",
      "additional":{
         "items":[
            {
               "sku":"XYZ1",
               "description":"item1",
               "quantity":1,
               "price":200,
               "images":"<Image URL>",
               "return_days":2,
               "additional":{
                  "length":10,
                  "height":10,
                  "breadth":10,
                  "weight":100
               }
            }
         ]
      }
   },
   "additional":{
      "order_date":"2017-02-14T18:00:00+05:30",
      "ship_date":"2017-02-14T23:00:00+05:30",
      "min_edd":2,
      "max_edd":4,
      "enable_whatsapp":false,
      "order_id":"ORDER-12"
   }
}

Sample Response

{
    "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"
    }
}
{
    "meta": {
        "status": 303,
        "message": "Waybill already registered",
        "success": false
    }
}
{
    "meta": {
        "status": 351,
        "message": "Clickpost Account: Does not exist",
        "success": false
    }
}

Important Links

Run in Postman API Reference

Body Payload

Payload encapsulates details regarding the AWB to be registered, and its details

Field NameData TypeFieldDescription
waybillStringMandatoryAWB to be registered
cp_idIntegerMandatoryCarrier partner which should be tracking the AWB
keyStringMandatoryUnique license key for the enterprise user provided by Clickpost
account_codeStringMandatoryCourier partner account name configured on the Clickpost dashboard.
consumer_detailsObjectOptionalDetails of the consumer
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

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 TypeFieldDescription
enable_whatsappBooleanOptionalIf enterprise has WhatsApp for business account, they can pass opt-in information here so Clickpost starts sending out communications to customers
order_dateStringOptionalDate of placing the order (in YYYY-MM-DD format)
ship_dateStringOptionalDate of shipping the order (in YYYY-MM-DD format)
language_codeStringOptionalISO Alpha-3 Language code for the shipment
min_eddIntegerOptionalMinimum committed estimated delivery duration (in days) of the shipment
max_eddIntegerOptionalMaximum committed estimated delivery duration (in days) of the shipment
channel_nameStringOptionalThe channel through which the order was places. Example: Unicommerce, EasyEcom, Shopify, Retail Store
zoneString OptionalIf you wish to club multiple pickup-drop pin-codes together for easier recommendation allocation rule or for better visibility on internal business metrics based on a collection of pin-codes, this field is handy.

This can be configured in the Pricing section in courier partner account configuration section. (Settings>Courier>Integrations>Accounts> Configuration > Pricing)
reseller_infoJSON ObjectOptionalThe reseller information to be passed
nameStringOptionalThe name of the reseller
phoneStringOptionalThe phone number of the reseller

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 NameData TypeFieldDescription
itemsList[Object]OptionalList of items to be delivered in the shipment. Details of the items explained below.
heightFloatOptionalHeight of the overall package (in cms)
widthFloatOptionalWidth of the overall package (in cms)
lengthFloatOptionalLength of the overall package (in cms)
weightFloatOptionalWeight of the package (in gms)
reference_numberStringOptionalReference number of the order. Must be unique for every shipment, i.e. every call of this API.
cod_valueFloatOptionalCash 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_idStringOptionalIdentification string for the order
order_typeStringOptionalType 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_valueFloatOptionalValue of the shipment as mentioned in the invoice.
invoice_dateStringOptionalDate 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 NameData TypeFieldDescription
catStringOptionalCategory of the item in question
descriptionStringOptionalBrief description of the item
quantityIntegerOptionalNumber of units of the item
weightFloatOptionalWeight of each unit of the item
priceFloatOptionalPrice of each unit of the item (currency to be decided by 'currency_code' field)
manufacture_country_codeStringOptionalAlpha-2 ISO Country code of manufacture of the item
manufacture_countryStringOptionalFull country name of manufacture of the item
skuStringOptionalStock-keeping unit of the item
return_daysIntegerOptionalNumber of days within which the item can be returned
exchange_daysIntegerOptionalNumber of days within which the item can be exchanged
product_urlStringOptionalURL for the product. If there are multiple URLs, they can be sent as a single string with comma-separated values.
imagesStringOptionalURL for the image(s) of the product. If there are multiple URLs, they can be sent as a single string with comma-separated values.

Response

The sample response can have the following fields

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

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

Field NameData TypeDescription
tracking_idIntegerTracking ID of the newly registered waybill stored in our database.
security_keyStringUUID string for the security key of the order
shipment_infoObjectAn object that contains only a single field: id that is the ID of the shipment
consumer_detailsObjectAn object that contains only a single field: id that is the ID of the consumer
Language
Click Try It! to start a request and see the response here!