V02 DocumentArchive

Communication

Integration Layer

teamfineilosp[ätt]osp.de

InterfaceOwner

FINE

???

Producer

KR1 HHStr

Martin Körner

Producer

KR1 SHF

Martin Körner

Consumer

SER

Sebastian Gil Händelt / Niko Maximilian Kirsch

(Root)

object

Document references for archive processes

    eventId*

string

The unique eventId
UUID.

    traceId*

string

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

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record/event was technically generated.

    version*

string (const)

Schema version number
Schema version - 1.0 for this message.

Constant: 1.0

    eventType*

string (const)

Concrete type/kind of record/event

Constant: DOCUMENT_ARCHIVE

    metaData

object

Additional meta information
Any optional or required attributes for additional technical information can be defined here individually for each interface. The attributes listed here cover the most common use cases. The same attribute names as listed here should be used when describing the same thing.

        sender

string (enum)

Name of sender/producer
Name of the source system that generated this data.

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", "EFI" ]

        client

string

Client / Tenant
Name of the client, for example if messages from different clients have different processing rules or destinations.

    data*

object

        documentType*

string

Document type
Different types of documents should have a meaningful name. Currently, 'EWAP' is the only supported type

Maximum Length: 20

        documentDownload*

string

Download link
The document has to be stored somewhere for download - here, the complete access URL should be provided

Maximum Length: 1024

        context*

object

Each document can have different types of context information. Typically, each document type has the same kind of information, but not all fields have to be filled

            shipmentNumber

string

Inbound Shipment number as provided by the warehouse

Maximum Length: 10

            documentNumber

integer

Number of inbound document (= Acceptance protocol (WAP))

Minimum: 100000
Maximum: 999999

            productNumber

string

Product Number

Maximum Length: 12

            supplierNumber

integer

Number of Supplier (LKZ)

Maximum: 999999

            documentTimestamp

string (date-time)

Time at which the document was created/uploaded

Version

Number

valid from

File

Changes

upcoming

1.0

01.03.2025

Download

Initial Version