I02D Despatch Advice Process State

Status: DRAFT → Dokumentation im Aufbau
Approval
Comment: FLASH nutzt bereits eine CargoClix-Schnittstelle produktiv. Die folgende Beschreibung bezieht sich auf ein neu zu entwickelndes Schnittstellenformat.

1. Stakeholder

Role	Application	Responsible
Communication	Integration Layer
Leading App
InterfaceOwner
Producer	CargoClix
Consumer	FLASH
Consumer	Oyster
Consumer	Yard

Role

Application

Responsible

Communication

Integration Layer

Leading App

InterfaceOwner

Producer

CargoClix

Consumer

FLASH

Consumer

Oyster

Consumer

Yard

2. Business Context

process status data for bookings

3. Informationflow

4. Interface

Vorhandene Dokumentation

Technisch:

4.1. Direction Cargoclix to FINE

4.1.1. Header

This interface uses the Service Header

4.1.2. Datamodel

Property	Type	Description
(Root)	object	Despatch Advice Process State
eventId*	string (uuid)	The uniq eventId Global uniq Id
traceId*	string (uuid)	The uniq traceId Global uniq Id for tracing the flow of events
spanId	string (uuid)	The uniq spanId ID of the privious event (message). The ID is not given if there is no previous event. For transaction initiated by user the spanId of the executed event might be the userId.
eventTime*	string (date-time)	Time of occurrence of the event Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.
version*	string	The number of version schema Number of version of this data structure. Sematic specification (String with major & minor nr) Minimum Length: 3 Maximum Length: 5 Regular expression: ^[0-9]+[.][0-9]+$
context	string	The context / business case The context specified here means the business domain.
eventType*	string (enum)	The type of operation Type of message Any of: [ "INSERT", "UPDATE", "DELETE" ]
metaData	object
sender	string (enum)	system Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND", "F2X", "WMSX_WEISMAIN", "LIGIS", "KR1_MANDANT", "YMS_KMOTION", "YMS_INCONSO", "HERIS", "CARGOCLIX", "KMOTION_ERFURT", "LOGISTIKPUFFER" ]
data*	object
location*	string (enum)	warehouse locations Any of: [ "ANSBACH", "LOEHNE", "LANGENSELBOLD", "MOSINA", "OHRDRUF", "HALDENSLEBEN", "HALDENSLEBEN_RT", "SUEDHAFEN", "SONNEFELD", "ALTENKUNSTADT", "WEIDEN", "KRACANY", "ILOWA", "ILOWA_RT", "ILOWA_RSS", "GERNSHEIM", "ERFURT", "HAMBURG_RT", "OTELFINGEN_RT", "KRIMICE_RT", "STAHLAVY_RT", "OHRDRUF_RT", "LOEHNE_RT", "LANGENSELBOLD_RT", "LODZ_1_RT", "LODZ_2_RT", "BERGHEIM_RT", "ALTENKUNSTADT_RT", "LISTERHILLS_RT", "SUEDHAFEN_RT", "PILSEN_RT", "HAMBURG_SC", "LOEHNE_SC", "SCHWABHAUSEN_SC", "HALDENSLEBEN_RSS", "ALTENKUNSTADT_RSS", "LOEHNE_RSS", "OHRDRUF_RSS", "LANGENSELBOLD_RSS", "LOEHNE_CP" ]
bookId*	integer	Id of the booking
businessEventDateTime*	string (date-time)	timestamp of business event
processState*	object
number*	integer
name*	string

Property

Type

Description

(Root)

object

Despatch Advice Process State

eventId*

string (uuid)

The uniq eventId
Global uniq Id

traceId*

string (uuid)

The uniq traceId
Global uniq Id for tracing the flow of events

spanId

string (uuid)

The uniq spanId
ID of the privious event (message). The ID is not given if there is no previous event. For transaction initiated by user the spanId of the executed event might be the userId.

eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.

version*

string

The number of version schema
Number of version of this data structure. Sematic specification (String with major & minor nr)

Minimum Length: 3
Maximum Length: 5
Regular expression: ^[0-9]+[.][0-9]+$

context

string

The context / business case
The context specified here means the business domain.

eventType*

string (enum)

The type of operation
Type of message

Any of: [ "INSERT", "UPDATE", "DELETE" ]

metaData

object

sender

string (enum)

system

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND", "F2X", "WMSX_WEISMAIN", "LIGIS", "KR1_MANDANT", "YMS_KMOTION", "YMS_INCONSO", "HERIS", "CARGOCLIX", "KMOTION_ERFURT", "LOGISTIKPUFFER" ]

data*

object

location*

string (enum)

warehouse locations

Any of: [ "ANSBACH", "LOEHNE", "LANGENSELBOLD", "MOSINA", "OHRDRUF", "HALDENSLEBEN", "HALDENSLEBEN_RT", "SUEDHAFEN", "SONNEFELD", "ALTENKUNSTADT", "WEIDEN", "KRACANY", "ILOWA", "ILOWA_RT", "ILOWA_RSS", "GERNSHEIM", "ERFURT", "HAMBURG_RT", "OTELFINGEN_RT", "KRIMICE_RT", "STAHLAVY_RT", "OHRDRUF_RT", "LOEHNE_RT", "LANGENSELBOLD_RT", "LODZ_1_RT", "LODZ_2_RT", "BERGHEIM_RT", "ALTENKUNSTADT_RT", "LISTERHILLS_RT", "SUEDHAFEN_RT", "PILSEN_RT", "HAMBURG_SC", "LOEHNE_SC", "SCHWABHAUSEN_SC", "HALDENSLEBEN_RSS", "ALTENKUNSTADT_RSS", "LOEHNE_RSS", "OHRDRUF_RSS", "LANGENSELBOLD_RSS", "LOEHNE_CP" ]

bookId*

integer

Id of the booking

businessEventDateTime*

string (date-time)

timestamp of business event

processState*

object

number*

integer

name*

string

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

Table 1. Version Cargoclix to FINE
Version	Number	File	Published on	Changes
current version	1.0	Download	18.02.2025	added attribute location
previous version	1.0	Download	23.11.2023	final
previous version
coming version

Last updated: Fri, 25 Apr 2025 01:44:49 UTC