Fetch Visibility Data into your Inhouse SystemStatus V2 endpoint
- ser_hcskb_api
The following endpoints allow to get visibility data for currently tracked or recently completed transports.
Tracking State Definition of a Working or Finished Transport
A transport is defined as working, when Transporeon system started to calculate an ETA for the first stop. This is dependent on several factors, such as time, distance, signal quality, transport length, timeslots, etc.
A transport is defined as finished, if system ended to track this transport: Either all stops were visited and the tracking was concluded or it failed for different reasons (see cancellation_reason for details)Lookup of One Specific Transport
You can get visibility data for one specific transport by querying the respective RESTful resource by defining the transport_number or transport_id (see General chapter for more information on those fields).
To get visibilty for one specific transport, you must provide the following URL parameters:
The
identifier_typethat should be used to uniquely identify the transport. The available types are:transport_idtransport_number
The
identifier_value: The actual value of the identifier.
Make an authenticated GET request as shown in the example below:
GET transport status by identifier
https://api.transporeon.com/rtv/v1/transports/{identifier_type}/{identifier_value}/status-v2
The response contains general infos about the transport (identifiers, location, etc.) as well as the visibility relevant fields and objects, especially:
transport_private_url: Authenticated (private) link to the transport visibilitytransport_sharing_url: Non-authenticated (public) link of the transport visibility.delivery_item: Specifics of delivery orders and and which stops are referenced in them.locations: List of transport ids associated with transport.milestones: List of milestones and existing timestampstracking_state:The tracking state of the transport. See below for more details.
{
"transport_id": "01951de8-0c00-760c-adbe-ee8972608568",
"transport_number": "e8192cf8-dcb0-4980-a0e0-4149d58ec316",
"transport_private_url": "https://app.sixfold.tech/go/transports/17193172",
"transport_public_url": "https://app.sixfold.tech/go/71d8282d2a2207cae3cdff3c7475e041114f4f7292c7b19e02b39775dd4f3d37",
"delivery_items": [
{
"delivery_item_type": "delivery_order",
"delivery_order_number": "62305",
"location_references": [
{
"location_id": "46003232",
"stop_reference_number": "stop-reference-1",
"action": "collection"
},
{
"location_id": "46003233",
"stop_reference_number": "stop-reference-2",
"action": "delivery"
}
]
}
],
"locations": [
{
"location_id": "46003232",
"name": "Magirus-Deutz-Straße 16, 89077 Ulm, BW, DE, Ulm",
"stop_reference_number": "stop-reference-1",
"location_reference_number": "BBL04",
"location_public_url": "https://app.sixfold.tech/go/2f22b2a4fa55ce9e7b8ad87f674fdf0cec2d67e5bcadd18480b2db1a4f36ad82"
},
{
"location_id": "46003233",
"name": "Clean Car, Saarländer Straße 2, 04179 Leipzig, SN, DE, Leipzig (Stadt)",
"stop_reference_number": "stop-reference-2",
"location_reference_number": "KG01",
"location_public_url": "https://app.sixfold.tech/go/0eab3ab8d1756021d85fe6a803a72af3e74d757b845162d9a2e99965f0f6691d"
}
],
"milestones": [
{
"location_id": "46003232",
"milestone_type": "arrived",
"actual_timestamp": "2025-02-19T11:55:18.044Z",
"planned_timestamps": {
"planned_begin_timestamp": "2025-02-18T14:50:18.044Z",
"planned_end_timestamp": "2025-02-18T14:55:18.044Z"
}
},
{
"location_id": "46003232",
"milestone_type": "departed",
"actual_timestamp": "2025-02-19T12:04:14.444Z",
"planned_timestamps": {
"planned_begin_timestamp": "2025-02-18T14:50:18.044Z",
"planned_end_timestamp": "2025-02-18T14:55:18.044Z"
}
},
{
"location_id": "46003233",
"milestone_type": "arrived",
"planned_timestamps": {
"planned_begin_timestamp": "2025-02-18T20:15:18.044Z",
"planned_end_timestamp": "2025-02-18T20:35:18.044Z"
},
"estimated_timestamp": "2025-02-19T20:05:32.691Z"
},
{
"location_id": "46003233",
"milestone_type": "departed",
"planned_timestamps": {
"planned_begin_timestamp": "2025-02-18T20:15:18.044Z",
"planned_end_timestamp": "2025-02-18T20:35:18.044Z"
},
"estimated_timestamp": "2025-02-19T20:05:32.691Z"
}
],
"tracking_state": {
"label": "tracked",
"is_finished": false,
"is_working": true
}
}
GET transport status by searching and filtering all transports
With the following request, you can search and filter for currently tracked and completed transports.
You need to use one of the following search (query) parameters:
transport_numbertransport_idtransport_filter: Transports with matchingtransport_numberortransport_idordelivery_numberorpurchase_order_numberororder_numberwill be returned. Thetransport_filterparameter supports partial search. This is especially helpful if the exact field used by the customer is not known / varies from customer to customer or if multiple transports/deliveries should be returned that match the same criteria.
Make an authenticated GET request as shown in the example below:
https://api.transporeon.com/rtv/v1/transports/status-v2?transport_filter=6230
Response:
{
"transports": [
{
"transport_id": "01951e1c-8444-76da-b57c-6b7a30d4b57f",
"transport_number": "de89dec5-86e8-43e9-b711-f41bdf3c8458",
"transport_private_url": "https://app.sixfold.tech/go/transports/17193524",
"transport_public_url": "https://app.sixfold.tech/go/0d8e978b338adecafc9bf158dfb74613a4ffd2cab24c34e38997373d6ed191ca",
"delivery_items": [
{
"delivery_item_type": "delivery_order",
"delivery_order_number": "62301",
"location_references": [
{
"location_id": "46004178",
"stop_reference_number": "stop-reference-1",
"action": "collection"
},
{
"location_id": "46004179",
"stop_reference_number": "stop-reference-2",
"action": "delivery"
}
]
}
],
"locations": [
{
"location_id": "46004178",
"name": "75001 Paris, Île-de-France, FR, Paris",
"stop_reference_number": "stop-reference-1",
"location_reference_number": "BBL04",
"location_public_url": "https://app.sixfold.tech/go/aeedbc39d114f98025052fbb8f001b67ae33788e928d82d9eea5db9d97b93925"
},
{
"location_id": "46004179",
"name": "Briljantstraat, 9743 NL Groningen, GR, NL, Groningen",
"stop_reference_number": "stop-reference-2",
"location_reference_number": "KG01",
"location_public_url": "https://app.sixfold.tech/go/afc976347ee364f1e3d666ecb450dd85b343787bca1b4bb30b6d6f6bc2295069"
}
],
"milestones": [
{
"location_id": "46004178",
"milestone_type": "arrived",
"planned_timestamps": {
"planned_begin_timestamp": "2025-02-18T14:50:18.044Z",
"planned_end_timestamp": "2025-02-18T14:55:18.044Z"
}
},
{
"location_id": "46004178",
"milestone_type": "departed",
"planned_timestamps": {
"planned_begin_timestamp": "2025-02-18T14:50:18.044Z",
"planned_end_timestamp": "2025-02-18T14:55:18.044Z"
}
},
{
"location_id": "46004179",
"milestone_type": "arrived",
"planned_timestamps": {}
},
{
"location_id": "46004179",
"milestone_type": "departed",
"planned_timestamps": {}
}
],
"tracking_state": {
"label": "unallocated",
"is_finished": false
}
},
{
"transport_id": "01951de8-0c00-760c-adbe-ee8972608568",
"transport_number": "e8192cf8-dcb0-4980-a0e0-4149d58ec316",
"transport_private_url": "https://app.sixfold.tech/go/transports/17193172",
"transport_public_url": "https://app.sixfold.tech/go/71d8282d2a2207cae3cdff3c7475e041114f4f7292c7b19e02b39775dd4f3d37",
"delivery_items": [
{
"delivery_item_type": "delivery_order",
"delivery_order_number": "62305",
"location_references": [
{
"location_id": "46003232",
"stop_reference_number": "stop-reference-1",
"action": "collection"
},
{
"location_id": "46003233",
"stop_reference_number": "stop-reference-2",
"action": "delivery"
}
]
}
],
"locations": [
{
"location_id": "46003232",
"name": "Magirus-Deutz-Straße 16, 89077 Ulm, BW, DE, Ulm",
"stop_reference_number": "stop-reference-1",
"location_reference_number": "BBL04",
"location_public_url": "https://app.sixfold.tech/go/2f22b2a4fa55ce9e7b8ad87f674fdf0cec2d67e5bcadd18480b2db1a4f36ad82"
},
{
"location_id": "46003233",
"name": "Clean Car, Saarländer Straße 2, 04179 Leipzig, SN, DE, Leipzig (Stadt)",
"stop_reference_number": "stop-reference-2",
"location_reference_number": "KG01",
"location_public_url": "https://app.sixfold.tech/go/0eab3ab8d1756021d85fe6a803a72af3e74d757b845162d9a2e99965f0f6691d"
}
],
"milestones": [
{
"location_id": "46003232",
"milestone_type": "arrived",
"actual_timestamp": "2025-02-19T11:55:18.044Z",
"planned_timestamps": {
"planned_begin_timestamp": "2025-02-18T14:50:18.044Z",
"planned_end_timestamp": "2025-02-18T14:55:18.044Z"
}
},
{
"location_id": "46003232",
"milestone_type": "departed",
"actual_timestamp": "2025-02-19T12:04:14.444Z",
"planned_timestamps": {
"planned_begin_timestamp": "2025-02-18T14:50:18.044Z",
"planned_end_timestamp": "2025-02-18T14:55:18.044Z"
}
},
{
"location_id": "46003233",
"milestone_type": "arrived",
"planned_timestamps": {
"planned_begin_timestamp": "2025-02-18T20:15:18.044Z",
"planned_end_timestamp": "2025-02-18T20:35:18.044Z"
},
"estimated_timestamp": "2025-02-19T20:05:32.691Z"
},
{
"location_id": "46003233",
"milestone_type": "departed",
"planned_timestamps": {
"planned_begin_timestamp": "2025-02-18T20:15:18.044Z",
"planned_end_timestamp": "2025-02-18T20:35:18.044Z"
},
"estimated_timestamp": "2025-02-19T20:05:32.691Z"
}
],
"tracking_state": {
"label": "tracked",
"is_finished": false,
"is_working": true
}
}
],
"page_info": {}
}→ Two transports were returned, as the search string "6230" was found in two delivery_numbers:
"delivery_number": "62302""delivery_number": "62301"
Object Details tracking_state
The state (object on transport level) describes the overall state of the transport:
label- human readable label of the tracking state. Can be any string and the values returned are a subject to change.
Examples: tracked, cancelledis_working- the transport is currently being tracked.is_finished- the tracking for the transport is completed OR the tracking for the transport failed or was cancelled. For details on thecancellation_reason, see the FAQ page .
The states is_working and is_finished can never be true at the same time!