Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Click here Read API Docs for API interfaces and schemas

...

To see the complete list of all fields trip attributes Read API docs

Attribute

Description

lrid

FT Trip ID which is returned in Add Trip API response.

vehicleNumber

Specifies the vehicle that is currently carrying the shipment

driverName

Specifies the name of the driver driving the vehicle

driverNumbers

List of phone numbers of the driver.

locationSource

Specifies the type of Device to track the location. A vehicle could be tracked using any one of following:

  • sim card of driver’s phone

  • GPS device fitted in the vehicle

  • portable GPS device carried in the vehicle

  • Smart Phone location of the driver, if they are carrying one

portableTrackerId

Specifies the ID of the GPS device on the truck. Applicable only incase of locationSource= portableGPS.

plantCode

Specifies the unique RefCode for specific branch/plant.

** Master data onboarding required.

loading

Specifies the lat-long or the address & area details of the Loading point.

** Master data onboarding required.

unloading

Specifies the lat-long or the address & area details of the Unloading point.

** Master data onboarding required.

waypoints

Specifies the lat-long or the address & area details of the way point.

** Master data onboarding required.

route

Specifies the unique RefCode for specific Route.

** Master data onboarding required.

consignee

Specifies the unique RefCode for specific Consignee.

** Master data onboarding required.

transporter

Specifies the unique RefCode for specific Transporter.

** Master data onboarding required.

consignor

Specifies the unique RefCode for specific Consignor.

** Master data onboarding required.

share_trip

Specifies binary value for sharing trip with your customer.

1= Yes

0= No

lrnumber

Specifies the lorry receipt number of the Transporter.

feedUniqueId

Specifies the uniqueId identified from ERP - this could be Invoice number, DO number, anything that is unique and will never be repeated.

Trips will not be created for same feedUniqueId ever again.

If this field is not provided, FT randomly generates one.

smartPhoneEnabled

Specifies if the Driver Number is a smartphone.

ewbNo

Specifies the e-Way Bill number.

originSTD

Specifies the expected Standard Time of Departure from Origin

destinationSTA

Specifies the expected Standard Time of Arrival at Destination

customValues

Specifies additional information which is not a part of the standard API.

** Master data onboarding required.

vehicle_details

Specifies the details of the vehicle

shipment_number

Specifies the Shipment number

lr_reference_number

Specifies the Lorry Receipt reference number

Primary Attributes section

shipment_numbers

Specifies multiple Shipment numbers in array

container_number

Specifies the container number of the shipment

feed_unique_id

Specifies the Unique Reference ID for the trip

movement_subtype

movement_channel

Specifies the Movement Channel of the shipment

billing_type

yard_entry_number

expected_transit_time

erp_transit_distance

gross_weight

Specifies the Gross Weight of the shipment

tare_weight

Specifies the Tare Weight of the shipment

net_weight

Specifies the Net Weight of the shipment

vehicle_type_ref_code

gate_in

Specifies the timestamp when vehicle entered the gate of the Origin of the trip.

gate_out

Specifies the timestamp when vehicle left the gate of the Origin of the trip.

sales_rep_id

Specifies the Sales Representative Reference Code

total_invoice_value

Specifies the total Invoice amount of the shipment on the trip.

currency

Specifies the currency of the Invoice

invoice_details

Contains the Invoice details section

From section

Specifies the Consignor (Ship From) details

name

Specifies the Consignor (Ship From) Name

gstin

Specifies the Consignor (Ship From) GSTIN

shipping_address

Specifies the Consignor (Ship From) Address

billing_address

Specifies the Consignor (Bill From) Name

contact_phone

Specifies the Consignor (Ship From) Phone Number

contact_email

Specifies the Consignor (Ship From) Email

To section

Specifies the Consignor (Ship To) details

name

Specifies the Consignor (Ship To) Name

gstin

Specifies the Consignor (Ship To) GSTIN

shipping_address

Specifies the Consignor (Ship To) Address

billing_address

Specifies the Consignor (Bill To) details

contact_phone

Specifies the Consignor (Ship To) Phone Number

contact_email

Specifies the Consignor (Ship To) Email

so_number

Specifies the Sales Order Number

so_quantity

Specifies the Sales Order Quantity

so_date

Specifies the Sales Order generation timestamp

so_release_date

Specifies the Sales Order Release Date

po_number

Specifies the Purchase Order Number

do_number

Specifies the Delivery/Despatch Order Number

do_quantity

Specifies the quantity of Delivery Order generated

do_date

Specifies the Delivery/Despatch Order generation timestamp

do_publish_date

Specifies the Delivery/Despatch Order Published Date

invoice_number

Specifies the Invoice Number

invoice_date

Specifies the Invoice Date

eway_bill_no

Specifies the e-Way Bill number

eway_bill_expiry_date

Specifies the e-Way Bill expiry date

This helps receive respective alerts before expiry.

total_invoice_value

Specifies the Total Invoice Value

description

Specifies the Invoice Details

net_price

Specifies the Invoice Net Price

total_price

Specifies the Total Price of the shipment

total_tax

Specifies the Total Tax on the shipment

cgst_rate

sgst_rate

igst_rate

other_tax_rate

cgst

sgst

igst

other_tax

sku_code

Specifies the SKU Code of the shipment

material_code

Specifies the Material Code of the shipment

hsn_code

Specifies the HSN Code of the shipment

quantity

Specifies the quantity of the shipment

quantity_unit

Specifies the units of the quantity (Bags/Dozens/Kg etc)

gross_weight

Specifies the Gross Weight of the shipment

net_weight

Specifies the Net Weight of the shipment

weight_unit

Specifies the Unit of Weight of the shipment

product_name

Specifies the Product being shipped.

description

Specifies the details of the Product being shipped.

...