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