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

Return to the regular view of this page.

Team IL

1 -

1.1 -

Property Type Description

(Root)

object

    eventId

string (uuid)

    traceId

string (uuid)

    eventTime

string (date-time)

    eventType

(enum)

Any of: [ "LogisticsProductIdNotFound", "InternalServerError" ]

    data

object

        message

string

2 -

2.1 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        product*

object

            itemNumber*

integer

Item Number
the item number

            itemSize*

integer

Item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

            company*

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        quantity*

integer

quantity
Submitted quantity

Exclusive Maximum: 1000000000000000000

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        hAwbBl*

string

hAwbBl
House B/L or HAWB-Nummer. (Bei Luftfrachten werden derzeit die HAWB-Nummern als Zugangsnummer erfasst. Mittelfristig soll die

Maximum Length: 70

2.2 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        product*

object

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        quantity*

integer

quantity
Submitted quantity

Exclusive Maximum: 1000000000000000000

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        hAwbBl*

string

hAwbBl
House B/L or HAWB-Nummer. (Bei Luftfrachten werden derzeit die HAWB-Nummern als Zugangsnummer erfasst. Mittelfristig soll die

Maximum Length: 70

3 -

3.1 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

sender system

Any of: [ "HERMES_C@TS", "HEINE_ZOLL" ]

    data*

object

        product*

object

            itemNumber*

string

Item Number
the item number

            itemSize*

string

Item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

            company*

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        newCustomsClearanceSign*

integer

new customs clearance sign
New returned customs clearance sign. In C@ts/WMS-term called 'Zoll KNZ, neu', e.g. '0=goods have been cleared, duty paid/1=goods must be cleared'

Minimum: 0
Exclusive Maximum: 10

        quantity*

integer

quantity
Returned quantity. In C@ts-term called 'excess/overfulfilled Qty./Übermenge'. If no overfulfilled quantity, then 0 (overfulfilled quantities are not evaluated)

Maximum: 1000000000000000000

3.2 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

sender system

Any of: [ "HERMES_C@TS", "HEINE_ZOLL" ]

    data*

object

        product*

object

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        newCustomsClearanceSign*

integer

new customs clearance sign
New returned customs clearance sign. In C@ts/WMS-term called 'Zoll KNZ, neu', e.g. '0=goods have been cleared, duty paid/1=goods must be cleared'

Minimum: 0
Exclusive Maximum: 10

        quantity*

integer

quantity
Returned quantity. In C@ts-term called 'excess/overfulfilled Qty./Übermenge'. If no overfulfilled quantity, then 0 (overfulfilled quantities are not evaluated)

Maximum: 1000000000000000000

4 -

4.1 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string (enum)

The type of operation
Typ der Nachricht

Any of: [ "CUSTOMS_NOTIFICATION_PICKING_GOODS" ]

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        product*

object

            itemNumber*

integer

Item Number
the item number

            itemSize*

integer

Item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

            company*

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        stockRemovalDate*

string

stock removal date
Stock removal date of customs affected item/product (ddMMYYY). In C@ts/WMS-terms aka. 'Tag der Auslagerung / DAT_OUTSOURCING'.

Regular expression: ^((0[1-9])|(1[0-9])|(2[0-9])|(3[0-1]))((0[1-9])|(1[0-2]))((19\d\d)|(20\d\d))$

        quantity*

integer

quantity
Stock removed quantity of item/product. In C@ts/WMS-terms aka. 'Entnommene Menge des Artikels'

Maximum: 1000000000000000000

        customsClearanceSign*

number

customs clearance sign
Reported customs clearance sign/status. In C@ts/WMS-terms called 'Zoll KNZ', e.g. '0 = Goods have been cleared (regarding items in WMS with customs status 05 = 'customs')

4.2 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string (enum)

The type of operation
Typ der Nachricht

Any of: [ "CUSTOMS_NOTIFICATION_PICKING_GOODS" ]

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        product*

object

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        stockRemovalDate*

string

stock removal date
Stock removal date of customs affected item/product (ddMMYYY). In C@ts/WMS-terms aka. 'Tag der Auslagerung / DAT_OUTSOURCING'.

Regular expression: ^((0[1-9])|(1[0-9])|(2[0-9])|(3[0-1]))((0[1-9])|(1[0-2]))((19\d\d)|(20\d\d))$

        quantity*

integer

quantity
Stock removed quantity of item/product. In C@ts/WMS-terms aka. 'Entnommene Menge des Artikels'

Maximum: 1000000000000000000

        customsClearanceSign*

number

customs clearance sign
Reported customs clearance sign/status. In C@ts/WMS-terms called 'Zoll KNZ', e.g. '0 = Goods have been cleared (regarding items in WMS with customs status 05 = 'customs')

5 -

5.1 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string (enum)

The type of operation
Typ der Nachricht

Any of: [ "CUSTOMS_STOCK_SUMMARY" ]

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        product*

object

            itemNumber*

integer

Item Number
the item number

            itemSize*

integer

Item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

            company*

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        quantity*

integer

Reported quantity
Reported recent quantity (available + reserved qty's) of the customs related item in the whole warehouse per logisticsProductId and customs indication/status (add up all quantum).

Maximum: 1000000000000000000

        customsClearanceSign*

integer

customs clearance sign
Reported customs clearance sign/status. In C@ts/WMS-terms called 'Zoll KNZ', e.g. '1 = Item can be cleared through customs, customs clearance notification (ZO51) is available. 2 = Item cannot be cleared through customs, customs release notification (ZO51) is not yet available. (In the WMS, customs status 'undetermined')'

Minimum: 0
Exclusive Maximum: 10

5.2 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string (enum)

The type of operation
Typ der Nachricht

Any of: [ "CUSTOMS_STOCK_SUMMARY" ]

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        product*

object

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        quantity*

integer

Reported quantity
Reported recent quantity (available + reserved qty's) of the customs related item in the whole warehouse per logisticsProductId and customs indication/status (add up all quantum).

Maximum: 1000000000000000000

        customsClearanceSign*

integer

customs clearance sign
Reported customs clearance sign/status. In C@ts/WMS-terms called 'Zoll KNZ', e.g. '1 = Item can be cleared through customs, customs clearance notification (ZO51) is available. 2 = Item cannot be cleared through customs, customs release notification (ZO51) is not yet available. (In the WMS, customs status 'undetermined')'

Minimum: 0
Exclusive Maximum: 10

6 -

6.1 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

        messageNumber

integer

Current number of the message in this batch. The first message has the number 1.

Minimum: 1
Maximum: 999999999

    data*

object

        location*

string (enum)

Warehouse location

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

        market*

string

market
SST03/4AB: <market>, according Heine-TargetFormat-XSD: the target market (ISO 3166-1 ALPHA-2)

Maximum Length: 2

        clientKey*

string (enum)

client key
SST03/4AB: <client_key>, internal id of otto group companies who use HEINE's customs services

Any of: [ "6PM-CH", "ABOUTYOU-CH", "ACKERMANN-CH", "BESTSELLER-CH", "BONPRIX-CH", "BRAVEHEART-CH", "FGH-BONPRIX-GB", "FGH-DIRECT-DELIVERY-GB", "FGH-OTTO-GB", "FGH-SCHWAB-GB", "FGH-WITT-GB", "FRANKONIA-CH", "HEINE-CH", "JELMOLI-CH", "LIEBESKIND-CH", "MAGAZIN-CH", "MAGAZIN-TH", "MAGAZIN-US", "MANUFACTUM-CH", "MANUFACTUM-HK", "MANUFACTUM-TH", "MANUFACTUM-US", "MYTOYS-CH", "QUELLE-CH", "SIEHAN!-CH", "SOLIVER-CH", "SPS-CH", "WITT-CH" ]
Minimum Length: 1
Maximum Length: 22

        invoiceDate*

string (date-time)

invoice date
SST03/4AB: <invoice_date> (optional), if invoicing takes place only when goods are issued (NEON)

        consignments*

array

SST03/4AB: <consignment>, multiple without outer consignments brackets in Heine's XML taget format.

Minimum number of items 1

            (Array item)

object

                consignmentBarcode*

string

consignment barcode
SST03/4AB: <consignment_barcode>, contains shipment/tracking number of consignment

Maximum Length: 40

                products*

array

products
SST03/4AB: <product>, multiple …​ without outer products brackets in Heine's XML taget format. c.f. shipped products in customers parcel/consignment.

Minimum number of items 1

                    (Array item)

object

                        company*

string

origin company
SST03/4AB: <origin_company>, Unique Id of inventory/stock owning group company

Minimum Length: 1
Maximum Length: 2

                        itemNumber*

string

item number / product number
SST03/4AB: <product_number>, c.f. item number

Maximum Length: 99

                        itemSize*

string

item size / product variant
SST03/4AB: <product_variant>, aka. item size

Maximum Length: 25

                        quantities*

array

quantities
SST03/4AB: <quantity>, multiple without outer quantities brackets in Heine's XML taget format. quantities of same product in one consignment/shipment (n' records à qty=1 >> for 'OrderQuantities > 1' of same product)

Minimum number of items 1

                            (Array item)

object

                                quantity

integer

quantity
SST03/4AB: <qty>, Specific amount of ItemSpecificQuantity, mainly: qty=1

Minimum: 1
Maximum: 1

                                buidId

string

buid id
SST03/4AB: <buid_id>, optional - ID used for unique/specific item shipped

Maximum Length: 99

                                externalReference

string

external reference
SST03/4AB: <external_reference>, optional - ID used for unique/specific prospected goods returned item

Maximum Length: 128

                                containerPackaging

string

Container Packaging
Gebindenorm (11-17: Auslieferkartons, 40-43: Ausliefertüten (Tütennorm F4,F5,F7,F8), 1-7: RL-Kolli vom KR1)

Maximum Length: 2

                                storageType

string (enum)

PICKING -> Kommissionierung, RESERVE -> Reservelager

Any of: [ "PICKING", "RESERVE" ]

                                storageLocationType

string (enum)

Storage Location Type
gibt an, in welches Lager der Artikel soll. FREE -> kein Zolllager. BONDED -> Zolllager

Any of: [ "BONDED", "FREE" ]

                                bondedStock

object

SST03/4AB: <bonded_stock>, optional customs bonded information (if customs related) regarding inbound id's, c.f. 'WE/WAP'

                                    goodsInId

string

the goods receipt number/id
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

                                    customsShipmentNumber*

integer

WE-Sendungsnummer
SST03/4AB: <we_number>, >> 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

                                    documentNumber*

integer

WAP number
SST03/4AB: <wap_number>, In Customs/WMS-terms aka. 'ANZ-Nummer (aka. Warenannahmeprotokollnummer)'. Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

6.2 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

        messageNumber

integer

Current number of the message in this batch. The first message has the number 1.

Minimum: 1
Maximum: 999999999

    data*

object

        location*

string (enum)

Warehouse location

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

        market*

string

market
SST03/4AB: <market>, according Heine-TargetFormat-XSD: the target market (ISO 3166-1 ALPHA-2)

Maximum Length: 2

        clientKey*

string (enum)

client key
SST03/4AB: <client_key>, internal id of otto group companies who use HEINE's customs services

Any of: [ "6PM-CH", "ABOUTYOU-CH", "ACKERMANN-CH", "BESTSELLER-CH", "BONPRIX-CH", "BRAVEHEART-CH", "FGH-BONPRIX-GB", "FGH-DIRECT-DELIVERY-GB", "FGH-OTTO-GB", "FGH-SCHWAB-GB", "FGH-WITT-GB", "FRANKONIA-CH", "HEINE-CH", "JELMOLI-CH", "LIEBESKIND-CH", "MAGAZIN-CH", "MAGAZIN-TH", "MAGAZIN-US", "MANUFACTUM-CH", "MANUFACTUM-HK", "MANUFACTUM-TH", "MANUFACTUM-US", "MYTOYS-CH", "QUELLE-CH", "SIEHAN!-CH", "SOLIVER-CH", "SPS-CH", "WITT-CH" ]
Minimum Length: 1
Maximum Length: 22

        invoiceDate*

string (date-time)

invoice date
SST03/4AB: <invoice_date> (optional), if invoicing takes place only when goods are issued (NEON)

        consignments*

array

SST03/4AB: <consignment>, multiple without outer consignments brackets in Heine's XML taget format.

Minimum number of items 1

            (Array item)

object

                consignmentBarcode*

string

consignment barcode
SST03/4AB: <consignment_barcode>, contains shipment/tracking number of consignment

Maximum Length: 40

                products*

array

products
SST03/4AB: <product>, multiple …​ without outer products brackets in Heine's XML taget format. c.f. shipped products in customers parcel/consignment.

Minimum number of items 1

                    (Array item)

object

                        logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

                        quantities*

array

quantities
SST03/4AB: <quantity>, multiple without outer quantities brackets in Heine's XML taget format. quantities of same product in one consignment/shipment (n' records à qty=1 >> for 'OrderQuantities > 1' of same product)

Minimum number of items 1

                            (Array item)

object

                                quantity

integer

quantity
SST03/4AB: <qty>, Specific amount of ItemSpecificQuantity, mainly: qty=1

Minimum: 1
Maximum: 1

                                buidId

string

buid id
SST03/4AB: <buid_id>, optional - ID used for unique/specific item shipped

Maximum Length: 99

                                externalReference

string

external reference
SST03/4AB: <external_reference>, optional - ID used for unique/specific prospected goods returned item

Maximum Length: 128

                                containerPackaging

string

Container Packaging
Gebindenorm (11-17: Auslieferkartons, 40-43: Ausliefertüten (Tütennorm F4,F5,F7,F8), 1-7: RL-Kolli vom KR1)

Maximum Length: 2

                                storageType

string (enum)

Storage Type
PICKING -> Kommissionierung, RESERVE -> Reservelager

Any of: [ "PICKING", "RESERVE" ]

                                storageLocationType

string (enum)

Storage Location Type
gibt an, in welches Lager der Artikel soll. FREE -> kein Zolllager. BONDED -> Zolllager

Any of: [ "BONDED", "FREE" ]

                                bondedStock

object

SST03/4AB: <bonded_stock>, optional customs bonded information (if customs related) regarding inbound id's, c.f. 'WE/WAP'

                                    goodsInId

string

the goods receipt number/id
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

                                    customsShipmentNumber*

integer

WE-Sendungsnummer
SST03/4AB: <we_number>, >> 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

                                    documentNumber*

integer

WAP number
SST03/4AB: <wap_number>, In Customs/WMS-terms aka. 'ANZ-Nummer (aka. Warenannahmeprotokollnummer)'. Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

7 -

7.1 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

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

    data*

object

        location*

string (enum)

Warehouse location
SST02: <storage_location>, Warehouse location

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" ]
Maximum Length: 25

        fileName

string

filename
SST02: <filename>

Maximum Length: 99

        creationTimestamp

string (date-time)

creation timestamp
SST02: <creation_timestamp>, MsgProduction timestamp

        market*

string

market
SST02: <market>, according Heine-TargetFormat-XSD: the target market (ISO 3166-1 ALPHA-2)

Maximum Length: 2

        loadingNumber

string

loading number
SST02: <loading_number>, number of loading expected

Maximum Length: 25

        swapBodyNumber*

string

swap body numberloading number
SST02: <swap_body_number>, WAB - Number of loading expected

Maximum Length: 25

        truck

string

truck license plate
SST02: <truck>, designation or license plate registration of truck

Maximum Length: 25

        consignments*

array

SST02: <consignment>, multiple …​ without outer consignments brackets in Heine's XML target format.

Minimum number of items 1

            (Array item)

object

                consignmentBarcode*

string

consignment barcode
SST02: <consignment_barcode>, contains shipment/tracking number of consignment

Maximum Length: 40

                scanTimestamp*

string (date-time)

last scan timestamp
SST02: <scan_timestamp>, final scanning before loading (WMS: after the chute/slide)

                externalReference

string

externalReference
SST02: <external_reference>, optional unique client reference

Maximum Length: 128

                products*

array

products
SST02: <product>, multiple …​ without outer products brackets in Heine's XML target format. c.f. shipped products in customers parcel/consignment.

Minimum number of items 1

                    (Array item)

object

                        company*

string

origin company
SST02: <origin_company>, Unique Id of inventory/stock owning group company

Minimum Length: 1
Maximum Length: 2

                        itemNumber*

string

item number / product number
SST02: <product_number>, c.f. item number

Maximum Length: 99

                        itemSize*

string

item size / product variant
SST02: <product_variant>, aka. item size

Maximum Length: 25

                        buidId

string

buid id
SST02: <buid_id>, optional - ID used for unique/specific item shipped

Maximum Length: 99

                        productRefNumber

string

product reference number
SST02: <product_ref_number>, optional - article reference id

Maximum Length: 99

                        zlStatus

integer

zlStatus, customs warehouse status
SST02: <zl_status>, customs bonded warehouse status (1=Yes/0=No)

Minimum: 0
Maximum: 1

                        goodsInId

string

the goods receipt number/id
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

                        customsShipmentNumber

integer

WE-Sendungsnummer
SST02: <we_number>, >> 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

                        documentNumber

integer

WAP number
SST02: <wap_number>, In Customs/WMS-terms aka. 'ANZ-Nummer (aka. Warenannahmeprotokollnummer)'. Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

7.2 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

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

    data*

object

        location*

string (enum)

Warehouse location
SST02: <storage_location>, Warehouse location

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" ]
Maximum Length: 25

        fileName

string

filename
SST02: <filename>

Maximum Length: 99

        creationTimestamp

string (date-time)

creation timestamp
SST02: <creation_timestamp>, MsgProduction timestamp

        market*

string

market
SST02: <market>, according Heine-TargetFormat-XSD: the target market (ISO 3166-1 ALPHA-2)

Maximum Length: 2

        loadingNumber

string

loading number
SST02: <loading_number>, number of loading expected

Maximum Length: 25

        swapBodyNumber*

string

swap body numberloading number
SST02: <swap_body_number>, WAB - Number of loading expected

Maximum Length: 25

        truck

string

truck license plate
SST02: <truck>, designation or license plate registration of truck

Maximum Length: 25

        consignments*

array

SST02: <consignment>, multiple …​ without outer consignments brackets in Heine's XML target format.

Minimum number of items 1

            (Array item)

object

                consignmentBarcode*

string

consignment barcode
SST02: <consignment_barcode>, contains shipment/tracking number of consignment

Maximum Length: 40

                scanTimestamp*

string (date-time)

last scan timestamp
SST02: <scan_timestamp>, final scanning before loading (WMS: after the chute/slide)

                externalReference

string

externalReference
SST02: <external_reference>, optional unique client reference

Maximum Length: 128

                products*

array

products
SST02: <product>, multiple …​ without outer products brackets in Heine's XML target format. c.f. shipped products in customers parcel/consignment.

Minimum number of items 1

                    (Array item)

object

                        logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

                        buidId

string

buid id
SST02: <buid_id>, optional - ID used for unique/specific item shipped

Maximum Length: 99

                        productRefNumber

string

product reference number
SST02: <product_ref_number>, optional - article reference id

Maximum Length: 99

                        zlStatus

integer

zlStatus, customs warehouse status
SST02: <zl_status>, customs bonded warehouse status (1=Yes/0=No)

Minimum: 0
Maximum: 1

                        goodsInId

string

the goods receipt number/id
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

                        customsShipmentNumber

integer

WE-Sendungsnummer
SST02: <we_number>, >> 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

                        documentNumber

integer

WAP number
SST02: <wap_number>, In Customs/WMS-terms aka. 'ANZ-Nummer (aka. Warenannahmeprotokollnummer)'. Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

8 -

8.1 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        swapBodyNumber*

string

Swap Body Number
WAB-Nummer

        storageLocationKey*

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

        bins*

array

            (Array item)

object

                binCode*

string

bin code
Wannen-Barcode, eg. 7275573284

Maximum Length: 25

                articles*

array

                    (Array item)

object

                        itemNumber*

integer

Item Number
the item number

                        itemSize*

integer

Item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

                        company*

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

                        quantities*

array

                            (Array item)

object

                                customsShipmentNumber

integer

WE-Sendungsnummer
<we_number> auch 'WE-Sendungsnummer'. Im KR1 7-stellig (vgl C05).

Maximum: 99999999

                                documentNumber

integer

WAP number
<wap_number> auch ANZ-Nummer oder Warenannahmeprotokollnummer. Im KR1 6-stellig (vgl C05).

Maximum: 9999999

                                storageLocationType*

string (enum)

Storage Location Type
gibt an, in welches Lager der Artikel soll. FREE -> kein Zolllager. BONDED -> Zolllager

Any of: [ "BONDED", "FREE" ]

                                quantity*

integer

quantity
Gemeldete Menge des Artikels

Minimum: 1
Maximum: 1

                                hAwbBl*

string

hAwbBl
HAWB-Nummer - [Land][Verladenummer Retourenbetrieb inkl. Kundenfirmenkurzzeichen]

Maximum Length: 70

                                qaBlockingSign*

string

qa blocking sign
QS-Sperrkenzeichen. Ausprägungen: 'F' = frei 'I' = inventurgesperrt

Maximum Length: 1

8.2 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        swapBodyNumber*

string

Swap Body Number
WAB-Nummer

        storageLocationKey*

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

        bins*

array

            (Array item)

object

                binCode*

string

bin code
Wannen-Barcode, eg. 7275573284

Maximum Length: 25

                articles*

array

                    (Array item)

object

                        itemNumber

integer

Item Number
the item number

                        itemSize

integer

Item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

                        company

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

                        logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

                        quantities*

array

                            (Array item)

object

                                customsShipmentNumber

integer

WE-Sendungsnummer
<we_number> auch 'WE-Sendungsnummer'. Im KR1 7-stellig (vgl C05).

Maximum: 99999999

                                documentNumber

integer

WAP number
<wap_number> auch ANZ-Nummer oder Warenannahmeprotokollnummer. Im KR1 6-stellig (vgl C05).

Maximum: 9999999

                                storageLocationType*

string (enum)

Storage Location Type
gibt an, in welches Lager der Artikel soll. FREE -> kein Zolllager. BONDED -> Zolllager

Any of: [ "BONDED", "FREE" ]

                                quantity*

integer

quantity
Gemeldete Menge des Artikels

Minimum: 1
Maximum: 1

                                hAwbBl*

string

hAwbBl
HAWB-Nummer - [Land][Verladenummer Retourenbetrieb inkl. Kundenfirmenkurzzeichen]

Maximum Length: 70

                                qaBlockingSign*

string

qa blocking sign
QS-Sperrkenzeichen. Ausprägungen: 'F' = frei 'I' = inventurgesperrt

Maximum Length: 1

9 -

9.1 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        swapBodyNumber*

string

Swap Body Number
WAB-Nummer

        bins*

array

            (Array item)

object

                binCode*

string

bin code
Wannen-Barcode, eg. 7275573284

Maximum Length: 25

                articles*

array

                    (Array item)

object

                        itemNumber*

integer

item Number
the item number

                        itemSize*

integer

item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

                        company*

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

                        quantities*

array

                            (Array item)

object

                                customsShipmentNumber

integer

WE-Sendungsnummer
<we_number> auch 'WE-Sendungsnummer'. Im KR1 7-stellig (vgl C05).

Maximum: 99999999

                                documentNumber

integer

WAP number
<wap_number> auch ANZ-Nummer oder Warenannahmeprotokollnummer. Im KR1 6-stellig (vgl C05).

Maximum: 9999999

                                quantity*

integer

quantity
Menge des Artikels

Minimum: 1
Maximum: 1

                                responseStatus*

string

response status
3 Ausprägungen:Artikel angekommen und verzollt/Artikel angekommen und nicht verzollt/Artikel nicht angekommen obwohl verzollt

9.2 -

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        swapBodyNumber*

string

Swap Body Number
WAB-Nummer

        bins*

array

            (Array item)

object

                binCode*

string

bin code
Wannen-Barcode, eg. 7275573284

Maximum Length: 25

                articles*

array

                    (Array item)

object

                        logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

                        quantities*

array

                            (Array item)

object

                                customsShipmentNumber

integer

WE-Sendungsnummer
<we_number> auch 'WE-Sendungsnummer'. Im KR1 7-stellig (vgl C05).

Maximum: 99999999

                                documentNumber

integer

WAP number
<wap_number> auch ANZ-Nummer oder Warenannahmeprotokollnummer. Im KR1 6-stellig (vgl C05).

Maximum: 9999999

                                quantity*

integer

quantity
Menge des Artikels

Minimum: 1
Maximum: 1

                                responseStatus*

string

response status
3 Ausprägungen:Artikel angekommen und verzollt/Artikel angekommen und nicht verzollt/Artikel nicht angekommen obwohl verzollt

10 - C00 Customs Interface Overview

Status

DRAFT → stable: interfaces to/from C@TS under construction: C06 + C07 new interfaces to/from Heine-Zoll

1. Content / Business Context

This section and its subpages provide an overview of all IT systems required for customs processes and the interfaces to be exchanged.

2. Informationflow

flow

3. BreakUp of logisticsProductId in direction Hermes/Heine

To maintain functionality in legacy systems (here Hermes C@ts, or Heine customs system), which cannot be adapted to erpProductID, or this would be domain technically foreign -→ there is an agreement for product signaling by sending the 'otto'-wide known triplex (Company + ItemNo + Size) along with the logisticsProductId. The item detection is thus simplified and does not need to be changed in target systems. FINE takes care of this functionality of "ID-BreakUp". In any reply, the customs system will then only return the logisticsProductId that was prior given in. C.f. following illustration also:

flow

4. Datamodel for the messages in the error topics

Property Type Description

(Root)

object

    eventId

string (uuid)

    traceId

string (uuid)

    eventTime

string (date-time)

    eventType

(enum)

Any of: [ "LogisticsProductIdNotFound", "InternalServerError" ]

    data

object

        message

string

4.1. Schema

Table 1. Version WMS to FINE
Version Number File Published on Changes

current version

0.1

Download

19.06.2023

intitiale Version

previous version

coming version
Interface FINE to Producers
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$comment": "Schema for the messages inside the error topics of the customs interface",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/CustomsErrorResponse.v0.1.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid"
        },
        "traceId": {
            "type": "string",
            "format": "uuid"
        },
        "eventTime": {
            "type": "string",
            "format": "date-time"
        },
        "eventType": {
            "enum": [
                "LogisticsProductIdNotFound",
                "InternalServerError"
            ]
        },
        "data": {
            "type": "object",
            "properties": {
                "message": {
                    "type": "string"
                }
            }
        }
    }
}

11 - C01 Customs Registration Request to C@TS (ZO01)

Status

Version 1.0 released for C@TS and WMS, published 12.05.2023

Approval

  1. NEON: erstellt auf Basis des Pflichtenheft: NEON_Fein_Pflichtenheft_WEN2_SST_V6.2.pdf

  2. …​

Comment

Naming/notation of the interface at Körber/C@TS: ZO01

Assumption

Unknown so far.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

K.Motion

InterfaceOwner

OSP

Producer

K.Motion

Consumer

C@ts

2. Business Context

Im Wareneingang kommt sowohl verzollte als auch unverzollte OTTO-Ware an. Ankommende Ware wird somit pauschal als "gesperrt" gehandhabt, sodass das LVS eine Zollmeldung durchführen muss (nach WE Differenzenklärung, WE 1.5). Mit dem Service wird beim Zollsystem der Wareneingang angemeldet. Im Zielsystem wird geprüft ob die Ware verzollt ist, mögliche Differenzen werden vom Zollsystem korrigiert.

3. Informationflow

flow

4. Interface

4.1. Direction WMS to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

eventType

REQUEST

context

CUSTOMS

4.1.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        product*

object

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        quantity*

integer

quantity
Submitted quantity

Exclusive Maximum: 1000000000000000000

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        hAwbBl*

string

hAwbBl
House B/L or HAWB-Nummer. (Bei Luftfrachten werden derzeit die HAWB-Nummern als Zugangsnummer erfasst. Mittelfristig soll die

Maximum Length: 70

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

Table 2. Version WMS to FINE
Version Number File Published on Changes

current version

1.0

Download

14.07.2023

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WEN2_SST_V6.2.pdf)

previous version

0.1

Download

28.03.2023

Intitiale Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4(WE)_SST_Zoll.docx)

coming version
Interface WMS to FINE
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for custom registration request of a goods receipt (WMS >> FINE) [FINE:C01/KOERBER:ZO01]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C01-CustomsRegistrationRequestWms.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2016-04-16T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "examples": [
                "REQUEST",
                "RESPONSE",
                "NOTIFICATION",
                "LOADING_ADVICE",
                "MESSAGE"
            ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v2.schema.json"
                }
            }
        },
        "data": {
            "type": "object",
            "properties": {
                "product": {
                    "type": "object",
                    "properties": {
                        "logisticsProductId": {
                            "type": "string",
                            "title": "technical ID 'logistics product ID'",
                            "description": "Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.",
                            "maxLength": 36,
                            "examples": [
                                "73941806"
                            ]
                        }
                    },
                    "required": [
                        "logisticsProductId"
                    ]
                },
                "location": {
                    "type": "string",
                    "description": "Warehouse location (optional)",
                    "title": "location",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
                },
                "quantity": {
                    "type": "integer",
                    "exclusiveMaximum": 1000000000000000000,
                    "description": "Submitted quantity",
                    "title": "quantity",
                    "examples": [
                        114
                    ]
                },
                "goodsInId": {
                    "description": "The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).",
                    "type": "string",
                    "maxLength": 36,
                    "title": "the goods receipt number",
                    "examples": [
                        "228008245557"
                    ]
                },
                "customsShipmentNumber": {
                    "description": "C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [
                        8245557
                    ]
                },
                "documentNumber": {
                    "description": "C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)",
                    "type": "integer",
                    "maximum": 999999,
                    "title": "WAP number",
                    "examples": [
                        429313
                    ]
                },
                "hAwbBl": {
                    "type": "string",
                    "description": "House B/L or HAWB-Nummer. (Bei Luftfrachten werden derzeit die HAWB-Nummern als Zugangsnummer erfasst. Mittelfristig soll die",
                    "maxLength": 70,
                    "title": "hAwbBl",
                    "examples": [
                        "SGH123070029"
                    ]
                }
            },
            "required": [
                "product",
                "quantity",
                "customsShipmentNumber",
                "documentNumber",
                "hAwbBl"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ]
}

4.2. Direction FINE to C@TS

4.2.1. Header

This interface uses the Service Header

Table 3. Attribute
Fieldname Expresion

eventType

REQUEST

context

CUSTOMS

4.2.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        product*

object

            itemNumber*

integer

Item Number
the item number

            itemSize*

integer

Item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

            company*

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        quantity*

integer

quantity
Submitted quantity

Exclusive Maximum: 1000000000000000000

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        hAwbBl*

string

hAwbBl
House B/L or HAWB-Nummer. (Bei Luftfrachten werden derzeit die HAWB-Nummern als Zugangsnummer erfasst. Mittelfristig soll die

Maximum Length: 70

4.2.3. Enumeration

4.2.4. Example

4.2.5. Schema

Table 4. Version FINE to C@ts
Version Number File Published on Changes

current version

1.0

Download

14.07.2023

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WEN2_SST_V6.2.pdf)

previous version

0.1

Download

28.03.2023

Intitiale Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4(WE)_SST_Zoll.docx)

coming version
Interface FINE to C@ts
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for custom registration request of a goods receipt (FINE >> C@TS) [FINE:C01/KOERBER:ZO01]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C01-CustomsRegistrationRequestCats.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2016-04-16T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "examples": [
                "REQUEST",
                "RESPONSE",
                "NOTIFICATION",
                "LOADING_ADVICE",
                "MESSAGE"
            ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v2.schema.json"
                }
            }
        },
        "data": {
            "type": "object",
            "properties": {
                "product": {
                    "type": "object",
                    "properties": {
                        "itemNumber": {
                            "description": "the item number",
                            "type": "integer",
                            "title": "Item Number",
                            "examples": [
                                29343364
                            ]
                        },
                        "itemSize": {
                            "description": "the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')",
                            "type": "integer",
                            "title": "Item Size",
                            "examples": [
                                38,
                                907
                            ]
                        },
                        "company": {
                            "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
                        },
                        "logisticsProductId": {
                            "type": "string",
                            "title": "technical ID 'logistics product ID'",
                            "description": "Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.",
                            "maxLength": 36,
                            "examples": [
                                "73941806"
                            ]
                        }
                    },
                    "required": [
                        "itemNumber",
                        "itemSize",
                        "company",
                        "logisticsProductId"
                    ]
                },
                "location": {
                    "type": "string",
                    "description": "Warehouse location (optional)",
                    "title": "location",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
                },
                "quantity": {
                    "type": "integer",
                    "exclusiveMaximum": 1000000000000000000,
                    "description": "Submitted quantity",
                    "title": "quantity",
                    "examples": [
                        114
                    ]
                },
                "goodsInId": {
                    "description": "The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).",
                    "type": "string",
                    "maxLength": 36,
                    "title": "the goods receipt number",
                    "examples": [
                        "228008245557"
                    ]
                },
                "customsShipmentNumber": {
                    "description": "C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [
                        8245557
                    ]
                },
                "documentNumber": {
                    "description": "C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)",
                    "type": "integer",
                    "maximum": 999999,
                    "title": "WAP number",
                    "examples": [
                        429313
                    ]
                },
                "hAwbBl": {
                    "type": "string",
                    "description": "House B/L or HAWB-Nummer. (Bei Luftfrachten werden derzeit die HAWB-Nummern als Zugangsnummer erfasst. Mittelfristig soll die",
                    "maxLength": 70,
                    "title": "hAwbBl",
                    "examples": [
                        "SGH123070029"
                    ]
                }
            },
            "required": [
                "product",
                "quantity",
                "customsShipmentNumber",
                "documentNumber",
                "hAwbBl"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ]
}

5. Kafka Topics

Unresolved directive in <stdin> - include::../../../../integration-layer/topics/interfaces/C01.adoc[]

12 - C02 Customs Registration Response from C@TS (ZO51)

Status

Version 1.0 released for C@TS and WMS, published 12.05.2023

Approval

  1. NEON: erstellt auf Basis des Pflichtenheft: NEON_Fein_Pflichtenheft_WEN2_SST_V6.2.pdf

  2. …​

Comment

Naming/notation of the interface at Körber/C@TS: ZO51

Assumption

Unknown so far.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

K.Motion

InterfaceOwner

OSP

Consumer

K.Motion

Provider

C@ts

2. Business Context

Im Wareneingang kommt sowohl verzollte als auch unverzollte OTTO-Ware an. Ankommende Ware wird somit pauschal als "gesperrt" gehandhabt, sodass das LVS eine Zollmeldung durchführen muss (nach WE Differenzenklärung, WE 1,5). Im Zollsystem wurde die Ware geprüft und ggf. Differenzen nachgemeldet. Mit dem Service wird vom Zollsystem an das LVS eine Rückmeldung erteilt, ob es Freigut oder Zollgut ist.

3. Informationflow

flow

4. Interface

4.1. Direction C@ts to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

eventType

RESPONSE

context

CUSTOMS

4.1.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

sender system

Any of: [ "HERMES_C@TS", "HEINE_ZOLL" ]

    data*

object

        product*

object

            itemNumber*

string

Item Number
the item number

            itemSize*

string

Item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

            company*

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        newCustomsClearanceSign*

integer

new customs clearance sign
New returned customs clearance sign. In C@ts/WMS-term called 'Zoll KNZ, neu', e.g. '0=goods have been cleared, duty paid/1=goods must be cleared'

Minimum: 0
Exclusive Maximum: 10

        quantity*

integer

quantity
Returned quantity. In C@ts-term called 'excess/overfulfilled Qty./Übermenge'. If no overfulfilled quantity, then 0 (overfulfilled quantities are not evaluated)

Maximum: 1000000000000000000

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

Table 2. Version C@ts to FINE
Version Number File Published on Changes

current version

1.0

Download

14.07.2023

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WEN2_SST_V6.2.pdf)

previous version

0.1

Download

28.03.2023

Intitiale Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4(WE)_SST_Zoll.docx)

coming version
Interface C@ts to FINE
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for a response following on a customs registration requ. regarding an incoming goods receipt (C@TS >> FINE) [FINE:C02/KOERBER:ZO51]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C02-CustomsRegistrationResponseCats.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2016-04-16T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "examples": [
                "REQUEST",
                "RESPONSE",
                "NOTIFICATION",
                "LOADING_ADVICE",
                "MESSAGE"
            ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "type": "string",
                    "title": "sender system",
                    "enum": [
                        "HERMES_C@TS",
                        "HEINE_ZOLL"
                    ],
                    "examples": [
                        "HERMES_C@TS"
                    ]
                }
            }
        },  
        "data": {
            "type": "object",
            "properties": {
                "product": {
                    "type": "object",
                    "properties": {
                        "itemNumber": {
                            "description": "the item number",
                            "type": "string",
                            "title": "Item Number",
                            "examples": [
                                "29343364"
                            ]
                        },
                        "itemSize": {
                            "description": "the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')",
                            "type": "string",
                            "title": "Item Size",
                            "examples": [
                                "38",
                                "907"
                            ]
                        },
                        "company": {
                            "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
                        },
                        "logisticsProductId": {
                            "type": "string",
                            "title": "technical ID 'logistics product ID'",
                            "description": "Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.",
                            "maxLength": 36,
                            "examples": [
                                "73941806"
                            ]
                        }
                    },
                    "required": [
                        "itemNumber",
                        "itemSize",
                        "company",
                        "logisticsProductId"
                    ]
                },
                "location": {
                    "type": "string",
                    "description": "Warehouse location (optional)",
                    "title": "location",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
                },
                "goodsInId": {
                    "description": "The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).",
                    "type": "string",
                    "maxLength": 36,
                    "title": "the goods receipt number",
                    "examples": [
                        "228008245557"
                    ]
                },
                "customsShipmentNumber": {
                    "description": "C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [
                        8245557
                    ]
                },                
                "documentNumber": {
                    "description": "C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)",
                    "type": "integer",
                    "maximum": 999999,
                    "title": "WAP number",
                    "examples": [
                        429313
                    ]
                },
                "newCustomsClearanceSign": {
                    "type": "integer",
                    "minimum": 0,
                    "exclusiveMaximum": 10,
                    "description": "New returned customs clearance sign. In C@ts/WMS-term called 'Zoll KNZ, neu', e.g. '0=goods have been cleared, duty paid/1=goods must be cleared'",
                    "title": "new customs clearance sign",
                    "examples": [
                        0
                    ]
                },
                "quantity": {
                    "type": "integer",
                    "maximum": 999999999999999999,
                    "description": "Returned quantity. In C@ts-term called 'excess/overfulfilled Qty./Übermenge'. If no overfulfilled quantity, then 0 (overfulfilled quantities are not evaluated)",
                    "title": "quantity",
                    "examples": [
                        114
                    ]
                }
            },
            "required": [
                "product",
                "customsShipmentNumber",
                "documentNumber",
                "newCustomsClearanceSign",
                "quantity"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ]
}

4.2. Direction FINE to WMS

4.2.1. Header

This interface uses the Service Header

Table 3. Attribute
Fieldname Expresion

eventType

RESPONSE

context

CUSTOMS

4.2.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

sender system

Any of: [ "HERMES_C@TS", "HEINE_ZOLL" ]

    data*

object

        product*

object

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        newCustomsClearanceSign*

integer

new customs clearance sign
New returned customs clearance sign. In C@ts/WMS-term called 'Zoll KNZ, neu', e.g. '0=goods have been cleared, duty paid/1=goods must be cleared'

Minimum: 0
Exclusive Maximum: 10

        quantity*

integer

quantity
Returned quantity. In C@ts-term called 'excess/overfulfilled Qty./Übermenge'. If no overfulfilled quantity, then 0 (overfulfilled quantities are not evaluated)

Maximum: 1000000000000000000

4.2.3. Enumeration

4.2.4. Example

4.2.5. Schema

Table 4. Version FINE to WMS
Version Number File Published on Changes

current version

1.0

Download

14.07.2023

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WEN2_SST_V6.2.pdf)

previous version

0.1

Download

28.03.2023

intitial Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4(WE)_SST_Zoll.docx)

coming version
Interface FINE to WMS
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for a response following on a customs registration requ. regarding an incoming goods receipt (FINE >> WMS) [FINE:C02/KOERBER:ZO51]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C02-CustomsRegistrationResponseWms.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2016-04-16T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "examples": [
                "REQUEST",
                "RESPONSE",
                "NOTIFICATION",
                "LOADING_ADVICE",
                "MESSAGE"
            ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "type": "string",
                    "title": "sender system",
                    "enum": [
                        "HERMES_C@TS",
                        "HEINE_ZOLL"
                    ],
                    "examples": [
                        "HERMES_C@TS"
                    ]
                }
            }
        },        
        "data": {
            "type": "object",
            "properties": {
                "product": {
                    "type": "object",
                    "properties": {
                        "logisticsProductId": {
                            "type": "string",
                            "title": "technical ID 'logistics product ID'",
                            "description": "Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.",
                            "maxLength": 36,
                            "examples": [
                                "73941806"
                            ]
                        }
                    },                
                    "required": [
                        "logisticsProductId"
                    ]
                },
                "location": {
                    "type": "string",
                    "description": "Warehouse location (optional)",
                    "title": "location",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
                },
                "goodsInId": {
                    "description": "The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).",
                    "type": "string",
                    "maxLength": 36,
                    "title": "the goods receipt number",
                    "examples": [
                        "228008245557"
                    ]
                },
                "customsShipmentNumber": {
                    "description": "C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [
                        8245557
                    ]
                },                   
                "documentNumber": {
                    "description": "C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)",
                    "type": "integer",
                    "maximum": 999999,
                    "title": "WAP number",
                    "examples": [
                        429313
                    ]
                },
                "newCustomsClearanceSign": {
                    "type": "integer",
                    "minimum": 0,
                    "exclusiveMaximum": 10,
                    "description": "New returned customs clearance sign. In C@ts/WMS-term called 'Zoll KNZ, neu', e.g. '0=goods have been cleared, duty paid/1=goods must be cleared'",
                    "title": "new customs clearance sign",
                    "examples": [
                        0
                    ]
                },
                "quantity": {
                    "type": "integer",
                    "maximum": 999999999999999999,
                    "description": "Returned quantity. In C@ts-term called 'excess/overfulfilled Qty./Übermenge'. If no overfulfilled quantity, then 0 (overfulfilled quantities are not evaluated)",
                    "title": "quantity",
                    "examples": [
                        114
                    ]
                }
            },
            "required": [
                "product",
                "customsShipmentNumber",
                "documentNumber",
                "newCustomsClearanceSign",
                "quantity"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ]
}

5. Kafka Topics

Unresolved directive in <stdin> - include::../../../../integration-layer/topics/interfaces/C02.adoc[]

13 - C03 Customs Notifications On Picking Goods to C@TS (ZO02)

Status

Version 1.0 released for C@TS and WMS, published 12.05.2023

Approval

  1. NEON: erstellt auf Basis des Pflichtenheft: NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf

  2. …​

Comment

Naming/notation of the interface at Körber/C@TS: ZO02

Assumptions

Unknown so far.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

K.Motion

InterfaceOwner

OSP

Producer

K.Motion

Consumer

C@ts

2. Business Context

Im Warenausgang sind bei zollpflichtiger Ware ggfls. Meldungen an C@ts zu übermitteln. Bereits bei der (platzbezogenen) Reservierung (im Rahmen der Batchbildung) werden vom WMS in speziellen Fällen je reservierter Auftragspositionsmenge Zollanmeldungen (ZO02) an das C@ts–System übertragen. Das WMS sendet die Anfrage nur beim zollrelevanten Bestand: d.h. Quantenstatus ist entweder "unbestimmt" oder "zoll". Die Attribute für Artikelgröße und Bestandsfirma (benötigt auf C@ts-Seite) entfallen in der Schnittstelle zwischen WMS und FINE. Für den Austausch zwischen FINE und C@ts werden diese von der FINE-Schicht über die logisticsProductId hinzugefügt.

3. Informationflow

flow

4. Interface

4.1. Direction WMS to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

eventType

NOTIFICATION

context

CUSTOMS

4.1.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string (enum)

The type of operation
Typ der Nachricht

Any of: [ "CUSTOMS_NOTIFICATION_PICKING_GOODS" ]

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        product*

object

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        stockRemovalDate*

string

stock removal date
Stock removal date of customs affected item/product (ddMMYYY). In C@ts/WMS-terms aka. 'Tag der Auslagerung / DAT_OUTSOURCING'.

Regular expression: ^((0[1-9])|(1[0-9])|(2[0-9])|(3[0-1]))((0[1-9])|(1[0-2]))((19\d\d)|(20\d\d))$

        quantity*

integer

quantity
Stock removed quantity of item/product. In C@ts/WMS-terms aka. 'Entnommene Menge des Artikels'

Maximum: 1000000000000000000

        customsClearanceSign*

number

customs clearance sign
Reported customs clearance sign/status. In C@ts/WMS-terms called 'Zoll KNZ', e.g. '0 = Goods have been cleared (regarding items in WMS with customs status 05 = 'customs')

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

Table 2. Version WMS to FINE
Version Number File Published on Changes

current version

1.0

Download

14.07.2023

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf)

previous version

0.1

Download

28.03.2023

Intitiale Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4(WE)_SST_Zoll.docx)

coming version
Interface WMS to FINE
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for stock removal (picking goods) and subsequent/following customs message (WMS >> FINE) [FINE:C03/KOERBER:ZO02]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C03-CustomsNotificationsOnPickingGoodsWms.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2016-04-16T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "enum": [ 
                "CUSTOMS_NOTIFICATION_PICKING_GOODS"
              ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v2.schema.json"
                }
            }
        },
        "data": {
            "type": "object",
            "properties": {
                "product": {
                    "type": "object",
                    "properties": {
                        "logisticsProductId": {
                            "type": "string",
                            "title": "technical ID 'logistics product ID'",
                            "description": "Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.",
                            "maxLength": 36,
                            "examples": [
                                "73941806"
                            ]
                        }
                    },
                    "required": [
                        "logisticsProductId"
                    ]
                },
                "location": {
                    "type": "string",
                    "description": "Warehouse location (optional)",
                    "title": "location",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
                },
                "goodsInId": {
                    "description": "The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).",
                    "type": "string",
                    "maxLength": 36,
                    "title": "the goods receipt number",
                    "examples": [
                        "228008245557"
                    ]
                },
                "customsShipmentNumber": {
                    "description": "C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [
                        8245557
                    ]
                },                
                "documentNumber": {
                    "description": "C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)",
                    "type": "integer",
                    "maximum": 999999,
                    "title": "WAP number",
                    "examples": [
                        429313
                    ]
                },
                "stockRemovalDate": {
                    "description": "Stock removal date of customs affected item/product (ddMMYYY). In C@ts/WMS-terms aka. 'Tag der Auslagerung / DAT_OUTSOURCING'.",
                    "type": "string",
                    "pattern": "^((0[1-9])|(1[0-9])|(2[0-9])|(3[0-1]))((0[1-9])|(1[0-2]))((19\\d\\d)|(20\\d\\d))$",
                    "title": "stock removal date",
                    "examples": [
                        "14032023"
                    ]
                },
                "quantity": {
                    "type": "integer",
                    "maximum": 999999999999999999,
                    "description": "Stock removed quantity of item/product. In C@ts/WMS-terms aka. 'Entnommene Menge des Artikels'",
                    "title": "quantity",
                    "examples": [
                        1
                    ]
                },
                "customsClearanceSign": {
                    "type": "number",
                    "description": "Reported customs clearance sign/status. In C@ts/WMS-terms called 'Zoll KNZ', e.g. '0 = Goods have been cleared (regarding items in WMS with customs status 05 = 'customs')",
                    "title": "customs clearance sign",
                    "examples": [
                        0
                    ]
                }
            },
            "required": [
                "product",
                "customsShipmentNumber",
                "documentNumber",
                "stockRemovalDate",
                "quantity",
                "customsClearanceSign"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ]
}

4.2. Direction FINE to C@TS

4.2.1. Header

This interface uses the Service Header

Table 3. Attribute
Fieldname Expresion

eventType

NOTIFICATION

context

CUSTOMS

4.2.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string (enum)

The type of operation
Typ der Nachricht

Any of: [ "CUSTOMS_NOTIFICATION_PICKING_GOODS" ]

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        product*

object

            itemNumber*

integer

Item Number
the item number

            itemSize*

integer

Item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

            company*

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        stockRemovalDate*

string

stock removal date
Stock removal date of customs affected item/product (ddMMYYY). In C@ts/WMS-terms aka. 'Tag der Auslagerung / DAT_OUTSOURCING'.

Regular expression: ^((0[1-9])|(1[0-9])|(2[0-9])|(3[0-1]))((0[1-9])|(1[0-2]))((19\d\d)|(20\d\d))$

        quantity*

integer

quantity
Stock removed quantity of item/product. In C@ts/WMS-terms aka. 'Entnommene Menge des Artikels'

Maximum: 1000000000000000000

        customsClearanceSign*

number

customs clearance sign
Reported customs clearance sign/status. In C@ts/WMS-terms called 'Zoll KNZ', e.g. '0 = Goods have been cleared (regarding items in WMS with customs status 05 = 'customs')

4.2.3. Enumeration

4.2.4. Example

4.2.5. Schema

Table 4. Version FINE to C@ts
Version Number File Published on Changes

current version

1.0

Download

14.07.2023

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf)

previous version

0.1

Download

28.03.2023

Intitiale Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4(WE)_SST_Zoll.docx)

coming version
Interface FINE to C@ts
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for stock removal (picking goods) and subsequent/following customs message (FINE >> C@TS) [FINE:C03/KOERBER:ZO02]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C03-CustomsNotificationsOnPickingGoodsCats.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2016-04-16T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "enum": [ 
                "CUSTOMS_NOTIFICATION_PICKING_GOODS"
              ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v2.schema.json"
                }
            }
        },
        "data": {
            "type": "object",
            "properties": {
                "product": {
                    "type": "object",
                    "properties": {
                        "itemNumber": {
                            "description": "the item number",
                            "type": "integer",
                            "title": "Item Number",
                            "examples": [
                                29343364
                            ]
                        },
                        "itemSize": {
                            "description": "the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')",
                            "type": "integer",
                            "title": "Item Size",
                            "examples": [
                                38,
                                907
                            ]
                        },
                        "company": {
                            "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
                        },
                        "logisticsProductId": {
                            "type": "string",
                            "title": "technical ID 'logistics product ID'",
                            "description": "Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.",
                            "maxLength": 36,
                            "examples": [
                                "73941806"
                            ]
                        }
                    },
                    "required": [
                        "itemNumber",
                        "itemSize",
                        "company",
                        "logisticsProductId"
                    ]
                },
                "location": {
                    "type": "string",
                    "description": "Warehouse location (optional)",
                    "title": "location",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
                },
                "goodsInId": {
                    "description": "The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).",
                    "type": "string",
                    "maxLength": 36,
                    "title": "the goods receipt number",
                    "examples": [
                        "228008245557"
                    ]
                },
                "customsShipmentNumber": {
                    "description": "C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [
                        8245557
                    ]
                },
                "documentNumber": {
                    "description": "C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)",
                    "type": "integer",
                    "maximum": 999999,
                    "title": "WAP number",
                    "examples": [
                        429313
                    ]
                },
                "stockRemovalDate": {
                    "description": "Stock removal date of customs affected item/product (ddMMYYY). In C@ts/WMS-terms aka. 'Tag der Auslagerung / DAT_OUTSOURCING'.",
                    "type": "string",
                    "pattern": "^((0[1-9])|(1[0-9])|(2[0-9])|(3[0-1]))((0[1-9])|(1[0-2]))((19\\d\\d)|(20\\d\\d))$",
                    "title": "stock removal date",
                    "examples": [
                        "14032023"
                    ]
                },
                "quantity": {
                    "type": "integer",
                    "maximum": 999999999999999999,
                    "description": "Stock removed quantity of item/product. In C@ts/WMS-terms aka. 'Entnommene Menge des Artikels'",
                    "title": "quantity",
                    "examples": [
                        1
                    ]
                },
                "customsClearanceSign": {
                    "type": "number",
                    "description": "Reported customs clearance sign/status. In C@ts/WMS-terms called 'Zoll KNZ', e.g. '0 = Goods have been cleared (regarding items in WMS with customs status 05 = 'customs')",
                    "title": "customs clearance sign",
                    "examples": [
                        0
                    ]
                }
            },
            "required": [
                "product",
                "customsShipmentNumber",
                "documentNumber",
                "stockRemovalDate",
                "quantity",
                "customsClearanceSign"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ]
}

5. Kafka Topics

Unresolved directive in <stdin> - include::../../../../integration-layer/topics/interfaces/C03.adoc[]

14 - C04 Customs Stock Summary Messages to C@TS (ZO03)

Status

Version 1.0 released for C@TS and WMS, published 12.05.2023

Approval

  1. NEON: erstellt auf Basis des Pflichtenheft: NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf

  2. …​

Comment

Naming/notation of the interface at Körber/C@TS: ZO03

Assumptions

Unknown so far.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

K.Motion

InterfaceOwner

OSP

Producer

K.Motion

Consumer

C@ts

2. Business Context

Über dieses Verfahren wird der gesamte zollrelevante Bestand (ZO03) zum Abgleich geliefert. Diese Meldung erfolgt (im InitialCase: Ilowa(k.Motion) agains C@ts) einmal wöchentlich am Sonntag um 4:00 Uhr. Das WMS sendet nur den zollrelevanten Bestand: d.h. Quantenstatus ist entweder „unbestimmt“ oder „zoll“. Die Attribute für Artikelgröße und Bestandsfirma (benötigt auf C@ts-Seite) entfallen in der Schnittstelle zwischen WMS und FINE. Für den Austausch zwischen FINE und C@ts werden diese von der FINE-Schicht über die logisticsProductId hinzugefügt.

3. Informationflow

flow

4. Interface

4.1. Direction WMS to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

eventType

MESSAGE

context

CUSTOMS

4.1.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string (enum)

The type of operation
Typ der Nachricht

Any of: [ "CUSTOMS_STOCK_SUMMARY" ]

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        product*

object

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        quantity*

integer

Reported quantity
Reported recent quantity (available + reserved qty's) of the customs related item in the whole warehouse per logisticsProductId and customs indication/status (add up all quantum).

Maximum: 1000000000000000000

        customsClearanceSign*

integer

customs clearance sign
Reported customs clearance sign/status. In C@ts/WMS-terms called 'Zoll KNZ', e.g. '1 = Item can be cleared through customs, customs clearance notification (ZO51) is available. 2 = Item cannot be cleared through customs, customs release notification (ZO51) is not yet available. (In the WMS, customs status 'undetermined')'

Minimum: 0
Exclusive Maximum: 10

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

Table 2. Version WMS to FINE
Version Number File Published on Changes

current version

1.0

Download

14.07.2023

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf)

previous version

0.1

Download

28.03.2023

Intitiale Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4(WE)_SST_Zoll.docx)

coming version
Interface WMS to FINE
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for weekly reported customs regarding all relevant inventory/stock (WMS >> FINE) [FINE:C04/KOERBER:ZO03]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C04-CustomsStockSummaryMessagesWms.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2016-04-16T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "enum": [ 
                "CUSTOMS_STOCK_SUMMARY"
              ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v2.schema.json"
                }
            }
        },
        "data": {
            "type": "object",
            "properties": {
                "product": {
                    "type": "object",
                    "properties": {
                        "logisticsProductId": {
                            "type": "string",
                            "title": "technical ID 'logistics product ID'",
                            "description": "Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.",
                            "maxLength": 36,
                            "examples": [
                                "73941806"
                            ]
                        }
                    },
                    "required": [
                        "logisticsProductId"
                    ]
                },
                "location": {
                    "type": "string",
                    "description": "Warehouse location (optional)",
                    "title": "location",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
                },
                "goodsInId": {
                    "description": "The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).",
                    "type": "string",
                    "maxLength": 36,
                    "title": "the goods receipt number",
                    "examples": [
                        "228008245557"
                    ]
                },
                "customsShipmentNumber": {
                    "description": "C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [
                        8245557
                    ]
                },
                "documentNumber": {
                    "description": "C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)",
                    "type": "integer",
                    "maximum": 999999,
                    "title": "WAP number",
                    "examples": [
                        429313
                    ]
                },                                  
                "quantity": {
                    "type": "integer",
                    "maximum": 999999999999999999,
                    "description": "Reported recent quantity (available + reserved qty's) of the customs related item in the whole warehouse per logisticsProductId and customs indication/status (add up all quantum).",
                    "title": "Reported quantity",
                    "examples": [
                        2094
                    ]
                },
                "customsClearanceSign": {
                    "type": "integer",
                    "minimum": 0,
                    "exclusiveMaximum": 10,
                    "description": "Reported customs clearance sign/status. In C@ts/WMS-terms called 'Zoll KNZ', e.g. '1 = Item can be cleared through customs, customs clearance notification (ZO51) is available. 2 = Item cannot be cleared through customs, customs release notification (ZO51) is not yet available. (In the WMS, customs status 'undetermined')'",
                    "title": "customs clearance sign",
                    "examples": [
                        1,
                        2
                    ]
                }
            },
            "required": [
                "product",
                "customsShipmentNumber",
                "documentNumber",
                "quantity",
                "customsClearanceSign"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ]
}

4.2. Direction FINE to C@TS

4.2.1. Header

This interface uses the Service Header

Table 3. Attribute
Fieldname Expresion

eventType

MESSAGE

context

CUSTOMS

4.2.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string (enum)

The type of operation
Typ der Nachricht

Any of: [ "CUSTOMS_STOCK_SUMMARY" ]

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        product*

object

            itemNumber*

integer

Item Number
the item number

            itemSize*

integer

Item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

            company*

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

        location

string (enum)

location
Warehouse location (optional)

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

        goodsInId

string

the goods receipt number
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

        customsShipmentNumber*

integer

WE-Sendungsnummer
C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

        documentNumber*

integer

WAP number
C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

        quantity*

integer

Reported quantity
Reported recent quantity (available + reserved qty's) of the customs related item in the whole warehouse per logisticsProductId and customs indication/status (add up all quantum).

Maximum: 1000000000000000000

        customsClearanceSign*

integer

customs clearance sign
Reported customs clearance sign/status. In C@ts/WMS-terms called 'Zoll KNZ', e.g. '1 = Item can be cleared through customs, customs clearance notification (ZO51) is available. 2 = Item cannot be cleared through customs, customs release notification (ZO51) is not yet available. (In the WMS, customs status 'undetermined')'

Minimum: 0
Exclusive Maximum: 10

4.2.3. Enumeration

4.2.4. Example

4.2.5. Schema

Table 4. Version FINE to C@ts
Version Number File Published on Changes

current version

1.0

Download

14.07.2023

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf)

previous version

0.1

Download

28.03.2023

Intitiale Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4(WE)_SST_Zoll.docx)

coming version
Interface FINE to C@ts
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for weekly reported customs regarding all relevant inventory/stock (FINE >> C@TS) [FINE:C04/KOERBER:ZO03]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C04-CustomsStockSummaryMessagesCats.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2016-04-16T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "enum": [ 
                "CUSTOMS_STOCK_SUMMARY"
              ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v2.schema.json"
                }
            }
        },
        "data": {
            "type": "object",
            "properties": {
                "product": {
                    "type": "object",
                    "properties": {
                        "itemNumber": {
                            "description": "the item number",
                            "type": "integer",
                            "title": "Item Number",
                            "examples": [
                                29343364
                            ]
                        },
                        "itemSize": {
                            "description": "the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')",
                            "type": "integer",
                            "title": "Item Size",
                            "examples": [
                                38,
                                907
                            ]
                        },
                        "company": {
                            "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
                        },
                        "logisticsProductId": {
                            "type": "string",
                            "title": "technical ID 'logistics product ID'",
                            "description": "Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.",
                            "maxLength": 36,
                            "examples": [
                                "73941806"
                            ]
                        }
                    },
                    "required": [
                        "itemNumber",
                        "itemSize",
                        "company",
                        "logisticsProductId"
                    ]
                },
                "location": {
                    "type": "string",
                    "description": "Warehouse location (optional)",
                    "title": "location",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
                },
                "goodsInId": {
                    "description": "The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).",
                    "type": "string",
                    "maxLength": 36,
                    "title": "the goods receipt number",
                    "examples": [
                        "228008245557"
                    ]
                },
                "customsShipmentNumber": {
                    "description": "C@ts 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [
                        8245557
                    ]
                },
                "documentNumber": {
                    "description": "C@ts ANZ/WAP number (aka. Warenannahmeprotokollnummer). Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)",
                    "type": "integer",
                    "maximum": 999999,
                    "title": "WAP number",
                    "examples": [
                        429313
                    ]
                },
                "quantity": {
                    "type": "integer",
                    "maximum": 999999999999999999,
                    "description": "Reported recent quantity (available + reserved qty's) of the customs related item in the whole warehouse per logisticsProductId and customs indication/status (add up all quantum).",
                    "title": "Reported quantity",
                    "examples": [
                        2094
                    ]
                },
                "customsClearanceSign": {
                    "type": "integer",
                    "minimum": 0,
                    "exclusiveMaximum": 10,
                    "description": "Reported customs clearance sign/status. In C@ts/WMS-terms called 'Zoll KNZ', e.g. '1 = Item can be cleared through customs, customs clearance notification (ZO51) is available. 2 = Item cannot be cleared through customs, customs release notification (ZO51) is not yet available. (In the WMS, customs status 'undetermined')'",
                    "title": "customs clearance sign",
                    "examples": [
                        1,
                        2
                    ]
                }
            },
            "required": [
                "product",
                "customsShipmentNumber",
                "documentNumber",
                "quantity",
                "customsClearanceSign"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ]
}

5. Kafka Topics

Unresolved directive in <stdin> - include::../../../../integration-layer/topics/interfaces/C04.adoc[]

15 - C05 Customs Order Picking to Heine (SST03/4AB)

Status

Version 1.0 released for HEINE and WMS, published 05.09.2023

Approval

  1. NEON: erstellt auf Basis des Pflichtenheft: NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf

  2. …​

Comment

Naming/notation of the interface at Heine/Körber: 4AB / SST03

Assumptions

'Heine-Zoll' as legacy system expects the messages as XML file. An adapter/conversion in the middle from FINE (Json) to Heine (XML) needs further planning and is currently 'out of scope' for this standard interface spec.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

K.Motion

InterfaceOwner

OSP

Producer

K.Motion

Consumer

Heine

2. Business Context

Heine verzollt Sendungen mit seiner Software für Otto Konzerntöchter als interner Dienstleister. Das Verfahren wird namentlich als "4AB" geführt. Nach dem Picking und der Zusammenstellung von Kundensendungen in WMS-Lokationen, erfolgt eine Meldung der Paketinhalte mit Mandantenbezug an Heine. In den Meldungen gibt es aufgezählte Sendungen (consignments) und deren beinhaltete Produkte (products). Die Produkte werden entsprechend ihrer Quantitäten (quantities) als 'Freigut' bzw. als 'Zollgut (dann mit WE-/WAP-Bezug)' gelistet. Ist die Quantität 'Zollgut', so hat sie einen 'bonded_stock'-Bezug, der auf die 'WE/WAP-Nummern' referenziert. Heine-Zoll "4AB" übernimmt daraufhin mit den übermittelten Informationen die zollrelevanten Meldungen für den Otto Group Mandanten.

Die Attribute für Artikelgröße und Bestandsfirma (benötigt auf Heine-Seite) entfallen in der Schnittstelle zwischen WMS und FINE. Für den Austausch zwischen FINE und Heine-Zoll werden diese von der FINE-Schicht über die logisticsProductId hinzugefügt.

3. Informationflow

flow

4. Interface

4.1. Direction WMS to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

eventType

NOTIFICATION

context

CUSTOMS

4.1.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

        messageNumber

integer

Current number of the message in this batch. The first message has the number 1.

Minimum: 1
Maximum: 999999999

    data*

object

        location*

string (enum)

Warehouse location

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

        market*

string

market
SST03/4AB: <market>, according Heine-TargetFormat-XSD: the target market (ISO 3166-1 ALPHA-2)

Maximum Length: 2

        clientKey*

string (enum)

client key
SST03/4AB: <client_key>, internal id of otto group companies who use HEINE's customs services

Any of: [ "6PM-CH", "ABOUTYOU-CH", "ACKERMANN-CH", "BESTSELLER-CH", "BONPRIX-CH", "BRAVEHEART-CH", "FGH-BONPRIX-GB", "FGH-DIRECT-DELIVERY-GB", "FGH-OTTO-GB", "FGH-SCHWAB-GB", "FGH-WITT-GB", "FRANKONIA-CH", "HEINE-CH", "JELMOLI-CH", "LIEBESKIND-CH", "MAGAZIN-CH", "MAGAZIN-TH", "MAGAZIN-US", "MANUFACTUM-CH", "MANUFACTUM-HK", "MANUFACTUM-TH", "MANUFACTUM-US", "MYTOYS-CH", "QUELLE-CH", "SIEHAN!-CH", "SOLIVER-CH", "SPS-CH", "WITT-CH" ]
Minimum Length: 1
Maximum Length: 22

        invoiceDate*

string (date-time)

invoice date
SST03/4AB: <invoice_date> (optional), if invoicing takes place only when goods are issued (NEON)

        consignments*

array

SST03/4AB: <consignment>, multiple without outer consignments brackets in Heine's XML taget format.

Minimum number of items 1

            (Array item)

object

                consignmentBarcode*

string

consignment barcode
SST03/4AB: <consignment_barcode>, contains shipment/tracking number of consignment

Maximum Length: 40

                products*

array

products
SST03/4AB: <product>, multiple …​ without outer products brackets in Heine's XML taget format. c.f. shipped products in customers parcel/consignment.

Minimum number of items 1

                    (Array item)

object

                        logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

                        quantities*

array

quantities
SST03/4AB: <quantity>, multiple without outer quantities brackets in Heine's XML taget format. quantities of same product in one consignment/shipment (n' records à qty=1 >> for 'OrderQuantities > 1' of same product)

Minimum number of items 1

                            (Array item)

object

                                quantity

integer

quantity
SST03/4AB: <qty>, Specific amount of ItemSpecificQuantity, mainly: qty=1

Minimum: 1
Maximum: 1

                                buidId

string

buid id
SST03/4AB: <buid_id>, optional - ID used for unique/specific item shipped

Maximum Length: 99

                                externalReference

string

external reference
SST03/4AB: <external_reference>, optional - ID used for unique/specific prospected goods returned item

Maximum Length: 128

                                containerPackaging

string

Container Packaging
Gebindenorm (11-17: Auslieferkartons, 40-43: Ausliefertüten (Tütennorm F4,F5,F7,F8), 1-7: RL-Kolli vom KR1)

Maximum Length: 2

                                storageType

string (enum)

Storage Type
PICKING -> Kommissionierung, RESERVE -> Reservelager

Any of: [ "PICKING", "RESERVE" ]

                                storageLocationType

string (enum)

Storage Location Type
gibt an, in welches Lager der Artikel soll. FREE -> kein Zolllager. BONDED -> Zolllager

Any of: [ "BONDED", "FREE" ]

                                bondedStock

object

SST03/4AB: <bonded_stock>, optional customs bonded information (if customs related) regarding inbound id's, c.f. 'WE/WAP'

                                    goodsInId

string

the goods receipt number/id
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

                                    customsShipmentNumber*

integer

WE-Sendungsnummer
SST03/4AB: <we_number>, >> 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

                                    documentNumber*

integer

WAP number
SST03/4AB: <wap_number>, In Customs/WMS-terms aka. 'ANZ-Nummer (aka. Warenannahmeprotokollnummer)'. Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

Table 2. Version WMS to FINE
Version Number File Published on Changes

current version

1.0

Download

14.07.2023

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf)

previous version

0.1

Download

28.03.2023

Intitiale Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_Heine.docx)

coming version
Interface WMS to FINE
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for stock removal/picking and subsequent/following customs message (WMS >> FINE) [FINE:C05/HEINE:SST03,4AB]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C05-CustomsOrderPicking2HeineWms.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2016-04-16T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "examples": [
                "REQUEST",
                "RESPONSE",
                "NOTIFICATION",
                "LOADING_ADVICE",
                "MESSSAGE"
            ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v2.schema.json"
                },
                "messageNumber": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 999999999,
                    "description": "Current number of the message in this batch. The first message has the number 1."
                }
            }
        },
        "data": {
            "type": "object",
            "properties": {
                "location": {
                    "type": "string",
                    "title": "Warehouse location",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
                },
                "market": {
                    "type": "string",
                    "title": "market",
                    "description": "SST03/4AB: <market>, according Heine-TargetFormat-XSD: the target market (ISO 3166-1 ALPHA-2)",
                    "maxLength": 2
                },
                "clientKey": {
                    "type": "string",
                    "title": "client key",
                    "enum": ["6PM-CH", "ABOUTYOU-CH", "ACKERMANN-CH", "BESTSELLER-CH", "BONPRIX-CH", "BRAVEHEART-CH", "FGH-BONPRIX-GB", "FGH-DIRECT-DELIVERY-GB", "FGH-OTTO-GB", "FGH-SCHWAB-GB", "FGH-WITT-GB", "FRANKONIA-CH", "HEINE-CH", "JELMOLI-CH", "LIEBESKIND-CH", "MAGAZIN-CH", "MAGAZIN-TH", "MAGAZIN-US", "MANUFACTUM-CH", "MANUFACTUM-HK", "MANUFACTUM-TH", "MANUFACTUM-US", "MYTOYS-CH", "QUELLE-CH", "SIEHAN!-CH", "SOLIVER-CH", "SPS-CH", "WITT-CH"],
                    "minLength": 1,
                    "maxLength": 22,
                    "description": "SST03/4AB: <client_key>, internal id of otto group companies who use HEINE's customs services"
                },
                "invoiceDate": {
                    "type": "string",
                    "format":"date-time",
                    "title": "invoice date",
                    "description": "SST03/4AB: <invoice_date> (optional), if invoicing takes place only when goods are issued (NEON)"
                },
                "consignments":{
                    "type": "array",
                    "items": { "$ref": "#/$defs/consignment" },
                    "minItems": 1,
                    "description": "SST03/4AB: <consignment>, multiple without outer consignments brackets in Heine's XML taget format."
                }
            },
            "required": [
                "location",
                "market",
                "clientKey",
                "invoiceDate",
                "consignments"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ],
    "$defs": {
        "consignment": {
            "type": "object",
            "properties": {
                "consignmentBarcode": {
                    "type": "string",
                    "title": "consignment barcode",
                    "description": "SST03/4AB: <consignment_barcode>, contains shipment/tracking number of consignment",
                    "maxLength": 40
                },
                "products":{
                    "type": "array",
                    "items": { "$ref": "#/$defs/product" },
                    "minItems": 1,
                    "title": "products",
                    "description": "SST03/4AB: <product>, multiple ... without outer products brackets in Heine's XML taget format. c.f. shipped products in customers parcel/consignment."
                }    
            },
            "required": [
                "consignmentBarcode",
                "products"
            ]
        },
        "product": {
            "type": "object",
            "properties": {
                "logisticsProductId": {
                    "type": "string",
                    "title": "technical ID 'logistics product ID'",
                    "description": "Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.",
                    "maxLength": 36
                },
                "quantities":{
                    "type": "array",
                    "title": "quantities",
                    "items": { "$ref": "#/$defs/quantity" },
                    "minItems": 1,
                    "description": "SST03/4AB: <quantity>, multiple without outer quantities brackets in Heine's XML taget format. quantities of same product in one consignment/shipment (n' records à qty=1 >> for 'OrderQuantities > 1' of same product)"
                }  
            },
            "required": [
                "logisticsProductId",
                "quantities"
            ]
        },
        "quantity": {
            "type": "object",
            "properties": {
                "quantity": {
                    "type": "integer",
                    "title": "quantity",
                    "minimum": 1,
                    "maximum": 1,
                    "description": "SST03/4AB: <qty>, Specific amount of ItemSpecificQuantity, mainly: qty=1"
                },
                "buidId": {
                    "type": "string",
                    "title": "buid id",
                    "maxLength": 99,
                    "description": "SST03/4AB: <buid_id>, optional - ID used for unique/specific item shipped"
                },
                "externalReference": {
                    "type": "string",
                    "title": "external reference",
                    "maxLength": 128,
                    "description": "SST03/4AB: <external_reference>, optional - ID used for unique/specific prospected goods returned item"
                },
                "containerPackaging": {
                    "title": "Container Packaging",
                    "description": "Gebindenorm (11-17: Auslieferkartons, 40-43: Ausliefertüten (Tütennorm F4,F5,F7,F8), 1-7: RL-Kolli vom KR1)",
                    "type": "string",
                    "maxLength": 2
                },
                "storageType": {
                    "title": "Storage Type",
                    "description": "PICKING -> Kommissionierung, RESERVE -> Reservelager",
                    "type": "string",
                    "enum": [
                        "PICKING",
                        "RESERVE"
                    ]
                },
                "storageLocationType": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/Customs/StorageLocationType.v1.schema.json"
                },
                "bondedStock": {
                    "type": "object",
                    "description": "SST03/4AB: <bonded_stock>, optional customs bonded information (if customs related) regarding inbound id's, c.f. 'WE/WAP'",
                    "properties": {
                        "goodsInId": {
                            "description": "The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).",
                            "type": "string",
                            "maxLength": 36,
                            "title": "the goods receipt number/id",
                            "examples": [
                                "228008245557"
                            ]
                        },
                        "customsShipmentNumber": {
                            "description": "SST03/4AB: <we_number>, >> 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.",
                            "type": "integer",
                            "maximum": 9999999,
                            "title": "WE-Sendungsnummer",
                            "examples": [
                                8245557
                            ]
                        },
                        "documentNumber": {
                            "description": "SST03/4AB: <wap_number>, In Customs/WMS-terms aka. 'ANZ-Nummer (aka. Warenannahmeprotokollnummer)'. Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)",
                            "type": "integer",
                            "maximum": 999999,
                            "title": "WAP number",
                            "examples": [
                                429313
                            ]
                        }
                    },
                    "required": [
                        "customsShipmentNumber",
                        "documentNumber"
                    ]
                }
            },
            "required": [
                "qty"
            ]
        }       
    }
}

4.2. Direction FINE to Heine-Zoll

4.2.1. Header

This interface uses the Service Header

Table 3. Attribute
Fieldname Expresion

eventType

NOTIFICATION

context

CUSTOMS

4.2.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

        messageNumber

integer

Current number of the message in this batch. The first message has the number 1.

Minimum: 1
Maximum: 999999999

    data*

object

        location*

string (enum)

Warehouse location

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

        market*

string

market
SST03/4AB: <market>, according Heine-TargetFormat-XSD: the target market (ISO 3166-1 ALPHA-2)

Maximum Length: 2

        clientKey*

string (enum)

client key
SST03/4AB: <client_key>, internal id of otto group companies who use HEINE's customs services

Any of: [ "6PM-CH", "ABOUTYOU-CH", "ACKERMANN-CH", "BESTSELLER-CH", "BONPRIX-CH", "BRAVEHEART-CH", "FGH-BONPRIX-GB", "FGH-DIRECT-DELIVERY-GB", "FGH-OTTO-GB", "FGH-SCHWAB-GB", "FGH-WITT-GB", "FRANKONIA-CH", "HEINE-CH", "JELMOLI-CH", "LIEBESKIND-CH", "MAGAZIN-CH", "MAGAZIN-TH", "MAGAZIN-US", "MANUFACTUM-CH", "MANUFACTUM-HK", "MANUFACTUM-TH", "MANUFACTUM-US", "MYTOYS-CH", "QUELLE-CH", "SIEHAN!-CH", "SOLIVER-CH", "SPS-CH", "WITT-CH" ]
Minimum Length: 1
Maximum Length: 22

        invoiceDate*

string (date-time)

invoice date
SST03/4AB: <invoice_date> (optional), if invoicing takes place only when goods are issued (NEON)

        consignments*

array

SST03/4AB: <consignment>, multiple without outer consignments brackets in Heine's XML taget format.

Minimum number of items 1

            (Array item)

object

                consignmentBarcode*

string

consignment barcode
SST03/4AB: <consignment_barcode>, contains shipment/tracking number of consignment

Maximum Length: 40

                products*

array

products
SST03/4AB: <product>, multiple …​ without outer products brackets in Heine's XML taget format. c.f. shipped products in customers parcel/consignment.

Minimum number of items 1

                    (Array item)

object

                        company*

string

origin company
SST03/4AB: <origin_company>, Unique Id of inventory/stock owning group company

Minimum Length: 1
Maximum Length: 2

                        itemNumber*

string

item number / product number
SST03/4AB: <product_number>, c.f. item number

Maximum Length: 99

                        itemSize*

string

item size / product variant
SST03/4AB: <product_variant>, aka. item size

Maximum Length: 25

                        quantities*

array

quantities
SST03/4AB: <quantity>, multiple without outer quantities brackets in Heine's XML taget format. quantities of same product in one consignment/shipment (n' records à qty=1 >> for 'OrderQuantities > 1' of same product)

Minimum number of items 1

                            (Array item)

object

                                quantity

integer

quantity
SST03/4AB: <qty>, Specific amount of ItemSpecificQuantity, mainly: qty=1

Minimum: 1
Maximum: 1

                                buidId

string

buid id
SST03/4AB: <buid_id>, optional - ID used for unique/specific item shipped

Maximum Length: 99

                                externalReference

string

external reference
SST03/4AB: <external_reference>, optional - ID used for unique/specific prospected goods returned item

Maximum Length: 128

                                containerPackaging

string

Container Packaging
Gebindenorm (11-17: Auslieferkartons, 40-43: Ausliefertüten (Tütennorm F4,F5,F7,F8), 1-7: RL-Kolli vom KR1)

Maximum Length: 2

                                storageType

string (enum)

PICKING -> Kommissionierung, RESERVE -> Reservelager

Any of: [ "PICKING", "RESERVE" ]

                                storageLocationType

string (enum)

Storage Location Type
gibt an, in welches Lager der Artikel soll. FREE -> kein Zolllager. BONDED -> Zolllager

Any of: [ "BONDED", "FREE" ]

                                bondedStock

object

SST03/4AB: <bonded_stock>, optional customs bonded information (if customs related) regarding inbound id's, c.f. 'WE/WAP'

                                    goodsInId

string

the goods receipt number/id
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

                                    customsShipmentNumber*

integer

WE-Sendungsnummer
SST03/4AB: <we_number>, >> 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

                                    documentNumber*

integer

WAP number
SST03/4AB: <wap_number>, In Customs/WMS-terms aka. 'ANZ-Nummer (aka. Warenannahmeprotokollnummer)'. Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

4.2.3. Enumeration

4.2.4. Example

4.2.5. Schema

Table 4. Version FINE to Heine-Zoll
Version Number File Published on Changes

current version

1.0

Download

14.07.2023

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf) und den Anforderungen des KR/Cobra

previous version

0.1

Download

28.03.2023

Intitiale Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_Heine.docx)

coming version
Interface FINE to Heine-Zoll
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for stock removal/picking and subsequent/following customs message (FINE >> HEINE-Zoll) [FINE:C05/HEINE:SST03,4AB]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C05-CustomsOrderPicking2HeineHeine.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2016-04-16T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "examples": [
                "REQUEST",
                "RESPONSE",
                "NOTIFICATION",
                "LOADING_ADVICE",
                "MESSAGE"
            ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v2.schema.json"
                },
                "messageNumber": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 999999999,
                    "description": "Current number of the message in this batch. The first message has the number 1."
                }
            }
        },
        "data": {
            "type": "object",
            "properties": {
                "location": {
                    "type": "string",
                    "title": "Warehouse location",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
                },
                "market": {
                    "type": "string",
                    "title": "market",
                    "description": "SST03/4AB: <market>, according Heine-TargetFormat-XSD: the target market (ISO 3166-1 ALPHA-2)",
                    "maxLength": 2
                },
                "clientKey": {
                    "type": "string",
                    "title": "client key",
                    "enum": ["6PM-CH", "ABOUTYOU-CH", "ACKERMANN-CH", "BESTSELLER-CH", "BONPRIX-CH", "BRAVEHEART-CH", "FGH-BONPRIX-GB", "FGH-DIRECT-DELIVERY-GB", "FGH-OTTO-GB", "FGH-SCHWAB-GB", "FGH-WITT-GB", "FRANKONIA-CH", "HEINE-CH", "JELMOLI-CH", "LIEBESKIND-CH", "MAGAZIN-CH", "MAGAZIN-TH", "MAGAZIN-US", "MANUFACTUM-CH", "MANUFACTUM-HK", "MANUFACTUM-TH", "MANUFACTUM-US", "MYTOYS-CH", "QUELLE-CH", "SIEHAN!-CH", "SOLIVER-CH", "SPS-CH", "WITT-CH"],
                    "minLength": 1,
                    "maxLength": 22,
                    "description": "SST03/4AB: <client_key>, internal id of otto group companies who use HEINE's customs services"
                },
                "invoiceDate": {
                    "type": "string",
                    "format":"date-time",
                    "title": "invoice date",
                    "description": "SST03/4AB: <invoice_date> (optional), if invoicing takes place only when goods are issued (NEON)"
                },
                "consignments":{
                    "type": "array",
                    "items": { "$ref": "#/$defs/consignment" },
                    "minItems": 1,
                    "description": "SST03/4AB: <consignment>, multiple without outer consignments brackets in Heine's XML taget format."
                }
            },
            "required": [
                "location",
                "market",
                "clientKey",
                "invoiceDate",
                "consignments"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ],
    "$defs": {
        "consignment": {
            "type": "object",
            "properties": {
                "consignmentBarcode": {
                    "type": "string",
                    "title": "consignment barcode",
                    "description": "SST03/4AB: <consignment_barcode>, contains shipment/tracking number of consignment",
                    "maxLength": 40
                },
                "products":{
                    "type": "array",
                    "items": { "$ref": "#/$defs/product" },
                    "minItems": 1,
                    "title": "products",
                    "description": "SST03/4AB: <product>, multiple ... without outer products brackets in Heine's XML taget format. c.f. shipped products in customers parcel/consignment."
                }    
            },
            "required": [
                "consignmentBarcode",
                "products"
            ]
        },
        "product": {
            "type": "object",
            "properties": {
                "company": {
                    "type": "string",
                    "title": "origin company",
                    "minLength": 1,
                    "maxLength": 2,
                    "description": "SST03/4AB: <origin_company>, Unique Id of inventory/stock owning group company"
                },
                "itemNumber": {
                    "type": "string",
                    "title": "item number / product number",
                    "maxLength": 99,
                    "description": "SST03/4AB: <product_number>, c.f. item number"
                },
                "itemSize": {
                    "type": "string",
                    "title": "item size / product variant",
                    "maxLength": 25,
                    "description": "SST03/4AB: <product_variant>, aka. item size"
                },
                "quantities":{
                    "type": "array",
                    "title": "quantities",
                    "items": { "$ref": "#/$defs/quantity" },
                    "minItems": 1,
                    "description": "SST03/4AB: <quantity>, multiple without outer quantities brackets in Heine's XML taget format. quantities of same product in one consignment/shipment (n' records à qty=1 >> for 'OrderQuantities > 1' of same product)"
                } 
            },
            "required": [
                "itemNumber",
                "company",
                "itemSize",
                "quantities"
            ]
        },
        "quantity": {
            "type": "object",
            "properties": {
                "quantity": {
                    "type": "integer",
                    "title": "quantity",
                    "minimum": 1,
                    "maximum": 1,
                    "description": "SST03/4AB: <qty>, Specific amount of ItemSpecificQuantity, mainly: qty=1"
                },
                "buidId": {
                    "type": "string",
                    "title": "buid id",
                    "maxLength": 99,
                    "description": "SST03/4AB: <buid_id>, optional - ID used for unique/specific item shipped"
                },
                "externalReference": {
                    "type": "string",
                    "title": "external reference",
                    "maxLength": 128,
                    "description": "SST03/4AB: <external_reference>, optional - ID used for unique/specific prospected goods returned item"
                },
                "containerPackaging": {
                    "title": "Container Packaging",
                    "description": "Gebindenorm (11-17: Auslieferkartons, 40-43: Ausliefertüten (Tütennorm F4,F5,F7,F8), 1-7: RL-Kolli vom KR1)",
                    "type": "string",
                    "maxLength": 2
                },
                "storageType": {
                    "type": "string",
                    "enum": [
                        "PICKING",
                        "RESERVE"
                    ],
                    "description": "PICKING -> Kommissionierung, RESERVE -> Reservelager"
                },
                "storageLocationType": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/Customs/StorageLocationType.v1.schema.json"
                },
                "bondedStock":{
                    "type": "object",
                    "description": "SST03/4AB: <bonded_stock>, optional customs bonded information (if customs related) regarding inbound id's, c.f. 'WE/WAP'",
                    "properties": {
                        "goodsInId": {
                            "description": "The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).",
                            "type": "string",
                            "maxLength": 36,
                            "title": "the goods receipt number/id",
                            "examples": [
                                "228008245557"
                            ]
                        },
                        "customsShipmentNumber": {
                            "description": "SST03/4AB: <we_number>, >> 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.",
                            "type": "integer",
                            "maximum": 9999999,
                            "title": "WE-Sendungsnummer",
                            "examples": [
                                8245557
                            ]
                        },
                        "documentNumber": {
                            "description": "SST03/4AB: <wap_number>, In Customs/WMS-terms aka. 'ANZ-Nummer (aka. Warenannahmeprotokollnummer)'. Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)",
                            "type": "integer",
                            "maximum": 999999,
                            "title": "WAP number",
                            "examples": [
                                429313
                            ]
                        }
                    },
                    "required": [
                        "customsShipmentNumber",
                        "documentNumber"
                    ]
                }
            },
            "required": [
                "qty"
            ]
        }     
    }
}

5. Kafka Topics

Unresolved directive in <stdin> - include::../../../../integration-layer/topics/interfaces/C05.adoc[]

16 - C06 Customs Loading Advice to Heine (SST02)

Status

Version 1.0 released for Heine and WMS, published 05.09.2023

Approval

  1. NEON: erstellt auf Basis des Pflichtenheft: NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf

  2. …​

Comment

Naming/notation of the interface at Heine/Körber: SST02

Assumptions

'Heine-Zoll' as legacy system expects the messages as XML file. An adapter/conversion in the middle from FINE (Json) to Heine (XML) needs further planning and is currently 'out of scope' for this standard interface spec.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

K.Motion

InterfaceOwner

OSP

Producer

K.Motion

Consumer

Heine

2. Business Context

Heine verzollt Sendungen mit seiner Software für Otto Konzerntöchter als interner Dienstleister. Zollrelevante Ware ist bei der Verladung gegenüber Heine zu avisieren. Je Ladeeinheit (Wechselbrücke, c.f. WAB/SwapBody) wird ein Datensatz versendet. In den Meldungen gibt es aufgezählte Sendungen (consignments) und deren beinhaltete Produkte (products). Die so gemeldeten Sendungen werden später dann mit den Daten des Verfahrens Heine-Zoll "4AB" (c.f. C05) abgeglichen und dann verzollt.

Die Attribute für Artikelgröße und Bestandsfirma (benötigt auf Heine-Seite) entfallen in der Schnittstelle zwischen WMS und FINE. Für den Austausch zwischen FINE und Heine-Zoll werden diese dann von der FINE-Schicht über die logisticsProductId hinzugefügt. Auf Heine-Seite ist dann eine Wandlung via Software-Adapter von FINE-Json-Messages auf XML-Dateien vorgesehen.

3. Informationflow

flow

4. Interface

4.1. Direction WMS to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

eventType

LOADING_ADVICE

context

CUSTOMS

4.1.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

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

    data*

object

        location*

string (enum)

Warehouse location
SST02: <storage_location>, Warehouse location

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" ]
Maximum Length: 25

        fileName

string

filename
SST02: <filename>

Maximum Length: 99

        creationTimestamp

string (date-time)

creation timestamp
SST02: <creation_timestamp>, MsgProduction timestamp

        market*

string

market
SST02: <market>, according Heine-TargetFormat-XSD: the target market (ISO 3166-1 ALPHA-2)

Maximum Length: 2

        loadingNumber

string

loading number
SST02: <loading_number>, number of loading expected

Maximum Length: 25

        swapBodyNumber*

string

swap body numberloading number
SST02: <swap_body_number>, WAB - Number of loading expected

Maximum Length: 25

        truck

string

truck license plate
SST02: <truck>, designation or license plate registration of truck

Maximum Length: 25

        consignments*

array

SST02: <consignment>, multiple …​ without outer consignments brackets in Heine's XML target format.

Minimum number of items 1

            (Array item)

object

                consignmentBarcode*

string

consignment barcode
SST02: <consignment_barcode>, contains shipment/tracking number of consignment

Maximum Length: 40

                scanTimestamp*

string (date-time)

last scan timestamp
SST02: <scan_timestamp>, final scanning before loading (WMS: after the chute/slide)

                externalReference

string

externalReference
SST02: <external_reference>, optional unique client reference

Maximum Length: 128

                products*

array

products
SST02: <product>, multiple …​ without outer products brackets in Heine's XML target format. c.f. shipped products in customers parcel/consignment.

Minimum number of items 1

                    (Array item)

object

                        logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

                        buidId

string

buid id
SST02: <buid_id>, optional - ID used for unique/specific item shipped

Maximum Length: 99

                        productRefNumber

string

product reference number
SST02: <product_ref_number>, optional - article reference id

Maximum Length: 99

                        zlStatus

integer

zlStatus, customs warehouse status
SST02: <zl_status>, customs bonded warehouse status (1=Yes/0=No)

Minimum: 0
Maximum: 1

                        goodsInId

string

the goods receipt number/id
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

                        customsShipmentNumber

integer

WE-Sendungsnummer
SST02: <we_number>, >> 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

                        documentNumber

integer

WAP number
SST02: <wap_number>, In Customs/WMS-terms aka. 'ANZ-Nummer (aka. Warenannahmeprotokollnummer)'. Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

Table 2. Version WMS to FINE
Version Number File Published on Changes

current version

1.0

Download

14.07.2023

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf)

previous version

0.1

Download

28.03.2023

Intitiale Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_Heine.docx)
Interface WMS to FINE
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Scheme for notification of loading  (WMS >> FINE) [FINE:C06/HEINE:SST02]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C06-CustomsLoadingAdvice2HeineWms.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2016-04-16T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "examples": [
                "REQUEST",
                "RESPONSE",
                "NOTIFICATION",
                "LOADING_ADVICE",
                "MESSAGE"
            ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v9.schema.json"
                }
            },
            "required": ["sender"]
        },
        "data": {
            "type": "object",
            "properties": {
                "location": {
                    "title": "Warehouse location",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json",
                    "description": "SST02: <storage_location>, Warehouse location",
                    "maxLength": 25
                },
                "fileName": {
                    "type": "string",
                    "title": "filename",
                    "description": "SST02: <filename>",
                    "maxLength": 99
                },
                "creationTimestamp": {
                    "type": "string",
                    "format": "date-time",
                    "title": "creation timestamp",
                    "description": "SST02: <creation_timestamp>, MsgProduction timestamp"
                },
                "market": {
                    "type": "string",
                    "title": "market",
                    "description": "SST02: <market>, according Heine-TargetFormat-XSD: the target market (ISO 3166-1 ALPHA-2)",
                    "maxLength": 2
                },
                "loadingNumber": {
                    "type": "string",
                    "title": "loading number",
                    "description": "SST02: <loading_number>, number of loading expected",
                    "maxLength": 25
                },
                "swapBodyNumber": {
                    "type": "string",
                    "title": "swap body numberloading number",
                    "description": "SST02: <swap_body_number>, WAB - Number of loading expected",
                    "maxLength": 25
                },
                "truck": {
                    "type": "string",
                    "title": "truck license plate",
                    "description": "SST02: <truck>, designation or license plate registration of truck",
                    "maxLength": 25
                },                                
                "consignments": {
                    "type": "array",
                    "items": {
                        "$ref": "#/$defs/consignment"
                    },
                    "minItems": 1,
                    "description": "SST02: <consignment>, multiple ... without outer consignments brackets in Heine's XML target format."
                }
            },
            "required": [
                "location",
                "market",
                "swapBodyNumber",
                "consignments"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "metaData",
        "data"
    ],
    "$defs": {
        "consignment": {
            "type": "object",
            "properties": {
                "consignmentBarcode": {
                    "type": "string",
                    "title": "consignment barcode",
                    "description": "SST02: <consignment_barcode>, contains shipment/tracking number of consignment",
                    "maxLength": 40
                },
                "scanTimestamp": {
                    "type": "string",
                    "format": "date-time",
                    "title": "last scan timestamp",
                    "description": "SST02: <scan_timestamp>, final scanning before loading (WMS: after the chute/slide)"
                },
                "externalReference": {
                    "type": "string",
                    "title": "externalReference",
                    "description": "SST02: <external_reference>, optional unique client reference",
                    "maxLength": 128
                },                             
                "products": {
                    "type": "array",
                    "items": {
                        "$ref": "#/$defs/product"
                    },
                    "minItems": 1,
                    "title": "products",
                    "description": "SST02: <product>, multiple ... without outer products brackets in Heine's XML target format. c.f. shipped products in customers parcel/consignment."
                }
            },
            "required": [
                "consignmentBarcode",
                "scanTimestamp",
                "products"
            ]
        },
        "product": {
            "type": "object",
            "properties": {
                "logisticsProductId": {
                    "type": "string",
                    "title": "technical ID 'logistics product ID'",
                    "description": "Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.",
                    "maxLength": 36
                },
                "buidId": {
                    "type": "string",
                    "title": "buid id",
                    "maxLength": 99,
                    "description": "SST02: <buid_id>, optional - ID used for unique/specific item shipped"
                },
                "productRefNumber": {
                    "type": "string",
                    "title": "product reference number",
                    "maxLength": 99,
                    "description": "SST02: <product_ref_number>, optional - article reference id"
                },
                "zlStatus": {
                    "type": "integer",
                    "title": "zlStatus, customs warehouse status",
                    "minimum": 0,
                    "maximum": 1,
                    "description": "SST02: <zl_status>, customs bonded warehouse status (1=Yes/0=No)"
                },
                "goodsInId": {
                    "description": "The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).",
                    "type": "string",
                    "maxLength": 36,
                    "title": "the goods receipt number/id",
                    "examples": [
                        "228008245557"
                    ]
                },
                "customsShipmentNumber": {
                    "description": "SST02: <we_number>, >> 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [
                        8245557
                    ]
                },
                "documentNumber": {
                    "description": "SST02: <wap_number>, In Customs/WMS-terms aka. 'ANZ-Nummer (aka. Warenannahmeprotokollnummer)'. Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)",
                    "type": "integer",
                    "maximum": 999999,
                    "title": "WAP number",
                    "examples": [
                        429313
                    ]
                }
            },
            "required": [
                "logisticsProductId"
            ]
        }
    }
}

4.2. Direction FINE to Heine-Zoll

4.2.1. Header

This interface uses the Service Header

Table 3. Attribute
Fieldname Expresion

eventType

LOADING_ADVICE

context

CUSTOMS

4.2.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

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

    data*

object

        location*

string (enum)

Warehouse location
SST02: <storage_location>, Warehouse location

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" ]
Maximum Length: 25

        fileName

string

filename
SST02: <filename>

Maximum Length: 99

        creationTimestamp

string (date-time)

creation timestamp
SST02: <creation_timestamp>, MsgProduction timestamp

        market*

string

market
SST02: <market>, according Heine-TargetFormat-XSD: the target market (ISO 3166-1 ALPHA-2)

Maximum Length: 2

        loadingNumber

string

loading number
SST02: <loading_number>, number of loading expected

Maximum Length: 25

        swapBodyNumber*

string

swap body numberloading number
SST02: <swap_body_number>, WAB - Number of loading expected

Maximum Length: 25

        truck

string

truck license plate
SST02: <truck>, designation or license plate registration of truck

Maximum Length: 25

        consignments*

array

SST02: <consignment>, multiple …​ without outer consignments brackets in Heine's XML target format.

Minimum number of items 1

            (Array item)

object

                consignmentBarcode*

string

consignment barcode
SST02: <consignment_barcode>, contains shipment/tracking number of consignment

Maximum Length: 40

                scanTimestamp*

string (date-time)

last scan timestamp
SST02: <scan_timestamp>, final scanning before loading (WMS: after the chute/slide)

                externalReference

string

externalReference
SST02: <external_reference>, optional unique client reference

Maximum Length: 128

                products*

array

products
SST02: <product>, multiple …​ without outer products brackets in Heine's XML target format. c.f. shipped products in customers parcel/consignment.

Minimum number of items 1

                    (Array item)

object

                        company*

string

origin company
SST02: <origin_company>, Unique Id of inventory/stock owning group company

Minimum Length: 1
Maximum Length: 2

                        itemNumber*

string

item number / product number
SST02: <product_number>, c.f. item number

Maximum Length: 99

                        itemSize*

string

item size / product variant
SST02: <product_variant>, aka. item size

Maximum Length: 25

                        buidId

string

buid id
SST02: <buid_id>, optional - ID used for unique/specific item shipped

Maximum Length: 99

                        productRefNumber

string

product reference number
SST02: <product_ref_number>, optional - article reference id

Maximum Length: 99

                        zlStatus

integer

zlStatus, customs warehouse status
SST02: <zl_status>, customs bonded warehouse status (1=Yes/0=No)

Minimum: 0
Maximum: 1

                        goodsInId

string

the goods receipt number/id
The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).

Maximum Length: 36

                        customsShipmentNumber

integer

WE-Sendungsnummer
SST02: <we_number>, >> 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.

Maximum: 9999999

                        documentNumber

integer

WAP number
SST02: <wap_number>, In Customs/WMS-terms aka. 'ANZ-Nummer (aka. Warenannahmeprotokollnummer)'. Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)

Maximum: 999999

4.2.3. Enumeration

4.2.4. Example

4.2.5. Schema

Table 4. Version FINE to Heine-Zoll
Version Number File Published on Changes

current version

1.0

Download

14.07.2023

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf)

previous version

0.1

Download

28.03.2023

Intitiale Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_Heine.docx)
Interface FINE to Heine-Zoll
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Scheme for notification of loading  (FINE >> HEINE-Zoll) [FINE:C06/HEINE:SST02]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C06-CustomsLoadingAdvice2HeineHeine.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2016-04-16T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "examples": [
                "REQUEST",
                "RESPONSE",
                "NOTIFICATION",
                "LOADING_ADVICE",
                "MESSAGE"
            ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v9.schema.json"
                }
            },
            "required": ["sender"]
        },
        "data": {
            "type": "object",
            "properties": {
                "location": {
                    "title": "Warehouse location",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json",
                    "description": "SST02: <storage_location>, Warehouse location",
                    "maxLength": 25
                },
                "fileName": {
                    "type": "string",
                    "title": "filename",
                    "description": "SST02: <filename>",
                    "maxLength": 99
                },
                "creationTimestamp": {
                    "type": "string",
                    "format": "date-time",
                    "title": "creation timestamp",
                    "description": "SST02: <creation_timestamp>, MsgProduction timestamp"
                },
                "market": {
                    "type": "string",
                    "title": "market",
                    "description": "SST02: <market>, according Heine-TargetFormat-XSD: the target market (ISO 3166-1 ALPHA-2)",
                    "maxLength": 2
                },
                "loadingNumber": {
                    "type": "string",
                    "title": "loading number",
                    "description": "SST02: <loading_number>, number of loading expected",
                    "maxLength": 25
                },
                "swapBodyNumber": {
                    "type": "string",
                    "title": "swap body numberloading number",
                    "description": "SST02: <swap_body_number>, WAB - Number of loading expected",
                    "maxLength": 25
                },
                "truck": {
                    "type": "string",
                    "title": "truck license plate",
                    "description": "SST02: <truck>, designation or license plate registration of truck",
                    "maxLength": 25
                },                                
                "consignments": {
                    "type": "array",
                    "items": {
                        "$ref": "#/$defs/consignment"
                    },
                    "minItems": 1,
                    "description": "SST02: <consignment>, multiple ... without outer consignments brackets in Heine's XML target format."
                }
            },
            "required": [
                "location",
                "market",
                "swapBodyNumber",
                "consignments"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "metaData",
        "data"
    ],
    "$defs": {
        "consignment": {
            "type": "object",
            "properties": {
                "consignmentBarcode": {
                    "type": "string",
                    "title": "consignment barcode",
                    "description": "SST02: <consignment_barcode>, contains shipment/tracking number of consignment",
                    "maxLength": 40
                },
                "scanTimestamp": {
                    "type": "string",
                    "format": "date-time",
                    "title": "last scan timestamp",
                    "description": "SST02: <scan_timestamp>, final scanning before loading (WMS: after the chute/slide)"
                },
                "externalReference": {
                    "type": "string",
                    "title": "externalReference",
                    "description": "SST02: <external_reference>, optional unique client reference",
                    "maxLength": 128
                },                             
                "products": {
                    "type": "array",
                    "items": {
                        "$ref": "#/$defs/product"
                    },
                    "minItems": 1,
                    "title": "products",
                    "description": "SST02: <product>, multiple ... without outer products brackets in Heine's XML target format. c.f. shipped products in customers parcel/consignment."
                }
            },
            "required": [
                "consignmentBarcode",
                "scanTimestamp",
                "products"
            ]
        },
        "product": {
            "type": "object",
            "properties": {
                "company": {
                    "type": "string",
                    "title": "origin company",
                    "minLength": 1,
                    "maxLength": 2,
                    "description": "SST02: <origin_company>, Unique Id of inventory/stock owning group company"
                },
                "itemNumber": {
                    "type": "string",
                    "title": "item number / product number",
                    "maxLength": 99,
                    "description": "SST02: <product_number>, c.f. item number"
                },
                "itemSize": {
                    "type": "string",
                    "title": "item size / product variant",
                    "maxLength": 25,
                    "description": "SST02: <product_variant>, aka. item size"
                },
                "buidId": {
                    "type": "string",
                    "title": "buid id",
                    "maxLength": 99,
                    "description": "SST02: <buid_id>, optional - ID used for unique/specific item shipped"
                },
                "productRefNumber": {
                    "type": "string",
                    "title": "product reference number",
                    "maxLength": 99,
                    "description": "SST02: <product_ref_number>, optional - article reference id"
                },
                "zlStatus": {
                    "type": "integer",
                    "title": "zlStatus, customs warehouse status",
                    "minimum": 0,
                    "maximum": 1,
                    "description": "SST02: <zl_status>, customs bonded warehouse status (1=Yes/0=No)"
                },
                "goodsInId": {
                    "description": "The goods receipt number, generated by the WMS. (Possible UUID but other identifier accepted).",
                    "type": "string",
                    "maxLength": 36,
                    "title": "the goods receipt number/id",
                    "examples": [
                        "228008245557"
                    ]
                },
                "customsShipmentNumber": {
                    "description": "SST02: <we_number>, >> 'WE-Sendungsnummer'. Last 7 digits (significant from right) of the general known WMS goods receipt number (goodsInId). Derived to fit C@ts needs.",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [
                        8245557
                    ]
                },
                "documentNumber": {
                    "description": "SST02: <wap_number>, In Customs/WMS-terms aka. 'ANZ-Nummer (aka. Warenannahmeprotokollnummer)'. Unique ID at goodsIn-Positions per Supplier/LKZ below a 'WE-Sendungsnummer' (c.f. customsShipmentNumber)",
                    "type": "integer",
                    "maximum": 999999,
                    "title": "WAP number",
                    "examples": [
                        429313
                    ]
                }
            },
            "required": [
                "company",
                "itemNumber",
                "itemSize"
            ]
        }
    }
}

5. Kafka Topics

Unresolved directive in <stdin> - include::../../../../integration-layer/topics/interfaces/C06.adoc[]

17 - C07 Customs Return Advice from Heine (SST23)

Status

DRAFT/Test operation (v0.1) → Documentation in the process of completion

Approval

  1. Heine: based on document: Konzept Heine Außenwirtschaftssoftware und Lagerstandorte FINE.doc

  2. …​

Comment

Naming/notation of the interface at Heine: SST23

Assumptions

'Heine-Zoll' as legacy system send messages with advices of B2C return goods coming out of dutiable supplier countries which have to store into a Hermes warehouse.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

Heine Außenwirtschaftssoftware

InterfaceOwner

OSP

Consumer

KR1

Consumer

k.Motion - interface currently not used

Producer

Heine

2. Business Context

Mit den Informationen aus dieser SST wird das Ziellager der Retourenartikel informiert, welche Artikel sich auf der Wechselbrücke befinden sollen und zollrechtlich abgefertigt wurden. Im Zuge der Standardisierung wird die SST HeineToSPLS_Retouren_yyyymmdd-hhmmss.txt durch die C07 ersetzt. Die SST CustomsReturnAdvice ersetzt die bisher genutzte SST HeineCustomsReturns *.txt für bonprix bzw. heineToSPLS_Retouren*.txt für Otto.

3. Informationflow

flow

4. Interface

4.1. Direction Heine to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

eventType

NOTIFICATION

context

CUSTOMS

4.1.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        swapBodyNumber*

string

Swap Body Number
WAB-Nummer

        storageLocationKey*

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

        bins*

array

            (Array item)

object

                binCode*

string

bin code
Wannen-Barcode, eg. 7275573284

Maximum Length: 25

                articles*

array

                    (Array item)

object

                        itemNumber*

integer

Item Number
the item number

                        itemSize*

integer

Item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

                        company*

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

                        quantities*

array

                            (Array item)

object

                                customsShipmentNumber

integer

WE-Sendungsnummer
<we_number> auch 'WE-Sendungsnummer'. Im KR1 7-stellig (vgl C05).

Maximum: 99999999

                                documentNumber

integer

WAP number
<wap_number> auch ANZ-Nummer oder Warenannahmeprotokollnummer. Im KR1 6-stellig (vgl C05).

Maximum: 9999999

                                storageLocationType*

string (enum)

Storage Location Type
gibt an, in welches Lager der Artikel soll. FREE -> kein Zolllager. BONDED -> Zolllager

Any of: [ "BONDED", "FREE" ]

                                quantity*

integer

quantity
Gemeldete Menge des Artikels

Minimum: 1
Maximum: 1

                                hAwbBl*

string

hAwbBl
HAWB-Nummer - [Land][Verladenummer Retourenbetrieb inkl. Kundenfirmenkurzzeichen]

Maximum Length: 70

                                qaBlockingSign*

string

qa blocking sign
QS-Sperrkenzeichen. Ausprägungen: 'F' = frei 'I' = inventurgesperrt

Maximum Length: 1

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

Table 2. Version Heine to FINE
Version Number File Published on Changes

current version

1.0

Download

06.05.2024

Version basierend auf dem Plichtenheft von Heine und Anforderungen des KR

previous version

coming version
Interface Heine to FINE
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for advice returns out of dutiable countries (HEINE >> FINE) [FINE:C07/HEINE:SST23]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C07-CustomsReturnAdviceFromHeine.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2024-02-24T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "examples": [
                "REQUEST",
                "RESPONSE",
                "NOTIFICATION",
                "LOADING_ADVICE",
                "MESSSAGE"
            ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v2.schema.json"
                }
            }
        },
        "data": {
            "type": "object",
            "properties": {
                "swapBodyNumber": {
                    "type": "string",
                    "title": "Swap Body Number",
                    "description": "WAB-Nummer",
                    "examples": ["WAB0123456789"]
                },
                "storageLocationKey": {
                   "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
                },
                "bins": {
                    "type": "array",
                    "items": {"$ref": "#/$defs/bin"}
                }
            },
            "required": [
                "swapBodyNumber",
                "storageLocationKey",
                "bins"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ],
    "$defs": {
        "bin": {
            "type": "object",
            "properties": {
                "binCode": {
                    "type": "string",
                    "title": "bin code",
                    "description": "Wannen-Barcode, eg. 7275573284",
                    "maxLength": 25,
                    "examples": [ 7275573284 ]
                },
                "articles": {
                    "type": "array",
                    "items": {"$ref": "#/$defs/article"}
                }
            },
            "required": [
                "binCode",
                "articles"
            ]
        },
        "article": {
            "type": "object",
            "properties": {
                "itemNumber": {
                    "description": "the item number",
                    "type": "integer",
                    "title": "Item Number",
                    "examples": [ 29343364 ]
                },
                "itemSize": {
                    "description": "the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')",
                    "type": "integer",
                    "title": "Item Size",
                    "examples": [ 38, 907 ]
                },
                "company": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
                },
                "quantities": {
                  "type": "array",
                  "items": {"$ref": "#/$defs/quantity"}
                }
            },
            "required": [
                "itemNumber",
                "itemSize",
                "company",
                "quantities"
            ]
        },
        "quantity": {
            "type": "object",
            "properties": {
                "customsShipmentNumber": {
                    "description": "<we_number> auch 'WE-Sendungsnummer'. Im KR1 7-stellig (vgl C05).",
                    "type": "integer",
                    "maximum": 99999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [ 4041703 ]
                },
                "documentNumber": {
                    "description": "<wap_number> auch ANZ-Nummer oder Warenannahmeprotokollnummer. Im KR1 6-stellig (vgl C05).",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WAP number",
                    "examples": [ 489810 ]
                },
                "storageLocationType": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/Customs/StorageLocationType.v1.schema.json"
                },
                "quantity": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 1,
                    "description": "Gemeldete Menge des Artikels",
                    "title": "quantity",
                    "examples": [ 1 ]
                },
                "hAwbBl": {
                    "type": "string",
                    "description": "HAWB-Nummer - [Land][Verladenummer Retourenbetrieb inkl. Kundenfirmenkurzzeichen]",
                    "maxLength": 70,
                    "title": "hAwbBl",
                    "examples": [ "CHKA020108" ]
                },
                "qaBlockingSign": {
                    "type": "string",
                    "description": "QS-Sperrkenzeichen. Ausprägungen: 'F' = frei 'I' = inventurgesperrt",
                    "maxLength": 1,
                    "title": "qa blocking sign",
                    "examples": [ "I" ]
                }
            },
            "required": [
                "storageLocationType",
                "quantity",
                "hAwbBl",
                "qaBlockingSign"
            ]
        }
    }
}

4.2. Direction FINE to WMS (KR1)

4.2.1. Header

This interface uses the Service Header

Table 3. Attribute
Fieldname Expresion

eventType

NOTIFICATION

context

CUSTOMS

4.2.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        swapBodyNumber*

string

Swap Body Number
WAB-Nummer

        storageLocationKey*

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

        bins*

array

            (Array item)

object

                binCode*

string

bin code
Wannen-Barcode, eg. 7275573284

Maximum Length: 25

                articles*

array

                    (Array item)

object

                        itemNumber

integer

Item Number
the item number

                        itemSize

integer

Item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

                        company

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

                        logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

                        quantities*

array

                            (Array item)

object

                                customsShipmentNumber

integer

WE-Sendungsnummer
<we_number> auch 'WE-Sendungsnummer'. Im KR1 7-stellig (vgl C05).

Maximum: 99999999

                                documentNumber

integer

WAP number
<wap_number> auch ANZ-Nummer oder Warenannahmeprotokollnummer. Im KR1 6-stellig (vgl C05).

Maximum: 9999999

                                storageLocationType*

string (enum)

Storage Location Type
gibt an, in welches Lager der Artikel soll. FREE -> kein Zolllager. BONDED -> Zolllager

Any of: [ "BONDED", "FREE" ]

                                quantity*

integer

quantity
Gemeldete Menge des Artikels

Minimum: 1
Maximum: 1

                                hAwbBl*

string

hAwbBl
HAWB-Nummer - [Land][Verladenummer Retourenbetrieb inkl. Kundenfirmenkurzzeichen]

Maximum Length: 70

                                qaBlockingSign*

string

qa blocking sign
QS-Sperrkenzeichen. Ausprägungen: 'F' = frei 'I' = inventurgesperrt

Maximum Length: 1

4.2.3. Enumeration

4.2.4. Example

4.2.5. Schema

Table 4. Version FINE to WMS
Version Number File Published on Changes

current version

1.0

Download

06.05.2024

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf) und Anforderungen des KR

previous version

coming version
Interface FINE to WMS (KR)
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema Schema for advice returns out of dutiable countries (FINE >> WMS) [FINE:C07/HEINE:SST23]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C07-CustomsReturnAdviceFromHeine2Wms.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2024-02-24T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "examples": [
                "REQUEST",
                "RESPONSE",
                "NOTIFICATION",
                "LOADING_ADVICE",
                "MESSSAGE"
            ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v2.schema.json"
                }
            }
        },
        "data": {
            "type": "object",
            "properties": {
                "swapBodyNumber": {
                    "type": "string",
                    "title": "Swap Body Number",
                    "description": "WAB-Nummer",
                    "examples": ["WAB0123456789"]
                },
                "storageLocationKey": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
                 },
                "bins": {
                    "type": "array",
                    "items": {"$ref": "#/$defs/bin"}
                }
            },
            "required": [
                "swapBodyNumber",
                "storageLocationKey",
                "bins"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ],
    "$defs": {
        "bin": {
            "type": "object",
            "properties": {
                "binCode": {
                    "type": "string",
                    "title": "bin code",
                    "description": "Wannen-Barcode, eg. 7275573284",
                    "maxLength": 25,
                    "examples": [ 7275573284 ]
                },
                "articles": {
                    "type": "array",
                    "items": {"$ref": "#/$defs/article"}
                }
            },
            "required": [
                "binCode",
                "articles"
            ]
        },
        "article": {
            "type": "object",
            "properties": {
                "itemNumber": {
                    "description": "the item number",
                    "type": "integer",
                    "title": "Item Number",
                    "examples": [ 29343364 ]
                },
                "itemSize": {
                    "description": "the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')",
                    "type": "integer",
                    "title": "Item Size",
                    "examples": [ 38, 907 ]
                },
                "company": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
                },                
                "logisticsProductId": {
                    "type": "string",
                    "title": "technical ID 'logistics product ID'",
                    "description": "Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.",
                    "maxLength": 36
                },      
                "quantities": {
                  "type": "array",
                  "items": {"$ref": "#/$defs/quantity"}
                }
            },
            "required": [
                "logisticsProductId",
                "quantities"
            ]
        },
        "quantity": {
            "type": "object",
            "properties": {
                "customsShipmentNumber": {
                    "description": "<we_number> auch 'WE-Sendungsnummer'. Im KR1 7-stellig (vgl C05).",
                    "type": "integer",
                    "maximum": 99999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [ 4041703 ]
                },
                "documentNumber": {
                    "description": "<wap_number> auch ANZ-Nummer oder Warenannahmeprotokollnummer. Im KR1 6-stellig (vgl C05).",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WAP number",
                    "examples": [ 489810 ]
                },
                "storageLocationType": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/Customs/StorageLocationType.v1.schema.json"
                },
                "quantity": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 1,
                    "description": "Gemeldete Menge des Artikels",
                    "title": "quantity",
                    "examples": [ 1 ]
                },
                "hAwbBl": {
                    "type": "string",
                    "description": "HAWB-Nummer - [Land][Verladenummer Retourenbetrieb inkl. Kundenfirmenkurzzeichen]",
                    "maxLength": 70,
                    "title": "hAwbBl",
                    "examples": [ "CHKA020108" ]
                },
                "qaBlockingSign": {
                    "type": "string",
                    "description": "QS-Sperrkenzeichen. Ausprägungen: 'F' = frei 'I' = inventurgesperrt",
                    "maxLength": 1,
                    "title": "qa blocking sign",
                    "examples": [ "I" ]
                }
            },
            "required": [
                "storageLocationType",
                "quantity",
                "hAwbBl",
                "qaBlockingSign"
            ]
        }
    }
}

5. Kafka Topics

Unresolved directive in <stdin> - include::../../../../integration-layer/topics/interfaces/C07.adoc[]

18 - C08 Customs Return Advice Response to Heine (SST23R)

Status

DRAFT/Test operation (v0.1) → Documentation in the process of completion

Approval

  1. Heine: based on document: Konzept Heine Außenwirtschaftssoftware und Lagerstandorte FINE.doc

  2. …​

Comment

Naming/notation of the interface at Heine: SST23R

Assumptions

Warehouse Mgmt System - currently KR1 - sends feedback on the returns advice note that Heine provides in SST C07 back to Heine-Außenwirtschaft

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

Heine Außenwirtschaftssoftware

InterfaceOwner

OSP

Producer

KR1

Consumer

Heine

2. Business Context

Um die compliante Zollabwicklung bei Retouren sicherzustellen, erwartet heine mit der neuen Außenwirtschaftssoftware eine Rückmeldung innerhalb von 24-Stunden nach Ankunft des LKWs/der Wechselbrücke, welche Artikel tatsächlich auf der Brücke angeliefert wurden. Basierend auf den in der C07 übermittelten Daten erwartet heine eine der drei folgenden Antwortoptionen: - Artikel ist angekommen und verzollt - Artikel ist angekommen, aber wurde nicht verzollt (nicht in C07 gemeldet) - Artikel ist nicht angekommen, obwohl er verzollt wurde

3. Informationflow

flow

4. Interface

4.1. Direction WMS to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

eventType

NOTIFICATION

context

CUSTOMS

4.1.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        swapBodyNumber*

string

Swap Body Number
WAB-Nummer

        bins*

array

            (Array item)

object

                binCode*

string

bin code
Wannen-Barcode, eg. 7275573284

Maximum Length: 25

                articles*

array

                    (Array item)

object

                        logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

                        quantities*

array

                            (Array item)

object

                                customsShipmentNumber

integer

WE-Sendungsnummer
<we_number> auch 'WE-Sendungsnummer'. Im KR1 7-stellig (vgl C05).

Maximum: 99999999

                                documentNumber

integer

WAP number
<wap_number> auch ANZ-Nummer oder Warenannahmeprotokollnummer. Im KR1 6-stellig (vgl C05).

Maximum: 9999999

                                quantity*

integer

quantity
Menge des Artikels

Minimum: 1
Maximum: 1

                                responseStatus*

string

response status
3 Ausprägungen:Artikel angekommen und verzollt/Artikel angekommen und nicht verzollt/Artikel nicht angekommen obwohl verzollt

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

Table 2. Version Heine to FINE
Version Number File Published on Changes

current version

1.0

Download

28.02.2024

Version basierend auf dem Plichtenheft von Heine

previous version

coming version
Interface WMS to FINE
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for response of returns out of dutiable countries (WMS >> FINE) [FINE:C08/HEINE:SST23R]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C08-CustomsReturnAdviceResponseToHeineFromWms.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2024-02-24T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "examples": [
                "REQUEST",
                "RESPONSE",
                "NOTIFICATION",
                "LOADING_ADVICE",
                "MESSSAGE"
            ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v2.schema.json"
                }
            }
        },
        "data": {
            "type": "object",
            "properties": {
                "swapBodyNumber": {
                    "type": "string",
                    "title": "Swap Body Number",
                    "description": "WAB-Nummer",
                    "examples": ["WAB0123456789"]
                },
                "bins": {
                    "type": "array",
                    "items": { "$ref": "#/$defs/bin" }
                }
            },
            "required": [
                "swapBodyNumber",
                "bins"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ],
    "$defs": {
        "bin": {
            "type": "object",
            "properties": {
                "binCode": {
                    "type": "string",
                    "title": "bin code",
                    "description": "Wannen-Barcode, eg. 7275573284",
                    "maxLength": 25,
                    "examples": [ 7275573284 ]
                },
                "articles": {
                    "type": "array",
                    "items": { "$ref": "#/$defs/article" }
                }
            },
            "required": [
                "binCode",
                "articles"
            ]
        },
        "article": {
            "type": "object",
            "properties": {
                "logisticsProductId": {
                    "type": "string",
                    "title": "technical ID 'logistics product ID'",
                    "description": "Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a product.",
                    "maxLength": 36
                },
                "quantities": {
                    "type": "array",
                    "items": { "$ref": "#/$defs/quantity" }
                }
            },
            "required": [
                "logisticsProductId",
                "quantities"
            ]
        },
        "quantity": {
            "type": "object",
            "properties": {
                "customsShipmentNumber": {
                    "description": "<we_number> auch 'WE-Sendungsnummer'. Im KR1 7-stellig (vgl C05).",
                    "type": "integer",
                    "maximum": 99999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [ 4041703 ]
                },
                "documentNumber": {
                    "description": "<wap_number> auch ANZ-Nummer oder Warenannahmeprotokollnummer. Im KR1 6-stellig (vgl C05).",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WAP number",
                    "examples": [ 489810 ]
                },
                "quantity": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 1,
                    "description": "Menge des Artikels",
                    "title": "quantity",
                    "examples": [ 1 ]
                },
                "responseStatus": {
                    "type": "string",
                    "title": "response status",
                    "description": "3 Ausprägungen:Artikel angekommen und verzollt/Artikel angekommen und nicht verzollt/Artikel nicht angekommen obwohl verzollt",
                    "examples": [ "Artikel angekommen und verzollt" ]
                }
            },
            "required": [
                "quantity",
                "responseStatus"
            ]
        }
    }
}

4.2. Direction FINE to Heine

4.2.1. Header

This interface uses the Service Header

Table 3. Attribute
Fieldname Expresion

eventType

NOTIFICATION

context

CUSTOMS

4.2.2. Datamodel

Property Type Description

(Root)

object

    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

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

    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.

    eventType*

string

The type of operation
Typ der Nachricht

    metaData

object

        sender

string (enum)

Any of: [ "BUBE", "COBRA", "CORE", "FINE_INBOUND", "IDEEFIX", "KMOTION_ILOWA", "KMOTION_GERNSHEIM", "KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "KR1_HAMBURGERSTRASSE", "LDH", "LIGIS", "LSAS", "OBS", "RESY", "RETAILSCHICHT", "WMSX_AKU", "WMSX_SONNEFELD", "WMSX_WEISMAIN" ]

    data*

object

        swapBodyNumber*

string

Swap Body Number
WAB-Nummer

        bins*

array

            (Array item)

object

                binCode*

string

bin code
Wannen-Barcode, eg. 7275573284

Maximum Length: 25

                articles*

array

                    (Array item)

object

                        itemNumber*

integer

item Number
the item number

                        itemSize*

integer

item Size
the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')

                        company*

string (enum)

company

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU" ]

                        quantities*

array

                            (Array item)

object

                                customsShipmentNumber

integer

WE-Sendungsnummer
<we_number> auch 'WE-Sendungsnummer'. Im KR1 7-stellig (vgl C05).

Maximum: 99999999

                                documentNumber

integer

WAP number
<wap_number> auch ANZ-Nummer oder Warenannahmeprotokollnummer. Im KR1 6-stellig (vgl C05).

Maximum: 9999999

                                quantity*

integer

quantity
Menge des Artikels

Minimum: 1
Maximum: 1

                                responseStatus*

string

response status
3 Ausprägungen:Artikel angekommen und verzollt/Artikel angekommen und nicht verzollt/Artikel nicht angekommen obwohl verzollt

4.2.3. Enumeration

4.2.4. Example

4.2.5. Schema

Table 4. Version FINE to Heine
Version Number File Published on Changes

current version

1.0

Download

14.07.2023

Version basierend auf dem Plichtenheft Zoll (NEON_Fein_Pflichtenheft_WAN4_SST_Zoll_V6.00.A.pdf)

previous version

coming version
Interface FINE to Heine
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for response of returns out of dutiable countries (FINE >> HEINE) [FINE:C08/HEINE:SST23R]",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Customs/C08-CustomsReturnAdviceResponseToHeine.v1.0.schema.json",
    "type": "object",
    "properties": {
        "eventId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq eventId",
            "description": "Global uniq Id",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d87"
            ]
        },
        "traceId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq traceId",
            "description": "Global uniq Id for tracing the flow of events",
            "examples": [
                "00ce536f-923a-42f4-8138-33418faf1342"
            ]
        },
        "spanId": {
            "type": "string",
            "format": "uuid",
            "title": "The uniq spanId",
            "description": "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.",
            "examples": [
                "00ce536f-923a-42f4-8128-be118faf1d85"
            ]
        },
        "eventTime": {
            "type": "string",
            "title": "Time of occurrence of the event",
            "description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
            "examples": [
                "2024-02-24T16:06:05.000+02:00"
            ]
        },
        "version": {
            "title": "The number of version schema",
            "description": "Number of version of this data structure. Only required if no $schema is specified!",
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "\\d+\\.\\d{1,2}",
                    "examples": [
                        "1.01",
                        "01.02"
                    ]
                },
                {
                    "type": "integer",
                    "examples": [
                        1,
                        2
                    ]
                }
            ]
        },
        "context": {
            "type": "string",
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "examples": [
                "CUSTOMS"
            ]
        },
        "eventType": {
            "type": "string",
            "title": "The type of operation",
            "description": "Typ der Nachricht",
            "examples": [
                "REQUEST",
                "RESPONSE",
                "NOTIFICATION",
                "LOADING_ADVICE",
                "MESSSAGE"
            ]
        },
        "metaData": {
            "type": "object",
            "properties": {
                "sender": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v2.schema.json"
                }
            }
        },
        "data": {
            "type": "object",
            "properties": {
                "swapBodyNumber": {
                    "type": "string",
                    "title": "Swap Body Number",
                    "description": "WAB-Nummer",
                    "examples": ["WAB0123456789"]
                },
                "bins": {
                    "type": "array",
                    "items": { "$ref": "#/$defs/bin" }
                        
                }
            },
            "required": [
                "swapBodyNumber",
                "bins"
            ]
        }
    },
    "required": [
        "eventId",
        "traceId",
        "eventTime",
        "version",
        "eventType",
        "data"
    ],
    "$defs": {
        "bin": {
            "type": "object",
            "properties": {
                "binCode": {
                    "type": "string",
                    "title": "bin code",
                    "description": "Wannen-Barcode, eg. 7275573284",
                    "maxLength": 25,
                    "examples": [ 7275573284 ]
                },
                "articles": {
                    "type": "array",
                    "items": { "$ref": "#/$defs/article" }
                }
            },
            "required": [
                "binCode",
                "articles"
            ]
        },
        "article": {
            "type": "object",
            "properties": {
                "itemNumber": {
                    "description": "the item number",
                    "type": "integer",
                    "title": "item Number",
                    "examples": [ 29343364 ]
                },
                "itemSize": {
                    "description": "the item size (binary size, not alphanumeric, c.f. 907 instead of 'S')",
                    "type": "integer",
                    "title": "item Size",
                    "examples": [ 38, 907 ]
                },
                "company": {
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
                },
                "quantities": {
                    "type": "array",
                    "items": { "$ref": "#/$defs/quantity" }
                }
            },
            "required": [
                "itemNumber",
                "itemSize",
                "company",
                "quantities"
            ]
        },
        "quantity": {
            "type": "object",
            "properties": {
                "customsShipmentNumber": {
                    "description": "<we_number> auch 'WE-Sendungsnummer'. Im KR1 7-stellig (vgl C05).",
                    "type": "integer",
                    "maximum": 99999999,
                    "title": "WE-Sendungsnummer",
                    "examples": [ 4041703 ]
                },
                "documentNumber": {
                    "description": "<wap_number> auch ANZ-Nummer oder Warenannahmeprotokollnummer. Im KR1 6-stellig (vgl C05).",
                    "type": "integer",
                    "maximum": 9999999,
                    "title": "WAP number",
                    "examples": [ 489810 ]
                },
                "quantity": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 1,
                    "description": "Menge des Artikels",
                    "title": "quantity",
                    "examples": [ 1 ]
                },
                "responseStatus": {
                    "type": "string",
                    "title": "response status",
                    "description": "3 Ausprägungen:Artikel angekommen und verzollt/Artikel angekommen und nicht verzollt/Artikel nicht angekommen obwohl verzollt",
                    "examples": [ "Artikel angekommen und verzollt" ]
                }
            },
            "required": [
                "quantity",
                "responseStatus"
            ]
        }
    }
}

5. Kafka Topics

Unresolved directive in <stdin> - include::../../../../integration-layer/topics/interfaces/C08.adoc[]