V01 Logistic Issues

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

LogisticIssuesService

InterfaceOwner

Neon

Producer

kMotion

Producer

YardManagement

Consumer

Hermes Jira

2. Business Context

Sends problems that occur in the logistics systems (WMS, Yard, …​) to Hermes' JIRA system to automatically generate a JIRA ticket there.

3. Informationflow

Diagram

4. Confluent Rest-API

A minimal example for producing a record with the Confluent REST-API looks like this:

curl --request POST \
  --url <CLUSTER_ENDPOINT_URL>/kafka/v3/clusters/<CLUSTER_ID>/topics/<TOPIC_NAME>/records \
  --header 'Authorization: Basic <REPLACE_BASIC_AUTH>' \
  --header 'Content-Type: application/json' \
  --data '{"value":{"type":"JSON","data":"Hello World!"}}'

More detailed information about producing records with the Confluent REST-API can be found here.

5. Data model

Property Type Description

(Root)

object

Logistic Issue
Data spec for a logistic issue send by NEON

    eventId*

string (uuid)

UUID for this event
UUID for this event

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    eventTime*

string (date-time)

the date and time, when this event occured as an ISO-8601 timestamp.
the date and time, when this event occured as an ISO-8601 timestamp.

    traceId*

string

The unique traceId
Global unique Id for tracing the flow of events, recommended as UUID.

    eventType*

string (const)

Concrete type/kind of record/event
Describes the characteristics of the record/event.

Constant: LOGISTIC_CLARIFICATION_CASE

    version*

string

Json schema version
JSON schema version

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

    data*

object

        incidentId*

string

incident ID
ID of the incident-type

Minimum Length: 2
Maximum Length: 20

        title*

string

Title of the incident
Title of the incident

Minimum Length: 5
Maximum Length: 100

        process*

string

Title of the NEON-Process
Title of the NEON-Process

Minimum Length: 5
Maximum Length: 100

        incidentType*

string

Type of the incident
Type of the incident

Minimum Length: 3
Maximum Length: 100

        dialoque*

string

Dialogue
The name of the sending dialogue

Minimum Length: 1
Maximum Length: 30

        terminal*

string

Terminal
The name of the sending terminal

Minimum Length: 1
Maximum Length: 30

        user*

string

User
The name of the sending user

Minimum Length: 1
Maximum Length: 30

        SOS*

boolean

SOS-Incident
flag if incident is urgent

        optionalData

object

            description

string

Description
detailed information about the incident

Maximum Length: 500

            idArticle

string

ID Article
id of the article in the incident

Maximum Length: 12

            buid

string

BUID
buid of the incident

Maximum Length: 36

            logisticProductId

string

logisticProductId
logisticProductId in the incident

Maximum Length: 40

            ean

string

ean
ean in the incident

Maximum Length: 13

            idGoodsReceiving

string

GR ID
Goods receiving ID

Maximum Length: 12

            deliveryNoteNumber

string

Die Belegnummer des Lieferscheins
deliveryNoteNumber

Maximum Length: 36

            truckNumber

string

truck number
Number of the truck

Maximum Length: 20

            idLu

string

id of the load unit
Load unit ID

Maximum Length: 20

            storageArea

string

storage area
Name of the storage area

Maximum Length: 20

            storageLocation

string

storageLocation
Name of the storage location

Maximum Length: 65

            batchId

string

batch ID
Id of the batch of an order

Maximum Length: 5

            orderID

string

order ID

Maximum Length: 12

            consolidationId

string

batch ID

Maximum Length: 20

            additionalInformation

string

additional Informations
commaseparated infos, for which no interface field exists

Maximum Length: 2000

            imageURLs

array

image URLs

                (Array item)

string

            ottoCategory

string

otto category
Category assortment Otto

Maximum Length: 25

            herisTour

string

Heris-Tournummer

Maximum Length: 20

            ccxAvisId

string

CCX Avis ID
CCX Avis ID from YMS

Maximum Length: 20

            wmsAvisId

string

wms Avis ID
WMS Umfuhr Avis ID (YMS)

Maximum Length: 20

            resyId

string

resy ID

Maximum Length: 20

            company

string

company
company

            supplierName

string

supplier Name
Name of the supplier

Maximum Length: 35

            supplierId

integer

supplier Id
Supplier ID (LKZ)

            location

string

location Name
location of the warehouse

Maximum Length: 35

            salesBrand

string

sales brand
brand name

Maximum Length: 35

            erpProductId

string

erpProductId
technical Id

            itemNo

string

item number
item number

Maximum Length: 16

            orderNumber

string (OVA)

order number
order number

            productGroup

integer

product Group
Classification of products (phone, watch, cosmetics, etc.)

            size

string

size
groesse logistisch

Maximum Length: 3

            deliveryDate

string (yyyy-MM-dd'T'HH:mm:ss.SSSZ)

delivery date

            orderQty

number

order quantity number
purchase order quantity

            deliveryNotePositionId

string

delivery Note Position Id
all positions of the delivery note

6. Version history

Table 1. Version WMS to FINE

Version

Number

valid from

File

Changes

upcoming

2.0

tbd

Download

1. removed object optionalData and moved all its properties to data
2. description is now mandatory

current

1.1

17.04.2024

Download

added field description under data/optionalData for Jira description

previous

1.0

01.02.2024

Download

Initial Version
Last updated: Fri, 25 Apr 2025 01:44:50 UTC