Introduction

An Itinerary is a multi-leg trip where a vehicle goes from point A to B to C to D…

High Level Process Flow

1. During trip creation, client application will give the trip attributes as well as the array of drop points (with a proper sequence - A to B to C to D )

2. FT will first create trip A to B

3. Client application sends an alert to FT saying that the truck has exited drop point B

4. FT will close A to B and start B to C

5. Similarly, for the last trip/leg, C to D, client application will send an alert to close the trip

Add Trip Itinerary

Client application calls this API to add a trip itinerary.

Input Parameters:

1. itinerary_external_id

2. origin

3. stops

4. trip data

Internal flow of Add Trip Itinerary

1. The itinerary is stored in the integration DB.

2. The first leg of the multi-leg trip is created in the core FT using the core FT Add Trip API.

Start Next Trip Leg

Clients call this API to start the next trip(next leg) of the itinerary by the leg_id.

Input Parameters:

1. itinerary_external_id

2. leg_id

Internal flow of Start Next Trip Leg

• The previous trip or previous leg which was currently active is marked closed using Close Trip API.

• The next leg is identified via the leg_id and the second trip leg is marked active in the database.

• The next trip leg is created using the core FT Add Trip API.

End Trip Leg

Clients call this API to end a trip leg of the itinerary.

Input Parameters:

1. itinerary_external_id

2. leg_id

Internal flow of End Trip Leg Itinerary

• The trip leg identified by the leg_id which was active is closed using the Close Trip API

• The status of the stop identified by the leg_id which was used for the trip leg creation is marked closed.

User Story

Let’s say there is a trip with hops/legs/hubs A-->B-->C-->D-->E in the calling application

1. The moment this trip gets created, the Add Trip Itinerary is called

2. The moment trip/vehicle Gates Out at hub B, call Start Next Trip Leg. This will end first trip and create next.

3. Repeat step 3 at gate out at C & D

4. After the vehicle unloads at location E, call End Trip Leg.

Exception Cases

Exception Case: A stop is skipped

Vehicle goes from A-->C-->D-->E. Stop B is skipped.

1. The moment this trip gets created, the Add Trip Itinerary is called

2. The vehicle starts from A but does not go to B and it directly goes to C. The geo tracking will continue to happen.

3. At any point, say at gate out at C, call Start Next Trip Leg. This will close trip A-->B and start trip B-->C. Then call call Start Next Trip Leg again. This will close trip B-->C and start C-->D.

4. Rest of the process will be same as main flow

Exception Case: Vehicle moves differently than defined itinerary

Scenarios:

1. Vehicle goes from A-->C-->B-->D

2. New stops like A1 are introduced

Currently, the itinerary feature is not designed to support such a scenarios. It's best to call End Trip Leg and do a graceful exit.

Test Scripts

Systems:

1. FT - Freight Tiger Platform

2. Client - A system at FT’s customer landscape (ex SAP or another TMS)

Pre-conditions:

1. Connect Client test system to Freight Tiger Integration Test Server. Use FT JWT token for integration server for this.

Test Steps:

1. Create a multi-drop trip (A-B-C-D) in Client. 

2. Check if a trip is created in FT wth source as A and destination as B

3. Execute gate-in at B in Shipsy

4. Check in FT that trip A-B is closed and trip B-C is created

5. Execute gate-in at C in Shipsy

6. Check in FT that trip B-C is closed and trip C-D is created

7. Execute gate out at D in shipsy

8. Check that in FT, C-D is closed

Exception Case: A stop is skipped

Vehicle goes from A-->C-->D-->E. Stop B is skipped.

1. Create a multi-drop trip (A-B-C-D) in shipsy. 

2. Check if a trip is created in FT wth source as A and destination as B

3. Considering B is skipped, Execute gate-in at C in Shipsy

4. Check in FT that trip A-B is closed and trip B-C is created

5. Execute gate-in at C in Shipsy

6. Check in FT that trip B-C is closed and trip C-D is created

7. Execute gate out at D in shipsy

8. Check that in FT, C-D is closed