Register shipment for tracking: V2

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. Applicable for Indian geographies.

Usecase

This is a standard API that supports MPS and SPS orders

URL

POST https://www.clickpost.in/api/v2/tracking/awb-register/

Body Payload

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

Field Name	Data Type	Field	Description	Max Length	Example
`waybill`	String	Mandatory	AWB to be registered	100	"TESTAWB00001"
`cp_id`	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. List: http://track.clickpost.in/courier_partner		215
`key`	String	Mandatory	Unique license key for the enterprise user provided by Clickpost	100	"34be9be5-3de8-4223-ad14-d7391159b80e"
`account_code`	String	Mandatory	Courier partner account name configured on the Clickpost dashboard	100	"test_account"
`consumer_details`	Object	Optional	Details of the consumer
`shipment_info`	Object	Optional	Details of the shipment to be registered
`additional`	Object	Optional	Additional 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 Name	Data Type	Field	Description	Max Length	Example
`order_date`	String	Optional	Date of placing the order (in YYYY-MM-DD format)	50	"2022-10-01"
`ship_date`	String	Optional	Date of shipping the order (in YYYY-MM-DD format)	50	"2022-10-01"
`language_code`	String	Optional	ISO Alpha-3 Language code for the shipment	2	"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 places. Example: Unicommerce, EasyEcom, Shopify, Retail Store		`Unicommerce`
`zone`	String	Optional	If 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. The zone wise analytics* will be visible under Home > Analytics > Zone Analysis
`reseller_info`	JSON Object	Optional	The reseller information to be passed		{ "name": "Clickpost Support", "phone": "8080808080" }
`name`	String	Optional	The name of the reseller		"Clickpost Support"
`phone`	String	Optional	The phone number of the reseller		"8080808080"

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	Max Length	Example
`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)		25.25
`breadth`	Float	Optional	Width of the overall package (in cms)		45.6
`length`	Float	Optional	Length of the overall package (in cms)		75.29
`weight`	Float	Optional	Weight of the package (in gms)		500.20
`reference_number`	String	Optional	Reference number of the order. Must be unique for every shipment, i.e. every call of this API.	100	"TestOrder00001"
`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.		25.25
`order_id`	String	Optional	Identification string for the order	100	"TestOrderID00001"
`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.	10	"COD"/"PREPAID"
`invoice_value`	Float	Optional	Value of the shipment as mentioned in the invoice.		256.29
`invoice_date`	String	Optional	Date of issuance of the invoice of the shipment. (`YYYY-MM-DD` format only)	100	2022-01-10

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	Max Length	Example
`cat`	String	Optional	Category of the item in question	50	Footwear
`description`	String	Optional	Brief description of the item	500	"Brown Cotton Socks - 1 pair"
`quantity`	Integer	Optional	Number of units of the item		5
`weight`	Float	Optional	Weight of each unit of the item		500
`price`	Float	Optional	Price of each unit of the item (currency to be decided by 'currency_code' field)		64.99
`sku`	String	Optional	Stock-keeping unit of the item	100	"SKU0001"
`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.	1000	"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"

Response

The sample response can have the following fields

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
`shipment_info`	Object	An object that contains only a single field: `id` that is the ID of the shipment
`consumer_details`	Object	An object that contains only a single field: `id` that is the ID of the consumer

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
    }
}

# Zone Wise Analytics