Y03 Yard Container Inventory

(Root)

object

Interface for reporting Yard Container Inventory

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

Maximum Length: 36

    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.

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in format yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI.

    version*

The number of version schema
Number of version of this data structure. Only required if no $schema is specified!

    context

string

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

Maximum Length: 25

    eventType*

string (enum)

The concrete type = kind of record(event)

Any of: [ "YARD_CONTAINER_INVENTORY" ]
Maximum Length: 50

    metaData

object

        sender

string (enum)

The name of sender/producer
Name of the source system, which has 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" ]

        instance

string

SW-Instance of the producing system
Name of the source instance, which has generated this data. The enum here is only an example.

Maximum Length: 50

        client

string

Client / Tenant
the client (messages of different clients have different processing rules and destination interfaces)

Maximum Length: 50

        messageNumber

integer

Current meassage number
the current message number that is transmitted (first message has number=1)

Minimum: 1
Maximum: 999999999

        messageCount

integer

Overall message count
how many messages are to be transferred in this batch

Minimum: 1
Maximum: 999999999

    data*

object

        yard*

string

Yard for wich the Inventory is provided
Yard for wich the Inventory is provided / Yard der Hofaufnahmet

Maximum Length: 50

        location

string (enum)

location managed by the Yard system
location managed by the Yard system - can be one ore more locations (e.g. ILOWA and ILOWA_RT for yard ILOWA)

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

        recipient*

string (enum)

receiver system
receiver system, which is entitled to get information about listed inventory

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

        containerList*

array

container list
list of load carriers for the recipient for this yard (empty array when no load carrier available)

            (Array item)

object

                loadCarrierId*

string

Load carrier ID
load carrier ID / ID des Ladungsträgers (Brückennummer, Containernummer, KFZ-Kennz. bei LKW, …​), referenziert auf Avise

Maximum Length: 50

                loadCarrierIsDefective

boolean

Load carrier defective flag
flag whether this load carrier is defective or not / Kennzeichen Defekt

                yardTransactionType

string

YMS Transaction Type
YMS Transaction Type / YMS Vorgangsart (for HERIS status mapping)

Maximum Length: 25

                deliveryType

string

Delivery Type
delivery type / Art der Anlieferung (for HERIS status mapping)

Maximum Length: 25

current version

1.0

YardContainerInventory.v1.0.schema.json

30.11.2023

location, additionalInfo added, delayCategory optional

previous version

0.1

YardContainerInventory.v0.1.schema.json

28.09.2023

draft

coming version

current version

2.0

Download

20.09.2023

initial version

previous version

coming version