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

Return to the regular view of this page.

FLASH/Outbound

1 -

1.1 -

Property Type Description

(Root)

object

outbound.deliverystatement
data from Brain about delivery Statementdata

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

    eventTime*

string

Time of technical 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. Only required if no $schema is specified!

Regular expression: \d+\.\d{1,2}

    eventType*

string (enum)

The concrete type = kind of record(event)
Type of the event. The possible values are defined as Enum

Any of: [ "INSERT", "UPDATE" ]
Minimum Length: 1
Maximum Length: 50

    data*

object

        deliveryStatementWorkdays

integer,null

Anzahl der Werktage
Anzahl der Werktage

Minimum: 0
Maximum: 1000000000000000000

        deliveryDate

string,null (date)

Liefertermin
um Sonn-/und Feiertage ergaenztes Lieferdatum, anhand von Workdays

Minimum Length: 10
Maximum Length: 10

        returnKey*

integer

Retourenschluessel
Retourenschluessel der ausgehenden Sendung

Minimum: 1
Maximum: 1000000000000000000

        deliveryStatementCode

integer,null

Lieferzeit-Id
dreistelliger nummerischer code der die geplante Lieferzeit abbildet

Minimum: 1
Maximum: 999

        deliveryStatementDescription

string,null

Lieferzeit Beschreibung
Beschreibung der numerischen DELIVERYSTATEMENTID in Textform

Minimum Length: 1
Maximum Length: 100

        deliveryInformationReasonCode

integer,null

Grund des Lieferstatus als Id
einstelliger nummerischer code der die Begruendung für den aktuellen Lieferstatus abbildet

Minimum: 1
Maximum: 9

        deliveryInformationReasonDescription

string,null

Grund des aktuellen Lieferstatus
Beschreibung der numerischen DELIVERYINFORMATIONREASONCODE in Textform

Minimum Length: 1
Maximum Length: 100

        slbCode

integer,null

Code der sofortigen Lieferbarkeit
Einstelliger numerischer Code, der die Lieferaussage im Bezug auf die sofortige Lieferbarkeit naeher beschreibt

Minimum: 1
Maximum: 9

        slbDescription

string,null

Beschreibung der sofortigen Lieferbarkeit
Beschreibung der numerischen SLB in Textform

Minimum Length: 1
Maximum Length: 100

        shipmentServiceTypeCode

integer,null

Lieferservicetyp als Id
ein- bis zweistelliger numerischer Code, der den Lieferservicetype abbildet

Minimum: 1
Maximum: 99

        shipmentServiceTypeDescription

string,null

Beschreibung des Lieferservicetyps
Beschreibung der SHIPMENT_SERVICE_TYPE_ID in Textform

Minimum Length: 1
Maximum Length: 500

        businessEventTimestamp

string

Fachlicher Zeitstempel
fachlicher Zeitstempel, des Events im ISO 8601-Format.

        RUN_ID

string

RUN_ID
Export ID of exporting system. RUN_ID is the used name in all BRAIN-Exports, renaming is tricky

Minimum Length: 14
Maximum Length: 14

2 -

2.1 -

Property Type Description

(Root)

object

outbound.customerorder.orderprocess.brain
data from Brain about order-process (KPI)

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    eventTime*

string

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

    eventType*

string (enum)

The concrete type = kind of record(event)
Type of the event. The possible values are defined as Enum

Any of: [ "INSERT", "UPDATE" ]
Minimum Length: 1
Maximum Length: 50

    traceId*

string (uuid)

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

    version*

string

The number of version schema
Number of version of this data structure. Only required if no $schema is specified!

Regular expression: \d+\.\d{1,2}

    data*

object

        returnKey*

integer

Retourenschluessel
Retourenschluessel der ausgehenden Sendung

Minimum: 1
Maximum: 1000000000000000000

        kpiTimestamp

string (date)

KPI-Timestamp
fachlicher Zeitstempel, des Auftragsstatus (KPI laut BRAIN) im ISO 8601-Format.

        kpiName

string (enum)

Enum zur Abbildung des Auftragsstatus (KPI laut BRAIN)
KPI/Auftragsstatus

Any of: [ "KPI_1_NACHFRAGE", "KPI_8_ANSPRACHE", "KPI_22_MENGENSTEUERUNG_AUFBAU", "KPI_25_FAKTURIERUNGSVOLUMEN_AUFBAU", "KPI_184_LAGERDIFFERENZEN_STUECK", "KPI_187_OFFENER_NAB_STUECK", "KPI_190_RESERVIERTER_NAB_STUECK" ]
Minimum Length: 10
Maximum Length: 100

        kpiValue

number

Wert der KPI/Auftragsstatus
Gibt den Wert des Auftragssstatus an, z.B. Auftragswert oder Lagerbestandsmenge

        salesorderIdTok

string

key to identify SalesorderID
tokenisierte eindeutige Id der Bestellung

Minimum Length: 25
Maximum Length: 50

        customerCompanyNumber

integer

Number of the customer-company
Kundenfirmennummer

Minimum: 0
Maximum: 2000000000

        customerTypeNumber

integer

Type of the customer
Kundenart

Minimum: 0
Maximum: 30000

        nonMerchandizeType

boolean

non-Merchandize-Type-Id
Nicht-handelsware-Kennzeichen

3 -

3.1 -

Property Type Description

(Root)

object

outbound.shipmentmasterdata
data from Brain about Shipmentdata

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

    eventTime*

string

Time of technical 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. Only required if no $schema is specified!

Regular expression: \d+\.\d{1,2}

    eventType*

string (enum)

The concrete type = kind of record(event)
Type of the event. The possible values are defined as Enum

Any of: [ "INSERT", "UPDATE" ]
Minimum Length: 1
Maximum Length: 50

    data*

object

        returnKey*

string

Retourenschluessel
Retourenschluessel der ausgehenden Sendung

Minimum Length: 1
Maximum Length: 25

        trackingNumber

string

Sendungsidentnummer
Sendungsidentnummer der ausgehenden Sendung

Minimum Length: 1
Maximum Length: 50

        partnerVariationId

string

ERP-ProductId
ERP-Id laut LSAS-Artikelstamm

Minimum Length: 18
Maximum Length: 36

        erpId

string

ERP-Id
fuehrendes System für Artiklinformationen

Minimum Length: 1
Maximum Length: 25

        packageCount

integer

Kollimenge
Anzahl der Kolli je Sendung

Minimum: 1
Maximum: 999

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

        handling

string

Handling
Gibt das Handling des Artikels an. PL/GL (1Mh/2MH)

Minimum Length: 2
Maximum Length: 10

4 -

4.1 -

Property Type Description

(Root)

object

outbound.orderdatatoflash.f2x
orderdata from F2X to flash

Additional Properties: false

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

Minimum Length: 36
Maximum Length: 36

    eventTime*

string

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

    eventType*

string (enum)

The concrete type = kind of record(event)
Type of the event. Several different events are tracked during the picking an goods issue process. The possible values are defined as Enum

Any of: [ "INSERT", "UPDATE" ]
Minimum Length: 1
Maximum Length: 50

    version*

string

The number of version schema
Number of version of this data structure. Only required if no $schema is specified!

Regular expression: \d+\.\d{1,2}

    meta*

object

        sender*

string (enum)

The name of sender = producer
An explanation about the purpose of this instance.

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

        businessType*

string (enum)

type of business
concrete type of business

Any of: [ "B2B", "B2C" ]
Minimum Length: 1
Maximum Length: 50

        orderOwner*

string

order owner
Owner of the order. Same as for Logistikpuffer, ReSy, e.g.

Minimum Length: 1
Maximum Length: 50

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

        businessEventType*

string (enum)

The concrete business eventtype of the record
Type of the event. Several different events are tracked. The possible values are defined as enum

Any of: [ "ERP_CUSTOMER_ORDER", "ERP_ORDER_CREATED_AT", "F2X_ORDER_RECEIVED", "F2X_ORDER_REJECTION", "F2X_ORDER_SUBMISSION_TO_WHS", "WHS_INVOICE_REQUEST", "WHS_LABEL_DOCUMENT", "WHS_GOODS_ISSUE_NOTE", "WHS_GOODS_ISSUE_NOTE_SUBMISSION_TO_F2X", "F2X_GOODS_ISSUE_NOTE_SUBMISSION_TO_ERP", "WHS_CANCELATION_NOTE", "WHS_CANCELATION_NOTE_SUBMISSION_TO_F2X", "F2X_CANCELATION_NOTE_SUBMISSION_TO_ERP" ]
Minimum Length: 1
Maximum Length: 50

        businessEventTimestamp*

string (date-time)

timestamp of occurrence of the business event type
Time at which this businees event type was physically generated in RFC3339 format. In local time with offset.

        saleschannel

string

saleschannel
saleschannel of the order

Minimum Length: 1
Maximum Length: 50

        orderType

string

order type
order type (MFDE, MFCH, MAINT eg.)

Minimum Length: 1
Maximum Length: 50

        clientOrderId*

string

client order id
client order id of the several ERP

Minimum Length: 1
Maximum Length: 50

        f2xOrderId

string

f2x order id
internal F2X order id

Minimum Length: 1
Maximum Length: 50

        whsOrderId

string

warehouse order id
warehouse order id

Minimum Length: 1
Maximum Length: 50

        whsSubOrderId

string

warehouse sub order id
warehouse sub order id (Teilauftragsnummer/ partital order number)

Minimum Length: 1
Maximum Length: 50

        logisticsProductId

integer

unique key for an item(size)
unique key for an item(size) from product master data (if available)

Minimum: 1
Maximum: 1000000000000000000

        articleNumber

string

article number
internal article id, F2X article number if logisticsProductId is not avaiable

Minimum Length: 1
Maximum Length: 50

        articlePositionNumber

integer

article position number
position in order

Minimum: 1
Maximum: 1000000000000000000

        quantity*

integer

quantity
quantity of article position

Minimum: 1
Maximum: 1000000000000000000

        carrier

string

carrier
name of carrier

Minimum Length: 1
Maximum Length: 50

        shippingTrackingNumber

string

outgoing shipment tracking number
goods issue identnumber

Minimum Length: 1
Maximum Length: 50

        returnTrackingNumber

string

return tracking number
return identnumber

Minimum Length: 1
Maximum Length: 50

        rejectionReason

string

rejection reason
one reason for rejection

Minimum Length: 1
Maximum Length: 50

        retryFlag

string

retry flag
retry flag (technical)

Minimum Length: 1
Maximum Length: 50

5 -

5.1 -

Property Type Description

(Root)

object

outbound.buffer.item
data provided by FLASH about buffered items in system 'Logistikpuffer'

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    eventTime*

string

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

    eventType*

string (enum)

The concrete type = kind of record(event)
Type of the event. The possible values are defined as Enum

Any of: [ "INSERT", "UPDATE" ]
Minimum Length: 1
Maximum Length: 50

    context*

string

Context of the message
short description about the content of the message

    version*

string

The number of version schema
Number of version of this data structure. Only required if no $schema is specified!

Regular expression: \d+\.\d{1,2}

    meta*

object

        senderSystem*

string

senderSystem
name of sending system, according to fine-standard

Minimum Length: 1
Maximum Length: 25

    data*

object

        erpProductId*

string

erpProductId / externe technische Artikel Referenz
reference to article-number from soucesystem, provided bei lsas

Minimum Length: 1
Maximum Length: 50

        date*

string

date / Datum
Date which the message relates to

Minimum Length: 8
Maximum Length: 8

        warehouseLocation*

string (enum)

warehouseLocation / Logistikstandort

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

        customerCompanyNumber*

string

customerCompanyNumber / Kundenfirmenkennzeichen
Number of the customer company

Minimum Length: 25
Maximum Length: 50

        handling*

string

handling / Abwicklung
Name of handling as provided by lsas-article-informations

Minimum Length: 25
Maximum Length: 50

        volumecluster*

string

volume-cluster / Mengencluster
Name of the used volumecluster

Minimum Length: 25
Maximum Length: 50

        bufferCreatedQuantity

integer

Quantity, of created Aritcles at system 'Logistikpuffer'.

Minimum: 0
Maximum: 1e+21

        cancellationQuantity

integer

Quantity, of cancelled Aritcles at system 'Logistikpuffer'.

Minimum: 0
Maximum: 1e+21

        callOffQuantity

integer

Quantity, of called-off Aritcles at system 'Logistikpuffer'.

Minimum: 0
Maximum: 1e+21

        bufferQuantity*

integer

Quantity, of still buffered Aritcles at system 'Logistikpuffer'.

Minimum: 1
Maximum: 1e+21

6 - O46 DeliveryStatement

Status

Version 2.0 published 17.10.2022

Approval

  1. xxx

Comment

xxx

Assumption

xxx

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

FLASH

InterfaceOwner

Producer

BRAIN

Consumer

FLASH

2. Business Context

Die Schnittstelle bildet die Lieferaussage (z.B. "Lieferung innerhalb von 2 Wochen") und Daten dazu ab (z.B Lieferservice, Lieferdatum) zu einem Lieferauftrag ab.

3. Informationflow

flow

4. Interface

4.1. Direction ERP to FINE

4.1.1. Header

This interface uses the Service Header

4.1.2. Datamodel

Property Type Description

(Root)

object

outbound.deliverystatement
data from Brain about delivery Statementdata

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

    eventTime*

string

Time of technical 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. Only required if no $schema is specified!

Regular expression: \d+\.\d{1,2}

    eventType*

string (enum)

The concrete type = kind of record(event)
Type of the event. The possible values are defined as Enum

Any of: [ "INSERT", "UPDATE" ]
Minimum Length: 1
Maximum Length: 50

    data*

object

        deliveryStatementWorkdays

integer,null

Anzahl der Werktage
Anzahl der Werktage

Minimum: 0
Maximum: 1000000000000000000

        deliveryDate

string,null (date)

Liefertermin
um Sonn-/und Feiertage ergaenztes Lieferdatum, anhand von Workdays

Minimum Length: 10
Maximum Length: 10

        returnKey*

integer

Retourenschluessel
Retourenschluessel der ausgehenden Sendung

Minimum: 1
Maximum: 1000000000000000000

        deliveryStatementCode

integer,null

Lieferzeit-Id
dreistelliger nummerischer code der die geplante Lieferzeit abbildet

Minimum: 1
Maximum: 999

        deliveryStatementDescription

string,null

Lieferzeit Beschreibung
Beschreibung der numerischen DELIVERYSTATEMENTID in Textform

Minimum Length: 1
Maximum Length: 100

        deliveryInformationReasonCode

integer,null

Grund des Lieferstatus als Id
einstelliger nummerischer code der die Begruendung für den aktuellen Lieferstatus abbildet

Minimum: 1
Maximum: 9

        deliveryInformationReasonDescription

string,null

Grund des aktuellen Lieferstatus
Beschreibung der numerischen DELIVERYINFORMATIONREASONCODE in Textform

Minimum Length: 1
Maximum Length: 100

        slbCode

integer,null

Code der sofortigen Lieferbarkeit
Einstelliger numerischer Code, der die Lieferaussage im Bezug auf die sofortige Lieferbarkeit naeher beschreibt

Minimum: 1
Maximum: 9

        slbDescription

string,null

Beschreibung der sofortigen Lieferbarkeit
Beschreibung der numerischen SLB in Textform

Minimum Length: 1
Maximum Length: 100

        shipmentServiceTypeCode

integer,null

Lieferservicetyp als Id
ein- bis zweistelliger numerischer Code, der den Lieferservicetype abbildet

Minimum: 1
Maximum: 99

        shipmentServiceTypeDescription

string,null

Beschreibung des Lieferservicetyps
Beschreibung der SHIPMENT_SERVICE_TYPE_ID in Textform

Minimum Length: 1
Maximum Length: 500

        businessEventTimestamp

string

Fachlicher Zeitstempel
fachlicher Zeitstempel, des Events im ISO 8601-Format.

        RUN_ID

string

RUN_ID
Export ID of exporting system. RUN_ID is the used name in all BRAIN-Exports, renaming is tricky

Minimum Length: 14
Maximum Length: 14

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

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

current version

2.0

Download

17.10.2022

Anpassung auf Retourenschluessel-Granularität

previous version

1.0

24.08.2022

initial

coming version
Interface ERP to FINE
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$comment": "Schema for Delivery Statement from ERP to FINE",
  "$id": "https://doc.fine.gcp.osp-dev.de/registry/Outbound/DeliveryStatementErp.v2.0.schema.json",
  "type": "object",
  "title": "outbound.deliverystatement",
  "description": "data from Brain about delivery Statementdata",
  "required": [
    "eventId",
    "traceId",
    "eventTime",
    "version",
    "eventType",
    "data"
  ],
  "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-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of technical 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:05Z"
      ]
    },
    "version": {
      "title": "The number of version schema",
      "description": "Number of version of this data structure. Only required if no $schema is specified!",
      "type": "string",
      "pattern": "\\d+\\.\\d{1,2}",
      "examples": [ "1.01" ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "description": "Type of the event. The possible values are defined as Enum",
      "minLength": 1,
      "maxLength": 50,
      "enum": [ "INSERT", "UPDATE"],
      "examples": [
        "INSERT"
      ]
    },
    "data": {
      "type": "object",
      "required": [
        "returnKey"
      ],
      "properties": {
        "deliveryStatementWorkdays": {
              "title": "Anzahl der Werktage",
              "description": "Anzahl der Werktage",
              "type": ["integer", "null"],
              "default": null,
              "minimum": 0,
              "maximum": 999999999999999999,
              "examples": [
                "1"
              ]
            },
        "deliveryDate": {
          "type": ["string", "null"],
          "default": null,
          "format": "date",
              "title": "Liefertermin",
              "description": "um Sonn-/und Feiertage ergaenztes Lieferdatum, anhand von Workdays",
          "minLength": 10,
              "maxLength": 10,
              "examples": [
                "2022-08-10"
              ]
            },
        "returnKey": {
              "type": "integer",
              "title": "Retourenschluessel",
              "description": "Retourenschluessel der ausgehenden Sendung",
              "minimum": 1,
              "maximum": 999999999999999999,
              "isEncryptionEnabled": true,
              "examples": [
                "417919950186"
              ]
            },
        "deliveryStatementCode": {
              "type": ["integer", "null"],
              "default": null,
              "title": "Lieferzeit-Id",
              "description": "dreistelliger nummerischer code der die geplante Lieferzeit abbildet",
              "minimum": 1,
              "maximum": 999,
              "examples": [
                "72"
              ]
            },
        "deliveryStatementDescription": {
              "type": ["string", "null"],
              "default": null,
              "title": "Lieferzeit Beschreibung",
              "description": "Beschreibung der numerischen DELIVERYSTATEMENTID in Textform",
              "minLength": 1,
              "maxLength": 100,
              "examples": [
                "innerhalb von zwei Wochen"
              ]
            },
        "deliveryInformationReasonCode": {
              "type": ["integer", "null"],
              "default": null,
              "title": "Grund des Lieferstatus als Id",
              "description": "einstelliger nummerischer code der die Begruendung für den aktuellen Lieferstatus abbildet",
              "minimum": 1,
              "maximum": 9,
              "examples": [
                "3"
              ]
            },
        "deliveryInformationReasonDescription": {
              "type": ["string", "null"],
              "default": null,
              "title": "Grund des aktuellen Lieferstatus",
              "description": "Beschreibung der numerischen DELIVERYINFORMATIONREASONCODE in Textform",
              "minLength": 1,
              "maxLength": 100,
              "examples": [
                "Veraenderter Liefertermin durch NINA-Kette"
              ]
            },
        "slbCode": {
              "type": ["integer", "null"],
              "default": null,
              "title": "Code der sofortigen Lieferbarkeit",
              "description": "Einstelliger numerischer Code, der die Lieferaussage im Bezug auf die sofortige Lieferbarkeit naeher beschreibt",
              "minimum": 1,
              "maximum": 9,
              "examples": [
                "2"
              ]
            },
        "slbDescription": {
              "type": ["string", "null"],
              "default": null,
              "title": "Beschreibung der sofortigen Lieferbarkeit",
              "description": "Beschreibung der numerischen SLB in Textform",
              "minLength": 1,
              "maxLength": 100,
              "examples": [
                "NALI"
              ]
            },
        "shipmentServiceTypeCode": {
              "type": ["integer", "null"],
              "default": null,
              "title": "Lieferservicetyp als Id",
              "description": "ein- bis zweistelliger numerischer Code, der den Lieferservicetype abbildet",
              "minimum": 1,
              "maximum": 99,
              "examples": [
                "5"
              ]
            },
        "shipmentServiceTypeDescription": {
              "type": ["string", "null"],
              "default": null,
              "title": "Beschreibung des Lieferservicetyps",
              "description": "Beschreibung der SHIPMENT_SERVICE_TYPE_ID in Textform",
              "minLength": 1,
              "maxLength": 500,
              "examples": [
                "Normalservice"
              ]
            },
        "businessEventTimestamp": {
              "type": "string",
              "title": "Fachlicher Zeitstempel",
              "description": "fachlicher Zeitstempel, des Events im ISO 8601-Format.",
              "examples": [
                "2022-09-26T13:59:36.631+02:00"
              ]
            },
        "RUN_ID": {
          "type": "string",
          "title": "RUN_ID",
          "description": "Export ID of exporting system. RUN_ID is the used name in all BRAIN-Exports, renaming is tricky",
          "maxLength": 14,
          "minLength": 14,
          "examples": [
              "20220622010436"
            ]
          }
        }
      }
    }
  }

7 - O50 OrderProcess

Status

Version 2.00 published 26.06.2023

Approval

  1. xxx

Comment

xxx

Assumption

xxx

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

FLASH

InterfaceOwner

FLASH

Producer

BRAIN

Consumer

FLASH

2. Business Context

Die Schnittstelle wird von BRAIN mit den Auftragsprozess-Daten/ KPI-Daten versorgt. Die Granularität ist Retourenschlüssel. Dadurch ist sichergestellt, dass die Daten in FLASH verknüpft werden können. Die Daten werden zusammen mit den Daten aus O51 - ShipmentMasterdata genutzt.

3. Informationflow

flow

4. Interface

4.1. Direction ERP to FINE

4.1.1. Header

This interface uses the Service Header

4.1.2. Datamodel

Property Type Description

(Root)

object

outbound.customerorder.orderprocess.brain
data from Brain about order-process (KPI)

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    eventTime*

string

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

    eventType*

string (enum)

The concrete type = kind of record(event)
Type of the event. The possible values are defined as Enum

Any of: [ "INSERT", "UPDATE" ]
Minimum Length: 1
Maximum Length: 50

    traceId*

string (uuid)

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

    version*

string

The number of version schema
Number of version of this data structure. Only required if no $schema is specified!

Regular expression: \d+\.\d{1,2}

    data*

object

        returnKey*

integer

Retourenschluessel
Retourenschluessel der ausgehenden Sendung

Minimum: 1
Maximum: 1000000000000000000

        kpiTimestamp

string (date)

KPI-Timestamp
fachlicher Zeitstempel, des Auftragsstatus (KPI laut BRAIN) im ISO 8601-Format.

        kpiName

string (enum)

Enum zur Abbildung des Auftragsstatus (KPI laut BRAIN)
KPI/Auftragsstatus

Any of: [ "KPI_1_NACHFRAGE", "KPI_8_ANSPRACHE", "KPI_22_MENGENSTEUERUNG_AUFBAU", "KPI_25_FAKTURIERUNGSVOLUMEN_AUFBAU", "KPI_184_LAGERDIFFERENZEN_STUECK", "KPI_187_OFFENER_NAB_STUECK", "KPI_190_RESERVIERTER_NAB_STUECK" ]
Minimum Length: 10
Maximum Length: 100

        kpiValue

number

Wert der KPI/Auftragsstatus
Gibt den Wert des Auftragssstatus an, z.B. Auftragswert oder Lagerbestandsmenge

        salesorderIdTok

string

key to identify SalesorderID
tokenisierte eindeutige Id der Bestellung

Minimum Length: 25
Maximum Length: 50

        customerCompanyNumber

integer

Number of the customer-company
Kundenfirmennummer

Minimum: 0
Maximum: 2000000000

        customerTypeNumber

integer

Type of the customer
Kundenart

Minimum: 0
Maximum: 30000

        nonMerchandizeType

boolean

non-Merchandize-Type-Id
Nicht-handelsware-Kennzeichen

4.1.3. Enumeration

Field: KPI

Table 1. KPI
Meta Value Description

KPI_1_NACHFRAGE

Summe der Auftragswerte aller Kundenaufträge, unabhängig vom Bestellweg. Der Auftragswert umfasst Preis und Menge aller vom Kunden bestellten Waren und Services. Die Nachfrage entspricht dem Wert aller abgeschickten Bestellungen vor nachgelagerten Kreditsperren und taggleichen Stornierungen über alle Bestellwege (inkl. Telefon etc.) der jeweiligen Geschäftsfelder.

KPI_8_ANSPRACHE

Die Ansprache Handel ist die kaufkräftige Nachfrage eines Kunden, die hinsichtlich ihrer Fehlerfreiheit und Kreditwürdigkeit überprüft und nicht taggleich durch den Kunden wieder storniert wurde. Mit der Ansprache geht eine Bestandsreservierung für den Kunden einher.

KPI_22_MENGENSTEUERUNG_AUFBAU

Können vom Logistikbetrieb aus Kapazitätsgründen nicht alle Kundenaufträge fakturiert werden, wird im Rahmen der Mengensteuerung ein Teil der Aufträge zurückgehalten. Diese Kundenaufträge verbleiben so lange in der Mengensteuerung, bis sie durch die Logistik verarbeitet werden können und in das Fakturierungsvolumen übergehen. In COIN wird nicht die absolute Höhe der Mengensteuerung ausgewiesen, sondern die Veränderung ggü. dem Vortag.

KPI_25_FAKTURIERUNGSVOLUMEN_AUFBAU

Die Notwendigkeit der Zeile „Fakturierungsvolumen“ ergibt sich durch die zeitliche Abbildung der Kennzahlen in COIN: Während alle KPIs vor dem BRUMS zu dem Zeitpunkt abgebildet werden, an dem das Ereignis eintritt, wird der BRUMS am Fakturierungsdatum ausgewiesen. I.d.R. erfolgt die Fakturierung mit einem Tag Versatz zum Auftragseingang. Daher werden Nachfrage und Ansprache bei sofort lieferfähigen Auftragspositionen am heutigen Tag, der BRUMS aber erst am Folgetag ausgewiesen. Diesen Zeitversatz „überbrücken“ Aufträge im Fakturierungsvolumen: Dieses wird aufgebaut, wenn ein Auftrag zur Fakturierung bereitsteht, und i.d.R. mit der Fakturierung selbst (BRUMS-Ausweis) wieder abgebaut.

KPI_184_LAGERDIFFERENZEN_STUECK

Lagerdifferenzen entstehen, wenn im Nachgang zur Fakturierung im Lager festgestellt wird, dass der bestellte – und laut Buchbestand lieferbare – Artikel nicht mehr vorhanden ist. Es besteht also eine Differenz zwischen dem erwarteten Buchbestand und dem tatsächlichen Bestand im Lager. In diesem Fall wird neben einer Lagerdifferenz ebenfalls ein negativer Bruttoumsatz ausgewiesen. Wird im Falle einer Lagerdifferenz ein Neuauftrag angelegt, so weist dieser weder Nachfrage noch Ansprache aus, da diese Kennzahlen bereits auf dem ursprünglichen Auftrag gezählt werden. Stattdessen wird auf dem Neuauftrag ein positiver Abbau der Lagerdifferenz ausgewiesen, welcher den negativen Lagerdifferenz-Aufbau des Ursprungsauftrags ausgleicht.

KPI_187_OFFENER_NAB_STUECK

Der offene Nachlieferungsbestand (NAB) bildet die tägliche Veränderung aller Auftragspositionen ab, die keinen lieferbaren Bestand aufweisen. Sobald ein lieferbarer Bestand vorliegt, erfolgt entweder die Fakturierung oder eine Umbuchung in den reservierten NAB, wenn aus anderen Gründen auf die Fakturierung gewartet werden soll.

KPI_190_RESERVIERTER_NAB_STUECK

Der reservierte Nachlieferungsbestand (NAB) bildet die tägliche Veränderung aller Auftragspositionen ab, die zwar einen lieferbaren Bestand aufweisen, aber dennoch nicht sofort ausgeliefert werden sollen. Gründe für ein solches Warten können z.B. sein, dass ein Kunde einen bestimmten späteren Liefertermin wünscht (Wunschtermin) oder auf die Komplettierung einer Bestellung gewartet wird.

4.1.4. Example

Message ERP to FINE
{
  "data": {
    "salesorderIdTok": "k4fP3CbV-Scg3-widQ-3Iwo-2ssY0JqpieUr",
    "returnKey": 422374877649,
    "kpiTimestamp": "2023-06-20T17:53:06.622+00:00",
    "kpiName": "KPI_8_ANSPRACHE",
    "kpiValue": 23.95,
    "customerCompanyNumber": 0,
    "customerTypeNumber": 22,
    "nonMerchandizeType": false
  },
  "eventId": "0f41e668-e476-4e89-b479-065a16375e4b",
  "eventTime": "2023-06-22T16:19:11",
  "eventType": "INSERT",
  "traceId": "07e72ff6af5647a05d278c24ed10fd19-d52239f8f8855d79ab421bd0461f3715-2023-06-20T17:53:06.622+00:00",
  "version": "2.00"
}

4.1.5. Schema

Table 2. Version ERP to FINE
Status Version Number File Published on Changes

current version

2.00

https://doc.fine.gcp.osp-dev.de/registry/Outbound/OrderProcess.v2.00.schema.json [Download]

26.06.2023

1. removal of Fields (related to article-Informations)
2. Integration of customerCompany-Informations
3. Integration of nonMerchandizeTypeId

deprecated version

1.00

https://doc.fine.gcp.osp-dev.de/registry/Outbound/OrderProcess.v1.00.schema.json [Download]

08.06.2023

initial
Interface ERP to FINE
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$comment": "Schema for OrderProcess from BRAIN to FINE",
  "$id": "https://doc.fine.gcp.osp-dev.de/registry/Outbound/OrderProcess.Brain.v2.00.schema.json",
  "type": "object",
  "title": "outbound.customerorder.orderprocess.brain",
  "description": "data from Brain about order-process (KPI)",
  "required": [
    "eventId",
    "eventTime",
    "eventType",
    "traceId",
    "version",
    "data"
  ],
  "properties": {
    "eventId": {
      "type": "string",
      "format": "uuid",
      "title": "The uniq eventId",
      "description": "Global uniq Id",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of technical 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:05Z"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "description": "Type of the event. The possible values are defined as Enum",
      "minLength": 1,
      "maxLength": 50,
      "enum": [
        "INSERT",
        "UPDATE"
      ],
      "examples": [
        "INSERT"
      ]
    },
    "traceId": {
      "type": "string",
      "format": "uuid",
      "title": "The uniq traceId",
      "description": "Global uniq Id for tracing the flow of events",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "version": {
      "title": "The number of version schema",
      "description": "Number of version of this data structure. Only required if no $schema is specified!",
      "type": "string",
      "pattern": "\\d+\\.\\d{1,2}",
      "examples": [
        "1.01"
      ]
    },
    "data": {
      "type": "object",
      "required": [
        "returnKey"
      ],
      "properties": {
        "returnKey": {
          "type": "integer",
          "title": "Retourenschluessel",
          "description": "Retourenschluessel der ausgehenden Sendung",
          "minimum": 1,
          "maximum": 999999999999999999,
          "examples": [
            "417919950186"
          ]
        },
        "kpiTimestamp": {
          "type": "string",
          "format": "date",
          "title": "KPI-Timestamp",
          "description": "fachlicher Zeitstempel, des Auftragsstatus (KPI laut BRAIN) im ISO 8601-Format.",
          "examples": [
            "2022-09-26T13:59:36.631+02:00"
          ]
        },
        "kpiName": {
          "type": "string",
          "title": "Enum zur Abbildung des Auftragsstatus (KPI laut BRAIN)",
          "description": "KPI/Auftragsstatus",
          "minLength": 10,
          "maxLength": 100,
          "enum": [
            "KPI_1_NACHFRAGE",
            "KPI_8_ANSPRACHE",
            "KPI_22_MENGENSTEUERUNG_AUFBAU",
            "KPI_25_FAKTURIERUNGSVOLUMEN_AUFBAU",
            "KPI_184_LAGERDIFFERENZEN_STUECK",
            "KPI_187_OFFENER_NAB_STUECK",
            "KPI_190_RESERVIERTER_NAB_STUECK"
          ],
          "examples": [
            "KPI_190_RESERVIERTER_NAB_STUECK"
          ]
        },
        "kpiValue": {
          "type": "number",
          "title": "Wert der KPI/Auftragsstatus",
          "description": "Gibt den Wert des Auftragssstatus an, z.B. Auftragswert oder Lagerbestandsmenge",
          "examples": [
            "7.24",
            "-1"
          ]
        },
        "salesorderIdTok": {
          "type": "string",
          "title": "key to identify SalesorderID",
          "description": "tokenisierte eindeutige Id der Bestellung",
          "minLength": 25,
          "maxLength": 50,
          "examples": [
            "ChqB2ZjAL"
          ]
        },
        "customerCompanyNumber": {
          "type": "integer",
          "title": "Number of the customer-company",
          "description": "Kundenfirmennummer",
          "minimum": 0,
          "maximum": 2000000000,
          "examples": [
            ""
          ]
        },
        "customerTypeNumber": {
          "type": "integer",
          "title": "Type of the customer",
          "description": "Kundenart",
          "minimum": 0,
          "maximum": 30000,
          "examples": [
            "ChqB2ZjAL"
          ]
        },
        "nonMerchandizeType": {
          "type": "boolean",
          "title": "non-Merchandize-Type-Id",
          "description": "Nicht-handelsware-Kennzeichen",
          "examples": [
            "true", "false"
          ]
        }
      }
    }
  }
}

8 - O51 ShipmentMasterdata

Status

Version 1.0 published 26.06.2023

Approval

  1. xxx

Comment

xxx

Assumption

xxx

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

FLASH

InterfaceOwner

FLASH

Producer

BRAIN

Consumer

FLASH

2. Business Context

Die Schnittstelle bildet die Sendungsdaten (Artikel, Trackingnummer, Anzahl Packstücke für GL und den Lagerstandort) aus DeepSea für einzelne Retourenschlüssel ab. Die SST ergänzt die Daten aus O50 - OrderProcess.

3. Informationflow

flow

4. Interface

4.1. Direction ERP to FINE

4.1.1. Header

This interface uses the Service Header

4.1.2. Datamodel

Property Type Description

(Root)

object

outbound.shipmentmasterdata
data from Brain about Shipmentdata

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

    eventTime*

string

Time of technical 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. Only required if no $schema is specified!

Regular expression: \d+\.\d{1,2}

    eventType*

string (enum)

The concrete type = kind of record(event)
Type of the event. The possible values are defined as Enum

Any of: [ "INSERT", "UPDATE" ]
Minimum Length: 1
Maximum Length: 50

    data*

object

        returnKey*

string

Retourenschluessel
Retourenschluessel der ausgehenden Sendung

Minimum Length: 1
Maximum Length: 25

        trackingNumber

string

Sendungsidentnummer
Sendungsidentnummer der ausgehenden Sendung

Minimum Length: 1
Maximum Length: 50

        partnerVariationId

string

ERP-ProductId
ERP-Id laut LSAS-Artikelstamm

Minimum Length: 18
Maximum Length: 36

        erpId

string

ERP-Id
fuehrendes System für Artiklinformationen

Minimum Length: 1
Maximum Length: 25

        packageCount

integer

Kollimenge
Anzahl der Kolli je Sendung

Minimum: 1
Maximum: 999

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

        handling

string

Handling
Gibt das Handling des Artikels an. PL/GL (1Mh/2MH)

Minimum Length: 2
Maximum Length: 10

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

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

current version

1.0

Download

26.06.2023

initial

previous version

coming version
Interface ERP to FINE
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for Shipment-MAsterdata from ERP to FINE",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Outbound/ShipmentMasterdata.v1.0.schema.json",
    "type": "object",
    "title": "outbound.shipmentmasterdata",
    "description": "data from Brain about Shipmentdata",
    "required": [
      "eventId",
      "eventType",
      "traceId",
      "eventTime",
      "version",
      "data"
    ],
    "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-8128-be118faf1d87"
        ]
      },
      "eventTime": {
        "type": "string",
        "title": "Time of technical 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:05Z"
        ]
      },
      "version": {
        "title": "The number of version schema",
        "description": "Number of version of this data structure. Only required if no $schema is specified!",
        "type": "string",
        "pattern": "\\d+\\.\\d{1,2}",
        "examples": [ "1.01" ]
      },
      "eventType": {
        "type": "string",
        "title": "The concrete type = kind of record(event)",
        "description": "Type of the event. The possible values are defined as Enum",
        "minLength": 1,
        "maxLength": 50,
        "enum": [ "INSERT", "UPDATE"],
        "examples": [
          "INSERT"
        ]
      },
      "data": {
        "type": "object",
        "required": [
          "returnKey"
        ],
        "properties": {
            "returnKey": {
                "type": "string",
                "title": "Retourenschluessel",
                "description": "Retourenschluessel der ausgehenden Sendung",
                "minLength": 1,
                "maxLength": 25,
                "examples": [
                  "417919950186"
                ]
              },
              "trackingNumber": {
                "type": "string",
                "title": "Sendungsidentnummer",
                "description": "Sendungsidentnummer der ausgehenden Sendung",
                "minLength": 1,
                "maxLength": 50,
                "examples": [
                  "H1023790000000107062"
                ]
              },
              "partnerVariationId": {
                "type": "string",
                "title": "ERP-ProductId",
                "description": "ERP-Id laut LSAS-Artikelstamm",
                "minLength": 18,
                "maxLength": 36,
                "examples": [
                  "8a9e857b-10a8-5e38-a493-4899ed47e75a"
                ]
              },
              "erpId": {
                "type": "string",
                "title": "ERP-Id",
                "description": "fuehrendes System für Artiklinformationen",
                "minLength": 1,
                "maxLength": 25,
                "examples": [
                  "LDH"
                ]
              },
              "packageCount": {
                "type": "integer",
                "title": "Kollimenge",
                "description": "Anzahl der Kolli je Sendung",
                "minimum": 1,
                "maximum": 999,
                "examples": [
                  "417919950186"
                ]
              },
              "location": {
                "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
              },
              "handling":{
                "type": "string",
                "title": "Handling",
                "description": "Gibt das Handling des Artikels an. PL/GL (1Mh/2MH)",
                "minLength": 2,
                "maxLength": 10,
                "examples": ["PL","GL", "1MH"]
             }
            }
        }
      }
    }

9 - O61 OrderDataToFlash

Status

Version 1.0.0 published 05.11.2024

Approval

  1. xxx

Comment

xxx

Assumption

xxx

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

FLASH

InterfaceOwner

FLASH

Producer

F2X

Consumer

FLASH

2. Business Context

This interface sends order data from F2X to FLASH via FINE.

3. Informationflow

image:

4. Interface

4.1. Direction F2X to FINE

4.1.1. Header

This interface uses the Service Header

4.1.2. Datamodel

Property Type Description

(Root)

object

outbound.orderdatatoflash.f2x
orderdata from F2X to flash

Additional Properties: false

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    traceId*

string (uuid)

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

Minimum Length: 36
Maximum Length: 36

    eventTime*

string

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

    eventType*

string (enum)

The concrete type = kind of record(event)
Type of the event. Several different events are tracked during the picking an goods issue process. The possible values are defined as Enum

Any of: [ "INSERT", "UPDATE" ]
Minimum Length: 1
Maximum Length: 50

    version*

string

The number of version schema
Number of version of this data structure. Only required if no $schema is specified!

Regular expression: \d+\.\d{1,2}

    meta*

object

        sender*

string (enum)

The name of sender = producer
An explanation about the purpose of this instance.

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

        businessType*

string (enum)

type of business
concrete type of business

Any of: [ "B2B", "B2C" ]
Minimum Length: 1
Maximum Length: 50

        orderOwner*

string

order owner
Owner of the order. Same as for Logistikpuffer, ReSy, e.g.

Minimum Length: 1
Maximum Length: 50

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

        businessEventType*

string (enum)

The concrete business eventtype of the record
Type of the event. Several different events are tracked. The possible values are defined as enum

Any of: [ "ERP_CUSTOMER_ORDER", "ERP_ORDER_CREATED_AT", "F2X_ORDER_RECEIVED", "F2X_ORDER_REJECTION", "F2X_ORDER_SUBMISSION_TO_WHS", "WHS_INVOICE_REQUEST", "WHS_LABEL_DOCUMENT", "WHS_GOODS_ISSUE_NOTE", "WHS_GOODS_ISSUE_NOTE_SUBMISSION_TO_F2X", "F2X_GOODS_ISSUE_NOTE_SUBMISSION_TO_ERP", "WHS_CANCELATION_NOTE", "WHS_CANCELATION_NOTE_SUBMISSION_TO_F2X", "F2X_CANCELATION_NOTE_SUBMISSION_TO_ERP" ]
Minimum Length: 1
Maximum Length: 50

        businessEventTimestamp*

string (date-time)

timestamp of occurrence of the business event type
Time at which this businees event type was physically generated in RFC3339 format. In local time with offset.

        saleschannel

string

saleschannel
saleschannel of the order

Minimum Length: 1
Maximum Length: 50

        orderType

string

order type
order type (MFDE, MFCH, MAINT eg.)

Minimum Length: 1
Maximum Length: 50

        clientOrderId*

string

client order id
client order id of the several ERP

Minimum Length: 1
Maximum Length: 50

        f2xOrderId

string

f2x order id
internal F2X order id

Minimum Length: 1
Maximum Length: 50

        whsOrderId

string

warehouse order id
warehouse order id

Minimum Length: 1
Maximum Length: 50

        whsSubOrderId

string

warehouse sub order id
warehouse sub order id (Teilauftragsnummer/ partital order number)

Minimum Length: 1
Maximum Length: 50

        logisticsProductId

integer

unique key for an item(size)
unique key for an item(size) from product master data (if available)

Minimum: 1
Maximum: 1000000000000000000

        articleNumber

string

article number
internal article id, F2X article number if logisticsProductId is not avaiable

Minimum Length: 1
Maximum Length: 50

        articlePositionNumber

integer

article position number
position in order

Minimum: 1
Maximum: 1000000000000000000

        quantity*

integer

quantity
quantity of article position

Minimum: 1
Maximum: 1000000000000000000

        carrier

string

carrier
name of carrier

Minimum Length: 1
Maximum Length: 50

        shippingTrackingNumber

string

outgoing shipment tracking number
goods issue identnumber

Minimum Length: 1
Maximum Length: 50

        returnTrackingNumber

string

return tracking number
return identnumber

Minimum Length: 1
Maximum Length: 50

        rejectionReason

string

rejection reason
one reason for rejection

Minimum Length: 1
Maximum Length: 50

        retryFlag

string

retry flag
retry flag (technical)

Minimum Length: 1
Maximum Length: 50

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

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

initial version

1.0.0

Download

04.11.2024
Interface F2X to FINE
{
  "type": "object",
  "title": "outbound.orderdatatoflash.f2x",
  "description": "orderdata from F2X to flash",
  "required": [
    "eventId",
    "traceId",
    "eventTime",
    "version",
    "eventType",
    "meta",
	"sender",
    "data"
  ],
  "properties": {
    "eventId": {
      "type": "string",
      "format": "uuid",
      "title": "The uniq eventId",
      "description": "Global uniq Id",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "traceId": {
        "title": "The unique traceId",
        "description": "Global unique Id for tracing the flow of events",
        "type": "string",
        "format": "uuid",
        "minLength": 36,
        "maxLength": 36,
        "examples": [
            "00ce536f-923a-42f4-8138-33418faf1342"
        ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of technical 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"
      ]
    },"eventType": {
		"type": "string",
		"title": "The concrete type = kind of record(event)",
		"description": "Type of the event. Several different events are tracked during the picking an goods issue process. The possible values are defined as Enum",
		"minLength": 1,
		"maxLength": 50,
		"enum":[ "INSERT", "UPDATE"],
		"examples": [
			"insert"
			  ]
			},
    "version": {
      "title": "The number of version schema",
      "description": "Number of version of this data structure. Only required if no $schema is specified!",
      "type": "string",
      "pattern": "\\d+\\.\\d{1,2}",
      "examples": [ "1.01" ]
    },
    
    "meta": {
      "type": "object",
      "required": [
        "sender"
      ],
      "properties": {
        "sender": {
          "title": "The name of sender = producer",
          "description": "An explanation about the purpose of this instance.",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v7.schema.json"
        }
      }
    },
    "data": {
      "type": "object",
      "required": [
        "businessType",
		    "orderOwner",
        "location",
        "businessEventType",
		    "businessEventTimestamp",
        "clientOrderId",
		    "quantity"
      ],
      "properties": {
		"businessType": {
			"type": "string",
			"title": "type of business",
			"description": "concrete type of business",
			"minLength": 1,
			"maxLength": 50,
			"enum":[ "B2B", "B2C" ],
			"examples": [
				"B2B"
				]
		},
		"orderOwner": {
			"type": "string",
			"title": "order owner",
			"description": "Owner of the order. Same as for Logistikpuffer, ReSy, e.g.",
			"minLength": 1,
			"maxLength": 50,
			"examples": [
				"TAZZIO", "TAZZIO_OV"
				]
		},
		"location": {
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
        },
		"businessEventType": {
			  "type": "string",
			  "title": "The concrete business eventtype of the record",
			  "description": "Type of the event. Several different events are tracked. The possible values are defined as enum",
			  "minLength": 1,
			  "maxLength": 50,
			  "enum":[ "ERP_CUSTOMER_ORDER", "ERP_ORDER_CREATED_AT", "F2X_ORDER_RECEIVED", "F2X_ORDER_REJECTION", "F2X_ORDER_SUBMISSION_TO_WHS", "WHS_INVOICE_REQUEST", "WHS_LABEL_DOCUMENT", "WHS_GOODS_ISSUE_NOTE", "WHS_GOODS_ISSUE_NOTE_SUBMISSION_TO_F2X", "F2X_GOODS_ISSUE_NOTE_SUBMISSION_TO_ERP", "WHS_CANCELATION_NOTE","WHS_CANCELATION_NOTE_SUBMISSION_TO_F2X", "F2X_CANCELATION_NOTE_SUBMISSION_TO_ERP" ],
			  "examples": [
				"ERP_CUSTOMER_ORDER"
		  ]
		},
        "businessEventTimestamp": {
          "type": "string",
          "format": "date-time",
          "title": "timestamp of occurrence of the business event type",
          "description": "Time at which this businees event type was physically generated in RFC3339 format. In local time with offset.",
          "examples": [
            "2016-04-16T16:06:05.000+02:00"
          ]
        },
        "saleschannel ": {
		  "type": "string",
          "title": "saleschannel",
          "description": "saleschannel of the order",
          "minLength": 1,
          "maxLength": 50,
          "examples": [
            "Amazon" , "Ebay"
          ]
        },
		"orderType ": {
		  "type": "string",
          "title": "order type",
          "description": "order type (MFDE, MFCH, MAINT eg.)",
          "minLength": 1,
          "maxLength": 50,
          "examples": [
            "MFDE"
          ]
        },
		"clientOrderId": {
		  "type": "string",
          "title": "client order id",
          "description": "client order id of the several ERP",
          "minLength": 1,
          "maxLength": 50,
          "examples": [
            "23456"
          ]
        },
		"f2xOrderId": {
		  "type": "string",
          "title": "f2x order id",
          "description": "internal F2X order id",
          "minLength": 1,
          "maxLength": 50,
          "examples": [
            "815243"
          ]
        },
		"whsOrderId": {
		  "type": "string",
          "title": "warehouse order id",
          "description": "warehouse order id",
          "minLength": 1,
          "maxLength": 50,
          "examples": [
            "916454534"
          ]
        },
		"whsSubOrderId": {
		  "type": "string",
          "title": "warehouse sub order id",
          "description": "warehouse sub order id (Teilauftragsnummer/ partital order number)",
          "minLength": 1,
          "maxLength": 50,
          "examples": [
            "1"
          ]
        },
		"logisticsProductId": {
          "type": "integer",
          "title": "unique key for an item(size)",
          "description": "unique key for an item(size) from product master data (if available)",
          "minimum": 1,
          "maximum": 999999999999999999,
          "examples": [
            "123456789"
          ]
        },
		"articleNumber": {
		  "type": "string",
          "title": "article number",
          "description": "internal article id, F2X article number if logisticsProductId is not avaiable",
          "minLength": 1,
          "maxLength": 50,
          "examples": [
            "T-Shirt_Black_12386543", "000000000000098735"
          ]
        },
		"articlePositionNumber": {
          "type": "integer",
          "title": "article position number",
          "description": "position in order",
          "minimum": 1,
          "maximum": 999999999999999999,
          "examples": [
            "2"
          ]
        },
		"quantity": {
          "type": "integer",
          "title": "quantity",
          "description": "quantity of article position",
          "minimum": 1,
          "maximum": 999999999999999999,
          "examples": [
            "2"
          ]
        },
		"carrier": {
		  "type": "string",
          "title": "carrier",
          "description": "name of carrier",
          "minLength": 1,
          "maxLength": 50,
          "examples": [
            "DHL"
          ]
        },
		"shippingTrackingNumber": {
		  "type": "string",
          "title": "outgoing shipment tracking number",
          "description": "goods issue identnumber",
          "minLength": 1,
          "maxLength": 50,
          "examples": [
            ""
          ]
        },
		"returnTrackingNumber": {
		  "type": "string",
          "title": "return tracking number",
          "description": "return identnumber",
          "minLength": 1,
          "maxLength": 50,
          "examples": [
            ""
          ]
        },
		"rejectionReason": {
		  "type": "string",
          "title": "rejection reason",
          "description": "one reason for rejection",
          "minLength": 1,
          "maxLength": 50,
          "examples": [
            "Invalid time value"
          ]
        },
		"retryFlag": {
		  "type": "string",
          "title": "retry flag",
          "description": "retry flag (technical)",
          "minLength": 1,
          "maxLength": 50,
          "examples": [
            "0"
          ]
        }
      }
    }
  },
  "additionalProperties": false
}

10 - O64 buffer item

Status

Version 1.0.0 published 12.03.2025

Approval

  1. xxx

Comment

xxx

Assumption

xxx

1. Stakeholder

Role Application Responsible

Communication

Integration Layer

Leading App

FLASH

InterfaceOwner

FLASH

Producer

FLASH

Consumer

BRAIN

2. Business Context

The interface provides data for yesterday.It is provided for every article that has at least one item in the buffer. Additional informations for the same day and artilce about quantities of called-Off, cancelled and created at system 'Logistikpuffer'. The granularity: - erpProductId - warehouseLocation - date - handling - volumecluster

3. Informationflow

flow

4. Interface

4.1. Direction FLASH to FINE

4.1.1. Header

This interface uses the Service Header

4.1.2. Datamodel

Property Type Description

(Root)

object

outbound.buffer.item
data provided by FLASH about buffered items in system 'Logistikpuffer'

    eventId*

string (uuid)

The uniq eventId
Global uniq Id

    eventTime*

string

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

    eventType*

string (enum)

The concrete type = kind of record(event)
Type of the event. The possible values are defined as Enum

Any of: [ "INSERT", "UPDATE" ]
Minimum Length: 1
Maximum Length: 50

    context*

string

Context of the message
short description about the content of the message

    version*

string

The number of version schema
Number of version of this data structure. Only required if no $schema is specified!

Regular expression: \d+\.\d{1,2}

    meta*

object

        senderSystem*

string

senderSystem
name of sending system, according to fine-standard

Minimum Length: 1
Maximum Length: 25

    data*

object

        erpProductId*

string

erpProductId / externe technische Artikel Referenz
reference to article-number from soucesystem, provided bei lsas

Minimum Length: 1
Maximum Length: 50

        date*

string

date / Datum
Date which the message relates to

Minimum Length: 8
Maximum Length: 8

        warehouseLocation*

string (enum)

warehouseLocation / Logistikstandort

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

        customerCompanyNumber*

string

customerCompanyNumber / Kundenfirmenkennzeichen
Number of the customer company

Minimum Length: 25
Maximum Length: 50

        handling*

string

handling / Abwicklung
Name of handling as provided by lsas-article-informations

Minimum Length: 25
Maximum Length: 50

        volumecluster*

string

volume-cluster / Mengencluster
Name of the used volumecluster

Minimum Length: 25
Maximum Length: 50

        bufferCreatedQuantity

integer

Quantity, of created Aritcles at system 'Logistikpuffer'.

Minimum: 0
Maximum: 1e+21

        cancellationQuantity

integer

Quantity, of cancelled Aritcles at system 'Logistikpuffer'.

Minimum: 0
Maximum: 1e+21

        callOffQuantity

integer

Quantity, of called-off Aritcles at system 'Logistikpuffer'.

Minimum: 0
Maximum: 1e+21

        bufferQuantity*

integer

Quantity, of still buffered Aritcles at system 'Logistikpuffer'.

Minimum: 1
Maximum: 1e+21

4.1.3. Enumeration

4.1.4. Example

4.1.5. Schema

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

initial version

1.0.0

Download

12.03.2025
Interface FLASH to FINE
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$comment": "Schema for outbound buffer item from FLASH to FINE",
  "$id": "https://doc.fine.gcp.osp-dev.de/registry/Outbound/outbound.buffer.item.v1.0.schema.json",
  "type": "object",
  "title": "outbound.buffer.item",
  "description": "data provided by FLASH about buffered items in system 'Logistikpuffer'",
  "required": [
    "eventId",
    "eventTime",
    "eventType",
    "context",
    "meta",
    "version",
    "data"
  ],
  "properties": {
    "eventId": {
      "type": "string",
      "format": "uuid",
      "title": "The uniq eventId",
      "description": "Global uniq Id",
      "examples": [
        "00ce536f-923a-42f4-8128-be118faf1d87"
      ]
    },
    "eventTime": {
      "type": "string",
      "title": "Time of technical 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:05Z"
      ]
    },
    "eventType": {
      "type": "string",
      "title": "The concrete type = kind of record(event)",
      "description": "Type of the event. The possible values are defined as Enum",
      "minLength": 1,
      "maxLength": 50,
      "enum": [
        "INSERT",
        "UPDATE"
      ],
      "examples": [
        "INSERT"
      ]
    },
    "context": {
      "type": "string",
       "title": "Context of the message",
      "description": "short description about the content of the message",
      "examples": [
        "Export_LSP"
      ]
    },
    "version": {
      "title": "The number of version schema",
      "description": "Number of version of this data structure. Only required if no $schema is specified!",
      "type": "string",
      "pattern": "\\d+\\.\\d{1,2}",
      "examples": [
        "1.01"
      ]
    },
    "meta": {
        "type": "object",
        "required": ["senderSystem"],
        "properties": {
            "senderSystem":{
                "type":"string",
                "title": "senderSystem",
                "description": "name of sending system, according to fine-standard",
                "minLength":1,
                "maxLength": 25
            }
        }
    },
    "data": {
      "type": "object",
      "required": [
        "erpProductId",
        "date",
        "warehouseLocation",
        "customerCompanyNumber",
        "handling",
        "volumecluster",
        "bufferQuantity"
      ],
      "properties": {
        "erpProductId": {
          "type": "string",
          "title": "erpProductId / externe technische Artikel Referenz",
          "description": "reference to article-number from soucesystem, provided bei lsas",
          "minLength": 1,
          "maxLength": 50,
          "examples": [
            "92ef07f1-5dd0-5089-94b5-4f2c7f57414a"
          ]
        },
        "date": {
          "type": "string",
          "title": "date / Datum",
          "description": "Date which the message relates to",
          "minLength": 8,
          "maxLength": 8,
          "examples": [
            "2025-04-14"
          ]
        },
        "warehouseLocation": {
          "type": "string",
          "title": "warehouseLocation / Logistikstandort",
          "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
        },
        "customerCompanyNumber": {
          "type": "string",
          "title": "customerCompanyNumber / Kundenfirmenkennzeichen",
          "description": "Number of the customer company",
          "minLength": 25,
          "maxLength": 50,
          "examples": [
            "44"
          ]
        },
        "handling": {
          "type": "string",
          "title": "handling / Abwicklung",
          "description": "Name of handling as provided by lsas-article-informations",
          "minLength": 25,
          "maxLength": 50,
          "examples": [
            "Lagerware"
          ]
        },
        "volumecluster": {
          "type": "string",
          "title": "volume-cluster / Mengencluster",
          "description": "Name of the used volumecluster",
          "minLength": 25,
          "maxLength": 50,
          "examples": [
            "1-AK-Tüte","Sorter"
          ]
        },
        "bufferCreatedQuantity": {
          "type": "integer",
          "title": "",
          "description": "Quantity, of created Aritcles at system 'Logistikpuffer'.",
          "minimum": 0,
          "maximum": 999999999999999999999,
          "examples": [
            "99"
          ]
        },
        "cancellationQuantity": {
          "type": "integer",
          "title": "",
          "description": "Quantity, of cancelled Aritcles at system 'Logistikpuffer'.",
          "minimum": 0,
          "maximum": 999999999999999999999,
          "examples": [
            "1"
          ]
        },
        "callOffQuantity": {
          "type": "integer",
          "title": "",
          "description": "Quantity, of called-off Aritcles at system 'Logistikpuffer'.",
          "minimum": 0,
          "maximum": 999999999999999999999,
          "examples": [
            "5"
          ]
        },
        "bufferQuantity": {
          "type": "integer",
          "title": "",
          "description": "Quantity, of still buffered Aritcles at system 'Logistikpuffer'.",
          "minimum": 1,
          "maximum": 999999999999999999999,
          "examples": [
            "12"
          ]
        }
      }
    }
  }
}