comment

Additional comments on the status message.

String

False

delivery_id

Unique Transporeon delivery ID

Long (64 bit)

False

id

Unique Transporeon Process Status ID

Long (64 bit)

True

parameters

Field used for special status messages to provide additional information. See Parameter (CI)

String

False

Different status messages and parameters are required individually per shipper.

position/latitude

The latitude where the event occurred.

Double (64 bit)

False

position/longitude

The longitude where the event occurred.

Double (64 bit)

False

qualifier

Identifies the event that caused the status to be set.

String

True

Although there are recurring and standardized processes, qualifiers are specific to workflows on shipper side.

severity

Severity of the process status

String

False

"OK", "PROBLEM", "FAILURE"

source

Source of the process status

String

False

"TP_CARRIER_API", "TP_TRUCKER", "TP_VISIBILITY_HUB"

status

Status indicator

String

True

N: Status has been placed
D: Status has been cancelled

timestamp

Timestamp when the event occurred.

ISO_8601

True

The timestamp is sent in local timestamp format. Timezone can be obtained from the timezone field.

timezone

Provides timezone information

Parameter

True

The timezone is one of the values from IANA timezone database, canonical entries only.

Example: Europe/Berlin

transport_id

Unique Transporeon-ID

Long (64 bit)

True

transport_number

Transport number in the shipper's system

String

False

Might be re-used by the shipper after the life-cycle of the current transport ends (Cancelled or removed by retention policy).

trigger

Trigger of the process status

String

False

"EVENT", "GPS"