ProcessStatus (CI, Inbound)
- ser_hcskb_api
- Faruk Mercan
ProcessStatus are used to send Event Management data on transport level and delivery level to the Transporeon Platform.
Field Description
Field | Description | Type | Mandatory | Remarks |
|---|---|---|---|---|
transport_id | Unique Transporeon-ID | Long (64 bit) | True |
|
scheduler_email | E-mail address of the responsible scheduler. | String | False | Transporeon will match the provided e-mail address with all schedulers registered and active for the company. If no match can be found or no e-mail is given, a system user will be shown instead as contact. |
delivery_id | Unique Transporeon delivery ID | Long (64 bit) | False | Only required for status messages on delivery / order level. Skip it otherwise. You can provide either delivery_id or delivery_number. If both are provided, delivery_id has precedence. |
delivery_number | Identifies the shipment uniquely in the shipper's system. | String | False | |
qualifier | Identifies the event that caused the status to be set. | String | False | Although there are recurring and standardized processes, qualifiers are specific to workflows on shipper side. Please contact us to agree on qualifiers. |
timestamp timestamp_action | Timestamp when the event occurred. | ISO_8601 | False | For all status messages it is possible to insert a parameter with qualifier timezone to indicate the time zone the event occurred in. See timezone parameter description below. The timezone offset provided in this field will be ignored, instead the IANA timezone parameter is taken into consideration. |
longitude | The longitude where the event occurred. | Double (64 bit) | False |
|
latitude | The latitude where the event occurred. | Double (64 bit) | False |
|
comment | Additional comments on the status message. | String | False |
|
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. For detailed information please contact us directly. |
parameter[qualifier = 'timezone'] | Provides timezone information | Parameter | Recommended | Send a parameter with qualifier "timezone" to provide information about the timezone in which the event occurred. The timezone must be one of the values from IANA timezone database, canonical entries only. Example: Europe/Berlin |
ECTA Codes
Use cases: The message is sent to Transporeon to inform about incidents or problems during pickup or delivery of a transport.
You can provide ECTA codes for certain qualifiers. Please contact us to agree on the qualifiers in advance.
The ECTA code must be formatted in the following way:
DT - S - RO - R - D - CC - 7It must be provided as parameter with qualifier "custom1".
Example
ECTA example
<process_status>
<transport_id>12345</transport_id>
<delivery_number>1234</delivery_number>
<qualifier>status.ecta.code</qualifier>
<timestamp>2014-09-09T17:15:00</timestamp>
<longitude>10.123</longitude>
<latitude>45.678</latitude>
<comment>comment0</comment>
<parameters>
<parameter>
<qualifier>timezone</qualifier>
<value>Europe/Berlin</value>
</parameter>
<parameter>
<qualifier>custom1</qualifier>
<value>DT - S - RO - R - D - CC - 7</value>
</parameter>
</parameters>
</process_status>