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

Return to the regular view of this page.

20 Inbound

1 - FLASH/Inbound

1.1 -

1.1.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

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event), recommended as uuid, Special usecases can be specify for some interfaces

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in 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
INSERT events will usually signal a new error (with data.errorState CREATED); UPDATE events are usually issued when an error gets RESOLVED; and DELETE events occur when an error is subject to housekeeping/deletion from the WMS database

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

    metaData*

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        senderSystem*

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

    data*

object

        location*

string (enum)

warehouse locations

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

        goodsInErrorId*

string

techn. key of this error that occurred during goods in of a particular storage handling unit

        storageHandlingUnitId*

string

techn. key of the storage handling unit that is subject to this very error

        error*

string (enum)

business key of the error type - as presented to the WMS users

Any of: [ "E1_PACKAGE", "E2_WEIGHT", "E3_NO_LABEL", "E4_2D_OCR_FAIL", "E5_MASTER_DATA_MISSING", "E6_PROD_DATA_MISSING", "E7_SUPPL_DATA_MISSING", "E8_NO_GOODSIN_MATCH", "E9_MANUAL_HANDLING", "E10_BAD_IMAGE", "E11_GOODSIN_MISSING" ]

        errorCode*

string

human-readable (prosaic) version of error

        errorState*

string (enum)

current state of the error - created or resolved

Any of: [ "CREATED", "RESOLVED" ]

        errorTime*

string (date-time)

time when the error received its current state

1.2 -

1.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

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event), recommended as uuid, Special usecases can be specify for some interfaces

    eventTime*

string

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format.

    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 concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        senderSystem*

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

    data*

object

        location*

string (enum)

warehouse locations
Goods Inspection 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" ]

        businessProcessUnit

string

businessProcessUnit
Goods Inspection Team

        inspectionId*

string

Quality Order ID
QualityorderID (technical code)

        testAccuracy

Test accuracy
Test accuracy

        testAccuracyHierarchy

Test Accuracy Hierarchy
Einteil- bzw. Vollprüfung

        inspectionResultCode

Inspection Result Code
Inspection Result Code

        faultCode

array

Fault Codes
list of errorCodes

            (Array item)

string

        quantityFault

object

            value

integer

the quantity for this item size/order

            unit

string (enum)

unit

Any of: [ "GRAM", "KILOGRAM", "CUBIC_METER", "METER", "LITER", "PIECES" ]

        quantityInspection

object

            value

integer

the quantity for this item size/order

            unit

string (enum)

unit

Any of: [ "GRAM", "KILOGRAM", "CUBIC_METER", "METER", "LITER", "PIECES" ]

        quantityDelivery

object

            value

integer

the quantity for this item size/order

            unit

string (enum)

unit

Any of: [ "GRAM", "KILOGRAM", "CUBIC_METER", "METER", "LITER", "PIECES" ]

        processTime*

string (date-time)

processtime
Process Time

        product

object

            erpProductId

string

Erp product Id
FINE-LSAS ERP Product Identifier.

Maximum Length: 50

        supplier

object

            id

string

¨
Supplier ID

        goodsIn

object

            id

string

eindeutige Kennzeichnung der Wareneingang-Kopfdaten. Weitere Details des Wareneingangs sind über die Verknüpfung dieser ID mit inbound.goodsInId möglich.

            positionId

string

eindeutige Kennzeichnung der Wareneingang-Positionsdaten. Weitere Details des Wareneingangs sind über die Verknüpfung dieser ID mit inbound.goodsInPositionId möglich.

1.3 - I20 Goods In Error

Status

Version 1.0 published 17.03.2023

Approval
Comment
Assumption

_

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Bernd Ledig

Leading App

InterfaceOwner

FLASH

Konstantin Volke

Producer

KR1

Matthias Fraass

Consumer

FLASH

Konstatin Volke

2. Business Context

Im Rahmen der automatischen Kollierfassung in Haldensleben werden über diese Schnittstelle die Fehler beim Wareneingang übermittelt

3. Informationflow

Partner Direction FINE-Service Topic/API Description Status

WMS:KR1

send

INBOUND

goodsinerror

ProductDataService

ready

FLASH

receive

INBOUND

goodsinerror

ProductDataService

ready

Diagram

4. Interface

4.1. Direction WMS to FINE and FINE to WMS

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

context

GOODS_IN_ERROR

eventType

INSERT, UPDATE, DELETE

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

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event), recommended as uuid, Special usecases can be specify for some interfaces

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in 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
INSERT events will usually signal a new error (with data.errorState CREATED); UPDATE events are usually issued when an error gets RESOLVED; and DELETE events occur when an error is subject to housekeeping/deletion from the WMS database

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

    metaData*

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        senderSystem*

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

    data*

object

        location*

string (enum)

warehouse locations

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

        goodsInErrorId*

string

techn. key of this error that occurred during goods in of a particular storage handling unit

        storageHandlingUnitId*

string

techn. key of the storage handling unit that is subject to this very error

        error*

string (enum)

business key of the error type - as presented to the WMS users

Any of: [ "E1_PACKAGE", "E2_WEIGHT", "E3_NO_LABEL", "E4_2D_OCR_FAIL", "E5_MASTER_DATA_MISSING", "E6_PROD_DATA_MISSING", "E7_SUPPL_DATA_MISSING", "E8_NO_GOODSIN_MATCH", "E9_MANUAL_HANDLING", "E10_BAD_IMAGE", "E11_GOODSIN_MISSING" ]

        errorCode*

string

human-readable (prosaic) version of error

        errorState*

string (enum)

current state of the error - created or resolved

Any of: [ "CREATED", "RESOLVED" ]

        errorTime*

string (date-time)

time when the error received its current state

4.1.3. Enumeration

Field: error type

Table 2. tbd

Meta Value

Description

Short Value

E1_PACKAGE

Abweichler Norm

E2_WEIGHT

Abweichler Gewicht

E3_NO_LABEL

kein 2D und Vorkleber verborgen

E4_2D_OCR_FAIL

kein 2D und OCR nicht erfolgreich

E5_MASTER_DATA_MISSING

Artikelnr./-größe im KR1 Artikelstamm und im Lieferantenstamm nicht bekannt

E6_PROD_DATA_MISSING

Artikelnr./-gröee im KR1 Artikelstamm nicht bekannt, aber im Lieferantenstamm bekannt

E7_SUPPL_DATA_MISSING

Artikelnr./-größe im KR1 Artikelstamm bekannt, aber nicht im Lieferantenstamm bekannt

E8_NO_GOODSIN_MATCH

Artikel nicht zu einer Sendungsnr. zuzuordnen

E9_MANUAL_HANDLING

NER-Kennzeichnung

E10_BAD_IMAGE

Foto nicht lesbar

E11_GOODSIN_MISSING

Keine Sendungszuordnung möglich

4.1.4. Example

Message WMS to FINE and FINE to WMS
{
  "eventId": "f4675429-bf86-4aee-995d-9ee260f800d8",
  "traceId": "f4675429-bf86-4aee-995d-9ee260f800d8",
  "eventTime": "2023-03-10T09:10:16.529+01:00",
  "version": "1.0",
  "context": "GOODS_IN_ERROR",
  "eventType": "INSERT",
  "metaData": {
    "senderSystem": "KR1_HHSTR"
  },
  "data": {
    "location": "HALDENSLEBEN",
    "goodsInErrorId": "956921",
    "storageHandlingUnitId": "91751080",
    "error": "E9_MANUAL_HANDLING",
    "errorCode": "NER-Kennzeichnung",
    "errorState": "CREATED",
    "errorTime": "2023-03-08T09:45:58.000+01:00"
  }
}

4.1.5. Schema

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

current version

1.0

Download

17.03.2023

previous version

coming version

Interface WMS to FINE
{
	"$schema": "http://json-schema.org/draft-07/schema",
	"$comment": "Schema for Goods In Errors.",
	"$id": "https://doc.fine.gcp.osp-dev.de/registry/Inbound/GoodsInErrorWms.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",
			"title": "The eventId of previous record or batchId",
			"description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event), recommended as uuid, Special usecases can be specify for some interfaces",
			"examples": [
				"00ce536f-923a-42f4-5463-32a41877b3c2"
			]
		},
		"eventTime": {
			"type": "string",
			"format": "date-time",
			"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": [
				"returnsprocessing",
				"storageLocation"
			]
		},
		"eventType": {
			"type": "string",
			"title": "The type of operation",
			"description": "INSERT events will usually signal a new error (with data.errorState CREATED); UPDATE events are usually issued when an error gets RESOLVED; and DELETE events occur when an error is subject to housekeeping/deletion from the WMS database",
			"examples": [
				"INSERT",
				"UPDATE",
				"DELETE"
			],
			"enum": [
				"INSERT",
				"UPDATE",
				"DELETE"
			]
		},
		"metaData": {
			"type": "object",
			"title": "additional meta information",
			"description": "optional, can be used with different characteristics for technical data per interface",
			"properties": {
				"senderSystem": {
					"$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v1.schema.json"
				}
			},
			"required": [
				"senderSystem"
			]
		},
		"data": {
			"type": "object",
			"properties": {
				"location": {
					"$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
				},
				"goodsInErrorId": {
					"type": "string",
					"description": "techn. key of this error that occurred during goods in of a particular storage handling unit",
					"examples": [
						"218530844"
					]
				},
				"storageHandlingUnitId": {
					"type": "string",
					"description": "techn. key of the storage handling unit that is subject to this very error",
					"examples": [
						"218530844"
					]
				},
				"error": {
					"type": "string",
					"description": "business key of the error type - as presented to the WMS users",
					"examples": [
						"E2_WEIGHT"
					],
					"enum": [
						"E1_PACKAGE",
						"E2_WEIGHT",
						"E3_NO_LABEL",
						"E4_2D_OCR_FAIL",
						"E5_MASTER_DATA_MISSING",
						"E6_PROD_DATA_MISSING",
						"E7_SUPPL_DATA_MISSING",
						"E8_NO_GOODSIN_MATCH",
						"E9_MANUAL_HANDLING",
						"E10_BAD_IMAGE",
						"E11_GOODSIN_MISSING"
					]
				},
				"errorCode": {
					"type": "string",
					"description": "human-readable (prosaic) version of error",
					"examples": [
						"Abweichler Gewicht"
					]
				},
				"errorState": {
					"type": "string",
					"description": "current state of the error - created or resolved",
					"examples": [
						"CREATED"
					],
					"enum": [
						"CREATED",
						"RESOLVED"
					]
				},
				"errorTime": {
					"type": "string",
					"format": "date-time",
					"description": "time when the error received its current state",
					"examples": [
						"2016-04-16T16:06:05.000+02:00"
					]
				}
			},
			"required": [
				"location",
				"goodsInErrorId",
				"storageHandlingUnitId",
				"error",
				"errorCode",
				"errorState",
				"errorTime"
			]
		}
	},
	"required": [
		"eventId",
		"traceId",
		"eventTime",
		"version",
		"eventType",
		"metaData",
		"data"
	]
}

1.4 - I21 Quality Inspection

Status

Version 1.0 published 05.04.2023

Approval
Comment
Assumption

_

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Bernd Ledig

Leading App

InterfaceOwner

FLASH

Konstantin Volke

Producer

Babelfish

Michael Hahne

Consumer

FLASH

Konstatin Volke

2. Business Context

Im Rahmen der Warenprüfungen werden über diese Schnittstelle die Informationen zu einem Prüfauftrag übermittelt.

3. Informationflow

Partner Direction FINE-Service Topic/API Description Status

LIGIS

send

INBOUND

qualityinspection

ProductDataService

in progress

FLASH

receive

INBOUND

qualityinspection

ProductDataService

in progress

Diagram

4. Interface

4.1. Direction WMS to FINE and FINE to WMS

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

context

QUALITY_INSPECTION

eventType

QUALITYORDER_START, QUALITYORDER_CANCELATION, SECONDSAMPLE_REQUESTED, SECONDSAMPLE_RECEIVED, CLAIM_SEND, CLAIM_RECEIVED, CLAIM_APPROVED, QUALITYORDER_CREATED, QUALITYORDER_END, QUALITYORDER_START_BREAK, QUALITYORDER_END_BREAK, QUALITYORDER_ABORT

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

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event), recommended as uuid, Special usecases can be specify for some interfaces

    eventTime*

string

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format.

    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 concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        senderSystem*

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

    data*

object

        location*

string (enum)

warehouse locations
Goods Inspection 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" ]

        businessProcessUnit

string

businessProcessUnit
Goods Inspection Team

        inspectionId*

string

Quality Order ID
QualityorderID (technical code)

        testAccuracy

Test accuracy
Test accuracy

        testAccuracyHierarchy

Test Accuracy Hierarchy
Einteil- bzw. Vollprüfung

        inspectionResultCode

Inspection Result Code
Inspection Result Code

        faultCode

array

Fault Codes
list of errorCodes

            (Array item)

string

        quantityFault

object

            value

integer

the quantity for this item size/order

            unit

string (enum)

unit

Any of: [ "GRAM", "KILOGRAM", "CUBIC_METER", "METER", "LITER", "PIECES" ]

        quantityInspection

object

            value

integer

the quantity for this item size/order

            unit

string (enum)

unit

Any of: [ "GRAM", "KILOGRAM", "CUBIC_METER", "METER", "LITER", "PIECES" ]

        quantityDelivery

object

            value

integer

the quantity for this item size/order

            unit

string (enum)

unit

Any of: [ "GRAM", "KILOGRAM", "CUBIC_METER", "METER", "LITER", "PIECES" ]

        processTime*

string (date-time)

processtime
Process Time

        product

object

            erpProductId

string

Erp product Id
FINE-LSAS ERP Product Identifier.

Maximum Length: 50

        supplier

object

            id

string

¨
Supplier ID

        goodsIn

object

            id

string

eindeutige Kennzeichnung der Wareneingang-Kopfdaten. Weitere Details des Wareneingangs sind über die Verknüpfung dieser ID mit inbound.goodsInId möglich.

            positionId

string

eindeutige Kennzeichnung der Wareneingang-Positionsdaten. Weitere Details des Wareneingangs sind über die Verknüpfung dieser ID mit inbound.goodsInPositionId möglich.

4.1.3. Enumeration

Field: businessProcessUnit

Table 2. tbd

Meta Value

Description

Short Value

Deko

Hartware

Textil

Schmuck

Schuhe

UNKNOWN

4.1.4. Example

Message WMS to FINE and FINE to WMS
//include::QualiyInsepction.v1.0_sampleMessage.json[]

4.1.5. Schema

Table 3. Version LIGIS to FINE
Version Number File Published on Changes

current version

1.0

Download

05.04.2023

previous version

coming version

Interface LIGIS to FINE
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for QualityInspection 1.0",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Inbound/QualityInspection.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",
        "title": "The eventId of previous record or batchId",
        "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event), recommended as uuid, Special usecases can be specify for some interfaces",
        "examples": [
            "00ce536f-923a-42f4-5463-32a41877b3c2"
        ]
    },    
      "eventTime": {
        "type": "string",
        "title": "Time of occurrence of the event",
        "description": "Time at which this record(event) was technically generated in RFC3339 format.",
        "examples": [
            "2022-03-22T09:52:00.000+01: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}",
              "maxLength": 6,
              "examples": ["1.01", "01.02"]
          },
          {
              "type": "integer",
              "minimum": 1,
              "maximum": 99999,              
              "examples": [1, 2]
          }
      ]
    },
      "context": {
        "type": "string",
        "title": "The context / business case",
        "description": "The context specified here means the business domain.",
        "examples": [
            "QUALITY_INSPECTION"
        ]
    },
      "eventType": {
        "type": "string",
        "title": "The concrete type = kind of record(event)",
        "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
        "examples": ["QUALITYORDER_START", "QUALITYORDER_CANCELATION","SECONDSAMPLE_REQUESTED","SECONDSAMPLE_RECEIVED","CLAIM_SEND",
						"CLAIM_RECEIVED","CLAIM_APPROVED","QUALITYORDER_CREATED","QUALITYORDER_END","QUALITYORDER_START_BREAK","QUALITYORDER_END_BREAK","QUALITYORDER_ABORT"]
		
    },
    "metaData": {
      "type": "object",
      "title": "additional meta information",
      "description": "optional, can be used with different characteristics for technical data per interface",
      "properties": {
        "senderSystem": {
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v1.schema.json"
      }
      },
      "required": [
        "senderSystem"
      ]     
    },
    "data": {
        "type": "object",
        "properties": { 
            "location": {
                "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json",
                "description": "Goods Inspection Location"
            },
            "businessProcessUnit": {
               "description": "Goods Inspection Team",
               "type": "string",
               "title": "businessProcessUnit",
               "ENUM":["Deko","Hartware","Textil","Schmuck","Schuhe","UNKNOWN"]
            },			
            "inspectionId": {
              "description": "QualityorderID (technical code)",
              "type": "string",
              "title": "Quality Order ID",
              "examples":["1234"]
            },
			"testAccuracy": {
              "description": "Test accuracy",
              "typeCode": "string",
              "title": "Test accuracy",
              "example": ["keine Prüfung","normal prüfen","reduziert prüfen"]
            },
			"testAccuracyHierarchy": {
              "description": "Einteil- bzw. Vollprüfung",
              "typeCode": "string",
              "title": "Test Accuracy Hierarchy",
              "example": ["Einteilprüfung","Vollprüfung"]
            },
			"inspectionResultCode": {
              "description": "Inspection Result Code",
              "typeCode": "string",
              "title": "Inspection Result Code",
              "example": ["100","102","105"]
            },
            "faultCode":{
              "description": "list of errorCodes",
              "type":"array",
              "title": "Fault Codes",
              "items": {
                "type": "string",
                "example": ["150","151"]
              }
           },
            "quantityFault": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "integer",
                  "description": "the quantity for this item size/order"
                },
                "unit": {
                  "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/unit.v1.schema.json"
                  }
                }
            }, 
            "quantityInspection": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "integer",
                  "description": "the quantity for this item size/order"
                },
                "unit": {
                  "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/unit.v1.schema.json"
                  }
                }
            },  	
            "quantityDelivery": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "integer",
                  "description": "the quantity for this item size/order"
                },
                "unit": {
                  "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/unit.v1.schema.json"
                  }
                }
            },  		
            "processTime": {
              "description": "Process Time",
              "type": "string",
              "format": "date-time",
              "title": "processtime" ,
              "examples":["2022-03-22T09:52:00.000+01:00"]
            },	  
           "product": {
              "type": "object",
              "properties": {
                "erpProductId": {
                    "description": "FINE-LSAS ERP Product Identifier.",
                    "type": "string",
                    "maxLength": 50,
                    "title": "Erp product Id",
                    "examples": ["45896254"]
                  } 
              }          
          },                                          
          "supplier": {
            "type": "object",
            "properties": {
              "id": {
                "description": "Supplier ID",
                "type": "string",
                "title": "¨",
                "examples":["123"]
              }
            }                                   
          },
          "goodsIn": {
            "type": "object",
            "properties": {
              "id": {
                "description": "eindeutige Kennzeichnung der Wareneingang-Kopfdaten. Weitere Details des Wareneingangs sind über die Verknüpfung dieser ID mit inbound.goodsInId möglich.",
                "type": "string",
                "title": "",
                "examples":["123"]
              },
              "positionId": {
                "description": "eindeutige Kennzeichnung der Wareneingang-Positionsdaten. Weitere Details des Wareneingangs sind über die Verknüpfung dieser ID mit inbound.goodsInPositionId möglich.",
                "type": "string",
                "title": "",
                "examples":["4"]
              }              
            }                                          
          }
        },
         "required": [
            "location",
            "inspectionId",
            "processTime",
            "erpProductId"
          ]              
        }
    },
    "required": [
      "eventId",
      "traceId",
      "eventTime",
      "version",
      "eventType",
      "data"
    ]
  }

2 - Inbound/QS

2.1 -

2.1.1 -

Property Type Description

(Root)

object

    eventId*

string (uuid)

UUID for this event
ID of the event (message), will be generated by the actual producer

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    traceId*

string (uuid)

UUID for all events in a call hierarchy
ID of the trace, will be generated by the first producer of the process. The ID will be the same for all events in the context of this process, also over system bounderies. The ID is equal to the eventId, if it is the frist event.

It's like a order number, the will used for alle activities around the order.

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    spanId*

string (uuid)

UUID for all events in a call hierarchy
ID of the previous event (message). The ID is NULL if there is no previous event

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    version*

string

Json schema version
Version of the interface

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

    eventTime*

string (date-time)

Event time
Point in time where the event (message - not the businessEvent). Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

    context*

string

The name of the responsible context
Name of the context

Maximum Length: 20

    type*

string

Type
Name of the single atomar process (businessEvent) that causes this event

    sender*

string

Sender
The producer, that send the message (COBRA, K.MOTION…​)

    sourceIdentifier*

string

SourceIdentifier
End 2 End producer (original producer)

    instance

string

Instance
Application instance

    data*

object

        storageNotificationId*

string

Storage Notification Id
Technical key

Maximum Length: 36

        storageNotificationNo*

string

Storage Notification Number
Business key

        created*

string (date-time)

Created Date
Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

        updated*

string (date-time)

Updated Time
Modification date. For new installation: creatDate=modifyDate. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

        partnerId*

string

Partner Id
Platform ID in the first step is the Otto

        purchaseOrder*

object

            orderUUID*

string

Order UUID
PurchaseOrder ID - technische Schlüssel

            orderPositionUUID*

string

Order Position UUID
PurchaseOrder Position ID - technische Schlüssel

            orderNo*

string

Order Number
OVA

            location*

string

Storage Location
Storage location, List of allowed values will be defined and documented #url

            sourceLocation

string

Source/Original location
Where does the stock originally come from

            handlingType*

string

Handling Type
Processing type OSS, wholesale, wholesalelight

            supplyLocationCode*

string

Supply Location Code
e.g. 10 camp location with all its gates. Delivery address mark

            deliveryDate*

string (date)

Delivery Date
The planned delivery date. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

Maximum Length: 10

            forecastedWarehouseArrivalDate

string (date)

Forecasted Warehouse Arrival Date
Projected WE1 date. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

Maximum Length: 10

            forecastedBufferedStorageDate

string (date)

Forecasted Buffered Storage Date
Predicted WE2 Date. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

Maximum Length: 10

            foreignDemandQty

string

Foreign Demand Quantity
Fremdbedarfe ist eine Lagerwaren-Bestellung von Großkunden an Otto. Otto ist in diesem Fall also der Lieferant. Und manchmal beschafft Otto die benötigte Ware mit einem eigenen Otto-Auftrag mit.

            planningPeriodCode*

string

Planning Period Code
Season

            supplierNo*

string

Supplier Number
LKZ

            orderQty*

number

Order Quantity
PurchaseOrder quantity

        productIdentifier*

object

            erpProductId*

string

¨Erp Product Id
erpProductId aus LSAS

Maximum Length: 36

            FNSKU

string

FNSKU
Fachliche Artikelnummer

            sku*

string

¨Sku

Maximum Length: 36

            itemNo*

string

Item Number

Maximum Length: 16

            itemSize*

string

Item Size

Maximum Length: 16

2.1.2 -

Property Type Description

(Root)

object

    eventId*

string (uuid)

UUID for this event
ID of the event (message), will be generated by the actual producer

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    traceId*

string (uuid)

UUID for all events in a call hierarchy
ID of the trace, will be generated by the first producer of the process. The ID will be the same for all events in the context of this process, also over system bounderies. The ID is equal to the eventId, if it is the frist event.

It's like a order number, the will used for alle activities around the order.

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    spanId*

string (uuid)

UUID for all events in a call hierarchy
ID of the previous event (message). The ID is NULL if there is no previous event

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    version*

string

Json schema version
Version of the interface

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

    eventTime*

string (date-time)

Event time
Point in time where the event (message - not the businessEvent). Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

    context*

string

The name of the responsible context
Name of the context

Maximum Length: 20

    type*

string

Type
Name of the single atomar process (businessEvent) that causes this event

    sender*

string

Sender
The producer, that send the message (COBRA, K.MOTION…​)

    sourceIdentifier*

string

SourceIdentifier
End 2 End producer (original producer)

    instance

string

Instance
Application instance

    data*

object

        storageNotificationId*

string

Storage Notification Id
Technical key

Maximum Length: 36

        storageNotificationNo*

string

Storage Notification Number
Business key

        createDate*

string (date-time)

Created Date
Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

        modifyDate

string (date-time)

Modify Date
Änderungsdatum. Bei Neuanlage: creatDate=modifyDate. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

        partnerId*

string

Partner Id
Platform ID in the first step is the Otto

        location*

string

Storage Location
Storage location, List of allowed values will be defined and documented #url

        sourceLocation

string

Source/Original location
Where does the stock originally come from

        purchaseOrder*

object

            orderUUID*

string

Order UUID
PurchaseOrder ID - technische Schlüssel

            orderPositionUUID*

string

Order Position UUID
PurchaseOrder Position ID - technische Schlüssel

            orderNumber*

string

Order Number
OVA

            handlingType*

string

Handling Type
Processing type OSS, wholesale, wholesalelight

            supplyLocationCode*

string

Supply Location Code
e.g. 10 camp location with all its gates. Delivery address mark

            deliveryDate*

string (date)

Delivery Date
The planned delivery date. Format: yyyy-MM-dd

Maximum Length: 10

            forecastedWarehouseArrivalDate

string (date)

Forecasted Warehouse Arrival Date
Projected WE1 date. Format: yyyy-MM-dd

Maximum Length: 10

            forecastedBufferedStorageDate

string (date)

Forecasted Buffered Storage Date
Predicted WE2 Date. Format: yyyy-MM-dd

Maximum Length: 10

            foreignDemandQty

string

Foreign Demand Quantity
Fremdbedarfe ist eine Lagerwaren-Bestellung von Großkunden an Otto. Otto ist in diesem Fall also der Lieferant. Und manchmal beschafft Otto die benötigte Ware mit einem eigenen Otto-Auftrag mit.

            planningPeriodCode*

string

Planning Period Code
Season

            supplierNumber*

string

Supplier Number
LKZ

            quantity*

number

Order Quantity
PurchaseOrder quantity

        product*

object

            logisticProductId*

string

¨Logistic Product Id
logisticProductId aus LSAS

Maximum Length: 30

            erpProductId*

string

¨Erp Product Id
erpProductId aus LSAS

Maximum Length: 36

            FNSKU

string

FNSKU
Fachliche Artikelnummer

            sku*

string

¨Sku

Maximum Length: 36

            itemNumber*

string

Item Number

Maximum Length: 16

            itemSize*

string

Item Size

Maximum Length: 16

2.2 -

2.2.1 -

Property Type Description

(Root)

object

Despatch Advice Ramps

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

    spanId

string (uuid)

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

    eventTime*

string (date-time)

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

    version*

string

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

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

    context

string

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

    eventType*

string (enum)

The type of operation
Type of message

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

    metaData

object

        sender

string (enum)

system

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

    data*

object

        location*

string (enum)

warehouse locations

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

        businessEventDateTime

string (date-time)

timestamp of business event

        bookRampId*

integer

Id of the ramp

        rampName*

string

Name of the ramp

        rampType

string

Type of the ramp

        groupName

string

Ramp group name

        rampProcessStateCount*

integer

Number of available process states for a ramp

        defaultWeekFreeMinutes

integer

        active*

boolean

Is the ramp active

2.3 -

2.3.1 -

Property Type Description

(Root)

object

Despatch Advice Ramp Process

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

    spanId

string (uuid)

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

    eventTime*

string (date-time)

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

    version*

string

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

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

    context

string

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

    eventType*

string (enum)

The type of operation
Type of message

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

    metaData

object

        sender

string (enum)

system

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

    data*

object

        location*

string (enum)

warehouse locations

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

        businessEventDateTime*

string (date-time)

timestamp of business event

        bookRampId

integer

Id of the ramp

        arrivalSlotStartDateTime

string (date-time)

        dailyStartTime

string (time)

        dailyCloseTime

string (time)

        dailyOpenMinutes

integer

        dailyCapacityLimitMinutes

integer

        dailyCapacityLimitKolli

integer

        bookedMinutes

integer

        manuallyClosedMinutes

integer

        manuallyOpenMinutes

integer

        previous

object

            arrivalSlotStartDateTime

string (date-time)

            bookedMinutes

integer

            manuallyClosedMinutes

integer

            manuallyOpenMinutes

integer

2.4 -

2.4.1 -

Property Type Description

(Root)

object

Despatch Advice Bookings

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

    spanId

string (uuid)

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

    eventTime*

string (date-time)

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

    version*

string

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

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

    context

string

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

    eventType*

string (enum)

The type of operation
Type of message

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

    metaData

object

        sender

string (enum)

system

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

    data*

object

        bookId

integer

Id of the booking

        location*

string (enum)

warehouse locations

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

        businessEventDateTime

string (date-time)

timestamp of business event

        creator

object

            id

integer

Id of the booking creator

            companyId

integer

the creators company id

            companyName

string

the creators company name

        previous

object

            arrivalSlotStartDateTime

string (date-time)

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

            arrivalSlotEndDateTime

string (date-time)

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

            arrivalSlotLengthMinutes

integer

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

            bookRampId

integer

Id of previous ramp

        arrivalSlotStartDateTime

string (date-time)

slot start time
start time of the arrival time slot

        arrivalSlotCriticalStartDateTime

string (date-time)

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

        arrivalSlotEndDateTime

string (date-time)

slot end time
end time of the arrival time slot

        arrivalSlotLengthMinutes

integer

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

        bookRampId

integer

Id of the ramp

        bookingCompany

object

            id

integer

Id of the booking company

            name

string

the booking company name

        storageNotification

array

StorageNotifications

            (Array item)

object

                id

string

StorageNotificationId
StorageNotificationId

                quantity

integer

quantity

        orderNumber

array

order numbers

            (Array item)

string

        carrier

string

carrier

        productDescription

string

        itemNumber

array

item numbers

            (Array item)

string

        customerCompany

array

HF Customer from CargoClix

            (Array item)

string

        leavingEuroPallets

integer

        loadCarrier

array

            (Array item)

object

                id

string

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

                type

string (enum)

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

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

                sealNumber

string

seal number

        cancellationDescription

string

        comment

string

        deliveryMethodDescription

string

        processingInformation

array

            (Array item)

object

                goodsReceiptProcessingType

string

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

                quantity

integer

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

Minimum: 0
Maximum: 99999999999999

        delivery

array

            (Array item)

object

                type

string

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

                number

string

delivery number

        desiredDate

string

preferred delivery date by HG

        deviationAvisQuality

string

Avis quality

        deliveryNoteId

array

            (Array item)

string

delivery note uuid

        supplier

object

            name

string

supplier name

            code

string

supplier code

        numberOf

object

            colliLoose

integer

            colliPaletized

integer

            hunte

integer

            articles

integer

            colli

integer

            defectivePallets

integer

            onewayPallets

integer

            pallets

integer

        pager

object

            pagerNumber

string

pager number

            returned

boolean

pager returned by driver

        pagerNumber

string

pager number

        pagerReturn

boolean

pager returned by driver

        palleteNumber

string

        processingTimeMinCalculated

string

calculated timee for umloading in minutes

        ProductTypeSelect

string

Sortimentsauswahl

        shipName

string

ship name

        shipmentNumber

string

shipment number

        slaRelevance

boolean

        cancellationReason

string

        transportId

array

            (Array item)

string

transport uuid

        tourNumber

array

tour numbers

            (Array item)

string

        wayBillNumber

string

        driver

object

            name

string

driver name

            phone

string

driver phone

            language

string

driver language

        isDeleted

boolean

booking is deleted

        isCancelled

boolean

booking is cancelled

        licensePlate

object

            truck

string

truck license plate

            trailer

string

driver license plate

2.5 -

2.6 -

2.6.1 -

Property Type Description

(Root)

object

DeliveryNote

    eventId*

string (uuid)

UUID for this event
JAVA UUID4 for this event (the booking), use pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    traceId*

string (uuid)

UUID for all events in a call hierarchy
UUID for all events in a call hierarchy.

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    spanId*

string (uuid)

UUID for all events in a call hierarchy
UUID for all events in a call hierarchy. If a new event is emitted, the eventId of the causing event is set as SpanId

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    eventTime*

string (date-time)

the date and time, when this event occured as an ISO-8601 timestamp.
the date and time, when this event occured as an ISO-8601 timestamp.

    version*

string

Json schema version
JSON schema version

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

    context*

string

The name of the responsible context
The name of the repsonsible context. Normally the context, which emits this event. tbd

Maximum Length: 20

    type*

string

the event type that triggers this event
the event type that triggers this event

Maximum Length: 20

    sender*

string

The sending system
The sending system

Maximum Length: 20

    sourceIdentifier*

string

SourceIdentifier
End 2 End producer (original producer)

    data*

object

        deliveryNoteId*

string

deliveryNoteId
delivery Note Id

Maximum Length: 36

        deliveryNoteNumber*

string

Die Belegnummer des Lieferscheins
deliveryNoteNumber

Maximum Length: 36

        deliveryNoteStatus*

string

deliveryNoteStatus
Interner Status des Lieferscheins - Möglich ist der Status 'validated' und 'deleted'. Wenn ein LS den Status 'deleted' hat, dann gibt es für diesen Lieferschein ein Update(neuer LS).

Maximum Length: 10

        location*

string

Electronic delivery Location
Electronic delivery location, List of allowed values will be defined and documented #url

        createDate*

string (date-time)

createDate
Create-Timestamp

        modifyDate*

string (date-time)

modifyDate
Update-Timestamp

        shippingDate*

string (date-time)

shippingDate
Datum des Versandes beim Lieferanten

        plannedDeliveryDate

string (date-time)

plannedDeliveryDate
Zum Zeitpunkt der Übertragung geplantes Anlieferdatum am Lager (zunächst frühestes mögliches Lieferdatum von HG, sobald in CargoLogic-web verfügbar: geplantes Anlieferdatum vom Lager)

        totalCartonQty*

integer

totalCartonQty
the loading unit differs for each retailer, the quantity is determined by the items and quantity

Maximum Length: 4

        collectionAddress

string

collectionAddress
Adresse, von der die Ware vom Nachlaufspediteur abgeholt wird (häufig Hamburger Containerterminals), Zusatzinfo, kann gekürzt sein aufgrund maximaler Feldlänge

Maximum Length: 35

        package

object

            weight

object

weight
weight

                value*

number

                unit*

string

            volume

object

volume
volume

                value*

number

                unit*

string

        carrierForwarding

string

carrierForwarding
Spediteur, der den Nachlauf physisch durchführt und ans Lager fährt

Maximum Length: 35

        positions*

array

Positions
Positions

Minimum number of items 1

            (Array item)

object

                deliveryNotePositionId*

string

deliveryNotePositionId
Alle Positionen zum Lieferschein

Maximum Length: 36

                deliveryNotePositionStatus*

string

deliveryNotePositionStatus
Interner Status des Lieferscheins - Möglich ist der Status 'validated' und 'deleted'. Wenn ein LS den Status 'deleted' hat, dann gibt es für diesen Lieferschein ein Update(neuer LS).

Maximum Length: 10

                createDate*

string (date-time)

createDate
create Date

                modifyDate*

string (date-time)

modifyDate
modify Date

                product*

object

                    logisticProductId*

integer

logisticProductId
master communication key

Maximum: 1000000000000000000

                    itemNumber*

integer

ItemNumber
the item number

Maximum Length: 16

                    itemSize*

string

ItemSize
the item size

Maximum Length: 16

                    itemSizeBin*

integer

ItemSizeBin
item Size Bin

                quantity*

number

quantity
quantity

                supplierNumber*

integer

supplierNumber
the number of supplier

Maximum Length: 6
Maximum: 999999

                purchaseOrderNumber*

integer

purchaseOrderNumber
Auftragsnummer

Maximum Length: 6

                shippingUnitNumber

integer

shippingUnitNumber
Nummer der Versandeinheit (des Paketes)

Maximum Length: 18
Maximum: 1000000000000000000

                containerType

string

containerType
Entweder WAB oder Containernummer, wenn ein Seefracht-Container „direkt“ gefahren wird.

Maximum Length: 70

                containerNumber

string

containerNumber
containerNumber

                hermesTMPPosNr

string

hermesTMPPosNr
(um erste vier, hier nicht relevante gekürzte) Positionsnummer des Transport Management Systems der HG, wird bei Seefrachten als Zugangsnummer ans Lager übermittelt

Maximum Length: 70

                customsProcedure

string

customsProcedure
ZL = Zolllagerware; FV = Bereits vollständig verzollt (Freier Verkehr)

Maximum Length: 70

                hAwbBl

string

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

Maximum Length: 70

                deliveryTypeCode*

string

deliveryTypeCode
Dient zur Ermittlung der Abwicklungsart (OTTO Market / Whole Sale)

Maximum Length: 1

                ovaValInfo

integer

ovaValInfo
Info darüber ob die OVA Nr währen der Validierung angepasst wurde oder nicht.

Maximum Length: 1

                additionalInformation

object

                    originalItemNumber

integer

originalItemNumber
Ursprüngliche Artikel Nr der Postion. Wird immer ausgegeben wenn für die Postion eine Korrektur vorgenommen wurde, d.h. das der Orginalwert des Lieferscheins während der Validierung verändert wurde.

Maximum Length: 8

                    originalItemSize

string

originalItemSize
Ursprüngliche Artikel Gr der Postion. Wird immer ausgegeben wenn für die Postion eine Korrektur vorgenommen wurde, d.h. das der Orginalwert des Lieferscheins während der Validierung verändert wurde.

Maximum Length: 7

                    ean

integer

ean
EAN der Artikelgröße

Maximum Length: 13
Maximum: 1000000000000000000

                    originalOva

integer

originalOva
Ursprüngliche Auftrags Nr der Postion. Wird immer ausgegeben wenn für die Postion eine Korrektur vorgenommen wurde, d.h. das der Orginalwert des Lieferscheins während der Validierung verändert wurde.

Maximum Length: 6

                    errorCode

string

errorCode
Bei Fehlerhafter Postion wird ein FehlerCode mit übergeben.

                    errorMessage

string

errorMessage
Beschreibung des ErrorCodes

2.7 -

2.7.1 -

Property Type Description

(Root)

object

ERP goods receipt messages
This document describes the goods receipt messages that FINE sends to the ERPs.

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

    spanId*

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format with timezone in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

    version*

string

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

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

    context*

string (enum)

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

Any of: [ "GOODS_IN" ]

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "DELIVERY_NOTE_REGISTRATION_END", "GOODSRECEIPT_START", "GOODSRECEIPT_END", "DELIVERY_COMPARISON_START", "DELIVERY_COMPARISON_END", "RELEASE_END" ]

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

        client

string

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​). List of values: https://docs.osp-fine.de/page/fine-common/00_meta_data/me02_global_enumerations/me02_global_enumerations/#_enum_company

        instance

string

Software instance of producing system
Name of the source instance that generated this data. Used for example to distinguish between different Test Instances.

    data*

object

Additional Properties: false

        location*

string (enum)

The sending warehouse
The sending warehouse (cobra sends data for different warehouses), List of allowed values will be defined and documented #url

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

        businessEventTime*

string (date-time)

The date and time, when the business event occurred
the date and time, when the business event occurred, in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

        goodsInId*

string

the goods receipt ID
the goods receipt technical key, generated by the wms. (Possible UUID but other identifier accepted)

Maximum Length: 36

        originalGoodsInId

string

the original goods receipt ID
the goods receipt technical key, generated by the wms. This ID is referencing the original Delivery (technical key) in case when goods arrive back from rework

Maximum Length: 36

        deliveryNumber*

string

the inbound delivery business key
the inbound delivery business key, generated by the wms

Maximum Length: 36

        deliveryTypeCode

string

Identification of the type of entry/delivery
Identification of the type of entry/delivery type {manual, automatic entry, DLW, return, transfer, WE from post-processing, WE without goods, etc.} Only the known forms of the WMS are delivered.

Maximum Length: 50

        deliveryType*

string (enum)

Type of the delivery
the type of the delivery (from supplier, DLW, returns, postprocessing, without goods…​)

Any of: [ "GOODSIN_SUPPLIER", "GOODSIN_FROM_REWORK", "GOODSIN_FOR_BOOKING_AND_RELEASE", "GOODSIN_FOR_REMOVAL", "GOODSIN_INCOMPLETE", "GOODSIN_DLW", "GOODSIN_FOR_RELEASE", "GOODSIN_POST_PROCESSING", "GOODSIN_FROM_MAPPER", "GOODSIN_SECOND_CHOICE", "GOODSIN_STATIONARY_TRADE", "GOODSIN_SMALLPARTS", "GOODSIN_CANCELATION", "GOODSIN_RELABEL", "GOODSIN_B2B", "GOODSIN_FROM_RETAIL", "GOODSIN_3RD_PARTY" ]

        carrier

string

name of the carrier transporting goods
name of the carrier transporting goods

Maximum Length: 100

        gates

array

            (Array item)

object

                door

string

Gate or Door number
The gate, door no where the truck arrives

Maximum Length: 10

                building

string

Building
The building where the truck arrives

Maximum Length: 3

        processingInformation

array

            (Array item)

object

Additional Properties: false

                goodsReceiptProcessingType*

string (enum)

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

Any of: [ "PALLETED_SORTED", "PALLETED_UNSORTED", "CARTONS_SORTED", "CARTONS_UNSORTED", "SANDWICH_PALLET", "PULK_2MH", "DLW", "ITEMS_UNSORTED", "ITEMS_UNSORTED_FROM_KEP", "CARTONS_UNSORTED_FROM_KEP", "NON_TRADE_ITEMS" ]

                goodsReceiptProcessingCode*

string

Pallet/hatch detection code
Differentiation according to pallet/hatch detection, or in the case of Cobra: differentiation according to palletized/loose, loose, DLW, etc. WMS internal codes are transferred in this attribute

                quantity

integer

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

Minimum: 0
Maximum: 99999999999999

        positions

array

            (Array item)

object

Additional Properties: false

                deliveryPositionId*

string

Position Id
Unique ID of the position. Can be a number from a sequence, a UUID or a combination of GoodsInId + PositionNumber

Maximum Length: 36

                deliveryPositionNumber

integer

Position number
position number - incremental number (identifier) of the delivery position

Maximum: 99999999999999

                quantity*

integer

Quantity received
the received quantity for this item size according to the delivery note

Minimum: 0
Maximum: 99999999999999

                arrivedToReworkerQuantity

integer

Quantity received by the external reworker
the received quantity by the external reworker for this item size according to the delivery note

Minimum: 0
Maximum: 99999999999999

                destroyedByReworkerQuantity

integer

Quantity destroyed by the external reworker
the destroyed quantity for this item size by the external reworker

Minimum: 0
Maximum: 99999999999999

                loadingUnitQuantity

integer

Amount of goods
the amount of the goods quantity per loading unit

Minimum: 0
Maximum: 99999999999999

                supplierNumber*

integer

Supplier Number
the number of supplier

Maximum: 999999

                reworkerSupplierNumber

integer

External reworker supplier number
the number of the external reworker as supplier

Maximum: 999999

                documentNumber*

integer

Document number
for new goods deliveries this ist the goods receipt/goods acceptance protocol (WAP) number for this delivery entry generated from number range dependent on warehouse

Minimum: 100000
Maximum: 999999

                ownerCompany*

string

Owner Company (BDF)
stock-owner company for the product. List of values: https://docs.osp-fine.de/page/fine-common/00_meta_data/me02_global_enumerations/me02_global_enumerations/#_enum_company

                hermesTourNumber

string

Hermes number
the hermes tour number

Maximum Length: 12

                customsShipmentNumber

string

Custom shipment Number
shipment no from c@ts

                airWayBill

string

Custom shipment Number
Air Way Bill (Luftfrachtbrief)

Maximum Length: 30

                positionDetails

array

                    (Array item)

object

Additional Properties: false

                        purchaseOrderNumber*

string

Purchase Order Number
purchaseOrderNumber

Maximum Length: 36

                        deliveryNoteNumber

string

Delivery Note Number
the corresponding Id in the erp system

Maximum Length: 36

                        storageNotificationId

string

Storage Notification Id
Storage Notification Id

Maximum Length: 36

                        quantity

number

the quantity of the referenced PositionDetail within the position

                        electronicDeliveryNotePositionId

array

Electronic Delivery Note Position
list of delivery note positions

                            (Array item)

string

                        deliveryPositionDetailId

string

Position Detail Id
unique ID of the position detail

Maximum Length: 36

                        sourceLocation

string

Source/Original location
Where does the stock originally come from

                product*

object

Additional Properties: false

                    erpProductId*

string

ERP Product Id
master communication key

Maximum Length: 36

                    logisticsProductId*

string

Logistics Product Id
master communication key

Maximum Length: 36

                qualityCheck

string (enum)

Type of Quality Check
with goods inspection, without goods inspection, subsequent goods inspection. List of allowed values will be defined and documented #url

Any of: [ "NO_QUALITY_CHECK", "NORMAL_QUALITY_CHECK", "DOWNSTREAM_QUALITY_CHECK" ]
Maximum Length: 50

                qualityCode

integer

Quantity code number Goods inspection
quality code no from goods inspection (WACH)

Maximum: 999

                damagedQuantity

integer

Quantity items damaged
damaged quantity from transport (BI2), in COBRA always 0, damaged items will be booked additionally, in partno 1 set the qty for the complete item size

Maximum: 999999

                processEndDate

string

Process End Date
release date as YYYY-MM-DD

                processEndCode

string (enum)

Process End Code
ReturnKz/ReleaseCode = result of the activation process. List of allowed values will be defined and documented #url

Any of: [ "RELEASE", "CANCELLATION", "RETURN", "REWORK", "DESTROY", "THIRD_PARTY_SALE" ]

                erpDeliveryNo

string

Erp Deliver Number
Liefernummer im ERP_System

                qualitySampleRequestMode

string (enum)

Sample size calculation mode
Art der Musterberechnung. ONLINE=WACH/LIGIS, OFFLINE=claculated by the WMS

Any of: [ "ONLINE", "OFFLINE" ]

                qualitySampleDischargeMode

string (enum)

Direktausschleusung
Zeitpunkt der Musterentnahme: sofort/vorgelagert, nachgelagert, umgewandelt

Any of: [ "IMMEDIATE", "DEFERRED", "CONVERTED" ]

                deliveryComparisonResult

string (enum)

Comparison result
Ergebnis des Abgleiches Soll/Ist

Any of: [ "DIFFERENCE", "NO_DIFFERENCE", "NO_COMPARISON" ]

2.7.2 -

Property Type Description

(Root)

object

WMS goods receipt messages
This document describes the goods receipt messages that FINE receives from warehouse systems.

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

    spanId*

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format with timezone in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

    version*

string

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

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

    context*

string (enum)

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

Any of: [ "GOODS_IN" ]

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "DELIVERY_NOTE_REGISTRATION_END", "GOODSRECEIPT_START", "GOODSRECEIPT_END", "DELIVERY_COMPARISON_START", "DELIVERY_COMPARISON_END", "RELEASE_END" ]

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

        client

string

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​). List of values: https://docs.osp-fine.de/page/fine-common/00_meta_data/me02_global_enumerations/me02_global_enumerations/#_enum_company

        instance

string

Software instance of producing system
Name of the source instance that generated this data. Used for example to distinguish between different Test Instances.

    data*

object

Additional Properties: false

        location*

string (enum)

The sending warehouse
The sending warehouse (cobra sends data for different warehouses), List of allowed values will be defined and documented #url

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

        businessEventTime*

string (date-time)

The date and time, when the business event occurred
the date and time, when the business event occurred, in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

        goodsInId*

string

the goods receipt ID
the goods receipt technical key, generated by the wms. (Possible UUID but other identifier accepted)

Maximum Length: 36

        originalGoodsInId

string

the original goods receipt ID
the goods receipt technical key, generated by the wms. This ID is referencing the original Delivery (technical key) in case when goods arrive back from rework

Maximum Length: 36

        deliveryNumber*

string

the inbound delivery business key
the inbound delivery business key, generated by the wms

Maximum Length: 36

        deliveryTypeCode

string

Identification of the type of entry/delivery
Identification of the type of entry/delivery type {manual, automatic entry, DLW, return, transfer, WE from post-processing, WE without goods, etc.} Only the known forms of the WMS are delivered.

Maximum Length: 50

        deliveryType*

string (enum)

Type of the delivery
the type of the delivery (from supplier, DLW, returns, postprocessing, without goods…​)

Any of: [ "GOODSIN_SUPPLIER", "GOODSIN_FROM_REWORK", "GOODSIN_FOR_BOOKING_AND_RELEASE", "GOODSIN_FOR_REMOVAL", "GOODSIN_INCOMPLETE", "GOODSIN_DLW", "GOODSIN_FOR_RELEASE", "GOODSIN_POST_PROCESSING", "GOODSIN_FROM_MAPPER", "GOODSIN_SECOND_CHOICE", "GOODSIN_STATIONARY_TRADE", "GOODSIN_SMALLPARTS", "GOODSIN_CANCELATION", "GOODSIN_RELABEL", "GOODSIN_B2B", "GOODSIN_FROM_RETAIL", "GOODSIN_3RD_PARTY" ]

        carrier

string

name of the carrier transporting goods
name of the carrier transporting goods

Maximum Length: 100

        gates

array

            (Array item)

object

                door

string

Gate or Door number
The gate, door no where the truck arrives

Maximum Length: 10

                building

string

Building
The building where the truck arrives

Maximum Length: 3

        processingInformation

array

            (Array item)

object

Additional Properties: false

                goodsReceiptProcessingType*

string (enum)

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

Any of: [ "PALLETED_SORTED", "PALLETED_UNSORTED", "CARTONS_SORTED", "CARTONS_UNSORTED", "SANDWICH_PALLET", "PULK_2MH", "DLW", "ITEMS_UNSORTED", "ITEMS_UNSORTED_FROM_KEP", "CARTONS_UNSORTED_FROM_KEP", "NON_TRADE_ITEMS" ]

                goodsReceiptProcessingCode*

string

Pallet/hatch detection code
Differentiation according to pallet/hatch detection, or in the case of Cobra: differentiation according to palletized/loose, loose, DLW, etc. WMS internal codes are transferred in this attribute

                quantity

integer

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

Minimum: 0
Maximum: 99999999999999

        positions

array

            (Array item)

object

Additional Properties: false

                deliveryPositionId*

string

Position Id
Unique ID of the position. Can be a number from a sequence, a UUID or a combination of GoodsInId + PositionNumber

Maximum Length: 36

                deliveryPositionNumber

integer

Position number
position number - incremental number (identifier) of the delivery position

Maximum: 99999999999999

                quantity*

integer

Quantity received
the received quantity for this item size according to the delivery note

Minimum: 0
Maximum: 99999999999999

                arrivedToReworkerQuantity

integer

Quantity received by the external reworker
the received quantity by the external reworker for this item size according to the delivery note

Minimum: 0
Maximum: 99999999999999

                destroyedByReworkerQuantity

integer

Quantity destroyed by the external reworker
the destroyed quantity for this item size by the external reworker

Minimum: 0
Maximum: 99999999999999

                loadingUnitQuantity

integer

Amount of goods
the amount of the goods quantity per loading unit

Minimum: 0
Maximum: 99999999999999

                supplierNumber*

integer

Supplier Number
the number of supplier

Maximum: 999999

                reworkerSupplierNumber

integer

External reworker supplier number
the number of the external reworker as supplier

Maximum: 999999

                documentNumber*

integer

Document number
for new goods deliveries this ist the goods receipt/goods acceptance protocol (WAP) number for this delivery entry generated from number range dependent on warehouse

Minimum: 100000
Maximum: 999999

                ownerCompany*

string

Owner Company (BDF)
stock-owner company for the product. List of values: https://docs.osp-fine.de/page/fine-common/00_meta_data/me02_global_enumerations/me02_global_enumerations/#_enum_company

                hermesTourNumber

string

Hermes number
the hermes tour number

Maximum Length: 12

                customsShipmentNumber

string

Custom shipment Number
shipment no from c@ts

                airWayBill

string

Custom shipment Number
Air Way Bill (Luftfrachtbrief)

Maximum Length: 30

                positionDetails

array

                    (Array item)

object

Additional Properties: false

                        purchaseOrderNumber*

string

Purchase Order Number
purchaseOrderNumber

Maximum Length: 36

                        deliveryNoteNumber

string

Delivery Note Number
the corresponding Id in the erp system

Maximum Length: 36

                        storageNotificationId

string

Storage Notification Id
Storage Notification Id

Maximum Length: 36

                        quantity

number

the quantity of the referenced PositionDetail within the position

                        electronicDeliveryNotePositionId

array

Electronic Delivery Note Position
list of delivery note positions

                            (Array item)

string

                        deliveryPositionDetailId

string

Position Detail Id
unique ID of the position detail

Maximum Length: 36

                        sourceLocation

string

Source/Original location
Where does the stock originally come from

                product*

object

Additional Properties: false

                    logisticsProductId*

string

Logistics Product Id
master communication key

Maximum Length: 36

                qualityCheck

string (enum)

Type of Quality Check
with goods inspection, without goods inspection, subsequent goods inspection. List of allowed values will be defined and documented #url

Any of: [ "NO_QUALITY_CHECK", "NORMAL_QUALITY_CHECK", "DOWNSTREAM_QUALITY_CHECK" ]
Maximum Length: 50

                qualityCode

integer

Quantity code number Goods inspection
quality code no from goods inspection (WACH)

Maximum: 999

                damagedQuantity

integer

Quantity items damaged
damaged quantity from transport (BI2), in COBRA always 0, damaged items will be booked additionally, in partno 1 set the qty for the complete item size

Maximum: 999999

                processEndDate

string

Process End Date
release date as YYYY-MM-DD

                processEndCode

string (enum)

Process End Code
ReturnKz/ReleaseCode = result of the activation process. List of allowed values will be defined and documented #url

Any of: [ "RELEASE", "CANCELLATION", "RETURN", "REWORK", "DESTROY", "THIRD_PARTY_SALE" ]

                erpDeliveryNo

string

Erp Deliver Number
Liefernummer im ERP_System

                qualitySampleRequestMode

string (enum)

Sample size calculation mode
Art der Musterberechnung. ONLINE=WACH/LIGIS, OFFLINE=claculated by the WMS

Any of: [ "ONLINE", "OFFLINE" ]

                qualitySampleDischargeMode

string (enum)

Direktausschleusung
Zeitpunkt der Musterentnahme: sofort/vorgelagert, nachgelagert, umgewandelt

Any of: [ "IMMEDIATE", "DEFERRED", "CONVERTED" ]

                deliveryComparisonResult

string (enum)

Comparison result
Ergebnis des Abgleiches Soll/Ist

Any of: [ "DIFFERENCE", "NO_DIFFERENCE", "NO_COMPARISON" ]

2.8 -

2.8.1 -

Property Type Description

(Root)

object

QSRequestErp
Request von FINE-QS das ERP

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender

string

The name of sender = producer
Name of the source system, which has generated this data.

Maximum Length: 30

        instance

string

SW-Instance of the producing system
Name of the source instance, which has generated this data

Maximum Length: 36

        client

string

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

    data*

object

        location*

string

Request location
Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD

Minimum Length: 3
Maximum Length: 30

        requestType*

string

Request type
PRELIMINARY, SECONDLOT, FINAL, CANCELLATION

Maximum Length: 60

        deliveryDate*

string (date)

Delivery Date
Datum der Anlieferung

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Positionen

Minimum number of items 1
Unique Items: true

            (Array item)

object

Additional Properties: false

                product*

object

                    erpProductId*

string

Erp product Id
FINE-LSAS ERP Product Identifier.

Maximum Length: 50

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

                partnerId

string

Partner Id
Bestandsfirma (lt. Artikelstamm)

Minimum Length: 1
Maximum Length: 7

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                purchaseOrderNumber*

integer

Purchase order number
Auftragsnummer (OVA)

Maximum Length: 20

                externalQualityCode*

string

External quality code
Aussenpruefkennziffer. Enum wird definiert: Keine (-), Aussengeprueft (A), Selbstpruefer (S), Identifizieren (I)

Maximum Length: 30

                deliveryQuantity*

number

Delivery quantity
Liefermenge

                storageNotificationId

string

Storage Notification Id
Technical key

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

2.8.2 -

Property Type Description

(Root)

object

QSRequestWms
Request vom WMS an FINE-QS

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender

string

The name of sender = producer
Name of the source system, which has generated this data.

Maximum Length: 30

        instance

string

SW-Instance of the producing system
Name of the source instance, which has generated this data

Maximum Length: 36

        client

string

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

    data*

object

        location*

string

Request location
Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD

Minimum Length: 3
Maximum Length: 30

        requestType*

string

Request type
PRELIMINARY, SECONDLOT, FINAL, CANCELLATION

Maximum Length: 60

        deliveryDate*

string (date)

Delivery Date
Datum der Anlieferung

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Positionen

Minimum number of items 1
Unique Items: true

            (Array item)

object

Additional Properties: false

                product*

object

                    logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

                partnerId

string

Partner Id
Bestandsfirma (lt. Artikelstamm)

Minimum Length: 1
Maximum Length: 7

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                purchaseOrderNumber*

integer

Purchase order number
Auftragsnummer (OVA)

Maximum Length: 20

                externalQualityCode*

string

External quality code
Aussenpruefkennziffer. Enum wird definiert: Keine (-), Aussengeprueft (A), Selbstpruefer (S), Identifizieren (I)

Maximum Length: 30

                deliveryQuantity*

number

Delivery quantity
Liefermenge

                storageNotificationId

string

Storage Notification Id
Technical key

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

2.9 -

2.9.1 -

Property Type Description

(Root)

object

QSResponseErp
Response vom ERP an FINE-QS

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender

string

The name of sender = producer
Name of the source system, which has generated this data.

Maximum Length: 30

        instance

string

SW-Instance of the producing system
Name of the source instance, which has generated this data

Maximum Length: 36

        client

string

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

    data*

object

        location*

string

Request location
Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD

Minimum Length: 3
Maximum Length: 30

        deliveryDate*

string (date)

Delivery Date
Datum der Anlieferung

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Positionen

Minimum number of items 1
Unique Items: true

            (Array item)

object

Additional Properties: false

                product*

object

                    erpProductId*

string

Erp product Id
FINE-LSAS ERP Product Identifier.

Maximum Length: 50

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Maximum Length: 20

                partnerId

string

Partner Id
Bestandsfirma (lt. Artikelstamm)

Minimum Length: 1
Maximum Length: 10

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                purchaseOrderNumber*

integer

Purchase order number
Auftragsnummer (OVA)

Maximum Length: 20

                qualityCode*

integer

Quality code
Prüfergebnis. Bei 103 oder 110 --> manuelle Freigabe; Friegabe nur dann wenn qualityCode mit diesen Werten anfängt: 10,11,15,45,50,75

Maximum Length: 6

                checkPrecision*

string

Check precision
Prüfschärfe

Maximum Length: 10

                sampleQuantity*

integer

Sample quantity
Mustermenge

Maximum Length: 6

                inspectionId*

string

Inspection Id
Prüfauftrag Identifier

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

2.9.2 -

Property Type Description

(Root)

object

QSResponseWms
Response von FINE-QS an das WMS

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender

string

The name of sender = producer
Name of the source system, which has generated this data.

Maximum Length: 30

        instance

string

SW-Instance of the producing system
Name of the source instance, which has generated this data

Maximum Length: 36

        client

string

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

    data*

object

        location*

string

Request location
Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD

Minimum Length: 3
Maximum Length: 30

        deliveryDate*

string (date)

Delivery Date
Datum der Anlieferung

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Positionen

Minimum number of items 1
Unique Items: true

            (Array item)

object

Additional Properties: false

                product*

object

                    logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Maximum Length: 20

                partnerId

string

Partner Id
Bestandsfirma (lt. Artikelstamm)

Minimum Length: 1
Maximum Length: 10

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                purchaseOrderNumber*

integer

Purchase order number
Auftragsnummer (OVA)

Maximum Length: 20

                qualityCode*

integer

Quality code
Prüfergebnis. Bei 103 oder 110 --> manuelle Freigabe; Friegabe nur dann wenn qualityCode mit diesen Werten anfängt: 10,11,15,45,50,75

Maximum Length: 6

                checkPrecision*

string

Check precision
Prüfschärfe

Maximum Length: 10

                sampleQuantity*

integer

Sample quantity
Mustermenge

Maximum Length: 6

                inspectionId*

string

Inspection Id
Prüfauftrag Identifier

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

2.10 -

2.10.1 -

Property Type Description

(Root)

object

QSResultErp
Prüfergebnisse der Warenprüfung

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender

string

The name of sender = producer
Name of the source system, which has generated this data.

Maximum Length: 30

        instance

string

SW-Instance of the producing system
Name of the source instance, which has generated this data

        client

string

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

    data*

object

        location*

string

Request location
Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD

Minimum Length: 3
Maximum Length: 30

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        product*

object

            erpProductId*

string

Erp product Id
FINE-LSAS ERP Product Identifier.

Maximum Length: 50

        supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

        receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

        qualityCode*

integer

Quality code
Prüfergebnis. Bei 103 oder 110 --> manuelle Freigabe; Friegabe nur dann wenn qualityCode mit diesen Werten anfängt: 10,11,15,45,50,75

Maximum Length: 6

        resultCode*

string

Quality result code
Ergebnis der Warenprüfung. Mögliche Werte: APPROPRIATE, REWORK, RETURN, INADEQUATE

        rejectionCode

string

Rejection code
Beanstandungskennzeichen. Mögliche Werte: leer, F = Formale Fehler, S = Serienfehler, Q = Qualitätsfehler

Minimum Length: 1
Maximum Length: 1

        inspectionId

string

Inspection Id
Prüfauftrag Identifier

Maximum Length: 36

        wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

        resultQuantity

number

Result quantity
Optionale Ergebnismenge. Wenn nicht vorhanden, dann bezieht sich das Ergebnis auf die ganze Liefermenge. Mit dem Attribut kann man Prüfergebnisse bezugen auf eine Teilmenge übertragen

        cmsId

string

CMS Id
CMS Identifier

Maximum Length: 36

2.10.2 -

Property Type Description

(Root)

object

QSResultWms
Prüfergebnisse der Warenprüfung

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender

string

The name of sender = producer
Name of the source system, which has generated this data.

Maximum Length: 30

        instance

string

SW-Instance of the producing system
Name of the source instance, which has generated this data

        client

string

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

    data*

object

        location*

string

Request location
Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD

Minimum Length: 3
Maximum Length: 30

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

        product*

object

            logisticsProductId*

string

Logistics Product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

        supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

        receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

        qualityCode*

integer

Quality code
Prüfergebnis. Bei 103 oder 110 --> manuelle Freigabe; Friegabe nur dann wenn qualityCode mit diesen Werten anfängt: 10,11,15,45,50,75

Maximum Length: 6

        resultCode*

string

Quality result code
Ergebnis der Warenprüfung. Mögliche Werte: APPROPRIATE, REWORK, RETURN, INADEQUATE

        rejectionCode

string

Rejection code
Beanstandungskennzeichen. Mögliche Werte: leer, F = Formale Fehler, S = Serienfehler, Q = Qualitätsfehler

Minimum Length: 1
Maximum Length: 1

        inspectionId

string

Inspection Id
Prüfauftrag Identifier

Maximum Length: 36

        wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

        resultQuantity

number

Result quantity
Optionale Ergebnismenge. Wenn nicht vorhanden, dann bezieht sich das Ergebnis auf die ganze Liefermenge. Mit dem Attribut kann man Prüfergebnisse bezugen auf eine Teilmenge übertragen

        cmsId

string

CMS Id
CMS Identifier

Maximum Length: 36

2.11 -

2.11.1 -

Property Type Description

(Root)

object

PacklistReadyForQsErp
Packstückliste für die Warenprüfung

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Minimum number of items 1
Unique Items: true

            (Array item)

object

                containerId*

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

                containerNumber*

string

Container number
Fachliche ID des Packstückes/Quantes/Gebinde

Maximum Length: 50

                buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

                erpProductId*

string

Erp product Id
FINE-LSAS Erp Product Identifier.

Maximum Length: 50

                quantity*

number

Menge
Menge innerhalb des Packstückes

                storageRemovalTime*

string (date-time)

Entnahmezeitpunkt
Entnahmezeitpunkt

                currentStorageLocation*

string

Lagerort/Lagerkoordinate
Lagerort/Lagerkoordinate, wo sich die Ware aktuell befindet

Maximum Length: 50

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                inspectionId*

string

Inspection Id
Prüfauftrag Identifier

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

2.11.2 -

Property Type Description

(Root)

object

PackageStatusAfterQsWms
Packstückliste für die Warenprüfung

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Minimum number of items 1
Unique Items: true

            (Array item)

object

                containerId*

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

                containerNumber*

string

Container number
Fachliche ID des Packstückes/Quantes/Gebinde

Maximum Length: 50

                buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

                logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

                quantity*

number

Menge
Menge innerhalb des Packstückes

                storageRemovalTime*

string (date-time)

Entnahmezeitpunkt
Entnahmezeitpunkt

                currentStorageLocation*

string

Lagerort/Lagerkoordinate
Lagerort/Lagerkoordinate, wo sich die Ware aktuell befindet

Maximum Length: 50

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                inspectionId*

string

Inspection Id
Prüfauftrag Identifier

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

2.12 -

2.12.1 -

Property Type Description

(Root)

object

PackageStatusAfterQsErp
Packstück Status nach der Warenprüfung

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        containerId*

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

        buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

        erpProductId*

string

Erp product Id
FINE-LSAS Erp Product Identifier.

Maximum Length: 50

        quantity*

number

Menge
Menge innerhalb des Packstückes

        status*

string

Package status
Status des Packstückes

Maximum Length: 20

2.12.2 -

Property Type Description

(Root)

object

PackageStatusAfterQsWms
Packstück Status nach der Warenprüfung

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        containerId*

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

        buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

        logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

        quantity*

number

Menge
Menge innerhalb des Packstückes

        status*

string

Package status
Status des Packstückes

Maximum Length: 20

2.13 -

2.13.1 -

Property Type Description

(Root)

object

AllPlannedReworksErp
Übermittlung aller geplanten Nachbearbeitungen

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        cmsId*

string

CMS ID
VorgangsID aus dem System CMS

Maximum Length: 36

        validFrom

string (date-time)

Valid from date
Gültigkeit der Nachbearbeitung (Anfang).

        validTo

string (date-time)

Valid to date
Gültigkeit der Nachbearbeitung (Ende).

        erpProductId*

string

Erp product Id
FINE-LSAS Erp Product Identifier.

Maximum Length: 50

        quantity*

number

Quantity
Soll-Menge

        storageNotificationId

array

StorageNotification reference
Liste von StorageNotificationIds

            (Array item)

string

        activityCode*

array

Activity codes
Liste der Nachbearbeitungsschritte

            (Array item)

string

        supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

        companyNumber*

string

Company number
Bestandsfirma

2.13.2 -

Property Type Description

(Root)

object

AllPlannedReworksWms
Übermittlung aller geplanten Nachbearbeitungen

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        cmsId*

string

CMS ID
VorgangsID aus dem System CMS

Maximum Length: 36

        validFrom

string (date-time)

Valid from date
Gültigkeit der Nachbearbeitung (Anfang).

        validTo

string (date-time)

Valid to date
Gültigkeit der Nachbearbeitung (Ende).

        logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

        quantity*

number

Quantity
Soll-Menge

        storageNotificationId

array

StorageNotification reference
Liste von StorageNotificationIds

            (Array item)

string

        activityCode*

array

Activity codes
Liste der Nachbearbeitungsschritte

            (Array item)

string

        supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

        companyNumber*

string

Company number
Bestandsfirma

2.14 -

2.14.1 -

Property Type Description

(Root)

object

UnplannedReworkErp
Übermittlung ungeplanter Nachbearbeitungen

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        positions*

array

Minimum number of items 1
Unique Items: true

            (Array item)

object

                containerId

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

                containerNumber

string

Container number
Fachliche ID des Packstückes/Quantes/Gebinde

Maximum Length: 50

                buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

                erpProductId*

string

Erp product Id
FINE-LSAS Erp Product Identifier.

Maximum Length: 50

                quantity*

number

Menge
Menge innerhalb des Packstückes

                activityCode*

array

Activity codes
Liste der Nachbearbeitungsschritte

                    (Array item)

string

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Maximum Length: 12

                deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                cmsId*

string

CMS Id
Id aus dem System CMS

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

2.14.2 -

Property Type Description

(Root)

object

UnplannedReworkWms
Übermittlung ungeplanter Nachbearbeitungen

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        positions*

array

Minimum number of items 1
Unique Items: true

            (Array item)

object

                containerId

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

                containerNumber

string

Container number
Fachliche ID des Packstückes/Quantes/Gebinde

Maximum Length: 50

                buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

                logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

                quantity*

number

Menge
Menge innerhalb des Packstückes

                activityCode*

array

Activity codes
Liste der Nachbearbeitungsschritte

                    (Array item)

string

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Maximum Length: 12

                deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                cmsId*

string

CMS Id
Id aus dem System CMS

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

2.15 -

2.15.1 -

Property Type Description

(Root)

object

ExecutedReworkStepsErp
Meldung durchgeführter Nachbearbeitungsschritte

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Minimum number of items 1
Unique Items: true

            (Array item)

object

                erpProductId*

string

Erp product Id
FINE-LSAS Erp Product Identifier.

Maximum Length: 50

                quantity*

number

Menge
Menge innerhalb des Packstückes

                activityCode*

array

Activity codes
Liste der Nachbearbeitungsschritte

                    (Array item)

string

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                cmsId*

string

CMS Id
Id aus dem System CMS

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

2.15.2 -

Property Type Description

(Root)

object

ExecutedReworkStepsWms
Meldung durchgeführter Nachbearbeitungsschritte

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Minimum number of items 1
Unique Items: true

            (Array item)

object

                logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

                quantity*

number

Menge
Menge innerhalb des Packstückes

                activityCode*

array

Activity codes
Liste der Nachbearbeitungsschritte

                    (Array item)

string

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                cmsId*

string

CMS Id
Id aus dem System CMS

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

2.16 -

2.16.1 -

Property Type Description

(Root)

object

DetourTransport
Umfuhren zwischen Lagerstandorten

    eventId*

string

The uniqe eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format with timezone in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "STOCK_TRANSFER_BETWEEN_WAREHOUSES", "STOCK_TRANSFER_CANCELLATION" ]
Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Version of the interface
Version number of this data structure. Sematic specification (String with major & minor nr)

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

    context*

string (enum)

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

Any of: [ "STOCK_TRANSFER" ]
Maximum Length: 36

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU", "F2X", "F2X_MANUFACTUM", "PSAUT", "F2X_SHEEGO", "F2X_CLEARANCE" ]

    data*

object

        locationSource*

string (enum)

Source warehouse
Quelllager

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" ]
Minimum Length: 3
Maximum Length: 30

        locationTarget*

string (enum)

Target warehouse
Ziellager

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" ]
Minimum Length: 3
Maximum Length: 30

        wmsOrderId*

string

WMS Order ID
VorgangsID im Lagerverwaltungssystem des Abgangslagers (WMS interne Nummer der Verladung, Lagerauftrag - ext. Belegnummer o.ä.)

Maximum Length: 36

        transportStartTime

string (date-time)

Start time from source warehouse
Verlade-Abschluss - Zeitstempel (Verladung ist fertig, WAB kann geschlossen sein)

        positions*

array

Minimum number of items 1

            (Array item)

object

                b2bOrderId

string

ERP Order ID
ERP Original-Auftragsnummer - falls der Umfuhrauftrag vom ERP stammt

Maximum Length: 36

                voucherNumber

integer

Belegnummer
Belegnummer z.B. bei WRS

Maximum Length: 6

                loadingNumber

string

Loading Number
Generierung pro Sender; Generierungsvorschrift nach Anforderung OTTO, muss für 13 Jahre eindeutig sein

Maximum Length: 12

                originalLoadingNumber

string

Original Loading Number
Referenziert die loadingNumber bei der Nachmeldung von Überlieferungen

Maximum Length: 12

                wabNumber

string

WAB Number
WAB Nummer

Maximum Length: 30

                latestStorageTime

string (date-time)

Latest storage time at the target warehouse
Spätester Einlagerungszeitpunkt im Ziellager

                priority

string (enum)

Priority for transport
Bedarfscluster. Priorität der Umfuhr bezogen auf das Packstück

Any of: [ "PRIORITY_A", "PRIORITY_B" ]
Maximum Length: 50

                stockType*

string (enum)

Stock type
Bestandsart, wie z.B. Lagerware, Durchlaufware, NLR

Any of: [ "STOCK_ITEM", "LOCKED", "DLW", "NLR" ]
Maximum Length: 50

                transportType*

string (enum)

Transport type
Transport typ: Bestandsumfuhr normal, Umfuhr-für-WRS-aus WE, Umfuhr-für-WRS von Lieferant, Umfuhr für IWA aus Wareneingang / Warenprüfung, Umfuhr für IWA für Muster, Großkundenauftrag

Any of: [ "STOCK_TRANSFER", "RETURN_INBOUND", "RETURN_SUPPLIER", "INTERNAL_REMOVAL_FROM_INBOUND", "INTERNAL_REMOVAL_FOR_SAMPLE", "SUPPLY", "STOCK_TRANSFER_WITH_PROMISE", "FINAL_REMOVAL", "OTTO_MARKET", "INBOUND_SAMPLE" ]
Maximum Length: 50

                containerId*

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

                containerNumber*

string

Container number
Fachliche ID des Packstückes/Quantes/Gebinde

Maximum Length: 50

                containerPackaging*

string

Container packaging
Norm des Packstückes

Maximum Length: 50

                parentContainerId

string

Parent container ID
Technische ID des übergeordneten Packstückes/Quantes/Gebinde

Maximum Length: 36

                parentContainerNumber

string

Parent container number
Fachliche ID des übergeordneten Packstückes/Quantes/Gebinde

Maximum Length: 36

                parentContainerPackaging

string

Parent container packaging
Norm

Maximum Length: 50

                logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 36

                erpProductId

string

ERP Product Id
ERP product communication key

Maximum Length: 36

                partNumber*

integer

Part number
Teilenummer für Großstücklogistik. Für Paketlogistik immer 1.

Maximum Length: 6

                productDetails

object

                    buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

                    rfid

string

RFID
RFID

Maximum Length: 64

                    imei1

string

IMEI1
IMEI1

Maximum Length: 16

                    imei2

string

IMEI2
IMEI2

Maximum Length: 16

                    producerId

string

Producer ID
Hersteller ID

Maximum Length: 36

                    batchId

string

Batch ID
Chargennummer

Maximum Length: 40

                    bestBeforeDate

string (date-time)

Best before date
Mindesthaltbarkeitsdatum

                ownerCompany*

string (enum)

Owner Company (BDF)
stock-owner company for the product

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU", "F2X", "F2X_MANUFACTUM", "PSAUT", "F2X_SHEEGO", "F2X_CLEARANCE" ]

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Maximum Length: 6

                logisticsSupplierId

string

Logistics supplier id
FINE-LSAS Logistics Supplier Identifier.

Maximum Length: 36

                quantity*

number

Quantity
Menge innerhalb des Packstückes

                deliveryNumber

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

                deliveryNumberShort

integer

Delivery number short
Nummer der Anlieferung (kurzversion, für die Zoll-Meldung)

Maximum Length: 7

                receivingDocumentNumber

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 6

                customsStatus*

string (enum)

Customs status
Zollstatus, wie z.B. freigut, zollgut, nicht definiert

Any of: [ "FREE", "DUTY", "NOT_DEFINED" ]
Maximum Length: 50

                storageNotificationId

string

Storage Notification Id
Technischer Schlüssel des StorageNotification

Maximum Length: 36

                deliveryPositionId

string

Delivery Position Id
Technischer Schlüssel des Anlieferposition

Maximum Length: 36

                sortDestination

integer

Sort Destination
Sortierziel

Maximum Length: 4

                returnsKey

string

Returns Key
Retourenschlüssel

Maximum Length: 36

                returnsEvaluationCode

string

Returns evaluation code
Retourenbeurteilung

Maximum Length: 50

                orderDescription

string

Order description
Auftragstext (Freitext)

Maximum Length: 100

                lockReason

string (enum)

Lock reason type
Sperrgrund

Any of: [ "REQUEST_BY_MERCHANT", "QUALITY_PROBLEMS", "WRONG_LABEL", "RESERVED_FOR_IWA", "DIFFERENCES", "OTHER" ]
Maximum Length: 50

                lockReasonText

string

Lock reason text
Sperrgrund Beschreibung (Freitext)

Maximum Length: 1000

2.17 -

2.17.1 -

Property Type Description

(Root)

object

ERP WRS/WRR bookings
This document describes the WRS/WRR messages that FINE sends to the ERPs.

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

    spanId*

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format with timezone in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

    version*

string

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

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

    context*

string (enum)

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

Any of: [ "RETURNS_TO_SUPPLIER" ]

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "WRS", "WRR" ]

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU", "F2X", "F2X_MANUFACTUM", "PSAUT", "F2X_SHEEGO", "F2X_CLEARANCE" ]

    data*

object

Additional Properties: false

        location*

string (enum)

Lagerstandort
Lagerstandort. Die Liste der Betriebe ist vordefiniert.

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

        businessEventTime*

string (date-time)

Datum und Uhrzeit des Geschäftsvorfalls
Datum und Uhrzeit des Geschäftsvorfalls in Lokalzeit. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

        businessEventKey*

string

UUID der Buchung
UUID der Buchung aus dem WMS

Maximum Length: 36

        supplierNumber*

integer

Lieferantenkennziffer
Lieferantenkennziffer

Maximum: 999999

        erpSupplierId*

string

LieferantenID
LieferantenID auf ERP-Seite

Maximum Length: 36

        creditorNumber

integer

Kreditornummer eines Lieferanten
Kreditornummer eines Lieferanten in SAP (ZLKZ)

Maximum: 9999999999

        ownerCompany*

string (enum)

Owner Company (BDF)
stock-owner company for the product

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU", "F2X", "F2X_MANUFACTUM", "PSAUT", "F2X_SHEEGO", "F2X_CLEARANCE" ]

        returnAddress*

object

Abweichende Adresse
Abweichende Adresse

            addressName

string

Name des Lieferanten
Name des Lieferanten.

Maximum Length: 100

            addressStreet

string

Straße, Hausnummer
Straße, Hausnummer.

Maximum Length: 100

            addressZip

string

Postleitzahl
Postleitzahl.

Maximum Length: 10

            addressCity

string

Ortschaft
Ortschaft.

Maximum Length: 100

            addressCountryCode

string

Zweistellige Ländercode
Zweistellige Ländercode (ISO standard).

Maximum Length: 2

        documentNumber*

integer

Belegnummer
Belegnummer der Warenrücksendung (9xxxxx), WRS in COBRA wird nur bei Beleg 94xxxx - 979999 gebucht; 2. Stelle der Belegnummer: 4 = Konsignationsware; 5 = Retourenware; 6 = Lagerreparaturen; 7 = Sonstige (Standard)

Minimum: 100000
Maximum: 999999

        wrsOrderNumber

integer

WRS Order Number
WRS Auftragsnummer vom ERP

Minimum: 10000000000000
Maximum: 99999999999999

        cancellableDocumentNumber

integer

Nummer des zu stornierenden Beleges
Nummer des zu stornierenden Beleges

Minimum: 100000
Maximum: 999999

        cancellationFlag*

string (enum)

Cancellation flag
Sagt aus, ob es sich um einen Storno handelt

Any of: [ "YES", "NO" ]

        returnReason*

string (enum)

Return reason
Rücksendegrund: Qualität, Überlieferung, Kulanz

Any of: [ "QUALITY", "SURPLUS_DELIVERY", "FAIRNESS" ]

        returnSourceCode*

string (enum)

Quelle der Rücksendung
Quelle der Rücksendung: Nicht-Lagerware, Konsignationsware, Retourenware, Lagerreparturen, Sonstige (Standard)

Any of: [ "NON_STOCK_ITEM", "CONSIGNMENT_GOODS", "RETURNS", "WAREHOUSE_REPAIRS", "DEFAULT" ]

        freightTermCode*

string (enum)

Frankatur
Frankatur: unfrei, frei Haus, Ab Werk, nicht identifiziert

Any of: [ "NOT_FREE", "FREE", "FROM_FACTORY", "NOT_IDENTIFIED" ]

        shipmentCode*

string (enum)

Versand veranlasst per
Versand veranlasst per: Spedition, Bahn, Post, Express, Abholung, keine Angabe

Any of: [ "CARRIER", "RAILWAY", "POST", "EXPRESS", "COLLECTION", "NOT_IDENTIFIED" ]

        postageCost

integer

Porto
Rückporto in Cent

Minimum: 0
Maximum: 999999999999

        extraCost

integer

Nebenkosten
Nebenkosten je Stück, in Cent

Minimum: 0
Maximum: 999999

        extraCostsCode*

string (enum)

Nebenkosten Kennzeichen
Nebenkosten Kennzeichen: Kundenretoure, Normkarton, Eigenfertigung, Trolli, Meterwaren, Hartware, keine Nebenkosten

Any of: [ "CUSTOMER_RETURNS", "STANDARD_CARTON", "SELF_PRODUCTION", "TROLLEY", "SOLD_BY_METER", "HARDWARE", "NO_EXTRA_COSTS" ]

        extraCostCartonQuantity

integer

Anzahl Kartons
Anzahl Kartons für die Nebenkostenberechnung

Minimum: 0
Maximum: 999

        extraCostOpenCartonQuantity

integer

Anzahl geöffneter Kartons
Anzahl geöffneter Kartons für die Nebenkostenberechnung

Minimum: 0
Maximum: 99

        documentCreatedBy*

string

Beleg erstellt von
Name der Mitarbeiter

        positions*

array

            (Array item)

object

Additional Properties: false

                erpProductId*

string

ERP Product Id
product communication key

Maximum Length: 36

                quantity*

integer

Return received
the returned quantity for this product

Minimum: 0
Maximum: 99999999999999

2.17.2 -

Property Type Description

(Root)

object

WMS WRS/WRR bookings
This document describes the WRS/WRR messages that the WMS sends to FINE.

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

    spanId*

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format with timezone in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

    version*

string

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

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

    context*

string (enum)

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

Any of: [ "RETURNS_TO_SUPPLIER" ]

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "WRS", "WRR" ]

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU", "F2X", "F2X_MANUFACTUM", "PSAUT", "F2X_SHEEGO", "F2X_CLEARANCE" ]

    data*

object

Additional Properties: false

        location*

string (enum)

Lagerstandort
Lagerstandort. Die Liste der Betriebe ist vordefiniert.

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

        businessEventTime*

string (date-time)

Datum und Uhrzeit des Geschäftsvorfalls
Datum und Uhrzeit des Geschäftsvorfalls in Lokalzeit. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

        businessEventKey*

string

UUID der Buchung
UUID der Buchung aus dem WMS

Maximum Length: 36

        supplierNumber*

integer

Lieferantenkennziffer
Lieferantenkennziffer

Maximum: 999999

        logisticsSupplierId*

string

LieferantenID
LieferantenID auf LVS-Seite

Maximum Length: 36

        creditorNumber

integer

Kreditornummer eines Lieferanten
Kreditornummer eines Lieferanten in SAP (ZLKZ)

Maximum: 9999999999

        ownerCompany*

string (enum)

Owner Company (BDF)
stock-owner company for the product

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU", "F2X", "F2X_MANUFACTUM", "PSAUT", "F2X_SHEEGO", "F2X_CLEARANCE" ]

        returnAddress*

object

Abweichende Adresse
Abweichende Adresse

            addressName

string

Name des Lieferanten
Name des Lieferanten.

Maximum Length: 100

            addressStreet

string

Straße, Hausnummer
Straße, Hausnummer.

Maximum Length: 100

            addressZip

string

Postleitzahl
Postleitzahl.

Maximum Length: 10

            addressCity

string

Ortschaft
Ortschaft.

Maximum Length: 100

            addressCountryCode

string

Zweistellige Ländercode
Zweistellige Ländercode (ISO standard).

Maximum Length: 2

        documentNumber*

integer

Belegnummer
Belegnummer der Warenrücksendung (9xxxxx), WRS in COBRA wird nur bei Beleg 94xxxx - 979999 gebucht; 2. Stelle der Belegnummer: 4 = Konsignationsware; 5 = Retourenware; 6 = Lagerreparaturen; 7 = Sonstige (Standard)

Minimum: 100000
Maximum: 999999

        wrsOrderNumber

integer

WRS Order Number
WRS Auftragsnummer vom ERP

Minimum: 10000000000000
Maximum: 99999999999999

        cancellableDocumentNumber

integer

Nummer des zu stornierenden Beleges
Nummer des zu stornierenden Beleges

Minimum: 100000
Maximum: 999999

        cancellationFlag*

string (enum)

Cancellation flag
Sagt aus, ob es sich um einen Storno handelt

Any of: [ "YES", "NO" ]

        returnReason*

string (enum)

Return reason
Rücksendegrund: Qualität, Überlieferung, Kulanz

Any of: [ "QUALITY", "SURPLUS_DELIVERY", "FAIRNESS" ]

        returnSourceCode*

string (enum)

Quelle der Rücksendung
Quelle der Rücksendung: Nicht-Lagerware, Konsignationsware, Retourenware, Lagerreparturen, Sonstige (Standard)

Any of: [ "NON_STOCK_ITEM", "CONSIGNMENT_GOODS", "RETURNS", "WAREHOUSE_REPAIRS", "DEFAULT" ]

        freightTermCode*

string (enum)

Frankatur
Frankatur: unfrei, frei Haus, Ab Werk, nicht identifiziert

Any of: [ "NOT_FREE", "FREE", "FROM_FACTORY", "NOT_IDENTIFIED" ]

        shipmentCode*

string (enum)

Versand veranlasst per
Versand veranlasst per: Spedition, Bahn, Post, Express, Abholung, keine Angabe

Any of: [ "CARRIER", "RAILWAY", "POST", "EXPRESS", "COLLECTION", "NOT_IDENTIFIED" ]

        postageCost

integer

Porto
Rückporto in Cent

Minimum: 0
Maximum: 999999999999

        extraCost

integer

Nebenkosten
Nebenkosten je Stück, in Cent

Minimum: 0
Maximum: 999999

        extraCostsCode*

string (enum)

Nebenkosten Kennzeichen
Nebenkosten Kennzeichen: Kundenretoure, Normkarton, Eigenfertigung, Trolli, Meterwaren, Hartware, keine Nebenkosten

Any of: [ "CUSTOMER_RETURNS", "STANDARD_CARTON", "SELF_PRODUCTION", "TROLLEY", "SOLD_BY_METER", "HARDWARE", "NO_EXTRA_COSTS" ]

        extraCostCartonQuantity

integer

Anzahl Kartons
Anzahl Kartons für die Nebenkostenberechnung

Minimum: 0
Maximum: 999

        extraCostOpenCartonQuantity

integer

Anzahl geöffneter Kartons
Anzahl geöffneter Kartons für die Nebenkostenberechnung

Minimum: 0
Maximum: 99

        documentCreatedBy*

string

Beleg erstellt von
Name der Mitarbeiter

        positions*

array

            (Array item)

object

Additional Properties: false

                logisticsProductId*

string

WMS Product Id
product communication key

Maximum Length: 36

                quantity*

integer

Return received
the returned quantity for this product

Minimum: 0
Maximum: 99999999999999

2.18 -

2.18.1 -

Property Type Description

(Root)

object

TransportDamageErp
Nachricht von FINE-QS an den ERP

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId*

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context*

string (enum)

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

Any of: [ "QS" ]
Maximum Length: 36

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "TRANSPORT_DAMAGE_NEW_GOODS" ]
Maximum Length: 36

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

    data*

object

        location*

string (enum)

The sending warehouse
The sending warehouse (cobra sends data for different warehouses), List of allowed values will be defined and documented #url

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

        businessEventTime*

string (date-time)

The date and time, when the business event occurred
the date and time, when the business event occurred, in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

        goodsInId*

string

the goods receipt ID
the goods receipt technical key, generated by the wms. (Possible UUID but other identifier accepted)

Maximum Length: 36

        deliveryNumber*

string

the inbound delivery business key
the inbound delivery business key, generated by the wms

Maximum Length: 36

        deliveryDate*

string (date)

Delivery Date
Datum der Anlieferung

        positions*

array

Positionen

Minimum number of items 1
Unique Items: true

            (Array item)

object

Additional Properties: false

                goodsInPositionId*

string

Position Id
unique ID of the position. (Earlier name of the attribute: deliveryPositionId, wmsPositionId)

Maximum Length: 36

                supplierNumber*

integer

Supplier Number
the number of supplier

Maximum: 999999

                erpProductId*

string

Erp Product Id
Product Identifier

Maximum Length: 36

                documentNumber*

integer

Document number
for deliveries from supplier this ist the goods receipt/goods acceptance protocoll (WAP) number for this delivery entry generated from number range dependent on warehouse 44000 to 449999 for Langenselbold GL, for other types (returns) their document number

Minimum: 100000
Maximum: 999999

                purchaseOrderNumber*

integer

Purchase order number
Auftragsnummer (OVA)

Maximum Length: 20

                storageNotificationId*

string

Storage Notification Id
ID of the Storage Notification (Interface I01)

Maximum Length: 36

                deliveryQuantity*

number

Delivery quantity
Liefermenge

                damagedQuantity*

number

Damaged quantity
Beschädigte Menge

                imageURLs

array

Image URLs

                    (Array item)

string

                damageCode

array

Fehlercode
Codeliste vorhanden!

                    (Array item)

string

2.18.2 -

Property Type Description

(Root)

object

TransportDamageWms
Nachricht vom WMS an FINE-QS

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId*

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context*

string (enum)

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

Any of: [ "QS" ]
Maximum Length: 36

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "TRANSPORT_DAMAGE_NEW_GOODS" ]
Maximum Length: 36

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

    data*

object

        location*

string (enum)

The sending warehouse
The sending warehouse (cobra sends data for different warehouses), List of allowed values will be defined and documented #url

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

        businessEventTime*

string (date-time)

The date and time, when the business event occurred
the date and time, when the business event occurred, in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

        goodsInId*

string

the goods receipt ID
the goods receipt technical key, generated by the wms. (Possible UUID but other identifier accepted)

Maximum Length: 36

        deliveryNumber*

string

the inbound delivery business key
the inbound delivery business key, generated by the wms

Maximum Length: 36

        deliveryDate*

string (date)

Delivery Date
Datum der Anlieferung

        positions*

array

Positionen

Minimum number of items 1
Unique Items: true

            (Array item)

object

Additional Properties: false

                goodsInPositionId*

string

Position Id
unique ID of the position. (Earlier name of the attribute: deliveryPositionId, wmsPositionId)

Maximum Length: 36

                supplierNumber*

integer

Supplier Number
the number of supplier

Maximum: 999999

                logisticsProductId*

string

Logistics Product Id
Product Identifier

Maximum Length: 36

                documentNumber*

integer

Document number
for deliveries from supplier this ist the goods receipt/goods acceptance protocoll (WAP) number for this delivery entry generated from number range dependent on warehouse 44000 to 449999 for Langenselbold GL, for other types (returns) their document number

Minimum: 100000
Maximum: 999999

                purchaseOrderNumber*

integer

Purchase order number
Auftragsnummer (OVA)

Maximum Length: 20

                storageNotificationId*

string

Storage Notification Id
ID of the Storage Notification (Interface I01)

Maximum Length: 36

                deliveryQuantity*

number

Delivery quantity
Liefermenge

                damagedQuantity*

number

Damaged quantity
Beschädigte Menge

                imageURLs

array

Image URLs

                    (Array item)

string

                damageCode

array

Fehlercode
Codeliste vorhanden!

                    (Array item)

string

2.19 - I01 Storage Notification

Status

Version 2.0 for ERP published 25.04.2023, Version 1.0 for WMS published 12.04.2022

Approval
  1. DeepSea: SST im Worksheet abgestimmt mit Oyster Fachbereich

  2. NEON: abgestimmt mit Körber zur Umsetzung in NEON_Fein_Pflichtenheft_WEN1_ SST_v6.0

Comment

Die Anbindung von MyToys ist in Planung und im Informationsflussdiagramm mit aufgenommen.

Assumption

Die Avise wird nicht komplett über die SST übertragen sondern die Positionen als StorageNotification

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

Inbound

InterfaceOwner

Producer

Oyster

Producer

OBS

MyToys

Consumer

FLASH

Consumer

kMotion

Consumer

KR1

Consumer

COBRA

Consumer

2. Business Context

Es wird unterschieden zwischen PurchaseOrder als Lieferantenauftrag und einer Avise (Advice). Daneben wird im Rahmen von Deepsea auch eine Einlagerungsauftag aufgebaut. Dieser entspricht unserem Verständnis nach der Avise. Somit beschreibt die Avise eine Anlieferung die bald am Lager ankommen wird. Darin wird auf eine PurchaseOrder verwiesen. Eine PurchaseOrder kann n Avisen haben. Eine Avise kann aus mehreren Lieferscheinen bestehen. Eine Avise kann nach ihrer Art (Type) unterschieden werden Lieferavise, Umfuhr, Retoureavise.

3. Informationflow

flow

4. Interface

4.1. Direction ERP to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

type

oyster-goods-receipt-event.PURCHASE_ORDER_CREATE

oyster-goods-receipt-event.PURCHASE_ORDER_UPDATE

oyster-goods-receipt-event.PURCHASE_ORDER_CONFIRM

oyster-goods-receipt-event.PURCHASE_ORDER_CANCEL

context

STORAGE_NOTIFICATION

4.1.2. Datamodel

Property Type Description

(Root)

object

    eventId*

string (uuid)

UUID for this event
ID of the event (message), will be generated by the actual producer

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    traceId*

string (uuid)

UUID for all events in a call hierarchy
ID of the trace, will be generated by the first producer of the process. The ID will be the same for all events in the context of this process, also over system bounderies. The ID is equal to the eventId, if it is the frist event.

It's like a order number, the will used for alle activities around the order.

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    spanId*

string (uuid)

UUID for all events in a call hierarchy
ID of the previous event (message). The ID is NULL if there is no previous event

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    version*

string

Json schema version
Version of the interface

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

    eventTime*

string (date-time)

Event time
Point in time where the event (message - not the businessEvent). Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

    context*

string

The name of the responsible context
Name of the context

Maximum Length: 20

    type*

string

Type
Name of the single atomar process (businessEvent) that causes this event

    sender*

string

Sender
The producer, that send the message (COBRA, K.MOTION…​)

    sourceIdentifier*

string

SourceIdentifier
End 2 End producer (original producer)

    instance

string

Instance
Application instance

    data*

object

        storageNotificationId*

string

Storage Notification Id
Technical key

Maximum Length: 36

        storageNotificationNo*

string

Storage Notification Number
Business key

        created*

string (date-time)

Created Date
Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

        updated*

string (date-time)

Updated Time
Modification date. For new installation: creatDate=modifyDate. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

        partnerId*

string

Partner Id
Platform ID in the first step is the Otto

        purchaseOrder*

object

            orderUUID*

string

Order UUID
PurchaseOrder ID - technische Schlüssel

            orderPositionUUID*

string

Order Position UUID
PurchaseOrder Position ID - technische Schlüssel

            orderNo*

string

Order Number
OVA

            location*

string

Storage Location
Storage location, List of allowed values will be defined and documented #url

            sourceLocation

string

Source/Original location
Where does the stock originally come from

            handlingType*

string

Handling Type
Processing type OSS, wholesale, wholesalelight

            supplyLocationCode*

string

Supply Location Code
e.g. 10 camp location with all its gates. Delivery address mark

            deliveryDate*

string (date)

Delivery Date
The planned delivery date. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

Maximum Length: 10

            forecastedWarehouseArrivalDate

string (date)

Forecasted Warehouse Arrival Date
Projected WE1 date. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

Maximum Length: 10

            forecastedBufferedStorageDate

string (date)

Forecasted Buffered Storage Date
Predicted WE2 Date. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

Maximum Length: 10

            foreignDemandQty

string

Foreign Demand Quantity
Fremdbedarfe ist eine Lagerwaren-Bestellung von Großkunden an Otto. Otto ist in diesem Fall also der Lieferant. Und manchmal beschafft Otto die benötigte Ware mit einem eigenen Otto-Auftrag mit.

            planningPeriodCode*

string

Planning Period Code
Season

            supplierNo*

string

Supplier Number
LKZ

            orderQty*

number

Order Quantity
PurchaseOrder quantity

        productIdentifier*

object

            erpProductId*

string

¨Erp Product Id
erpProductId aus LSAS

Maximum Length: 36

            FNSKU

string

FNSKU
Fachliche Artikelnummer

            sku*

string

¨Sku

Maximum Length: 36

            itemNo*

string

Item Number

Maximum Length: 16

            itemSize*

string

Item Size

Maximum Length: 16

4.1.3. Enumeration

Field: handlingType

Table 2. HandlingType
Meta Value Description Short Value

Abwicklungsart OSS

wholesale

wholesalelight

4.1.4. Example

Message ERP to FINE
{
	"eventId": "ba7b43dd-8b4a-46d9-9e3d-03bb3781e06e",
	"traceId": "c24558d1-eb1f-4723-9ab6-d026014e407f",
	"spanId": null,
	"version": "1.0",
	"type": "oyster-goods-receipt-event.PURCHASE_ORDER_CREATE",
	"context": "oyster-goods-receipt-event",
	"eventTime": "2022-03-31T12:41:06.036+0200",
	"sender": "DEEPSEA_OYSTER",
	"sourceIdentifier": "D2PO",
	"data": {
		"storageNotificationId": "305106fa-2068-44b9-bca2-5afaed6f5090",
		"storageNotificationNo": "BlackWarehouse",
		"created": "2022-03-22T09:52:00.000+0100",
		"partnerId": "1234",
		"purchaseOrder": {
			"orderUUID": "189263jdueke6",
			"orderPositionUUID": "djfs73hef",
			"orderNo": "456",
			"location": "ANSBACH",
			"supplierNo": "7890",
			"handlingType": "OSS",
			"supplyLocationCode": "10",
			"orderQty": "10.35",
			"foreignDemandQty": "0.0",
			"deliveryDate": "2022-03-22T00:00:00.000+0100",
			"forecastedWarehouseArrivalDate": "2022-03-22T00:00:00.000+0100",
			"forecastedBufferedStorageDate": "2022-03-22T00:00:00.000+0100",
			"planningPeriodCode": "144"
		},
		"productIdentifier": {
			"sku": "12345",
			"itemSize": "36",
			"itemNo": "51755400",
			"fnsku": null,
			"erpProductId": null
		}
	}
}

4.1.5. Schema

Table 3. Versionsübersicht ERP to FINE
Version Number File Published on Changes

current version

2.0

Download

12.04.2022

previous version

coming version

Interface ERP to FINE
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$comment": "Schema for Storage Notification from ERP to FINE",
  "$id": "https://doc.fine.gcp.osp-dev.de/registry/Inbound/StorageNotificationErp.v2.0.schema.json",
    "type": "object",
    "properties": {
      "eventId": {
        "description": "ID of the event (message), will be generated by the actual producer",
        "type": "string",
        "format": "uuid",
        "minLength": 36,
        "maxLength": 36,
        "title": "UUID for this event",
        "examples":["00ce536f-923a-42f4-8128-be118faf1d87"],
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      },
      "traceId": {
        "description": "ID of the trace, will be generated by the first producer of the process. The ID will be the same for all events in the context of this process, also over system bounderies. The ID is equal to the eventId, if it is the frist event.\n\nIt's like a order number, the will used for alle activities around the order.",
        "type": "string",
        "format": "uuid",
        "minLength": 36,
        "maxLength": 36,
        "title": "UUID for all events in a call hierarchy",
        "examples":["00ce536f-923a-42f4-8128-be118faf1d87"],
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      },
      "spanId": {
        "description": "ID of the previous event (message). The ID is NULL if there is no previous event",
        "type": "string",
        "format": "uuid",
        "minLength": 36,
        "maxLength": 36,
        "title": "UUID for all events in a call hierarchy",
        "examples":["00ce536f-923a-42f4-8128-be118faf1d87"],
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      },
      "version": {
        "description": "Version of the interface",
        "type": "string",
        "pattern": "^[0-9]+[.][0-9]+$",
        "minLength": 3,
        "maxLength": 4,
        "title": "Json schema version",
        "examples":["1.0","1.11","1.1"]
      },
      "eventTime": {
        "description": "Point in time where the event (message - not the businessEvent). Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
        "type": "string",
        "format": "date-time",
        "title": "Event time",
        "example": ["2022-03-31T12:41:06.036+0200"]
      },
      "context": {
        "description": "Name of the context",
        "type": "string",
        "maxLength": 20,
        "title": "The name of the responsible context",
        "examples":["oyster-goods-receipt-event"]
      },
      "type": {
        "description": "Name of the single atomar process (businessEvent) that causes this event",
        "type": "string",
        "title": "Type",
        "examples":["oyster-goods-receipt-event.PURCHASE_ORDER_CREATE"]
      },
      "sender": {
        "description": "The producer, that send the message (COBRA, K.MOTION...)",
        "type": "string",
        "title": "Sender",
        "examples":["DEEPSEA_OYSTER"]
      },
      "sourceIdentifier": {
        "description": "End 2 End producer (original producer)",
        "type": "string",
        "title": "SourceIdentifier",
        "examples":["D2PO"]
      },
      "instance": {
        "description": "Application instance",
        "type": "string",
        "title": "Instance",
        "examples":["50.127.8.10"]
      },
      "data": {
        "type": "object",
        "properties": {
          "storageNotificationId": {
            "description": "Technical key",
            "type": "string",
            "title": "Storage Notification Id",
            "maxLength": 36,
            "examples":["305106fa-2068-44b9-bca2-5afaed6f5090"]
          },
          "storageNotificationNo": {
            "description": "Business key",
            "type": "string",
            "title": "Storage Notification Number",
            "examples":["BlackWarehouse"]
          },
          "created": {
            "description": "Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
            "type": "string",
            "format": "date-time",
            "title": "Created Date",
            "examples":["2022-03-22T09:52:00.000+0100"]
          },
          "updated": {
            "description": "Modification date. For new installation: creatDate=modifyDate. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
            "type": "string",
            "format": "date-time",
            "title": "Updated Time",
            "examples":["2022-03-22T09:52:00.000+0100"]
          },
          "partnerId": {
            "description": "Platform ID in the first step is the Otto",
            "type": "string",
            "title": "Partner Id",
            "examples":["1234"]
          },
          "purchaseOrder": {
            "type": "object",
            "properties": {
              "orderUUID": {
                "description": "PurchaseOrder ID - technische Schlüssel",
                "type": "string",
                "title": "Order UUID",
                "examples":["189263jdueke6"]
              },
              "orderPositionUUID": {
                "description": "PurchaseOrder Position ID - technische Schlüssel",
                "type": "string",
                "title": "Order Position UUID",
                "examples":["djfs73hef"]
              },
              "orderNo": {
                "description": "OVA",
                "type": "string",
                "title": "Order Number",
                "examples":["456"]
              },
              "location": {
                "description": "Storage location, List of allowed values will be defined and documented #url",
                "type": "string",
                "title": "Storage Location",
                "example": ["ANSBACH"]
              },
              "sourceLocation": {
                "description": "Where does the stock originally come from",
                "type": "string",
                "title": "Source/Original location",
                "example": ["54513210"]
              },
              "handlingType": {
                "description": "Processing type OSS, wholesale, wholesalelight",
                "type": "string",
                "title": "Handling Type",
                "examples":["OSS"]
              },
              "supplyLocationCode": {
                "description": "e.g. 10 camp location with all its gates. Delivery address mark",
                "type": "string",
                "title": "Supply Location Code",
                "examples":["10"]
              },
              "deliveryDate": {
                "description": "The planned delivery date.  Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
                "type": "string",
                "format": "date",
                "maxLength": 10,
                "title": "Delivery Date",
                "examples":["2022-03-22T00:00:00.000+0100"]
              },
              "forecastedWarehouseArrivalDate": {
                "description": "Projected WE1 date.  Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
                "type": "string",
                "format": "date",
                "maxLength": 10,
                "title": "Forecasted Warehouse Arrival Date",
                "examples":["2022-03-22T00:00:00.000+0100"]
              },
              "forecastedBufferedStorageDate": {
                "description": "Predicted WE2 Date.  Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
                "type": "string",
                "format": "date",
                "maxLength": 10,
                "title": "Forecasted Buffered Storage Date",
                "examples":["2022-03-22T00:00:00.000+0100"]
              },
              "foreignDemandQty": {
                "description": "Fremdbedarfe ist eine Lagerwaren-Bestellung von Großkunden an Otto. Otto ist in diesem Fall also der Lieferant. Und manchmal beschafft Otto die benötigte Ware mit einem eigenen Otto-Auftrag mit.",
                "type": "string",
                "title": "Foreign Demand Quantity",
                "examples":["0.0"]
              },
              "planningPeriodCode": {
                "description": "Season",
                "type": "string",
                "title": "Planning Period Code",
                "examples":["144"]
              },
              "supplierNo": {
                "description": "LKZ",
                "type": "string",
                "title": "Supplier Number",
                "examples":["7890"]
              },
              "orderQty": {
                "description": "PurchaseOrder quantity",
                "type": "number",
                "title": "Order Quantity",
                "examples":["10.35"]
              }
            },
            "required": [
              "orderUUID",
              "orderPositionUUID",
              "orderNo",
              "location",
              "handlingType",
              "supplyLocationCode",
              "deliveryDate",
              "planningPeriodCode",
              "supplierNo",
              "orderQty"
            ]
          },
          "productIdentifier": {
            "type": "object",
            "properties": {
              "erpProductId": {
                "description": "erpProductId aus LSAS",
                "type": "string",
                "maxLength": 36,
                "title": "¨Erp Product Id",
                "examples":["3291147085"]
              },
              "FNSKU": {
                "description": "Fachliche Artikelnummer",
                "type": "string",
                "title": "FNSKU",
                "examples":["00ce536f-923a-42f4-8128-be118faf1d87"]
              },
              "sku": {
                "description": "",
                "type": "string",
                "title": "¨Sku",
                "maxLength": 36,
                "examples":["89a8781f-539e-407d-b46c-9c2f1e6eef3b"]
              },
              "itemNo": {
                "description": "",
                "type": "string",
                "maxLength": 16,
                "title": "Item Number",
                "examples":["4"]
              },
              "itemSize": {
                "description": "",
                "type": "string",
                "maxLength": 16,
                "title": "Item Size",
                "examples":["960"]
              }
            },
            "required": [
              "erpProductId",
              "sku",
              "itemNo",
              "itemSize"
            ]
          }
        },
        "required": [
          "storageNotificationId",
          "storageNotificationNo",
          "created",
          "updated",
          "partnerId",
          "purchaseOrder",
          "productIdentifier"
        ]
      }
    },
    "required": [
      "eventId",
      "traceId",
      "spanId",
      "version",
      "eventTime",
      "context",
      "type",
      "sender",
      "sourceIdentifier",
      "data"
    ],
    "examples": [
      {
        "eventId": "ba7b43dd-8b4a-46d9-9e3d-03bb3781e06e",
        "traceId": "c24558d1-eb1f-4723-9ab6-d026014e407f",
        "spanId": null,
        "version": "1.0",
        "type": "oyster-goods-receipt-event.PURCHASE_ORDER_CREATE",
        "context": "oyster-goods-receipt-event",
        "eventTime": "2022-03-31T12:41:06.036+0200",
        "sender": "DEEPSEA_OYSTER",
        "sourceIdentifier": "D2PO",
        "data": {
          "storageNotificationId": "305106fa-2068-44b9-bca2-5afaed6f5090",
          "storageNotificationNo": "BlackWarehouse",
          "created": "2022-03-22T09:52:00.000+0100",
          "partnerId": "1234",
          "purchaseOrder": {
            "orderUUID": "189263jdueke6",
            "orderPositionUUID": "djfs73hef",
            "orderNo": "456",
            "location": "ANSBACH",
            "supplierNo": "7890",
            "handlingType": "OSS",
            "supplyLocationCode": "10",
            "orderQty": "10.35",
            "foreignDemandQty": "0.0",
            "deliveryDate": "2022-03-22T00:00:00.000+0100",
            "forecastedWarehouseArrivalDate": "2022-03-22T00:00:00.000+0100",
            "forecastedBufferedStorageDate": "2022-03-22T00:00:00.000+0100",
            "planningPeriodCode": "144"
          },
          "productIdentifier": {
            "sku": "12345",
            "itemSize": "36",
            "itemNo": "51755400",
            "fnsku": null,
            "erpProductId": null
          }
        }
      }
    ]
  }

4.2. Direction FINE to WMS

4.2.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 4. Attribute
Fieldname Expresion

type

PURCHASE_ORDER_CREATE

PURCHASE_ORDER_UPDATE

PURCHASE_ORDER_CONFIRM

PURCHASE_ORDER_CANCEL

context

STORAGE_NOTIFICATION

4.2.2. Datamodel

Property Type Description

(Root)

object

    eventId*

string (uuid)

UUID for this event
ID of the event (message), will be generated by the actual producer

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    traceId*

string (uuid)

UUID for all events in a call hierarchy
ID of the trace, will be generated by the first producer of the process. The ID will be the same for all events in the context of this process, also over system bounderies. The ID is equal to the eventId, if it is the frist event.

It's like a order number, the will used for alle activities around the order.

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    spanId*

string (uuid)

UUID for all events in a call hierarchy
ID of the previous event (message). The ID is NULL if there is no previous event

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    version*

string

Json schema version
Version of the interface

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

    eventTime*

string (date-time)

Event time
Point in time where the event (message - not the businessEvent). Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

    context*

string

The name of the responsible context
Name of the context

Maximum Length: 20

    type*

string

Type
Name of the single atomar process (businessEvent) that causes this event

    sender*

string

Sender
The producer, that send the message (COBRA, K.MOTION…​)

    sourceIdentifier*

string

SourceIdentifier
End 2 End producer (original producer)

    instance

string

Instance
Application instance

    data*

object

        storageNotificationId*

string

Storage Notification Id
Technical key

Maximum Length: 36

        storageNotificationNo*

string

Storage Notification Number
Business key

        createDate*

string (date-time)

Created Date
Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

        modifyDate

string (date-time)

Modify Date
Änderungsdatum. Bei Neuanlage: creatDate=modifyDate. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

        partnerId*

string

Partner Id
Platform ID in the first step is the Otto

        location*

string

Storage Location
Storage location, List of allowed values will be defined and documented #url

        sourceLocation

string

Source/Original location
Where does the stock originally come from

        purchaseOrder*

object

            orderUUID*

string

Order UUID
PurchaseOrder ID - technische Schlüssel

            orderPositionUUID*

string

Order Position UUID
PurchaseOrder Position ID - technische Schlüssel

            orderNumber*

string

Order Number
OVA

            handlingType*

string

Handling Type
Processing type OSS, wholesale, wholesalelight

            supplyLocationCode*

string

Supply Location Code
e.g. 10 camp location with all its gates. Delivery address mark

            deliveryDate*

string (date)

Delivery Date
The planned delivery date. Format: yyyy-MM-dd

Maximum Length: 10

            forecastedWarehouseArrivalDate

string (date)

Forecasted Warehouse Arrival Date
Projected WE1 date. Format: yyyy-MM-dd

Maximum Length: 10

            forecastedBufferedStorageDate

string (date)

Forecasted Buffered Storage Date
Predicted WE2 Date. Format: yyyy-MM-dd

Maximum Length: 10

            foreignDemandQty

string

Foreign Demand Quantity
Fremdbedarfe ist eine Lagerwaren-Bestellung von Großkunden an Otto. Otto ist in diesem Fall also der Lieferant. Und manchmal beschafft Otto die benötigte Ware mit einem eigenen Otto-Auftrag mit.

            planningPeriodCode*

string

Planning Period Code
Season

            supplierNumber*

string

Supplier Number
LKZ

            quantity*

number

Order Quantity
PurchaseOrder quantity

        product*

object

            logisticProductId*

string

¨Logistic Product Id
logisticProductId aus LSAS

Maximum Length: 30

            erpProductId*

string

¨Erp Product Id
erpProductId aus LSAS

Maximum Length: 36

            FNSKU

string

FNSKU
Fachliche Artikelnummer

            sku*

string

¨Sku

Maximum Length: 36

            itemNumber*

string

Item Number

Maximum Length: 16

            itemSize*

string

Item Size

Maximum Length: 16

4.2.3. Enumeration

Field: handlingType

Table 5. HandlingType
Meta Value Description Short Value

Abwicklungsart OSS

wholesale

wholesalelight

4.2.4. Example

Message FINE to WMS
{
    "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
    "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
    "spanId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
    "version": "1.0",
    "eventTime": "2018-11-28T08:25:56.523+0000",
    "context": "oyster-goods-receipt-event",
    "type": "PURCHASE_ORDER_CREATE",
    "sender": "fine-inbound",
    "sourceIdentifier": "D2PO",
    "instance": "instance",
    "data": {
      "storageNotificationId": "23548bfa-3d69-4080-90d1-37c4157bbe6a",
      "storageNotificationNo": "BD52FD46S2",
      "createDate": "2022-01-17T14:30:25.523+0000",
      "modifyDate": "2022-01-17T14:30:25.523+0000",
      "partnerId": "10000",
      "location": "ANSBACH",
      "purchaseOrder": {
        "orderUUID": "da087ed3-0802-4c48-bfb8-6f95dd254589",
        "orderPositionUUID": "7db820fb-d61b-4438-ac2d-d0fd8b6d36ca",
        "orderNumber": "57322",
        "handlingType": "WHS",
        "supplyLocationCode": "10",
        "deliveryDate": "2022-01-20",
        "forecastedWarehouseArrivalDate": "2022-01-25",
        "forecastedBufferedStorageDate": "2022-01-26",
        "foreignDemandQty": "0",
        "planningPeriodCode": "145",
        "supplierNumber": "11223",
        "quantity": 10
      },
      "product": {
        "logisticProductId": "123456789",
        "erpProductId": "123456789",
        "FNSKU": "AB12345678",
        "sku": "208d8205-510e-479b-bba1-6d8c3dd99354",
        "itemNumber": "51755400",
        "itemSize": "36"
      }
    }
  }

4.2.5. Schema

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

current version

1.0

Download

12.04.22

previous version

coming version

Interface FINE to WMS
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$comment": "Schema for Storage Notification from FINE to warehouse",
  "$id": "https://doc.fine.gcp.osp-dev.de/registry/Inbound/StorageNotificationWms.v1.0.schema.json",  
    "type": "object",
    "properties": {
      "eventId": {
        "description": "ID of the event (message), will be generated by the actual producer",
        "type": "string",
        "format": "uuid",
        "minLength": 36,
        "maxLength": 36,
        "title": "UUID for this event",
        "examples":["00ce536f-923a-42f4-8128-be118faf1d87"],
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      },
      "traceId": {
        "description": "ID of the trace, will be generated by the first producer of the process. The ID will be the same for all events in the context of this process, also over system bounderies. The ID is equal to the eventId, if it is the frist event.\n\nIt's like a order number, the will used for alle activities around the order.",
        "type": "string",
        "format": "uuid",
        "minLength": 36,
        "maxLength": 36,
        "title": "UUID for all events in a call hierarchy",
        "examples":["00ce536f-923a-42f4-8128-be118faf1d87"],
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      },
      "spanId": {
        "description": "ID of the previous event (message). The ID is NULL if there is no previous event",
        "type": "string",
        "format": "uuid",
        "minLength": 36,
        "maxLength": 36,
        "title": "UUID for all events in a call hierarchy",
        "examples":["00ce536f-923a-42f4-8128-be118faf1d87"],
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      },
      "version": {
        "description": "Version of the interface",
        "type": "string",
        "pattern": "^[0-9]+[.][0-9]+$",
        "minLength": 3,
        "maxLength": 4,
        "title": "Json schema version",
        "examples":["1.0","1.11","1.1"]
      },
      "eventTime": {
        "description": "Point in time where the event (message - not the businessEvent). Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
        "type": "string",
        "format": "date-time",
        "title": "Event time",
        "example": ["2022-03-31T12:41:06.036+0200"]
      },
      "context": {
        "description": "Name of the context",
        "type": "string",
        "maxLength": 20,
        "title": "The name of the responsible context",
        "examples":["oyster-goods-receipt-event"]
      },
      "type": {
        "description": "Name of the single atomar process (businessEvent) that causes this event",
        "type": "string",
        "title": "Type",
        "examples":["PURCHASE_ORDER_CREATE"]
      },
      "sender": {
        "description": "The producer, that send the message (COBRA, K.MOTION...)",
        "type": "string",
        "title": "Sender",
        "examples":["fine-inbound"]
      },
      "sourceIdentifier": {
        "description": "End 2 End producer (original producer)",
        "type": "string",
        "title": "SourceIdentifier",
        "examples":["D2PO"]
      },
      "instance": {
        "description": "Application instance",
        "type": "string",
        "title": "Instance",
        "examples":["50.127.8.10"]
      },
      "data": {
        "type": "object",
        "properties": {
          "storageNotificationId": {
            "description": "Technical key",
            "type": "string",
            "title": "Storage Notification Id",
            "maxLength": 36,
            "examples":["305106fa-2068-44b9-bca2-5afaed6f5090"]
          },
          "storageNotificationNo": {
            "description": "Business key",
            "type": "string",
            "title": "Storage Notification Number",
            "examples":["BlackWarehouse"]
          },
          "createDate": {
            "description": "Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
            "type": "string",
            "format": "date-time",
            "title": "Created Date",
            "examples":["2022-03-22T09:52:00.000+0100"]
          },
          "modifyDate": {
            "description": "Änderungsdatum. Bei Neuanlage: creatDate=modifyDate. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
            "type": "string",
            "format": "date-time",
            "title": "Modify Date",
            "examples":["2022-03-22T09:52:00.000+0100"]
          },
          "partnerId": {
            "description": "Platform ID in the first step is the Otto",
            "type": "string",
            "title": "Partner Id",
            "examples":["1234"]
          },
          "location": {
            "description": "Storage location, List of allowed values will be defined and documented #url",
            "type": "string",
            "title": "Storage Location",
            "example": ["Ansbach"]
          },
          "sourceLocation": {
            "description": "Where does the stock originally come from",
            "type": "string",
            "title": "Source/Original location",
            "example": ["54513210"]
          },
          "purchaseOrder": {
            "type": "object",
            "properties": {
              "orderUUID": {
                "description": "PurchaseOrder ID - technische Schlüssel",
                "type": "string",
                "title": "Order UUID",
                "examples":["189263jdueke6"]
              },
              "orderPositionUUID": {
                "description": "PurchaseOrder Position ID - technische Schlüssel",
                "type": "string",
                "title": "Order Position UUID",
                "examples":["djfs73hef"]
              },
              "orderNumber": {
                "description": "OVA",
                "type": "string",
                "title": "Order Number",
                "examples":["456"]
              },
              "handlingType": {
                "description": "Processing type OSS, wholesale, wholesalelight",
                "type": "string",
                "title": "Handling Type",
                "examples":["OSS"]
              },
              "supplyLocationCode": {
                "description": "e.g. 10 camp location with all its gates. Delivery address mark",
                "type": "string",
                "title": "Supply Location Code",
                "examples":["10"]
              },
              "deliveryDate": {
                "description": "The planned delivery date.  Format: yyyy-MM-dd",
                "type": "string",
                "format": "date",
                "maxLength": 10,
                "title": "Delivery Date",
                "examples":["2022-03-22"]
              },
              "forecastedWarehouseArrivalDate": {
                "description": "Projected WE1 date.  Format: yyyy-MM-dd",
                "type": "string",
                "format": "date",
                "maxLength": 10,
                "title": "Forecasted Warehouse Arrival Date",
                "examples":["2022-03-22"]
              },
              "forecastedBufferedStorageDate": {
                "description": "Predicted WE2 Date.  Format: yyyy-MM-dd",
                "type": "string",
                "format": "date",
                "maxLength": 10,
                "title": "Forecasted Buffered Storage Date",
                "examples":["2022-03-22"]
              },
              "foreignDemandQty": {
                "description": "Fremdbedarfe ist eine Lagerwaren-Bestellung von Großkunden an Otto. Otto ist in diesem Fall also der Lieferant. Und manchmal beschafft Otto die benötigte Ware mit einem eigenen Otto-Auftrag mit.",
                "type": "string",
                "title": "Foreign Demand Quantity",
                "examples":["0.0"]
              },
              "planningPeriodCode": {
                "description": "Season",
                "type": "string",
                "title": "Planning Period Code",
                "examples":["144"]
              },
              "supplierNumber": {
                "description": "LKZ",
                "type": "string",
                "title": "Supplier Number",
                "examples":["7890"]
              },
              "quantity": {
                "description": "PurchaseOrder quantity",
                "type": "number",
                "title": "Order Quantity",
                "examples":["10.35"]
              }
            },
            "required": [
              "orderUUID",
              "orderPositionUUID",
              "orderNumber",
              "handlingType",
              "supplyLocationCode",
              "deliveryDate",
              "planningPeriodCode",
              "supplierNumber",
              "quantity"
            ]
          },
          "product": {
            "type": "object",
            "properties": {
              "logisticProductId": {
                "description": "logisticProductId aus LSAS",
                "type": "string",
                "maxLength": 30,
                "title": "¨Logistic Product Id",
                "examples":["123"]
              },
              "erpProductId": {
                "description": "erpProductId aus LSAS",
                "type": "string",
                "maxLength": 36,
                "title": "¨Erp Product Id",
                "examples":["3291147085"]
              },
              "FNSKU": {
                "description": "Fachliche Artikelnummer",
                "type": "string",
                "title": "FNSKU",
                "examples":["00ce536f-923a-42f4-8128-be118faf1d87"]
              },
              "sku": {
                "description": "",
                "type": "string",
                "title": "¨Sku",
                "maxLength": 36,
                "examples":["89a8781f-539e-407d-b46c-9c2f1e6eef3b"]
              },
              "itemNumber": {
                "description": "",
                "type": "string",
                "maxLength": 16,
                "title": "Item Number",
                "examples":["4"]
              },
              "itemSize": {
                "description": "",
                "type": "string",
                "maxLength": 16,
                "title": "Item Size",
                "examples":["960"]
              }
            },
            "required": [
              "logisticProductId",
              "erpProductId",
              "sku",
              "itemNumber",
              "itemSize"
            ]
          }
        },
        "required": [
          "storageNotificationId",
          "storageNotificationNo",
          "createDate",
          "partnerId",
          "location",
          "purchaseOrder",
          "product"
        ]
      }
    },
    "required": [
      "eventId",
      "traceId",
      "spanId",
      "version",
      "eventTime",
      "context",
      "type",
      "sender",
      "sourceIdentifier",
      "data"
    ],
    "examples": [
      {
        "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
        "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
        "spanId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
        "version": "1.0",
        "eventTime": "2018-11-28T08:25:56.523+0000",
        "context": "oyster-goods-receipt-event",
        "type": "PURCHASE_ORDER_CREATE",
        "sender": "fine-inbound",
        "sourceIdentifier": "D2PO",
        "instance": "instance",
        "data": {
          "storageNotificationId": "23548bfa-3d69-4080-90d1-37c4157bbe6a",
          "storageNotificationNo": "BD52FD46S2",
          "createDate": "2022-01-17T14:30:25.523+0000",
          "modifyDate": "2022-01-17T14:30:25.523+0000",
          "partnerId": "10000",
          "location": "ANSBACH",
          "purchaseOrder": {
            "orderUUID": "da087ed3-0802-4c48-bfb8-6f95dd254589",
            "orderPositionUUID": "7db820fb-d61b-4438-ac2d-d0fd8b6d36ca",
            "orderNumber": "57322",
            "handlingType": "WHS",
            "supplyLocationCode": "10",
            "deliveryDate": "2022-01-20",
            "forecastedWarehouseArrivalDate": "2022-01-25",
            "forecastedBufferedStorageDate": "2022-01-26",
            "foreignDemandQty": "0",
            "planningPeriodCode": "145",
            "supplierNumber": "11223",
            "quantity": 10
          },
          "product": {
            "logisticProductId": "123456789",
            "erpProductId": "123456789",
            "FNSKU": "AB12345678",
            "sku": "208d8205-510e-479b-bba1-6d8c3dd99354",
            "itemNumber": "51755400",
            "itemSize": "36"
          }
        }
      }
    ]
  }

2.20 - I02A Despatch Advice Ramp

Status

DRAFT → Dokumentation im Aufbau

Approval
Comment

FLASH nutzt bereits eine CargoClix-Schnittstelle produktiv. Die folgende Beschreibung bezieht sich auf ein neu zu entwickelndes Schnittstellenformat.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

InterfaceOwner

Producer

CargoClix

Consumer

FLASH

Consumer

Oyster

2. Business Context

ramp master data

3. Informationflow

4. Interface

Vorhandene Dokumentation

Technisch:

4.1. Direction Cargoclix to FINE

4.1.1. Header

This interface uses the Service Header

4.1.2. Datamodel

Property Type Description

(Root)

object

Despatch Advice Ramps

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

    spanId

string (uuid)

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

    eventTime*

string (date-time)

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

    version*

string

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

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

    context

string

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

    eventType*

string (enum)

The type of operation
Type of message

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

    metaData

object

        sender

string (enum)

system

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

    data*

object

        location*

string (enum)

warehouse locations

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

        businessEventDateTime

string (date-time)

timestamp of business event

        bookRampId*

integer

Id of the ramp

        rampName*

string

Name of the ramp

        rampType

string

Type of the ramp

        groupName

string

Ramp group name

        rampProcessStateCount*

integer

Number of available process states for a ramp

        defaultWeekFreeMinutes

integer

        active*

boolean

Is the ramp active

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

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

current version

1.0

Download

23.11.2023

final

previous version

coming version

2.21 - I02B Despatch Advice Ramp Process

Status

DRAFT → Dokumentation im Aufbau

Approval
Comment

FLASH nutzt bereits eine CargoClix-Schnittstelle produktiv. Die folgende Beschreibung bezieht sich auf ein neu zu entwickelndes Schnittstellenformat.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

InterfaceOwner

Producer

CargoClix

Consumer

FLASH

Consumer

Oyster

2. Business Context

current ramp data (opening hours, capacities)

3. Informationflow

4. Interface

Vorhandene Dokumentation

Technisch:

4.1. Direction Cargoclix to FINE

4.1.1. Header

This interface uses the Service Header

4.1.2. Datamodel

Property Type Description

(Root)

object

Despatch Advice Ramp Process

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

    spanId

string (uuid)

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

    eventTime*

string (date-time)

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

    version*

string

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

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

    context

string

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

    eventType*

string (enum)

The type of operation
Type of message

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

    metaData

object

        sender

string (enum)

system

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

    data*

object

        location*

string (enum)

warehouse locations

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

        businessEventDateTime*

string (date-time)

timestamp of business event

        bookRampId

integer

Id of the ramp

        arrivalSlotStartDateTime

string (date-time)

        dailyStartTime

string (time)

        dailyCloseTime

string (time)

        dailyOpenMinutes

integer

        dailyCapacityLimitMinutes

integer

        dailyCapacityLimitKolli

integer

        bookedMinutes

integer

        manuallyClosedMinutes

integer

        manuallyOpenMinutes

integer

        previous

object

            arrivalSlotStartDateTime

string (date-time)

            bookedMinutes

integer

            manuallyClosedMinutes

integer

            manuallyOpenMinutes

integer

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

Table 1. Version Cargoclix to FINE

Version

Number

File

Published on

Changes

current version

1.0

Download

18.02.2025

added attribute location

previous version

1.0

Download

09.01.2025

added attributes arrivalSlotStartDateTime and previous.arrivalSlotStartDateTime

previous version

1.0

02.04.2024

dailyStartTime, dailyCloseTime change from date-time to time

coming version

2.22 - I02C Despatch Advice Booking

Status

1.0 current version published 07.02.2025

Approval
Comment

FLASH nutzt bereits eine CargoClix-Schnittstelle produktiv. Die folgende Beschreibung bezieht sich auf ein neu zu entwickelndes Schnittstellenformat.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

Inbound

InterfaceOwner

Inbound

Producer

CargoClix

Consumer

FLASH

Consumer

Oyster

Consumer

Yard

Consumer

Babelfish

2. Business Context

CargoClix slot booking

3. Informationflow

flow

4. Interface

Vorhandene Dokumentation

Technisch:

4.1. Direction Cargoclix to FINE

4.1.1. Header

This interface uses the Service Header

4.1.2. Datamodel

Property Type Description

(Root)

object

Despatch Advice Bookings

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

    spanId

string (uuid)

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

    eventTime*

string (date-time)

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

    version*

string

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

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

    context

string

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

    eventType*

string (enum)

The type of operation
Type of message

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

    metaData

object

        sender

string (enum)

system

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

    data*

object

        bookId

integer

Id of the booking

        location*

string (enum)

warehouse locations

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

        businessEventDateTime

string (date-time)

timestamp of business event

        creator

object

            id

integer

Id of the booking creator

            companyId

integer

the creators company id

            companyName

string

the creators company name

        previous

object

            arrivalSlotStartDateTime

string (date-time)

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

            arrivalSlotEndDateTime

string (date-time)

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

            arrivalSlotLengthMinutes

integer

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

            bookRampId

integer

Id of previous ramp

        arrivalSlotStartDateTime

string (date-time)

slot start time
start time of the arrival time slot

        arrivalSlotCriticalStartDateTime

string (date-time)

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

        arrivalSlotEndDateTime

string (date-time)

slot end time
end time of the arrival time slot

        arrivalSlotLengthMinutes

integer

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

        bookRampId

integer

Id of the ramp

        bookingCompany

object

            id

integer

Id of the booking company

            name

string

the booking company name

        storageNotification

array

StorageNotifications

            (Array item)

object

                id

string

StorageNotificationId
StorageNotificationId

                quantity

integer

quantity

        orderNumber

array

order numbers

            (Array item)

string

        carrier

string

carrier

        productDescription

string

        itemNumber

array

item numbers

            (Array item)

string

        customerCompany

array

HF Customer from CargoClix

            (Array item)

string

        leavingEuroPallets

integer

        loadCarrier

array

            (Array item)

object

                id

string

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

                type

string (enum)

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

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

                sealNumber

string

seal number

        cancellationDescription

string

        comment

string

        deliveryMethodDescription

string

        processingInformation

array

            (Array item)

object

                goodsReceiptProcessingType

string

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

                quantity

integer

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

Minimum: 0
Maximum: 99999999999999

        delivery

array

            (Array item)

object

                type

string

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

                number

string

delivery number

        desiredDate

string

preferred delivery date by HG

        deviationAvisQuality

string

Avis quality

        deliveryNoteId

array

            (Array item)

string

delivery note uuid

        supplier

object

            name

string

supplier name

            code

string

supplier code

        numberOf

object

            colliLoose

integer

            colliPaletized

integer

            hunte

integer

            articles

integer

            colli

integer

            defectivePallets

integer

            onewayPallets

integer

            pallets

integer

        pager

object

            pagerNumber

string

pager number

            returned

boolean

pager returned by driver

        pagerNumber

string

pager number

        pagerReturn

boolean

pager returned by driver

        palleteNumber

string

        processingTimeMinCalculated

string

calculated timee for umloading in minutes

        ProductTypeSelect

string

Sortimentsauswahl

        shipName

string

ship name

        shipmentNumber

string

shipment number

        slaRelevance

boolean

        cancellationReason

string

        transportId

array

            (Array item)

string

transport uuid

        tourNumber

array

tour numbers

            (Array item)

string

        wayBillNumber

string

        driver

object

            name

string

driver name

            phone

string

driver phone

            language

string

driver language

        isDeleted

boolean

booking is deleted

        isCancelled

boolean

booking is cancelled

        licensePlate

object

            truck

string

truck license plate

            trailer

string

driver license plate

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

Table 1. Version Cargoclix to FINE

Version

Number

File

Published on

Changes

coming version

1.0

Download

07.02.2025

new attribute customerCompany

current version

1.0

15.09.2023

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

2.23 - I02D Despatch Advice Process State

Status

DRAFT → Dokumentation im Aufbau

Approval
Comment

FLASH nutzt bereits eine CargoClix-Schnittstelle produktiv. Die folgende Beschreibung bezieht sich auf ein neu zu entwickelndes Schnittstellenformat.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

InterfaceOwner

Producer

CargoClix

Consumer

FLASH

Consumer

Oyster

Consumer

Yard

2. Business Context

process status data for bookings

3. Informationflow

4. Interface

Vorhandene Dokumentation

Technisch:

4.1. Direction Cargoclix to FINE

4.1.1. Header

This interface uses the Service Header

4.1.2. Datamodel

Property Type Description

(Root)

object

Despatch Advice Process State

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

    spanId

string (uuid)

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

    eventTime*

string (date-time)

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

    version*

string

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

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

    context

string

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

    eventType*

string (enum)

The type of operation
Type of message

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

    metaData

object

        sender

string (enum)

system

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

    data*

object

        location*

string (enum)

warehouse locations

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

        bookId*

integer

Id of the booking

        businessEventDateTime*

string (date-time)

timestamp of business event

        processState*

object

            number*

integer

            name*

string

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

Table 1. Version Cargoclix to FINE

Version

Number

File

Published on

Changes

current version

1.0

Download

18.02.2025

added attribute location

previous version

1.0

Download

23.11.2023

final

previous version

coming version

2.24 - I03 Delivery Note

Status

Version 1.0 published 12.04.2022

Approval
  1. DeepSea:

  2. NEON: abgestimmt mit Körber zur Umsetzung in NEON_Fein_Pflichtenheft_WEN1_ SST_v6.0

Comment

Die Anbindung von MyToys ist in Planung und im Informationsflussdiagramm mit aufgenommen.

Assumption

FINE bindet sich direkt an SZ an für die ELS. Im ersten Schritt wird das Format in FINE auf einen Standard gemappt. Dieses wird an die LVS weitergeleitet.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

Inbound

InterfaceOwner

Producer

Oyster

Producer

OBS

MyToys

Consumer

FLASH

Consumer

kMotion

Consumer

KR1

Consumer

COBRA

2. Business Context

Die DeliveryNote beschreibt das Geschäftsobjekt, welches den elektronische Lieferschein enthält. Dabei gibt es Kopf- und Positionsdaten.

(elektronischer) Lieferschein - Begleitdokument für die bewegte Ware

3. Informationflow

flow

4. Interface

4.1. Direction ERP to FINE

4.1.1. Header

This service has no standard header

4.1.2. Datamodel

Services is devided in "LieferscheinKopf" und "LieferscheinPosition"

Servicedescription from ZS System: ZS_-LVS_KR1__COBRA-_Version_1.pdf

Table 1. Feldliste
Fieldname Description Required Format Example

4.1.3. Enumeration

4.1.4. Example

Message ERP to FINE
[
    {
    "id": "69571695-1814-4771-b097-6091f8b5d8e4",
    "lieferscheinNr": "347669",
    "statusLieferschein": "validated",
    "versandDatum": "2020-03-12",
    "anzahlKartonGesamt": 4,
    "erstellungDatum": "2020-03-13T17:35:37",
    "aenderungDatum": "2020-03-13T17:52:09",
    "lieferscheinPosition": [
    {
    "id": "162d18ce-c31b-45b7-a75d-3c2de5cb1303",
    "konzernArtikelNr": 25724443,
    "konzernArtikelGr": "M",
    "konzernArtikelGrBinaer": 905,
    "lieferMg": 42.0,
    "konzernLieferantNr": 40411,
    "konzernAuftragsNr": 12802,
    "nveNr": 340070601330298816,
    "erstellungDatum": "2020-03-13T17:35:37",
    "aenderungDatum": "2020-03-13T17:52:09",
    "statusLieferscheinPos": "validated",
    "ean": 192564537341,
    "originalArtNr": 22445566,
    "originalArtGr": "S",
    "originalOva": 12345,
    "abwicklungsArt": "_",
    "ovaValInfo": 1
    },
    {
    "id": "46f07280-bd76-4582-bc18-a287b0de6f89",
    "konzernArtikelNr": 25724443,
    "konzernArtikelGr": "L",
    "konzernArtikelGrBinaer": 906,
    "lieferMg": 42.0,
    "konzernLieferantNr": 40411,
    "konzernAuftragsNr": 12802,
    "nveNr": 340070601330484821,
    "erstellungDatum": "2020-03-13T17:35:37",
    "aenderungDatum": "2020-03-13T17:52:09",
    "statusLieferscheinPos": "validated",
    "ean": 192564537372,
    "originalArtNr": 22445566,
    "originalArtGr": "S",
    "originalOva": 12345,
    "abwicklungsArt": "_",
    "ovaValInfo": 1
    },
    {
    "id": "5870c4e7-73d5-44f8-9641-b663c070d2f5",
    "konzernArtikelNr": 25724443,
    "konzernArtikelGr": "S",
    "konzernArtikelGrBinaer": 904,
    "lieferMg": 42.0,
    "konzernLieferantNr": 40411,
    "konzernAuftragsNr": 12802,
    "nveNr": 340070601330495369,
    "erstellungDatum": "2020-03-13T17:35:37",
    "aenderungDatum": "2020-03-13T17:52:09",
    "statusLieferscheinPos": "validated",
    "ean": 192564537266,
    "originalArtNr": 22445566,
    "originalArtGr": "S",
    "originalOva": 12345,
    "abwicklungsArt": "_",
    "ovaValInfo": 1
    },
    {
    "id": "b6daf4eb-ccb9-4069-a857-c93fd0f1f779",
    "konzernArtikelNr": 25724443,
    "konzernArtikelGr": "XL",
    "konzernArtikelGrBinaer": 907,
    "lieferMg": 42.0,
    "konzernLieferantNr": 40411,
    "konzernAuftragsNr": 12802,
    "nveNr": 340070601330165278,
    "erstellungDatum": "2020-03-13T17:35:37",
    "aenderungDatum": "2020-03-13T17:52:09",
    "statusLieferscheinPos": "validated",
    "ean": 192564537242,
    "originalArtNr": 22445566,
    "originalArtGr": "S",
    "originalOva": 12345,
    "abwicklungsArt": "_",
    "ovaValInfo": 1
    }
    ]
    },
    {
    "id": "856efcba-74ea-11ea-9851-0242ac110002",
    "lieferscheinNr": "347670",
    "statusLieferschein": "failed",
    "versandDatum": "2020-03-12",
    "anzahlKartonGesamt": 4,
    "erstellungDatum": "2020-03-13T17:35:37",
    "aenderungDatum": "2020-03-13T17:52:09",
    "lieferscheinPosition": [
    {
    "id": "162d18ce-c31b-45b7-a75d-3c2de5cb1301",
    "konzernArtikelNr": 25724443,
    "konzernArtikelGr": "M",
    "konzernArtikelGrBinaer": 905,
    "lieferMg": 42.0,
    "konzernLieferantNr": 40411,
    "konzernAuftragsNr": 12802,
    "nveNr": 340070601330298816,
    "erstellungDatum": "2020-03-13T17:35:37",
    "aenderungDatum": "2020-03-13T17:52:09",
    "statusLieferscheinPos": "failed",
    "ean": 192564537341,
    "abwicklungsArt": "_",
    "ovaValInfo": 1
    },
    {
    "id": "46f07280-bd76-4582-bc18-a287b0de6f82",
    "konzernArtikelNr": 25724443,
    "konzernArtikelGr": "L",
    "konzernArtikelGrBinaer": 906,
    "lieferMg": 42.0,
    "konzernLieferantNr": 40411,
    "konzernAuftragsNr": 12802,
    "nveNr": 340070601330484821,
    "erstellungDatum": "2020-03-13T17:35:37",
    "aenderungDatum": "2020-03-13T17:52:09",
    "statusLieferscheinPos": "failed",
    "ean": 192564537372,
    "abwicklungsArt": "_",
    "ovaValInfo": 1
    },
    {
    "id": "5870c4e7-73d5-44f8-9641-b663c070d2f3",
    "konzernArtikelNr": 25724443,
    "konzernArtikelGr": "S",
    "konzernArtikelGrBinaer": 904,
    "lieferMg": 42.0,
    "konzernLieferantNr": 40411,
    "konzernAuftragsNr": 12802,
    "nveNr": 340070601330495369,
    "erstellungDatum": "2020-03-13T17:35:37",
    "aenderungDatum": "2020-03-13T17:52:09",
    "statusLieferscheinPos": "failed",
    "ean": 192564537266,
    "abwicklungsArt": "_",
    "ovaValInfo": 1
    },
    {
    "id": "b6daf4eb-ccb9-4069-a857-c93fd0f1f774",
    "konzernArtikelNr": 25724443,
    "konzernArtikelGr": "XL",
    "konzernArtikelGrBinaer": 907,
    "lieferMg": 42.0,
    "konzernLieferantNr": 40411,
    "konzernAuftragsNr": 12802,
    "nveNr": 340070601330165278,
    "erstellungDatum": "2020-03-13T17:35:37",
    "aenderungDatum": "2020-03-13T17:52:09",
    "statusLieferscheinPos": "failed",
    "ean": 192564537242,
    "abwicklungsArt": "_",
    "ovaValInfo": 1
    }
    ]
    }
    ]

4.1.5. Schema

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

current version

previous version

coming version

4.2. Direction FINE to WMS

4.2.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 3. Attribute
Fieldname Expresion

context

DELIVERY_NOTE

type

CREATE

UPDATE

STORNO

4.2.2. Datamodel

Property Type Description

(Root)

object

DeliveryNote

    eventId*

string (uuid)

UUID for this event
JAVA UUID4 for this event (the booking), use pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    traceId*

string (uuid)

UUID for all events in a call hierarchy
UUID for all events in a call hierarchy.

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    spanId*

string (uuid)

UUID for all events in a call hierarchy
UUID for all events in a call hierarchy. If a new event is emitted, the eventId of the causing event is set as SpanId

Minimum Length: 36
Maximum Length: 36
Regular expression: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    eventTime*

string (date-time)

the date and time, when this event occured as an ISO-8601 timestamp.
the date and time, when this event occured as an ISO-8601 timestamp.

    version*

string

Json schema version
JSON schema version

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

    context*

string

The name of the responsible context
The name of the repsonsible context. Normally the context, which emits this event. tbd

Maximum Length: 20

    type*

string

the event type that triggers this event
the event type that triggers this event

Maximum Length: 20

    sender*

string

The sending system
The sending system

Maximum Length: 20

    sourceIdentifier*

string

SourceIdentifier
End 2 End producer (original producer)

    data*

object

        deliveryNoteId*

string

deliveryNoteId
delivery Note Id

Maximum Length: 36

        deliveryNoteNumber*

string

Die Belegnummer des Lieferscheins
deliveryNoteNumber

Maximum Length: 36

        deliveryNoteStatus*

string

deliveryNoteStatus
Interner Status des Lieferscheins - Möglich ist der Status 'validated' und 'deleted'. Wenn ein LS den Status 'deleted' hat, dann gibt es für diesen Lieferschein ein Update(neuer LS).

Maximum Length: 10

        location*

string

Electronic delivery Location
Electronic delivery location, List of allowed values will be defined and documented #url

        createDate*

string (date-time)

createDate
Create-Timestamp

        modifyDate*

string (date-time)

modifyDate
Update-Timestamp

        shippingDate*

string (date-time)

shippingDate
Datum des Versandes beim Lieferanten

        plannedDeliveryDate

string (date-time)

plannedDeliveryDate
Zum Zeitpunkt der Übertragung geplantes Anlieferdatum am Lager (zunächst frühestes mögliches Lieferdatum von HG, sobald in CargoLogic-web verfügbar: geplantes Anlieferdatum vom Lager)

        totalCartonQty*

integer

totalCartonQty
the loading unit differs for each retailer, the quantity is determined by the items and quantity

Maximum Length: 4

        collectionAddress

string

collectionAddress
Adresse, von der die Ware vom Nachlaufspediteur abgeholt wird (häufig Hamburger Containerterminals), Zusatzinfo, kann gekürzt sein aufgrund maximaler Feldlänge

Maximum Length: 35

        package

object

            weight

object

weight
weight

                value*

number

                unit*

string

            volume

object

volume
volume

                value*

number

                unit*

string

        carrierForwarding

string

carrierForwarding
Spediteur, der den Nachlauf physisch durchführt und ans Lager fährt

Maximum Length: 35

        positions*

array

Positions
Positions

Minimum number of items 1

            (Array item)

object

                deliveryNotePositionId*

string

deliveryNotePositionId
Alle Positionen zum Lieferschein

Maximum Length: 36

                deliveryNotePositionStatus*

string

deliveryNotePositionStatus
Interner Status des Lieferscheins - Möglich ist der Status 'validated' und 'deleted'. Wenn ein LS den Status 'deleted' hat, dann gibt es für diesen Lieferschein ein Update(neuer LS).

Maximum Length: 10

                createDate*

string (date-time)

createDate
create Date

                modifyDate*

string (date-time)

modifyDate
modify Date

                product*

object

                    logisticProductId*

integer

logisticProductId
master communication key

Maximum: 1000000000000000000

                    itemNumber*

integer

ItemNumber
the item number

Maximum Length: 16

                    itemSize*

string

ItemSize
the item size

Maximum Length: 16

                    itemSizeBin*

integer

ItemSizeBin
item Size Bin

                quantity*

number

quantity
quantity

                supplierNumber*

integer

supplierNumber
the number of supplier

Maximum Length: 6
Maximum: 999999

                purchaseOrderNumber*

integer

purchaseOrderNumber
Auftragsnummer

Maximum Length: 6

                shippingUnitNumber

integer

shippingUnitNumber
Nummer der Versandeinheit (des Paketes)

Maximum Length: 18
Maximum: 1000000000000000000

                containerType

string

containerType
Entweder WAB oder Containernummer, wenn ein Seefracht-Container „direkt“ gefahren wird.

Maximum Length: 70

                containerNumber

string

containerNumber
containerNumber

                hermesTMPPosNr

string

hermesTMPPosNr
(um erste vier, hier nicht relevante gekürzte) Positionsnummer des Transport Management Systems der HG, wird bei Seefrachten als Zugangsnummer ans Lager übermittelt

Maximum Length: 70

                customsProcedure

string

customsProcedure
ZL = Zolllagerware; FV = Bereits vollständig verzollt (Freier Verkehr)

Maximum Length: 70

                hAwbBl

string

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

Maximum Length: 70

                deliveryTypeCode*

string

deliveryTypeCode
Dient zur Ermittlung der Abwicklungsart (OTTO Market / Whole Sale)

Maximum Length: 1

                ovaValInfo

integer

ovaValInfo
Info darüber ob die OVA Nr währen der Validierung angepasst wurde oder nicht.

Maximum Length: 1

                additionalInformation

object

                    originalItemNumber

integer

originalItemNumber
Ursprüngliche Artikel Nr der Postion. Wird immer ausgegeben wenn für die Postion eine Korrektur vorgenommen wurde, d.h. das der Orginalwert des Lieferscheins während der Validierung verändert wurde.

Maximum Length: 8

                    originalItemSize

string

originalItemSize
Ursprüngliche Artikel Gr der Postion. Wird immer ausgegeben wenn für die Postion eine Korrektur vorgenommen wurde, d.h. das der Orginalwert des Lieferscheins während der Validierung verändert wurde.

Maximum Length: 7

                    ean

integer

ean
EAN der Artikelgröße

Maximum Length: 13
Maximum: 1000000000000000000

                    originalOva

integer

originalOva
Ursprüngliche Auftrags Nr der Postion. Wird immer ausgegeben wenn für die Postion eine Korrektur vorgenommen wurde, d.h. das der Orginalwert des Lieferscheins während der Validierung verändert wurde.

Maximum Length: 6

                    errorCode

string

errorCode
Bei Fehlerhafter Postion wird ein FehlerCode mit übergeben.

                    errorMessage

string

errorMessage
Beschreibung des ErrorCodes

4.2.3. Enumeration

Field: deliveryTypeCode

Table 4. deliveryTypeCode
Meta Value Description Short Value

OTTO_MARKET

O

WHOLE_SALE

WHLS

WHOLE_SALE_LIGHT

_

Field: ovaValidationInfo

Table 5. ovaValidationInfo
Meta Value Description Short Value

ORGINAL

Orginal

1

MODIFED

Modifed at Validation

2

4.2.4. Example

Message FINE to WMS
{
  "eventId": "00ce536f-923a-42f4-8128-be118faf1d87",
  "traceId": "00ce536f-923a-42f4-8128-be118faf1d85",
  "spanId": "null",
  "eventTime": "2022-03-31T12:41:06.036+0200",
  "version": "1.0",
  "context": "TRANSFER_ELS",
  "type": "CREATE",
  "sender": "ZS",
  "sourceIdentifier": "FINE-ELS",
  "data": {
    "deliveryNoteId": "69571695-1814-4771-b097-6091f8b5d8e4",
    "deliveryNoteNumber": "347669",
    "deliveryNoteStatus": "validated",
    "location": "LOEHNE",
    "createDate": "2022-03-31T12:41:06.036+0200",
    "modifyDate": "2022-03-31T12:41:06.036+0200",
    "shippingDate": "2022-03-31T12:41:06.036+0200",
    "plannedDeliveryDate": "2022-03-31T00:00:00.000+0200",
    "totalCartonQty": 4,
    "collectionAddress": "Dradenauer Deichweg 5, Hamburg",
    "package": {
      "weight": {
        "value": 2583,
        "unit": "kg"
      },
      "volume": {
        "value": 13.312,
        "unit": "m3"
      }
    },
    "carrierForwarding": "Unisped Logistik GmbH",
    "positions": [
      {
        "deliveryNotePositionId": "162d18ce-c31b-45b7-a75d-3c2de5cb1303",
        "deliveryNotePositionStatus": "validated",
        "createDate": "2022-03-31T12:41:06.036+0200",
        "modifyDate": "2022-03-31T12:41:06.036+0200",
        "product": {
          "logisticProductId": 1234567895241478,
          "itemNumber": 25724443,
          "itemSize": "M",
          "itemSizeBin": 905
        },
        "quantity": 42.0,
        "supplierNumber": 40411,
        "purchaseOrderNumber": 12802,
        "shippingUnitNumber": 340070601330298816,
        "containerType": "WAB",
        "containerNumber": "415396",
        "hermesTMPPosNr": "H119080851",
        "customsProcedure": "ZL",
        "hAwbBl": "SL30094406",
        "deliveryTypeCode": "_",
        "ovaValInfo": 1,
        "additionalInformation": {
          "originalItemNumber": 22445566,
          "originalItemSize": "S",
          "ean": 192564537341,
          "originalOva": 12345,
          "errorCode": "x",
          "errorMessage": "x"
        }
      }
    ]
  }
}

4.2.5. Schema

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

current version

1.0

Download

12.04.2022

previous version

coming version

Interface FINE to WMS
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "DeliveryNote",
  "type": "object",
  "properties": {
    "eventId": {
      "description": "JAVA UUID4 for this event (the booking), use pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' ",
      "type": "string",
      "format": "uuid",
      "minLength": 36,
      "maxLength": 36,
      "title": "UUID for this event",
      "examples":["00ce536f-923a-42f4-8128-be118faf1d87"],
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
    },
    "traceId": {
      "description": "UUID for all events in a call hierarchy. ",
      "type": "string",
      "format": "uuid",
      "minLength": 36,
      "maxLength": 36,
      "title": "UUID for all events in a call hierarchy",
      "examples":["00ce536f-923a-42f4-8128-be118faf1d87"],
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
    },
    "spanId": {
      "description": "UUID for all events in a call hierarchy. If a new event is emitted, the eventId of the causing event is set as SpanId",
      "type": "string",
      "format": "uuid",
      "minLength": 36,
      "maxLength": 36,
      "title": "UUID for all events in a call hierarchy",
      "examples":["00ce536f-923a-42f4-8128-be118faf1d87"],
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
    },
    "eventTime": {
      "description": "the date and time, when this event occured as an ISO-8601 timestamp.",
      "type": "string",
      "format": "date-time",
      "title": "the date and time, when this event occured as an ISO-8601 timestamp.",
      "examples":["2022-03-31T12:41:06.036+0200"]
    },
    "version": {
      "description": "JSON schema version",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 4,
      "title": "Json schema version",
      "examples":["1.0","1.11","1.1"]
    },
    "context": {
      "description": "The name of the repsonsible context. Normally the context, which emits this event. tbd",
      "type": "string",
      "maxLength": 20,
      "title": "The name of the responsible context",
      "examples":["TRANSFER_ELS"]
    },
    "type": {
      "description": "the event type that triggers this event",
      "type": "string",
      "maxLength": 20,
      "title": "the event type that triggers this event",
      "examples":["CREATE","UPDATE"]
    },
    "sender": {
      "description": "The sending system",
      "type": "string",
      "maxLength": 20,
      "title": "The sending system",
      "examples":["KR1_SUEDHAFEN", "KR1_HALDENSLEBEN", "WMSX_SONNEFELD", "WMSX_ILOWA", "WMSX_GERNSHEIM", "COBRA", "MYTOYS", "DEEPSEA", "INBOUND"]
    },
    "sourceIdentifier": {
      "description": "End 2 End producer (original producer)",
      "type": "string",
      "title": "SourceIdentifier",
      "examples":["FINE-ELS"]
    },
    "data": {
      "type": "object",
      "properties": {
        "deliveryNoteId": {
          "type": "string",
          "title": "deliveryNoteId",
          "maxLength": 36,
          "description":"delivery Note Id",
          "examples": [ "69571695-1814-4771-b097-6091f8b5d8e4"]
        },
        "deliveryNoteNumber": {
          "type": "string",
          "title": "Die Belegnummer des Lieferscheins",
          "maxLength": 36,
          "description":"deliveryNoteNumber",
          "examples": ["347669"]
        },
        "deliveryNoteStatus": {
          "type": "string",
          "title": "deliveryNoteStatus",
          "maxLength": 10,
          "description": "Interner Status des Lieferscheins - Möglich ist der Status 'validated' und 'deleted'. Wenn ein LS den Status 'deleted' hat, dann gibt es für diesen Lieferschein ein Update(neuer LS).",
          "examples": ["validated"]
        },
        "location": {
          "description": "Electronic delivery location, List of allowed values will be defined and documented #url",
          "type": "string",
          "title": "Electronic delivery Location",
          "example": ["LOEHNE"]
        },
        "createDate": {
          "type": "string",
          "format": "date-time",
          "title": "createDate",
          "description": "Create-Timestamp",
          "examples": ["2022-03-31T12:41:06.036+0200"]
        },
        "modifyDate": {
          "type": "string",
          "format": "date-time",
          "description": "Update-Timestamp",
          "title": "modifyDate",
          "examples": ["2022-03-31T12:41:06.036+0200"]
        },
        "shippingDate": {
          "description": "Datum des Versandes beim Lieferanten",
          "type": "string",
          "format": "date-time",
          "title": "shippingDate",
          "examples": ["2022-03-31T12:41:06.036+0200"]
        },
        "plannedDeliveryDate": {
          "description": "Zum Zeitpunkt der Übertragung geplantes Anlieferdatum am Lager (zunächst frühestes mögliches Lieferdatum von HG, sobald in CargoLogic-web verfügbar: geplantes Anlieferdatum vom Lager)",
          "type": "string",
          "format": "date-time",
          "title": "plannedDeliveryDate",
          "examples": ["2022-03-31T12:41:06.036+0200"]
        },
        "totalCartonQty": {
          "description": "the loading unit differs for each retailer, the quantity is determined by the items and quantity",
          "type": "integer",
          "maxLength": 4,
          "title": "totalCartonQty",
          "examples": [4]
        },
        "collectionAddress": {
          "type": "string",
          "description": "Adresse, von der die Ware vom Nachlaufspediteur abgeholt wird (häufig Hamburger Containerterminals), Zusatzinfo, kann gekürzt sein aufgrund maximaler Feldlänge",
          "title": "collectionAddress",
          "maxLength": 35,
          "examples": ["Dradenauer Deichweg 5, Hamburg"]
        },
        "package": {
          "type": "object",
          "properties": {
            "weight": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "number",
                  "examples": [2583]
                },
                "unit": {
                  "type": "string",
                  "examples": ["kg"]
                }
              },
              "required": [
                "value",
                "unit"
              ],
              "title": "weight",
              "description": "weight"
            },
            "volume": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "number"
                },
                "unit": {
                  "type": "string"
                }
              },
              "title": "volume",
              "description": "volume",
              "required": [
                "value",
                "unit"
              ]
            }
          }
        },
        "carrierForwarding": {
          "type": "string",
          "maxLength": 35,
          "description": "Spediteur, der den Nachlauf physisch durchführt und ans Lager fährt",
          "title": "carrierForwarding",
          "examples": ["Unisped Logistik GmbH"]
        },
        "positions": {
          "description": "Positions",
          "title": "Positions",
          "minItems": 1,
          "type": "array",
          "items": {
            "$ref": "#/$defs/ElsPosition"
          }
        }
      },
      "required": [
        "deliveryNoteId",
        "deliveryNoteNumber",
        "deliveryNoteStatus",
        "createDate",
        "modifyDate",
        "location",
        "shippingDate",
        "totalCartonQty",
        "positions"
      ]
    }
  },
  "required": [
    "eventId",
    "traceId",
    "spanId",
    "eventTime",
    "version",
    "context",
    "type",
    "sender",
    "data",
    "sourceIdentifier"
  ],
  "$defs": {
    "ElsPosition": {
      "type": "object",
      "properties": {
        "deliveryNotePositionId": {
          "type": "string",
          "maxLength": 36,
          "description": "Alle Positionen zum Lieferschein",
          "title": "deliveryNotePositionId",
          "examples": ["162d18ce-c31b-45b7-a75d-3c2de5cb1303"]
        },
        "deliveryNotePositionStatus": {
          "type": "string",
          "maxLength": 10,
          "description": "Interner Status des Lieferscheins - Möglich ist der Status 'validated' und 'deleted'. Wenn ein LS den Status 'deleted' hat, dann gibt es für diesen Lieferschein ein Update(neuer LS).",
          "title": "deliveryNotePositionStatus",
          "examples": ["validated"]
        },
        "createDate": {
          "type": "string",
          "format": "date-time",
          "description": "create Date",
          "title": "createDate",
          "examples": ["2022-03-31T12:41:06.036+0200"]
        },
        "modifyDate": {
          "type": "string",
          "format": "date-time",
          "description": "modify Date",
          "title": "modifyDate",
          "examples": ["2022-03-31T12:41:06.036+0200"]
        },
        "product": {
          "type": "object",
          "properties": {
            "logisticProductId": {
              "type": "integer",
              "maximum": 999999999999999999,
              "description": "master communication key",
              "title": "logisticProductId",
              "examples": [1234567895241478]
            },
            "itemNumber": {
              "type": "integer",
              "maxLength": 16,
              "description": "the item number",
              "title": "ItemNumber",
              "examples": [25724443]
            },
            "itemSize": {
              "description": "the item size ",
              "type": "string",
              "maxLength": 16,
              "title": "ItemSize",
              "examples":["M"]
            },
            "itemSizeBin": {
              "type": "integer",
              "description": "item Size Bin",
              "title": "ItemSizeBin",
              "examples": [905]
            }
          },
          "required": [
            "logisticProductId",
            "itemNumber",
            "itemSize",
            "itemSizeBin"
          ]
        },
        "quantity": {
          "type": "number",
          "description": "quantity",
          "title": "quantity",
          "examples": [42.0]
        },
        "supplierNumber": {
          "type": "integer",
          "maximum": 999999,
          "maxLength": 6,
          "description": "the number of supplier",
          "title": "supplierNumber",
          "examples": [40411]
        },
        "purchaseOrderNumber": {
          "type": "integer",
          "maxLength": 6,
          "description": "Auftragsnummer",
          "title": "purchaseOrderNumber",
          "examples": [12802]
        },
        "shippingUnitNumber": {
          "type": "integer",
          "maxLength": 18,
          "maximum": 999999999999999999,
          "description": "Nummer der Versandeinheit (des Paketes)",
          "title": "shippingUnitNumber",
          "examples": [340070601330298816]
        },
        "containerType": {
          "type": "string",
          "maxLength": 70,
          "description": "Entweder WAB oder Containernummer, wenn ein Seefracht-Container „direkt“ gefahren wird.",
          "title": "containerType",
          "examples": ["WAB"]
        },
        "containerNumber": {
          "type": "string",
          "description": "containerNumber",
          "title": "containerNumber",
          "examples": ["415396"]
        },
        "hermesTMPPosNr": {
          "type": "string",
          "maxLength": 70,
          "description": "(um erste vier, hier nicht relevante gekürzte) Positionsnummer des Transport Management Systems der HG, wird bei Seefrachten als Zugangsnummer ans Lager übermittelt",
          "title": "hermesTMPPosNr",
          "examples": ["H119080851"]
        },
        "customsProcedure": {
          "type": "string",
          "maxLength": 70,
          "description": "ZL = Zolllagerware; FV = Bereits vollständig verzollt (Freier Verkehr)",
          "title": "customsProcedure",
          "examples": ["ZL"]
        },
        "hAwbBl": {
          "type": "string",
          "description": "House B/L oder HAWB-Nummer. (Bei Luftfrachten werden derzeit die HAWB-Nummern als Zugangsnummer erfasst. Mittelfristig soll die",
          "maxLength": 70,
          "title": "hAwbBl",
          "examples": ["SL30094406"]
        },
        "deliveryTypeCode": {
          "type": "string",
          "maxLength": 1,
          "description": "Dient zur Ermittlung der Abwicklungsart (OTTO Market / Whole Sale)",
          "title": "deliveryTypeCode",
          "examples": ["_"]
        },
        "ovaValInfo": {
          "type": "integer",
          "maxLength": 1,
          "description": "Info darüber ob die OVA Nr währen der Validierung angepasst wurde oder nicht.",
          "title": "ovaValInfo",
          "examples": [1]
        },
        "additionalInformation": {
          "type": "object",
          "properties": {
            "originalItemNumber": {
              "type": "integer",
              "maxLength": 8,
              "description": "Ursprüngliche Artikel Nr der Postion. Wird immer ausgegeben wenn für die Postion eine Korrektur vorgenommen wurde, d.h. das der Orginalwert des Lieferscheins während der Validierung verändert wurde.",
              "title": "originalItemNumber",
              "examples": [22445566]
            },
            "originalItemSize": {
              "type": "string",
              "maxLength": 7,
              "description": "Ursprüngliche Artikel Gr der Postion. Wird immer ausgegeben wenn für die Postion eine Korrektur vorgenommen wurde, d.h. das der Orginalwert des Lieferscheins während der Validierung verändert wurde.",
              "title": "originalItemSize",
              "examples": ["S"]
            },
            "ean": {
              "type": "integer",
              "maxLength": 13,
              "maximum": 999999999999999999,
              "description": "EAN der Artikelgröße",
              "title": "ean",
              "examples": [192564537341]
            },
            "originalOva": {
              "type": "integer",
              "maxLength": 6,
              "description": "Ursprüngliche Auftrags Nr der Postion. Wird immer ausgegeben wenn für die Postion eine Korrektur vorgenommen wurde, d.h. das der Orginalwert des Lieferscheins während der Validierung verändert wurde.",
              "title": "originalOva",
              "examples": [12345]
            },
            "errorCode": {
              "type": "string",
              "description": "Bei Fehlerhafter Postion wird ein FehlerCode mit übergeben.",
              "title": "errorCode",
              "examples": ["x"]
            },
            "errorMessage": {
              "type": "string",
              "description": "Beschreibung des ErrorCodes",
              "title": "errorMessage",
              "examples": ["x"]
            }
          }
        }
      },
      "required": [
        "deliveryNotePositionId",
        "deliveryNotePositionStatus",
        "createDate",
        "modifyDate",
        "product",
        "quantity",
        "supplierNumber",
        "purchaseOrderNumber",
        "deliveryTypeCode"
      ]
    }
  },
  "examples": [
    {
      "eventId": "00ce536f-923a-42f4-8128-be118faf1d87",
      "traceId": "00ce536f-923a-42f4-8128-be118faf1d85",
      "spanId": "null",
      "eventTime": "2022-03-31T12:41:06.036+0200",
      "version": "1.0",
      "context": "TRANSFER_ELS",
      "type": "CREATE",
      "sender": "ZS",
      "sourceIdentifier": "FINE-ELS",
      "data": {
        "deliveryNoteId": "69571695-1814-4771-b097-6091f8b5d8e4",
        "deliveryNoteNumber": "347669",
        "deliveryNoteStatus": "validated",
        "location": "LOEHNE",
        "createDate": "2022-03-31T12:41:06.036+0200",
        "modifyDate": "2022-03-31T12:41:06.036+0200",
        "shippingDate": "2022-03-31T12:41:06.036+0200",
        "plannedDeliveryDate": "2022-03-31T00:00:00.000+0200",
        "totalCartonQty": 4,
        "collectionAddress": "Dradenauer Deichweg 5, Hamburg",
        "package": {
          "weight": {
            "value": 2583,
            "unit": "kg"
          },
          "volume": {
            "value": 13.312,
            "unit": "m3"
          }
        },
        "carrierForwarding": "Unisped Logistik GmbH",
        "positions": [
          {
            "deliveryNotePositionId": "162d18ce-c31b-45b7-a75d-3c2de5cb1303",
            "deliveryNotePositionStatus": "validated",
            "createDate": "2022-03-31T12:41:06.036+0200",
            "modifyDate": "2022-03-31T12:41:06.036+0200",
            "product": {
              "logisticProductId": 1234567895241478,
              "itemNumber": 25724443,
              "itemSize": "M",
              "itemSizeBin": 905
            },
            "quantity": 42.0,
            "supplierNumber": 40411,
            "purchaseOrderNumber": 12802,
            "shippingUnitNumber": 340070601330298816,
            "containerType": "WAB",
            "containerNumber": "415396",
            "hermesTMPPosNr": "H119080851",
            "customsProcedure": "ZL",
            "hAwbBl": "SL30094406",
            "deliveryTypeCode": "_",
            "ovaValInfo": 1,
            "additionalInformation": {
              "originalItemNumber": 22445566,
              "originalItemSize": "S",
              "ean": 192564537341,
              "originalOva": 12345,
              "errorCode": "x",
              "errorMessage": "x"
            }
          }
        ]
      }
    }
  ]
}

2.25 - I04 Goods In

Status

2.2 current version published 10.10.2024

Approval
  1. DeepSea: approved

  2. FLASH: approved

  3. F2X: approved

  4. NEON: approved

  5. KR1: approved

  6. COBRA: approved

  7. WITT: approved

Comment
Assumption

.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

Inbound

InterfaceOwner

Producer

kMotion

Producer

KR1

Producer

COBRA

Consumer

F2X

Consumer

Oyster

Consumer

FLASH

Consumer

WITT

2. Business Context

Die Wareneingänge beschreiben den Belegfluss des Wareneingangs und beinhalten Informationen zum Abgleich zwischen Lieferschein- und Kollierfassung, Lieferscheinmengen, Tournummern, Bestellungen, Lieferanten, Qualitätssicherung usw.

Für die einzelnen Prozessevents werden Messages versendet:

  • Ende Lieferscheinerfassung (WE1) → DELIVERY_NOTE_REGISTRATION_END

  • Start Warenvereinnahmung → keine Positionen gefüllt → GOODSRECEIPT_START

  • Ende Warenvereinnahmung (WE1.2) → GOODSRECEIPT_END

  • Start Differenzenabgleich → DELIVERY_COMPARISON_START

  • Ende Differenzenabgleich (WE1.5) → DELIVERY_COMPARISON_END

  • Warenfreischaltung (WE2) → RELEASE_END

Bei den Start-Events sollen nur Kopfdaten übermittelt werden, bei den End-Events sollen auch die Positionen übermittelt werden.

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

DELIVERY_NOTE_REGISTRATION_END

GOODSRECEIPT_START

GOODSRECEIPT_END

DELIVERY_COMPARISON_START

DELIVERY_COMPARISON_END

RELEASE_END

context

GOODS_IN

4.1.2. Datamodel

Property Type Description

(Root)

object

WMS goods receipt messages
This document describes the goods receipt messages that FINE receives from warehouse systems.

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

    spanId*

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format with timezone in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

    version*

string

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

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

    context*

string (enum)

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

Any of: [ "GOODS_IN" ]

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "DELIVERY_NOTE_REGISTRATION_END", "GOODSRECEIPT_START", "GOODSRECEIPT_END", "DELIVERY_COMPARISON_START", "DELIVERY_COMPARISON_END", "RELEASE_END" ]

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

        client

string

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​). List of values: https://docs.osp-fine.de/page/fine-common/00_meta_data/me02_global_enumerations/me02_global_enumerations/#_enum_company

        instance

string

Software instance of producing system
Name of the source instance that generated this data. Used for example to distinguish between different Test Instances.

    data*

object

Additional Properties: false

        location*

string (enum)

The sending warehouse
The sending warehouse (cobra sends data for different warehouses), List of allowed values will be defined and documented #url

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

        businessEventTime*

string (date-time)

The date and time, when the business event occurred
the date and time, when the business event occurred, in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

        goodsInId*

string

the goods receipt ID
the goods receipt technical key, generated by the wms. (Possible UUID but other identifier accepted)

Maximum Length: 36

        originalGoodsInId

string

the original goods receipt ID
the goods receipt technical key, generated by the wms. This ID is referencing the original Delivery (technical key) in case when goods arrive back from rework

Maximum Length: 36

        deliveryNumber*

string

the inbound delivery business key
the inbound delivery business key, generated by the wms

Maximum Length: 36

        deliveryTypeCode

string

Identification of the type of entry/delivery
Identification of the type of entry/delivery type {manual, automatic entry, DLW, return, transfer, WE from post-processing, WE without goods, etc.} Only the known forms of the WMS are delivered.

Maximum Length: 50

        deliveryType*

string (enum)

Type of the delivery
the type of the delivery (from supplier, DLW, returns, postprocessing, without goods…​)

Any of: [ "GOODSIN_SUPPLIER", "GOODSIN_FROM_REWORK", "GOODSIN_FOR_BOOKING_AND_RELEASE", "GOODSIN_FOR_REMOVAL", "GOODSIN_INCOMPLETE", "GOODSIN_DLW", "GOODSIN_FOR_RELEASE", "GOODSIN_POST_PROCESSING", "GOODSIN_FROM_MAPPER", "GOODSIN_SECOND_CHOICE", "GOODSIN_STATIONARY_TRADE", "GOODSIN_SMALLPARTS", "GOODSIN_CANCELATION", "GOODSIN_RELABEL", "GOODSIN_B2B", "GOODSIN_FROM_RETAIL", "GOODSIN_3RD_PARTY" ]

        carrier

string

name of the carrier transporting goods
name of the carrier transporting goods

Maximum Length: 100

        gates

array

            (Array item)

object

                door

string

Gate or Door number
The gate, door no where the truck arrives

Maximum Length: 10

                building

string

Building
The building where the truck arrives

Maximum Length: 3

        processingInformation

array

            (Array item)

object

Additional Properties: false

                goodsReceiptProcessingType*

string (enum)

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

Any of: [ "PALLETED_SORTED", "PALLETED_UNSORTED", "CARTONS_SORTED", "CARTONS_UNSORTED", "SANDWICH_PALLET", "PULK_2MH", "DLW", "ITEMS_UNSORTED", "ITEMS_UNSORTED_FROM_KEP", "CARTONS_UNSORTED_FROM_KEP", "NON_TRADE_ITEMS" ]

                goodsReceiptProcessingCode*

string

Pallet/hatch detection code
Differentiation according to pallet/hatch detection, or in the case of Cobra: differentiation according to palletized/loose, loose, DLW, etc. WMS internal codes are transferred in this attribute

                quantity

integer

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

Minimum: 0
Maximum: 99999999999999

        positions

array

            (Array item)

object

Additional Properties: false

                deliveryPositionId*

string

Position Id
Unique ID of the position. Can be a number from a sequence, a UUID or a combination of GoodsInId + PositionNumber

Maximum Length: 36

                deliveryPositionNumber

integer

Position number
position number - incremental number (identifier) of the delivery position

Maximum: 99999999999999

                quantity*

integer

Quantity received
the received quantity for this item size according to the delivery note

Minimum: 0
Maximum: 99999999999999

                arrivedToReworkerQuantity

integer

Quantity received by the external reworker
the received quantity by the external reworker for this item size according to the delivery note

Minimum: 0
Maximum: 99999999999999

                destroyedByReworkerQuantity

integer

Quantity destroyed by the external reworker
the destroyed quantity for this item size by the external reworker

Minimum: 0
Maximum: 99999999999999

                loadingUnitQuantity

integer

Amount of goods
the amount of the goods quantity per loading unit

Minimum: 0
Maximum: 99999999999999

                supplierNumber*

integer

Supplier Number
the number of supplier

Maximum: 999999

                reworkerSupplierNumber

integer

External reworker supplier number
the number of the external reworker as supplier

Maximum: 999999

                documentNumber*

integer

Document number
for new goods deliveries this ist the goods receipt/goods acceptance protocol (WAP) number for this delivery entry generated from number range dependent on warehouse

Minimum: 100000
Maximum: 999999

                ownerCompany*

string

Owner Company (BDF)
stock-owner company for the product. List of values: https://docs.osp-fine.de/page/fine-common/00_meta_data/me02_global_enumerations/me02_global_enumerations/#_enum_company

                hermesTourNumber

string

Hermes number
the hermes tour number

Maximum Length: 12

                customsShipmentNumber

string

Custom shipment Number
shipment no from c@ts

                airWayBill

string

Custom shipment Number
Air Way Bill (Luftfrachtbrief)

Maximum Length: 30

                positionDetails

array

                    (Array item)

object

Additional Properties: false

                        purchaseOrderNumber*

string

Purchase Order Number
purchaseOrderNumber

Maximum Length: 36

                        deliveryNoteNumber

string

Delivery Note Number
the corresponding Id in the erp system

Maximum Length: 36

                        storageNotificationId

string

Storage Notification Id
Storage Notification Id

Maximum Length: 36

                        quantity

number

the quantity of the referenced PositionDetail within the position

                        electronicDeliveryNotePositionId

array

Electronic Delivery Note Position
list of delivery note positions

                            (Array item)

string

                        deliveryPositionDetailId

string

Position Detail Id
unique ID of the position detail

Maximum Length: 36

                        sourceLocation

string

Source/Original location
Where does the stock originally come from

                product*

object

Additional Properties: false

                    logisticsProductId*

string

Logistics Product Id
master communication key

Maximum Length: 36

                qualityCheck

string (enum)

Type of Quality Check
with goods inspection, without goods inspection, subsequent goods inspection. List of allowed values will be defined and documented #url

Any of: [ "NO_QUALITY_CHECK", "NORMAL_QUALITY_CHECK", "DOWNSTREAM_QUALITY_CHECK" ]
Maximum Length: 50

                qualityCode

integer

Quantity code number Goods inspection
quality code no from goods inspection (WACH)

Maximum: 999

                damagedQuantity

integer

Quantity items damaged
damaged quantity from transport (BI2), in COBRA always 0, damaged items will be booked additionally, in partno 1 set the qty for the complete item size

Maximum: 999999

                processEndDate

string

Process End Date
release date as YYYY-MM-DD

                processEndCode

string (enum)

Process End Code
ReturnKz/ReleaseCode = result of the activation process. List of allowed values will be defined and documented #url

Any of: [ "RELEASE", "CANCELLATION", "RETURN", "REWORK", "DESTROY", "THIRD_PARTY_SALE" ]

                erpDeliveryNo

string

Erp Deliver Number
Liefernummer im ERP_System

                qualitySampleRequestMode

string (enum)

Sample size calculation mode
Art der Musterberechnung. ONLINE=WACH/LIGIS, OFFLINE=claculated by the WMS

Any of: [ "ONLINE", "OFFLINE" ]

                qualitySampleDischargeMode

string (enum)

Direktausschleusung
Zeitpunkt der Musterentnahme: sofort/vorgelagert, nachgelagert, umgewandelt

Any of: [ "IMMEDIATE", "DEFERRED", "CONVERTED" ]

                deliveryComparisonResult

string (enum)

Comparison result
Ergebnis des Abgleiches Soll/Ist

Any of: [ "DIFFERENCE", "NO_DIFFERENCE", "NO_COMPARISON" ]

4.1.3. Enumeration

Field: Event Type

Table 2. eventType
Meta Value Description Short Value

DELIVERY_NOTE_REGISTRATION_END

WE1.0 Ende

GOODSRECEIPT_START

WE1.2 Start

GOODSRECEIPT_END

WE1.2 Ende

DELIVERY_COMPARISON_START

WE1.5 Start

DELIVERY_COMPARISON_END

WE1.5 Ende

RELEASE_END

WE2.0 Ende

Field: Context

Table 3. context
Meta Value Description Short Value

GOODS_IN

Wareneingang Neuware

Field: Delivery Type

Table 4. deliveryType
Meta Value Description Short Value

GOODSIN_SUPPLIER

WE vom Lieferanten

GOODSIN_FROM_REWORK

WE aus Nachbearbeitung

GOODSIN_FOR_BOOKING_AND_RELEASE

WE ohne Ware (zur Freischaltung mit LIB)

GOODSIN_FOR_REMOVAL

WE ohne Ware (zur Ausbuchung)

GOODSIN_INCOMPLETE

Inkomplette Anlieferungen

GOODSIN_DLW

DLW Anlieferung

GOODSIN_FOR_RELEASE

WE ohne Ware (zur Freischaltung ohne LIB)

GOODSIN_POST_PROCESSING

WE zur Aufbereitung

GOODSIN_FROM_MAPPER

Anlieferung aus Mapper

GOODSIN_SECOND_CHOICE

Anlieferung 2. Wahl

GOODSIN_STATIONARY_TRADE

WE ohne Ware für Stationärhandel

GOODSIN_SMALLPARTS

OSS-Anlieferung

GOODSIN_CANCELATION

WE aus Storno

GOODSIN_RELABEL

WE aus Neuauszeichnung

GOODSIN_B2B

WE aus Großkundenabzug

GOODSIN_FROM_RETAIL

WE Rückführung aus Filialen

GOODSIN_3RD_PARTY

WE aus Rückführung Drittgeschäft

Field: Goods Receipt Processing

Table 5. goodsReceiptProcessingType
Meta Value Description Short Value

PALLETED_SORTED

Palettiert einlagerungsfähig/sortenrein

PALLETED_UNSORTED

Palettiert unsortiert/Mischpalette

CARTONS_SORTED

Sortenreine Kartons

CARTONS_UNSORTED

Mischkartons/lose angeliefert

SANDWICH_PALLET

Sandwichpalette

PULK_2MH

Pulkanlieferung 2MH

DLW

Durchlaufware

ITEMS_UNSORTED

Mischanlieferung Item/Schuhe

ITEMS_UNSORTED_FROM_KEP

Mischanlieferung Item/Schuhe (von KEP). KEP = Kurier-, Express- und Paketdienste-Dienstleister

CARTONS_UNSORTED_FROM_KEP

Mischanlieferung Kartons (von KEP). KEP = Kurier-, Express- und Paketdienste-Dienstleister

NON_TRADE_ITEMS

Anlieferung von Verbrauchs- und Verpackungsmaterial

Field: Quality Check

Table 6. qualityCheck
Meta Value Description Short Value

NO_QUALITY_CHECK

ohne Prüfung

NORMAL_QUALITY_CHECK

mit Prüfung

DOWNSTREAM_QUALITY_CHECK

nachgelagerte Prüfung

Field: Process End Code

Table 7. processEndCode
Meta Value Description Short Value

RELEASE

Freischaltung

RETURN

Warenrücksendung

REWORK

Nachbearbeitung

CANCELLATION

Storno

DESTROY

Verschrottung

THIRD_PARTY_SALE

Verkauf an dritte

Field: Quality Sample Request Mode

Table 8. qualitySampleRequestMode
Meta Value Description Short Value

ONLINE

WACH/LIGIS

OFFLINE

Vom LVS ermittelt

Field: Quality Sample Discharge Mode

Table 9. qualitySampleDischargeMode
Meta Value Description Short Value

IMMEDIATE

sofort/vorgelagert

DEFERRED

nachgelagert

CONVERTED

umgewandelt

Field: Delivery Comparison Result

Table 10. deliveryComparisonResult
Meta Value Description Short Value

DIFFERENCE

Abgleich mit Differenz

NO_DIFFERENCE

Abgleich ohne Differenz

NO_COMPARISON

Abgleich noch nicht erfolgt

4.1.4. Example

Message WMS to FINE
{
    "eventId": "00ce536f-923a-42f4-8128-be118faf1d87",
    "traceId": "00ce536f-923a-42f4-8128-be118faf1d85",
    "spanId": "00ce536f-923a-42f4-8128-be118faf1d85",
    "eventTime": "2022-03-31T12:41:06.036+01:00",
    "version": "2.3",
    "context": "GOODS_IN",
    "eventType": "RELEASE_END",
    "metaData" : {
        "sender": "FINE_INBOUND",
        "client": "FBO",
        "instance": "ILO_INT2"
    },
    "data": {
        "location": "ILOWA",
        "businessEventTime": "2022-03-31T12:41:06.036+01:00",
        "goodsInId": "1368329",
        "deliveryNumber": "1189582",
        "deliveryTypeCode": "1",
        "deliveryType": "GOODSIN_SUPPLIER",
        "carrier": "Hermes Germany",
        "gates": [
            {
                "building": "1",
                "door": "8"
            }
        ],
        "processingInformation": [
            {
                "goodsReceiptProcessingType": "PALLETED_SORTED",
                "goodsReceiptProcessingCode": "W",
                "quantity": 12
            }
        ],
        "positions": [
            {
                "deliveryPositionId": "123123",
                "deliveryPositionNumber": 123456,
                "quantity": 90,
                "loadingUnitQuantity": 9,
                "supplierNumber": 648052,
                "reworkerSupplierNumber": 588411,
                "documentNumber": 483512,
                "ownerCompany": "OTTO",
                "hermesTourNumber": "SGH222010043",
                "customsShipmentNumber": "",
                "airWayBill": "",
                "positionDetails": [
                    {
                        "purchaseOrderNumber": "105791",
                        "deliveryNoteNumber": "22020176_648052",
                        "storageNotificationId": "",
                        "quantity": 90,
                        "electronicDeliveryNotePositionId": [
                            "HG_22020176_648052",
                            "LSB_12345667_987654332"
                        ],
                        "deliveryPositionDetailId": "51984510"
                    }
                ],
                "product": {
                    "logisticsProductId": "1245874412"
                },
                "qualityCheck": "DOWNSTREAM_QUALITY_CHECK",
                "qualityCode": 100,
                "damagedQuantity": 0,
                "processEndDate": "2023-04-16",
                "processEndCode": "RELEASE",
                "erpDeliveryNo": "3291147085",
                "qualitySampleRequestMode": "ONLINE",
                "qualitySampleDischargeMode": "DEFERRED",
                "deliveryComparisonResult": "DIFFERENCE"
            }
        ]
    }
}

4.1.5. Version history

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

planned version

2.3

Download

11.04.2025

Siehe Kapitel Changelog weiter unten

current version

2.2

Download

10.10.2024

Siehe Kapitel Changelog weiter unten

previous version

2.1

Download

13.12.2023

Siehe Kapitel Changelog weiter unten

previous version

2.0

Download

11.04.2023

Siehe Kapitel Changelog weiter unten

previous version

1.0

26.05.2022

- die Länge des Feldes “type” im Header hat sich von 20 auf 32 Zeichen geändert

previous version

1.0

09.05.2022

- das Datums-Format an den Feldern eventTime und businessEventTime hat sich geändert: das korrekte Format sieht so aus: 2022-03-31T12:41:06.036+0200

- wir haben die Versionsnummer angepasst bzw. das Versionierungskonzept umgesetzt. Die aktuelle SST-Version ist: „1.0“

- es wurden die Pflichtfelder am Header entsprechend hinterlegt. Diese Felder sind jetzt auch laut JSON Schema immer mitzuschicken: (eventId, traceId, spanId, version, eventTime, context, type, sender, sourceIdentifier)

- die Dokumentation direkt am JSON Schema wurde ergänzt, Beschreibungen, Beispiele wurden hinzugefügt.

4.1.6. Changelog

Changes V2.2 → V2.3

  • New values added to the ENUM deliveryType: GOODSIN_B2B, GOODSIN_FROM_RETAIL, GOODSIN_3RD_PARTY

  • New optional attribute sourceLocation was added

Changes V2.1 → V2.2

  • Company ENUM was removed from the attributes: client, ownerCompany

  • New optional attribute reworkerSupplierNumber was added: the external reworker as supplier

  • New ENUM value "NO_COMPARISON" was added for the existing attribute deliveryComparisonResult. Meaning: there was no comparison yet.

  • New optional attributes were added: arrivedToReworkerQuantity, destroyedByReworkerQuantity.

Changes V2.0 → V2.1

  • upgraded ENUM company from V4 to V6

  • optional attribute metaData.instance was added to the header

  • optional attributes itemNumber and itemSize were removed

  • mandatory attribute logisticsProductId was added to the FINE-ERP interface

  • 3 new optional attributes have been introduced: qualitySampleRequestMode, qualitySampleDischargeMode, deliveryComparisonResult

  • optional attribute deliveryPositionDetailId has been added

Changes V1.0 → V2.0

  1. Standard header: The Standard header has been changed to the current standard header with following changes:

    • "eventTime" is to be sent in local time. Format: yyyy-MM-dd’T’HH:mm:ss.SSSXXX Example: 2023-04-12T16:06:05.036+01:00

    • the attributes: "sourceIdentifier", "instance", "messageNumber", "lastMessageNumber" have been removed

    • the attribute "type" has been renamed to "eventType" and an enum has been introduced

    • for the attribute "context" an enum has been introduced

    • the attributes "sender" and "client" have been moved to the new object type "metaData"

  2. Payload (Data)

    • for the attribute "location" an enum has been introduced

    • "businessEventTime" is to be sent in local time. Format: yyyy-MM-dd’T’HH:mm:ss.SSSXXX Example: 2023-04-12T16:06:05.036+01:00

    • the attribute "type" has been renamed to "deliveryType" and an enum has been introduced

    • the attribute "typeCode" has been renamed to "deliveryTypeCode"

    • the attributes "goodsReceiptProcessing" and "goodsReceiptProcessingCode" have been moved to the new array "processingInformation"

    • "goodsReceiptProcessing" has been renamed to "goodsReceiptProcessingType"

    • the new array is optional but if present, then "goodsReceiptProcessingType" and "goodsReceiptProcessingCode" have to be provided

    • besides of the old attributes "goodsReceiptProcessingType" and "goodsReceiptProcessingCode" a new optional attribute "quantity" has been introduced

    • for the attribute "goodsReceiptProcessingType" an enum has been introduced

    • the attribute "positionId" has been renamed to "deliveryPositionId"

    • the attribute "positionNumber" has been renamed to "deliveryPositionNumber"

    • the attribute "logisticProductId" has been renamed to "logisticsProductId" (change only in the WMS interface)

    • the attribute "sku" has been removed

    • for the attribute "qualityCheck" an enum has been introduced

    • for the attribute "processEndCode" an enum has been introduced

    • new attributes have been introduced: "originalGoodsInId" (optional), "carrier" (optional), ownerCompany (mandatory)

Hint: The "…​Code" attributes should be filled with the WMS specific codes also known by the users in the warehouse. These will be presented in the data mart reports (BI). Here no enum will be defined as this code is WMS specific.

4.1.7. Schema

Interface WMS to FINE
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://cobra.ov.otto.de/json-schemas/goodsReceipts",
  "title": "WMS goods receipt messages",
  "description": "This document describes the goods receipt messages that FINE receives from warehouse systems.",
  "required": [
    "eventId",
    "traceId",
    "spanId",
    "eventTime",
    "version",
    "context",
    "eventType",
    "metaData",
    "data"
  ],
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "customDateTimePattern": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
      "customTimezone": "Europe/Berlin",
      "description": "Time at which this record (event) was technically generated in RFC3339 format with timezone in local time.  Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
      "examples": [
        "2023-04-12T16:06:05.036+01:00"
      ]
    },
    "version": {
      "title": "The number of version schema",
      "description": "Number of version of this data structure. Sematic specification (String with major & minor nr)",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "examples": [
        "1.0",
        "1.5",
        "2.0"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The context specified here means the business domain.",
      "enum": [
        "GOODS_IN"
      ],
      "examples": [
        "GOODS_IN"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "enum": [
        "DELIVERY_NOTE_REGISTRATION_END",
        "GOODSRECEIPT_START",
        "GOODSRECEIPT_END",
        "DELIVERY_COMPARISON_START",
        "DELIVERY_COMPARISON_END",
        "RELEASE_END"
      ],
      "examples": [
        "DELIVERY_NOTE_REGISTRATION_END"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta information",
      "description": "can be used with different characteristics for technical data per interface",
      "properties": {
        "sender": {
          "title": "sender",
          "description": "Name of the source system, that has sent this message.",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v3.schema.json"
        },
        "client": {
          "type": "string",
          "title": "client",
          "description": "Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea...). List of values: https://docs.osp-fine.de/page/fine-common/00_meta_data/me02_global_enumerations/me02_global_enumerations/#_enum_company"
        },
        "instance": {
          "type": "string",
          "title": "Software instance of producing system",
          "description": "Name of the source instance that generated this data. Used for example to distinguish between different Test Instances."
        }
      },
      "required": [
        "sender"
      ]
    },
    "data": {
      "$ref": "#/definitions/data"
    }
  },
  "definitions": {
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "The sending warehouse (cobra sends data for different warehouses), List of allowed values will be defined and documented #url",
          "title": "The sending warehouse",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
        },
        "businessEventTime": {
          "description": "the date and time, when the business event occurred, in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
          "type": "string",
          "format": "date-time",
          "customDateTimePattern": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
          "customTimezone": "Europe/Berlin",
          "title": "The date and time, when the business event occurred",
          "examples": [
            "2022-03-31T12:41:06.036+01:00"
          ]
        },
        "goodsInId": {
          "description": "the goods receipt technical key, generated by the wms. (Possible UUID but other identifier accepted)",
          "type": "string",
          "maxLength": 36,
          "title": "the goods receipt ID",
          "examples": [
            "1189582"
          ]
        },
        "originalGoodsInId": {
          "description": "the goods receipt technical key, generated by the wms. This ID is referencing the original Delivery (technical key) in case when goods arrive back from rework",
          "type": "string",
          "maxLength": 36,
          "title": "the original goods receipt ID",
          "examples": [
            "1189581"
          ]
        },
        "deliveryNumber": {
          "description": "the inbound delivery business key, generated by the wms",
          "type": "string",
          "maxLength": 36,
          "title": "the inbound delivery business key",
          "examples": [
            "1189582"
          ]
        },
        "deliveryTypeCode": {
          "description": "Identification of the type of entry/delivery type {manual, automatic entry, DLW, return, transfer, WE from post-processing, WE without goods, etc.} Only the known forms of the WMS are delivered.",
          "type": "string",
          "maxLength": 50,
          "title": "Identification of the type of entry/delivery",
          "example": [
            "MANUAL",
            "WE_WITHOUT_GOODS",
            "1",
            "6"
          ]
        },
        "deliveryType": {
          "description": "the type of the delivery (from supplier, DLW, returns, postprocessing, without goods...)",
          "type": "string",
          "title": "Type of the delivery",
          "enum": [
            "GOODSIN_SUPPLIER",
            "GOODSIN_FROM_REWORK",
            "GOODSIN_FOR_BOOKING_AND_RELEASE",
            "GOODSIN_FOR_REMOVAL",
            "GOODSIN_INCOMPLETE",
            "GOODSIN_DLW",
            "GOODSIN_FOR_RELEASE",
            "GOODSIN_POST_PROCESSING",
            "GOODSIN_FROM_MAPPER",
            "GOODSIN_SECOND_CHOICE",
            "GOODSIN_STATIONARY_TRADE",
            "GOODSIN_SMALLPARTS",
            "GOODSIN_CANCELATION",
            "GOODSIN_RELABEL",
            "GOODSIN_B2B",
            "GOODSIN_FROM_RETAIL",
            "GOODSIN_3RD_PARTY"
          ]
        },
        "carrier": {
          "description": "name of the carrier transporting goods",
          "type": "string",
          "maxLength": 100,
          "title": "name of the carrier transporting goods",
          "examples": [
            "HG",
            "DHL"
          ]
        },
        "gates": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "door": {
                "description": "The gate, door no where the truck arrives",
                "type": "string",
                "maxLength": 10,
                "title": "Gate or Door number",
                "examples": [
                  "8"
                ]
              },
              "building": {
                "description": "The building where the truck arrives",
                "type": "string",
                "maxLength": 3,
                "title": "Building",
                "examples": [
                  "N/A"
                ]
              }
            }
          }
        },
        "processingInformation": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/processingInformationType"
          }
        },
        "positions": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/goodsReceiptPosition"
          }
        }
      },
      "required": [
        "location",
        "businessEventTime",
        "goodsInId",
        "deliveryNumber",
        "deliveryType"
      ],
      "additionalProperties": false
    },
    "processingInformationType": {
      "type": "object",
      "properties": {
        "goodsReceiptProcessingType": {
          "description": "Pallets/hatch detection, palletized, loose, loose, DLW.... List of allowed values will be defined and documented #url ",
          "type": "string",
          "title": "Pallets/hatch detection",
          "enum": [
            "PALLETED_SORTED",
            "PALLETED_UNSORTED",
            "CARTONS_SORTED",
            "CARTONS_UNSORTED",
            "SANDWICH_PALLET",
            "PULK_2MH",
            "DLW",
            "ITEMS_UNSORTED",
            "ITEMS_UNSORTED_FROM_KEP",
            "CARTONS_UNSORTED_FROM_KEP",
            "NON_TRADE_ITEMS"
          ]
        },
        "goodsReceiptProcessingCode": {
          "description": "Differentiation according to pallet/hatch detection, or in the case of Cobra: differentiation according to palletized/loose, loose, DLW, etc. WMS internal codes are transferred in this attribute",
          "type": "string",
          "title": "Pallet/hatch detection code",
          "examples": [
            "W"
          ]
        },
        "quantity": {
          "description": "the received quantity for this processing type",
          "type": "integer",
          "maximum": 99999999999999,
          "minimum": 0,
          "title": "Quantity received for this processing type",
          "examples": [
            90
          ]
        }
      },
      "required": [
        "goodsReceiptProcessingType",
        "goodsReceiptProcessingCode"
      ],
      "additionalProperties": false
    },
    "goodsReceiptPosition": {
      "type": "object",
      "properties": {
        "deliveryPositionId": {
          "description": "Unique ID of the position. Can be a number from a sequence, a UUID or a combination of GoodsInId + PositionNumber",
          "type": "string",
          "maxLength": 36,
          "title": "Position Id",
          "examples": [
            "12313"
          ]
        },
        "deliveryPositionNumber": {
          "description": "position number - incremental number (identifier) of the delivery position",
          "type": "integer",
          "maximum": 99999999999999,
          "title": "Position number",
          "examples": [
            1233413
          ]
        },
        "quantity": {
          "description": "the received quantity for this item size according to the delivery note",
          "type": "integer",
          "maximum": 99999999999999,
          "minimum": 0,
          "title": "Quantity received",
          "examples": [
            90
          ]
        },
        "arrivedToReworkerQuantity": {
          "description": "the received quantity by the external reworker for this item size according to the delivery note",
          "type": "integer",
          "maximum": 99999999999999,
          "minimum": 0,
          "title": "Quantity received by the external reworker",
          "examples": [
            90
          ]
        },
        "destroyedByReworkerQuantity": {
          "description": "the destroyed quantity for this item size by the external reworker",
          "type": "integer",
          "maximum": 99999999999999,
          "minimum": 0,
          "title": "Quantity destroyed by the external reworker",
          "examples": [
            90
          ]
        },
        "loadingUnitQuantity": {
          "description": "the amount of the goods quantity per loading unit",
          "type": "integer",
          "maximum": 99999999999999,
          "minimum": 0,
          "title": "Amount of goods",
          "examples": [
            9
          ]
        },
        "supplierNumber": {
          "description": "the number of supplier",
          "type": "integer",
          "maximum": 999999,
          "title": "Supplier Number",
          "examples": [
            648052
          ]
        },
        "reworkerSupplierNumber": {
          "description": "the number of the external reworker as supplier",
          "type": "integer",
          "maximum": 999999,
          "title": "External reworker supplier number",
          "examples": [
            625221
          ]
        },
        "documentNumber": {
          "description": "for new goods deliveries this ist the goods receipt/goods acceptance protocol (WAP) number for this delivery entry generated from number range dependent on warehouse",
          "type": "integer",
          "minimum": 100000,
          "maximum": 999999,
          "title": "Document number",
          "examples": [
            484052
          ]
        },
        "ownerCompany": {
          "type": "string",
          "title": "Owner Company (BDF)",
          "description": "stock-owner company for the product. List of values: https://docs.osp-fine.de/page/fine-common/00_meta_data/me02_global_enumerations/me02_global_enumerations/#_enum_company"
        },
        "hermesTourNumber": {
          "description": "the hermes tour number",
          "type": "string",
          "maxLength": 12,
          "title": "Hermes number",
          "examples": [
            "SGH222010043"
          ]
        },
        "customsShipmentNumber": {
          "description": "shipment no from c@ts",
          "type": "string",
          "title": "Custom shipment Number",
          "examples": [
            "804f2105-e5b7-4295-a6ae-02cc1cdc9c04"
          ]
        },
        "airWayBill": {
          "description": "Air Way Bill (Luftfrachtbrief)",
          "type": "string",
          "maxLength": 30,
          "title": "Custom shipment Number",
          "examples": [
            "SGH122020263"
          ]
        },
        "positionDetails": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/positionDetails"
          }
        },
        "product": {
          "$ref": "#/definitions/product"
        },
        "qualityCheck": {
          "description": "with goods inspection, without goods inspection, subsequent goods inspection. List of allowed values will be defined and documented #url",
          "type": "string",
          "maxLength": 50,
          "title": "Type of Quality Check",
          "enum": [
            "NO_QUALITY_CHECK",
            "NORMAL_QUALITY_CHECK",
            "DOWNSTREAM_QUALITY_CHECK"
          ]
        },
        "qualityCode": {
          "description": "quality code no from goods inspection (WACH)",
          "type": "integer",
          "maximum": 999,
          "title": "Quantity code number Goods inspection",
          "examples": [
            0
          ]
        },
        "damagedQuantity": {
          "description": "damaged quantity from transport (BI2), in COBRA always 0, damaged items will be booked additionally, in partno 1 set the qty for the complete item size",
          "type": "integer",
          "maximum": 999999,
          "title": "Quantity items damaged",
          "examples": [
            0
          ]
        },
        "processEndDate": {
          "description": "release date as YYYY-MM-DD",
          "type": "string",
          "title": "Process End Date",
          "examples": [
            "2016-04-16"
          ]
        },
        "processEndCode": {
          "description": "ReturnKz/ReleaseCode = result of the activation process. List of allowed values will be defined and documented #url",
          "type": "string",
          "title": "Process End Code",
          "enum": [
            "RELEASE",
            "CANCELLATION",
            "RETURN",
            "REWORK",
            "DESTROY",
            "THIRD_PARTY_SALE"
          ]
        },
        "erpDeliveryNo": {
          "description": "Liefernummer im ERP_System",
          "type": "string",
          "title": "Erp Deliver Number",
          "examples": [
            "3291147085"
          ]
        },
        "qualitySampleRequestMode": {
          "description": "Art der Musterberechnung. ONLINE=WACH/LIGIS, OFFLINE=claculated by the WMS",
          "type": "string",
          "title": "Sample size calculation mode",
          "enum": [
            "ONLINE",
            "OFFLINE"
          ]
        },
        "qualitySampleDischargeMode": {
          "description": "Zeitpunkt der Musterentnahme: sofort/vorgelagert, nachgelagert, umgewandelt",
          "type": "string",
          "title": "Direktausschleusung",
          "enum": [
            "IMMEDIATE",
            "DEFERRED",
            "CONVERTED"
          ]
        },
        "deliveryComparisonResult": {
          "description": "Ergebnis des Abgleiches Soll/Ist",
          "type": "string",
          "title": "Comparison result",
          "enum": [
            "DIFFERENCE",
            "NO_DIFFERENCE",
            "NO_COMPARISON"
          ]
        }
      },
      "required": [
        "deliveryPositionId",
        "quantity",
        "supplierNumber",
        "product",
        "documentNumber",
        "ownerCompany"
      ],
      "additionalProperties": false
    },
    "product": {
      "type": "object",
      "properties": {
        "logisticsProductId": {
          "description": "master communication key",
          "type": "string",
          "maxLength": 36,
          "title": "Logistics Product Id",
          "examples": [
            "123"
          ]
        }
      },
      "required": [
        "logisticsProductId"
      ],
      "additionalProperties": false
    },
    "positionDetails": {
      "type": "object",
      "properties": {
        "purchaseOrderNumber": {
          "description": "purchaseOrderNumber",
          "type": "string",
          "maxLength": 36,
          "title": "Purchase Order Number",
          "examples": [
            "105791"
          ]
        },
        "deliveryNoteNumber": {
          "description": "the corresponding Id in the erp system",
          "type": "string",
          "maxLength": 36,
          "title": "Delivery Note Number",
          "examples": [
            "22020176_648052"
          ]
        },
        "storageNotificationId": {
          "description": "Storage Notification Id",
          "title": "Storage Notification Id",
          "type": "string",
          "maxLength": 36
        },
        "quantity": {
          "description": "the quantity of the referenced PositionDetail within the position",
          "type": "number"
        },
        "electronicDeliveryNotePositionId": {
          "description": "list of delivery note positions",
          "type": "array",
          "title": "Electronic Delivery Note Position",
          "items": {
            "type": "string",
            "example": [
              "HG_22020176_648052",
              "LSB_12345667_987654332"
            ]
          }
        },
        "deliveryPositionDetailId": {
          "description": "unique ID of the position detail",
          "type": "string",
          "maxLength": 36,
          "title": "Position Detail Id",
          "examples": [
            "12313"
          ]
        },
        "sourceLocation": {
          "description": "Where does the stock originally come from",
          "type": "string",
          "title": "Source/Original location",
          "example": ["54513210"]
        }
      },
      "required": [
        "purchaseOrderNumber"
      ],
      "additionalProperties": false
    },
    "examples": [
      {
        "eventId": "00ce536f-923a-42f4-8128-be118faf1d87",
        "traceId": "00ce536f-923a-42f4-8128-be118faf1d85",
        "spanId": "00ce536f-923a-42f4-8128-be118faf1d85",
        "eventTime": "2022-03-31T12:41:06.036+01:00",
        "version": "2.2",
        "context": "GOODS_IN",
        "eventType": "RELEASE_END",
        "metaData" : {
          "sender": "FINE_INBOUND",
          "client": "FBO",
          "instance": "ILO_INT2"
        },
        "data": {
          "location": "ILOWA",
          "businessEventTime": "2022-03-31T12:41:06.036+01:00",
          "goodsInId": "1368329",
          "deliveryNumber": "1189582",
          "deliveryTypeCode": "1",
          "deliveryType": "GOODSIN_SUPPLIER",
          "carrier": "Hermes Germany",
          "gates": [
            {
              "building": "1",
              "door": "8"
            }
          ],
          "processingInformation": [
            {
              "goodsReceiptProcessingType": "PALLETED_SORTED",
              "goodsReceiptProcessingCode": "W",
              "quantity": 12
            }
          ],
          "positions": [
            {
              "deliveryPositionId": "123123",
              "deliveryPositionNumber": 123456,
              "quantity": 90,
              "loadingUnitQuantity": 9,
              "supplierNumber": 648052,
              "reworkerSupplierNumber": 588411,
              "documentNumber": 483512,
              "ownerCompany": "OTTO",
              "hermesTourNumber": "SGH222010043",
              "customsShipmentNumber": "",
              "airWayBill": "",
              "positionDetails": [
                {
                  "purchaseOrderNumber": "105791",
                  "deliveryNoteNumber": "22020176_648052",
                  "storageNotificationId": "",
                  "quantity": 90,
                  "electronicDeliveryNotePositionId": [
                    "HG_22020176_648052",
                    "LSB_12345667_987654332"
                  ],
                  "deliveryPositionDetailId": "51984510"
                }
              ],
              "product": {
                "logisticsProductId": "1245874412"
              },
              "qualityCheck": "DOWNSTREAM_QUALITY_CHECK",
              "qualityCode": 100,
              "damagedQuantity": 0,
              "processEndDate": "2023-04-16",
              "processEndCode": "RELEASE",
              "erpDeliveryNo": "3291147085",
              "qualitySampleRequestMode": "ONLINE",
              "qualitySampleDischargeMode": "DEFERRED",
              "deliveryComparisonResult": "DIFFERENCE"
            }
          ]
        }
      }
    ]
  }
}

4.2. Direction FINE to ERP

4.2.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 12. Attribute
Fieldname Expresion

type

DELIVERY_NOTE_REGISTRATION_END

GOODSRECEIPT_START

GOODSRECEIPT_END

DELIVERY_COMPARISON_START

DELIVERY_COMPARISON_END

RELEASE_END

context

GOODS_IN

4.2.2. Datamodel

Property Type Description

(Root)

object

ERP goods receipt messages
This document describes the goods receipt messages that FINE sends to the ERPs.

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

    spanId*

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format with timezone in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

    version*

string

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

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

    context*

string (enum)

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

Any of: [ "GOODS_IN" ]

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "DELIVERY_NOTE_REGISTRATION_END", "GOODSRECEIPT_START", "GOODSRECEIPT_END", "DELIVERY_COMPARISON_START", "DELIVERY_COMPARISON_END", "RELEASE_END" ]

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

        client

string

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​). List of values: https://docs.osp-fine.de/page/fine-common/00_meta_data/me02_global_enumerations/me02_global_enumerations/#_enum_company

        instance

string

Software instance of producing system
Name of the source instance that generated this data. Used for example to distinguish between different Test Instances.

    data*

object

Additional Properties: false

        location*

string (enum)

The sending warehouse
The sending warehouse (cobra sends data for different warehouses), List of allowed values will be defined and documented #url

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

        businessEventTime*

string (date-time)

The date and time, when the business event occurred
the date and time, when the business event occurred, in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

        goodsInId*

string

the goods receipt ID
the goods receipt technical key, generated by the wms. (Possible UUID but other identifier accepted)

Maximum Length: 36

        originalGoodsInId

string

the original goods receipt ID
the goods receipt technical key, generated by the wms. This ID is referencing the original Delivery (technical key) in case when goods arrive back from rework

Maximum Length: 36

        deliveryNumber*

string

the inbound delivery business key
the inbound delivery business key, generated by the wms

Maximum Length: 36

        deliveryTypeCode

string

Identification of the type of entry/delivery
Identification of the type of entry/delivery type {manual, automatic entry, DLW, return, transfer, WE from post-processing, WE without goods, etc.} Only the known forms of the WMS are delivered.

Maximum Length: 50

        deliveryType*

string (enum)

Type of the delivery
the type of the delivery (from supplier, DLW, returns, postprocessing, without goods…​)

Any of: [ "GOODSIN_SUPPLIER", "GOODSIN_FROM_REWORK", "GOODSIN_FOR_BOOKING_AND_RELEASE", "GOODSIN_FOR_REMOVAL", "GOODSIN_INCOMPLETE", "GOODSIN_DLW", "GOODSIN_FOR_RELEASE", "GOODSIN_POST_PROCESSING", "GOODSIN_FROM_MAPPER", "GOODSIN_SECOND_CHOICE", "GOODSIN_STATIONARY_TRADE", "GOODSIN_SMALLPARTS", "GOODSIN_CANCELATION", "GOODSIN_RELABEL", "GOODSIN_B2B", "GOODSIN_FROM_RETAIL", "GOODSIN_3RD_PARTY" ]

        carrier

string

name of the carrier transporting goods
name of the carrier transporting goods

Maximum Length: 100

        gates

array

            (Array item)

object

                door

string

Gate or Door number
The gate, door no where the truck arrives

Maximum Length: 10

                building

string

Building
The building where the truck arrives

Maximum Length: 3

        processingInformation

array

            (Array item)

object

Additional Properties: false

                goodsReceiptProcessingType*

string (enum)

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

Any of: [ "PALLETED_SORTED", "PALLETED_UNSORTED", "CARTONS_SORTED", "CARTONS_UNSORTED", "SANDWICH_PALLET", "PULK_2MH", "DLW", "ITEMS_UNSORTED", "ITEMS_UNSORTED_FROM_KEP", "CARTONS_UNSORTED_FROM_KEP", "NON_TRADE_ITEMS" ]

                goodsReceiptProcessingCode*

string

Pallet/hatch detection code
Differentiation according to pallet/hatch detection, or in the case of Cobra: differentiation according to palletized/loose, loose, DLW, etc. WMS internal codes are transferred in this attribute

                quantity

integer

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

Minimum: 0
Maximum: 99999999999999

        positions

array

            (Array item)

object

Additional Properties: false

                deliveryPositionId*

string

Position Id
Unique ID of the position. Can be a number from a sequence, a UUID or a combination of GoodsInId + PositionNumber

Maximum Length: 36

                deliveryPositionNumber

integer

Position number
position number - incremental number (identifier) of the delivery position

Maximum: 99999999999999

                quantity*

integer

Quantity received
the received quantity for this item size according to the delivery note

Minimum: 0
Maximum: 99999999999999

                arrivedToReworkerQuantity

integer

Quantity received by the external reworker
the received quantity by the external reworker for this item size according to the delivery note

Minimum: 0
Maximum: 99999999999999

                destroyedByReworkerQuantity

integer

Quantity destroyed by the external reworker
the destroyed quantity for this item size by the external reworker

Minimum: 0
Maximum: 99999999999999

                loadingUnitQuantity

integer

Amount of goods
the amount of the goods quantity per loading unit

Minimum: 0
Maximum: 99999999999999

                supplierNumber*

integer

Supplier Number
the number of supplier

Maximum: 999999

                reworkerSupplierNumber

integer

External reworker supplier number
the number of the external reworker as supplier

Maximum: 999999

                documentNumber*

integer

Document number
for new goods deliveries this ist the goods receipt/goods acceptance protocol (WAP) number for this delivery entry generated from number range dependent on warehouse

Minimum: 100000
Maximum: 999999

                ownerCompany*

string

Owner Company (BDF)
stock-owner company for the product. List of values: https://docs.osp-fine.de/page/fine-common/00_meta_data/me02_global_enumerations/me02_global_enumerations/#_enum_company

                hermesTourNumber

string

Hermes number
the hermes tour number

Maximum Length: 12

                customsShipmentNumber

string

Custom shipment Number
shipment no from c@ts

                airWayBill

string

Custom shipment Number
Air Way Bill (Luftfrachtbrief)

Maximum Length: 30

                positionDetails

array

                    (Array item)

object

Additional Properties: false

                        purchaseOrderNumber*

string

Purchase Order Number
purchaseOrderNumber

Maximum Length: 36

                        deliveryNoteNumber

string

Delivery Note Number
the corresponding Id in the erp system

Maximum Length: 36

                        storageNotificationId

string

Storage Notification Id
Storage Notification Id

Maximum Length: 36

                        quantity

number

the quantity of the referenced PositionDetail within the position

                        electronicDeliveryNotePositionId

array

Electronic Delivery Note Position
list of delivery note positions

                            (Array item)

string

                        deliveryPositionDetailId

string

Position Detail Id
unique ID of the position detail

Maximum Length: 36

                        sourceLocation

string

Source/Original location
Where does the stock originally come from

                product*

object

Additional Properties: false

                    erpProductId*

string

ERP Product Id
master communication key

Maximum Length: 36

                    logisticsProductId*

string

Logistics Product Id
master communication key

Maximum Length: 36

                qualityCheck

string (enum)

Type of Quality Check
with goods inspection, without goods inspection, subsequent goods inspection. List of allowed values will be defined and documented #url

Any of: [ "NO_QUALITY_CHECK", "NORMAL_QUALITY_CHECK", "DOWNSTREAM_QUALITY_CHECK" ]
Maximum Length: 50

                qualityCode

integer

Quantity code number Goods inspection
quality code no from goods inspection (WACH)

Maximum: 999

                damagedQuantity

integer

Quantity items damaged
damaged quantity from transport (BI2), in COBRA always 0, damaged items will be booked additionally, in partno 1 set the qty for the complete item size

Maximum: 999999

                processEndDate

string

Process End Date
release date as YYYY-MM-DD

                processEndCode

string (enum)

Process End Code
ReturnKz/ReleaseCode = result of the activation process. List of allowed values will be defined and documented #url

Any of: [ "RELEASE", "CANCELLATION", "RETURN", "REWORK", "DESTROY", "THIRD_PARTY_SALE" ]

                erpDeliveryNo

string

Erp Deliver Number
Liefernummer im ERP_System

                qualitySampleRequestMode

string (enum)

Sample size calculation mode
Art der Musterberechnung. ONLINE=WACH/LIGIS, OFFLINE=claculated by the WMS

Any of: [ "ONLINE", "OFFLINE" ]

                qualitySampleDischargeMode

string (enum)

Direktausschleusung
Zeitpunkt der Musterentnahme: sofort/vorgelagert, nachgelagert, umgewandelt

Any of: [ "IMMEDIATE", "DEFERRED", "CONVERTED" ]

                deliveryComparisonResult

string (enum)

Comparison result
Ergebnis des Abgleiches Soll/Ist

Any of: [ "DIFFERENCE", "NO_DIFFERENCE", "NO_COMPARISON" ]

4.2.3. Enumeration

Field: Event Type

Table 13. eventType
Meta Value Description Short Value

DELIVERY_NOTE_REGISTRATION_END

WE1.0 Ende

GOODSRECEIPT_START

WE1.2 Start

GOODSRECEIPT_END

WE1.2 Ende

DELIVERY_COMPARISON_START

WE1.5 Start

DELIVERY_COMPARISON_END

WE1.5 Ende

RELEASE_END

WE2.0 Ende

Field: Context

Table 14. context
Meta Value Description Short Value

GOODS_IN

Wareneingang Neuware

Field: Delivery Type

Table 15. deliveryType
Meta Value Description Short Value

GOODSIN_SUPPLIER

WE vom Lieferanten

GOODSIN_FROM_REWORK

WE aus Nachbearbeitung

GOODSIN_FOR_BOOKING_AND_RELEASE

WE ohne Ware (zur Freischaltung mit LIB)

GOODSIN_FOR_REMOVAL

WE ohne Ware (zur Ausbuchung)

GOODSIN_INCOMPLETE

Inkomplette Anlieferungen

GOODSIN_DLW

DLW Anlieferung

GOODSIN_FOR_RELEASE

WE ohne Ware (zur Freischaltung ohne LIB)

GOODSIN_POST_PROCESSING

WE zur Aufbereitung

GOODSIN_FROM_MAPPER

Anlieferung aus Mapper

GOODSIN_SECOND_CHOICE

Anlieferung 2. Wahl

GOODSIN_STATIONARY_TRADE

WE ohne Ware für Stationärhandel

GOODSIN_SMALLPARTS

OSS-Anlieferung

GOODSIN_CANCELATION

WE aus Storno

GOODSIN_RELABEL

WE aus Neuauszeichnung

GOODSIN_B2B

WE aus Großkundenabzug

GOODSIN_FROM_RETAIL

WE Rückführung aus Filialen

GOODSIN_3RD_PARTY

WE aus Rückführung Drittgeschäft

Field: Goods Receipt Processing

Table 16. goodsReceiptProcessingType
Meta Value Description Short Value

PALLETED_SORTED

Palettiert einlagerungsfähig/sortenrein

PALLETED_UNSORTED

Palettiert unsortiert/Mischpalette

CARTONS_SORTED

Sortenreine Kartons

CARTONS_UNSORTED

Mischkartons/lose angeliefert

SANDWICH_PALLET

Sandwichpalette

PULK_2MH

Pulkanlieferung 2MH

DLW

Durchlaufware

ITEMS_UNSORTED

Mischanlieferung Item/Schuhe

ITEMS_UNSORTED_FROM_KEP

Mischanlieferung Item/Schuhe (von KEP). KEP = Kurier-, Express- und Paketdienste-Dienstleister

CARTONS_UNSORTED_FROM_KEP

Mischanlieferung Kartons (von KEP). KEP = Kurier-, Express- und Paketdienste-Dienstleister

NON_TRADE_ITEMS

Anlieferung von Verbrauchs- und Verpackungsmaterial

Field: Quality Check

Table 17. qualityCheck
Meta Value Description Short Value

NO_QUALITY_CHECK

ohne Prüfung

NORMAL_QUALITY_CHECK

mit Prüfung

DOWNSTREAM_QUALITY_CHECK

nachgelagerte Prüfung

Field: Process End Code

Table 18. processEndCode
Meta Value Description Short Value

RELEASE

Freischaltung

RETURN

Warenrücksendung

REWORK

Nachbearbeitung

CANCELLATION

Storno

DESTROY

Verschrottung

THIRD_PARTY_SALE

Verkauf an dritte

Field: Quality Sample Request Mode

Table 19. qualitySampleRequestMode
Meta Value Description Short Value

ONLINE

WACH/LIGIS

OFFLINE

Vom LVS ermittelt

Field: Quality Sample Discharge Mode

Table 20. qualitySampleDischargeMode
Meta Value Description Short Value

IMMEDIATE

sofort/vorgelagert

DEFERRED

nachgelagert

CONVERTED

umgewandelt

Field: Delivery Comparison Result

Table 21. deliveryComparisonResult
Meta Value Description Short Value

DIFFERENCE

Abgleich mit Differenz

NO_DIFFERENCE

Abgleich ohne Differenz

NO_COMPARISON

Abgleich noch nicht erfolgt

4.2.4. Example

Message FINE to ERP
{
    "eventId": "00ce536f-923a-42f4-8128-be118faf1d87",
    "traceId": "00ce536f-923a-42f4-8128-be118faf1d85",
    "spanId": "00ce536f-923a-42f4-8128-be118faf1d85",
    "eventTime": "2022-03-31T12:41:06.036+01:00",
    "version": "2.3",
    "context": "GOODS_IN",
    "eventType": "RELEASE_END",
    "metaData" : {
        "sender": "FINE_INBOUND",
        "client": "FBO",
        "instance": "ILO_INT2"
    },
    "data": {
        "location": "ILOWA",
        "businessEventTime": "2022-03-31T12:41:06.036+01:00",
        "goodsInId": "1368329",
        "deliveryNumber": "1189582",
        "deliveryTypeCode": "1",
        "deliveryType": "GOODSIN_SUPPLIER",
        "carrier": "Hermes Germany",
        "gates": [
            {
                "building": "1",
                "door": "8"
            }
        ],
        "processingInformation": [
            {
                "goodsReceiptProcessingType": "PALLETED_SORTED",
                "goodsReceiptProcessingCode": "W",
                "quantity": 12
            }
        ],
        "positions": [
            {
                "deliveryPositionId": "123123",
                "deliveryPositionNumber": 123456,
                "quantity": 90,
                "loadingUnitQuantity": 9,
                "supplierNumber": 648052,
                "reworkerSupplierNumber": 588411,
                "documentNumber": 483512,
                "ownerCompany": "OTTO",
                "hermesTourNumber": "SGH222010043",
                "customsShipmentNumber": "",
                "airWayBill": "",
                "positionDetails": [
                    {
                        "purchaseOrderNumber": "105791",
                        "deliveryNoteNumber": "22020176_648052",
                        "storageNotificationId": "",
                        "quantity": 90,
                        "electronicDeliveryNotePositionId": [
                            "HG_22020176_648052",
                            "LSB_12345667_987654332"
                        ],
                        "deliveryPositionDetailId": "51984510"
                    }
                ],
                "product": {
                    "erpProductId": "1245874412",
                    "logisticsProductId": "1245874412"
                },
                "qualityCheck": "DOWNSTREAM_QUALITY_CHECK",
                "qualityCode": 100,
                "damagedQuantity": 0,
                "processEndDate": "2023-04-16",
                "processEndCode": "RELEASE",
                "erpDeliveryNo": "3291147085",
                "qualitySampleRequestMode": "ONLINE",
                "qualitySampleDischargeMode": "DEFERRED",
                "deliveryComparisonResult": "DIFFERENCE"
            }
        ]
    }
}

4.2.5. Version history

Table 22. Version FINE to ERP
Version Number File Published on Changes

planned version

2.3

Download

11.04.2025

Siehe Kapitel Changelog weiter unten

current version

2.2

Download

10.10.2024

Siehe Kapitel Changelog weiter unten

previous version

2.1

Download

13.12.2023

Siehe Kapitel Changelog weiter unten

previous version

2.0

Download

11.04.2023

Siehe Kapitel Changelog weiter unten

previous version

1.0

26.05.2022

- die Länge des Feldes “type” im Header hat sich von 20 auf 32 Zeichen geändert

previous version

1.0

09.05.2022

- das Datums-Format an den Feldern eventTime und businessEventTime hat sich geändert: das korrekte Format sieht so aus: 2022-03-31T12:41:06.036+0200

- wir haben die Versionsnummer angepasst bzw. das Versionierungskonzept umgesetzt. Die aktuelle SST-Version ist: „1.0“

- es wurden die Pflichtfelder am Header entsprechend hinterlegt. Diese Felder sind jetzt auch laut JSON Schema immer mitzuschicken: (eventId, traceId, spanId, version, eventTime, context, type, sender, sourceIdentifier)

- die Dokumentation direkt am JSON Schema wurde ergänzt, Beschreibungen, Beispiele wurden hinzugefügt.

4.2.6. Changelog

Changes V2.2 → V2.3

  • New values added to the ENUM deliveryType: GOODSIN_B2B, GOODSIN_FROM_RETAIL, GOODSIN_3RD_PARTY

  • New optional attribute sourceLocation was added

Changes V2.1 → V2.2

  • Company ENUM was removed from the attributes: client, ownerCompany

  • New optional attribute reworkerSupplierNumber was added: the external reworker as supplier

  • New ENUM value "NO_COMPARISON" was added for the existing attribute deliveryComparisonResult. Meaning: there was no comparison yet.

  • New optional attributes were added: arrivedToReworkerQuantity, destroyedByReworkerQuantity.

Changes V2.0 → V2.1

  • upgraded ENUM company from V4 to V6

  • optional attribute metaData.instance was added to the header

  • optional attributes itemNumber and itemSize were removed

  • mandatory attribute logisticsProductId was added to the FINE-ERP interface

  • 3 new optional attributes have been introduced: qualitySampleRequestMode, qualitySampleDischargeMode, deliveryComparisonResult

  • optional attribute deliveryPositionDetailId has been added

Changes V1.0 → V2.0

  1. Standard header: The Standard header has been changed to the current standard header with following changes:

    • "eventTime" is to be sent in local time. Format: yyyy-MM-dd’T’HH:mm:ss.SSSXXX Example: 2023-04-12T16:06:05.036+01:00

    • the attributes: "sourceIdentifier", "instance", "messageNumber", "lastMessageNumber" have been removed

    • the attribute "type" has been renamed to "eventType" and an enum has been introduced

    • for the attribute "context" an enum has been introduced

    • the attributes "sender" and "client" have been moved to the new object type "metaData"

  2. Payload (Data)

    • for the attribute "location" an enum has been introduced

    • "businessEventTime" is to be sent in local time. Format: yyyy-MM-dd’T’HH:mm:ss.SSSXXX Example: 2023-04-12T16:06:05.036+01:00

    • the attribute "type" has been renamed to "deliveryType" and an enum has been introduced

    • the attribute "typeCode" has been renamed to "deliveryTypeCode"

    • the attributes "goodsReceiptProcessing" and "goodsReceiptProcessingCode" have been moved to the new array "processingInformation"

    • "goodsReceiptProcessing" has been renamed to "goodsReceiptProcessingType"

    • the new array is optional but if present, then "goodsReceiptProcessingType" and "goodsReceiptProcessingCode" have to be provided

    • besides of the old attributes "goodsReceiptProcessingType" and "goodsReceiptProcessingCode" a new optional attribute "quantity" has been introduced

    • for the attribute "goodsReceiptProcessingType" an enum has been introduced

    • the attribute "positionId" has been renamed to "deliveryPositionId"

    • the attribute "positionNumber" has been renamed to "deliveryPositionNumber"

    • the attribute "sku" has been removed

    • for the attribute "qualityCheck" an enum has been introduced

    • for the attribute "processEndCode" an enum has been introduced

    • new attributes have been introduced: "originalGoodsInId" (optional), "carrier" (optional), ownerCompany (mandatory)

Hint: The "…​Code" attributes should be filled with the WMS specific codes also known by the users in the warehouse. These will be presented in the data mart reports (BI). Here no enum will be defined as this code is WMS specific.

4.2.7. Schema

Interface FINE to ERP
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://cobra.ov.otto.de/json-schemas/goodsReceipts",
  "title": "ERP goods receipt messages",
  "description": "This document describes the goods receipt messages that FINE sends to the ERPs.",
  "required": [
    "eventId",
    "traceId",
    "spanId",
    "eventTime",
    "version",
    "context",
    "eventType",
    "metaData",
    "data"
  ],
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "customDateTimePattern": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
      "customTimezone": "Europe/Berlin",
      "description": "Time at which this record (event) was technically generated in RFC3339 format with timezone in local time.  Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
      "examples": [
        "2023-04-12T16:06:05.036+01:00"
      ]
    },
    "version": {
      "title": "The number of version schema",
      "description": "Number of version of this data structure. Sematic specification (String with major & minor nr)",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "examples": [
        "1.0",
        "1.5",
        "2.0"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The context specified here means the business domain.",
      "enum": [
        "GOODS_IN"
      ],
      "examples": [
        "GOODS_IN"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "enum": [
        "DELIVERY_NOTE_REGISTRATION_END",
        "GOODSRECEIPT_START",
        "GOODSRECEIPT_END",
        "DELIVERY_COMPARISON_START",
        "DELIVERY_COMPARISON_END",
        "RELEASE_END"
      ],
      "examples": [
        "DELIVERY_NOTE_REGISTRATION_END"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta information",
      "description": "can be used with different characteristics for technical data per interface",
      "properties": {
        "sender": {
          "title": "sender",
          "description": "Name of the source system, that has sent this message.",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/sender.v3.schema.json"
        },
        "client": {
          "type": "string",
          "title": "client",
          "description": "Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea...). List of values: https://docs.osp-fine.de/page/fine-common/00_meta_data/me02_global_enumerations/me02_global_enumerations/#_enum_company"
        },
        "instance": {
          "type": "string",
          "title": "Software instance of producing system",
          "description": "Name of the source instance that generated this data. Used for example to distinguish between different Test Instances."
        }
      },
      "required": [
        "sender"
      ]
    },
    "data": {
      "$ref": "#/definitions/data"
    }
  },
  "definitions": {
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "The sending warehouse (cobra sends data for different warehouses), List of allowed values will be defined and documented #url",
          "title": "The sending warehouse",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
        },
        "businessEventTime": {
          "description": "the date and time, when the business event occurred, in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
          "type": "string",
          "format": "date-time",
          "customDateTimePattern": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
          "customTimezone": "Europe/Berlin",
          "title": "The date and time, when the business event occurred",
          "examples": [
            "2022-03-31T12:41:06.036+01:00"
          ]
        },
        "goodsInId": {
          "description": "the goods receipt technical key, generated by the wms. (Possible UUID but other identifier accepted)",
          "type": "string",
          "maxLength": 36,
          "title": "the goods receipt ID",
          "examples": [
            "1189582"
          ]
        },
        "originalGoodsInId": {
          "description": "the goods receipt technical key, generated by the wms. This ID is referencing the original Delivery (technical key) in case when goods arrive back from rework",
          "type": "string",
          "maxLength": 36,
          "title": "the original goods receipt ID",
          "examples": [
            "1189581"
          ]
        },
        "deliveryNumber": {
          "description": "the inbound delivery business key, generated by the wms",
          "type": "string",
          "maxLength": 36,
          "title": "the inbound delivery business key",
          "examples": [
            "1189582"
          ]
        },
        "deliveryTypeCode": {
          "description": "Identification of the type of entry/delivery type {manual, automatic entry, DLW, return, transfer, WE from post-processing, WE without goods, etc.} Only the known forms of the WMS are delivered.",
          "type": "string",
          "maxLength": 50,
          "title": "Identification of the type of entry/delivery",
          "example": [
            "MANUAL",
            "WE_WITHOUT_GOODS",
            "1",
            "6"
          ]
        },
        "deliveryType": {
          "description": "the type of the delivery (from supplier, DLW, returns, postprocessing, without goods...)",
          "type": "string",
          "title": "Type of the delivery",
          "enum": [
            "GOODSIN_SUPPLIER",
            "GOODSIN_FROM_REWORK",
            "GOODSIN_FOR_BOOKING_AND_RELEASE",
            "GOODSIN_FOR_REMOVAL",
            "GOODSIN_INCOMPLETE",
            "GOODSIN_DLW",
            "GOODSIN_FOR_RELEASE",
            "GOODSIN_POST_PROCESSING",
            "GOODSIN_FROM_MAPPER",
            "GOODSIN_SECOND_CHOICE",
            "GOODSIN_STATIONARY_TRADE",
            "GOODSIN_SMALLPARTS",
            "GOODSIN_CANCELATION",
            "GOODSIN_RELABEL",
            "GOODSIN_B2B",
            "GOODSIN_FROM_RETAIL",
            "GOODSIN_3RD_PARTY"
          ]
        },
        "carrier": {
          "description": "name of the carrier transporting goods",
          "type": "string",
          "maxLength": 100,
          "title": "name of the carrier transporting goods",
          "examples": [
            "HG",
            "DHL"
          ]
        },
        "gates": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "door": {
                "description": "The gate, door no where the truck arrives",
                "type": "string",
                "maxLength": 10,
                "title": "Gate or Door number",
                "examples": [
                  "8"
                ]
              },
              "building": {
                "description": "The building where the truck arrives",
                "type": "string",
                "maxLength": 3,
                "title": "Building",
                "examples": [
                  "N/A"
                ]
              }
            }
          }
        },
        "processingInformation": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/processingInformationType"
          }
        },
        "positions": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/goodsReceiptPosition"
          }
        }
      },
      "required": [
        "location",
        "businessEventTime",
        "goodsInId",
        "deliveryNumber",
        "deliveryType"
      ],
      "additionalProperties": false
    },
    "processingInformationType": {
      "type": "object",
      "properties": {
        "goodsReceiptProcessingType": {
          "description": "Pallets/hatch detection, palletized, loose, loose, DLW.... List of allowed values will be defined and documented #url ",
          "type": "string",
          "title": "Pallets/hatch detection",
          "enum": [
            "PALLETED_SORTED",
            "PALLETED_UNSORTED",
            "CARTONS_SORTED",
            "CARTONS_UNSORTED",
            "SANDWICH_PALLET",
            "PULK_2MH",
            "DLW",
            "ITEMS_UNSORTED",
            "ITEMS_UNSORTED_FROM_KEP",
            "CARTONS_UNSORTED_FROM_KEP",
            "NON_TRADE_ITEMS"
          ]
        },
        "goodsReceiptProcessingCode": {
          "description": "Differentiation according to pallet/hatch detection, or in the case of Cobra: differentiation according to palletized/loose, loose, DLW, etc. WMS internal codes are transferred in this attribute",
          "type": "string",
          "title": "Pallet/hatch detection code",
          "examples": [
            "W"
          ]
        },
        "quantity": {
          "description": "the received quantity for this processing type",
          "type": "integer",
          "maximum": 99999999999999,
          "minimum": 0,
          "title": "Quantity received for this processing type",
          "examples": [
            90
          ]
        }
      },
      "required": [
        "goodsReceiptProcessingType",
        "goodsReceiptProcessingCode"
      ],
      "additionalProperties": false
    },
    "goodsReceiptPosition": {
      "type": "object",
      "properties": {
        "deliveryPositionId": {
          "description": "Unique ID of the position. Can be a number from a sequence, a UUID or a combination of GoodsInId + PositionNumber",
          "type": "string",
          "maxLength": 36,
          "title": "Position Id",
          "examples": [
            "12313"
          ]
        },
        "deliveryPositionNumber": {
          "description": "position number - incremental number (identifier) of the delivery position",
          "type": "integer",
          "maximum": 99999999999999,
          "title": "Position number",
          "examples": [
            1233413
          ]
        },
        "quantity": {
          "description": "the received quantity for this item size according to the delivery note",
          "type": "integer",
          "maximum": 99999999999999,
          "minimum": 0,
          "title": "Quantity received",
          "examples": [
            90
          ]
        },
        "arrivedToReworkerQuantity": {
          "description": "the received quantity by the external reworker for this item size according to the delivery note",
          "type": "integer",
          "maximum": 99999999999999,
          "minimum": 0,
          "title": "Quantity received by the external reworker",
          "examples": [
            90
          ]
        },
        "destroyedByReworkerQuantity": {
          "description": "the destroyed quantity for this item size by the external reworker",
          "type": "integer",
          "maximum": 99999999999999,
          "minimum": 0,
          "title": "Quantity destroyed by the external reworker",
          "examples": [
            90
          ]
        },
        "loadingUnitQuantity": {
          "description": "the amount of the goods quantity per loading unit",
          "type": "integer",
          "maximum": 99999999999999,
          "minimum": 0,
          "title": "Amount of goods",
          "examples": [
            9
          ]
        },
        "supplierNumber": {
          "description": "the number of supplier",
          "type": "integer",
          "maximum": 999999,
          "title": "Supplier Number",
          "examples": [
            648052
          ]
        },
        "reworkerSupplierNumber": {
          "description": "the number of the external reworker as supplier",
          "type": "integer",
          "maximum": 999999,
          "title": "External reworker supplier number",
          "examples": [
            625221
          ]
        },
        "documentNumber": {
          "description": "for new goods deliveries this ist the goods receipt/goods acceptance protocol (WAP) number for this delivery entry generated from number range dependent on warehouse",
          "type": "integer",
          "minimum": 100000,
          "maximum": 999999,
          "title": "Document number",
          "examples": [
            484052
          ]
        },
        "ownerCompany": {
          "type": "string",
          "title": "Owner Company (BDF)",
          "description": "stock-owner company for the product. List of values: https://docs.osp-fine.de/page/fine-common/00_meta_data/me02_global_enumerations/me02_global_enumerations/#_enum_company"
        },
        "hermesTourNumber": {
          "description": "the hermes tour number",
          "type": "string",
          "maxLength": 12,
          "title": "Hermes number",
          "examples": [
            "SGH222010043"
          ]
        },
        "customsShipmentNumber": {
          "description": "shipment no from c@ts",
          "type": "string",
          "title": "Custom shipment Number",
          "examples": [
            "804f2105-e5b7-4295-a6ae-02cc1cdc9c04"
          ]
        },
        "airWayBill": {
          "description": "Air Way Bill (Luftfrachtbrief)",
          "type": "string",
          "maxLength": 30,
          "title": "Custom shipment Number",
          "examples": [
            "SGH122020263"
          ]
        },
        "positionDetails": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/positionDetails"
          }
        },
        "product": {
          "$ref": "#/definitions/product"
        },
        "qualityCheck": {
          "description": "with goods inspection, without goods inspection, subsequent goods inspection. List of allowed values will be defined and documented #url",
          "type": "string",
          "maxLength": 50,
          "title": "Type of Quality Check",
          "enum": [
            "NO_QUALITY_CHECK",
            "NORMAL_QUALITY_CHECK",
            "DOWNSTREAM_QUALITY_CHECK"
          ]
        },
        "qualityCode": {
          "description": "quality code no from goods inspection (WACH)",
          "type": "integer",
          "maximum": 999,
          "title": "Quantity code number Goods inspection",
          "examples": [
            0
          ]
        },
        "damagedQuantity": {
          "description": "damaged quantity from transport (BI2), in COBRA always 0, damaged items will be booked additionally, in partno 1 set the qty for the complete item size",
          "type": "integer",
          "maximum": 999999,
          "title": "Quantity items damaged",
          "examples": [
            0
          ]
        },
        "processEndDate": {
          "description": "release date as YYYY-MM-DD",
          "type": "string",
          "title": "Process End Date",
          "examples": [
            "2016-04-16"
          ]
        },
        "processEndCode": {
          "description": "ReturnKz/ReleaseCode = result of the activation process. List of allowed values will be defined and documented #url",
          "type": "string",
          "title": "Process End Code",
          "enum": [
            "RELEASE",
            "CANCELLATION",
            "RETURN",
            "REWORK",
            "DESTROY",
            "THIRD_PARTY_SALE"
          ]
        },
        "erpDeliveryNo": {
          "description": "Liefernummer im ERP_System",
          "type": "string",
          "title": "Erp Deliver Number",
          "examples": [
            "3291147085"
          ]
        },
        "qualitySampleRequestMode": {
          "description": "Art der Musterberechnung. ONLINE=WACH/LIGIS, OFFLINE=claculated by the WMS",
          "type": "string",
          "title": "Sample size calculation mode",
          "enum": [
            "ONLINE",
            "OFFLINE"
          ]
        },
        "qualitySampleDischargeMode": {
          "description": "Zeitpunkt der Musterentnahme: sofort/vorgelagert, nachgelagert, umgewandelt",
          "type": "string",
          "title": "Direktausschleusung",
          "enum": [
            "IMMEDIATE",
            "DEFERRED",
            "CONVERTED"
          ]
        },
        "deliveryComparisonResult": {
          "description": "Ergebnis des Abgleiches Soll/Ist",
          "type": "string",
          "title": "Comparison result",
          "enum": [
            "DIFFERENCE",
            "NO_DIFFERENCE",
            "NO_COMPARISON"
          ]
        }
      },
      "required": [
        "deliveryPositionId",
        "quantity",
        "supplierNumber",
        "product",
        "documentNumber",
        "ownerCompany"
      ],
      "additionalProperties": false
    },
    "product": {
      "type": "object",
      "properties": {
        "erpProductId": {
          "description": "master communication key",
          "type": "string",
          "maxLength": 36,
          "title": "ERP Product Id",
          "examples": [
            "123"
          ]
        },
        "logisticsProductId": {
          "description": "master communication key",
          "type": "string",
          "maxLength": 36,
          "title": "Logistics Product Id",
          "examples": [
            "123"
          ]
        }
      },
      "required": [
        "erpProductId",
        "logisticsProductId"
      ],
      "additionalProperties": false
    },
    "positionDetails": {
      "type": "object",
      "properties": {
        "purchaseOrderNumber": {
          "description": "purchaseOrderNumber",
          "type": "string",
          "maxLength": 36,
          "title": "Purchase Order Number",
          "examples": [
            "105791"
          ]
        },
        "deliveryNoteNumber": {
          "description": "the corresponding Id in the erp system",
          "type": "string",
          "maxLength": 36,
          "title": "Delivery Note Number",
          "examples": [
            "22020176_648052"
          ]
        },
        "storageNotificationId": {
          "description": "Storage Notification Id",
          "title": "Storage Notification Id",
          "type": "string",
          "maxLength": 36
        },
        "quantity": {
          "description": "the quantity of the referenced PositionDetail within the position",
          "type": "number"
        },
        "electronicDeliveryNotePositionId": {
          "description": "list of delivery note positions",
          "type": "array",
          "title": "Electronic Delivery Note Position",
          "items": {
            "type": "string",
            "example": [
              "HG_22020176_648052",
              "LSB_12345667_987654332"
            ]
          }
        },
        "deliveryPositionDetailId": {
          "description": "unique ID of the position detail",
          "type": "string",
          "maxLength": 36,
          "title": "Position Detail Id",
          "examples": [
            "12313"
          ]
        },
        "sourceLocation": {
          "description": "Where does the stock originally come from",
          "type": "string",
          "title": "Source/Original location",
          "example": ["54513210"]
        }
      },
      "required": [
        "purchaseOrderNumber"
      ],
      "additionalProperties": false
    },
    "examples": [
      {
        "eventId": "00ce536f-923a-42f4-8128-be118faf1d87",
        "traceId": "00ce536f-923a-42f4-8128-be118faf1d85",
        "spanId": "00ce536f-923a-42f4-8128-be118faf1d85",
        "eventTime": "2022-03-31T12:41:06.036+01:00",
        "version": "2.2",
        "context": "GOODS_IN",
        "eventType": "RELEASE_END",
        "metaData" : {
          "sender": "FINE_INBOUND",
          "client": "FBO",
          "instance": "ILO_INT2"
        },
        "data": {
          "location": "ILOWA",
          "businessEventTime": "2022-03-31T12:41:06.036+01:00",
          "goodsInId": "1368329",
          "deliveryNumber": "1189582",
          "deliveryTypeCode": "1",
          "deliveryType": "GOODSIN_SUPPLIER",
          "carrier": "Hermes Germany",
          "gates": [
            {
              "building": "1",
              "door": "8"
            }
          ],
          "processingInformation": [
            {
              "goodsReceiptProcessingType": "PALLETED_SORTED",
              "goodsReceiptProcessingCode": "W",
              "quantity": 12
            }
          ],
          "positions": [
            {
              "deliveryPositionId": "123123",
              "deliveryPositionNumber": 123456,
              "quantity": 90,
              "loadingUnitQuantity": 9,
              "supplierNumber": 648052,
              "reworkerSupplierNumber": 588411,
              "documentNumber": 483512,
              "ownerCompany": "OTTO",
              "hermesTourNumber": "SGH222010043",
              "customsShipmentNumber": "",
              "airWayBill": "",
              "positionDetails": [
                {
                  "purchaseOrderNumber": "105791",
                  "deliveryNoteNumber": "22020176_648052",
                  "storageNotificationId": "",
                  "quantity": 90,
                  "electronicDeliveryNotePositionId": [
                    "HG_22020176_648052",
                    "LSB_12345667_987654332"
                  ],
                  "deliveryPositionDetailId": "51984510"
                }
              ],
              "product": {
                "erpProductId": "1245874412",
                "logisticsProductId": "1245874412"
              },
              "qualityCheck": "DOWNSTREAM_QUALITY_CHECK",
              "qualityCode": 100,
              "damagedQuantity": 0,
              "processEndDate": "2023-04-16",
              "processEndCode": "RELEASE",
              "erpDeliveryNo": "3291147085",
              "qualitySampleRequestMode": "ONLINE",
              "qualitySampleDischargeMode": "DEFERRED",
              "deliveryComparisonResult": "DIFFERENCE"
            }
          ]
        }
      }
    ]
  }
}

2.26 - I05 Quality Sample Request

Status

Version 1.0 published 26.05.2022

Approval
Comment
Assumption

_

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

QS

InterfaceOwner

Producer

kMotion

Producer

KR1

Producer

COBRA

Consumer

Lionfish

2. Business Context

Nach der Lieferscheinerfassung im Wareneingang muss die Prüfmenge ermittelt werden für die Qualitätsprüfung. Das LVS sendet eine Musterziehungsanfrage über und erhält die Prüfmenge oder bei Außenprüfung bereits ein Prüfergebnis zurück. Das Lager versendet die Ware physisch zur Prüfung. Nach Abschluss der Warenprüfung sendet das Warenprüfungssystem das Ergebnis an das LVS und das BI -System.

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

context

QUALITY_SAMPLE_REQUEST

type

Vorläufige

Zweite Prüfmenge

Storno

Entgültig

4.1.2. Datamodel

Property Type Description

(Root)

object

QSRequestWms
Request vom WMS an FINE-QS

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender

string

The name of sender = producer
Name of the source system, which has generated this data.

Maximum Length: 30

        instance

string

SW-Instance of the producing system
Name of the source instance, which has generated this data

Maximum Length: 36

        client

string

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

    data*

object

        location*

string

Request location
Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD

Minimum Length: 3
Maximum Length: 30

        requestType*

string

Request type
PRELIMINARY, SECONDLOT, FINAL, CANCELLATION

Maximum Length: 60

        deliveryDate*

string (date)

Delivery Date
Datum der Anlieferung

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Positionen

Minimum number of items 1
Unique Items: true

            (Array item)

object

Additional Properties: false

                product*

object

                    logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

                partnerId

string

Partner Id
Bestandsfirma (lt. Artikelstamm)

Minimum Length: 1
Maximum Length: 7

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                purchaseOrderNumber*

integer

Purchase order number
Auftragsnummer (OVA)

Maximum Length: 20

                externalQualityCode*

string

External quality code
Aussenpruefkennziffer. Enum wird definiert: Keine (-), Aussengeprueft (A), Selbstpruefer (S), Identifizieren (I)

Maximum Length: 30

                deliveryQuantity*

number

Delivery quantity
Liefermenge

                storageNotificationId

string

Storage Notification Id
Technical key

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

4.1.3. Enumeration

Field: tbd

Table 2. tbd
Meta Value Description Short Value

4.1.4. Example

Message WMS to FINE
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "SAMPLE_REQUEST",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "QS",
  "metaData": {
    "sender": "kMotion",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "ILOWA",
    "requestType": "PRELIMINARY",
    "deliveryDate": "2020-12-21",
    "deliveryNumber": 0,
    "positions": [
      {
        "product": {
          "logisticsProductId": "1234567890"
        },
        "supplierNumber": 1,
        "partnerId": "0",
        "receivingDocumentNumber": 123,
        "purchaseOrderNumber": 123,
        "externalQualityCode": "A",
        "deliveryQuantity": 4,
        "storageNotificationId": "305106fa-2068-44b9-bca2-5afaed6f5090",
        "wmsPositionId": "4552140011"
      }
    ]
  }
}

4.1.5. Schema

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

current version

1.0

Download

26.05.2022

previous version

coming version

Interface WMS to FINE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "QSRequestWms",
  "description": "Request vom WMS an FINE-QS",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "maxLength": 36,
      "description": "The optional context specified here means the business domain.",
      "examples": [
        "QS"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "SAMPLE_REQUEST"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta information",
      "description": "optional, can be used with different characteristics for technical data per interface",
      "properties": {
        "sender": {
          "type": "string",
          "maxLength": 30,
          "examples": [
            "KR1",
            "ADD"
          ],
          "title": "The name of sender = producer",
          "description": "Name of the source system, which has generated this data."
        },
        "instance": {
          "type": "string",
          "examples": [
            "kMotion-ILO",
            "kMotion-GERNSHEIM"
          ],
          "maxLength": 36,
          "title": "SW-Instance of the producing system",
          "description": "Name of the source instance, which has generated this data"
        },
        "client": {
          "type": "string",
          "title": "Client / Tenant",
          "description": "the client (messages of different clients have different processing rules and destination interfaces)",
          "examples": [
            "KONZERN",
            "OTTO",
            "MYTOYS"
          ]
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD"
          ]
        },
        "requestType": {
          "description": "PRELIMINARY, SECONDLOT, FINAL, CANCELLATION",
          "type": "string",
          "title": "Request type",
          "maxLength": 60,
          "examples": [
            "PRELIMINARY",
            "SECONDLOT",
            "FINAL",
            "CANCELLATION"
          ]
        },
        "deliveryDate": {
          "description": "Datum der Anlieferung",
          "type": "string",
          "format": "date",
          "title": "Delivery Date",
          "examples": [
            "2022-03-22"
          ]
        },
        "deliveryNumber": {
          "description": "Nummer der Anlieferung",
          "type": "string",
          "title": "Delivery Number",
          "maxLength": 36,
          "examples": [
            "1"
          ]
        },
        "positions": {
          "description": "Positionen",
          "type": "array",
          "uniqueItems": true,
          "minItems": 1,
          "items": {
            "$ref": "#/$defs/QSRequestPos"
          }
        }
      },
      "required": [
        "location",
        "requestType",
        "deliveryDate",
        "deliveryNumber",
        "positions"
      ]
    }
  },
  "$defs": {
    "QSRequestPos": {
      "type": "object",
      "properties": {
        "product": {
          "type": "object",
          "properties": {
            "logisticsProductId": {
              "description": "FINE-LSAS Logistics Product Identifier.",
              "type": "string",
              "maxLength": 50,
              "title": "Logistics product Id",
              "examples": [
                "45896254"
              ]
            }
          },
          "required": [
            "logisticsProductId"
          ]
        },
        "supplierNumber": {
          "description": "Lieferantenkennziffer",
          "type": "integer",
          "title": "Supplier number",
          "examples": [
            1
          ],
          "maxLength": 6,
          "minLength": 1
        },
        "partnerId": {
          "description": "Bestandsfirma (lt. Artikelstamm)",
          "type": "string",
          "maxLength": 7,
          "minLength": 1,
          "title": "Partner Id",
          "examples": [
            "12"
          ]
        },
        "receivingDocumentNumber": {
          "description": "Warenannahmeprotokoll (WAP) Nummer",
          "type": "integer",
          "title": "Receiving document number",
          "examples": [
            12
          ],
          "maxLength": 20
        },
        "purchaseOrderNumber": {
          "description": "Auftragsnummer (OVA)",
          "type": "integer",
          "title": "Purchase order number",
          "examples": [
            12
          ],
          "maxLength": 20
        },
        "externalQualityCode": {
          "description": "Aussenpruefkennziffer. Enum wird definiert: Keine (-), Aussengeprueft (A), Selbstpruefer (S), Identifizieren (I)",
          "type": "string",
          "title": "External quality code",
          "maxLength": 30,
          "examples": [
            "-",
            "A",
            "S",
            "I"
          ]
        },
        "deliveryQuantity": {
          "description": "Liefermenge",
          "type": "number",
          "title": "Delivery quantity",
          "examples": [
            12
          ]
        },
        "storageNotificationId": {
          "description": "Technical key",
          "type": "string",
          "title": "Storage Notification Id",
          "maxLength": 36,
          "examples": [
            "305106fa-2068-44b9-bca2-5afaed6f5090"
          ]
        },
        "wmsPositionId": {
          "description": "LVS VorgangsID",
          "type": "string",
          "title": "LVS VorgangsID",
          "maxLength": 36,
          "examples": [
            "45880014",
            "390b8b08-20b9-11ed-861d-0242ac120002"
          ]
        }
      },
      "required": [
        "product",
        "supplierNumber",
        "receivingDocumentNumber",
        "purchaseOrderNumber",
        "externalQualityCode",
        "deliveryQuantity",
        "wmsPositionId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "SAMPLE_REQUEST",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "QS",
      "metaData": {
        "sender": "kMotion",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "requestType": "PRELIMINARY",
        "deliveryDate": "2020-12-21",
        "deliveryNumber": 0,
        "positions": [
          {
            "product": {
              "logisticsProductId": "1234567890"
            },
            "supplierNumber": 1,
            "partnerId": "0",
            "receivingDocumentNumber": 123,
            "purchaseOrderNumber": 123,
            "externalQualityCode": "A",
            "deliveryQuantity": 4,
            "storageNotificationId": "305106fa-2068-44b9-bca2-5afaed6f5090",
            "wmsPositionId": "4552140011"
          }
        ]
      }
    }
  ]
}

4.2. Direction FINE to ERP

4.2.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 4. Attribute
Fieldname Expresion

context

QUALITY_SAMPLE_REQUEST

type

Vorläufige

Zweite Prüfmenge

Storno

Entgültig

4.2.2. Datamodel

Property Type Description

(Root)

object

QSRequestErp
Request von FINE-QS das ERP

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender

string

The name of sender = producer
Name of the source system, which has generated this data.

Maximum Length: 30

        instance

string

SW-Instance of the producing system
Name of the source instance, which has generated this data

Maximum Length: 36

        client

string

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

    data*

object

        location*

string

Request location
Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD

Minimum Length: 3
Maximum Length: 30

        requestType*

string

Request type
PRELIMINARY, SECONDLOT, FINAL, CANCELLATION

Maximum Length: 60

        deliveryDate*

string (date)

Delivery Date
Datum der Anlieferung

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Positionen

Minimum number of items 1
Unique Items: true

            (Array item)

object

Additional Properties: false

                product*

object

                    erpProductId*

string

Erp product Id
FINE-LSAS ERP Product Identifier.

Maximum Length: 50

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

                partnerId

string

Partner Id
Bestandsfirma (lt. Artikelstamm)

Minimum Length: 1
Maximum Length: 7

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                purchaseOrderNumber*

integer

Purchase order number
Auftragsnummer (OVA)

Maximum Length: 20

                externalQualityCode*

string

External quality code
Aussenpruefkennziffer. Enum wird definiert: Keine (-), Aussengeprueft (A), Selbstpruefer (S), Identifizieren (I)

Maximum Length: 30

                deliveryQuantity*

number

Delivery quantity
Liefermenge

                storageNotificationId

string

Storage Notification Id
Technical key

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

4.2.3. Enumeration

Field: tbd

Table 5. tbd

Meta Value

Description

Short Value

4.2.4. Example

Message FINE to ERP
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "SAMPLE_REQUEST",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "QS",
  "metaData": {
    "sender": "kMotion",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "ILOWA",
    "requestType": "PRELIMINARY",
    "deliveryDate": "2020-12-21",
    "deliveryNumber": 0,
    "positions": [
      {
        "product": {
          "erpProductId": "1234567890"
        },
        "supplierNumber": 1,
        "partnerId": "0",
        "receivingDocumentNumber": 123,
        "purchaseOrderNumber": 123,
        "externalQualityCode": "A",
        "deliveryQuantity": 4,
        "storageNotificationId": "305106fa-2068-44b9-bca2-5afaed6f5090",
        "wmsPositionId": "4552140011"
      }
    ]
  }
}

4.2.5. Schema

Table 6. Version FINE to ERP
Version Number File Published on Changes

current version

1.0

Download

26.05.2022

previous version

coming version

Interface FINE to ERP
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "QSRequestErp",
  "description": "Request von FINE-QS das ERP",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "maxLength": 36,
      "description": "The optional context specified here means the business domain.",
      "examples": [
        "QS"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "SAMPLE_REQUEST"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta information",
      "description": "optional, can be used with different characteristics for technical data per interface",
      "properties": {
        "sender": {
          "type": "string",
          "maxLength": 30,
          "examples": [
            "KR1",
            "ADD"
          ],
          "title": "The name of sender = producer",
          "description": "Name of the source system, which has generated this data."
        },
        "instance": {
          "type": "string",
          "examples": [
            "kMotion-ILO",
            "kMotion-GERNSHEIM"
          ],
          "maxLength": 36,
          "title": "SW-Instance of the producing system",
          "description": "Name of the source instance, which has generated this data"
        },
        "client": {
          "type": "string",
          "title": "Client / Tenant",
          "description": "the client (messages of different clients have different processing rules and destination interfaces)",
          "examples": [
            "KONZERN",
            "OTTO",
            "MYTOYS"
          ]
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD"
          ]
        },
        "requestType": {
          "description": "PRELIMINARY, SECONDLOT, FINAL, CANCELLATION",
          "type": "string",
          "title": "Request type",
          "maxLength": 60,
          "examples": [
            "PRELIMINARY",
            "SECONDLOT",
            "FINAL",
            "CANCELLATION"
          ]
        },
        "deliveryDate": {
          "description": "Datum der Anlieferung",
          "type": "string",
          "format": "date",
          "title": "Delivery Date",
          "examples": [
            "2022-03-22"
          ]
        },
        "deliveryNumber": {
          "description": "Nummer der Anlieferung",
          "type": "string",
          "title": "Delivery Number",
          "maxLength": 36,
          "examples": [
            "1"
          ]
        },
        "positions": {
          "description": "Positionen",
          "type": "array",
          "uniqueItems": true,
          "minItems": 1,
          "items": {
            "$ref": "#/$defs/QSRequestPos"
          }
        }
      },
      "required": [
        "location",
        "requestType",
        "deliveryDate",
        "deliveryNumber",
        "positions"
      ]
    }
  },
  "$defs": {
    "QSRequestPos": {
      "type": "object",
      "properties": {
        "product": {
          "type": "object",
          "properties": {
            "erpProductId": {
              "description": "FINE-LSAS ERP Product Identifier.",
              "type": "string",
              "maxLength": 50,
              "title": "Erp product Id",
              "examples": [
                "45896254"
              ]
            }
          },
          "required": [
            "erpProductId"
          ]
        },
        "supplierNumber": {
          "description": "Lieferantenkennziffer",
          "type": "integer",
          "title": "Supplier number",
          "examples": [
            1
          ],
          "maxLength": 6,
          "minLength": 1
        },
        "partnerId": {
          "description": "Bestandsfirma (lt. Artikelstamm)",
          "type": "string",
          "maxLength": 7,
          "minLength": 1,
          "title": "Partner Id",
          "examples": [
            "12"
          ]
        },
        "receivingDocumentNumber": {
          "description": "Warenannahmeprotokoll (WAP) Nummer",
          "type": "integer",
          "title": "Receiving document number",
          "examples": [
            12
          ],
          "maxLength": 20
        },
        "purchaseOrderNumber": {
          "description": "Auftragsnummer (OVA)",
          "type": "integer",
          "title": "Purchase order number",
          "examples": [
            12
          ],
          "maxLength": 20
        },
        "externalQualityCode": {
          "description": "Aussenpruefkennziffer. Enum wird definiert: Keine (-), Aussengeprueft (A), Selbstpruefer (S), Identifizieren (I)",
          "type": "string",
          "title": "External quality code",
          "maxLength": 30,
          "examples": [
            "-",
            "A",
            "S",
            "I"
          ]
        },
        "deliveryQuantity": {
          "description": "Liefermenge",
          "type": "number",
          "title": "Delivery quantity",
          "examples": [
            12
          ]
        },
        "storageNotificationId": {
          "description": "Technical key",
          "type": "string",
          "title": "Storage Notification Id",
          "maxLength": 36,
          "examples": [
            "305106fa-2068-44b9-bca2-5afaed6f5090"
          ]
        },
        "wmsPositionId": {
          "description": "LVS VorgangsID",
          "type": "string",
          "title": "LVS VorgangsID",
          "maxLength": 36,
          "examples": [
            "45880014",
            "390b8b08-20b9-11ed-861d-0242ac120002"
          ]
        }
      },
      "required": [
        "product",
        "supplierNumber",
        "receivingDocumentNumber",
        "purchaseOrderNumber",
        "externalQualityCode",
        "deliveryQuantity",
        "wmsPositionId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "SAMPLE_REQUEST",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "QS",
      "metaData": {
        "sender": "kMotion",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "requestType": "PRELIMINARY",
        "deliveryDate": "2020-12-21",
        "deliveryNumber": 0,
        "positions": [
          {
            "product": {
              "erpProductId": "1234567890"
            },
            "supplierNumber": 1,
            "partnerId": "0",
            "receivingDocumentNumber": 123,
            "purchaseOrderNumber": 123,
            "externalQualityCode": "A",
            "deliveryQuantity": 4,
            "storageNotificationId": "305106fa-2068-44b9-bca2-5afaed6f5090",
            "wmsPositionId": "4552140011"
          }
        ]
      }
    }
  ]
}

2.27 - I06 Quality Sample Response

Status

Version 1.0 published 26.05.2022

Approval
Comment
Assumption

_

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

QS

InterfaceOwner

Producer

Lionfish

Consumer

kMotion

Consumer

KR1

Consumer

COBRA

2. Business Context

Nach der Lieferscheinerfassung im Wareneingang muss die Prüfmenge ermittelt werden für die Qualitätsprüfung. Das LVS sendet eine Musterziehungsanfrage über und erhält die Prüfmenge oder bei Außenprüfung bereits ein Prüfergebnis zurück. Das Lager versendet die Ware physisch zur Prüfung. Nach Abschluss der Warenprüfung sendet das Warenprüfungssystem das Ergebnis an das LVS und das BI -System.

3. Informationflow

flow

4. Interface

4.1. Direction ERP to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

context

QUALITY_SAMPLE_RESPONSE

type

Vorläufige

Zweite Prüfmenge

Storno

Entgültig

4.1.2. Datamodel

Property Type Description

(Root)

object

QSResponseErp
Response vom ERP an FINE-QS

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender

string

The name of sender = producer
Name of the source system, which has generated this data.

Maximum Length: 30

        instance

string

SW-Instance of the producing system
Name of the source instance, which has generated this data

Maximum Length: 36

        client

string

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

    data*

object

        location*

string

Request location
Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD

Minimum Length: 3
Maximum Length: 30

        deliveryDate*

string (date)

Delivery Date
Datum der Anlieferung

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Positionen

Minimum number of items 1
Unique Items: true

            (Array item)

object

Additional Properties: false

                product*

object

                    erpProductId*

string

Erp product Id
FINE-LSAS ERP Product Identifier.

Maximum Length: 50

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Maximum Length: 20

                partnerId

string

Partner Id
Bestandsfirma (lt. Artikelstamm)

Minimum Length: 1
Maximum Length: 10

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                purchaseOrderNumber*

integer

Purchase order number
Auftragsnummer (OVA)

Maximum Length: 20

                qualityCode*

integer

Quality code
Prüfergebnis. Bei 103 oder 110 --> manuelle Freigabe; Friegabe nur dann wenn qualityCode mit diesen Werten anfängt: 10,11,15,45,50,75

Maximum Length: 6

                checkPrecision*

string

Check precision
Prüfschärfe

Maximum Length: 10

                sampleQuantity*

integer

Sample quantity
Mustermenge

Maximum Length: 6

                inspectionId*

string

Inspection Id
Prüfauftrag Identifier

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

4.1.3. Enumeration

Field: tbd

Table 2. tbd
Meta Value Description Short Value

4.1.4. Example

Message ERP to FINE
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "SAMPLE_RESPONSE",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "QS",
  "metaData": {
    "sender": "kMotion",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "LANGENSELBOLD",
    "deliveryDate": "2020-12-21",
    "deliveryNumber": 12240,
    "positions": [
      {
        "product": {
          "erpProductId": "1234567890"
        },
        "supplierNumber": 1,
        "partnerId": "0",
        "receivingDocumentNumber": 123,
        "purchaseOrderNumber": 123,
        "qualityCode": 103,
        "checkPrecision": "",
        "sampleQuantity": 4,
        "inspectionId": "1234567890",
        "wmsPositionId": "4552140011"
      }
    ]
  }
}

4.1.5. Schema

Table 3. Version ERP to FINE
Version Number File Published on Changes

current version

1.0

Download

26.05.2022

previous version

coming version

Interface WMS to FINE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "QSResponseErp",
  "description": "Response vom ERP an FINE-QS",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "maxLength": 36,
      "description": "The optional context specified here means the business domain.",
      "examples": [
        "QS"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "SAMPLE_RESPONSE"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta information",
      "description": "optional, can be used with different characteristics for technical data per interface",
      "properties": {
        "sender": {
          "type": "string",
          "examples": [
            "KR1",
            "ADD"
          ],
          "title": "The name of sender = producer",
          "maxLength": 30,
          "description": "Name of the source system, which has generated this data."
        },
        "instance": {
          "type": "string",
          "examples": [
            "kMotion-ILO",
            "kMotion-GERNSHEIM"
          ],
          "maxLength": 36,
          "title": "SW-Instance of the producing system",
          "description": "Name of the source instance, which has generated this data"
        },
        "client": {
          "type": "string",
          "title": "Client / Tenant",
          "description": "the client (messages of different clients have different processing rules and destination interfaces)",
          "examples": [
            "KONZERN",
            "OTTO",
            "MYTOYS"
          ]
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD"
          ]
        },
        "deliveryDate": {
          "description": "Datum der Anlieferung",
          "type": "string",
          "format": "date",
          "title": "Delivery Date",
          "examples": [
            "2022-03-22"
          ]
        },
        "deliveryNumber": {
          "description": "Nummer der Anlieferung",
          "type": "string",
          "title": "Delivery Number",
          "maxLength": 36,
          "examples": [
            "1"
          ]
        },
        "positions": {
          "description": "Positionen",
          "type": "array",
          "uniqueItems": true,
          "minItems": 1,
          "items": {
            "$ref": "#/$defs/QSResponsePos"
          }
        }
      },
      "required": [
        "location",
        "deliveryDate",
        "deliveryNumber",
        "positions"
      ]
    }
  },
  "$defs": {
    "QSResponsePos": {
      "type": "object",
      "properties": {
        "product": {
          "type": "object",
          "properties": {
            "erpProductId": {
              "description": "FINE-LSAS ERP Product Identifier.",
              "type": "string",
              "maxLength": 50,
              "title": "Erp product Id",
              "examples": [
                "45896254"
              ]
            }
          },
          "required": [
            "erpProductId"
          ]
        },
        "supplierNumber": {
          "description": "Lieferantenkennziffer",
          "type": "integer",
          "title": "Supplier number",
          "examples": [
            1
          ],
          "maxLength": 20
        },
        "partnerId": {
          "description": "Bestandsfirma (lt. Artikelstamm)",
          "type": "string",
          "maxLength": 10,
          "minLength": 1,
          "title": "Partner Id",
          "examples": [
            "12"
          ]
        },
        "receivingDocumentNumber": {
          "description": "Warenannahmeprotokoll (WAP) Nummer",
          "type": "integer",
          "title": "Receiving document number",
          "examples": [
            12
          ],
          "maxLength": 20
        },
        "purchaseOrderNumber": {
          "description": "Auftragsnummer (OVA)",
          "type": "integer",
          "title": "Purchase order number",
          "examples": [
            12
          ],
          "maxLength": 20
        },
        "qualityCode": {
          "description": "Prüfergebnis. Bei 103 oder 110 --> manuelle Freigabe; Friegabe nur dann wenn qualityCode mit diesen Werten anfängt: 10,11,15,45,50,75",
          "type": "integer",
          "title": "Quality code",
          "maxLength": 6,
          "examples": [
            10,
            11,
            15
          ]
        },
        "checkPrecision": {
          "description": "Prüfschärfe",
          "type": "string",
          "maxLength": 10,
          "title": "Check precision",
          "examples": [
            "Y"
          ]
        },
        "sampleQuantity": {
          "description": "Mustermenge",
          "type": "integer",
          "title": "Sample quantity",
          "maxLength": 6,
          "examples": [
            12
          ]
        },
        "inspectionId": {
          "description": "Prüfauftrag Identifier",
          "type": "string",
          "title": "Inspection Id",
          "maxLength": 36,
          "examples": [
            "390c570e-20b9-11ed-861d-0242ac120002"
          ]
        },
        "wmsPositionId": {
          "description": "LVS VorgangsID",
          "type": "string",
          "title": "LVS VorgangsID",
          "maxLength": 36,
          "examples": [
            "45880014",
            "390b8b08-20b9-11ed-861d-0242ac120002"
          ]
        }
      },
      "required": [
        "product",
        "supplierNumber",
        "receivingDocumentNumber",
        "purchaseOrderNumber",
        "qualityCode",
        "checkPrecision",
        "sampleQuantity",
        "inspectionId",
        "wmsPositionId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "SAMPLE_RESPONSE",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "QS",
      "metaData": {
        "sender": "kMotion",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "LANGENSELBOLD",
        "deliveryDate": "2020-12-21",
        "deliveryNumber": 12240,
        "positions": [
          {
            "product": {
              "erpProductId": "1234567890"
            },
            "supplierNumber": 1,
            "partnerId": "0",
            "receivingDocumentNumber": 123,
            "purchaseOrderNumber": 123,
            "qualityCode": 103,
            "checkPrecision": "",
            "sampleQuantity": 4,
            "inspectionId": "1234567890",
            "wmsPositionId": "4552140011"
          }
        ]
      }
    }
  ]
}

4.2. Direction FINE to WMS

4.2.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 4. Attribute
Fieldname Expresion

context

QUALITY_SAMPLE_RESPONSE

type

Vorläufige

Zweite Prüfmenge

Storno

Entgültig

4.2.2. Datamodel

Property Type Description

(Root)

object

QSResponseWms
Response von FINE-QS an das WMS

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender

string

The name of sender = producer
Name of the source system, which has generated this data.

Maximum Length: 30

        instance

string

SW-Instance of the producing system
Name of the source instance, which has generated this data

Maximum Length: 36

        client

string

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

    data*

object

        location*

string

Request location
Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD

Minimum Length: 3
Maximum Length: 30

        deliveryDate*

string (date)

Delivery Date
Datum der Anlieferung

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Positionen

Minimum number of items 1
Unique Items: true

            (Array item)

object

Additional Properties: false

                product*

object

                    logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Maximum Length: 20

                partnerId

string

Partner Id
Bestandsfirma (lt. Artikelstamm)

Minimum Length: 1
Maximum Length: 10

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                purchaseOrderNumber*

integer

Purchase order number
Auftragsnummer (OVA)

Maximum Length: 20

                qualityCode*

integer

Quality code
Prüfergebnis. Bei 103 oder 110 --> manuelle Freigabe; Friegabe nur dann wenn qualityCode mit diesen Werten anfängt: 10,11,15,45,50,75

Maximum Length: 6

                checkPrecision*

string

Check precision
Prüfschärfe

Maximum Length: 10

                sampleQuantity*

integer

Sample quantity
Mustermenge

Maximum Length: 6

                inspectionId*

string

Inspection Id
Prüfauftrag Identifier

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

4.2.3. Enumeration

Field: tbd

Table 5. tbd

Meta Value

Description

Short Value

4.2.4. Example

Message FINE to WMS
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "SAMPLE_RESPONSE",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "QS",
  "metaData": {
    "sender": "kMotion",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "LANGENSELBOLD",
    "deliveryDate": "2020-12-21",
    "deliveryNumber": 12240,
    "positions": [
      {
        "product": {
          "logisticsProductId": "1234567890"
        },
        "supplierNumber": 1,
        "partnerId": "0",
        "receivingDocumentNumber": 123,
        "purchaseOrderNumber": 123,
        "qualityCode": 103,
        "checkPrecision": "",
        "sampleQuantity": 4,
        "inspectionId": "1234567890",
        "wmsPositionId": "4552140011"
      }
    ]
  }
}

4.2.5. Schema

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

current version

1.0

Download

26.05.2022

previous version

coming version

Interface FINE to WMS
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "QSResponseWms",
  "description": "Response von FINE-QS an das WMS",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "maxLength": 36,
      "description": "The optional context specified here means the business domain.",
      "examples": [
        "QS"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "SAMPLE_RESPONSE"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta information",
      "description": "optional, can be used with different characteristics for technical data per interface",
      "properties": {
        "sender": {
          "type": "string",
          "examples": [
            "KR1",
            "ADD"
          ],
          "title": "The name of sender = producer",
          "maxLength": 30,
          "description": "Name of the source system, which has generated this data."
        },
        "instance": {
          "type": "string",
          "examples": [
            "kMotion-ILO",
            "kMotion-GERNSHEIM"
          ],
          "maxLength": 36,
          "title": "SW-Instance of the producing system",
          "description": "Name of the source instance, which has generated this data"
        },
        "client": {
          "type": "string",
          "title": "Client / Tenant",
          "description": "the client (messages of different clients have different processing rules and destination interfaces)",
          "examples": [
            "KONZERN",
            "OTTO",
            "MYTOYS"
          ]
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD"
          ]
        },
        "deliveryDate": {
          "description": "Datum der Anlieferung",
          "type": "string",
          "format": "date",
          "title": "Delivery Date",
          "examples": [
            "2022-03-22"
          ]
        },
        "deliveryNumber": {
          "description": "Nummer der Anlieferung",
          "type": "string",
          "title": "Delivery Number",
          "maxLength": 36,
          "examples": [
            "1"
          ]
        },
        "positions": {
          "description": "Positionen",
          "type": "array",
          "uniqueItems": true,
          "minItems": 1,
          "items": {
            "$ref": "#/$defs/QSResponsePos"
          }
        }
      },
      "required": [
        "location",
        "deliveryDate",
        "deliveryNumber",
        "positions"
      ]
    }
  },
  "$defs": {
    "QSResponsePos": {
      "type": "object",
      "properties": {
        "product": {
          "type": "object",
          "properties": {
            "logisticsProductId": {
              "description": "FINE-LSAS Logistics Product Identifier.",
              "type": "string",
              "maxLength": 50,
              "title": "Logistics product Id",
              "examples": [
                "45896254"
              ]
            }
          },
          "required": [
            "logisticsProductId"
          ]
        },
        "supplierNumber": {
          "description": "Lieferantenkennziffer",
          "type": "integer",
          "title": "Supplier number",
          "examples": [
            1
          ],
          "maxLength": 20
        },
        "partnerId": {
          "description": "Bestandsfirma (lt. Artikelstamm)",
          "type": "string",
          "maxLength": 10,
          "minLength": 1,
          "title": "Partner Id",
          "examples": [
            "12"
          ]
        },
        "receivingDocumentNumber": {
          "description": "Warenannahmeprotokoll (WAP) Nummer",
          "type": "integer",
          "title": "Receiving document number",
          "examples": [
            12
          ],
          "maxLength": 20
        },
        "purchaseOrderNumber": {
          "description": "Auftragsnummer (OVA)",
          "type": "integer",
          "title": "Purchase order number",
          "examples": [
            12
          ],
          "maxLength": 20
        },
        "qualityCode": {
          "description": "Prüfergebnis. Bei 103 oder 110 --> manuelle Freigabe; Friegabe nur dann wenn qualityCode mit diesen Werten anfängt: 10,11,15,45,50,75",
          "type": "integer",
          "title": "Quality code",
          "maxLength": 6,
          "examples": [
            10,
            11,
            15
          ]
        },
        "checkPrecision": {
          "description": "Prüfschärfe",
          "type": "string",
          "maxLength": 10,
          "title": "Check precision",
          "examples": [
            "Y"
          ]
        },
        "sampleQuantity": {
          "description": "Mustermenge",
          "type": "integer",
          "title": "Sample quantity",
          "maxLength": 6,
          "examples": [
            12
          ]
        },
        "inspectionId": {
          "description": "Prüfauftrag Identifier",
          "type": "string",
          "title": "Inspection Id",
          "maxLength": 36,
          "examples": [
            "390c570e-20b9-11ed-861d-0242ac120002"
          ]
        },
        "wmsPositionId": {
          "description": "LVS VorgangsID",
          "type": "string",
          "title": "LVS VorgangsID",
          "maxLength": 36,
          "examples": [
            "45880014",
            "390b8b08-20b9-11ed-861d-0242ac120002"
          ]
        }
      },
      "required": [
        "product",
        "supplierNumber",
        "receivingDocumentNumber",
        "purchaseOrderNumber",
        "qualityCode",
        "checkPrecision",
        "sampleQuantity",
        "inspectionId",
        "wmsPositionId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "SAMPLE_RESPONSE",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "QS",
      "metaData": {
        "sender": "kMotion",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "LANGENSELBOLD",
        "deliveryDate": "2020-12-21",
        "deliveryNumber": 12240,
        "positions": [
          {
            "product": {
              "logisticsProductId": "1234567890"
            },
            "supplierNumber": 1,
            "partnerId": "0",
            "receivingDocumentNumber": 123,
            "purchaseOrderNumber": 123,
            "qualityCode": 103,
            "checkPrecision": "",
            "sampleQuantity": 4,
            "inspectionId": "1234567890",
            "wmsPositionId": "4552140011"
          }
        ]
      }
    }
  ]
}

2.28 - I07 Quality Result

Status

Version 1.0 published 18.10.2022

Approval
Comment
Assumption

_

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

QS

InterfaceOwner

Producer

Lionfish

Consumer

kMotion

Consumer

KR1

Consumer

COBRA

Consumer

FLASH

2. Business Context

Nach der Lieferscheinerfassung im Wareneingang muss die Prüfmenge ermittelt werden für die Qualitätsprüfung. Das LVS sendet eine Musterziehungsanfrage über und erhält die Prüfmenge oder bei Außenprüfung bereits ein Prüfergebnis zurück. Das Lager versendet die Ware physisch zur Prüfung. Nach Abschluss der Warenprüfung sendet das Warenprüfungssystem das Ergebnis an das LVS und das BI -System.

3. Informationflow

flow

4. Interface

4.1. Direction ERP to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

context

QUALITY_RESULT

CMS_RESULT

eventType

QUALITY_RESULT

CMS_RESULT

4.1.2. Datamodel

Property Type Description

(Root)

object

QSResultErp
Prüfergebnisse der Warenprüfung

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender

string

The name of sender = producer
Name of the source system, which has generated this data.

Maximum Length: 30

        instance

string

SW-Instance of the producing system
Name of the source instance, which has generated this data

        client

string

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

    data*

object

        location*

string

Request location
Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD

Minimum Length: 3
Maximum Length: 30

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        product*

object

            erpProductId*

string

Erp product Id
FINE-LSAS ERP Product Identifier.

Maximum Length: 50

        supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

        receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

        qualityCode*

integer

Quality code
Prüfergebnis. Bei 103 oder 110 --> manuelle Freigabe; Friegabe nur dann wenn qualityCode mit diesen Werten anfängt: 10,11,15,45,50,75

Maximum Length: 6

        resultCode*

string

Quality result code
Ergebnis der Warenprüfung. Mögliche Werte: APPROPRIATE, REWORK, RETURN, INADEQUATE

        rejectionCode

string

Rejection code
Beanstandungskennzeichen. Mögliche Werte: leer, F = Formale Fehler, S = Serienfehler, Q = Qualitätsfehler

Minimum Length: 1
Maximum Length: 1

        inspectionId

string

Inspection Id
Prüfauftrag Identifier

Maximum Length: 36

        wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

        resultQuantity

number

Result quantity
Optionale Ergebnismenge. Wenn nicht vorhanden, dann bezieht sich das Ergebnis auf die ganze Liefermenge. Mit dem Attribut kann man Prüfergebnisse bezugen auf eine Teilmenge übertragen

        cmsId

string

CMS Id
CMS Identifier

Maximum Length: 36

4.1.3. Enumeration

Field: Result Code

Table 2. resultCode
Meta Value Description Short Value

APPROPRIATE

Freischaltung - Qualität in Ordnung

INADEQUATE

Keine Freischaltung - Qualität nicht in Ordnung

RETURN

Rücksendung

REWORK

Nacharbeit

ONSTOCK

Freischaltung nach Claim (ggf. trotz Fehlerbild)

SCRAP

Verschrottung

THIRD_PARTY_SELLING

Sonderdrittverkauf

SECONDARY INSPECTION

Zweitprüfung

4.1.4. Example

Message ERP to FINE
{
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "QUALITY_RESULT",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "QS",
      "metaData": {
        "sender": "kMotion",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "deliveryNumber": 124404,
        "product": {
          "erpProductId": "1234567890"
        },
        "supplierNumber": 11148,
        "receivingDocumentNumber": 41123,
        "qualityCode": 103,
        "resultCode": "APPROPRIATE",
        "rejectionCode": "F",
        "inspectionId": "1234567890",
        "wmsPositionId": "4552140011"
      }
}

4.1.5. Schema

Table 3. Version ERP to FINE
Version Number File Published on Changes

current version

1.0

Download

26.05.2022

previous version

coming version

Interface WMS to FINE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "QSResultErp",
  "description": "Prüfergebnisse der Warenprüfung",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The optional context specified here means the business domain.",
      "maxLength": 36,
      "examples": [
        "QS"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "QUALITY_RESULT"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta information",
      "description": "optional, can be used with different characteristics for technical data per interface",
      "properties": {
        "sender": {
          "type": "string",
          "examples": [
            "KR1",
            "ADD"
          ],
          "title": "The name of sender = producer",
          "maxLength": 30,
          "description": "Name of the source system, which has generated this data."
        },
        "instance": {
          "type": "string",
          "examples": [
            "kMotion-ILO",
            "kMotion-GERNSHEIM"
          ],
          "title": "SW-Instance of the producing system",
          "description": "Name of the source instance, which has generated this data"
        },
        "client": {
          "type": "string",
          "title": "Client / Tenant",
          "description": "the client (messages of different clients have different processing rules and destination interfaces)",
          "examples": [
            "KONZERN",
            "OTTO",
            "MYTOYS"
          ]
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD"
          ]
        },
        "deliveryNumber": {
          "description": "Nummer der Anlieferung",
          "type": "string",
          "title": "Delivery Number",
          "maxLength": 36,
          "examples": [
            "1"
          ]
        },
        "product": {
          "type": "object",
          "properties": {
            "erpProductId": {
              "description": "FINE-LSAS ERP Product Identifier.",
              "type": "string",
              "maxLength": 50,
              "title": "Erp product Id",
              "examples": [
                "45896254"
              ]
            }
          },
          "required": [
            "erpProductId"
          ]
        },
        "supplierNumber": {
          "description": "Lieferantenkennziffer",
          "type": "integer",
          "title": "Supplier number",
          "examples": [
            1
          ],
          "maxLength": 6,
          "minLength": 1
        },
        "receivingDocumentNumber": {
          "description": "Warenannahmeprotokoll (WAP) Nummer",
          "type": "integer",
          "title": "Receiving document number",
          "examples": [
            12
          ],
          "maxLength": 20
        },
        "qualityCode": {
          "description": "Prüfergebnis. Bei 103 oder 110 --> manuelle Freigabe; Friegabe nur dann wenn qualityCode mit diesen Werten anfängt: 10,11,15,45,50,75",
          "type": "integer",
          "title": "Quality code",
          "maxLength": 6,
          "examples": [
            10,
            11,
            15
          ]
        },
        "resultCode": {
          "description": "Ergebnis der Warenprüfung. Mögliche Werte: APPROPRIATE, REWORK, RETURN, INADEQUATE",
          "type": "string",
          "title": "Quality result code",
          "examples": [
            "APPROPRIATE"
          ]
        },
        "rejectionCode": {
          "description": "Beanstandungskennzeichen. Mögliche Werte: leer, F = Formale Fehler, S = Serienfehler, Q = Qualitätsfehler",
          "type": "string",
          "maxLength": 1,
          "minLength": 1,
          "title": "Rejection code",
          "examples": [
            "F",
            "S",
            "Q"
          ]
        },
        "inspectionId": {
          "description": "Prüfauftrag Identifier",
          "type": "string",
          "title": "Inspection Id",
          "maxLength": 36,
          "examples": [
            "12"
          ]
        },
        "wmsPositionId": {
          "description": "LVS VorgangsID",
          "type": "string",
          "title": "LVS VorgangsID",
          "maxLength": 36,
          "examples": [
            "45880014",
            "390b8b08-20b9-11ed-861d-0242ac120002"
          ]
        },
        "resultQuantity": {
          "description": "Optionale Ergebnismenge. Wenn nicht vorhanden, dann bezieht sich das Ergebnis auf die ganze Liefermenge. Mit dem Attribut kann man Prüfergebnisse bezugen auf eine Teilmenge übertragen",
          "type": "number",
          "title": "Result quantity",
          "examples": [
            12
          ]
        },
        "cmsId": {
          "description": "CMS Identifier",
          "type": "string",
          "title": "CMS Id",
          "maxLength": 36,
          "examples": [
            "12"
          ]
        }
      },
      "required": [
        "location",
        "deliveryNumber",
        "product",
        "supplierNumber",
        "receivingDocumentNumber",
        "qualityCode",
        "resultCode",
        "wmsPositionId"
      ]
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "QUALITY_RESULT",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "QS",
      "metaData": {
        "sender": "kMotion",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "deliveryNumber": 124404,
        "product": {
          "erpProductId": "1234567890"
        },
        "supplierNumber": 11148,
        "receivingDocumentNumber": 41123,
        "qualityCode": 103,
        "resultCode": "APPROPRIATE",
        "rejectionCode": "F",
        "inspectionId": "1234567890",
        "wmsPositionId": "4552140011"
      }
    }
  ]
}

4.2. Direction FINE to WMS

4.2.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 4. Attribute
Fieldname Expresion

context

QUALITY_RESULT

CMS_RESULT

eventType

QUALITY_RESULT

CMS_RESULT

4.2.2. Datamodel

Property Type Description

(Root)

object

QSResultWms
Prüfergebnisse der Warenprüfung

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    metaData

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender

string

The name of sender = producer
Name of the source system, which has generated this data.

Maximum Length: 30

        instance

string

SW-Instance of the producing system
Name of the source instance, which has generated this data

        client

string

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

    data*

object

        location*

string

Request location
Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD

Minimum Length: 3
Maximum Length: 30

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

        product*

object

            logisticsProductId*

string

Logistics Product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

        supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

        receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

        qualityCode*

integer

Quality code
Prüfergebnis. Bei 103 oder 110 --> manuelle Freigabe; Friegabe nur dann wenn qualityCode mit diesen Werten anfängt: 10,11,15,45,50,75

Maximum Length: 6

        resultCode*

string

Quality result code
Ergebnis der Warenprüfung. Mögliche Werte: APPROPRIATE, REWORK, RETURN, INADEQUATE

        rejectionCode

string

Rejection code
Beanstandungskennzeichen. Mögliche Werte: leer, F = Formale Fehler, S = Serienfehler, Q = Qualitätsfehler

Minimum Length: 1
Maximum Length: 1

        inspectionId

string

Inspection Id
Prüfauftrag Identifier

Maximum Length: 36

        wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

        resultQuantity

number

Result quantity
Optionale Ergebnismenge. Wenn nicht vorhanden, dann bezieht sich das Ergebnis auf die ganze Liefermenge. Mit dem Attribut kann man Prüfergebnisse bezugen auf eine Teilmenge übertragen

        cmsId

string

CMS Id
CMS Identifier

Maximum Length: 36

4.2.3. Enumeration

Field: Result Code

Table 5. resultCode
Meta Value Description Short Value

APPROPRIATE

Freischaltung - Qualität in Ordnung

INADEQUATE

Keine Freischaltung - Qualität nicht in Ordnung

RETURN

Rücksendung

REWORK

Nacharbeit

ONSTOCK

Freischaltung nach Claim (ggf. trotz Fehlerbild)

SCRAP

Verschrottung

THIRD_PARTY_SELLING

Sonderdrittverkauf

SECONDARY INSPECTION

Zweitprüfung

4.2.4. Example

Message FINE to WMS
{
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "QUALITY_RESULT",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "QS",
      "metaData": {
        "sender": "kMotion",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "deliveryNumber": 124404,
        "product": {
          "logisticsProductId": "1234567890"
        },
        "supplierNumber": 11148,
        "receivingDocumentNumber": 41123,
        "qualityCode": 103,
        "resultCode": "APPROPRIATE",
        "rejectionCode": "F",
        "inspectionId": "1234567890",
        "wmsPositionId": "4552140011"
      }
}

4.2.5. Schema

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

current version

1.0

Download

26.05.2022

previous version

coming version

Interface FINE to WMS
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "QSResultWms",
  "description": "Prüfergebnisse der Warenprüfung",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "maxLength": 36,
      "title": "The uniq eventId",
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "traceId": {
      "type": "string",
      "maxLength": 36,
      "title": "The uniq traceId",
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "maxLength": 36,
      "description": "The optional context specified here means the business domain.",
      "examples": [
        "QS"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "QUALITY_RESULT"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta information",
      "description": "optional, can be used with different characteristics for technical data per interface",
      "properties": {
        "sender": {
          "type": "string",
          "examples": [
            "KR1",
            "ADD"
          ],
          "maxLength": 30,
          "title": "The name of sender = producer",
          "description": "Name of the source system, which has generated this data."
        },
        "instance": {
          "type": "string",
          "examples": [
            "kMotion-ILO",
            "kMotion-GERNSHEIM"
          ],
          "title": "SW-Instance of the producing system",
          "description": "Name of the source instance, which has generated this data"
        },
        "client": {
          "type": "string",
          "title": "Client / Tenant",
          "description": "the client (messages of different clients have different processing rules and destination interfaces)",
          "examples": [
            "KONZERN",
            "OTTO",
            "MYTOYS"
          ]
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Standort. Bsp. für Kmotion@LSB einen Festwert: LANGENSELBOLD",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD"
          ]
        },
        "deliveryNumber": {
          "description": "Nummer der Anlieferung",
          "type": "string",
          "title": "Delivery Number",
          "examples": [
            "1"
          ]
        },
        "product": {
          "type": "object",
          "properties": {
            "logisticsProductId": {
              "description": "FINE-LSAS Logistics Product Identifier.",
              "type": "string",
              "maxLength": 50,
              "title": "Logistics Product Id",
              "examples": [
                "45896254"
              ]
            }
          },
          "required": [
            "logisticsProductId"
          ]
        },
        "supplierNumber": {
          "description": "Lieferantenkennziffer",
          "type": "integer",
          "title": "Supplier number",
          "examples": [
            1
          ],
          "maxLength": 6,
          "minLength": 1
        },
        "receivingDocumentNumber": {
          "description": "Warenannahmeprotokoll (WAP) Nummer",
          "type": "integer",
          "title": "Receiving document number",
          "examples": [
            12
          ],
          "maxLength": 20
        },
        "qualityCode": {
          "description": "Prüfergebnis. Bei 103 oder 110 --> manuelle Freigabe; Friegabe nur dann wenn qualityCode mit diesen Werten anfängt: 10,11,15,45,50,75",
          "type": "integer",
          "title": "Quality code",
          "maxLength": 6,
          "examples": [
            10,
            11,
            15
          ]
        },
        "resultCode": {
          "description": "Ergebnis der Warenprüfung. Mögliche Werte: APPROPRIATE, REWORK, RETURN, INADEQUATE",
          "type": "string",
          "title": "Quality result code",
          "examples": [
            "APPROPRIATE"
          ]
        },
        "rejectionCode": {
          "description": "Beanstandungskennzeichen. Mögliche Werte: leer, F = Formale Fehler, S = Serienfehler, Q = Qualitätsfehler",
          "type": "string",
          "maxLength": 1,
          "minLength": 1,
          "title": "Rejection code",
          "examples": [
            "F",
            "S",
            "Q"
          ]
        },
        "inspectionId": {
          "description": "Prüfauftrag Identifier",
          "type": "string",
          "title": "Inspection Id",
          "maxLength": 36,
          "examples": [
            "12"
          ]
        },
        "wmsPositionId": {
          "description": "LVS VorgangsID",
          "type": "string",
          "title": "LVS VorgangsID",
          "maxLength": 36,
          "examples": [
            "45880014",
            "390b8b08-20b9-11ed-861d-0242ac120002"
          ]
        },
        "resultQuantity": {
          "description": "Optionale Ergebnismenge. Wenn nicht vorhanden, dann bezieht sich das Ergebnis auf die ganze Liefermenge. Mit dem Attribut kann man Prüfergebnisse bezugen auf eine Teilmenge übertragen",
          "type": "number",
          "title": "Result quantity",
          "examples": [
            12
          ]
        },
        "cmsId": {
          "description": "CMS Identifier",
          "type": "string",
          "title": "CMS Id",
          "maxLength": 36,
          "examples": [
            "12"
          ]
        }
      },
      "required": [
        "location",
        "deliveryNumber",
        "product",
        "supplierNumber",
        "receivingDocumentNumber",
        "qualityCode",
        "resultCode",
        "wmsPositionId"
      ]
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "QUALITY_RESULT",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "QS",
      "metaData": {
        "sender": "kMotion",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "deliveryNumber": 124404,
        "product": {
          "logisticsProductId": "1234567890"
        },
        "supplierNumber": 11148,
        "receivingDocumentNumber": 41123,
        "qualityCode": 103,
        "resultCode": "APPROPRIATE",
        "rejectionCode": "F",
        "inspectionId": "1234567890",
        "wmsPositionId": "4552140011"
      }
    }
  ]
}

2.29 - I08 Package List Ready for QS

Status

Version 1.0 published 21.11.2022

Approval
Comment
Assumption

_

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

QS

InterfaceOwner

Producer

kMotion

Producer

COBRA

Consumer

Lionfish

2. Business Context

Die Nachricht wird vom Lagerverwaltungssystem erzeugt und an FINE übermittelt genau dann, wenn die Packstücke auf der Übergabefläche für die Warenprüfung bereitgestellt worden sind. Es sollen Detailinformationen über die bereitgestellten Packstücke übermittelt werden. FINE bereitet dann diese Daten auf und übermittelt an das Warenprüfsystem/ERP.

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

context

QS

CLAIM

eventType

PACKAGE_LIST_READY_FOR_QS

PACKAGE_LIST_READY_FOR_CLAIM

4.1.2. Datamodel

Property Type Description

(Root)

object

PackageStatusAfterQsWms
Packstückliste für die Warenprüfung

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Minimum number of items 1
Unique Items: true

            (Array item)

object

                containerId*

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

                containerNumber*

string

Container number
Fachliche ID des Packstückes/Quantes/Gebinde

Maximum Length: 50

                buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

                logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

                quantity*

number

Menge
Menge innerhalb des Packstückes

                storageRemovalTime*

string (date-time)

Entnahmezeitpunkt
Entnahmezeitpunkt

                currentStorageLocation*

string

Lagerort/Lagerkoordinate
Lagerort/Lagerkoordinate, wo sich die Ware aktuell befindet

Maximum Length: 50

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                inspectionId*

string

Inspection Id
Prüfauftrag Identifier

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

4.1.3. Enumeration

Field: tbd

Table 2. tbd
Meta Value Description Short Value

4.1.4. Example

Message WMS to FINE
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "PACKAGE_LIST_READY_FOR_QS",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "QS",
  "metaData": {
    "sender": "KMOTION_ILO",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "ILOWA",
    "deliveryNumber": "124404",
    "positions": [
      {
        "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
        "containerNumber": "5487891001",
        "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
        "logisticsProductId": "1234567890",
        "quantity": 1,
        "storageRemovalTime": "2022-10-16T16:01:00+02:00",
        "currentStorageLocation": "7.1.15.41.2.01",
        "supplierNumber": 11148,
        "receivingDocumentNumber": 41123,
        "inspectionId": "1234567890",
        "wmsPositionId": "4552140011"
      }
    ]
  }
}

4.1.5. Schema

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

current version

1.0

Download

21.11.2022

previous version

coming version

Interface WMS to FINE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PackageStatusAfterQsWms",
  "description": "Packstückliste für die Warenprüfung",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "PACKAGE_LIST_READY_FOR_QS"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The optional context specified here means the business domain.",
      "maxLength": 36,
      "examples": [
        "QS", "CLAIM"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta data",
      "description": "additional meta information for booking interface",
      "properties": {
        "sender": {
          "title": "sender",
          "description": "Name of the source system, that has sent this message.",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v1.schema.json"
        },
        "instance": {
          "title": "instance of producer",
          "type": "string",
          "description": "instance of the application or warehouse context"
        },
        "client": {
          "title": "client",
          "description": "Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea...)",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Lagerstandort",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD", "ILOWA"
          ]
        },
        "deliveryNumber": {
          "description": "Nummer der Anlieferung",
          "type": "string",
          "title": "Delivery Number",
          "maxLength": 36,
          "examples": [
            "1"
          ]
        },
        "positions": {
          "type": "array",
          "uniqueItems": true,
          "minItems": 1,
          "items": {
            "type": "object",
            "properties": {
              "containerId": {
                "description": "Technische ID des Packstückes/Quantes/Gebinde",
                "type": "string",
                "title": "Container ID",
                "maxLength": 36,
                "examples": [
                  "390c3e40-20b9-11ed-861d-0242ac120002"
                ]
              },
              "containerNumber": {
                "description": "Fachliche ID des Packstückes/Quantes/Gebinde",
                "type": "string",
                "title": "Container number",
                "maxLength": 50,
                "examples": [
                  "5487891001"
                ]
              },
              "buid": {
                "description": "Eineindeutige Identifizierung eines Teils",
                "type": "string",
                "title": "BUID",
                "maxLength": 36,
                "examples": [
                  "390c3e40-20b9-11ed-861d-0242ac120002"
                ]
              },
              "logisticsProductId": {
                "description": "FINE-LSAS Logistics Product Identifier.",
                "type": "string",
                "maxLength": 50,
                "title": "Logistics product Id",
                "examples": [
                  "45896254"
                ]
              },
              "quantity": {
                "description": "Menge innerhalb des Packstückes",
                "type": "number",
                "title": "Menge",
                "examples": [
                  12
                ]
              },
              "storageRemovalTime": {
                "type": "string",
                "title": "Entnahmezeitpunkt",
                "format": "date-time",
                "description": "Entnahmezeitpunkt",
                "examples": [
                  "2016-04-16T16:06:05Z",
                  "2016-04-16T16:06:05+02:00"
                ]
              },
              "currentStorageLocation": {
                "description": "Lagerort/Lagerkoordinate, wo sich die Ware aktuell befindet",
                "type": "string",
                "maxLength": 50,
                "title": "Lagerort/Lagerkoordinate",
                "examples": [
                  "7.1.15.41.2.01"
                ]
              },
              "supplierNumber": {
                "description": "Lieferantenkennziffer",
                "type": "integer",
                "title": "Supplier number",
                "maxLength": 6,
                "minLength": 1,
                "examples": [
                  1
                ]
              },
              "receivingDocumentNumber": {
                "description": "Warenannahmeprotokoll (WAP) Nummer",
                "type": "integer",
                "title": "Receiving document number",
                "examples": [
                  12
                ],
                "maxLength": 20
              },
              "inspectionId": {
                "description": "Prüfauftrag Identifier",
                "type": "string",
                "title": "Inspection Id",
                "maxLength": 36,
                "examples": [
                  "12"
                ]
              },
              "wmsPositionId": {
                "description": "LVS VorgangsID",
                "type": "string",
                "title": "LVS VorgangsID",
                "maxLength": 36,
                "examples": [
                  "45880014",
                  "390b8b08-20b9-11ed-861d-0242ac120002"
                ]
              }
            },
            "required": [
              "containerId",
              "containerNumber",
              "logisticsProductId",
              "quantity",
              "storageRemovalTime",
              "currentStorageLocation",
              "supplierNumber",
              "receivingDocumentNumber",
              "inspectionId",
              "wmsPositionId"
            ]
          }
        }
      },
      "required": [
        "location",
        "deliveryNumber",
        "positions"
      ]
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "PACKAGE_LIST_READY_FOR_QS",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "QS",
      "metaData": {
        "sender": "KMOTION_ILO",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "deliveryNumber": "124404",
        "positions": [
          {
            "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
            "containerNumber": "5487891001",
            "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
            "logisticsProductId": "1234567890",
            "quantity": 1,
            "storageRemovalTime": "2022-10-16T16:01:00+02:00",
            "currentStorageLocation": "7.1.15.41.2.01",
            "supplierNumber": 11148,
            "receivingDocumentNumber": 41123,
            "inspectionId": "1234567890",
            "wmsPositionId": "4552140011"
          }
        ]
      }
    }
  ]
}

4.2. Direction FINE to ERP

4.2.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 4. Attribute
Fieldname Expresion

context

QS

CLAIM

eventType

PACKAGE_LIST_READY_FOR_QS

PACKAGE_LIST_READY_FOR_CLAIM

4.2.2. Datamodel

Property Type Description

(Root)

object

PacklistReadyForQsErp
Packstückliste für die Warenprüfung

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Minimum number of items 1
Unique Items: true

            (Array item)

object

                containerId*

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

                containerNumber*

string

Container number
Fachliche ID des Packstückes/Quantes/Gebinde

Maximum Length: 50

                buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

                erpProductId*

string

Erp product Id
FINE-LSAS Erp Product Identifier.

Maximum Length: 50

                quantity*

number

Menge
Menge innerhalb des Packstückes

                storageRemovalTime*

string (date-time)

Entnahmezeitpunkt
Entnahmezeitpunkt

                currentStorageLocation*

string

Lagerort/Lagerkoordinate
Lagerort/Lagerkoordinate, wo sich die Ware aktuell befindet

Maximum Length: 50

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                inspectionId*

string

Inspection Id
Prüfauftrag Identifier

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

4.2.3. Enumeration

Field: tbd

Table 5. tbd

Meta Value

Description

Short Value

4.2.4. Example

Message FINE to ERP
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "PACKAGE_LIST_READY_FOR_QS",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "QS",
  "metaData": {
    "sender": "KMOTION_ILO",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "ILOWA",
    "deliveryNumber": "124404",
    "positions": [
      {
        "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
        "containerNumber": "5487891001",
        "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
        "erpProductId": "1234567890",
        "quantity": 1,
        "storageRemovalTime": "2022-10-16T16:01:00+02:00",
        "currentStorageLocation": "7.1.15.41.2.01",
        "supplierNumber": 11148,
        "receivingDocumentNumber": 41123,
        "inspectionId": "1234567890",
        "wmsPositionId": "4552140011"
      }
    ]
  }
}

4.2.5. Schema

Table 6. Version FINE to ERP
Version Number File Published on Changes

current version

1.0

Download

21.11.2022

previous version

coming version

Interface FINE to ERP
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PacklistReadyForQsErp",
  "description": "Packstückliste für die Warenprüfung",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "PACKAGE_LIST_READY_FOR_QS"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The optional context specified here means the business domain.",
      "maxLength": 36,
      "examples": [
        "QS", "CLAIM"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta data",
      "description": "additional meta information for booking interface",
      "properties": {
        "sender": {
          "title": "sender",
          "description": "Name of the source system, that has sent this message.",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v1.schema.json"
        },
        "instance": {
          "title": "instance of producer",
          "type": "string",
          "description": "instance of the application or warehouse context"
        },
        "client": {
          "title": "client",
          "description": "Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea...)",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Lagerstandort",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD", "ILOWA"
          ]
        },
        "deliveryNumber": {
          "description": "Nummer der Anlieferung",
          "type": "string",
          "title": "Delivery Number",
          "maxLength": 36,
          "examples": [
            "1"
          ]
        },
        "positions": {
          "type": "array",
          "uniqueItems": true,
          "minItems": 1,
          "items": {
            "type": "object",
            "properties": {
              "containerId": {
                "description": "Technische ID des Packstückes/Quantes/Gebinde",
                "type": "string",
                "title": "Container ID",
                "maxLength": 36,
                "examples": [
                  "390c3e40-20b9-11ed-861d-0242ac120002"
                ]
              },
              "containerNumber": {
                "description": "Fachliche ID des Packstückes/Quantes/Gebinde",
                "type": "string",
                "title": "Container number",
                "maxLength": 50,
                "examples": [
                  "5487891001"
                ]
              },
              "buid": {
                "description": "Eineindeutige Identifizierung eines Teils",
                "type": "string",
                "title": "BUID",
                "maxLength": 36,
                "examples": [
                  "390c3e40-20b9-11ed-861d-0242ac120002"
                ]
              },
              "erpProductId": {
                "description": "FINE-LSAS Erp Product Identifier.",
                "type": "string",
                "maxLength": 50,
                "title": "Erp product Id",
                "examples": [
                  "45896254"
                ]
              },
              "quantity": {
                "description": "Menge innerhalb des Packstückes",
                "type": "number",
                "title": "Menge",
                "examples": [
                  12
                ]
              },
              "storageRemovalTime": {
                "type": "string",
                "title": "Entnahmezeitpunkt",
                "format": "date-time",
                "description": "Entnahmezeitpunkt",
                "examples": [
                  "2016-04-16T16:06:05Z",
                  "2016-04-16T16:06:05+02:00"
                ]
              },
              "currentStorageLocation": {
                "description": "Lagerort/Lagerkoordinate, wo sich die Ware aktuell befindet",
                "type": "string",
                "maxLength": 50,
                "title": "Lagerort/Lagerkoordinate",
                "examples": [
                  "7.1.15.41.2.01"
                ]
              },
              "supplierNumber": {
                "description": "Lieferantenkennziffer",
                "type": "integer",
                "title": "Supplier number",
                "maxLength": 6,
                "minLength": 1,
                "examples": [
                  1
                ]
              },
              "receivingDocumentNumber": {
                "description": "Warenannahmeprotokoll (WAP) Nummer",
                "type": "integer",
                "title": "Receiving document number",
                "examples": [
                  12
                ],
                "maxLength": 20
              },
              "inspectionId": {
                "description": "Prüfauftrag Identifier",
                "type": "string",
                "title": "Inspection Id",
                "maxLength": 36,
                "examples": [
                  "12"
                ]
              },
              "wmsPositionId": {
                "description": "LVS VorgangsID",
                "type": "string",
                "title": "LVS VorgangsID",
                "maxLength": 36,
                "examples": [
                  "45880014",
                  "390b8b08-20b9-11ed-861d-0242ac120002"
                ]
              }
            },
            "required": [
              "containerId",
              "containerNumber",
              "erpProductId",
              "quantity",
              "storageRemovalTime",
              "currentStorageLocation",
              "supplierNumber",
              "receivingDocumentNumber",
              "inspectionId",
              "wmsPositionId"
            ]
          }
        }
      },
      "required": [
        "location",
        "deliveryNumber",
        "positions"
      ]
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "PACKAGE_LIST_READY_FOR_QS",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "QS",
      "metaData": {
        "sender": "KMOTION_ILO",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "deliveryNumber": "124404",
        "positions": [
          {
            "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
            "containerNumber": "5487891001",
            "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
            "erpProductId": "1234567890",
            "quantity": 1,
            "storageRemovalTime": "2022-10-16T16:01:00+02:00",
            "currentStorageLocation": "7.1.15.41.2.01",
            "supplierNumber": 11148,
            "receivingDocumentNumber": 41123,
            "inspectionId": "1234567890",
            "wmsPositionId": "4552140011"
          }
        ]
      }
    }
  ]
}

2.30 - I09 Package Status after QS

Status

Version 1.0 published 22.11.2022

Approval
Comment
Assumption

_

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

QS

InterfaceOwner

Consumer

kMotion

Consumer

COBRA

Producer

Lionfish

2. Business Context

Die Nachricht wird vom ERP (Ligis/CMS) erzeugt und an FINE übermittelt. FINE bereitet dann diese Daten auf und übermittelt an das Lagerverwaltungssystem. Fachlicher Inhalt: Meldung über Zustand des einzelnen Warenstückes nach Warenprüfung, um LVS-seitig entsprechende Transportaufträge anzustoßen oder Bestandsreduzierungen vorzunehmen (z.B.: bei Vernichtung).

3. Informationflow

flow

4. Interface

4.1. Direction ERP to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

context

QS oder CLAIM

eventType

PACKAGE_STATUS_AFTER_QS

4.1.2. Datamodel

Property Type Description

(Root)

object

PackageStatusAfterQsErp
Packstück Status nach der Warenprüfung

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        containerId*

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

        buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

        erpProductId*

string

Erp product Id
FINE-LSAS Erp Product Identifier.

Maximum Length: 50

        quantity*

number

Menge
Menge innerhalb des Packstückes

        status*

string

Package status
Status des Packstückes

Maximum Length: 20

4.1.3. Enumeration

status: SELLABLE, DESTROYED

Table 2. tbd
Meta Value Description Short Value

4.1.4. Example

Message ERP to FINE
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "PACKAGE_STATUS_AFTER_QS",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "QS",
  "metaData": {
    "sender": "KMOTION_ILO",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "ILOWA",
    "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
    "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
    "erpProductId": "1234567890",
    "quantity": 1,
    "status": "DESTROYED"
  }
}

4.1.5. Schema

Table 3. Version ERP to FINE
Version Number File Published on Changes

current version

1.0

Download

22.11.2022

previous version

coming version

Interface ERP to FINE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PackageStatusAfterQsErp",
  "description": "Packstück Status nach der Warenprüfung",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "PACKAGE_STATUS_AFTER_QS"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The optional context specified here means the business domain.",
      "maxLength": 36,
      "examples": [
        "QS", "CLAIM"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta data",
      "description": "additional meta information for booking interface",
      "properties": {
        "sender": {
          "title": "sender",
          "description": "Name of the source system, that has sent this message.",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v1.schema.json"
        },
        "instance": {
          "title": "instance of producer",
          "type": "string",
          "description": "instance of the application or warehouse context"
        },
        "client": {
          "title": "client",
          "description": "Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea...)",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Lagerstandort",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD", "ILOWA"
          ]
        },
        "containerId": {
          "description": "Technische ID des Packstückes/Quantes/Gebinde",
          "type": "string",
          "title": "Container ID",
          "maxLength": 36,
          "examples": [
            "390c3e40-20b9-11ed-861d-0242ac120002"
          ]
        },
        "buid": {
          "description": "Eineindeutige Identifizierung eines Teils",
          "type": "string",
          "title": "BUID",
          "maxLength": 36,
          "examples": [
            "390c3e40-20b9-11ed-861d-0242ac120002"
          ]
        },
        "erpProductId": {
          "description": "FINE-LSAS Erp Product Identifier.",
          "type": "string",
          "maxLength": 50,
          "title": "Erp product Id",
          "examples": [
            "45896254"
          ]
        },
        "quantity": {
          "description": "Menge innerhalb des Packstückes",
          "type": "number",
          "title": "Menge",
          "examples": [
            12
          ]
        },
        "status": {
          "description": "Status des Packstückes",
          "type": "string",
          "title": "Package status",
          "maxLength": 20,
          "examples": [
            "SELLABLE", "DESTROYED"
          ]
        }
      },
      "required": [
        "location",
        "containerId",
        "erpProductId",
        "quantity",
        "status"
      ]
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "PACKAGE_STATUS_AFTER_QS",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "QS",
      "metaData": {
        "sender": "KMOTION_ILO",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
        "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
        "erpProductId": "1234567890",
        "quantity": 1,
        "status": "DESTROYED"
      }
    }
  ]
}

4.2. Direction FINE to WMS

4.2.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 4. Attribute
Fieldname Expresion

context

QS oder CLAIM

eventType

PACKAGE_STATUS_AFTER_QS

4.2.2. Datamodel

Property Type Description

(Root)

object

PackageStatusAfterQsWms
Packstück Status nach der Warenprüfung

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        containerId*

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

        buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

        logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

        quantity*

number

Menge
Menge innerhalb des Packstückes

        status*

string

Package status
Status des Packstückes

Maximum Length: 20

4.2.3. Enumeration

status: SELLABLE, DESTROYED

Table 5. tbd

Meta Value

Description

Short Value

4.2.4. Example

Message FINE to WMS
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "PACKAGE_STATUS_AFTER_QS",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "QS",
  "metaData": {
    "sender": "KMOTION_ILO",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "ILOWA",
    "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
    "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
    "logisticsProductId": "1234567890",
    "quantity": 1,
    "status": "DESTROYED"
  }
}

4.2.5. Schema

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

current version

1.0

Download

22.11.2022

previous version

coming version

Interface FINE to WMS
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PackageStatusAfterQsWms",
  "description": "Packstück Status nach der Warenprüfung",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "PACKAGE_STATUS_AFTER_QS"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The optional context specified here means the business domain.",
      "maxLength": 36,
      "examples": [
        "QS", "CLAIM"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta data",
      "description": "additional meta information for booking interface",
      "properties": {
        "sender": {
          "title": "sender",
          "description": "Name of the source system, that has sent this message.",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v1.schema.json"
        },
        "instance": {
          "title": "instance of producer",
          "type": "string",
          "description": "instance of the application or warehouse context"
        },
        "client": {
          "title": "client",
          "description": "Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea...)",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Lagerstandort",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD", "ILOWA"
          ]
        },
        "containerId": {
          "description": "Technische ID des Packstückes/Quantes/Gebinde",
          "type": "string",
          "title": "Container ID",
          "maxLength": 36,
          "examples": [
            "390c3e40-20b9-11ed-861d-0242ac120002"
          ]
        },
        "buid": {
          "description": "Eineindeutige Identifizierung eines Teils",
          "type": "string",
          "title": "BUID",
          "maxLength": 36,
          "examples": [
            "390c3e40-20b9-11ed-861d-0242ac120002"
          ]
        },
        "logisticsProductId": {
          "description": "FINE-LSAS Logistics Product Identifier.",
          "type": "string",
          "maxLength": 50,
          "title": "Logistics product Id",
          "examples": [
            "45896254"
          ]
        },
        "quantity": {
          "description": "Menge innerhalb des Packstückes",
          "type": "number",
          "title": "Menge",
          "examples": [
            12
          ]
        },
        "status": {
          "description": "Status des Packstückes",
          "type": "string",
          "title": "Package status",
          "maxLength": 20,
          "examples": [
            "SELLABLE", "DESTROYED"
          ]
        }
      },
      "required": [
        "location",
        "containerId",
        "logisticsProductId",
        "quantity",
        "status"
      ]
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "PACKAGE_STATUS_AFTER_QS",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "QS",
      "metaData": {
        "sender": "KMOTION_ILO",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
        "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
        "logisticsProductId": "1234567890",
        "quantity": 1,
        "status": "DESTROYED"
      }
    }
  ]
}

2.31 - I10 Planned reworks

Status

Version 1.0 published 27.11.2022

Approval
Comment
Assumption

_

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

QS

InterfaceOwner

Consumer

kMotion

Consumer

COBRA

Producer

Lionfish

2. Business Context

Übertragung aller bekannten geplanten Nachbearbeitungen aus Claim-Management-System (CMS) an das Lagerverwaltungssystem.

3. Informationflow

flow

4. Interface

4.1. Direction ERP to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

context

CLAIM

eventType

PLANNED_REWORK

4.1.2. Datamodel

Property Type Description

(Root)

object

AllPlannedReworksErp
Übermittlung aller geplanten Nachbearbeitungen

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        cmsId*

string

CMS ID
VorgangsID aus dem System CMS

Maximum Length: 36

        validFrom

string (date-time)

Valid from date
Gültigkeit der Nachbearbeitung (Anfang).

        validTo

string (date-time)

Valid to date
Gültigkeit der Nachbearbeitung (Ende).

        erpProductId*

string

Erp product Id
FINE-LSAS Erp Product Identifier.

Maximum Length: 50

        quantity*

number

Quantity
Soll-Menge

        storageNotificationId

array

StorageNotification reference
Liste von StorageNotificationIds

            (Array item)

string

        activityCode*

array

Activity codes
Liste der Nachbearbeitungsschritte

            (Array item)

string

        supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

        companyNumber*

string

Company number
Bestandsfirma

4.1.3. Enumeration

Table 2. tbd
Meta Value Description Short Value

4.1.4. Example

Message ERP to FINE
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "PLANNED_REWORK",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "CLAIM",
  "metaData": {
    "sender": "KMOTION_ILO",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "ILOWA",
    "cmsId": "649871002",
    "validFrom": "2022-11-16T16:06:05+02:00",
    "validTo": "2023-06-16T16:06:05+02:00",
    "erpProductId": "1234567890",
    "quantity": 1000,
    "storageNotificationId": ["390c5074-20b9-11ed-861d-0242ac120002", "390c5182-20b9-11ed-861d-0242ac120002"],
    "activityCode": ["12", "84", "41"],
    "supplierNumber": 11183,
    "companyNumber": "0"
  }
}

4.1.5. Schema

Table 3. Version ERP to FINE
Version Number File Published on Changes

current version

1.0

Download

27.11.2022

previous version

coming version

Interface ERP to FINE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AllPlannedReworksErp",
  "description": "Übermittlung aller geplanten Nachbearbeitungen",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "PLANNED_REWORK"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The optional context specified here means the business domain.",
      "maxLength": 36,
      "examples": [
        "CLAIM"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta data",
      "description": "additional meta information for booking interface",
      "properties": {
        "sender": {
          "title": "sender",
          "description": "Name of the source system, that has sent this message.",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v1.schema.json"
        },
        "instance": {
          "title": "instance of producer",
          "type": "string",
          "description": "instance of the application or warehouse context"
        },
        "client": {
          "title": "client",
          "description": "Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea...)",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Lagerstandort",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD", "ILOWA"
          ]
        },
        "cmsId": {
          "description": "VorgangsID aus dem System CMS",
          "type": "string",
          "title": "CMS ID",
          "maxLength": 36,
          "examples": [
            "390c3e40-20b9-11ed-861d-0242ac120002"
          ]
        },
        "validFrom": {
          "type": "string",
          "title": "Valid from date",
          "format": "date-time",
          "description": "Gültigkeit der Nachbearbeitung (Anfang).",
          "examples": [
            "2016-04-16T16:06:05Z",
            "2016-04-16T16:06:05+02:00"
          ]
        },
        "validTo": {
          "type": "string",
          "title": "Valid to date",
          "format": "date-time",
          "description": "Gültigkeit der Nachbearbeitung (Ende).",
          "examples": [
            "2016-04-16T16:06:05Z",
            "2016-04-16T16:06:05+02:00"
          ]
        },
        "erpProductId": {
          "description": "FINE-LSAS Erp Product Identifier.",
          "type": "string",
          "maxLength": 50,
          "title": "Erp product Id",
          "examples": [
            "45896254"
          ]
        },
        "quantity": {
          "description": "Soll-Menge",
          "type": "number",
          "title": "Quantity",
          "examples": [
            12000
          ]
        },
        "storageNotificationId": {
          "description": "Liste von StorageNotificationIds",
          "type": "array",
          "title": "StorageNotification reference",
          "items": {
            "type": "string",
            "example": ["390c539e-20b9-11ed-861d-0242ac120002", "390c560a-20b9-11ed-861d-0242ac120002"]
          }
        },
        "activityCode": {
          "description": "Liste der Nachbearbeitungsschritte",
          "type": "array",
          "title": "Activity codes",
          "items": {
            "type": "string",
            "example": ["12", "84", "41"]
          }
        },
        "supplierNumber": {
          "description": "Lieferantenkennziffer",
          "type": "integer",
          "title": "Supplier number",
          "maxLength": 6,
          "minLength": 1,
          "examples": [
            1
          ]
        },
        "companyNumber": {
          "description": "Bestandsfirma",
          "type": "string",
          "title": "Company number",
          "examples": ["0"]
        }
      },
      "required": [
        "location",
        "cmsId",
        "erpProductId",
        "quantity",
        "activityCode",
        "supplierNumber",
        "companyNumber"
      ]
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "PLANNED_REWORK",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "CLAIM",
      "metaData": {
        "sender": "KMOTION_ILO",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "cmsId": "649871002",
        "validFrom": "2022-11-16T16:06:05+02:00",
        "validTo": "2023-06-16T16:06:05+02:00",
        "erpProductId": "1234567890",
        "quantity": 1000,
        "storageNotificationId": ["390c5074-20b9-11ed-861d-0242ac120002", "390c5182-20b9-11ed-861d-0242ac120002"],
        "activityCode": ["12", "84", "41"],
        "supplierNumber": 11183,
        "companyNumber": "0"
      }
    }
  ]
}

4.2. Direction FINE to WMS

4.2.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 4. Attribute
Fieldname Expresion

context

CLAIM

eventType

PLANNED_REWORK

4.2.2. Datamodel

Property Type Description

(Root)

object

AllPlannedReworksWms
Übermittlung aller geplanten Nachbearbeitungen

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        cmsId*

string

CMS ID
VorgangsID aus dem System CMS

Maximum Length: 36

        validFrom

string (date-time)

Valid from date
Gültigkeit der Nachbearbeitung (Anfang).

        validTo

string (date-time)

Valid to date
Gültigkeit der Nachbearbeitung (Ende).

        logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

        quantity*

number

Quantity
Soll-Menge

        storageNotificationId

array

StorageNotification reference
Liste von StorageNotificationIds

            (Array item)

string

        activityCode*

array

Activity codes
Liste der Nachbearbeitungsschritte

            (Array item)

string

        supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

        companyNumber*

string

Company number
Bestandsfirma

4.2.3. Enumeration

Table 5. tbd

Meta Value

Description

Short Value

4.2.4. Example

Message FINE to WMS
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "PLANNED_REWORK",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "CLAIM",
  "metaData": {
    "sender": "KMOTION_ILO",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "ILOWA",
    "cmsId": "649871002",
    "validFrom": "2022-11-16T16:06:05+02:00",
    "validTo": "2023-06-16T16:06:05+02:00",
    "logisticsProductId": "1234567890",
    "quantity": 1000,
    "storageNotificationId": ["390c5074-20b9-11ed-861d-0242ac120002", "390c5182-20b9-11ed-861d-0242ac120002"],
    "activityCode": ["12", "84", "41"],
    "supplierNumber": 11183,
    "companyNumber": "0"
  }
}

4.2.5. Schema

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

current version

1.0

Download

27.11.2022

previous version

coming version

Interface FINE to WMS
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AllPlannedReworksWms",
  "description": "Übermittlung aller geplanten Nachbearbeitungen",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "PLANNED_REWORK"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The optional context specified here means the business domain.",
      "maxLength": 36,
      "examples": [
        "CLAIM"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta data",
      "description": "additional meta information for booking interface",
      "properties": {
        "sender": {
          "title": "sender",
          "description": "Name of the source system, that has sent this message.",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v1.schema.json"
        },
        "instance": {
          "title": "instance of producer",
          "type": "string",
          "description": "instance of the application or warehouse context"
        },
        "client": {
          "title": "client",
          "description": "Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea...)",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Lagerstandort",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD", "ILOWA"
          ]
        },
        "cmsId": {
          "description": "VorgangsID aus dem System CMS",
          "type": "string",
          "title": "CMS ID",
          "maxLength": 36,
          "examples": [
            "390c3e40-20b9-11ed-861d-0242ac120002"
          ]
        },
        "validFrom": {
          "type": "string",
          "title": "Valid from date",
          "format": "date-time",
          "description": "Gültigkeit der Nachbearbeitung (Anfang).",
          "examples": [
            "2016-04-16T16:06:05Z",
            "2016-04-16T16:06:05+02:00"
          ]
        },
        "validTo": {
          "type": "string",
          "title": "Valid to date",
          "format": "date-time",
          "description": "Gültigkeit der Nachbearbeitung (Ende).",
          "examples": [
            "2016-04-16T16:06:05Z",
            "2016-04-16T16:06:05+02:00"
          ]
        },
        "logisticsProductId": {
          "description": "FINE-LSAS Logistics Product Identifier.",
          "type": "string",
          "maxLength": 50,
          "title": "Logistics product Id",
          "examples": [
            "45896254"
          ]
        },
        "quantity": {
          "description": "Soll-Menge",
          "type": "number",
          "title": "Quantity",
          "examples": [
            12000
          ]
        },
        "storageNotificationId": {
          "description": "Liste von StorageNotificationIds",
          "type": "array",
          "title": "StorageNotification reference",
          "items": {
            "type": "string",
            "example": ["390c539e-20b9-11ed-861d-0242ac120002", "390c560a-20b9-11ed-861d-0242ac120002"]
          }
        },
        "activityCode": {
          "description": "Liste der Nachbearbeitungsschritte",
          "type": "array",
          "title": "Activity codes",
          "items": {
            "type": "string",
            "example": ["12", "84", "41"]
          }
        },
        "supplierNumber": {
          "description": "Lieferantenkennziffer",
          "type": "integer",
          "title": "Supplier number",
          "maxLength": 6,
          "minLength": 1,
          "examples": [
            1
          ]
        },
        "companyNumber": {
          "description": "Bestandsfirma",
          "type": "string",
          "title": "Company number",
          "examples": ["0"]
        }
      },
      "required": [
        "location",
        "cmsId",
        "logisticsProductId",
        "quantity",
        "activityCode",
        "supplierNumber",
        "companyNumber"
      ]
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "PLANNED_REWORK",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "CLAIM",
      "metaData": {
        "sender": "KMOTION_ILO",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "cmsId": "649871002",
        "validFrom": "2022-11-16T16:06:05+02:00",
        "validTo": "2023-06-16T16:06:05+02:00",
        "logisticsProductId": "1234567890",
        "quantity": 1000,
        "storageNotificationId": ["390c5074-20b9-11ed-861d-0242ac120002", "390c5182-20b9-11ed-861d-0242ac120002"],
        "activityCode": ["12", "84", "41"],
        "supplierNumber": 11183,
        "companyNumber": "0"
      }
    }
  ]
}

2.32 - I13 Unplanned reworks

Status

Version 1.0 published 27.11.2022

Approval
Comment
Assumption

_

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

QS

InterfaceOwner

Consumer

kMotion

Consumer

COBRA

Producer

Lionfish

2. Business Context

Anlage einer ungeplanten Nachbearbeitung und Übertragung notwendiger Informationen an das Lagerverwaltungssystem.

3. Informationflow

flow

4. Interface

4.1. Direction ERP to FINE

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

context

CLAIM

eventType

UNPLANNED_REWORK

4.1.2. Datamodel

Property Type Description

(Root)

object

UnplannedReworkErp
Übermittlung ungeplanter Nachbearbeitungen

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        positions*

array

Minimum number of items 1
Unique Items: true

            (Array item)

object

                containerId

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

                containerNumber

string

Container number
Fachliche ID des Packstückes/Quantes/Gebinde

Maximum Length: 50

                buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

                erpProductId*

string

Erp product Id
FINE-LSAS Erp Product Identifier.

Maximum Length: 50

                quantity*

number

Menge
Menge innerhalb des Packstückes

                activityCode*

array

Activity codes
Liste der Nachbearbeitungsschritte

                    (Array item)

string

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Maximum Length: 12

                deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                cmsId*

string

CMS Id
Id aus dem System CMS

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

4.1.3. Enumeration

Table 2. tbd
Meta Value Description Short Value

4.1.4. Example

Message ERP to FINE
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "UNPLANNED_REWORK",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "CLAIM",
  "metaData": {
    "sender": "KMOTION_ILO",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "ILOWA",
    "positions": [
      {
        "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
        "containerNumber": "5487891001",
        "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
        "erpProductId": "1234567890",
        "quantity": 1,
        "activityCode": ["12", "84", "41"],
        "supplierNumber": 11148,
        "deliveryNumber": "124404",
        "receivingDocumentNumber": 41123,
        "cmsId": "649871002",
        "wmsPositionId": "4552140011"
      }
    ]
  }
}

4.1.5. Schema

Table 3. Version ERP to FINE
Version Number File Published on Changes

current version

1.0

Download

27.11.2022

previous version

coming version

Interface ERP to FINE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "UnplannedReworkErp",
  "description": "Übermittlung ungeplanter Nachbearbeitungen",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "UNPLANNED_REWORK"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The optional context specified here means the business domain.",
      "maxLength": 36,
      "examples": [
        "CLAIM"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta data",
      "description": "additional meta information for booking interface",
      "properties": {
        "sender": {
          "title": "sender",
          "description": "Name of the source system, that has sent this message.",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v1.schema.json"
        },
        "instance": {
          "title": "instance of producer",
          "type": "string",
          "description": "instance of the application or warehouse context"
        },
        "client": {
          "title": "client",
          "description": "Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea...)",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Lagerstandort",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD", "ILOWA"
          ]
        },
        "positions": {
          "type": "array",
          "uniqueItems": true,
          "minItems": 1,
          "items": {
            "type": "object",
            "properties": {
              "containerId": {
                "description": "Technische ID des Packstückes/Quantes/Gebinde",
                "type": "string",
                "title": "Container ID",
                "maxLength": 36,
                "examples": [
                  "390c3e40-20b9-11ed-861d-0242ac120002"
                ]
              },
              "containerNumber": {
                "description": "Fachliche ID des Packstückes/Quantes/Gebinde",
                "type": "string",
                "title": "Container number",
                "maxLength": 50,
                "examples": [
                  "5487891001"
                ]
              },
              "buid": {
                "description": "Eineindeutige Identifizierung eines Teils",
                "type": "string",
                "title": "BUID",
                "maxLength": 36,
                "examples": [
                  "390c3e40-20b9-11ed-861d-0242ac120002"
                ]
              },
              "erpProductId": {
                "description": "FINE-LSAS Erp Product Identifier.",
                "type": "string",
                "maxLength": 50,
                "title": "Erp product Id",
                "examples": [
                  "45896254"
                ]
              },
              "quantity": {
                "description": "Menge innerhalb des Packstückes",
                "type": "number",
                "title": "Menge",
                "examples": [
                  12
                ]
              },
              "activityCode": {
                "description": "Liste der Nachbearbeitungsschritte",
                "type": "array",
                "title": "Activity codes",
                "items": {
                  "type": "string",
                  "example": ["12", "84", "41"]
                }
              },
              "supplierNumber": {
                "description": "Lieferantenkennziffer",
                "type": "integer",
                "title": "Supplier number",
                "maxLength": 12,
                "examples": [
                  1
                ]
              },
              "deliveryNumber": {
                "description": "Nummer der Anlieferung",
                "type": "string",
                "title": "Delivery Number",
                "maxLength": 36,
                "examples": [
                  "1"
                ]
              },
              "receivingDocumentNumber": {
                "description": "Warenannahmeprotokoll (WAP) Nummer",
                "type": "integer",
                "title": "Receiving document number",
                "examples": [
                  12
                ],
                "maxLength": 20
              },
              "cmsId": {
                "description": "Id aus dem System CMS",
                "type": "string",
                "title": "CMS Id",
                "maxLength": 36,
                "examples": [
                  "12"
                ]
              },
              "wmsPositionId": {
                "description": "LVS VorgangsID",
                "type": "string",
                "title": "LVS VorgangsID",
                "maxLength": 36,
                "examples": [
                  "45880014",
                  "390b8b08-20b9-11ed-861d-0242ac120002"
                ]
              }
            },
            "required": [
              "erpProductId",
              "quantity",
              "activityCode",
              "supplierNumber",
              "deliveryNumber",
              "receivingDocumentNumber",
              "cmsId",
              "wmsPositionId"
            ]
          }
        }
      },
      "required": [
        "location",
        "positions"
      ]
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "UNPLANNED_REWORK",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "CLAIM",
      "metaData": {
        "sender": "KMOTION_ILO",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "positions": [
          {
            "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
            "containerNumber": "5487891001",
            "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
            "erpProductId": "1234567890",
            "quantity": 1,
            "activityCode": ["12", "84", "41"],
            "supplierNumber": 11148,
            "deliveryNumber": "124404",
            "receivingDocumentNumber": 41123,
            "cmsId": "649871002",
            "wmsPositionId": "4552140011"
          }
        ]
      }
    }
  ]
}

4.2. Direction FINE to WMS

4.2.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 4. Attribute
Fieldname Expresion

context

CLAIM

eventType

UNPLANNED_REWORK

4.2.2. Datamodel

Property Type Description

(Root)

object

UnplannedReworkWms
Übermittlung ungeplanter Nachbearbeitungen

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        positions*

array

Minimum number of items 1
Unique Items: true

            (Array item)

object

                containerId

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

                containerNumber

string

Container number
Fachliche ID des Packstückes/Quantes/Gebinde

Maximum Length: 50

                buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

                logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

                quantity*

number

Menge
Menge innerhalb des Packstückes

                activityCode*

array

Activity codes
Liste der Nachbearbeitungsschritte

                    (Array item)

string

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Maximum Length: 12

                deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                cmsId*

string

CMS Id
Id aus dem System CMS

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

4.2.3. Enumeration

Table 5. tbd

Meta Value

Description

Short Value

4.2.4. Example

Message FINE to WMS
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "UNPLANNED_REWORK",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "CLAIM",
  "metaData": {
    "sender": "KMOTION_ILO",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "ILOWA",
    "positions": [
      {
        "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
        "containerNumber": "5487891001",
        "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
        "logisticsProductId": "1234567890",
        "quantity": 1,
        "activityCode": ["12", "84", "41"],
        "supplierNumber": 11148,
        "deliveryNumber": "124404",
        "receivingDocumentNumber": 41123,
        "cmsId": "649871002",
        "wmsPositionId": "4552140011"
      }
    ]
  }
}

4.2.5. Schema

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

current version

1.0

Download

27.11.2022

previous version

coming version

Interface FINE to WMS
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "UnplannedReworkWms",
  "description": "Übermittlung ungeplanter Nachbearbeitungen",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "UNPLANNED_REWORK"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The optional context specified here means the business domain.",
      "maxLength": 36,
      "examples": [
        "CLAIM"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta data",
      "description": "additional meta information for booking interface",
      "properties": {
        "sender": {
          "title": "sender",
          "description": "Name of the source system, that has sent this message.",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v1.schema.json"
        },
        "instance": {
          "title": "instance of producer",
          "type": "string",
          "description": "instance of the application or warehouse context"
        },
        "client": {
          "title": "client",
          "description": "Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea...)",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Lagerstandort",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD", "ILOWA"
          ]
        },
        "positions": {
          "type": "array",
          "uniqueItems": true,
          "minItems": 1,
          "items": {
            "type": "object",
            "properties": {
              "containerId": {
                "description": "Technische ID des Packstückes/Quantes/Gebinde",
                "type": "string",
                "title": "Container ID",
                "maxLength": 36,
                "examples": [
                  "390c3e40-20b9-11ed-861d-0242ac120002"
                ]
              },
              "containerNumber": {
                "description": "Fachliche ID des Packstückes/Quantes/Gebinde",
                "type": "string",
                "title": "Container number",
                "maxLength": 50,
                "examples": [
                  "5487891001"
                ]
              },
              "buid": {
                "description": "Eineindeutige Identifizierung eines Teils",
                "type": "string",
                "title": "BUID",
                "maxLength": 36,
                "examples": [
                  "390c3e40-20b9-11ed-861d-0242ac120002"
                ]
              },
              "logisticsProductId": {
                "description": "FINE-LSAS Logistics Product Identifier.",
                "type": "string",
                "maxLength": 50,
                "title": "Logistics product Id",
                "examples": [
                  "45896254"
                ]
              },
              "quantity": {
                "description": "Menge innerhalb des Packstückes",
                "type": "number",
                "title": "Menge",
                "examples": [
                  12
                ]
              },
              "activityCode": {
                "description": "Liste der Nachbearbeitungsschritte",
                "type": "array",
                "title": "Activity codes",
                "items": {
                  "type": "string",
                  "example": ["12", "84", "41"]
                }
              },
              "supplierNumber": {
                "description": "Lieferantenkennziffer",
                "type": "integer",
                "title": "Supplier number",
                "maxLength": 12,
                "examples": [
                  1
                ]
              },
              "deliveryNumber": {
                "description": "Nummer der Anlieferung",
                "type": "string",
                "title": "Delivery Number",
                "maxLength": 36,
                "examples": [
                  "1"
                ]
              },
              "receivingDocumentNumber": {
                "description": "Warenannahmeprotokoll (WAP) Nummer",
                "type": "integer",
                "title": "Receiving document number",
                "examples": [
                  12
                ],
                "maxLength": 20
              },
              "cmsId": {
                "description": "Id aus dem System CMS",
                "type": "string",
                "title": "CMS Id",
                "maxLength": 36,
                "examples": [
                  "12"
                ]
              },
              "wmsPositionId": {
                "description": "LVS VorgangsID",
                "type": "string",
                "title": "LVS VorgangsID",
                "maxLength": 36,
                "examples": [
                  "45880014",
                  "390b8b08-20b9-11ed-861d-0242ac120002"
                ]
              }
            },
            "required": [
              "logisticsProductId",
              "quantity",
              "activityCode",
              "supplierNumber",
              "deliveryNumber",
              "receivingDocumentNumber",
              "cmsId",
              "wmsPositionId"
            ]
          }
        }
      },
      "required": [
        "location",
        "positions"
      ]
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "UNPLANNED_REWORK",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "CLAIM",
      "metaData": {
        "sender": "KMOTION_ILO",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "positions": [
          {
            "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
            "containerNumber": "5487891001",
            "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
            "logisticsProductId": "1234567890",
            "quantity": 1,
            "activityCode": ["12", "84", "41"],
            "supplierNumber": 11148,
            "deliveryNumber": "124404",
            "receivingDocumentNumber": 41123,
            "cmsId": "649871002",
            "wmsPositionId": "4552140011"
          }
        ]
      }
    }
  ]
}

2.33 - I15 Executed rework steps

Status

Version 1.0 published 27.11.2022

Approval
Comment
Assumption

_

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

QS

InterfaceOwner

Producer

kMotion

Producer

COBRA

Consumer

Lionfish

2. Business Context

Bei der Rückmeldung an das ERP werden die durchgeführten Aufbereitungsschritte pro Artikel und Anlieferung im Rahmen des ETUP (bzw. separaten Arbeitsplatz für diese kleineres Nachbearbeitungs-Schritte) übertragen.

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

context

CLAIM

eventType

EXECUTED_REWORK_STEPS

4.1.2. Datamodel

Property Type Description

(Root)

object

ExecutedReworkStepsWms
Meldung durchgeführter Nachbearbeitungsschritte

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Minimum number of items 1
Unique Items: true

            (Array item)

object

                logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 50

                quantity*

number

Menge
Menge innerhalb des Packstückes

                activityCode*

array

Activity codes
Liste der Nachbearbeitungsschritte

                    (Array item)

string

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                cmsId*

string

CMS Id
Id aus dem System CMS

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

4.1.3. Enumeration

Field: tbd

Table 2. tbd
Meta Value Description Short Value

4.1.4. Example

Message WMS to FINE
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "EXECUTED_REWORK_STEPS",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "CLAIM",
  "metaData": {
    "sender": "KMOTION_ILO",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "ILOWA",
    "deliveryNumber": "124404",
    "positions": [
      {
        "logisticsProductId": "1234567890",
        "quantity": 1,
        "activityCode": ["12", "84", "41"],
        "supplierNumber": 11148,
        "receivingDocumentNumber": 41123,
        "cmsId": "649871002",
        "wmsPositionId": "4552140011"
      }
    ]
  }
}

4.1.5. Schema

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

current version

1.0

Download

27.11.2022

previous version

coming version

Interface WMS to FINE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ExecutedReworkStepsWms",
  "description": "Meldung durchgeführter Nachbearbeitungsschritte",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "EXECUTED_REWORK_STEPS"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The optional context specified here means the business domain.",
      "maxLength": 36,
      "examples": [
        "QS", "CLAIM"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta data",
      "description": "additional meta information for booking interface",
      "properties": {
        "sender": {
          "title": "sender",
          "description": "Name of the source system, that has sent this message.",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v1.schema.json"
        },
        "instance": {
          "title": "instance of producer",
          "type": "string",
          "description": "instance of the application or warehouse context"
        },
        "client": {
          "title": "client",
          "description": "Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea...)",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Lagerstandort",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD", "ILOWA"
          ]
        },
        "deliveryNumber": {
          "description": "Nummer der Anlieferung",
          "type": "string",
          "title": "Delivery Number",
          "maxLength": 36,
          "examples": [
            "1"
          ]
        },
        "positions": {
          "type": "array",
          "uniqueItems": true,
          "minItems": 1,
          "items": {
            "type": "object",
            "properties": {
              "logisticsProductId": {
                "description": "FINE-LSAS Logistics Product Identifier.",
                "type": "string",
                "maxLength": 50,
                "title": "Logistics product Id",
                "examples": [
                  "45896254"
                ]
              },
              "quantity": {
                "description": "Menge innerhalb des Packstückes",
                "type": "number",
                "title": "Menge",
                "examples": [
                  12
                ]
              },
              "activityCode": {
                "description": "Liste der Nachbearbeitungsschritte",
                "type": "array",
                "title": "Activity codes",
                "items": {
                  "type": "string",
                  "example": ["12", "84", "41"]
                }
              },
              "supplierNumber": {
                "description": "Lieferantenkennziffer",
                "type": "integer",
                "title": "Supplier number",
                "maxLength": 6,
                "minLength": 1,
                "examples": [
                  1
                ]
              },
              "receivingDocumentNumber": {
                "description": "Warenannahmeprotokoll (WAP) Nummer",
                "type": "integer",
                "title": "Receiving document number",
                "examples": [
                  12
                ],
                "maxLength": 20
              },
              "cmsId": {
                "description": "Id aus dem System CMS",
                "type": "string",
                "title": "CMS Id",
                "maxLength": 36,
                "examples": [
                  "12"
                ]
              },
              "wmsPositionId": {
                "description": "LVS VorgangsID",
                "type": "string",
                "title": "LVS VorgangsID",
                "maxLength": 36,
                "examples": [
                  "45880014",
                  "390b8b08-20b9-11ed-861d-0242ac120002"
                ]
              }
            },
            "required": [
              "logisticsProductId",
              "quantity",
              "activityCode",
              "supplierNumber",
              "receivingDocumentNumber",
              "cmsId",
              "wmsPositionId"
            ]
          }
        }
      },
      "required": [
        "location",
        "deliveryNumber",
        "positions"
      ]
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "EXECUTED_REWORK_STEPS",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "CLAIM",
      "metaData": {
        "sender": "KMOTION_ILO",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "deliveryNumber": "124404",
        "positions": [
          {
            "logisticsProductId": "1234567890",
            "quantity": 1,
            "activityCode": ["12", "84", "41"],
            "supplierNumber": 11148,
            "receivingDocumentNumber": 41123,
            "cmsId": "649871002",
            "wmsPositionId": "4552140011"
          }
        ]
      }
    }
  ]
}

4.2. Direction FINE to ERP

4.2.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 4. Attribute
Fieldname Expresion

context

CLAIM

eventType

EXECUTED_REWORK_STEPS

4.2.2. Datamodel

Property Type Description

(Root)

object

ExecutedReworkStepsErp
Meldung durchgeführter Nachbearbeitungsschritte

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    eventType*

string

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Json schema version
Version of the interface

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

    context

string

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

Maximum Length: 36

    metaData

object

additional meta data
additional meta information for booking interface

        sender

string (enum)

sender
Name of the source system, that has sent this message.

Any of: [ "KR1_SHF", "KR1_HHSTR", "WMSX_SON", "WMSX_AKU", "KMOTION_ILO", "KMOTION_GHM", "COBRA", "LSAS", "IDEEFIX", "OBS", "RESY", "LDH", "RETAILSCHICHT", "BUBE", "FINE_INBOUND" ]

        instance

string

instance of producer
instance of the application or warehouse context

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

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

    data*

object

        location*

string

Request location
Lagerstandort

Minimum Length: 3
Maximum Length: 30

        deliveryNumber*

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

        positions*

array

Minimum number of items 1
Unique Items: true

            (Array item)

object

                erpProductId*

string

Erp product Id
FINE-LSAS Erp Product Identifier.

Maximum Length: 50

                quantity*

number

Menge
Menge innerhalb des Packstückes

                activityCode*

array

Activity codes
Liste der Nachbearbeitungsschritte

                    (Array item)

string

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Minimum Length: 1
Maximum Length: 6

                receivingDocumentNumber*

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 20

                cmsId*

string

CMS Id
Id aus dem System CMS

Maximum Length: 36

                wmsPositionId*

string

LVS VorgangsID
LVS VorgangsID

Maximum Length: 36

4.2.3. Enumeration

Field: tbd

Table 5. tbd

Meta Value

Description

Short Value

4.2.4. Example

Message FINE to ERP
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2016-04-16T16:06:05+02:00",
  "eventType": "EXECUTED_REWORK_STEPS",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "1.0",
  "context": "CLAIM",
  "metaData": {
    "sender": "KMOTION_ILO",
    "instance": "kMotion-ILO",
    "client": "OTTO"
  },
  "data": {
    "location": "ILOWA",
    "deliveryNumber": "124404",
    "positions": [
      {
        "erpProductId": "1234567890",
        "quantity": 1,
        "activityCode": ["12", "84", "41"],
        "supplierNumber": 11148,
        "receivingDocumentNumber": 41123,
        "cmsId": "649871002",
        "wmsPositionId": "4552140011"
      }
    ]
  }
}

4.2.5. Schema

Table 6. Version FINE to ERP
Version Number File Published on Changes

current version

1.0

Download

27.11.2022

previous version

coming version

Interface FINE to ERP
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ExecutedReworkStepsErp",
  "description": "Meldung durchgeführter Nachbearbeitungsschritte",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniq eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "description": "Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.",
      "examples": [
        "2016-04-16T16:06:05Z",
        "2016-04-16T16:06:05+02:00"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "examples": [
        "EXECUTED_REWORK_STEPS"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "version": {
      "description": "Version of the interface",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "title": "Json schema version",
      "examples": [
        "1.0",
        "1.11",
        "1.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The optional context specified here means the business domain.",
      "maxLength": 36,
      "examples": [
        "QS", "CLAIM"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta data",
      "description": "additional meta information for booking interface",
      "properties": {
        "sender": {
          "title": "sender",
          "description": "Name of the source system, that has sent this message.",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v1.schema.json"
        },
        "instance": {
          "title": "instance of producer",
          "type": "string",
          "description": "instance of the application or warehouse context"
        },
        "client": {
          "title": "client",
          "description": "Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea...)",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/company.v1.schema.json"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Lagerstandort",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Request location",
          "examples": [
            "LANGENSELBOLD", "ILOWA"
          ]
        },
        "deliveryNumber": {
          "description": "Nummer der Anlieferung",
          "type": "string",
          "title": "Delivery Number",
          "maxLength": 36,
          "examples": [
            "1"
          ]
        },
        "positions": {
          "type": "array",
          "uniqueItems": true,
          "minItems": 1,
          "items": {
            "type": "object",
            "properties": {
              "erpProductId": {
                "description": "FINE-LSAS Erp Product Identifier.",
                "type": "string",
                "maxLength": 50,
                "title": "Erp product Id",
                "examples": [
                  "45896254"
                ]
              },
              "quantity": {
                "description": "Menge innerhalb des Packstückes",
                "type": "number",
                "title": "Menge",
                "examples": [
                  12
                ]
              },
              "activityCode": {
                "description": "Liste der Nachbearbeitungsschritte",
                "type": "array",
                "title": "Activity codes",
                "items": {
                  "type": "string",
                  "example": ["12", "84", "41"]
                }
              },
              "supplierNumber": {
                "description": "Lieferantenkennziffer",
                "type": "integer",
                "title": "Supplier number",
                "maxLength": 6,
                "minLength": 1,
                "examples": [
                  1
                ]
              },
              "receivingDocumentNumber": {
                "description": "Warenannahmeprotokoll (WAP) Nummer",
                "type": "integer",
                "title": "Receiving document number",
                "examples": [
                  12
                ],
                "maxLength": 20
              },
              "cmsId": {
                "description": "Id aus dem System CMS",
                "type": "string",
                "title": "CMS Id",
                "maxLength": 36,
                "examples": [
                  "12"
                ]
              },
              "wmsPositionId": {
                "description": "LVS VorgangsID",
                "type": "string",
                "title": "LVS VorgangsID",
                "maxLength": 36,
                "examples": [
                  "45880014",
                  "390b8b08-20b9-11ed-861d-0242ac120002"
                ]
              }
            },
            "required": [
              "erpProductId",
              "quantity",
              "activityCode",
              "supplierNumber",
              "receivingDocumentNumber",
              "cmsId",
              "wmsPositionId"
            ]
          }
        }
      },
      "required": [
        "location",
        "deliveryNumber",
        "positions"
      ]
    }
  },
  "required": [
    "eventId",
    "eventTime",
    "traceId",
    "eventType",
    "version",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2016-04-16T16:06:05+02:00",
      "eventType": "EXECUTED_REWORK_STEPS",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "1.0",
      "context": "CLAIM",
      "metaData": {
        "sender": "KMOTION_ILO",
        "instance": "kMotion-ILO",
        "client": "OTTO"
      },
      "data": {
        "location": "ILOWA",
        "deliveryNumber": "124404",
        "positions": [
          {
            "erpProductId": "1234567890",
            "quantity": 1,
            "activityCode": ["12", "84", "41"],
            "supplierNumber": 11148,
            "receivingDocumentNumber": 41123,
            "cmsId": "649871002",
            "wmsPositionId": "4552140011"
          }
        ]
      }
    }
  ]
}

2.34 - I19 Stock Transfer

Status

Version 2.1 published 31.10.2024

Approval
Comment
Assumption

_

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

Inbound

InterfaceOwner

Producer and Consumer

kMotion

2. Business Context

Avisierung von Umfuhren zwischen Lagerstandorten. Es werden die tatsächlich umgefahrenen Artikel und Packstücke gemeldet. Die Umfuhraufträge vom Händler werden nicht über diese Schnittstelle an das Lagerverwaltunssystem übermittelt.

3. Informationflow

flow

4. Interface

4.1. Direction WMS to FINE and FINE to WMS

4.1.1. Header

This interface uses the Service Header

Special expresion for this interface:

Table 1. Attribute
Fieldname Expresion

eventType

STOCK_TRANSFER_BETWEEN_WAREHOUSES

STOCK_TRANSFER_CANCELLATION

context

STOCK_TRANSFER

4.1.2. Datamodel

Property Type Description

(Root)

object

DetourTransport
Umfuhren zwischen Lagerstandorten

    eventId*

string

The uniqe eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format with timezone in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "STOCK_TRANSFER_BETWEEN_WAREHOUSES", "STOCK_TRANSFER_CANCELLATION" ]
Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    version*

string

Version of the interface
Version number of this data structure. Sematic specification (String with major & minor nr)

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

    context*

string (enum)

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

Any of: [ "STOCK_TRANSFER" ]
Maximum Length: 36

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU", "F2X", "F2X_MANUFACTUM", "PSAUT", "F2X_SHEEGO", "F2X_CLEARANCE" ]

    data*

object

        locationSource*

string (enum)

Source warehouse
Quelllager

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" ]
Minimum Length: 3
Maximum Length: 30

        locationTarget*

string (enum)

Target warehouse
Ziellager

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" ]
Minimum Length: 3
Maximum Length: 30

        wmsOrderId*

string

WMS Order ID
VorgangsID im Lagerverwaltungssystem des Abgangslagers (WMS interne Nummer der Verladung, Lagerauftrag - ext. Belegnummer o.ä.)

Maximum Length: 36

        transportStartTime

string (date-time)

Start time from source warehouse
Verlade-Abschluss - Zeitstempel (Verladung ist fertig, WAB kann geschlossen sein)

        positions*

array

Minimum number of items 1

            (Array item)

object

                b2bOrderId

string

ERP Order ID
ERP Original-Auftragsnummer - falls der Umfuhrauftrag vom ERP stammt

Maximum Length: 36

                voucherNumber

integer

Belegnummer
Belegnummer z.B. bei WRS

Maximum Length: 6

                loadingNumber

string

Loading Number
Generierung pro Sender; Generierungsvorschrift nach Anforderung OTTO, muss für 13 Jahre eindeutig sein

Maximum Length: 12

                originalLoadingNumber

string

Original Loading Number
Referenziert die loadingNumber bei der Nachmeldung von Überlieferungen

Maximum Length: 12

                wabNumber

string

WAB Number
WAB Nummer

Maximum Length: 30

                latestStorageTime

string (date-time)

Latest storage time at the target warehouse
Spätester Einlagerungszeitpunkt im Ziellager

                priority

string (enum)

Priority for transport
Bedarfscluster. Priorität der Umfuhr bezogen auf das Packstück

Any of: [ "PRIORITY_A", "PRIORITY_B" ]
Maximum Length: 50

                stockType*

string (enum)

Stock type
Bestandsart, wie z.B. Lagerware, Durchlaufware, NLR

Any of: [ "STOCK_ITEM", "LOCKED", "DLW", "NLR" ]
Maximum Length: 50

                transportType*

string (enum)

Transport type
Transport typ: Bestandsumfuhr normal, Umfuhr-für-WRS-aus WE, Umfuhr-für-WRS von Lieferant, Umfuhr für IWA aus Wareneingang / Warenprüfung, Umfuhr für IWA für Muster, Großkundenauftrag

Any of: [ "STOCK_TRANSFER", "RETURN_INBOUND", "RETURN_SUPPLIER", "INTERNAL_REMOVAL_FROM_INBOUND", "INTERNAL_REMOVAL_FOR_SAMPLE", "SUPPLY", "STOCK_TRANSFER_WITH_PROMISE", "FINAL_REMOVAL", "OTTO_MARKET", "INBOUND_SAMPLE" ]
Maximum Length: 50

                containerId*

string

Container ID
Technische ID des Packstückes/Quantes/Gebinde

Maximum Length: 36

                containerNumber*

string

Container number
Fachliche ID des Packstückes/Quantes/Gebinde

Maximum Length: 50

                containerPackaging*

string

Container packaging
Norm des Packstückes

Maximum Length: 50

                parentContainerId

string

Parent container ID
Technische ID des übergeordneten Packstückes/Quantes/Gebinde

Maximum Length: 36

                parentContainerNumber

string

Parent container number
Fachliche ID des übergeordneten Packstückes/Quantes/Gebinde

Maximum Length: 36

                parentContainerPackaging

string

Parent container packaging
Norm

Maximum Length: 50

                logisticsProductId*

string

Logistics product Id
FINE-LSAS Logistics Product Identifier.

Maximum Length: 36

                erpProductId

string

ERP Product Id
ERP product communication key

Maximum Length: 36

                partNumber*

integer

Part number
Teilenummer für Großstücklogistik. Für Paketlogistik immer 1.

Maximum Length: 6

                productDetails

object

                    buid

string

BUID
Eineindeutige Identifizierung eines Teils

Maximum Length: 36

                    rfid

string

RFID
RFID

Maximum Length: 64

                    imei1

string

IMEI1
IMEI1

Maximum Length: 16

                    imei2

string

IMEI2
IMEI2

Maximum Length: 16

                    producerId

string

Producer ID
Hersteller ID

Maximum Length: 36

                    batchId

string

Batch ID
Chargennummer

Maximum Length: 40

                    bestBeforeDate

string (date-time)

Best before date
Mindesthaltbarkeitsdatum

                ownerCompany*

string (enum)

Owner Company (BDF)
stock-owner company for the product

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU", "F2X", "F2X_MANUFACTUM", "PSAUT", "F2X_SHEEGO", "F2X_CLEARANCE" ]

                supplierNumber*

integer

Supplier number
Lieferantenkennziffer

Maximum Length: 6

                logisticsSupplierId

string

Logistics supplier id
FINE-LSAS Logistics Supplier Identifier.

Maximum Length: 36

                quantity*

number

Quantity
Menge innerhalb des Packstückes

                deliveryNumber

string

Delivery Number
Nummer der Anlieferung

Maximum Length: 36

                deliveryNumberShort

integer

Delivery number short
Nummer der Anlieferung (kurzversion, für die Zoll-Meldung)

Maximum Length: 7

                receivingDocumentNumber

integer

Receiving document number
Warenannahmeprotokoll (WAP) Nummer

Maximum Length: 6

                customsStatus*

string (enum)

Customs status
Zollstatus, wie z.B. freigut, zollgut, nicht definiert

Any of: [ "FREE", "DUTY", "NOT_DEFINED" ]
Maximum Length: 50

                storageNotificationId

string

Storage Notification Id
Technischer Schlüssel des StorageNotification

Maximum Length: 36

                deliveryPositionId

string

Delivery Position Id
Technischer Schlüssel des Anlieferposition

Maximum Length: 36

                sortDestination

integer

Sort Destination
Sortierziel

Maximum Length: 4

                returnsKey

string

Returns Key
Retourenschlüssel

Maximum Length: 36

                returnsEvaluationCode

string

Returns evaluation code
Retourenbeurteilung

Maximum Length: 50

                orderDescription

string

Order description
Auftragstext (Freitext)

Maximum Length: 100

                lockReason

string (enum)

Lock reason type
Sperrgrund

Any of: [ "REQUEST_BY_MERCHANT", "QUALITY_PROBLEMS", "WRONG_LABEL", "RESERVED_FOR_IWA", "DIFFERENCES", "OTHER" ]
Maximum Length: 50

                lockReasonText

string

Lock reason text
Sperrgrund Beschreibung (Freitext)

Maximum Length: 1000

4.1.3. Enumeration

Field: Priority

Table 2. priority
Meta Value Description Short Value

PRIORITY_A

Renner

PRIORITY_B

Penner

Field: Stock type

Table 3. stockType
Meta Value Description Short Value

STOCK_ITEM

Lagerware frei

LOCKED

Lagerware gesperrt

DLW

Durchlaufware

NLR

Nichtlagerfähige Retouren

Field: Transport type

Table 4. transportType
Meta Value Description Short Value

STOCK_TRANSFER

Bestandsumfuhr normal

RETURN_INBOUND

Umfuhr-für-WRS-aus WE

RETURN_SUPPLIER

Umfuhr-für-WRS von Lieferant

INTERNAL_REMOVAL_FROM_INBOUND

Umfuhr für IWA aus Wareneingang / Warenprüfung

INTERNAL_REMOVAL_FOR_SAMPLE

Umfuhr für IWA für Muster

SUPPLY

Großkundenauftrag

STOCK_TRANSFER_WITH_PROMISE

Zusagbare Umfuhr

FINAL_REMOVAL

Endauslagerung

OTTO_MARKET

Otto Market

INBOUND_SAMPLE

Muster

Field: Customs status

Table 5. customsStatus
Meta Value Description Short Value

FREE

Freigut

DUTY

Zollgut

NOT_DEFINED

Nicht definiert

Field: Lock reason

Table 6. lockReason
Meta Value Description Short Value

REQUEST_BY_MERCHANT

Anlieferung soll vorerst nicht verkauft werden, weil Materialzusammensetzung oder Farbnuance vom restlichen Bestand abweicht

QUALITY_PROBLEMS

Meist festgestellt bei nachgelagerter Warenprüfung oder im KS-Prozess

WRONG_LABEL

Meist festgestellt bei nachgelagerter Warenprüfung oder im KS-Prozess

RESERVED_FOR_IWA

Für angekündigte in- bzw. externe Warenanforderungen

DIFFERENCES

Bei falscher Mengeneingabe in der SEIN, Auslagerung zur Prüfung nicht taggleich möglich

OTHER

Grund per Freitext angegeben

4.1.4. Example

Message WMS to FINE and FINE to WMS
{
  "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
  "eventTime": "2023-04-12T16:06:05.036+01:00",
  "eventType": "STOCK_TRANSFER_BETWEEN_WAREHOUSES",
  "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
  "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
  "version": "2.1",
  "context": "STOCK_TRANSFER",
  "metaData": {
    "sender": "KMOTION_ILOWA",
    "client": "OTTO"
  },
  "data": {
    "locationSource": "ILOWA",
    "locationTarget": "SUEDHAFEN",
    "wmsOrderId": "390c4f5c-20b9-11ed-861d-0242ac120002",
    "transportStartTime": "2022-03-31T12:41:06.036+01:00",
    "positions": [
      {
        "b2bOrderId": "390c4084-20b9-11ed-861d-0242ac120002",
        "voucherNumber": 951145,
        "loadingNumber": "784414470093",
        "wabNumber": "23545359",
        "latestStorageTime": "2022-03-31T12:41:06.036+01:00",
        "priority": "PRIORITY_A",
        "stockType": "STOCK_ITEM",
        "transportType": "STOCK_TRANSFER",
        "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
        "containerNumber": "5487891001",
        "containerPackaging": "Norm 5 Karton",
        "parentContainerId": "390c3aee-20b9-11ed-861d-0242ac120002",
        "parentContainerNumber": "987251015011",
        "parentContainerPackaging": "Norm 20 Palette",
        "logisticsProductId": "1234567890",
        "erpProductId": "390c3aee-20b9-11ed-861d-0242ac120002",
        "partNumber": 1,
        "productDetails": {
          "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
          "rfid": "390c48a4-20b9-11ed-861d-0242ac120002",
          "imei1": "835468951314981",
          "imei2": "835468951314982",
          "producerId": "390c4732-20b9-11ed-861d-0242ac120002",
          "batchId": "390c4e1c-20b9-11ed-861d-0242ac120002",
          "bestBeforeDate": "2022-11-06T16:00:00+02:00"
        },
        "ownerCompany": "OTTO",
        "supplierNumber": 11148,
        "logisticsSupplierId": "461218997",
        "quantity": 1,
        "deliveryNumber": "124404",
        "deliveryNumberShort": 1458498,
        "receivingDocumentNumber": 41123,
        "customsStatus": "FREE",
        "storageNotificationId": "390c3e40-20b9-11ed-861d-0242ac120002",
        "deliveryPositionId": "390c43fe-20b9-11ed-861d-0242ac120002",
        "sortDestination": 9532,
        "returnsKey": "12500457996456101",
        "returnsEvaluationCode": "QUALITY",
        "orderDescription": "Auftragstext (Freitext)",
        "lockReason ": "WRONG_LABEL"
      }
    ]
  }
}

4.1.5. Schema

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

current version

2.1

Download

31.10.2024

neue Attribute lockReason und lockReasonText eingeführt

previous version

2.0

Download

13.06.2024

"uniqueItems": true bei den positions. eventType STOCK_TRANSFER_CANCELLATION eingeführt. originalLoadingNumber eingeführt

Interface WMS to FINE
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "DetourTransport",
  "description": "Umfuhren zwischen Lagerstandorten",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "string",
      "title": "The uniqe eventId",
      "maxLength": 36,
      "description": "Global uniq Id, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of occurrence of the event",
      "format": "date-time",
      "customDateTimePattern": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
      "customTimezone": "Europe/Berlin",
      "description": "Time at which this record (event) was technically generated in RFC3339 format with timezone in local time.  Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
      "examples": [
        "2023-04-12T16:06:05.036+01:00"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "maxLength": 36,
      "description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
      "enum": [
        "STOCK_TRANSFER_BETWEEN_WAREHOUSES", "STOCK_TRANSFER_CANCELLATION"
      ],
      "examples": [
        "STOCK_TRANSFER_BETWEEN_WAREHOUSES", "STOCK_TRANSFER_CANCELLATION"
      ]
    },
    "traceId": {
      "type": "string",
      "title": "The uniq traceId",
      "maxLength": 36,
      "description": "Global uniq Id for tracing the flow of events, recommended as uuid",
      "examples": [
        "00ce536f-923a-42f4-8138-33418faf1342"
      ]
    },
    "spanId": {
      "type": "string",
      "title": "The eventId of previous record or batchId",
      "maxLength": 36,
      "description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces",
      "examples": [
        "00ce536f-923a-42f4-5463-32a41877b3c2"
      ]
    },
    "version": {
      "title": "Version of the interface",
      "description": "Version number of this data structure. Sematic specification (String with major & minor nr)",
      "type": "string",
      "pattern": "^[0-9]+[.][0-9]+$",
      "minLength": 3,
      "maxLength": 5,
      "examples": [
        "1.0",
        "1.5",
        "2.1"
      ]
    },
    "context": {
      "type": "string",
      "title": "The context / business case",
      "description": "The context specified here means the business domain.",
      "maxLength": 36,
      "enum": [
        "STOCK_TRANSFER"
      ],
      "examples": [
        "STOCK_TRANSFER"
      ]
    },
    "metaData": {
      "type": "object",
      "title": "additional meta information",
      "description": "can be used with different characteristics for technical data per interface",
      "properties": {
        "sender": {
          "title": "sender",
          "description": "Name of the source system, that has sent this message.",
          "$ref": "https://docs.osp-fine.de/registry/MetaData/sender.v3.schema.json"
        },
        "client": {
          "title": "client",
          "description": "Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea...)",
          "$ref": "https://docs.osp-fine.de/registry/MetaData/company.v5.schema.json"
        }
      },
      "required": [
        "sender"
      ]
    },
    "data": {
      "type": "object",
      "properties": {
        "locationSource": {
          "description": "Quelllager",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Source warehouse",
          "$ref": "https://docs.osp-fine.de/registry/MetaData/warehouselocations.v1.schema.json"
        },
        "locationTarget": {
          "description": "Ziellager",
          "type": "string",
          "maxLength": 30,
          "minLength": 3,
          "title": "Target warehouse",
          "$ref": "https://docs.osp-fine.de/registry/MetaData/warehouselocations.v1.schema.json"
        },
        "wmsOrderId": {
          "description": "VorgangsID im Lagerverwaltungssystem des Abgangslagers (WMS interne Nummer der Verladung, Lagerauftrag - ext. Belegnummer o.ä.)",
          "type": "string",
          "title": "WMS Order ID",
          "maxLength": 36,
          "examples": [
            "390c4228-20b9-11ed-861d-0242ac120002"
          ]
        },
        "transportStartTime": {
          "type": "string",
          "title": "Start time from source warehouse",
          "format": "date-time",
          "customDateTimePattern": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
          "customTimezone": "Europe/Berlin",
          "description": "Verlade-Abschluss - Zeitstempel (Verladung ist fertig, WAB kann geschlossen sein)",
          "examples": [
            "2022-03-31T12:41:06.036+01:00"
          ]
        },
        "positions": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "object",
            "properties": {
              "b2bOrderId": {
                "description": "ERP Original-Auftragsnummer - falls der Umfuhrauftrag vom ERP stammt",
                "type": "string",
                "title": "ERP Order ID",
                "maxLength": 36,
                "examples": [
                  "390c4228-20b9-11ed-861d-0242ac120002"
                ]
              },
              "voucherNumber": {
                "description": "Belegnummer z.B. bei WRS",
                "type": "integer",
                "maxLength": 6,
                "title": "Belegnummer",
                "examples": [
                  951145
                ]
              },
              "loadingNumber": {
                "description": "Generierung pro Sender; Generierungsvorschrift nach Anforderung OTTO, muss für 13 Jahre eindeutig sein",
                "type": "string",
                "maxLength": 12,
                "title": "Loading Number",
                "examples": [
                  "784414470093"
                ]
              },
              "originalLoadingNumber": {
                "description": "Referenziert die loadingNumber bei der Nachmeldung von Überlieferungen",
                "type": "string",
                "maxLength": 12,
                "title": "Original Loading Number",
                "examples": [
                  "784414470092"
                ]
              },
              "wabNumber": {
                "description": "WAB Nummer",
                "type": "string",
                "title": "WAB Number",
                "maxLength": 30,
                "examples": [
                  "23545359"
                ]
              },
              "latestStorageTime": {
                "type": "string",
                "title": "Latest storage time at the target warehouse",
                "format": "date-time",
                "customDateTimePattern": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
                "customTimezone": "Europe/Berlin",
                "description": "Spätester Einlagerungszeitpunkt im Ziellager",
                "examples": [
                  "2022-03-31T12:41:06.036+01:00"
                ]
              },
              "priority": {
                "description": "Bedarfscluster. Priorität der Umfuhr bezogen auf das Packstück",
                "type": "string",
                "title": "Priority for transport",
                "maxLength": 50,
                "enum": [
                  "PRIORITY_A",
                  "PRIORITY_B"
                ]
              },
              "stockType": {
                "description": "Bestandsart, wie z.B. Lagerware, Durchlaufware, NLR",
                "type": "string",
                "title": "Stock type",
                "maxLength": 50,
                "enum": [
                  "STOCK_ITEM",
                  "LOCKED",
                  "DLW",
                  "NLR"
                ]
              },
              "transportType": {
                "description": "Transport typ: Bestandsumfuhr normal, Umfuhr-für-WRS-aus WE, Umfuhr-für-WRS von Lieferant, Umfuhr für IWA aus Wareneingang / Warenprüfung, Umfuhr für IWA für Muster, Großkundenauftrag",
                "type": "string",
                "title": "Transport type",
                "maxLength": 50,
                "enum": [
                  "STOCK_TRANSFER",
                  "RETURN_INBOUND",
                  "RETURN_SUPPLIER",
                  "INTERNAL_REMOVAL_FROM_INBOUND",
                  "INTERNAL_REMOVAL_FOR_SAMPLE",
                  "SUPPLY",
                  "STOCK_TRANSFER_WITH_PROMISE",
                  "FINAL_REMOVAL",
                  "OTTO_MARKET",
                  "INBOUND_SAMPLE"
                ]
              },
              "containerId": {
                "description": "Technische ID des Packstückes/Quantes/Gebinde",
                "type": "string",
                "title": "Container ID",
                "maxLength": 36,
                "examples": [
                  "390c3e40-20b9-11ed-861d-0242ac120002"
                ]
              },
              "containerNumber": {
                "description": "Fachliche ID des Packstückes/Quantes/Gebinde",
                "type": "string",
                "title": "Container number",
                "maxLength": 50,
                "examples": [
                  "5487891001"
                ]
              },
              "containerPackaging": {
                "description": "Norm des Packstückes",
                "type": "string",
                "title": "Container packaging",
                "maxLength": 50,
                "examples": [
                  "Norm 5 Karton"
                ]
              },
              "parentContainerId": {
                "description": "Technische ID des übergeordneten Packstückes/Quantes/Gebinde",
                "type": "string",
                "title": "Parent container ID",
                "maxLength": 36,
                "examples": [
                  "390c3e40-20b9-11ed-861d-0242ac120002"
                ]
              },
              "parentContainerNumber": {
                "description": "Fachliche ID des übergeordneten Packstückes/Quantes/Gebinde",
                "type": "string",
                "title": "Parent container number",
                "maxLength": 36,
                "examples": [
                  "987251015011"
                ]
              },
              "parentContainerPackaging": {
                "description": "Norm",
                "type": "string",
                "title": "Parent container packaging",
                "maxLength": 50,
                "examples": [
                  "Norm 20 Palette"
                ]
              },
              "logisticsProductId": {
                "description": "FINE-LSAS Logistics Product Identifier.",
                "type": "string",
                "maxLength": 36,
                "title": "Logistics product Id",
                "examples": [
                  "45896254"
                ]
              },
              "erpProductId": {
                "description": "ERP product communication key",
                "type": "string",
                "maxLength": 36,
                "title": "ERP Product Id",
                "examples": [
                  "123"
                ]
              },
              "partNumber": {
                "description": "Teilenummer für Großstücklogistik. Für Paketlogistik immer 1.",
                "type": "integer",
                "maxLength": 6,
                "title": "Part number",
                "examples": [
                  1
                ]
              },
              "productDetails": {
                "type": "object",
                "properties": {
                  "buid": {
                    "description": "Eineindeutige Identifizierung eines Teils",
                    "type": "string",
                    "title": "BUID",
                    "maxLength": 36,
                    "examples": [
                      "390c3e40-20b9-11ed-861d-0242ac120002"
                    ]
                  },
                  "rfid": {
                    "description": "RFID",
                    "type": "string",
                    "maxLength": 64,
                    "title": "RFID",
                    "examples": [
                      "390c48a4-20b9-11ed-861d-0242ac120002"
                    ]
                  },
                  "imei1": {
                    "description": "IMEI1",
                    "type": "string",
                    "maxLength": 16,
                    "title": "IMEI1",
                    "examples": [
                      "835468951314981"
                    ]
                  },
                  "imei2": {
                    "description": "IMEI2",
                    "type": "string",
                    "maxLength": 16,
                    "title": "IMEI2",
                    "examples": [
                      "835468951314982"
                    ]
                  },
                  "producerId": {
                    "description": "Hersteller ID",
                    "type": "string",
                    "maxLength": 36,
                    "title": "Producer ID",
                    "examples": [
                      "390c4732-20b9-11ed-861d-0242ac120002"
                    ]
                  },
                  "batchId": {
                    "description": "Chargennummer",
                    "type": "string",
                    "maxLength": 40,
                    "title": "Batch ID",
                    "examples": [
                      "390c4e1c-20b9-11ed-861d-0242ac120002"
                    ]
                  },
                  "bestBeforeDate": {
                    "type": "string",
                    "title": "Best before date",
                    "format": "date-time",
                    "customDateTimePattern": "yyyy-MM-dd'T'HH:mm:ssXXX",
                    "customTimezone": "Europe/Berlin",
                    "description": "Mindesthaltbarkeitsdatum",
                    "examples": [
                      "2016-04-16T16:06:05Z",
                      "2022-11-06T16:00:00+02:00"
                    ]
                  }
                }
              },
              "ownerCompany": {
                "title": "Owner Company (BDF)",
                "description": "stock-owner company for the product",
                "$ref": "https://docs.osp-fine.de/registry/MetaData/company.v5.schema.json"
              },
              "supplierNumber": {
                "description": "Lieferantenkennziffer",
                "type": "integer",
                "title": "Supplier number",
                "maxLength": 6,
                "examples": [
                  1
                ]
              },
              "logisticsSupplierId": {
                "description": "FINE-LSAS Logistics Supplier Identifier.",
                "type": "string",
                "maxLength": 36,
                "title": "Logistics supplier id",
                "examples": [
                  "45896254"
                ]
              },
              "quantity": {
                "description": "Menge innerhalb des Packstückes",
                "type": "number",
                "title": "Quantity",
                "examples": [
                  12
                ]
              },
              "deliveryNumber": {
                "description": "Nummer der Anlieferung",
                "type": "string",
                "title": "Delivery Number",
                "maxLength": 36,
                "examples": [
                  "1"
                ]
              },
              "deliveryNumberShort": {
                "description": "Nummer der Anlieferung (kurzversion, für die Zoll-Meldung)",
                "type": "integer",
                "title": "Delivery number short",
                "maxLength": 7,
                "examples": [
                  "1"
                ]
              },
              "receivingDocumentNumber": {
                "description": "Warenannahmeprotokoll (WAP) Nummer",
                "type": "integer",
                "title": "Receiving document number",
                "examples": [
                  12
                ],
                "maxLength": 6
              },
              "customsStatus": {
                "title": "Customs status",
                "description": "Zollstatus, wie z.B. freigut, zollgut, nicht definiert",
                "type": "string",
                "maxLength": 50,
                "enum": [
                  "FREE",
                  "DUTY",
                  "NOT_DEFINED"
                ]
              },
              "storageNotificationId": {
                "description": "Technischer Schlüssel des StorageNotification",
                "type": "string",
                "title": "Storage Notification Id",
                "maxLength": 36,
                "examples": [
                  "305106fa-2068-44b9-bca2-5afaed6f5090"
                ]
              },
              "deliveryPositionId": {
                "description": "Technischer Schlüssel des Anlieferposition",
                "type": "string",
                "title": "Delivery Position Id",
                "maxLength": 36,
                "examples": [
                  "390c45c0-20b9-11ed-861d-0242ac120002"
                ]
              },
              "sortDestination": {
                "description": "Sortierziel",
                "type": "integer",
                "title": "Sort Destination",
                "maxLength": 4,
                "examples": [
                  9532
                ]
              },
              "returnsKey": {
                "description": "Retourenschlüssel",
                "type": "string",
                "title": "Returns Key",
                "maxLength": 36,
                "examples": [
                  "390c4bc4-20b9-11ed-861d-0242ac120002"
                ]
              },
              "returnsEvaluationCode": {
                "description": "Retourenbeurteilung",
                "type": "string",
                "title": "Returns evaluation code",
                "maxLength": 50,
                "examples": [
                  "QUALITY",
                  "SDV"
                ]
              },
              "orderDescription": {
                "title": "Order description",
                "description": "Auftragstext (Freitext)",
                "type": "string",
                "maxLength": 100
              },
              "lockReason": {
                "title": "Lock reason type",
                "description": "Sperrgrund",
                "type": "string",
                "maxLength": 50,
                "enum": [
                  "REQUEST_BY_MERCHANT",
                  "QUALITY_PROBLEMS",
                  "WRONG_LABEL",
                  "RESERVED_FOR_IWA",
                  "DIFFERENCES",
                  "OTHER"
                ]
              },
              "lockReasonText": {
                "title": "Lock reason text",
                "description": "Sperrgrund Beschreibung (Freitext)",
                "type": "string",
                "maxLength": 1000
              }
            },
            "required": [
              "stockType",
              "transportType",
              "containerId",
              "containerNumber",
              "containerPackaging",
              "logisticsProductId",
              "partNumber",
              "ownerCompany",
              "supplierNumber",
              "quantity",
              "customsStatus"
            ]
          }
        }
      },
      "required": [
        "locationSource",
        "locationTarget",
        "wmsOrderId",
        "positions"
      ]
    }
  },
  "required": [
    "eventId",
    "traceId",
    "eventTime",
    "eventType",
    "version",
    "context",
    "metaData",
    "data"
  ],
  "examples": [
    {
      "eventId": "b7731f51-fa96-43e8-9035-46221d31fd26",
      "eventTime": "2023-04-12T16:06:05.036+01:00",
      "eventType": "STOCK_TRANSFER_BETWEEN_WAREHOUSES",
      "traceId": "4b8cce05-51a6-412e-89a0-sdfsdfsdfsdf",
      "spanId": "00ce536f-923a-42f4-5463-32a41877b3c2",
      "version": "2.1",
      "context": "STOCK_TRANSFER",
      "metaData": {
        "sender": "KMOTION_ILOWA",
        "client": "OTTO"
      },
      "data": {
        "locationSource": "ILOWA",
        "locationTarget": "SUEDHAFEN",
        "wmsOrderId": "390c4f5c-20b9-11ed-861d-0242ac120002",
        "transportStartTime": "2022-03-31T12:41:06.036+01:00",
        "positions": [
          {
            "b2bOrderId": "390c4084-20b9-11ed-861d-0242ac120002",
            "voucherNumber": 951145,
            "loadingNumber": "784414470093",
            "wabNumber": "23545359",
            "latestStorageTime": "2022-03-31T12:41:06.036+01:00",
            "priority": "PRIORITY_A",
            "stockType": "STOCK_ITEM",
            "transportType": "STOCK_TRANSFER",
            "containerId": "390c3aee-20b9-11ed-861d-0242ac120002",
            "containerNumber": "5487891001",
            "containerPackaging": "Norm 5 Karton",
            "parentContainerId": "390c3aee-20b9-11ed-861d-0242ac120002",
            "parentContainerNumber": "987251015011",
            "parentContainerPackaging": "Norm 20 Palette",
            "logisticsProductId": "1234567890",
            "erpProductId": "390c3aee-20b9-11ed-861d-0242ac120002",
            "partNumber": 1,
            "productDetails": {
              "buid": "390c3d1e-20b9-11ed-861d-0242ac120002",
              "rfid": "390c48a4-20b9-11ed-861d-0242ac120002",
              "imei1": "835468951314981",
              "imei2": "835468951314982",
              "producerId": "390c4732-20b9-11ed-861d-0242ac120002",
              "batchId": "390c4e1c-20b9-11ed-861d-0242ac120002",
              "bestBeforeDate": "2022-11-06T16:00:00+02:00"
            },
            "ownerCompany": "OTTO",
            "supplierNumber": 11148,
            "logisticsSupplierId": "461218997",
            "quantity": 1,
            "deliveryNumber": "124404",
            "deliveryNumberShort": 1458498,
            "receivingDocumentNumber": 41123,
            "customsStatus": "FREE",
            "storageNotificationId": "390c3e40-20b9-11ed-861d-0242ac120002",
            "deliveryPositionId": "390c43fe-20b9-11ed-861d-0242ac120002",
            "sortDestination": 9532,
            "returnsKey": "12500457996456101",
            "returnsEvaluationCode": "QUALITY",
            "orderDescription": "Auftragstext (Freitext)"
          }
        ]
      }
    }
  ]
}

4.1.6. Changelog

2.35 - I22 Returns Booking

Status

FINAL → Dokumentation abgenommen

Approval
Comment

Neue Schnittstelle für WRS/WRR Buchungen aus den Lagerverwaltungssystemen in Richtung ERP.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

InterfaceOwner

Producer

COBRA

Producer

KMotion

Consumer

Eaglefish

2. Business Context

booking: returns

3. Informationflow

4. Interface

Vorhandene Dokumentation

Technisch:

4.1. Direction WMS to FINE

4.1.1. Header

This interface uses the Service Header

4.1.2. Datamodel

Property Type Description

(Root)

object

WMS WRS/WRR bookings
This document describes the WRS/WRR messages that the WMS sends to FINE.

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

    spanId*

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format with timezone in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

    version*

string

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

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

    context*

string (enum)

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

Any of: [ "RETURNS_TO_SUPPLIER" ]

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "WRS", "WRR" ]

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU", "F2X", "F2X_MANUFACTUM", "PSAUT", "F2X_SHEEGO", "F2X_CLEARANCE" ]

    data*

object

Additional Properties: false

        location*

string (enum)

Lagerstandort
Lagerstandort. Die Liste der Betriebe ist vordefiniert.

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

        businessEventTime*

string (date-time)

Datum und Uhrzeit des Geschäftsvorfalls
Datum und Uhrzeit des Geschäftsvorfalls in Lokalzeit. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

        businessEventKey*

string

UUID der Buchung
UUID der Buchung aus dem WMS

Maximum Length: 36

        supplierNumber*

integer

Lieferantenkennziffer
Lieferantenkennziffer

Maximum: 999999

        logisticsSupplierId*

string

LieferantenID
LieferantenID auf LVS-Seite

Maximum Length: 36

        creditorNumber

integer

Kreditornummer eines Lieferanten
Kreditornummer eines Lieferanten in SAP (ZLKZ)

Maximum: 9999999999

        ownerCompany*

string (enum)

Owner Company (BDF)
stock-owner company for the product

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU", "F2X", "F2X_MANUFACTUM", "PSAUT", "F2X_SHEEGO", "F2X_CLEARANCE" ]

        returnAddress*

object

Abweichende Adresse
Abweichende Adresse

            addressName

string

Name des Lieferanten
Name des Lieferanten.

Maximum Length: 100

            addressStreet

string

Straße, Hausnummer
Straße, Hausnummer.

Maximum Length: 100

            addressZip

string

Postleitzahl
Postleitzahl.

Maximum Length: 10

            addressCity

string

Ortschaft
Ortschaft.

Maximum Length: 100

            addressCountryCode

string

Zweistellige Ländercode
Zweistellige Ländercode (ISO standard).

Maximum Length: 2

        documentNumber*

integer

Belegnummer
Belegnummer der Warenrücksendung (9xxxxx), WRS in COBRA wird nur bei Beleg 94xxxx - 979999 gebucht; 2. Stelle der Belegnummer: 4 = Konsignationsware; 5 = Retourenware; 6 = Lagerreparaturen; 7 = Sonstige (Standard)

Minimum: 100000
Maximum: 999999

        wrsOrderNumber

integer

WRS Order Number
WRS Auftragsnummer vom ERP

Minimum: 10000000000000
Maximum: 99999999999999

        cancellableDocumentNumber

integer

Nummer des zu stornierenden Beleges
Nummer des zu stornierenden Beleges

Minimum: 100000
Maximum: 999999

        cancellationFlag*

string (enum)

Cancellation flag
Sagt aus, ob es sich um einen Storno handelt

Any of: [ "YES", "NO" ]

        returnReason*

string (enum)

Return reason
Rücksendegrund: Qualität, Überlieferung, Kulanz

Any of: [ "QUALITY", "SURPLUS_DELIVERY", "FAIRNESS" ]

        returnSourceCode*

string (enum)

Quelle der Rücksendung
Quelle der Rücksendung: Nicht-Lagerware, Konsignationsware, Retourenware, Lagerreparturen, Sonstige (Standard)

Any of: [ "NON_STOCK_ITEM", "CONSIGNMENT_GOODS", "RETURNS", "WAREHOUSE_REPAIRS", "DEFAULT" ]

        freightTermCode*

string (enum)

Frankatur
Frankatur: unfrei, frei Haus, Ab Werk, nicht identifiziert

Any of: [ "NOT_FREE", "FREE", "FROM_FACTORY", "NOT_IDENTIFIED" ]

        shipmentCode*

string (enum)

Versand veranlasst per
Versand veranlasst per: Spedition, Bahn, Post, Express, Abholung, keine Angabe

Any of: [ "CARRIER", "RAILWAY", "POST", "EXPRESS", "COLLECTION", "NOT_IDENTIFIED" ]

        postageCost

integer

Porto
Rückporto in Cent

Minimum: 0
Maximum: 999999999999

        extraCost

integer

Nebenkosten
Nebenkosten je Stück, in Cent

Minimum: 0
Maximum: 999999

        extraCostsCode*

string (enum)

Nebenkosten Kennzeichen
Nebenkosten Kennzeichen: Kundenretoure, Normkarton, Eigenfertigung, Trolli, Meterwaren, Hartware, keine Nebenkosten

Any of: [ "CUSTOMER_RETURNS", "STANDARD_CARTON", "SELF_PRODUCTION", "TROLLEY", "SOLD_BY_METER", "HARDWARE", "NO_EXTRA_COSTS" ]

        extraCostCartonQuantity

integer

Anzahl Kartons
Anzahl Kartons für die Nebenkostenberechnung

Minimum: 0
Maximum: 999

        extraCostOpenCartonQuantity

integer

Anzahl geöffneter Kartons
Anzahl geöffneter Kartons für die Nebenkostenberechnung

Minimum: 0
Maximum: 99

        documentCreatedBy*

string

Beleg erstellt von
Name der Mitarbeiter

        positions*

array

            (Array item)

object

Additional Properties: false

                logisticsProductId*

string

WMS Product Id
product communication key

Maximum Length: 36

                quantity*

integer

Return received
the returned quantity for this product

Minimum: 0
Maximum: 99999999999999

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

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

current version

1.0

Download

30.12.2024

Einführung wrsOrderNumber

previous version

coming version

4.2. Direction FINE to ERP

4.2.1. Header

This interface uses the Service Header

4.2.2. Datamodel

Property Type Description

(Root)

object

ERP WRS/WRR bookings
This document describes the WRS/WRR messages that FINE sends to the ERPs.

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

    spanId*

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format with timezone in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

    version*

string

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

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

    context*

string (enum)

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

Any of: [ "RETURNS_TO_SUPPLIER" ]

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "WRS", "WRR" ]

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

        client

string (enum)

client
Client/mandant (messages of different clients have different processing rules and destination interfaces) - use FBO for Fulfillment by Otto (CORE, DeepSea…​)

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU", "F2X", "F2X_MANUFACTUM", "PSAUT", "F2X_SHEEGO", "F2X_CLEARANCE" ]

    data*

object

Additional Properties: false

        location*

string (enum)

Lagerstandort
Lagerstandort. Die Liste der Betriebe ist vordefiniert.

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

        businessEventTime*

string (date-time)

Datum und Uhrzeit des Geschäftsvorfalls
Datum und Uhrzeit des Geschäftsvorfalls in Lokalzeit. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

        businessEventKey*

string

UUID der Buchung
UUID der Buchung aus dem WMS

Maximum Length: 36

        supplierNumber*

integer

Lieferantenkennziffer
Lieferantenkennziffer

Maximum: 999999

        erpSupplierId*

string

LieferantenID
LieferantenID auf ERP-Seite

Maximum Length: 36

        creditorNumber

integer

Kreditornummer eines Lieferanten
Kreditornummer eines Lieferanten in SAP (ZLKZ)

Maximum: 9999999999

        ownerCompany*

string (enum)

Owner Company (BDF)
stock-owner company for the product

Any of: [ "FBO", "MYTOYS", "BONPRIX", "WITT", "CORSO", "HEINE", "BAUMARKT_DIREKT", "BAUR", "OTTO", "ABOUTYOU", "F2X", "F2X_MANUFACTUM", "PSAUT", "F2X_SHEEGO", "F2X_CLEARANCE" ]

        returnAddress*

object

Abweichende Adresse
Abweichende Adresse

            addressName

string

Name des Lieferanten
Name des Lieferanten.

Maximum Length: 100

            addressStreet

string

Straße, Hausnummer
Straße, Hausnummer.

Maximum Length: 100

            addressZip

string

Postleitzahl
Postleitzahl.

Maximum Length: 10

            addressCity

string

Ortschaft
Ortschaft.

Maximum Length: 100

            addressCountryCode

string

Zweistellige Ländercode
Zweistellige Ländercode (ISO standard).

Maximum Length: 2

        documentNumber*

integer

Belegnummer
Belegnummer der Warenrücksendung (9xxxxx), WRS in COBRA wird nur bei Beleg 94xxxx - 979999 gebucht; 2. Stelle der Belegnummer: 4 = Konsignationsware; 5 = Retourenware; 6 = Lagerreparaturen; 7 = Sonstige (Standard)

Minimum: 100000
Maximum: 999999

        wrsOrderNumber

integer

WRS Order Number
WRS Auftragsnummer vom ERP

Minimum: 10000000000000
Maximum: 99999999999999

        cancellableDocumentNumber

integer

Nummer des zu stornierenden Beleges
Nummer des zu stornierenden Beleges

Minimum: 100000
Maximum: 999999

        cancellationFlag*

string (enum)

Cancellation flag
Sagt aus, ob es sich um einen Storno handelt

Any of: [ "YES", "NO" ]

        returnReason*

string (enum)

Return reason
Rücksendegrund: Qualität, Überlieferung, Kulanz

Any of: [ "QUALITY", "SURPLUS_DELIVERY", "FAIRNESS" ]

        returnSourceCode*

string (enum)

Quelle der Rücksendung
Quelle der Rücksendung: Nicht-Lagerware, Konsignationsware, Retourenware, Lagerreparturen, Sonstige (Standard)

Any of: [ "NON_STOCK_ITEM", "CONSIGNMENT_GOODS", "RETURNS", "WAREHOUSE_REPAIRS", "DEFAULT" ]

        freightTermCode*

string (enum)

Frankatur
Frankatur: unfrei, frei Haus, Ab Werk, nicht identifiziert

Any of: [ "NOT_FREE", "FREE", "FROM_FACTORY", "NOT_IDENTIFIED" ]

        shipmentCode*

string (enum)

Versand veranlasst per
Versand veranlasst per: Spedition, Bahn, Post, Express, Abholung, keine Angabe

Any of: [ "CARRIER", "RAILWAY", "POST", "EXPRESS", "COLLECTION", "NOT_IDENTIFIED" ]

        postageCost

integer

Porto
Rückporto in Cent

Minimum: 0
Maximum: 999999999999

        extraCost

integer

Nebenkosten
Nebenkosten je Stück, in Cent

Minimum: 0
Maximum: 999999

        extraCostsCode*

string (enum)

Nebenkosten Kennzeichen
Nebenkosten Kennzeichen: Kundenretoure, Normkarton, Eigenfertigung, Trolli, Meterwaren, Hartware, keine Nebenkosten

Any of: [ "CUSTOMER_RETURNS", "STANDARD_CARTON", "SELF_PRODUCTION", "TROLLEY", "SOLD_BY_METER", "HARDWARE", "NO_EXTRA_COSTS" ]

        extraCostCartonQuantity

integer

Anzahl Kartons
Anzahl Kartons für die Nebenkostenberechnung

Minimum: 0
Maximum: 999

        extraCostOpenCartonQuantity

integer

Anzahl geöffneter Kartons
Anzahl geöffneter Kartons für die Nebenkostenberechnung

Minimum: 0
Maximum: 99

        documentCreatedBy*

string

Beleg erstellt von
Name der Mitarbeiter

        positions*

array

            (Array item)

object

Additional Properties: false

                erpProductId*

string

ERP Product Id
product communication key

Maximum Length: 36

                quantity*

integer

Return received
the returned quantity for this product

Minimum: 0
Maximum: 99999999999999

4.2.3. Enumeration

4.2.4. Example

4.2.5. Schema

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

current version

1.0

Download

30.12.2024

Einführung wrsOrderNumber

previous version

coming version

2.36 - I23 Transport Damages

Status

DRAFT → Geplante Schnittstelle

Approval
Comment

Neue Schnittstelle für die Meldung von Transportschäden im Wareneingang.

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

InterfaceOwner

Producer

KMotion

Consumer

Lionfish

2. Business Context

3. Informationflow

4. Interface

Vorhandene Dokumentation

Technisch:

4.1. Direction WMS to FINE

4.1.1. Header

This interface uses the Service Header

4.1.2. Datamodel

Property Type Description

(Root)

object

TransportDamageWms
Nachricht vom WMS an FINE-QS

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId*

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context*

string (enum)

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

Any of: [ "QS" ]
Maximum Length: 36

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "TRANSPORT_DAMAGE_NEW_GOODS" ]
Maximum Length: 36

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

    data*

object

        location*

string (enum)

The sending warehouse
The sending warehouse (cobra sends data for different warehouses), List of allowed values will be defined and documented #url

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

        businessEventTime*

string (date-time)

The date and time, when the business event occurred
the date and time, when the business event occurred, in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

        goodsInId*

string

the goods receipt ID
the goods receipt technical key, generated by the wms. (Possible UUID but other identifier accepted)

Maximum Length: 36

        deliveryNumber*

string

the inbound delivery business key
the inbound delivery business key, generated by the wms

Maximum Length: 36

        deliveryDate*

string (date)

Delivery Date
Datum der Anlieferung

        positions*

array

Positionen

Minimum number of items 1
Unique Items: true

            (Array item)

object

Additional Properties: false

                goodsInPositionId*

string

Position Id
unique ID of the position. (Earlier name of the attribute: deliveryPositionId, wmsPositionId)

Maximum Length: 36

                supplierNumber*

integer

Supplier Number
the number of supplier

Maximum: 999999

                logisticsProductId*

string

Logistics Product Id
Product Identifier

Maximum Length: 36

                documentNumber*

integer

Document number
for deliveries from supplier this ist the goods receipt/goods acceptance protocoll (WAP) number for this delivery entry generated from number range dependent on warehouse 44000 to 449999 for Langenselbold GL, for other types (returns) their document number

Minimum: 100000
Maximum: 999999

                purchaseOrderNumber*

integer

Purchase order number
Auftragsnummer (OVA)

Maximum Length: 20

                storageNotificationId*

string

Storage Notification Id
ID of the Storage Notification (Interface I01)

Maximum Length: 36

                deliveryQuantity*

number

Delivery quantity
Liefermenge

                damagedQuantity*

number

Damaged quantity
Beschädigte Menge

                imageURLs

array

Image URLs

                    (Array item)

string

                damageCode

array

Fehlercode
Codeliste vorhanden!

                    (Array item)

string

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

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

current version

1.0

Download

01.07.2024

draft

previous version

coming version

4.2. Direction FINE to ERP

4.2.1. Header

This interface uses the Service Header

4.2.2. Datamodel

Property Type Description

(Root)

object

TransportDamageErp
Nachricht von FINE-QS an den ERP

    eventId*

string

The uniq eventId
Global uniq Id, recommended as uuid

Maximum Length: 36

    traceId*

string

The uniq traceId
Global uniq Id for tracing the flow of events, recommended as uuid

Maximum Length: 36

    spanId*

string

The eventId of previous record or batchId
Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event) or event is a part of a batch, recommended as uuid, Special usecases can be specify for some interfaces

Maximum Length: 36

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record(event) was technically generated in RFC3339 format with timezone or UTC.

    version*

string

Json schema version
Version of the interface

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

    context*

string (enum)

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

Any of: [ "QS" ]
Maximum Length: 36

    eventType*

string (enum)

The concrete type = kind of record(event)
This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.

Any of: [ "TRANSPORT_DAMAGE_NEW_GOODS" ]
Maximum Length: 36

    metaData*

object

additional meta information
can be used with different characteristics for technical data per interface

        sender*

string (enum)

sender
Name of the source system, that has sent this message.

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

    data*

object

        location*

string (enum)

The sending warehouse
The sending warehouse (cobra sends data for different warehouses), List of allowed values will be defined and documented #url

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

        businessEventTime*

string (date-time)

The date and time, when the business event occurred
the date and time, when the business event occurred, in local time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

        goodsInId*

string

the goods receipt ID
the goods receipt technical key, generated by the wms. (Possible UUID but other identifier accepted)

Maximum Length: 36

        deliveryNumber*

string

the inbound delivery business key
the inbound delivery business key, generated by the wms

Maximum Length: 36

        deliveryDate*

string (date)

Delivery Date
Datum der Anlieferung

        positions*

array

Positionen

Minimum number of items 1
Unique Items: true

            (Array item)

object

Additional Properties: false

                goodsInPositionId*

string

Position Id
unique ID of the position. (Earlier name of the attribute: deliveryPositionId, wmsPositionId)

Maximum Length: 36

                supplierNumber*

integer

Supplier Number
the number of supplier

Maximum: 999999

                erpProductId*

string

Erp Product Id
Product Identifier

Maximum Length: 36

                documentNumber*

integer

Document number
for deliveries from supplier this ist the goods receipt/goods acceptance protocoll (WAP) number for this delivery entry generated from number range dependent on warehouse 44000 to 449999 for Langenselbold GL, for other types (returns) their document number

Minimum: 100000
Maximum: 999999

                purchaseOrderNumber*

integer

Purchase order number
Auftragsnummer (OVA)

Maximum Length: 20

                storageNotificationId*

string

Storage Notification Id
ID of the Storage Notification (Interface I01)

Maximum Length: 36

                deliveryQuantity*

number

Delivery quantity
Liefermenge

                damagedQuantity*

number

Damaged quantity
Beschädigte Menge

                imageURLs

array

Image URLs

                    (Array item)

string

                damageCode

array

Fehlercode
Codeliste vorhanden!

                    (Array item)

string

4.2.3. Enumeration

4.2.4. Example

4.2.5. Schema

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

current version

1.0

Download

01.07.2024

draft

previous version

coming version