Stop
- ser_hcskb_api
A stop is a location (address) and contains information about when to arrive at that location.
It has an Id that is referenced in Order Details. This Id will also be referenced in outgoing communication (if relevant). The Stop Id must be unique within one Transport Order. There is no global uniqueness constraint on the Transporeon platform, however, it is recommended to use globally unique stop ids.
You can also include multiple stops with different ids but the same address data if this is required to represent the correct stop sequence for certain types of transports.
Attribute | Description | Type (Length) | Example | Mandatory |
|---|---|---|---|---|
id | Stop identifier | CHAR(50) | be53c66a-ea44-4172-adc3-17740909d806 | True |
index | Index to define stop sequence. If it is not provided or 0 for all stops, the list indexes will define the stop sequence. | CHAR(100) | 1 | False |
location | See below | True | ||
date_time_period | See below | True | ||
Location
Attribute | Description | Type (Length) | Example | Mandatory |
|---|---|---|---|---|
avis | Dispatcher/recipient advice | CHAR(50) | +4973116906101 | False |
city | City | CHAR(100) | Ulm | False1 |
comment | Loading/unloading station comment, free text | CHAR(3000) | My loading station comment | False1 |
company_name | Company name | CHAR(100) | My Company Inc. | False1 |
country | Country code | CHAR(2) | DE | True |
id | Loading / unloading station identifier | CHAR(50) | HQ | False1 |
place_reference_id | Loading/unloading station reference id | CHAR(50) | PLACE_1 | False |
ramp | Gate name | CHAR(100) | Main entrance | False |
state | Federal state | CHAR(2) | BW | False |
street | Street name and number | CHAR(100) | Magirus-Deutz-Str. 16 | False1 |
zip | Postal code | CHAR(20) | 89077 | False1 |
latitude2 | Latitude coordinate in decimal degrees (DD) | DOUBLE | 48.400002 | False1 |
longitude2 | Longitude coordinate in decimal degrees (DD) | DOUBLE | 9.983333 | False1 |
1Although most of the address data are not mandatory on technical level, they are crucial in most cases for the carriers and also for correct geolocation of the station and ETA calculations. Please, check “Data quality and interfaces to carrier systems” and “Best Practices” chapters for more information.
Either address or coordinates can be provided.
2Not exported by default.
Datetime Period
Attribute | Description | Type (Length) | Example | Mandatory |
|---|---|---|---|---|
start
| Loading/unloading period begin / end (date and time). Note: This a local timestamp. This means the offset on the timestamp is ignored and the time is always related the local location! Timezone for the location is defined in field timezone instead. Examples: Loading or unloading times for 2021-10-08T14:15:00Z, 2021-10-08T14:15:00+02:00 and even 2021-10-08T14:15:00-10:00 will be displayed in our front-end application as 14:15. The offsets for exports and further data processing is solely taken from the timezone field! | CHAR(19) | 2021-10-08T12:00:00 | True |
end | CHAR(19) | 2021-10-08T14:15:00Z | True
| |
timezone | Time zone of the loading / unloading location. Naming must follow tz database (also known as IANA time zone database) We only accept entries marked as “Canonical” in tz database. | CHAR(50) | Europe/Berlin | False1 |
1We highly recommend to provide the timezone. Default if not provided is Europe/Amsterdam