Downloading transport by identifier (ID)

URL parameters and connection settings

Headers:

  • Con­tent type: app/json
  • Accept: application/json
  • Autho­riza­tion: bear­er {access_token}
  • API Key: {unique_app_api_key}

Authorization

The autho­riza­tion process is described Here. Each API request must also con­sist of a unique Api-key obtained dur­ing appli­ca­tion reg­is­tra­tion togeth­er with client_id and client_secret.

Endpoint operation description

End­point is used to retrieve detailed infor­ma­tion about the trans­port by the trans­port task ID.

In the list of trans­port tasks (see above) you can find the ID of the trans­port task you are inter­est­ed in:

"id": "e6b7494b-4922-4fdb-af28-97618b8fb857"

The iden­ti­fi­er can be used to dis­play one trans­port task

After ask­ing the fol­low­ing end­point

/ext/transports-api/v1/transports/{transport_task_id}

we will receive one trans­port task in response accord­ing to the giv­en iden­ti­fi­er

Sample query using identifier

GET https://api.platform.trans.eu/ext/transports-api/v1/transports/ee6b7494b-4922-4fdb-af28-97618b8fb857 

Sample Answer

The response to the list query con­tains full infor­ma­tion about the trans­port task.

[
    {
        "_metadata": {
            "mode": "edit",
            "restrictions": {
                "companies": {
                    "carrier": null
                },
                "devices": {
                    "executor": {
                        "details": {
                            "document": null,
                            "identity_document_number": null,
                            "name": null,
                            "phone": null
                        },
                        "position": {
                            "address": null
                        }
                    },
                    "semitrailer": {
                        "position": {
                            "address": null
                        }
                    },
                    "truck": {
                        "position": {
                            "address": null
                        }
                    }
                },
                "and": {
                    "reasons": [
                        "no_visibility_monitoring"
                    ]
                },
                "loads": {
                    "amount": null,
                    "count": null,
                    "description": null,
                    "height": null,
                    "length": null,
                    "name": null,
                    "type": null,
                    "volume": null,
                    "weight": null,
                    "width": null
                },
                "monitoring": {
                    "reasons": [
                        "no_visibility_monitoring"
                    ]
                },
                "monitoring_sources": null,
                "operations": {
                    "claims": null,
                    "completion_status": null,
                    "and": {
                        "reasons": [
                            "no_visibility_monitoring"
                        ]
                    },
                    "execution": null,
                    "time_to_next_operation": {
                        "reasons": [
                            "no_visibility_monitoring"
                        ]
                    }
                },
                "reports": null,
                "status": {
                    "context": {
                        "reasons": [
                            "no_visibility_monitoring"
                        ]
                    },
                    "details": {
                        "context": {
                            "reasons": [
                                "no_visibility_monitoring"
                            ]
                        },
                        "device_position": {
                            "reasons": [
                                "no_visibility_monitoring"
                            ]
                        },
                        "distance_to_destination": {
                            "reasons": [
                                "no_visibility_monitoring"
                            ]
                        },
                        "monitoring_start_date": {
                            "reasons": [
                                "no_visibility_monitoring"
                            ]
                        },
                        "pause_start_date": {
                            "reasons": [
                                "no_visibility_monitoring"
                            ]
                        },
                        "status_change_date": null,
                        "total_route_distance": null
                    },
                    "monitoring": null,
                    "transport": null
                },
                "synthetic_signal": {
                    "reasons": [
                        "no_visibility_monitoring"
                    ]
                }
            }
        },
        "alerts": [],
        "archived_at": null,
        "available_actions": [
            {
                "available": true,
                "name": "unloading_complete",
                "reasons": [],
                "subactions": []
            },
            {
                "available": true,
                "name": "loading_complete",
                "reasons": [],
                "subactions": []
            }
        ],
        "claims": [
            {
                "context": "loading",
                "text": null
            },
            {
                "context": "loading",
                "text": null
            },
            {
                "context": "loading",
                "text": null
            },
            {
                "context": "unloading",
                "text": null
            },
            {
                "context": "unloading",
                "text": null
            }
        ],
        "companies": {
            "carrier": {
                "contact_person": {
                    "account_id": 1263715,
                    "first_name": "Matthew",
                    "language": "PL",
                    "last_name": "To",
                    "trans_id": "956529-1"
                },
                "id": 956529,
                "name": "MTCarrier",
                "product": "tfc"
            },
            "owner": {
                "contact_person": {
                    "account_id": 1841392,
                    "first_name": "Pan",
                    "language": "PL",
                    "last_name": "Bot",
                    "trans_id": "666666-2"
                },
                "id": 666666,
                "name": "Trans.eu - API Integrations",
                "product": "tff"
            },
            "shipper": {
                "contact_person": {
                    "account_id": 1841392,
                    "first_name": "Pan",
                    "language": "PL",
                    "last_name": "Bot",
                    "trans_id": "666666-2"
                },
                "id": 666666,
                "name": "Trans.eu - API Integrations",
                "product": "tff"
            }
        },
        "date_created": "2025-05-13T08:39:25.000Z",
        "devices": {
            "executor": {
                "details": {
                    "account_id": 1274987,
                    "company_id": 956529,
                    "document": null,
                    "identity_document_number": null,
                    "is_shared": false,
                    "name": "Paul Testowy",
                    "phone": null
                },
                "is_leading": false,
                "is_shared": false,
                "position": null
            },
            "semitrailer": null,
            "truck": {
                "details": {
                    "capacity": null,
                    "combustion_norm": null,
                    "dispatcher_id": null,
                    "fleet_id": null,
                    "id": "de1d22f5-0e8f-437d-b6ce-ba65c721f11d",
                    "kind": null,
                    "loading_meters": null,
                    "plate_number": "DTR11111",
                    "revision": null,
                    "source": {
                        "context": "manual",
                        "data": {
                            "company": {
                                "contact_person": {
                                    "account_id": 1263715,
                                    "first_name": "Matthew",
                                    "language": null,
                                    "last_name": "To",
                                    "trans_id": null
                                },
                                "id": 956529,
                                "name": "MTCarrier",
                                "product": null
                            },
                            "role": "carrier"
                        }
                    },
                    "vehicle_id": null
                },
                "is_leading": true,
                "is_shared": true,
                "position": null
            }
        },
        "and": null,
        "id": "e6b7494b-4922-4fdb-af28-97618b8fb857",
        "info": null,
        "monitorable": null,
        "monitoring_sources": [
            "manual"
        ],
        "operations": [
            {
                "claims": [
                    {
                        "context": "loading",
                        "text": null
                    },
                    {
                        "context": "loading",
                        "text": null
                    },
                    {
                        "context": "loading",
                        "text": null
                    }
                ],
                "completed_at": "2025-05-13T09:00:33.000Z",
                "completion_status": {
                    "data": {
                        "delay_time": null
                    },
                    "type": "on_time"
                },
                "completion_type": "CONFIRMED_MANUALLY",
                "contact": null,
                "estimated_execution_time": 1800,
                "and": null,
                "execution": {
                    "arrival": {
                        "date": "2025-05-13T08:59:35.000Z",
                        "load_weight": null,
                        "source": {
                            "context": "manual",
                            "data": {
                                "company": {
                                    "contact_person": {
                                        "account_id": 1842922,
                                        "first_name": "Satamil",
                                        "language": "PL",
                                        "last_name": "St",
                                        "trans_id": "666666-3"
                                    },
                                    "id": 666666,
                                    "name": "Trans.eu - API Integrations",
                                    "product": "tff"
                                },
                                "role": "shipper"
                            }
                        },
                        "vehicle_weight": 2400
                    },
                    "complete": {
                        "date": "2025-05-13T09:00:33.000Z",
                        "load_weight": 200,
                        "source": {
                            "context": "manual",
                            "data": {
                                "company": {
                                    "contact_person": {
                                        "account_id": 1842922,
                                        "first_name": "Satamil",
                                        "language": "PL",
                                        "last_name": "St",
                                        "trans_id": "666666-3"
                                    },
                                    "id": 666666,
                                    "name": "Trans.eu - API Integrations",
                                    "product": "tff"
                                },
                                "role": "shipper"
                            }
                        },
                        "vehicle_weight": 2600
                    }
                },
                "id": "43cb5e7c-7c7a-4713-a5bf-ea60d0dde709",
                "index": 1,
                "loads": [],
                "place": {
                    "address": {
                        "country": "OF",
                        "description": null,
                        "locality": "Babylon",
                        "name": "Purgatory",
                        "number": "666",
                        "postcode": "66-666",
                        "street": "Sinful"
                    },
                    "coordinates": {
                        "latitude": 34.5260109,
                        "longitude": 69.1776838
                    },
                    "suggested_location_id": null,
                    "timezone": "Asia/Kabul"
                },
                "requirements": {
                    "estimated_execution_time": 1800,
                    "time_frame": {
                        "date_from": "2025-05-13T09:00:00.000Z",
                        "date_to": "2025-05-13T09:00:00.000Z"
                    }
                },
                "time_frame": {
                    "date_from": "2025-05-13T09:00:00.000Z",
                    "date_to": "2025-05-13T09:00:00.000Z",
                    "is_precise": true
                },
                "time_frame_tz": {
                    "date_from": 2025-05-13T13:30:00.000+04:30,
                    "date_to": 2025-05-13T13:30:00.000+04:30,
                    "is_precise": true
                },
                "time_to_next_operation": null,
                "type": "loading",
                "warehouse": null
            },
            {
                "claims": [
                    {
                        "context": "unloading",
                        "text": null
                    },
                    {
                        "context": "unloading",
                        "text": null
                    }
                ],
                "completed_at": "2025-05-13T09:02:59.000Z",
                "completion_status": {
                    "data": {
                        "delay_time": null
                    },
                    "type": "on_time"
                },
                "completion_type": "CONFIRMED_MANUALLY",
                "contact": null,
                "estimated_execution_time": 10800,
                "and": null,
                "execution": {
                    "arrival": {
                        "date": "2025-05-13T09:02:35.000Z",
                        "load_weight": null,
                        "source": {
                            "context": "manual",
                            "data": {
                                "company": {
                                    "contact_person": {
                                        "account_id": 1841392,
                                        "first_name": "Pan",
                                        "language": "PL",
                                        "last_name": "Bot",
                                        "trans_id": "666666-2"
                                    },
                                    "id": 666666,
                                    "name": "Trans.eu - API Integrations",
                                    "product": "tff"
                                },
                                "role": "shipper"
                            }
                        },
                        "vehicle_weight": 2600
                    },
                    "complete": {
                        "date": "2025-05-13T09:02:59.000Z",
                        "load_weight": null,
                        "source": {
                            "context": "manual",
                            "data": {
                                "company": {
                                    "contact_person": {
                                        "account_id": 1841392,
                                        "first_name": "Pan",
                                        "language": "PL",
                                        "last_name": "Bot",
                                        "trans_id": "666666-2"
                                    },
                                    "id": 666666,
                                    "name": "Trans.eu - API Integrations",
                                    "product": "tff"
                                },
                                "role": "shipper"
                            }
                        },
                        "vehicle_weight": 2600
                    }
                },
                "id": "01ce47c3-5971-4432-8849-5f0f20c0b1f0",
                "index": 2,
                "loads": [],
                "place": {
                    "address": {
                        "country": "GE",
                        "description": null,
                        "locality": "Batumi",
                        "name": "Sky",
                        "number": null,
                        "postcode": "66-666",
                        "street": "Akaki Shanidze 1st Dead End"
                    },
                    "coordinates": {
                        "latitude": 41.5864466,
                        "longitude": 41.6460693
                    },
                    "suggested_location_id": null,
                    "timezone": "Asia/Tbilisi"
                },
                "requirements": {
                    "estimated_execution_time": null,
                    "time_frame": {
                        "date_from": "2025-05-14T06:00:00.000Z",
                        "date_to": "2025-05-14T06:00:00.000Z"
                    }
                },
                "time_frame": {
                    "date_from": "2025-05-14T06:00:00.000Z",
                    "date_to": "2025-05-14T06:00:00.000Z",
                    "is_precise": true
                },
                "time_frame_tz": {
                    "date_from": "2025-05-14T10:00:00.000+04:00",
                    "date_to": "2025-05-14T10:00:00.000+04:00",
                    "is_precise": true
                },
                "time_to_next_operation": null,
                "type": "unloading",
                "warehouse": null
            }
        ],
        "reference_number": null,
        "references": {
            "ecmr": null,
            "freight": null,
            "order": {
                "count": 1,
                "id": "3e3f21cf-1b25-483a-aca4-bfe81ae3b849",
                "number": "2025/05/13/1"
            }
        },
        "reports": [],
        "requirements": {
            "monitoring": {
                "value": "1_required"
            },
            "time_frame": null,
            "tracking": true,
            "transit_time": null,
            "vehicle_size": "lorry"
        },
        "source": {
            "data": {
                "freight_legacy_id": null,
                "freight_publication_id": null,
                "freight_reference_number": null,
                "order_id": "3e3f21cf-1b25-483a-aca4-bfe81ae3b849",
                "order_number": "2025/05/13/1",
                "order_shipment_external_id": null
            },
            "name": "freight-orders"
        },
        "state": "completed",
        "status": {
            "context": null,
            "details": {
                "context": null,
                "device_position": null,
                "distance_to_destination": null,
                "monitoring_start_date": null,
                "pause_start_date": null,
                "status_change_date": "2025-05-13T09:04:03.000Z",
                "total_route_distance": 3365243
            },
            "monitoring": "finish",
            "transport": {
                "date": "2025-05-13T09:04:03.000Z",
                "source": {
                    "context": "manual",
                    "data": {
                        "company": {
                            "contact_person": {
                                "account_id": 1263715,
                                "first_name": "Matthew",
                                "language": "PL",
                                "last_name": "To",
                                "trans_id": "956529-1"
                            },
                            "id": 956529,
                            "name": "MTCarrier",
                            "product": "tfc"
                        },
                        "role": "carrier"
                    }
                },
                "value": "9_finished"
            }
        },
        "suggested_route_id": "f2b3ada9-8762-4fa4-a033-594c8205fd98",
        "time_frame": {
            "date_from": "2025-05-13T09:00:00.000Z",
            "date_to": "2025-05-14T06:00:00.000Z"
        },
        "transport_number": "TT2025/05/13/1-1/1"
    }
]