{
"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"
}
]
}
}
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
4. Interface
4.1. Direction WMS to FINE
4.1.1. Header
This interface uses the Service Header
Special expresion for this interface:
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 |
eventId* |
string |
The uniq eventId Maximum Length: 36 |
eventTime* |
string (date-time) |
Time of occurrence of the event |
eventType* |
string |
The concrete type = kind of record(event) Maximum Length: 36 |
traceId* |
string |
The uniq traceId Maximum Length: 36 |
spanId |
string |
The eventId of previous record or batchId Maximum Length: 36 |
version* |
string |
Json schema version Minimum Length: 3 |
context |
string |
The context / business case Maximum Length: 36 |
metaData |
object |
additional meta data |
sender |
string (enum) |
sender 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 |
client |
string (enum) |
client Any of: [
"FBO",
"MYTOYS",
"BONPRIX",
"WITT",
"CORSO",
"HEINE",
"BAUMARKT_DIREKT",
"BAUR",
"OTTO",
"ABOUTYOU"
] |
data* |
object |
|
location* |
string |
Request location Minimum Length: 3 |
deliveryNumber* |
string |
Delivery Number Maximum Length: 36 |
positions* |
array |
Minimum number of items 1 |
(Array item) |
object |
|
containerId* |
string |
Container ID Maximum Length: 36 |
containerNumber* |
string |
Container number Maximum Length: 50 |
buid |
string |
BUID Maximum Length: 36 |
logisticsProductId* |
string |
Logistics product Id Maximum Length: 50 |
quantity* |
number |
Menge |
storageRemovalTime* |
string (date-time) |
Entnahmezeitpunkt |
currentStorageLocation* |
string |
Lagerort/Lagerkoordinate Maximum Length: 50 |
supplierNumber* |
integer |
Supplier number Minimum Length: 1 |
receivingDocumentNumber* |
integer |
Receiving document number Maximum Length: 20 |
inspectionId* |
string |
Inspection Id Maximum Length: 36 |
wmsPositionId* |
string |
LVS VorgangsID Maximum Length: 36 |
4.1.3. Enumeration
Field: tbd
Meta Value | Description | Short Value |
---|
4.1.4. Example
4.1.5. Schema
Version | Number | File | Published on | Changes |
---|---|---|---|---|
current version |
1.0 |
21.11.2022 |
||
previous version |
||||
coming version |
{
"$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:
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 |
eventId* |
string |
The uniq eventId Maximum Length: 36 |
eventTime* |
string (date-time) |
Time of occurrence of the event |
eventType* |
string |
The concrete type = kind of record(event) Maximum Length: 36 |
traceId* |
string |
The uniq traceId Maximum Length: 36 |
spanId |
string |
The eventId of previous record or batchId Maximum Length: 36 |
version* |
string |
Json schema version Minimum Length: 3 |
context |
string |
The context / business case Maximum Length: 36 |
metaData |
object |
additional meta data |
sender |
string (enum) |
sender 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 |
client |
string (enum) |
client Any of: [
"FBO",
"MYTOYS",
"BONPRIX",
"WITT",
"CORSO",
"HEINE",
"BAUMARKT_DIREKT",
"BAUR",
"OTTO",
"ABOUTYOU"
] |
data* |
object |
|
location* |
string |
Request location Minimum Length: 3 |
deliveryNumber* |
string |
Delivery Number Maximum Length: 36 |
positions* |
array |
Minimum number of items 1 |
(Array item) |
object |
|
containerId* |
string |
Container ID Maximum Length: 36 |
containerNumber* |
string |
Container number Maximum Length: 50 |
buid |
string |
BUID Maximum Length: 36 |
erpProductId* |
string |
Erp product Id Maximum Length: 50 |
quantity* |
number |
Menge |
storageRemovalTime* |
string (date-time) |
Entnahmezeitpunkt |
currentStorageLocation* |
string |
Lagerort/Lagerkoordinate Maximum Length: 50 |
supplierNumber* |
integer |
Supplier number Minimum Length: 1 |
receivingDocumentNumber* |
integer |
Receiving document number Maximum Length: 20 |
inspectionId* |
string |
Inspection Id Maximum Length: 36 |
wmsPositionId* |
string |
LVS VorgangsID Maximum Length: 36 |
4.2.3. Enumeration
Field: tbd
Meta Value |
Description |
Short Value |
4.2.4. Example
{
"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
Version | Number | File | Published on | Changes |
---|---|---|---|---|
current version |
1.0 |
21.11.2022 |
||
previous version |
||||
coming version |
{
"$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"
}
]
}
}
]
}