Road Transports Tracking and Tracing
- ser_hcskb_api
Shipper Standard Interface provides two types of transport visibility data.
Process Statuses
Description
Process statuses are the key milestones reached during the transport execution. In general case, there are 3 sources of the process statuses:
Generated automatically on delivery and transport level in Transporeon Visibility Hub module based on GPS coordinates of the road vehicle if the carrier integrated their telematics provider to Transporeon Visibility Hub.
You may receive the statuses from Transporeon platform, for example, when an assigned vehicle is approaching a loading stop.
Complete list of auto-generated road process status can be found here: Automatic Road Process StatusesGenerated upon actions of a driver in Transporeon Trucker application, if the executing carrier uses the app.
For example, a vehicle driver reports a traffic jam on the way.
A list of Transporeon Trucker app process statuses can be found here: Trucker App Process StatusesSet by carrier operator via Transporeon UI or via carrier interface, if the process workflow is configured for the shipper customer.
Reported status messages are highly dependent on the business process implemented.
Note, Transporeon Sixfold requires your carriers to provide their telematics data. Please contact Transporeon project team for further information.
Receiving Process Statuses
You can receive tracking and tracing data of transports which were set for your transports either automatically in Transporeon Sixfold, by driver in Transporeon Trucker app, via carrier interfaces, or by operator in Transporeon UI.
A type of the process status is populated in the “qualifier” attribute of the process_status DTO, for example status.loading.begin or status.loading.arrival. If a process status is valid for the whole transport (for example driver’s break or a delay due to traffic jam), delivery_number is not contained in the message or null.
Process statuses, automatically generated on Transporeon platform, have a list of reserved qualifiers.
Transporeon Sixfold generates six main types of process statuses on delivery level, based on the geo-position of the assigned road vehicle. See “Automatic road process statuses” chapter.
Transporeon Trucker app also has a list of standard process statuses, see “Trucker app process statuses” section.
In addition to the auto-generated process statuses, shipper customer using Transport Execution feature, can define additional transport visibility statuses both on delivery and transport level. If configured, an operator of the transport executing carrier would place the transport visibility statuses via Transporeon UI or carrier interfaces.
Resources
Description | Documentation | OpenApi |
|---|---|---|
Process Status | GET /v2/process_statuses/pull |
Providing Process Status
For business specific use cases it may be necessary to provide process status messages to our system.
Process status workflow configurations can be very complex and also restrictive in which order status messages have to be provided. Please contact the responsible project manager to agree on a workflow.
Not all fields in the DTO are relevant for this direction of communication. The following table shows which information are relevant:
Attribute | Description | Type (Length) | Example | Mandatory |
|---|---|---|---|---|
delivery_number | Delivery number. Mandatory for statuses on delivery level | CHAR(50) | 456 | See description |
comment | Status comment | CHAR(255) | This is a comment | False |
declared_timestamp | Date and time when the status took place. | CHAR(29) | 2021-10-07T16:00:00+02:00 | True |
timezone | Timezone of the declared_timestamp, according to IANA tz database. | CHAR(50) | Europe/Berlin | False |
latitude | Geographic coordinates (Latitude) | FP NUMBER | 48.400002 | False |
longitude | Geographic coordinates (Longitude) | FP NUMBER | 9.983333 | False |
parameters | List of parameters, see Parameter | False | ||
qualifier | Status qualifier. The status should be allowed according to the delivery and transport process. Mutually agreed, see also Automatic Road Process Statuses, Trucker App Process Statuses | CHAR(50) | status.loading.arrival | True |
severity | Severity of the status Severity
| CHAR(20) | OK | False |
transport_number | Number of the transport that received the status | CHAR(50) | ABC123 | True |
user_id | User that placed the status | INT(10) | 2147483647 | False |
status | Describes if the status is set (N) or deleted (D). Status
| CHAR(1) | N | False |
Resources
Description | Documentation | OpenApi |
|---|---|---|
Process Status | POST /v2/process_statuses |
ETA
You can receive all recently updated estimated time of arrival (ETA) of your active transports.
Note, the frequency of updates per transport can be in the range of a few minutes, depending on the data source and the exact circumstances. This may result in high volume of messages.
Resources
Description | Documentation | OpenApi |
|---|---|---|
Eta | GET /v2/etas/pull |