Add Trip API

Owned by Mohit Shukla (Unlicensed)
Last updated: Jul 22, 2021
2 min read

About Add Trip API

Clients call this API to add an active trip for a given source - destination, Vehicle and it's tracking information.

Read the detailed API document here

loading / unloading objects

These objects expects carry the information of source and destination place and intends to resolve the required information of the place i.e., lat, long and address of the place for the Trip. The required information is either passed directly or indirectly with unique place reference of the company. Hence, Any combination from the following is allowed in these objects.

  • lat, lng, area, address: Direct Information of a place with lat, long, area and address

  • uniqueId, area, address: Case when the known places of the company are already on-boarded on the Freight Tiger system with required data for a place that helps in resolving the lat, long and address using a uniqueId representing the unique code reference for that place.

Note: In case the known place is not on-boarded for the company, passing this combination will also auto onboard the place for that company by resolving the fields address and area.

Passing only uniqueId without area and address will only refer to the on-boarded place and can not auto onboard the place.

If the provided information does not resolve the lat, long for a place, It will result in the error: 422 - Missing Required Input.

Digtial LR: If Digital LR (eLR) feature is enabled for the customer, the invoice related parameters also need to be passed

Mandatory fields for creating trip

You can create the trip by providing following minimum fields:

  • Vehicle Number

  • Location Source

  • Loading Point

    • Note: either object {uniqueId, area, address} where uniqueId field is mandatory OR object {lat, lng, area, address} where lat, lng fields are mandatory fields.

    • Latitude

    • Longitude

    • address

    • area string

    • unique Id

  • Unloading

    • Same as Loading Point

 

Frequently Asked Questions

We created a test trip but it is not tracking (Integration/Sandbox environment)?

We do not support consent/tracking on integration environment. You can download and install the FT Driver App (Integration environment) from Google Play. If the location is turned on - the Driver's location will get updated on the trip.

During an "Add Trip" API call, is it mandatory to send custom fields even when we do NOT have any to send?

Best practice would be to leave the 'custom fields' block with no fields mentioned at all and mention all of the fields available with their respective values.

Will FT PULL data from ERP for Trip Creation?

No, FT does not pull data for Trip Creation. We have REST APIs which accept this data as input for Trip Creation.

What are RefCodes for PlantCode, Transporter, Consignee, etc?

Any unique identifier from your ERP for respective Branch, Transporter, Consignee identification. These need to be pre-onboarded before you start tagging them on the trips.

Can we have a separate trigger for Add Trip API for different type of movements?

Yes, you may select the trigger points as suitable for you. But it is always good to have the trips created at an earlier stage for better chances of consent completion and visibility on loading time. Also, you can keep updating the trip to add more information on it as required.

Post your questions in the comment box to get answers from the experts who watch this page.

For engineering support: visit FT Support