CLickPost
INTEGRATION DOCUMENT
|
About ClickPost
ClickPost is a logistics aggregator that helps integrate with multiple shipping partners, send shipping updates to customers, and optimize logistics operations. ClickPost uses machine learning and data science to let ecommerce enterprises match area codes (PIN codes) with the best logistics vendor, monitor dispatches in real time, identify and solve exceptions, predict delays in the shipment process, estimate accurate delivery dates on the product page, and track returns.
Services Integrated
Below are the services of ClickPost which are integrated with e-Retail:
- Shipment Tracking
- Forward Manifest
- Reverse Manifest
Pre-requisites
Before configuring the transporter on Vin e-Retail, the following needs to be obtained from ClickPost:
- ClickPost API Key
- Courier User Name
- Courier API Key
- Courier Partner ID
- Courier Account Code
Configuring the logistics partner
Below are the steps to configure the transporter in eRetail:
- Login on Vin e-Retail. Once logged in, navigate to left hand side of the screen towards the menu.
2. Hover over the Master Module and click on Transporter Master under Trading Partners.
3. In the Transporter Enquiry screen, click the Add New button that is located on the top right corner of the screen. Alternatively, use Alt+F as shortcut key to add a new transporter. This will bring up Transporter Create/Edit screen.
4. On the Transporter Create/Edit screen, select the Transporter Type as CLICKPOST from the drop-down list.
Fill the details as required in the below table:
Detail Transporter
S.No. | Section | Field (Free Text/Checkbox/ Dropdown) | Features | Details |
1. | Detail Transporter | Transporter Type | Select the dropdown to choose the transporter. It is a mandatory field. | Select CLICKPOST. Once the transporter is selected, “Configure API Details” tab will appear. |
1.a. | Transporter Code* | Unique Code is generated by the user for each Transport. Once the Transporter Code is saved, it cannot be edited. It is a mandatory field. | It helps differentiating two or more records in case these records have same Transporter Name. | |
1.b. | Transporter Name* | Defined by the user. It is a mandatory field. | The user can use this field to give any name for the transporter. | |
1.c. | Company Name | Defined by the user. | This field is used to provide an optional alternative name to the transporter. | |
1.d. | GL Code | General Ledger Code and it is an optional free text field. | It is used for reference to locate the transporter in the books of accounts. | |
1.e. | Validate Service Loc | Checkbox that allows validation of Delivery location/pin code of the transporter | It is used to check whether the delivery location is serviceable or not (i.e., reachable by the transporter.) | |
1.f. | Send Ship Mail ID | Checkbox that allows to send ship mail ID to your customers. | When this option is enabled, the transporter will send order tracking information to the end customer via email. | |
1.g. | Reverse Validate Service Loc | Checkbox will allow validation for the delivery location/pin code in case of returns | It is used to check whether the pickup location is serviceable or not. | |
1.h. | Delivery Mode | Dropdown to select delivery mode as Air or Surface | It is not a mandatory field. The delivery via water bodies will be part of the surface only. | |
1.i. | Upload AWB series | Checkbox that allows to upload AWB series if manifest generation is offline otherwise leave it blank. | Check only if manifest generation is off line. Keep this option unchecked in case of real time manifest generation. Manifest (offline/real-time) can be selected in the Configure API Details tab. | |
1.j. | Is Active | Check this option to mark the transporter active. It is a mandatory field. | The transporter cannot be used if it is not marked active. | |
1.k. | Tracking hour | Free text field used for any number of hours less than 24 hours to check the shipment with the transporter. | 6 hours is the ideal time and is also the default value. | |
1.l | Dimensional Factor | Optional free text field used to calculate the dimensional weight of the shipment. | The volume of the shipment is divided by Dimensional Factor to determine the shipment’s dimensional weight, which is then further used to calculate the shipment rates. It is an optional field. | |
1.m. | Trans Type* | Dropdown to be selected either as “Courier” or “Own Fleet”. It is a mandatory field. | In B2C cases, select “Courier” as the default Trans type. In B2B cases, this field is more relevant. | |
2. (a-d) | Contact Details | Mandatory fields a. Address 1 b. Address 2 c. Country d. State | a & b. Free text field to update the correct address
c. & d. Dropdown boxes to select the correct City & State information | Address1, Address2, Country, and State are mandatory, and must be filled before further configuration. |
2. (e-m) | Other fields like: Address 3, Address 4, Phone, Alternate Phone, Fax, Email, Alternate Email, City & Pin code | Optional fields to update the required information | These are optional fields to provide other contact information. |
User Defined Fields
The user may also add up to 5 custom defined fields for their use in the User Defined Field tab. All these fields are optional.
Configure API Details
Configure the following as needed:
Field | Feature | Details |
AWB Generation Type | It is a drop down list to select the type of AWB number generation. | Enter the following accordingly: 1. Off Line Manifest - The AWB numbers are already acquired beforehand from ClickPost, and saved in Vin e-Retail database. These AWB numbers are then used to track order status of the shipment. 2. Real Time Manifest - The AWB numbers are received from ClickPost when the manifest (booking) details are sent through API. Tracking of the order status of the shipment is done through the AWB number generated by Transporter. |
Exchange / Replacement Order Support | This check box is used to enable the product exchange / replacement order support. | It is given in detail in a separate section. |
Create Return on RTO (WMS) | This option is used to create a return order for RTO (Return to Origin) made for any order created via the Warehouse Management System. |
|
Create Return on RTO (SP) | This option is used to create a return order for RTO (Return to Origin) made for any order created via Seller Panel. |
|
External Invoice | This option is used to generate the invoice provided by the B2B shipping partner. | This option is only relevant for B2B transporters. If left unchecked, then the system will generate the eRetail invoice. |
External Shipping Label | This option is used to generate the shipping label provided by the B2B shipping partner. | This option is only relevant for B2B transporters. If left unchecked, then the system will generate the eRetail shipping label. |
Applicable to B2B | This option is used to mark the shipping partner for use in B2B transactions. | This option is mandatory if the transporter must be used for B2B transactions. |
Below screen will appear once the AWB generation type is selected with three tabs:
- Tracking API Details
- Manifest API Details
- Reverse Pickup API Details
Tracking API Details
Fill the details as per the information provided in the table.
S.No. | Field | Feature | Details |
3.a.i. | Tracking API Details | It is a check box that enables Tracking API details | Tracking API is used to get the various statuses of an order, e.g. In Transit, Delivered, RTO, etc. Once this checkbox is clicked, the subsequent tabs will be enabled for allowing input. |
3.a.ii. | Clickpost | It is a mandatory alphanumeric API key which is provided by the transporter (ClickPost). | It is to be obtained from ClickPost. |
3.a.iii. | Clickpost_Courier_UserName | It is the user name of the partner transporter integrated with ClickPost. | It is to be obtained from ClickPost. |
3.a.iv. | Clickpost_Courier_ApiKey | It is the API Key for using the partner transporter integrated with ClickPost. | It is to be obtained from ClickPost. |
3.a.v. | Clickpost_Courier_PartnerID | It is the partner ID of the partner transporter integrated with ClickPost. | It is to be obtained from ClickPost. |
3.a.vi. | Clickpost_Courier_AccountCode | It is the account code of the partner transporter integrated with ClickPost. | It is to be obtained from ClickPost. |
Manifest API Details
Fill the details as per the information provided in the table.
S.No. | Field | Feature | Details |
3.b.i. | Manifest API Details | It is a check box that enables Manifest API details | Manifest API is mainly used to inform the transporter of the pickup location and the delivery location. Once this checkbox is clicked, the subsequent tabs will be enabled for allowing input. |
3.b.ii. | Clickpost_Courier_UserName | It is the user name of the partner transporter integrated with ClickPost. | It is to be obtained from ClickPost. |
3.b.iii. | Clickpost_Courier_ApiKey | It is the API Key for using the partner transporter integrated with ClickPost. | It is to be obtained from ClickPost. The API Key used will be for ClickPost. |
3.b.iv. | Clickpost_Courier_PartnerID | It is the partner ID of the partner transporter integrated with ClickPost. | It is to be obtained from ClickPost. |
3.b.v. | Clickpost_Courier_AccountCode | It is the account code of the partner transporter integrated with ClickPost. | It is to be obtained from ClickPost. |
3.b.vi. | Unique Order Key [?] | This field is used to set the format for order number to be sent to the transporter. The default value is EODR. | Enter the following accordingly: 1. OBC – To send the outbound code. 2. EODR – To send the external order reference number. 3. OBCT – To send the outbound code with timestamp. 4. EODRT – To send the external order reference number with timestamp. |
3.b.vii. | ClickPost Label (Y/N) | This field is used to enable using shipping label generated by ClickPost. | Enter the following accordingly: 1. Y – To enable using ClickPost Label. This is the default value. 2. N – To use label generated by eRetail system. |
3.b.viii. | External_OrderNo_Separator | This field is used to define separator for external orders. | In case of multiple external orders, the orders are separated using a special character, e.g., abcd122-2 is separated using ‘-’. Some transporters may not accept certain special characters. |
Reverse Pickup API Details
Fill the details as per the information provided in the table.
S.No. | Field | Feature | Details |
3.c.i. | Reverse Pickup API Details | It is a check box that enables Reverse Pickup API details. | Reverse PickUp API is used to send any special instruction for picking up shipment from customers in case of returns. Once this checkbox is clicked, the subsequent tabs will be enabled for allowing input. |
3.c.ii. | Clickpost_Courier_UserName | It is the user name of the partner transporter integrated with ClickPost. | It is to be obtained from ClickPost. |
3.c.iii. | Clickpost_Courier_ApiKey | It is the API Key for using the partner transporter integrated with ClickPost. | It is to be obtained from ClickPost. |
3.c.iv. | Clickpost_Courier_PartnerID | It is the partner ID of the partner transporter integrated with ClickPost. | It is to be obtained from ClickPost. |
3.c.v. | Clickpost_Courier_AccountCode | It is the account code of the partner transporter integrated with ClickPost. | It is to be obtained from ClickPost. |
3.c.vi. | enableShadowFaxQC ( only for ShadowFax ( Y/N ) ) | This field is used to enable Quality Check of the shipment by ShadowFax during returns by customer after sales only. This field must be checked only in case of ShadowFax. | Enter the following accordingly: 1. Y – To enable QC. 2. N – To not enable QC. |