UpdateTrip API

UpdateTrip API

API to update a trip

Clients call this API to update a previously created trip based on tripId or uniqueId (feedUniqueId).

loading / unloading objects

These objects expect to carry the information of source and destination place and intend to resolve the required information of the place i.e., lat, lng and address of the place for the Trip. The required information is either passed directly or indirectly with a 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, lng, area and address

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

In case the known place is not onboarded 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 onboarded place and can not auto onboard the place. If the provided information does not resolve the lat, lng for a place, It will result in the error: 422 - Missing Required Input.

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

API Endpoint:

Request Parameters:

Name

Type

Location

Description

Example

Name

Type

Location

Description

Example

Authorization

string

headers

JWT token required to authenticate API call.

Authorization: Bearer eyJhbGciOiJIUzI1Ni

Request Body:

Example value:

{ "lrid": 9089444, "lrnumber": "LR123", "feedUniqueId": "F1212121-dd-98375", "loading": { "uniqueId": "1234567", "lat": 19.0759837, "lng": 72.87765590000004, "address": "Mumbai, Maharashtra, India", "area": "Mumbai, Maharashtra, India" }, "unloading": { "uniqueId": "1234568", "lat": 17.9307285, "lng": 73.64773420000006, "address": "Mahabaleshwar, Maharashtra 412806, India", "area": "Mahabaleshwar, Maharashtra, India" }, "waypoints": [ { "uniqueId": "123456", "address": "Pune Maharashtra", "number": "AP071H07", "area": "500001", "lat": 18.5204, "lng": 73.8567 } ], "vehicleNumber": "MH05AS1212", "portableTrackerUniqueId":"PRT123" "locationSource": "sim", "driverName": "Raju", "driverNumbers": [ "1234567890" ], "consignee": { "uniqueId": "CODE1", "name": "Consignee 1", "number": [ "1111111111", "1111111111" ] }, "share_trip": 1, "customValues": { "ewayBillNo": "EWB1234", "invoiceNumber": "INV123" }, "vehicle_details": { "tare_weight": 100, "net_weight": 100, "gross_weight": 100, "type": "8 wheels" }, "lr_reference_number": "INV-4453", "primary_attributes": { "gate_in": "2021-02-02 12:34", "gate_out": "2021-02-02 12:34", "gate_management": { "loading_start_datetime": "2024-09-24T00:00:00.000Z", "loading_end_datetime": "2024-09-24T00:00:00.000Z" } "shipment_numbers": [ "SHP1", "SHP2" ], "container_number": "CN1", "tare_weight": 100, "net_weight": 100, "gross_weight": 100, "movement_subtype": "M", "movement_channel": "In", "billing_type": "To Pay", "yard_entry_number": "Y12", "expected_transit_time": 200, "erp_transit_distance": 80, "vehicle_type_ref_code": "4Wheeler", "freight_value": 25.5, "freight_value_currency": "INR", "order_type": "ZSOR", "master_trip_grouping_parameter":"MST123", "unloading_gate_in": "2024-02-02 11:34", "unloading_gate_out": "2024-02-03 12:34" }, "invoice": { "total_invoice_value": 1000000, "currency": "INR", "invoice_details": [ { "from": { "name": "XYX Pvt Ltd", "gstin": "SADSDFG132435DV", "shipping_address": "HSR", "billing_address": "HSR", "contact_phone": [ "9123404017", "98121231234" ], "contact_email": [ "abc@gmail.com" ] }, "to": { "name": "ABC Pvt Ltd", "gstin": "ASDSFD1234FDS", "shipping_address": "Agra", "billing_address": "Agra", "contact_phone": [ "9123404017", "98121231234" ], "contact_email": [ "def@gmail.com" ] }, "so_number": "343424", "so_quantity": 12, "so_date": "2020-01-01 13:40:00", "so_release_date": "2020-01-01 13:40:00", "po_number": "45642", "do_number": "9675752", "do_quantity": 12, "do_date": "2020-01-01 13:40:00", "do_publish_date": "2020-01-01 13:40:00", "invoice_number": "INV2345", "invoice_date": "2020-01-01 13:40:00", "eway_bill_no": "1516859638", "eway_bill_expiry_date": "2020-12-11 12:00:00", "description": "Invoice For Cement Bags", "total_invoice_value": 2222, "price": { "net_price": 10000, "total_price": 12000, "total_tax": 2000 }, "tax": { "cgst_rate": 10, "cgst": 1000, "sgst": 10, "sgst_rate": 100, "igst": 10, "igst_rate": 100, "other_tax": 0, "other_tax_rate": 0 }, "custom_fields": { "doStoNo": "DO-232", "gstvalue": "477531.32" }, "item_details": [ { "sku_code": "DA-123", "material_code": "21324", "hsn_code": "8803", "quantity": 11, "quantity_unit": "BAG", "gross_weight": 22.34, "net_weight": 21.34, "weight_unit": "TON", "product_name": "Concrete Cement Bag", "description": "Concrete Cement Bag", "custom_fields": { "cement_type": "Concrete cement", "cement_grade": "A Grade" }, "price": { "net_price": 10000, "total_price": 12000, "total_tax": 2000 }, "tax": { "cgst_rate": 10, "cgst": 10, "sgst": 10, "sgst_rate": 100, "igst": 10, "igst_rate": 100, "other_tax": 0, "other_tax_rate": 0 } } ] } ] } }

Attributes

FieldName

Data type

Description

Example

Mandatory

lrid

String

FT Trip ID

"28854344"

Yes for Update Trip

initial_pickup_point

Object

Contains latitude and longitude for pickup point

{ "lat": 28.6139, "lng": 77.2090 }

No

lat

Float

Latitude of the pickup point

28.6139

No

lng

Float

Longitude of the pickup point

77.209

No

final_drop_point

Object

Contains latitude and longitude for drop point

{ "lat": 19.0760, "lng": 72.8777 }

No

lat

Float

Latitude of the drop point

19.076

No

lng

Float

Longitude of the drop point

72.8777

No

expected_vehicle_reporting_time

String

Date and time when the vehicle is expected to report

2024-09-30T10:00:00Z

No

total_pickups_count

Integer

Total number of pickups

5

No

is_round_trip

Boolean

Indicates if the trip is a round trip

TRUE

No

portableTrackerUniqueId

String

Unique ID for the portable tracker

PT-123456789

No

shipments

Array of Objects

List of shipments

 

No

lrnumber

String

LR number of the shipment

LR-123456

No

loading

Object

Details about loading location

 

Yes

lat

Float

Latitude of the loading location

28.7041

Yes

lng

Float

Longitude of the loading location

77.1025

Yes

address

String

Address of the loading location

123 Loading St, City, State

Yes

area

String

Area of the loading location

Area 51

Yes

uniqueId

String

Unique ID for the loading location

LOAD-001

Yes

unloading

Object

Details about unloading location

 

Yes

lat

Float

Latitude of the unloading location

19.4326

Yes

lng

Float

Longitude of the unloading location

-99.1332

Yes

address

String

Address of the unloading location

456 Unloading Ave, City, State

Yes

area

String

Area of the unloading location

Area 52

Yes

uniqueId

String

Unique ID for the unloading location

UNLOAD-001

Yes

waypoints

Array of Objects

List of waypoints

 

No

uniqueId

String

Unique ID for the waypoint

WAYPOINT-001

No

address

String

Address of the waypoint

789 Waypoint Rd, City, State

No

number

String

Vehicle number associated with the waypoint

ABC-1234

No

area

String

Area of the waypoint

Waypoint Area

No

lat

Float

Latitude of the waypoint

28.6139

No

lng

Float

Longitude of the waypoint

77.209

No

vehicleNumber

String

Vehicle number used in the shipment

V1234

Yes

locationSource

String

Source of the location data

GPS

Yes

driverName

String

Name of the driver

John Doe

Yes

driverNumbers

Array of Strings

List of driver contact numbers

[ "9876543210", "1234567890" ]

Yes

consignee

Object

Details of the consignee

{ ... } (nested object)

No

uniqueId

String

Unique ID for the consignee

CONSIGNEE-001

No

name

String

Name of the consignee

Jane Smith

No

number

Array of Strings

List of consignee contact numbers

[ "0987654321" ]

No

bill_to_party

Object

Billing party details

 

No

email

String

Email address of the billing party

billing@company.com

No

number

String

Contact number of the billing party

555-1234

No

code

String

Short code for the billing party

BILL-001

No

share_trip

Integer

Indicates if the trip is shared

1 (yes)

No

customValues

Object

Custom values related to the shipment

 

No

property1

String

Custom property 1

Custom Value 1

No

property2

String

Custom property 2

Custom Value 2

No

primary_attributes

Object

Primary attributes of the shipment

 

No

gate_in

String

Gate in time

2024-09-30T09:00:00Z

No

gate_out

String

Gate out time

2024-09-30T17:00:00Z

No

feed_unique_id

String

Unique feed ID

FEED-123456

Yes

shipment_numbers

Array of Strings

List of shipment numbers

[ "SH-001", "SH-002" ]

No

container_number

String

Container number

CONT-001

No

tare_weight

Float

Tare weight of the shipment

500.5

No

net_weight

Float

Net weight of the shipment

1000

No

gross_weight

Float

Gross weight of the shipment

1500

No

movement_subtype

String

Subtype of the movement

Export

No

movement_channel

String

Movement channel

Air

No

billing_type

String

Billing type of the shipment

Prepaid

No

yard_entry_number

String

Yard entry number

YARD-001

No

expected_transit_time

Integer

Expected transit time

24

No

erp_transit_distance

Integer

Transit distance in ERP

300

No

vehicle_type_ref_code

String

Reference code for vehicle type

VTYPE-001

No

freight_value

Float

Freight value of the shipment

2000

No

freight_value_currency

String

Currency of the freight value

INR

No

freight_rate

Float

Freight rate for the shipment

20

No

freight_rate_unit

String

Unit of freight rate

per kg

No

master_trip_grouping_parameter

String

Parameter for master trip grouping

Group-001

No

unloading_gate_in

String

Unloading gate in time

2024-09-30T10:30:00Z

No

unloading_gate_out

String

Unloading gate out time

2024-09-30T12:30:00Z

No

invoice

Object

Invoice details

 

Yes

currency

String

Currency of the invoice

INR

No

invoice_details

Array of Objects

List of invoice details

 

No

from

Object

Details of the sender

 

No

name

String

Sender's name

Sender Name

No

gstin

String

GSTIN of the sender

GSTIN-123456

No

shipping_address

String

Shipping address of the sender

123 Sender St, City, State

No

billing_address

String

Billing address of the sender

456 Billing Rd, City, State

No

contact_phone

Array of Strings

List of contact numbers of the sender

[ "555-1111", "555-2222" ]

No

contact_email

Array of Strings

List of email addresses of the sender

[ "sender@example.com" ]

No

to

Object

Details of the receiver

 

No

name

String

Receiver's name

Receiver Name

No

gstin

String

GSTIN of the receiver

GSTIN-654321

No

shipping_address

String

Shipping address of the receiver

789 Receiver St, City, State

No

billing_address

String

Billing address of the receiver

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

For engineering support: visit FT Support