Whizzard
INTEGRATION DOCUMENT
|
|
About Whizzard
Whizzard is a Hyderabad based tech-enabled automated logistics network that offers flexible capacity and pay per use services. The logistics company provides retailers and businesses a platform to offer services with same-day, next-day, and hyperlocal deliveries.
Services Integrated
Below are the services of Whizzard which are integrated with e-Retail:
- Shipment creation
- Shipment tracking
- Refrigerated shipping
Important Note: Currently the mapping of the tracking events is not complete. New tracking events are being added by Whizzard team, which will be soon mapped with the respective tracking status in eRetail. As a result, the current tracking API integration for certain status options are as follows:
- The mapping for "RTO Delivered" is not present, and the same is needed to be handled manually. This will be mitigated once a distinct tracking event is shared by Whizzard team to be mapped with the status.
- The tracking event "Partially Delivered" is currently not handled in eRetail.
Pre-requisite
Before configuring the transporter on Vin e-Retail, the following needs to be obtained from Whizzard:
- API Key
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.
- Hover over the Master Module and click on Transporter Master under Trading Partners.
- 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.
- On the Transporter Create/Edit screen, select the Transporter Type as "Whizzard" 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 "Whizzard." 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. Real Time Manifest - The AWB numbers are received from Whizzard 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. |
Country ISO Code | This text box is used to enter the country ISO code to be sent with manifest request. | These codes are the standard codes for every country defined by the International Organization for Standardization. In case of international transactions, a 2 or 3 digit code may be used for the country. |
Send City Code | This check box is used to send city code with manifest request. | These are predefined set of city codes which are provided by the transporter. |
Extended RefNo | This check box is used to receive the reference number for every shipment with a time stamp. | This feature can be used to make every reference number unique. |
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. Not relevant for Whizzard. |
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. Not relevant for Whizzard. |
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. Not relevant for Whizzard. |
Below screen will appear once the AWB generation type is selected with two tabs:
- Tracking API Details
- Manifest 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. | Api-Key | This field is used to enter the API Key that is used to authenticate the Tracking API request. | This key is provided by Whizzard. |
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. | Api-Key | This field is used to enter the API Key that is used to authenticate the Forward Manifest API request. | This key is provided by Whizzard. |
3.b.iii. | Unique 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.iv. | Package Type | This field is used to define whether the package type of the shipment is “cold” or “non-cold”. This configured value will be passed for all the shipments processed using the transporter. | The possible values are “Cold” and “Non-cold”. By default, the value for this field is “Non-cold”. |