{
"$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"
]
}
}
}
}
}
O46 DeliveryStatement
- Status
-
Version 2.0 published 17.10.2022
- Approval
-
-
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
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 |
eventId* |
string (uuid) |
The uniq eventId |
traceId* |
string (uuid) |
The uniq traceId |
eventTime* |
string |
Time of technical occurrence of the event |
version* |
string |
The number of version schema Regular expression: \d+\.\d{1,2} |
eventType* |
string (enum) |
The concrete type = kind of record(event) Any of: [
"INSERT",
"UPDATE"
] |
data* |
object |
|
deliveryStatementWorkdays |
integer,null |
Anzahl der Werktage Minimum: 0 |
deliveryDate |
string,null (date) |
Liefertermin Minimum Length: 10 |
returnKey* |
integer |
Retourenschluessel Minimum: 1 |
deliveryStatementCode |
integer,null |
Lieferzeit-Id Minimum: 1 |
deliveryStatementDescription |
string,null |
Lieferzeit Beschreibung Minimum Length: 1 |
deliveryInformationReasonCode |
integer,null |
Grund des Lieferstatus als Id Minimum: 1 |
deliveryInformationReasonDescription |
string,null |
Grund des aktuellen Lieferstatus Minimum Length: 1 |
slbCode |
integer,null |
Code der sofortigen Lieferbarkeit Minimum: 1 |
slbDescription |
string,null |
Beschreibung der sofortigen Lieferbarkeit Minimum Length: 1 |
shipmentServiceTypeCode |
integer,null |
Lieferservicetyp als Id Minimum: 1 |
shipmentServiceTypeDescription |
string,null |
Beschreibung des Lieferservicetyps Minimum Length: 1 |
businessEventTimestamp |
string |
Fachlicher Zeitstempel |
RUN_ID |
string |
RUN_ID Minimum Length: 14 |
4.1.3. Enumeration
4.1.4. Example
4.1.5. Schema
Version | Number | File | Published on | Changes |
---|---|---|---|---|
current version |
2.0 |
17.10.2022 |
Anpassung auf Retourenschluessel-Granularität |
|
previous version |
1.0 |
24.08.2022 |
initial |
|
coming version |