I02C Despatch Advice Booking

(Root)

object

Despatch Advice Bookings

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

    spanId

string (uuid)

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

    eventTime*

string (date-time)

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

    version*

string

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

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

    context

string

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

    eventType*

string (enum)

The type of operation
Type of message

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

    metaData

object

        sender

string (enum)

system

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

    data*

object

        bookId

integer

Id of the booking

        location*

string (enum)

warehouse locations

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

        businessEventDateTime

string (date-time)

timestamp of business event

        creator

object

            id

integer

Id of the booking creator

            companyId

integer

the creators company id

            companyName

string

the creators company name

        previous

object

            arrivalSlotStartDateTime

string (date-time)

previous slot start time
previous start time of the arrival time slot

            arrivalSlotEndDateTime

string (date-time)

previous slot end time
previous end time of the arrival time slot

            arrivalSlotLengthMinutes

integer

previous slot length in minutes
difference between previous slot start time and previous slot end time

            bookRampId

integer

Id of previous ramp

        arrivalSlotStartDateTime

string (date-time)

slot start time
start time of the arrival time slot

        arrivalSlotCriticalStartDateTime

string (date-time)

slot critical start time
critical start time of the arrival time slot

        arrivalSlotEndDateTime

string (date-time)

slot end time
end time of the arrival time slot

        arrivalSlotLengthMinutes

integer

slot length in minutes
difference between slot start time and slot end time

        bookRampId

integer

Id of the ramp

        bookingCompany

object

            id

integer

Id of the booking company

            name

string

the booking company name

        storageNotification

array

StorageNotifications

            (Array item)

object

                id

string

StorageNotificationId
StorageNotificationId

                quantity

integer

quantity

        orderNumber

array

order numbers

            (Array item)

string

        carrier

string

carrier

        productDescription

string

        itemNumber

array

item numbers

            (Array item)

string

        customerCompany

array

HF Customer from CargoClix

            (Array item)

string

        leavingEuroPallets

integer

        loadCarrier

array

            (Array item)

object

                id

string

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

                type

string (enum)

load carrier type / Typ des Ladungsträgers: LKW, Auflieger, WAB, Container, …

Any of: [ "WAB", "CT20", "CT40", "CT20HC", "CT40HC", "TRUCK", "TRUCK_WITH_TRAILER", "TRAILER", "BUS", "OTHER" ]

                sealNumber

string

seal number

        cancellationDescription

string

        comment

string

        deliveryMethodDescription

string

        processingInformation

array

            (Array item)

object

                goodsReceiptProcessingType

string

Pallets/hatch detection
Pallets/hatch detection, palletized, loose, loose, DLW…​. List of allowed values will be defined and documented #url

                quantity

integer

Quantity received for this processing type
the received quantity for this processing type

Minimum: 0
Maximum: 99999999999999

        delivery

array

            (Array item)

object

                type

string

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

                number

string

delivery number

        desiredDate

string

preferred delivery date by HG

        deviationAvisQuality

string

Avis quality

        deliveryNoteId

array

            (Array item)

string

delivery note uuid

        supplier

object

            name

string

supplier name

            code

string

supplier code

        numberOf

object

            colliLoose

integer

            colliPaletized

integer

            hunte

integer

            articles

integer

            colli

integer

            defectivePallets

integer

            onewayPallets

integer

            pallets

integer

        pager

object

            pagerNumber

string

pager number

            returned

boolean

pager returned by driver

        pagerNumber

string

pager number

        pagerReturn

boolean

pager returned by driver

        palleteNumber

string

        processingTimeMinCalculated

string

calculated timee for umloading in minutes

        ProductTypeSelect

string

Sortimentsauswahl

        shipName

string

ship name

        shipmentNumber

string

shipment number

        slaRelevance

boolean

        cancellationReason

string

        transportId

array

            (Array item)

string

transport uuid

        tourNumber

array

tour numbers

            (Array item)

string

        wayBillNumber

string

        driver

object

            name

string

driver name

            phone

string

driver phone

            language

string

driver language

        isDeleted

boolean

booking is deleted

        isCancelled

boolean

booking is cancelled

        licensePlate

object

            truck

string

truck license plate

            trailer

string

driver license plate

Version

Number

File

Published on

Changes

coming version

1.0

Download

07.02.2025

new attribute customerCompany

current version

1.0

15.09.2023

senderSystem → sender: system.v7.schema.json, remove carrierCountryIso , ship {name, number} → shipName, shipmentNumber, sealNumber → move to loadCarrier {id, type, sealNumber}, deliveryNoteId → array, transportId → array, wayBillNumber integer→string