...
| Tip |
|---|
https://integration.freighttiger.com/saas/trips - Integration/Sandbox Environment https://www.freighttiger.com/saas/trips - Production Environment |
Headers Parameters:
Field key | Data Type | Description | Example |
|---|---|---|---|
Authorization | string | JWT token required to authenticate API call. | Authorization: Bearer eyJhbGciOiJIUzI1Ni |
Query parameters:
size
Field key | Data type | Description | Example value |
|---|---|---|---|
trip_id | integer | Mulple Trip_ids can be passed separated by comma | 638476,1247725 |
vehicle_no | string | Multiple vehicle numbers can be passed separated by comma | AP26TB1234, AB12RK4567 |
feedunique_id | string | Multiple feedUnique ids can be passed separated by comma | 638476-1574148880-572142,1247725-1575635735-889938 |
status | string | Trip Status ( OPEN / CLOSED) | OPEN |
page | number | Page for Pagination (Default - 1) | 1 |
size | number | Number of trips to return (Default - 100) Max number of trips - 100 | 10 |
Responses:
| Tip |
|---|
Status code 200 Get Details For Mutliple Trips |
| Code Block | ||
|---|---|---|
| ||
{
"success": true,
"data": {
"trips": [
{
"trip_id": 638476,
"feed_unique_id": "638476-1574148880-572142",
"created_at": "2019-11-19 07:34:40",
"lr_number": "",
"vehicle": {
"license_plate": "mkuu122"
},
"last_known_location": null,
"origins": [
{
"point": {
"latitude": 19.1350852,
"longitude": 72.8146101
},
"address": "Versova, Andheri West, Mumbai, Maharashtra, India",
"etd": null,
"atd": null
}
],
"destinations": [
{
"point": {
"latitude": 19.2183307,
"longitude": 72.9780897
},
"address": "Thane, Maharashtra, India",
"distance_from_last_location": 28.9,
"ata": null,
"eta": "2019-11-19 09:49:12",
"eta_updated_at": "2019-11-19 08:39:12"
}
],
"drivers": [
{
"name": "dsd",
"contact": "2999990909"
}
],
"total_distance": 28.9,
"start_time": null,
"end_time": null,
"close_time": null,
"status": "Closed",
"status_code": 0,
"custom_params": {
"shipment_number": "bner34"
},
"parties": [
{
"name": "ABC Consignor",
"type": "consignor"
},
{
"name": "XYZ Transporter",
"type": "transporter"
},
{
"name": "The Consignee",
"type": "consignee"
}
],
"is_consent_done": false,
"primary_attributes": {
"gate_in": "2021-04-06T10:57:38.159Z",
"gate_out": "2021-04-06T12:57:40.560Z",
"net_weight": 100.9,
"tare_weight": 1000.9,
"billing_type": "to pay",
"gross_weight": 1000.87,
"sales_rep_id": "100.9",
"container_number": "CN678",
"movement_channel": "6",
"movement_subtype": "456",
"shipment_numbers": [
"SH789",
"SH999"
],
"yard_entry_number": "1211",
"erp_transit_distance": 100,
"expected_transit_time": 100,
"vehicle_type_ref_code": "REF679"
},
"invoices": [
{
"invoice_number": "3001001371",
"invoice_date": "2021-02-12 11:55:00",
"description": "some description here",
"from_name": "GOKUL TRADERS",
"from_gstin": "12345",
"from_shipping_address": null,
"from_billing_address": "Rajabazar, Patna Bihar-800014",
"from_contact_phone": [
"7531877654"
],
"from_contact_email": [
"abc@gmail.com"
],
"to_name": "GOKUL TRADERS",
"to_gstin": "12345",
"to_shipping_address": "Tilak Nagar, Lucknow UP-800014",
"to_billing_address": "Tilak Nagar, Lucknow UP-800014",
"to_contact_phone": [
"7531877654"
],
"to_contact_email": [
"abc@gmail.com"
],
"so_number": null,
"so_quantity": 90,
"so_date": "2021-08-11 14:00:00",
"so_release_date": "2021-08-11 14:00:00",
"po_number": "1234",
"do_number": "324331",
"do_quantity": 11,
"do_date": "2021-08-11 12:00:00",
"do_publish_date": "2021-08-11 14:00:00",
"currency": "INR",
"price": {
"net_price": 1100,
"total_price": 1200,
"total_tax": 1300
},
"tax": {
"cgst": 11,
"igst": 12
},
"custom_fields": {
"some_cutom_data": "sfnnsnds"
},
"total_invoice_value": 1234,
"eway_bill_no": "2212785376106",
"eway_bill_expiry_date": "2021-08-11 14:00:00",
"item_details": [
{
"product_name": "steel",
"description": "steel description",
"sku_code": "23456",
"material_code": "steel",
"hsn_code": "fghjk",
"quantity": 100,
"quantity_unit": "Kgs",
"gross_weight": 1200.89,
"net_weight": 1200.91,
"weight_unit": "Ton",
"price": {
"net_price": 2100,
"total_price": 3200,
"total_tax": 5300
},
"tax": {
"cgst": 110,
"igst": 120
},
"custom_fields": {
"some_cutom_data": "steelk"
}
}
]
}
]
},
{
"trip_id": 638477,
"feed_unique_id": "638477-1574148880-572142",
"created_at": "2019-11-19 07:34:40",
"lr_number": "",
"vehicle": {
"license_plate": "mkuu122"
},
"last_known_location": null,
"origins": [
{
"point": {
"latitude": 19.1350852,
"longitude": 72.8146101
},
"address": "Versova, Andheri West, Mumbai, Maharashtra, India",
"etd": null,
"atd": null
}
],
"destinations": [
{
"point": {
"latitude": 19.2183307,
"longitude": 72.9780897
},
"address": "Thane, Maharashtra, India",
"distance_from_last_location": 28.9,
"ata": null,
"eta": "2019-11-19 09:49:12",
"eta_updated_at": "2019-11-19 08:39:12"
}
],
"drivers": [
{
"name": "dsd",
"contact": "2999990909"
}
],
"total_distance": 28.9,
"start_time": null,
"end_time": null,
"close_time": null,
"status": "Closed",
"status_code": 0,
"parties": [
{
"name": "ABC Consignor",
"type": "consignor"
},
{
"name": "XYZ Transporter",
"type": "transporter"
},
{
"name": "The Consignee",
"type": "consignee"
}
],
"custom_params": {
"shipment_number": "bner34"
},
"is_consent_done": false,
"primary_attributes": {
"gate_in": "2021-04-06T10:57:38.159Z",
"gate_out": "2021-04-06T12:57:40.560Z",
"net_weight": 100.9,
"tare_weight": 1000.9,
"billing_type": "to pay",
"gross_weight": 1000.87,
"sales_rep_id": "100.9",
"container_number": "CN678",
"movement_channel": "6",
"movement_subtype": "456",
"shipment_numbers": [
"SH789",
"SH999"
],
"yard_entry_number": "1211",
"erp_transit_distance": 100,
"expected_transit_time": 100,
"vehicle_type_ref_code": "REF679"
},
"invoices": [
{
"invoice_number": "3001001371",
"invoice_date": "2021-02-12 11:55:00",
"description": "some description here",
"from_name": "GOKUL TRADERS",
"from_gstin": "12345",
"from_shipping_address": null,
"from_billing_address": "Rajabazar, Patna Bihar-800014",
"from_contact_phone": [
"7531877654"
],
"from_contact_email": [
"abc@gmail.com"
],
"to_name": "GOKUL TRADERS",
"to_gstin": "12345",
"to_shipping_address": "Tilak Nagar, Lucknow UP-800014",
"to_billing_address": "Tilak Nagar, Lucknow UP-800014",
"to_contact_phone": [
"7531877654"
],
"to_contact_email": [
"abc@gmail.com"
],
"so_number": null,
"so_quantity": 90,
"so_date": "2021-08-11 14:00:00",
"so_release_date": "2021-08-11 14:00:00",
"po_number": "1234",
"do_number": "324331",
"do_quantity": 11,
"do_date": "2021-08-11 12:00:00",
"do_publish_date": "2021-08-11 14:00:00",
"currency": "INR",
"price": {
"net_price": 1100,
"total_price": 1200,
"total_tax": 1300
},
"tax": {
"cgst": 11,
"igst": 12
},
"custom_fields": {
"some_cutom_data": "sfnnsnds"
},
"total_invoice_value": 1234,
"eway_bill_no": "2212785376106",
"eway_bill_expiry_date": "2021-08-11 14:00:00",
"item_details": [
{
"product_name": "steel",
"description": "steel description",
"sku_code": "23456",
"material_code": "steel",
"hsn_code": "fghjk",
"quantity": 100,
"quantity_unit": "Kgs",
"gross_weight": 1200.89,
"net_weight": 1200.91,
"weight_unit": "Ton",
"price": {
"net_price": 2100,
"total_price": 3200,
"total_tax": 5300
},
"tax": {
"cgst": 110,
"igst": 120
},
"custom_fields": {
"some_cutom_data": "steelk"
}
}
]
}
]
}
],
"total": 2
}
} |
...
| Code Block | ||
|---|---|---|
| ||
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "True indicates API returned data successfully"
},
"data": {
"type": "object",
"description": "API Response",
"properties": {
"trips": {
"type": "array",
"description": "List of Trips",
"items": {
"properties": {
"trip_id": {
"type": "number",
"description": "Trip ID"
},
"feed_unique_id": {
"type": "string",
"description": "Unique Id for the Trip"
},
"created_at": {
"type": "string",
"description": "Trip Creation Time (in UTC)"
},
"lr_number": {
"type": "string",
"description": "LR Number"
},
"vehicle": {
"type": "object",
"properties": {
"license_plate": {
"type": "string",
"description": "Vehicle No"
}
}
},
"last_known_location": {
"type": "object",
"description": "Last Known Location of Trip",
"properties": {
"point": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"format": "double",
"description": "Latitude"
},
"longitude": {
"type": "number",
"format": "double",
"description": "Longitude"
}
}
},
"address": {
"type": "string",
"description": "Address"
}
}
},
"origins": {
"type": "array",
"description": "Origins of Trip",
"items": {
"properties": {
"point": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"format": "double",
"description": "Latitude"
},
"longitude": {
"type": "number",
"format": "double",
"description": "Longitude"
}
}
},
"address": {
"type": "string",
"description": "Address"
},
"atd": {
"type": "string",
"description": "Actual Time of Departure (in UTC)"
}
}
}
},
"destinations": {
"type": "array",
"description": "Destinations of Trip",
"items": {
"properties": {
"point": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"format": "double",
"description": "Latitude"
},
"longitude": {
"type": "number",
"format": "double",
"description": "Longitude"
}
}
},
"address": {
"type": "string",
"description": "Address"
},
"ata": {
"type": "string",
"description": "Actual Time of Arrival (in UTC)"
},
"distance_from_last_location": {
"type": "number",
"format": "double",
"description": "Distance (in KM) of destination from Last Location"
},
"eta": {
"type": "string",
"description": "Expected Time of Arrival (in UTC)"
},
"eta_updated_at": {
"type": "string",
"description": "Last Time when ETA was Updated (in UTC)"
}
}
}
},
"drivers": {
"type": "array",
"description": "List of Drivers for the Trip",
"items": {
"properties": {
"name": {
"type": "string",
"description": "Driver Name"
},
"contact": {
"type": "string",
"description": "Driver Phone number"
}
}
}
},
"total_distance": {
"type": "number",
"format": "double",
"description": "Total Distance of Trip"
},
"start_time": {
"type": "string",
"description": "Actual Time of Departure of Trip (in UTC)"
},
"end_time": {
"type": "string",
"description": "Actual Time of Arrival of Trip (in UTC)"
},
"close_time": {
"type": "string",
"description": "Time when Trip was closed (in UTC)"
},
"status": {
"type": "string",
"description": "Trip Status - Open/Closed"
},
"status_code": {
"type": "number",
"description": "Status Code of trip (1/0) 1 for open, 0 for closed"
},
"parties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
},
"custom_params": {
"type": "object",
"description": "Object contaning Custom Params of Trip"
},
"is_consent_done": {
"type": "boolean",
"description": "In case vehicle consent status is 'Accepted' is_consent_done is true"
},
"primary_attributes": {
"type": "object",
"description": "Object containing Primary Attributes of Trip"
},
"invoices": {
"type": "array",
"description": "Array of object containing Invoice Details of Trip",
"items": {
"type": "object"
}
}
}
}
}
}
}
}
} |
...