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 "Shipway" 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.

Field

Feature

Details

AWB Generation Type

It is a drop down list to select the type of AWB number generation.
 NOTE: When selecting Off Line Manifest, the Upload AWB Series must be checked as well.

Enter the following accordingly:

1. Off Line Manifest - The AWB numbers are already acquired beforehand from Shipway, 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 Shipway 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.

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.

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.

Mongo DB Tracking (Y/N)

This field is used to enable tracking via webhook (push based tracking)

Enter the value “Y” to enable this feature. The default value of this field is “N”.

3.a.iii.

UserName

This field is used to enter the username / login ID to authenticate the API.

It is provided by Shipway.

3.a.iv.

Password

This field is used to enter the password / licence key to authenticate the API.

It is provided by Shipway.

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.

UserName

This field is used to enter the username / login ID to authenticate the API.

It is provided by Shipway.

3.b.iii.

Password

This field is used to enter the password / licence key to authenticate the API.

It is provided by Shipway.

3.b.iv.

Carrier Id

This field is used to enter the Carrier ID of the courier partner to be used via Shipway

It is provided by Shipway.

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.

UserName

This field is used to enter the username / login ID to authenticate the API.

It is provided by Shipway.

3.c.iii.

Password

This field is used to enter the password / licence key to authenticate the API.

It is provided by Shipway.

3.c.iv.

Carrier Id

This field is used to enter the Carrier ID of the courier partner to be used via Shipway

It is provided by Shipway.