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"
      }
    }
  ]
}
Last updated: Fri, 25 Apr 2025 01:44:49 UTC