This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

70 Yard Management

1 - Team IL

1.1 -

1.1.1 -

Property Type Description

(Root)

object

Interface for Advice of Loading Units for Yard Management

    eventId*

string (uuid)

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    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

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)
Determines whether a loading unit advice is 1) created or changed or 2) marked as deleted

Any of: [ "LOADING_UNIT_ADVICE_DATA", "LOADING_UNIT_ADVICE_DELETE", "LOADING_UNIT_ADVICE_REVOKE" ]
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.

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

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

Minimum: 1
Maximum: 999999999

        messageCount

integer

how many messages are to be transferred in this batch

Minimum: 1
Maximum: 999999999

    data*

object

        systemRegistration*

string (enum)

System which registers the advice
sender system of advice / System aus dem die Registrierung übertragen wurde: HERIS, CARGOCLIX, RESY, …​

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

        yard*

string (enum)

Yard for the advice
yard for wich the advice is intended / Yard für welches die Ankündigung relevant ist

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

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

        arrivalSlotStartDateTime*

string (date-time)

Arrival slot start time
start date+time of announced arrival time slot / Datum, Uhrzeit ab dem der Ladungsträger erwartet wird (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        arrivalSlotEndDateTime

string (date-time)

Arrival slot end time
end date+time of announced arrival time slot / Datum, Uhrzeit bis zu dem der Ladungsträger erwartet wird (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        adviceType*

string (enum)

Advice Type
advice type: INBOUND, OUTBOUND / Typisierung: INBOUND (Anlieferung), OUTBOUND (Abholung)

Any of: [ "INBOUND", "OUTBOUND" ]
Maximum Length: 25

        inbound

object

            deliveryType

string

Delivery type
delivery type (new items single SKU boxes, returns, transfer) / Art der Anlieferung (Neuware SKU-rein, Retoure, Umfuhr)

Maximum Length: 25

            transportOriginRelation

string

Origin Relation
origin of the transport - needed for inbound / Start des Transportes (Matchcode)

Maximum Length: 50

            transportDestinationRelationGoods

string

Destination relation
destination of the transport for inbound (for detection of transit transports) / Ziel des Transportes bei WE (für Erkennung von Transitverkehren)

Maximum Length: 50

            supplier

string

Supplier
Supplier for display on gate display (inbound) / Lieferant für Anzeige auf Tordisplay (WE)

Maximum Length: 50

        outbound

object

            departureTargetDateTime

string (date-time)

target departure time
target departure time for outbound / Optional bei WA wann der Ladungsträger das Yard verlassen soll (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

            departureReadinessDateTime

string (date-time)

departure readiness time
departure readiness time (for waybill printing) / Gestellungszeit (für Frachtbriefdruck) (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

            transportDestinationRelation

string

destination relation
destination of the transport - needed for outbound / Ziele des Transportes - relevant für WA

Maximum Length: 50

            destinationTargetArrivalDateTime

string (date-time)

Expected Arrival time at destination
Expected Arrival time at destination / Soll-Ankunftszeit Ziel (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        loadCarrier*

object

            loadCarrierId

string

load Carrier ID
load carrier ID (swap body number, container ID, license plate number of the truck, …​) / ID des Ladungsträgers (Brückennummer, Containernummer, KFZ-Kennz. bei LKW, …​)

Maximum Length: 50

            loadCarrierType*

string

load Carrier Type
load carrier type / Typ des Ladungsträgers: WAB (swap body / Wechselaufbaubrücke), BUS, SATTEL (semi trailer / Sattelauflieger), LKW (truck), CT20 (Container 20 feet/Fuß), CT40 (Container 40 feet/Fuß)

Maximum Length: 25

            loadCarrierTruckConsolidation

string

load carrier consolidation truck + trailer
consolidate 2 load carriers which are delivered with the same truck / Klammer bei Avisierung von 2 Ladungsträgern, die mit einem LKW geliefert werden.

Maximum Length: 50

        transport

object

            licensePlateTruck

string

License plate truck
license plate number of the truck / KFZ-Kennzeichen des LKWs bzw. der Zugmaschine (receiver YMS_KMOTION will accept formatted values and normalize them by removing spaces and special characters)

Maximum Length: 25

            licensePlateTrailer

string

License plate trailer
license plate number of the trailer / KFZ-Kennzeichen des Anhängers bzw. der Lafette (receiver YMS_KMOTION will accept formatted values and normalize them by removing spaces and special characters)

Maximum Length: 25

            driverName

string

Driver name
driver name / Name des Fahrers

Maximum Length: 100

            driverPhone

string

Driver phone
driver's mobile phone number / Telefonnummer des Fahrers

Maximum Length: 50

            driverLanguage

string

Driver Language
driver's language / Sprache des Fahrers (ISO coded, preferable 639-1)

Maximum Length: 50

        carrier

object

            carrierId

string

Carrier ID
carrier ID / ID des Spediteurs

Maximum Length: 50

            subCarrierId

string

Carrier subcontractor ID
ID of carrier's subcontractor / ID des Subauftragnehmers des Spediteurs

Maximum Length: 50

        comment

string

Free comment
free comment / freies Bermerkungsfeld

Maximum Length: 1000

        sealNumber

string

Seal number
seal number / Plombennummer

Maximum Length: 50

        externalReferences*

object

external references

            typeReference*

string

reference type
reference type referring to the system / Referenztyp bezugnehmend auf das externe System (z.B. TOUR, BOOKID, LOADING_MANIFEST, WMS_ORDER)

Maximum Length: 50

            idReference1*

string

external reference 1
external reference 1 / externe ID 1 der Referenz (Bsp. HERIS Tournummer, CCX BookID, Resy loadingNumber, wmsOrderId)

Maximum Length: 50

            idReference2

string

external reference 2
external reference 2 / optionale externe ID 2 der Referenz (Bsp. HERIS Teilstreckennummer)

Maximum Length: 50

            idReference3

string

external reference 3
external reference 3 / optionale externe ID 3 der Referenz (Bsp. HERIS Beladungsnummer)

Maximum Length: 50

            idReference4

string

external reference 4
external reference 4 / optionale externe ID 4 der Referenz

Maximum Length: 50

            idReference5

string

external reference 5
external reference 5 / optionale externe ID 5 der Referenz

Maximum Length: 50

            idReference6

string

external reference 6
external reference 6 / optionale externe ID 6 der Referenz

Maximum Length: 50

        yardEntranceId

string

Yard entrance ID
optional ID for driver's identification (security check) / Optionale ID mit der der Fahrer sich im Pfortenprozess identifiziert

Maximum Length: 50

        additionalInfo

object

additional Information

            internalTripNumber

string

internal trip number
internal trip number for partial routes between locations of the same yard / Teilstreckennummer für interne Teilstrecke zwischen Locations desselben Yards (e.g. HERIS)

Maximum Length: 50

            loadingNumber

string

Loading Number / Verladenummer
Loading number generated by system responsible for loading, e.g. WMS / Vom verladenden System, z.B. WMS generierte Verladenummer pro Verladung

Maximum Length: 25

        addressShipper

object

shipper address for waybill / Versenderadresse für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

        addressOriginLocation

object

originloading location address for waybill / Adresse des Verladestandorts für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

        addressRecipient

object

recipient address for waybill / Empfängeradresse für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

        addressDestinationLocation

object

destination location address for waybill / Adresse des Entladestandorts für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

1.1.2 -

Property Type Description

(Root)

object

Interface for Advice of Loading Units for Yard Management

    eventId*

string (uuid)

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    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

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)
Determines whether a loading unit advice is 1) created or changed or 2) marked as deleted

Any of: [ "LOADING_UNIT_ADVICE_DATA", "LOADING_UNIT_ADVICE_DELETE", "LOADING_UNIT_ADVICE_REVOKE" ]
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.

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

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

Minimum: 1
Maximum: 999999999

        messageCount

integer

how many messages are to be transferred in this batch

Minimum: 1
Maximum: 999999999

    data*

object

        systemRegistration*

string (enum)

System which registers the advice
sender system of advice / System aus dem die Registrierung übertragen wurde: HERIS, CARGOCLIX, RESY, …​

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

        yard*

string (enum)

Yard for the advice
yard for wich the advice is intended / Yard für welches die Ankündigung relevant ist

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

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

        arrivalSlotStartDateTime*

string (date-time)

Arrival slot start time
start date+time of announced arrival time slot / Datum, Uhrzeit ab dem der Ladungsträger erwartet wird (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        arrivalSlotEndDateTime

string (date-time)

Arrival slot end time
end date+time of announced arrival time slot / Datum, Uhrzeit bis zu dem der Ladungsträger erwartet wird (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        adviceType*

string (enum)

Advice Type
advice type: INBOUND, OUTBOUND / Typisierung: INBOUND (Anlieferung), OUTBOUND (Abholung)

Any of: [ "INBOUND", "OUTBOUND" ]
Maximum Length: 25

        inbound

object

            deliveryType

string

Delivery type
delivery type (new items single SKU boxes, returns, transfer) / Art der Anlieferung (Neuware SKU-rein, Retoure, Umfuhr)

Maximum Length: 25

            transportOriginRelation

string

Origin Relation
origin of the transport - needed for inbound / Start des Transportes (Matchcode)

Maximum Length: 50

            transportDestinationRelationGoods

string

Destination relation
destination of the transport for inbound (for detection of transit transports) / Ziel des Transportes bei WE (für Erkennung von Transitverkehren)

Maximum Length: 50

            supplier

string

Supplier
Supplier for display on gate display (inbound) / Lieferant für Anzeige auf Tordisplay (WE)

Maximum Length: 50

        outbound

object

            deliveryType

string

Delivery type
delivery type (especially empty transport) / Art der Abholung (insbesondere Leertransport)

Maximum Length: 25

            departureTargetDateTime

string (date-time)

target departure time
target departure time for outbound / Optional bei WA wann der Ladungsträger das Yard verlassen soll (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

            departureReadinessDateTime

string (date-time)

departure readiness time
departure readiness time (for waybill printing) / Gestellungszeit (für Frachtbriefdruck) (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

            transportDestinationRelation

string

destination relation
destination of the transport - needed for outbound / Ziele des Transportes - relevant für WA

Maximum Length: 50

            destinationTargetArrivalDateTime

string (date-time)

Expected Arrival time at destination
Expected Arrival time at destination / Soll-Ankunftszeit Ziel (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        loadCarrier*

object

            loadCarrierId

string

load Carrier ID
load carrier ID (swap body number, container ID, license plate number of the truck, …​) / ID des Ladungsträgers (Brückennummer, Containernummer, KFZ-Kennz. bei LKW, …​)

Maximum Length: 50

            loadCarrierType*

string

load Carrier Type
load carrier type / Typ des Ladungsträgers: WAB (swap body / Wechselaufbaubrücke), BUS, SATTEL (semi trailer / Sattelauflieger), LKW (truck), CT20 (Container 20 feet/Fuß), CT40 (Container 40 feet/Fuß)

Maximum Length: 25

            loadCarrierTruckConsolidation

string

load carrier consolidation truck + trailer
consolidate 2 load carriers which are delivered with the same truck / Klammer bei Avisierung von 2 Ladungsträgern, die mit einem LKW geliefert werden.

Maximum Length: 50

        transport

object

            licensePlateTruck

string

License plate truck
license plate number of the truck / KFZ-Kennzeichen des LKWs bzw. der Zugmaschine (receiver YMS_KMOTION will accept formatted values and normalize them by removing spaces and special characters)

Maximum Length: 25

            licensePlateTrailer

string

License plate trailer
license plate number of the trailer / KFZ-Kennzeichen des Anhängers bzw. der Lafette (receiver YMS_KMOTION will accept formatted values and normalize them by removing spaces and special characters)

Maximum Length: 25

            driverName

string

Driver name
driver name / Name des Fahrers

Maximum Length: 100

            driverPhone

string

Driver phone
driver's mobile phone number / Telefonnummer des Fahrers

Maximum Length: 50

            driverLanguage

string

Driver Language
driver's language / Sprache des Fahrers (ISO coded, preferable 639-1)

Maximum Length: 50

        carrier

object

            carrierId

string

Carrier ID
carrier ID / ID des Spediteurs

Maximum Length: 50

            subCarrierId

string

Carrier subcontractor ID
ID of carrier's subcontractor / ID des Subauftragnehmers des Spediteurs

Maximum Length: 50

        comment

string

Free comment
free comment / freies Bermerkungsfeld

Maximum Length: 1000

        sealNumber

string

Seal number
seal number / Plombennummer

Maximum Length: 50

        externalReferences*

object

external references

            typeReference*

string

reference type
reference type referring to the system / Referenztyp bezugnehmend auf das externe System (z.B. TOUR, BOOKID, LOADING_MANIFEST, WMS_ORDER)

Maximum Length: 50

            idReference1*

string

external reference 1
external reference 1 / externe ID 1 der Referenz (Bsp. HERIS Tournummer, CCX BookID, Resy loadingNumber, wmsOrderId)

Maximum Length: 50

            idReference2

string

external reference 2
external reference 2 / optionale externe ID 2 der Referenz (Bsp. HERIS Teilstreckennummer)

Maximum Length: 50

            idReference3

string

external reference 3
external reference 3 / optionale externe ID 3 der Referenz (Bsp. HERIS Beladungsnummer)

Maximum Length: 50

            idReference4

string

external reference 4
external reference 4 / optionale externe ID 4 der Referenz

Maximum Length: 50

            idReference5

string

external reference 5
external reference 5 / optionale externe ID 5 der Referenz

Maximum Length: 50

            idReference6

string

external reference 6
external reference 6 / optionale externe ID 6 der Referenz

Maximum Length: 50

        yardEntranceId

string

Yard entrance ID
optional ID for driver's identification (security check) / Optionale ID mit der der Fahrer sich im Pfortenprozess identifiziert

Maximum Length: 50

        additionalInfo

object

additional Information

            internalTripNumber

string

internal trip number
internal trip number for partial routes between locations of the same yard / Teilstreckennummer für interne Teilstrecke zwischen Locations desselben Yards (e.g. HERIS)

Maximum Length: 50

            loadingNumber

string

Loading Number / Verladenummer
Loading number generated by system responsible for loading, e.g. WMS / Vom verladenden System, z.B. WMS generierte Verladenummer pro Verladung

Maximum Length: 25

        addressShipper

object

shipper address for waybill / Versenderadresse für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

        addressOriginLocation

object

originloading location address for waybill / Adresse des Verladestandorts für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

        addressRecipient

object

recipient address for waybill / Empfängeradresse für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

        addressDestinationLocation

object

destination location address for waybill / Adresse des Entladestandorts für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

1.2 -

1.2.1 -

Property Type Description

(Root)

object

Interface for Status Update Data of Loading Units from Yard Management

    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: [ "LOADING_UNIT_STATUS" ]
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", "KMOTION_ERFURT", "LOGISTIKPUFFER" ]

        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 which provides the status
Yard for the message / Yard für den die Meldung ist (ILOWA)

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

        systemRegistration*

string (enum)

System of original Registration
sender system of advice / System aus dem die Registrierung übertragen wurde: HERIS, CARGOCLIX, RESY, …​

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

        yardEventType*

string

Yard event type
yard event / Ereignis (YARD_ARRIVAL, YARD_ENTRANCE, YARD_DEPARTURE, LOADING_START, LOADING_CANCEL, LOADING_END, UNLOADING_START, UNLOADING_CANCEL, UNLOADING_END, PARKING_POSITION, LEAVING_PARKING, TOURING)

Maximum Length: 25

        yardEventDateTime*

string (date-time)

Yard event occurence timestamp
actual time when the event occured / Zeitpunkt des Ereigniseintritts (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        yardAreaId

string

Yard area ID
ID of yard area / ID des Bereiches

Maximum Length: 50

        gateId

string

Gate ID
ID gate / ID des Tores

Maximum Length: 50

        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

        loadCarrierType

string

load Carrier Type
load carrier type / Typ des Ladungsträgers: WAB (swap body / Wechselaufbaubrücke), BUS, SATTEL (semi trailer / Sattelauflieger), LKW (truck), CT20 (Container 20 feet/Fuß), CT40 (Container 40 feet/Fuß)

Maximum Length: 25

        loadingNumber

string

Loading Number / Verladenummer
Loading number generated by system responsible for loading, e.g. WMS / Vom verladenden System, z.B. WMS generierte Verladenummer pro Verladung

Maximum Length: 25

        carrierId

string

Carrier ID
carrier ID / ID des Spediteurs

Maximum Length: 50

        ymsRegistrationId

string

YMS registration ID
id of registration in YMS / ID der Registrierung im YMS

Maximum Length: 50

        externalReferences

object

external references
References for loading units registered by external systems. Data from Y01 must be contained for loading units registered by external systems. No requirements for Loading units registered internally in YMS.

            typeReference

string

reference type
reference type referring to the system / Referenztyp bezugnehmend auf das externe System

Maximum Length: 50

            idReference1

string

external reference 1
external reference 1 / ID 1 der Referenz (CGX/HERIS/RESY-ID) (Bsp. HERIS Tournummer)

Maximum Length: 50

            idReference2

string

external reference 2
external reference 2 / Optional ID 2 der Referenz (CGX/HERIS/RESY-ID) (Bsp. HERIS Teilstreckennummer)

Maximum Length: 50

            idReference3

string

external reference 3
external reference 3 / Optional ID 3 der Referenz (CGX/HERIS/RESY-ID) (Bsp. HERIS Beladungsnummer)

Maximum Length: 50

            idReference4

string

external reference 4
external reference 4 / Optional ID 4 der Referenz (CGX/HERIS/RESY-ID)

Maximum Length: 50

            idReference5

string

external reference 5
external reference 5 / Optional ID 5 der Referenz (CGX/HERIS/RESY-ID)

Maximum Length: 50

            idReference6

string

external reference 6
external reference 6 / Optional ID 6 der Referenz (CGX/HERIS/RESY-ID)

Maximum Length: 50

        sealNumber1

string

Seal number 1
seal number 1 / Plombennummer 1

Maximum Length: 50

        sealNumber2

string

Seal number 2
seal number 2 / Plombennummer 2

Maximum Length: 50

        fillingRateInPercent

number (float)

Filling rate
filling rate of load carrier for outbound / Füllgrad der WAB bei WA in Prozent

Minimum: 0
Maximum: 1000

        departureReadinessDateTime

string (date-time)

departure readiness time
departure readiness time / Gestellungszeit (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        transport

object

            licensePlateTruck

string

License plate truck
license plate number of the truck / KFZ-Kennzeichen des LKWs bzw. der Zugmaschine (receiver YMS_KMOTION will accept formatted values and normalize them by removing spaces and special characters)

Maximum Length: 25

            licensePlateTrailer

string

License plate trailer
license plate number of the trailer / KFZ-Kennzeichen des Anhängers bzw. der Lafette (receiver YMS_KMOTION will accept formatted values and normalize them by removing spaces and special characters)

Maximum Length: 25

            driverName

string

Driver name
driver name / Name des Fahrers

Maximum Length: 100

            driverPhone

string

Driver phone
driver's mobile phone number / Telefonnummer des Fahrers

Maximum Length: 50

        additionalInfo

object

additional Information

            adviceType

string

Type of the LoadingUnitAdvcie to which this event refers
advice type: INBOUND, OUTBOUND / Typ der ursprünglichen Avisierung: INBOUND (Anlieferung), OUTBOUND (Abholung)

Maximum Length: 25

            internalTripNumber

string

internal trip number
internal trip number for partial routes between locations of the same yard / Teilstreckennummer für interne Teilstrecke zwischen Locations desselben Yards (e.g. HERIS)

Maximum Length: 50

        delay

object

            delayCategory

string

HERIS delay category

Maximum Length: 50

            delayComment

string

HERIS delay comment

Maximum Length: 500

1.2.2 -

Property Type Description

(Root)

object

Schema for proof of Transport Documents for departure of outgoing transports and arrival of incoming transports

    transportType

string

Type of Transnport related to the location
transport type: INBOUND, OUTBOUND, RETURNS (as special case of INBOUND)

Maximum Length: 25

    location*

string

location
location for which the proof of transport is created (locations as in https://docs.osp-fine.de/registry/MetaData/warehouselocations.v1.schema.json)

Maximum Length: 25

    loadingNumber

string

Loading Number
Loading number generated by system responsible for loading, e.g. WMS

Maximum Length: 25

    carrier

string

Carrier ID
carrier who carried out the transport

Maximum Length: 50

    transportNumber

string

carrier tour number
carrier tour number (e.g. for HG) or comparable reference

Maximum Length: 50

    transportDateTime*

object

        yardDepartureDateTime

string (date-time)

Yard Departure Date incl.timestamp
actual time of transpaort departure from location

        yardArrivalDateTime

string (date-time)

Yard Arrival Date incl.timestamp
actual time of transpaort departure frinom location

    loadCarrierId

string

Load carrier ID
load carrier ID (e.g. swap body number, container number, license plate)

Maximum Length: 50

    addressOriginLocation

object

origin location of transport

        addressName*

string

address name
address name

Maximum Length: 100

        addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

        addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

        addressCity*

string

address city
address city

Maximum Length: 100

        addressDistrict

string

address district
address district

Maximum Length: 100

        addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

    addressDestinationLocation

object

destination location address for waybill / Adresse des Entladestandorts für Frachtbrief

        addressName*

string

address name
address name

Maximum Length: 100

        addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

        addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

        addressCity*

string

address city
address city

Maximum Length: 100

        addressDistrict

string

address district
address district

Maximum Length: 100

        addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

1.3 -

1.3.1 -

Property Type Description

(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

1.4 - Y00 Yard Interface Overview

Status

v1.0.1, 30.01.2025

1. Informationflow

flow

1.5 - Y01 Loading Unit Advice

Status

v1.3, 22.09.2025

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

Yard

InterfaceOwner

FINE Yard

OSP

Producer

HERIS

Hermes Germany

Producer

Cargoclix via FINE Inbound

Cargoclix

Producer

RESY

OSP

Producer

WMS via FINE Inbound

OSP, Körber

Consumer

Yard-Management-System Körber

Körber

2. Business Context

A Yard Management controls all activities on the "outer" areas of the respective warehouse location. The main yard management activities include: Entry/Exit, scheduling, movements of load carriers on the site, weighing, loading/unloading, sealing/unsealing.

The "Loading Unit Advice" interface provides the Yard Mangemnt with the required information about the arriving or departing load carriers.

3. Informationflow

Information for the "Loading Unit Advice" is generated in different source systems. The data of the different source systems are converted by FINE to the format expected by Yard Management.

flow

[ options="header"]

Partner

Direction

FINE-Service

Topic/API

Description

Status

Hermes-Germany:HERIS

send

Yard

https

yardTourAssignmentRequest, yardTourAssignmentRevokedRequest, yardTourCancelledRequest

productive

Extern:Cargoclix

send

Inbound

DespatchAdviceBooking

productice

FINE:Inbound

send

Yard

inbound.despatchadvicebooking.out.yard.v1

DespatchAdviceBooking

productive

RESY

send

Yard

returns.loading.manifest.yard

LoadingManifest

productive

WMS

send

Inbound

Stock Transfer between warehouses

productive

FINE:Inbound

send

Yard

inbound.stocktransfer.out.yard.v2

Stock Transfer between warehouses

productive

YMS:Körber-YardMgmt

receive

Yard

https

LoadingUnitAdvice

productive

4. Interfaces

4.1. Direction HG to FINE - Yard Tour Assignment

The HG yard tour assignment interface will be used to advise especially return transfers, internal transfers between warehouses, outbound transports and other internal transports. The described HG formats will be converted into Direction FINE to Yard Management format.

4.1.1. Mapping for Y01

HG yardTourAssignmentRequest is converted to LOADING_UNIT_ADVICE_DATA message.

HG yardTourAssignmentRevokedRequest is converted to LOADING_UNIT_ADVICE_REVOKE message. It is a temporary revocation of the assigned tour which will be followed by

  • either a new assignment which can contain the same or changed data compared to original assignment

  • or a cancellation request which will finally cancel the revoked tour.

HG yardTourCancelledRequest will be converted to LOADING_UNIT_ADVICE_DELETE event.

4.1.1.1. Example
Details 
<?xml version="1.0" encoding="UTF-8"?>
<hlg:yardTourAssignmentRequest
	xmlns:hlg="http://hlg.de/tl/yard-tour-outbound-2.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://hlg.de/tl/yard-tour-outbound-2.0 /Users/nliebelt/work/sources/hermes/htl_hub_integration/hub-integration/src/main/resources/yard-outbound.xsd">
	<hlg:tour>
		<hlg:tourNumber>51231539</hlg:tourNumber>
		<hlg:carrier>
			<hlg:number>1</hlg:number>
			<hlg:name>HSV Systemverkehre GmbH</hlg:name>
			<hlg:matchCode>hsv</hlg:matchCode>		
		</hlg:carrier>	
		<hlg:truckType>
			<hlg:number>54</hlg:number>
			<hlg:name>WAB-LKW</hlg:name>
			<hlg:matchCode>wab</hlg:matchCode>		
		</hlg:truckType>
		<hlg:tourStatus>Abgerechnet</hlg:tourStatus>
		<hlg:trip>
			<hlg:tripNumber>529010874</hlg:tripNumber>
			<hlg:origin>
				<hlg:name>KS-Europe Ltd.</hlg:name>
				<hlg:matchCode>KATASTAHCZ</hlg:matchCode>
				<hlg:address>
					<hlg:street>Komenského</hlg:street>
					<hlg:houseNumber>598</hlg:houseNumber>
					<hlg:zipCode>332 03</hlg:zipCode>
					<hlg:city>Stahlavy</hlg:city>
					<hlg:district/>
					<hlg:country>CZ</hlg:country>
				</hlg:address>
			</hlg:origin>
			<hlg:scheduledCrewCheckinDateTime>2023-03-20T07:45:00+02:00</hlg:scheduledCrewCheckinDateTime>	
			<hlg:scheduledDepartureDateTime>2023-03-20T08:00:00+02:00</hlg:scheduledDepartureDateTime>
			<hlg:destination>
				<hlg:name>Otto Ilowa</hlg:name>
				<hlg:matchCode>HUBILOWPL</hlg:matchCode>
				<hlg:address>
					<hlg:street>Konin Żagański</hlg:street>
					<hlg:houseNumber>158</hlg:houseNumber>
					<hlg:zipCode>68-121</hlg:zipCode>
					<hlg:city>Iłowa</hlg:city>
					<hlg:district/>
					<hlg:country>PL</hlg:country>
				</hlg:address>
			</hlg:destination>
			<hlg:scheduledArrivalDateTime>2023-03-20T09:30:00+02:00</hlg:scheduledArrivalDateTime>
			<hlg:scheduledUnloadEndDateTime>2023-03-20T10:25:00+02:00</hlg:scheduledUnloadEndDateTime>
			<hlg:additionalInfoOrigin>
				<hlg:driverName>John Doe</hlg:driverName>
				<hlg:driverPhone>+481619988765</hlg:driverPhone>
				<hlg:licensePlateTruck>HH-HG 2047</hlg:licensePlateTruck>
				<hlg:licensePlateTrailer>HH-HG 8048</hlg:licensePlateTrailer>
			</hlg:additionalInfoOrigin>
			<hlg:additionalInfoDestination>
				<hlg:driverName>John Doe</hlg:driverName>
				<hlg:driverPhone>+481619988765</hlg:driverPhone>
				<hlg:licensePlateTruck>HH-HG 2047</hlg:licensePlateTruck>
				<hlg:licensePlateTrailer>HH-HG 8048</hlg:licensePlateTrailer>
			</hlg:additionalInfoDestination>
		</hlg:trip>	
		<hlg:cargo>
			<hlg:cargoNumber>52002860</hlg:cargoNumber>
			<hlg:tripNumber>529010874</hlg:tripNumber> 
			<hlg:containerType>
				<hlg:number>1</hlg:number>
				<hlg:name>WAB Standard</hlg:name>
				<hlg:matchCode>orwab</hlg:matchCode>		
			</hlg:containerType>
			<hlg:order>
				<hlg:orderNumber>45793002</hlg:orderNumber>
				<hlg:origin>
					<hlg:name>KS-Europe Ltd.</hlg:name>
					<hlg:matchCode>KATASTAHCZ</hlg:matchCode>
					<hlg:address>
						<hlg:street>Komenského</hlg:street>
						<hlg:houseNumber>598</hlg:houseNumber>
						<hlg:zipCode>332 03</hlg:zipCode>
						<hlg:city>Stahlavy</hlg:city>
						<hlg:district/>
						<hlg:country>CZ</hlg:country>
					</hlg:address>
				</hlg:origin>
				<hlg:earliestScheduledDepartureDateTime>2023-03-20T07:00:00+02:00</hlg:earliestScheduledDepartureDateTime>
				<hlg:latestScheduledDepartureDateTime>2023-03-20T08:00:00+02:00</hlg:latestScheduledDepartureDateTime>
				<hlg:articleType>
					<hlg:number>146</hlg:number>
					<hlg:name>Leercorletten</hlg:name>
					<hlg:matchCode>Leercorletten</hlg:matchCode>		
				</hlg:articleType>
				<hlg:weight>7500</hlg:weight>
				<hlg:loadingMeters>7</hlg:loadingMeters>
				<hlg:comment></hlg:comment>
				<hlg:orderType>
					<hlg:number>6</hlg:number>
					<hlg:name>06_Auslandsverkehre</hlg:name>
					<hlg:matchCode>06_Auslandsverkehre</hlg:matchCode>		
				</hlg:orderType>
				<hlg:destination>
					<hlg:name>Otto Ilowa</hlg:name>
					<hlg:matchCode>HUBILOWPL</hlg:matchCode>
					<hlg:address>
						<hlg:street>Konin Żagański</hlg:street>
						<hlg:houseNumber>158</hlg:houseNumber>
						<hlg:zipCode>68-121</hlg:zipCode>
						<hlg:city>Iłowa</hlg:city>
						<hlg:district/>
						<hlg:country>PL</hlg:country>
					</hlg:address>
				</hlg:destination>
				<hlg:earliestScheduledArrivalDateTime>2023-03-20T09:30:00+02:00</hlg:earliestScheduledArrivalDateTime>
				<hlg:latestScheduledArrivalDateTime>2023-03-20T10:30:00+02:00</hlg:latestScheduledArrivalDateTime>
			</hlg:order> 
			<hlg:containerIdentifier>432102</hlg:containerIdentifier>
			<hlg:sealIdentifier>9702102</hlg:sealIdentifier>
		</hlg:cargo>  
		<hlg:cargo>
			<hlg:cargoNumber>52002861</hlg:cargoNumber>
			<hlg:tripNumber>529010874</hlg:tripNumber> 
			<hlg:containerType>
				<hlg:number>1</hlg:number>
				<hlg:name>WAB Standard</hlg:name>
				<hlg:matchCode>orwab</hlg:matchCode>		
			</hlg:containerType>
			<hlg:order>
				<hlg:orderNumber>45793003</hlg:orderNumber>
				<hlg:origin>
					<hlg:name>KS-Europe Ltd.</hlg:name>
					<hlg:matchCode>KATASTAHCZ</hlg:matchCode>
					<hlg:address>
						<hlg:street>Komenského</hlg:street>
						<hlg:houseNumber>598</hlg:houseNumber>
						<hlg:zipCode>332 03</hlg:zipCode>
						<hlg:city>Stahlavy</hlg:city>
						<hlg:district/>
						<hlg:country>CZ</hlg:country>
					</hlg:address>
				</hlg:origin>
				<hlg:earliestScheduledDepartureDateTime>2023-03-20T07:00:00+02:00</hlg:earliestScheduledDepartureDateTime>
				<hlg:latestScheduledDepartureDateTime>2023-03-20T08:00:00+02:00</hlg:latestScheduledDepartureDateTime>
				<hlg:articleType>
					<hlg:number>146</hlg:number>
					<hlg:name>Leercorletten</hlg:name>
					<hlg:matchCode>Leercorletten</hlg:matchCode>		
				</hlg:articleType>
				<hlg:weight>7500</hlg:weight>
				<hlg:loadingMeters>7</hlg:loadingMeters>
				<hlg:comment></hlg:comment>
				<hlg:orderType>
					<hlg:number>6</hlg:number>
					<hlg:name>06_Auslandsverkehre</hlg:name>
					<hlg:matchCode>06_Auslandsverkehre</hlg:matchCode>		
				</hlg:orderType>
				<hlg:destination>
					<hlg:name>Otto Ilowa</hlg:name>
					<hlg:matchCode>HUBILOWPL</hlg:matchCode>
					<hlg:address>
						<hlg:street>Konin Żagański</hlg:street>
						<hlg:houseNumber>158</hlg:houseNumber>
						<hlg:zipCode>68-121</hlg:zipCode>
						<hlg:city>Iłowa</hlg:city>
						<hlg:district/>
						<hlg:country>PL</hlg:country>
					</hlg:address>
				</hlg:destination>
				<hlg:earliestScheduledArrivalDateTime>2023-03-20T09:30:00+02:00</hlg:earliestScheduledArrivalDateTime>
				<hlg:latestScheduledArrivalDateTime>2023-03-20T10:30:00+02:00</hlg:latestScheduledArrivalDateTime>
			</hlg:order> 
			<hlg:containerIdentifier>432103</hlg:containerIdentifier>
			<hlg:sealIdentifier>9702103</hlg:sealIdentifier>
		</hlg:cargo>  
	</hlg:tour>
	<hlg:auditInfo>
		<hlg:createdAt>2023-09-06T11:24:04+02:00</hlg:createdAt>
		<hlg:lastModifiedAt>2023-09-15T07:20:47+02:00</hlg:lastModifiedAt>
	</hlg:auditInfo>
</hlg:yardTourAssignmentRequest>

4.1.2. Schema

HG is responsible for the described schema. It is mentioned here for reference only.

Version Number File Published on Changes

current version

2.0

Download

13.09.2023

initial version

previous version

coming version

4.2. Direction Cargoclix to FINE - Despatch Advice Booking

Cargoclix will mainly advise inbound deliveries from suppliers. The Cargoclix format will be converted to Direction FINE to Yard Management format.

eventTypes INSERT and UPDATE are mapped to LOADING_UNIT_ADVICE_DATA, DELETE is mapped to LOADING_UNIT_ADVICE_DELETE.

Please refer to I02C Despatch Advice Booking for format definition.

4.3. Direction RESY to FINE - Loading Manifest

RESY "Loading Manifest" is intended to be used for

  • advices of returns transfers which are not transported by Hermes Germany (and advised via HERIS)

  • for enrichment of HERIS return advices, especially of attribute "deliveryType".

"Loading Manifest" will be converted to Direction FINE to Yard Management format. Only eventType LOADING_UNIT_ADVICE_DATA is supported.

Please refer to R05 Loading Manifest

Filter: Only data for agreed metadata/destination values (managed by Körber YMS) are mapped to Y01.

4.3.1. Data value ranges

4.3.1.1. RESY deliveryType (Anlieferarten) mapping to Körber
R05 container/type Y01 deliveryType Prio

PALLET

RET_PAL

1

BULKYBOX, EUROTAINER, CORLETTE

RET_BOX

2

SINGLE_BIN, DOUBLE_BIN

RET_MW

3

In case different conatiner types are present for one single load carrier, the deliveryType mapping of the container type having the lowest priority is used.

4.4. Direction WMS to FINE - Stock Transfer between warehouses

"Stock Transfer" interface is intended to be used for

  • advices of internal transfers between warehouses which are not transported by Hermes Germany (and advised via HERIS)

  • for enrichment of HERIS inbound transfer advices, especially of attribute "deliveryType".

"Stock Transfer" interface will be converted to Direction FINE to Yard Management format. Only eventType LOADING_UNIT_ADVICE_DATA is supported.

Please refer to I19 Stock Transfer

Filter: Only data for agreed locationTarget values (managed by Körber YMS) are mapped to Y01.

4.5. Direction FINE to Yard Management

"Loading Unit Advice" to Yard Management is the unified interface to send information of all sources to Yard Managment System. Yard Managment System will be provided with data for the respective yard only.

4.5.1. Header

This interface uses the Service Header

Special values for this interface:

Fieldname Expresion

context

YARD

eventType

LOADING_UNIT_ADVICE_DATA, LOADING_UNIT_ADVICE_DELETE

4.5.2. Datamodel

4.5.2.1. Version 1.1
Property Type Description

(Root)

object

Interface for Advice of Loading Units for Yard Management

    eventId*

string (uuid)

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    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

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)
Determines whether a loading unit advice is 1) created or changed or 2) marked as deleted

Any of: [ "LOADING_UNIT_ADVICE_DATA", "LOADING_UNIT_ADVICE_DELETE", "LOADING_UNIT_ADVICE_REVOKE" ]
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.

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

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

Minimum: 1
Maximum: 999999999

        messageCount

integer

how many messages are to be transferred in this batch

Minimum: 1
Maximum: 999999999

    data*

object

        systemRegistration*

string (enum)

System which registers the advice
sender system of advice / System aus dem die Registrierung übertragen wurde: HERIS, CARGOCLIX, RESY, …​

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

        yard*

string (enum)

Yard for the advice
yard for wich the advice is intended / Yard für welches die Ankündigung relevant ist

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

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

        arrivalSlotStartDateTime*

string (date-time)

Arrival slot start time
start date+time of announced arrival time slot / Datum, Uhrzeit ab dem der Ladungsträger erwartet wird (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        arrivalSlotEndDateTime

string (date-time)

Arrival slot end time
end date+time of announced arrival time slot / Datum, Uhrzeit bis zu dem der Ladungsträger erwartet wird (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        adviceType*

string (enum)

Advice Type
advice type: INBOUND, OUTBOUND / Typisierung: INBOUND (Anlieferung), OUTBOUND (Abholung)

Any of: [ "INBOUND", "OUTBOUND" ]
Maximum Length: 25

        inbound

object

            deliveryType

string

Delivery type
delivery type (new items single SKU boxes, returns, transfer) / Art der Anlieferung (Neuware SKU-rein, Retoure, Umfuhr)

Maximum Length: 25

            transportOriginRelation

string

Origin Relation
origin of the transport - needed for inbound / Start des Transportes (Matchcode)

Maximum Length: 50

            transportDestinationRelationGoods

string

Destination relation
destination of the transport for inbound (for detection of transit transports) / Ziel des Transportes bei WE (für Erkennung von Transitverkehren)

Maximum Length: 50

            supplier

string

Supplier
Supplier for display on gate display (inbound) / Lieferant für Anzeige auf Tordisplay (WE)

Maximum Length: 50

        outbound

object

            departureTargetDateTime

string (date-time)

target departure time
target departure time for outbound / Optional bei WA wann der Ladungsträger das Yard verlassen soll (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

            departureReadinessDateTime

string (date-time)

departure readiness time
departure readiness time (for waybill printing) / Gestellungszeit (für Frachtbriefdruck) (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

            transportDestinationRelation

string

destination relation
destination of the transport - needed for outbound / Ziele des Transportes - relevant für WA

Maximum Length: 50

            destinationTargetArrivalDateTime

string (date-time)

Expected Arrival time at destination
Expected Arrival time at destination / Soll-Ankunftszeit Ziel (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        loadCarrier*

object

            loadCarrierId

string

load Carrier ID
load carrier ID (swap body number, container ID, license plate number of the truck, …​) / ID des Ladungsträgers (Brückennummer, Containernummer, KFZ-Kennz. bei LKW, …​)

Maximum Length: 50

            loadCarrierType*

string

load Carrier Type
load carrier type / Typ des Ladungsträgers: WAB (swap body / Wechselaufbaubrücke), BUS, SATTEL (semi trailer / Sattelauflieger), LKW (truck), CT20 (Container 20 feet/Fuß), CT40 (Container 40 feet/Fuß)

Maximum Length: 25

            loadCarrierTruckConsolidation

string

load carrier consolidation truck + trailer
consolidate 2 load carriers which are delivered with the same truck / Klammer bei Avisierung von 2 Ladungsträgern, die mit einem LKW geliefert werden.

Maximum Length: 50

        transport

object

            licensePlateTruck

string

License plate truck
license plate number of the truck / KFZ-Kennzeichen des LKWs bzw. der Zugmaschine (receiver YMS_KMOTION will accept formatted values and normalize them by removing spaces and special characters)

Maximum Length: 25

            licensePlateTrailer

string

License plate trailer
license plate number of the trailer / KFZ-Kennzeichen des Anhängers bzw. der Lafette (receiver YMS_KMOTION will accept formatted values and normalize them by removing spaces and special characters)

Maximum Length: 25

            driverName

string

Driver name
driver name / Name des Fahrers

Maximum Length: 100

            driverPhone

string

Driver phone
driver's mobile phone number / Telefonnummer des Fahrers

Maximum Length: 50

            driverLanguage

string

Driver Language
driver's language / Sprache des Fahrers (ISO coded, preferable 639-1)

Maximum Length: 50

        carrier

object

            carrierId

string

Carrier ID
carrier ID / ID des Spediteurs

Maximum Length: 50

            subCarrierId

string

Carrier subcontractor ID
ID of carrier's subcontractor / ID des Subauftragnehmers des Spediteurs

Maximum Length: 50

        comment

string

Free comment
free comment / freies Bermerkungsfeld

Maximum Length: 1000

        sealNumber

string

Seal number
seal number / Plombennummer

Maximum Length: 50

        externalReferences*

object

external references

            typeReference*

string

reference type
reference type referring to the system / Referenztyp bezugnehmend auf das externe System (z.B. TOUR, BOOKID, LOADING_MANIFEST, WMS_ORDER)

Maximum Length: 50

            idReference1*

string

external reference 1
external reference 1 / externe ID 1 der Referenz (Bsp. HERIS Tournummer, CCX BookID, Resy loadingNumber, wmsOrderId)

Maximum Length: 50

            idReference2

string

external reference 2
external reference 2 / optionale externe ID 2 der Referenz (Bsp. HERIS Teilstreckennummer)

Maximum Length: 50

            idReference3

string

external reference 3
external reference 3 / optionale externe ID 3 der Referenz (Bsp. HERIS Beladungsnummer)

Maximum Length: 50

            idReference4

string

external reference 4
external reference 4 / optionale externe ID 4 der Referenz

Maximum Length: 50

            idReference5

string

external reference 5
external reference 5 / optionale externe ID 5 der Referenz

Maximum Length: 50

            idReference6

string

external reference 6
external reference 6 / optionale externe ID 6 der Referenz

Maximum Length: 50

        yardEntranceId

string

Yard entrance ID
optional ID for driver's identification (security check) / Optionale ID mit der der Fahrer sich im Pfortenprozess identifiziert

Maximum Length: 50

        additionalInfo

object

additional Information

            internalTripNumber

string

internal trip number
internal trip number for partial routes between locations of the same yard / Teilstreckennummer für interne Teilstrecke zwischen Locations desselben Yards (e.g. HERIS)

Maximum Length: 50

            loadingNumber

string

Loading Number / Verladenummer
Loading number generated by system responsible for loading, e.g. WMS / Vom verladenden System, z.B. WMS generierte Verladenummer pro Verladung

Maximum Length: 25

        addressShipper

object

shipper address for waybill / Versenderadresse für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

        addressOriginLocation

object

originloading location address for waybill / Adresse des Verladestandorts für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

        addressRecipient

object

recipient address for waybill / Empfängeradresse für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

        addressDestinationLocation

object

destination location address for waybill / Adresse des Entladestandorts für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2
4.5.2.2. Version 1.2
Property Type Description

(Root)

object

Interface for Advice of Loading Units for Yard Management

    eventId*

string (uuid)

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    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

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)
Determines whether a loading unit advice is 1) created or changed or 2) marked as deleted

Any of: [ "LOADING_UNIT_ADVICE_DATA", "LOADING_UNIT_ADVICE_DELETE", "LOADING_UNIT_ADVICE_REVOKE" ]
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.

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

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

Minimum: 1
Maximum: 999999999

        messageCount

integer

how many messages are to be transferred in this batch

Minimum: 1
Maximum: 999999999

    data*

object

        systemRegistration*

string (enum)

System which registers the advice
sender system of advice / System aus dem die Registrierung übertragen wurde: HERIS, CARGOCLIX, RESY, …​

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

        yard*

string (enum)

Yard for the advice
yard for wich the advice is intended / Yard für welches die Ankündigung relevant ist

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

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

        arrivalSlotStartDateTime*

string (date-time)

Arrival slot start time
start date+time of announced arrival time slot / Datum, Uhrzeit ab dem der Ladungsträger erwartet wird (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        arrivalSlotEndDateTime

string (date-time)

Arrival slot end time
end date+time of announced arrival time slot / Datum, Uhrzeit bis zu dem der Ladungsträger erwartet wird (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        adviceType*

string (enum)

Advice Type
advice type: INBOUND, OUTBOUND / Typisierung: INBOUND (Anlieferung), OUTBOUND (Abholung)

Any of: [ "INBOUND", "OUTBOUND" ]
Maximum Length: 25

        inbound

object

            deliveryType

string

Delivery type
delivery type (new items single SKU boxes, returns, transfer) / Art der Anlieferung (Neuware SKU-rein, Retoure, Umfuhr)

Maximum Length: 25

            transportOriginRelation

string

Origin Relation
origin of the transport - needed for inbound / Start des Transportes (Matchcode)

Maximum Length: 50

            transportDestinationRelationGoods

string

Destination relation
destination of the transport for inbound (for detection of transit transports) / Ziel des Transportes bei WE (für Erkennung von Transitverkehren)

Maximum Length: 50

            supplier

string

Supplier
Supplier for display on gate display (inbound) / Lieferant für Anzeige auf Tordisplay (WE)

Maximum Length: 50

        outbound

object

            deliveryType

string

Delivery type
delivery type (especially empty transport) / Art der Abholung (insbesondere Leertransport)

Maximum Length: 25

            departureTargetDateTime

string (date-time)

target departure time
target departure time for outbound / Optional bei WA wann der Ladungsträger das Yard verlassen soll (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

            departureReadinessDateTime

string (date-time)

departure readiness time
departure readiness time (for waybill printing) / Gestellungszeit (für Frachtbriefdruck) (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

            transportDestinationRelation

string

destination relation
destination of the transport - needed for outbound / Ziele des Transportes - relevant für WA

Maximum Length: 50

            destinationTargetArrivalDateTime

string (date-time)

Expected Arrival time at destination
Expected Arrival time at destination / Soll-Ankunftszeit Ziel (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        loadCarrier*

object

            loadCarrierId

string

load Carrier ID
load carrier ID (swap body number, container ID, license plate number of the truck, …​) / ID des Ladungsträgers (Brückennummer, Containernummer, KFZ-Kennz. bei LKW, …​)

Maximum Length: 50

            loadCarrierType*

string

load Carrier Type
load carrier type / Typ des Ladungsträgers: WAB (swap body / Wechselaufbaubrücke), BUS, SATTEL (semi trailer / Sattelauflieger), LKW (truck), CT20 (Container 20 feet/Fuß), CT40 (Container 40 feet/Fuß)

Maximum Length: 25

            loadCarrierTruckConsolidation

string

load carrier consolidation truck + trailer
consolidate 2 load carriers which are delivered with the same truck / Klammer bei Avisierung von 2 Ladungsträgern, die mit einem LKW geliefert werden.

Maximum Length: 50

        transport

object

            licensePlateTruck

string

License plate truck
license plate number of the truck / KFZ-Kennzeichen des LKWs bzw. der Zugmaschine (receiver YMS_KMOTION will accept formatted values and normalize them by removing spaces and special characters)

Maximum Length: 25

            licensePlateTrailer

string

License plate trailer
license plate number of the trailer / KFZ-Kennzeichen des Anhängers bzw. der Lafette (receiver YMS_KMOTION will accept formatted values and normalize them by removing spaces and special characters)

Maximum Length: 25

            driverName

string

Driver name
driver name / Name des Fahrers

Maximum Length: 100

            driverPhone

string

Driver phone
driver's mobile phone number / Telefonnummer des Fahrers

Maximum Length: 50

            driverLanguage

string

Driver Language
driver's language / Sprache des Fahrers (ISO coded, preferable 639-1)

Maximum Length: 50

        carrier

object

            carrierId

string

Carrier ID
carrier ID / ID des Spediteurs

Maximum Length: 50

            subCarrierId

string

Carrier subcontractor ID
ID of carrier's subcontractor / ID des Subauftragnehmers des Spediteurs

Maximum Length: 50

        comment

string

Free comment
free comment / freies Bermerkungsfeld

Maximum Length: 1000

        sealNumber

string

Seal number
seal number / Plombennummer

Maximum Length: 50

        externalReferences*

object

external references

            typeReference*

string

reference type
reference type referring to the system / Referenztyp bezugnehmend auf das externe System (z.B. TOUR, BOOKID, LOADING_MANIFEST, WMS_ORDER)

Maximum Length: 50

            idReference1*

string

external reference 1
external reference 1 / externe ID 1 der Referenz (Bsp. HERIS Tournummer, CCX BookID, Resy loadingNumber, wmsOrderId)

Maximum Length: 50

            idReference2

string

external reference 2
external reference 2 / optionale externe ID 2 der Referenz (Bsp. HERIS Teilstreckennummer)

Maximum Length: 50

            idReference3

string

external reference 3
external reference 3 / optionale externe ID 3 der Referenz (Bsp. HERIS Beladungsnummer)

Maximum Length: 50

            idReference4

string

external reference 4
external reference 4 / optionale externe ID 4 der Referenz

Maximum Length: 50

            idReference5

string

external reference 5
external reference 5 / optionale externe ID 5 der Referenz

Maximum Length: 50

            idReference6

string

external reference 6
external reference 6 / optionale externe ID 6 der Referenz

Maximum Length: 50

        yardEntranceId

string

Yard entrance ID
optional ID for driver's identification (security check) / Optionale ID mit der der Fahrer sich im Pfortenprozess identifiziert

Maximum Length: 50

        additionalInfo

object

additional Information

            internalTripNumber

string

internal trip number
internal trip number for partial routes between locations of the same yard / Teilstreckennummer für interne Teilstrecke zwischen Locations desselben Yards (e.g. HERIS)

Maximum Length: 50

            loadingNumber

string

Loading Number / Verladenummer
Loading number generated by system responsible for loading, e.g. WMS / Vom verladenden System, z.B. WMS generierte Verladenummer pro Verladung

Maximum Length: 25

        addressShipper

object

shipper address for waybill / Versenderadresse für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

        addressOriginLocation

object

originloading location address for waybill / Adresse des Verladestandorts für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

        addressRecipient

object

recipient address for waybill / Empfängeradresse für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

        addressDestinationLocation

object

destination location address for waybill / Adresse des Entladestandorts für Frachtbrief

            addressName*

string

address name
address name

Maximum Length: 100

            addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

            addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

            addressCity*

string

address city
address city

Maximum Length: 100

            addressDistrict

string

address district
address district

Maximum Length: 100

            addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

4.5.3. Data value ranges

4.5.3.1. deliveryType (Anlieferarten) Körber

In case FINE receives values which are either unknown (HERIS) or cannot be mapped to agreed deliveryType (Stock Transfer), the agreed behaviour is to send no deliveryType to Körber YMS.

deliveryType Beschreibung description

NW_SKU_R_PAL

Neuware, SKU rein, palettiert

new goods, single SKU, palletized

NW_LOSE_MK

Neuware lose Mischkolli

new goods, loose, mixed SKU cartons

NW_SKU_R_KOLL

Neuware Sku-reine Kolli

new goods, single SKU cartons

NW_MP

Neuware Mischpalette

new goods, mixed SKU pallets

NW_LOSE

Neuware lose Artikel

new goods, loose articles

RET_MW

Retoure, Mischwanne

returns, mixes bin

RET_PAL

Retouren auf Paletten

returns, pallets

RET_BOX

Retouren Boxtainer

returns, boxtainer

UMF_KOLLI

Umfuhren Kolli

transfer, cartons

UMF_RET_MW

Umfuhren in Retourenmischwanne

transfer, returns mixed bin

UMF_PAL

Umfuhren Palette

transfer, pallets

UMF_BOX

Umfuhren Boxtainer

transfer, boxtainer

BHM_EXT

Betriebsmittel, externer Transport

operating equipement (cartons, labels), external transport

BHM_INT

Betriebsmittel, interner Transport

operating equipement (cartons, labels), external transport

LHM

Ladehilfsmittel

loading equipment (pallets, return bins, boxtainer)

LEER

Leerer Ladungsträger

empty loading unit

KEP

KEP-Dienstleister

KEP service provider

4.5.4. Köber YMS Key for Identification of Registrations for Update or Deletion

data/systemRegistration + all References in data/externalReferences* are the key to identitfy a registration

  • for updating registration information using a further LOADING_UNIT_ADVICE_DATA event

  • or deletion of a registartion using a LOADING_UNIT_ADVICE_DELETE event

4.5.5. Examples

4.5.5.1. Inbound Advice (new items, Cargoclix)
Details 
{
    "eventId": "00ce536f-923a-42f4-8128-be118faf1d87",
    "traceId": "00ce536f-923a-42f4-8128-be118faf1d85",
    "spanId": "",
    "eventTime": "2016-04-16T16:06:05.008+02:00",
    "eventType": "LOADING_UNIT_ADVICE_DATA",
    "version": "1.0",
    "context": "YARD",
    "data": {
        "systemRegistration": "CARGOCLIX",
        "yard": "ILOWA",
        "location": "ILOWA",
        "adviceType": "INBOUND",
        "arrivalSlotStartDateTime": "2023-03-20T09:30:00+02:00",
        "arrivalSlotEndDateTime": "2023-03-20T10:59:00+02:00",
        "inbound": {
          "deliveryType": "NW_SKU_R_PAL",
          "supplier": "Samsung Electronics GmbH"
        },
        "loadCarrier": {
            "loadCarrierId": "905603311",
            "loadCarrierType": "LKW"
        },
        "transport":{
          "licensePlateTruck": "HH-HG 2023",
          "driverName": "John Doe",
          "driverPhone": "+481619988765",
          "driverLanguage": "pl"
        },
        "carrier": {
          "carrierId": "DACHSER"
        },
        "externalReferences": {
           "typeReference":"BOOKID",
           "idReference1": "37688865",
           "idReference1": "1"
        }
    }
}
4.5.5.2. Inbound Advice (returns, truck+trailer, HG)
Details 
{
    "eventId": "00ce536f-923a-42f4-8128-be118faf1d87",
    "traceId": "00ce536f-923a-42f4-8128-be118faf1d85",
    "spanId": "",
    "eventTime": "2023-02-16T16:06:05.008+02:00",
    "eventType": "LOADING_UNIT_ADVICE_DATA",
    "version": "1.0",
    "context": "YARD",
    "data": {
        "systemRegistration": "HERIS",
        "yard": "ILOWA",
        "location": "ILOWA",
        "adviceType": "INBOUND",
        "arrivalSlotStartDateTime": "2023-03-20T09:30:00+02:00",
        "inbound": {
          "transportOriginRelation": "KATASTAHCZ",
          "transportDestinationRelationGoods": "HUBILOWPL"
        },
        "outbound": {
          "departureReadinessDateTime": "2023-09-07T07:45:00.000+02:00"
        },
        "loadCarrier": {
            "loadCarrierId": "170560",
            "loadCarrierType": "WAB",
            "loadCarrierTruckConsolidation": "51231539_0930"
        },
        "transport":{
          "licensePlateTruck": "HH-HG 2047",
          "licensePlateTrailer": "HH-HG 8048",
          "driverName": "John Doe",
          "driverPhone": "+481619988765"
        },
        "carrier": {
          "carrierId": "HG",
          "subCarrierId": "hsv"
        },
        "externalReferences": {
           "typeReference":"TOUR",
           "idReference1": "51231539",
           "idReference2": "529010874",
           "idReference3": "52002860"
        },
        "addressOriginLocation": {
          "addressName": "KS-Europe Ltd.",
          "addressStreet": "Komenského 598",
          "addressZipcode": "332 03",
          "addressCity": "Šťáhlavy",
          "addressCountryIso": "CZ"
        },
        "addressDestinationLocation": {
          "addressName": "Otto Ilowa",
          "addressStreet": "Konin Żagański 158",
          "addressZipcode": "68-121",
          "addressCity": "Iłowa",
          "addressCountryIso": "PL"
        }
    }
}

{
  "eventId": "00ce536f-923a-42f4-8128-be118faf1d88",
  "traceId": "00ce536f-923a-42f4-8128-be118faf1d86",
  "spanId": "",
  "eventTime": "2016-04-16T16:06:05.008+02:00",
  "eventType": "LOADING_UNIT_ADVICE_DATA",
  "version": "1.0",
  "context": "YARD",
  "sender": "HERIS",
  "data": {
      "systemRegistration": "HERIS",
      "yard": "ILOWA",
      "location": "ILOWA",
      "adviceType": "INBOUND",
      "arrivalSlotStartDateTime": "2023-03-20T09:30:00+02:00"
      "inbound": {
        "transportOriginRelation": "KATASTAHCZ",
        "transportDestinationRelationGoods": "HUBILOWPL"
      },
      "outbound": {
        "departureReadinessDateTime": "2023-09-07T07:45:00.000+02:00"
      },
      "loadCarrier": {
          "loadCarrierId": "17056033",
          "loadCarrierType": "WAB",
          "loadCarrierTruckConsolidation": "51231539_0930"
      },
      "transport":{
        "licensePlateTruck": "HH-HG 2047",
        "licensePlateTrailer": "HH-HG 8048",
        "driverName": "John Doe",
        "driverPhone": "+481619988765"
      },
      "carrier": {
        "carrierId": "HG"
      },
      "externalReferences": {
        "typeReference":"TOUR",
        "idReference1": "51231539",
        "idReference2": "529010874",
        "idReference3": "52002861",
        "idReference4": "45793002"
      },
      "addressOriginLocation": {
        "addressName": "KS-Europe Ltd.",
        "addressStreet": "Komenského 598",
        "addressZipcode": "332 03",
        "addressCity": "Stahlavy",
        "addressCountryIso": "CZ"
      },
      "addressDestinationLocation": {
        "addressName": "Otto Ilowa",
        "addressStreet": "Konin Żagański 158",
        "addressZipcode": "68-121",
        "addressCity": "Iłowa",
        "addressCountryIso": "PL"
      }
  }
}
4.5.5.3. Inbound Advice (mapped from RESY)
Details 
{
    "eventId": "00ce536f-923a-42f4-8128-be118faf1d87",
    "traceId": "00ce536f-923a-42f4-8128-be118faf1d85",
    "spanId": "",
    "eventTime": "2023-06-05T16:20:19.235+02:00",
    "eventType": "LOADING_UNIT_ADVICE_DATA",
    "version": "1.0",
    "context": "YARD",
    "data": {
        "systemRegistration": "RESY",
        "yard": "ILOWA",
        "location": "ILOWA",
        "adviceType": "INBOUND",
        "arrivalSlotStartDateTime": "2023-03-20T09:30:00+02:00",
        "inbound": {
          "deliveryType": "RET_MW"
        },
        "loadCarrier": {
            "loadCarrierId": "905603313",
            "loadCarrierType": "WAB"
        },
        "transport":{
          "licensePlateTruck": "HH-HG 2023"
        },
        "externalReferences": {
           "typeReference":"LOADING_MANIFEST",
           "idReference1": "00002363"
        },
        "additionalInfo": {
            "loadingNumber": "00002363"
        }
    }
}

{
  "eventId": "00ee536f-923a-42f4-8128-be118faf1d87",
  "traceId": "00ee536f-923a-42f4-8128-be118faf1d85",
  "spanId": "",
  "eventTime": "2023-06-05T16:20:19.235+02:00",
  "eventType": "LOADING_UNIT_ADVICE_DATA",
  "version": "1.0",
  "context": "YARD",
  "sender": "RESY",
  "data": {
      "systemRegistration": "RESY",
      "yard": "ILOWA",
      "location": "ILOWA",
      "adviceType": "INBOUND",
      "arrivalSlotStartDateTime": "2023-03-20T09:30:00+02:00",
      "inbound": {
        "deliveryType": "RET_PAL"
      },
      "loadCarrier": {
          "loadCarrierType": "WAB"
      },
      "externalReferences": {
         "idExternalReference":"LOADING_MANIFEST",
         "idReference1": "v"
      },
      "additionalInfo": {
          "loadingNumber": "00001816"
      }
  }
}
4.5.5.4. Inbound Advice (mapped from Stock Transfer)
Details 
{
    "eventId": "00ce536f-923a-42f4-8128-be118faf1d87",
    "traceId": "00ce536f-923a-42f4-8128-be118faf1d85",
    "spanId": "",
    "eventTime": "2016-04-16T16:06:05.008+02:00",
    "eventType": "LOADING_UNIT_ADVICE_DATA",
    "version": "1.0",
    "context": "YARD",
    "data": {
        "systemRegistration": "KR1_HHSTR",
        "yard": "ILOWA",
        "location": "ILOWA",
        "adviceType": "INBOUND",
        "arrivalSlotStartDateTime": "2023-03-20T09:30:00+02:00",
        "inbound": {
          "deliveryType": "UMF_KOLLI"
        },
        "loadCarrier": {
            "loadCarrierId": "905603313",
            "loadCarrierType": "WAB"
        },
        "externalReferences": {
           "typeReference":"WMS_ORDER",
           "idReference1": "390c4f5c-20b9-11ed-861d-0242ac120002",
           "idReference2": "905603313"
        },
        "additionalInfo": {
            "loadingNumber": "01234567"
        }
    }
}
4.5.5.5. Outbound Advice (HG)
Details 
{
    "eventId": "00ce536f-923a-42f4-8128-ce118faf1d88",
    "traceId": "00ce536f-923a-42f4-8128-ce118faf1d86",
    "spanId": "",
    "eventTime": "2023-02-16T16:06:05.002+02:00",
    "eventType": "LOADING_UNIT_ADVICE_DATA",
    "version": "1.0",
    "context": "YARD",
    "data": {
        "systemRegistration": "HERIS",
        "yard": "ILOWA",
        "location": "ILOWA",
        "adviceType": "OUTBOUND",
        "arrivalSlotStartDateTime": "2023-03-20T09:30:00+02:00",
        "outbound": {
          "departureTargetDateTime": "2023-03-20T10:15:00+02:00",
          "departureReadinessDateTime": "2023-03-20T10:00:00+02:00",
          "transportDestinationRelation": "HUBRELEX5"
        },
        "loadCarrier": {
          "loadCarrierId": "905604711",
          "loadCarrierType": "SATTEL"
        },
        "transport": {
          "licensePlateTruck": "HH-WA 2023",       
          "driverName": "Jane Doe"
        },
        "carrier": {
          "carrierId": "HG",
          "subCarrierId": "123 International Transports"
        },
        "sealNumber": "12345",
        "externalReferences": {
           "typeReference":"TOUR",
           "idReference1": "31231539",
           "idReference2": "42424324",
           "idReference3": "75455755"
        },
        "addressOriginLocation": {
          "addressName": "Otto CT Park Iłowa",
          "addressStreet": "Konin Żagański 158",
          "addressZipcode": "68-121",
          "addressCity": "Iłowa",
          "addressCountryIso": "PL"
        },
        "addressDestinationLocation": {
          "addressName": "Evri",
          "addressStreet": "Capitol House,1 Capitol Close",
          "addressZipcode": "LS27 OWH",
          "addressCity": "Morley, Leeds",
          "addressCountryIso": "GB"
        }
    }
}
4.5.5.6. Outbound Advice (HG, empty, v1.2)
Details 
{
    "eventId": "00ce536f-923a-42f4-8128-ce118faf1d88",
    "traceId": "00ce536f-923a-42f4-8128-ce118faf1d86",
    "spanId": "",
    "eventTime": "2025-02-16T16:06:05.002+02:00",
    "eventType": "LOADING_UNIT_ADVICE_DATA",
    "version": "1.2",
    "context": "YARD",
    "data": {
        "systemRegistration": "HERIS",
        "yard": "ILOWA",
        "location": "ILOWA",
        "adviceType": "OUTBOUND",
        "arrivalSlotStartDateTime": "2025-03-20T09:30:00+02:00",
        "outbound": {
          "deliveryType": "LEER",
          "departureTargetDateTime": "2025-03-20T10:15:00+02:00",
          "departureReadinessDateTime": "2025-03-20T10:00:00+02:00",
          "transportDestinationRelation": "hubhaldd"
        },
        "loadCarrier": {
          "loadCarrierId": "404040",
          "loadCarrierType": "WAB"
        },
        "transport": {
          "licensePlateTruck": "HH-WA 2025",       
          "driverName": "Jane Doe"
        },
        "carrier": {
          "carrierId": "HG",
          "subCarrierId": "Diebel"
        },
        "sealNumber": "12345",
        "externalReferences": {
           "typeReference":"TOUR",
           "idReference1": "31231524",
           "idReference2": "42424325",
           "idReference3": "75455756"
        },
        "addressOriginLocation": {
          "addressName": "Otto CT Park Iłowa",
          "addressStreet": "Konin Żagański 158",
          "addressZipcode": "68-121",
          "addressCity": "Iłowa",
          "addressCountryIso": "PL"
        },
        "addressDestinationLocation": {
          "addressName": "HAB Haldensleben GmbH",
          "addressStreet": "Hamburger Straße 1",
          "addressZipcode": "39340",
          "addressCity": "Haldensleben",
          "addressCountryIso": "DE"
        }
    }
}
4.5.5.7. Revocation (HG)
Details 
{
  "eventId": "2e5fa957-0dee-4456-b28e-a7736df06f1b",
  "traceId": "a49ae3cb-4afa-44fd-aa95-8d24a687d137",
  "eventTime": "2024-07-18T22:47:20.800+00:00",
  "version": "1.0",
  "context": "YARD",
  "eventType": "LOADING_UNIT_ADVICE_REVOKE",
  "data": {
    "systemRegistration": "HERIS",
    "yard": "ILOWA",
    "location": "ILOWA_RT",
    "arrivalSlotStartDateTime": "2024-07-19T09:15:00.000+02:00",
    "adviceType": "OUTBOUND",
    "inbound": {

    },
    "outbound": {
      "departureTargetDateTime": "2024-07-19T09:45:00.000+02:00"
    },
    "loadCarrier": {
      "loadCarrierType": "WAB",
      "loadCarrierTruckConsolidation": "926172450915ILOWA_RT"
    },
    "transport": {
      "licensePlateTruck": "HG-MD 1234",
      "licensePlateTrailer": "HG-MD5678",
      "driverName": "Schmidt"
    },
    "carrier": {
      "carrierId": "HG",
      "subCarrierId": "hsv (ohne shuttle)"
    },
    "externalReferences": {
      "typeReference": "TOUR",
      "idReference1": "92617245",
      "idReference2": "987018231",
      "idReference3": "913568213"
    }
  }
}
4.5.5.8. Cancellation/Deletion (HG)
Details 
{
  "eventId": "2e5fa957-0dee-4456-b28e-a7736df06f1b",
  "traceId": "a49ae3cb-4afa-44fd-aa95-8d24a687d137",
  "eventTime": "2024-07-18T22:47:20.800+00:00",
  "version": "1.0",
  "context": "YARD",
  "eventType": "LOADING_UNIT_ADVICE_DELETE",
  "data": {
    "systemRegistration": "HERIS",
    "yard": "ILOWA",
    "location": "ILOWA_RT",
    "arrivalSlotStartDateTime": "2024-07-19T09:15:00.000+02:00",
    "adviceType": "OUTBOUND",
    "inbound": {

    },
    "outbound": {
      "departureTargetDateTime": "2024-07-19T09:45:00.000+02:00"
    },
    "loadCarrier": {
      "loadCarrierType": "WAB",
      "loadCarrierTruckConsolidation": "926172450915ILOWA_RT"
    },
    "transport": {
      "licensePlateTruck": "HG-MD 1234",
      "licensePlateTrailer": "HG-MD5678",
      "driverName": "Schmidt"
    },
    "carrier": {
      "carrierId": "HG",
      "subCarrierId": "hsv (ohne shuttle)"
    },
    "externalReferences": {
      "typeReference": "TOUR",
      "idReference1": "92617245",
      "idReference2": "987018231",
      "idReference3": "913568213"
    }
  }
}

4.5.6. Schema

Version Number File Published on Changes

coming version

1.2

LoadingUnitAdvice.v1.2.schema.json

11.03.2025

data/outbound/deliveryType added to enable empty outbound detection

current version

1.1

LoadingUnitAdvice.v1.1.schema.json

31.07.2024

new eventType LOADING_UNIT_ADVICE_REVOKE - logic change for HG revocation mapping

Previous version

1.0

LoadingUnitAdvice.v1.0.schema.json

20.11.2023

location, additionalInfo added

1.6 - Y02 Loading Unit Status

Status

v1.0.2, 13.02.2025

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

Yard

InterfaceOwner

FINE Yard

OSP

Producer

YMS Körber

Körber

Consumer

HERIS

Hermes Germany

Consumer

HG BI

Hermes Germany

Consumer

Flash

2. Business Context

Yard Management Systems control all activities on the "outer" areas of the respective warehouse location. The main yard management activities include: Entry/Exit, scheduling, movements of load carriers on the site, weighing, loading/unloading, sealing/unsealing. In addition, Yard Management collects and evaluates all information about trucks on the site and passes it to the BI system-FLASH.

Yard-Management sends the required status change data for advised load carriers via interface Loading Unit Status. This status information includes:

  • actually used yard area and gate

  • event type and time stamp

  • seal numbers

3. Informationflow

Partner Direction FINE-Service Topic/API Description Status

YMS:Körber-YMS

send

Yard

https

LoadingUnitStatus

productive

YMS:HG-YMS

send

Yard

https

LoadingUnitStatus

postponed

Hermes-Germany:HERIS

receive

Yard

https with XML

yardReportActualArrivalRequest, yardReportActualDepartureRequest, yardReportCargoUtilizationRequest

productive

Hermes-Germany:BI

receive

Yard

yard.loadingunitstatus.hg-bi

LoadingUnitStatus

planned

FINE:Flash

receive

Yard

yard.loadingunitstatus.flash

LoadingUnitStatus

productive

OTTO:SER

receive

Yard

https

Transportnachweis

productive

extern:Cargoclix

receive

Yard

postponed

Oyster

receive

Yard

postponed

flow

4. Interface

4.1. Direction YMS Körber to FINE

4.1.1. Header

This interface uses the Service Header

Special expression for this interface:

Fieldname

Expresion

context

YARD

eventType

LOADING_UNIT_STATUS

4.1.2. Datamodel

Property Type Description

(Root)

object

Interface for Status Update Data of Loading Units from Yard Management

    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: [ "LOADING_UNIT_STATUS" ]
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", "KMOTION_ERFURT", "LOGISTIKPUFFER" ]

        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 which provides the status
Yard for the message / Yard für den die Meldung ist (ILOWA)

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

        systemRegistration*

string (enum)

System of original Registration
sender system of advice / System aus dem die Registrierung übertragen wurde: HERIS, CARGOCLIX, RESY, …​

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

        yardEventType*

string

Yard event type
yard event / Ereignis (YARD_ARRIVAL, YARD_ENTRANCE, YARD_DEPARTURE, LOADING_START, LOADING_CANCEL, LOADING_END, UNLOADING_START, UNLOADING_CANCEL, UNLOADING_END, PARKING_POSITION, LEAVING_PARKING, TOURING)

Maximum Length: 25

        yardEventDateTime*

string (date-time)

Yard event occurence timestamp
actual time when the event occured / Zeitpunkt des Ereigniseintritts (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        yardAreaId

string

Yard area ID
ID of yard area / ID des Bereiches

Maximum Length: 50

        gateId

string

Gate ID
ID gate / ID des Tores

Maximum Length: 50

        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

        loadCarrierType

string

load Carrier Type
load carrier type / Typ des Ladungsträgers: WAB (swap body / Wechselaufbaubrücke), BUS, SATTEL (semi trailer / Sattelauflieger), LKW (truck), CT20 (Container 20 feet/Fuß), CT40 (Container 40 feet/Fuß)

Maximum Length: 25

        loadingNumber

string

Loading Number / Verladenummer
Loading number generated by system responsible for loading, e.g. WMS / Vom verladenden System, z.B. WMS generierte Verladenummer pro Verladung

Maximum Length: 25

        carrierId

string

Carrier ID
carrier ID / ID des Spediteurs

Maximum Length: 50

        ymsRegistrationId

string

YMS registration ID
id of registration in YMS / ID der Registrierung im YMS

Maximum Length: 50

        externalReferences

object

external references
References for loading units registered by external systems. Data from Y01 must be contained for loading units registered by external systems. No requirements for Loading units registered internally in YMS.

            typeReference

string

reference type
reference type referring to the system / Referenztyp bezugnehmend auf das externe System

Maximum Length: 50

            idReference1

string

external reference 1
external reference 1 / ID 1 der Referenz (CGX/HERIS/RESY-ID) (Bsp. HERIS Tournummer)

Maximum Length: 50

            idReference2

string

external reference 2
external reference 2 / Optional ID 2 der Referenz (CGX/HERIS/RESY-ID) (Bsp. HERIS Teilstreckennummer)

Maximum Length: 50

            idReference3

string

external reference 3
external reference 3 / Optional ID 3 der Referenz (CGX/HERIS/RESY-ID) (Bsp. HERIS Beladungsnummer)

Maximum Length: 50

            idReference4

string

external reference 4
external reference 4 / Optional ID 4 der Referenz (CGX/HERIS/RESY-ID)

Maximum Length: 50

            idReference5

string

external reference 5
external reference 5 / Optional ID 5 der Referenz (CGX/HERIS/RESY-ID)

Maximum Length: 50

            idReference6

string

external reference 6
external reference 6 / Optional ID 6 der Referenz (CGX/HERIS/RESY-ID)

Maximum Length: 50

        sealNumber1

string

Seal number 1
seal number 1 / Plombennummer 1

Maximum Length: 50

        sealNumber2

string

Seal number 2
seal number 2 / Plombennummer 2

Maximum Length: 50

        fillingRateInPercent

number (float)

Filling rate
filling rate of load carrier for outbound / Füllgrad der WAB bei WA in Prozent

Minimum: 0
Maximum: 1000

        departureReadinessDateTime

string (date-time)

departure readiness time
departure readiness time / Gestellungszeit (yyyy-mm-ddTHH:mi:ss[+|-]HH:MI or yyyy-mm-ddTHH:mi:ss.fff[+|-]HH:MI)

        transport

object

            licensePlateTruck

string

License plate truck
license plate number of the truck / KFZ-Kennzeichen des LKWs bzw. der Zugmaschine (receiver YMS_KMOTION will accept formatted values and normalize them by removing spaces and special characters)

Maximum Length: 25

            licensePlateTrailer

string

License plate trailer
license plate number of the trailer / KFZ-Kennzeichen des Anhängers bzw. der Lafette (receiver YMS_KMOTION will accept formatted values and normalize them by removing spaces and special characters)

Maximum Length: 25

            driverName

string

Driver name
driver name / Name des Fahrers

Maximum Length: 100

            driverPhone

string

Driver phone
driver's mobile phone number / Telefonnummer des Fahrers

Maximum Length: 50

        additionalInfo

object

additional Information

            adviceType

string

Type of the LoadingUnitAdvcie to which this event refers
advice type: INBOUND, OUTBOUND / Typ der ursprünglichen Avisierung: INBOUND (Anlieferung), OUTBOUND (Abholung)

Maximum Length: 25

            internalTripNumber

string

internal trip number
internal trip number for partial routes between locations of the same yard / Teilstreckennummer für interne Teilstrecke zwischen Locations desselben Yards (e.g. HERIS)

Maximum Length: 50

        delay

object

            delayCategory

string

HERIS delay category

Maximum Length: 50

            delayComment

string

HERIS delay comment

Maximum Length: 500

4.1.3. Data value ranges

yardEventType (Ereignis)

yardEventType

description

Beschreibung

YARD_ARRIVAL

arrival

Anunft

YARD_ENTRANCE

yard entrance

Einfahrt

YARD_DEPARTURE

yard departure

Ausfahrt

UNLOADING_START

start unloading

Start Entladung

UNLOADING_CANCEL

cancel unloading

Abbruch Entladung

UNLOADING_END

end unloading

Ende Entladung

LOADING_START

start loading

Start Beladung

LOADING_CANCEL

cancel loading

Abbruch Beladung

LOADING_END

end loading

Ende Beladung

LEAVING_PARKING

leave parking position

Abfahrt von einem Platz oder Tor

PARKING_POSITION

arrive at parking position

Ankunft an einem Platz oder Tor

TOURING

touring

Vertourung

4.1.4. Examples

UNLOADING_START
{
    "eventId": "00ce536f-923a-42f4-8128-ce118faf1d81",
    "traceId": "00ce536f-923a-42f4-8128-ce118faf1d81",
    "spanId": "",
    "eventTime": "2016-04-16T16:16:05.002+02:00",
    "eventType": "LOADING_UNIT_STATUS",
    "version": "1.0",
    "context": "YARD",
    "sender": "YMS_KMOTION",
    "data": {
        "yard": "ILOWA",
        "location": "ILOWA_RT",
        "systemRegistration": "HERIS",
        "yardEventType": "UNLOADING_START",
        "yardEventDateTime": "2023-03-20T09:53:00+02:00",
        "gateId": "T112",
        "loadCarrierId": "905604",
        "loadCarrierType": "WAB",
        "loadingNumber": "220123456789",
        "carrierId": "HG",
        "ymsRegistrationId": "AB123",
        "externalReferences": {
          "typeReference":"TOUR",
           "idReference1": "51231539",
           "idReference2": "529010874",
           "idReference3": "52002860"
        },
        "additionalInfo": {
            "adviceType": "INBOUND"
        }
    }
}
YARD_DEPARTURE
{
    "eventId": "00ce536f-923a-42f4-8128-ce118faf1d81",
    "traceId": "00ce536f-923a-42f4-8128-ce118faf1d81",
    "spanId": "",
    "eventTime": "2016-04-16T16:16:05.002+02:00",
    "eventType": "YARD_DEPARTURE",
    "version": "1.0",
    "context": "YARD",
    "sender": "YMS_KMOTION",
    "data": {
        "yard": "ILOWA",
        "location": "ILOWA",
        "systemRegistration": "HERIS",
        "yardEventType": "YARD_DEPARTURE",
        "yardEventDateTime": "2023-03-20T10:10:00+02:00",
        "loadCarrierId": "905604",
        "loadCarrierType": "WAB",
        "loadingNumber": "1705603311",
        "carrierId": "HG",
        "ymsRegistrationId": "AB43543",        
        "externalReferences": {
            "typeReference":"TOUR",
            "idReference1": "31231539",
            "idReference2": "42424324",
            "idReference3": "75455755"
        },
        "sealNumaber1": "SealOTTO123",
        "fillingRateInPercent": 56.9,
        "transport":{
            "licensePlateTruck": "MD-HG 123",
            "driverName": "Jane Doe"
        },
        "additionalInfo": {
            "adviceType": "OUTBOUND"
        },
        "delay": {
            "delayCategory": "701"
        }
    }
}

4.1.5. Schema

Version Number File Published on Changes

current version

1.0

LoadingUnitStatus.v1.0.schema.json

05.12.2023

location, additionalInfo added, typeReference+idReference1 no longer required

previous version

0.2.8

LoadingUnitStatus.v0.2.schema.json

22.09.2023

delay type, departureReadinessDateTime, transport added

coming version

4.2. Direction FINE to HG Heris

Körber YMS data will be mapped and transferred to HG Heris formats:

Körber YMS Messages having eventType YARD_ARRIVAL will be mapped and transferred as yardReportActualArrivalRequest + yardReportAdditionalInfoRequest.

Körber YMS Messages having eventType YARD_DEPARTURE will be mapped and transferred as yardReportActualDepartureRequest + yardReportCargoUtilizationRequest + yardReportAdditionalInfoRequest.

For HG YMS it is not yet planned.

4.2.1. Schema

HG is responsible for the described schema. It is mentioned here for reference only.

Version Number File Published on Changes

current version

2.0

Download

20.09.2023

initial version

previous version

coming version

4.2.2. Examples

yardReportActualArrivalRequest aus YARD_DEPARTURE

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<yardReportActualDepartureRequest xmlns="http://hlg.de/tl/yard-inbound-2.0">
  <tripNumber>42424324</tripNumber>
  <containerDetails>
    <cargoNumber>75455755</cargoNumber>
    <containerIdentifier>905604711</containerIdentifier>
    <sealIdentifier>SealOTTO123</sealIdentifier>
  </containerDetails>
  <actualDateTime>2023-02-15T13:54:00.000+01:00</actualDateTime>
  <delay>
    <departureDelayCategory>TP F. zu spät gestellt</departureDelayCategory>
	</comment>
  </delay>
</yardReportActualDepartureRequest>

yardReportCargoUtilizationRequest aus YARD_DEPARTURE

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<yardReportCargoUtilizationRequest xmlns="http://hlg.de/tl/yard-inbound-2.0">
  <cargoNumber>75455755</cargoNumber>
  <utilizationPercent>57</utilizationPercent>
</yardReportCargoUtilizationRequest>

yardReportAdditionalInfoRequest aus YARD_DEPARTURE

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<yardReportAdditionalInfoRequest xmlns="http://hlg.de/tl/yard-inbound-2.0">
	<tripNumber>42424324</tripNumber>
	<isDeparture>true</isDeparture>
	<driverName>Jane Doe</driverName>
	<licensePlateTruck>MD-HG 123</licensePlateTruck>
</yardReportAdditionalInfoRequest>

4.3. Direction FINE to HG BI

see Direction YMS Körber to FINE

The HG topic contains only data for systemRegistration 'HERIS' for all yards and locations. It does not contain any personal data.

4.4. Direction FINE to Flash

see Direction YMS Körber to FINE

Personal data will not be transferred to Flash.

4.5. Direction FINE to SER

For legal reasons, the retailer must prove that transports abroad (from ILOWA to Germany or vice versa) have left the origin location or arrived at destination. Hermes Germany (HERIS) Yard Departure and Arrival Events will be delivered to SER als "Proof of Transport" for this purpose.

4.5.1. Datamodel

The provided document is a json File containing the data for the proof of transport.

Property Type Description

(Root)

object

Schema for proof of Transport Documents for departure of outgoing transports and arrival of incoming transports

    transportType

string

Type of Transnport related to the location
transport type: INBOUND, OUTBOUND, RETURNS (as special case of INBOUND)

Maximum Length: 25

    location*

string

location
location for which the proof of transport is created (locations as in https://docs.osp-fine.de/registry/MetaData/warehouselocations.v1.schema.json)

Maximum Length: 25

    loadingNumber

string

Loading Number
Loading number generated by system responsible for loading, e.g. WMS

Maximum Length: 25

    carrier

string

Carrier ID
carrier who carried out the transport

Maximum Length: 50

    transportNumber

string

carrier tour number
carrier tour number (e.g. for HG) or comparable reference

Maximum Length: 50

    transportDateTime*

object

        yardDepartureDateTime

string (date-time)

Yard Departure Date incl.timestamp
actual time of transpaort departure from location

        yardArrivalDateTime

string (date-time)

Yard Arrival Date incl.timestamp
actual time of transpaort departure frinom location

    loadCarrierId

string

Load carrier ID
load carrier ID (e.g. swap body number, container number, license plate)

Maximum Length: 50

    addressOriginLocation

object

origin location of transport

        addressName*

string

address name
address name

Maximum Length: 100

        addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

        addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

        addressCity*

string

address city
address city

Maximum Length: 100

        addressDistrict

string

address district
address district

Maximum Length: 100

        addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

    addressDestinationLocation

object

destination location address for waybill / Adresse des Entladestandorts für Frachtbrief

        addressName*

string

address name
address name

Maximum Length: 100

        addressStreet

string

address street name and number
address street name and number

Maximum Length: 100

        addressZipcode*

string

address zip code
address zip code

Maximum Length: 10

        addressCity*

string

address city
address city

Maximum Length: 100

        addressDistrict

string

address district
address district

Maximum Length: 100

        addressCountryIso*

string

address country ISO
address country ISO Alpha-2

Maximum Length: 2

4.5.2. Schema

SER is responsible for the described interface schema. It is mentioned here for reference only.

Version Number description Published on Changes

current version

v3

Document archive API

03/2024

initial version

previous version

coming version

1.7 - Y03 Yard Container Inventory

Status

v1.0, 31.07.2024

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

Yard

InterfaceOwner

OSP

Producer

YMS Körber

Körber

Consumer

HERIS

Hermes Germany

Consumer

Flash

2. Business Context

A Snapshot of available containers located in a yard will be provided per receiver.

3. Informationflow

flow

Partner Direction FINE-Service Topic/API Description Status

YMS:Körber-YMS

send

Yard

https

YardContainerInventory

productive

Hermes-Germany:HERIS

receive

Yard

https with XML

yardReportContainerInventoryRequest

productive

FINE:Flash

receive

Yard

yard.inventory.out

YardContainerInventory

productive

4. Interface

4.1. Direction YMS Körber to FINE

4.1.1. Datamodel

Property Type Description

(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

4.1.2. Example

{
    "eventId": "00ce536f-923a-42f4-8128-be118faf1d87",
    "traceId": "00ce536f-923a-42f4-8128-be118faf1d85",
    "eventTime": "2023-02-15T13:55:00+01:00",
    "eventType": "YARD_CONTAINER_INVENTORY",
    "version": "1.0",
    "context": "YARD",
    "sender": "YMS_KMOTION",
    "data": {
        "yard": "ILOWA",
        "location": "ILOWA",
        "recipient": "HERIS",
        "containerList": [
            {
                "loadCarrierId": "905603311",
                "loadCarrierIsDefective": false,
                "yardTransactionType": "WAB",
                "deliveryType": "UMF_KOLLI"
            },
            {
                "loadCarrierId": "905603312",
                "loadCarrierIsDefective": false,
                "yardTransactionType": "BRLEER",
                "deliveryType": "LEER"
            },
            {
                "loadCarrierId": "905603313",
                "loadCarrierIsDefective": false,
                "yardTransactionType": "WAKB"
            },
            {
                "loadCarrierId": "905603314",
                "loadCarrierIsDefective": true,
                "yardTransactionType": "BRLEER",
                "deliveryType": "LEER"
            },
            {
                "loadCarrierId": "905603315",
                "loadCarrierIsDefective": false,
                "yardTransactionType": "WAUB",
                "deliveryType": "LHM"
            },
            {
                "loadCarrierId": "905603316",
                "loadCarrierIsDefective": false,
                "yardTransactionType": "WAUB",
                "deliveryType": "RET_MW"
            },
            {
                "loadCarrierId": "905603317",
                "loadCarrierIsDefective": false,
                "yardTransactionType": "WAKUB",
                "deliveryType": "RET_MW"
            }
        ]
    }
}

4.1.3. Schema

Version Number File Published on Changes

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

4.2. Direction FINE to HG - yardReportContainerInventoryRequest

Körber YMS data will be mappedand transferred to HG as yardReportContainerInventoryRequest.

4.2.1. Schema

HG is responsible for the described schema. It is mentioned here for reference only.

Version Number File Published on Changes

current version

2.0

Download

20.09.2023

initial version

previous version

coming version

4.2.2. Examples

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<yardReportContainerInventoryRequest xmlns="http://hlg.de/tl/yard-inbound-2.0">
  <inventoryReport>
    <containerIdentifier>905603311</containerIdentifier>
    <locationMatchCode>HUBILOWPL</locationMatchCode>
    <containerStatus>Vorlader</containerStatus>
    <comment/>
  </inventoryReport>
  <inventoryReport>
    <containerIdentifier>905603312</containerIdentifier>
    <locationMatchCode>OTTOILOWPL</locationMatchCode>
    <containerStatus>Leer</containerStatus>
    <comment/>
  </inventoryReport>
  <inventoryReport>
      <containerIdentifier>905603313</containerIdentifier>
      <locationMatchCode>OTTOILOWPL</locationMatchCode>
      <containerStatus>Überhänge</containerStatus>
      <comment/>
  </inventoryReport>
  <!-- ... -->
</yardReportContainerInventoryRequest>

4.3. Direction FINE to Flash

see <Direction YMS Körber to FINE