Add Trip Itinerary - API Documentation - Itinerary - Multi Leg Trips

Owned by Naved Ahmad (Unlicensed)
Last updated: Mar 01, 2022
23 min read

This is the Freight Tiger API specification, for creating Multi-Leg Trip. Read about how multi-leg trips work in Freight Tiger before using this API

Servers

https://integration-api.freighttiger.com - Integration/Sandbox Server

https://api.freighttiger.com - Production server

Postman Collection

Production Environment Postman Collection

Integration/Testing Environment Postman Collection

Import this collection to Postman, it consists of all trip itinerary APIs

Replace <token> in Authorization with the company JWT token provided to your organization.

Add Trip Itinerary

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

Body

Example Value

{ "itinerary_external_id": 131, "origin": { "lat": 19.0759837, "lng": 72.87765590000004, "address": "Mumbai, Maharashtra, India", "area": "Mumbai, Maharashtra, India", "uniqueId": "K4J354" }, "stops": [ { "leg_id": 1, "location": { "lat": 17.9307285, "lng": 73.64773420000006, "address": "Mahabaleshwar, Maharashtra 412806, India", "area": "Mahabaleshwar, Maharashtra, India", "uniqueId": "K1J354" }, "plantCode": "B101", "feedUniqueId": "F1212121-dd-24244", "consignee": { "uniqueId": "CODE1", "name": "Consignee 1", "number": [ "9876123456", "9175127853" ] }, "waypoints": [ { "uniqueId": "123456", "address": "Pune Maharashtra", "number": "AP071H07", "area": "500001", "lat": 18.5204, "lng": 73.8567 } ], "ewbNo": "abcd1234", "destinationSTA": 1637757262, "customValues": { "ewayBillNo": "EWB12345", "invoiceNumber": "INV1234" }, "shipment_numbers": [ "SHP1", "SHP2" ], "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 } } ] } ] } }, { "leg_id": 2, "location": { "lat": 19.9307285, "lng": 63.64773420000006, "address": "Kolkata, West Bengal, India", "area": "Kolkata, West Bengal, India", "uniqueId": "K2J354" }, "plantCode": "B201", "feedUniqueId": "F1212121-dd-24245", "consignee": { "uniqueId": "CODE2", "name": "Consignee 2", "number": [ "9876123456", "9175127853" ] }, "waypoints": [ { "uniqueId": "123456", "address": "Pune Maharashtra", "number": "AP071H07", "area": "500001", "lat": 18.5204, "lng": 73.8567 } ], "ewbNo": "abcd1235", "destinationSTA": 1637767262, "customValues": { "ewayBillNo": "EWB12346", "invoiceNumber": "INV1235" }, "shipment_numbers": [ "SHP3", "SHP4" ], "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 } } ] } ] } }, { "leg_id": 3, "location": { "lat": 19.9307285, "lng": 63.64773420000006, "address": "Hauz Khas, Delhi, India", "area": "Hauz Khas, Delhi, India", "uniqueId": "K3J354" }, "plantCode": "B202", "feedUniqueId": "F1212121-dd-24246", "consignee": { "uniqueId": "CODE3", "name": "Consignee 3", "number": [ "9876123456", "9175127853" ] }, "waypoints": [ { "uniqueId": "123456", "address": "Pune Maharashtra", "number": "AP071H07", "area": "500001", "lat": 18.5204, "lng": 73.8567 } ], "ewbNo": "abcd1236", "destinationSTA": 1637777262, "customValues": { "ewayBillNo": "EWB12347", "invoiceNumber": "INV1236" }, "shipment_numbers": [ "SHP5", "SHP6" ], "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 } } ] } ] } } ], "trip": { "lrnumber": "LR123", "vehicleNumber": "MH05AS1212", "locationSource": "sim", "driverName": "Raju", "driverNumbers": [ "1234567890" ], "share_trip": 1, "vehicle_details": { "tare_weight": 100, "net_weight": 100, "gross_weight": 100, "type": "8 wheels" }, "shipment_number": "1234", "lr_reference_number": "INV-4453", "primary_attributes": { "gate_in": "2021-02-02 12:34", "gate_out": "2021-02-02 12:34", "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" } } }

Schema

https://freighttiger.atlassian.net/wiki/spaces/FCS/pages/585760780

Responses

{ "status": true, "trip": { "id": 123, "lr_number": "DEL-BKR-568", "shareUrl": "string", "feed_unique_id": "string" }, "itinerary_external_id": 12, "message": "Trip Created Successfully" }
{ "status": false, "message": "Authentication failed" }

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

For engineering support: visit FT Support