This is the multi-page printable view of this section. Click here to print.
FLASH
1 -
1.1 -
| Property | Type | Description |
|---|---|---|
(Root) |
object |
Additional Properties: false |
eventId* |
string |
The unique eventId. Global uniq Id, recommended as uuid |
eventTime* |
string (date-time) |
Time at which this record(event) was technically generated in RFC3339 format with timezone ([+|-]hh:mi) |
version* |
string |
Number of version of this data structure. Either a sematic specification(String with major & minor nr) or the version number in the Kafka schema registry |
context* |
string (const) |
The context of this message is always forecast (constant FORECAST) Constant: FORECAST |
eventType* |
string (const) |
Kind of "event" that describes the following data. In this case always UPDATE Constant: UPDATE |
data* |
object |
Element holding the payload for this message. Additional Properties: false |
creationTimestamp* |
string (date-time) |
Datetime at which this record(event) was actually issued in RFC3339 format with timezone ([+|-]hh:mi): yyyy-mm-ddTHH:mi:ss[+|-]HH:MI |
forecastType* |
string |
Kind / Type of forecast. Currently supported values 'TaProg_angepasst', 'WoProg_Handel'. |
forecastPeriod* |
string (enum) |
Period the forecast-date belongs to. For daily values use 'DAY', for week or month other matching enums. A 5-Week-Forecast forecasts single days for example. Any of: [
"DAY",
"ISO_WEEK",
"MONTH"
] |
forecastDate* |
string (date) |
Date the forecast belongs to in format "yyyy-mm-dd". Depending on forecastPeriod, this refers to one particular day ("DAY"), the first day of the week ("ISO_WEEK") or the first day of the month (("MONTH") |
forecastDimensions* |
object |
Planning dimensions of the forecast |
company |
string |
if applicable, actual company. Currently supported: 'OTTO' |
location* |
string |
location-dimension for a forecast measure, e.g. ILOWA_RT. Uses locations provided by FINE |
forecastMeasure* |
object |
Planned Measure |
name* |
string |
Name of the measure. Currently supported: 'Umfuhr_ex_HDL', 'Umfuhr_ex_SDH', 'Umfuhr_ex_SNF', 'WE_Lukenerfassung', 'WER', 'RT-Leistung_inkl_Zweitbearbeitung'. |
value* |
string |
Actual value of the measure, numeric datatype with 19 digits and 9 decimal places |
unit* |
string (enum) |
Unit of the measure Any of: [
"AK",
"Kolli"
] |
2 - CD01 F2X Forecasts
- Status
-
Version 1.0 published 16.01.2024
- Approval
- Comment
- Assumption
-
_
1. Stakeholder
| Role | Application | Responsible |
|---|---|---|
Communication |
Integration Layer |
|
Leading App |
||
InterfaceOwner |
FLASH |
|
Producer |
F2X |
|
Consumer |
FLASH |
2. Business Context
Forecasts regarding inbound, outbound and returns for f2x-costumers. Data is consumed by flash to put forecast against actual measures.
3. Informationflow
| Partner | Direction | FINE-Service | Topic/API | Description | Status |
|---|---|---|---|---|---|
WMS:F2X |
send |
CDI |
crossdomain.forecasts.f2x |
F2X_Forecasts.v1.0 |
planned |
FLASH |
receive |
CDI |
crossdomain.forecasts.f2x |
F2X_Forecasts.v1.0 |
planned |
4. Interface
4.1. Direction WMS to FINE and FINE to WMS
4.1.1. Header
This interface uses the Service Header
Special expresion for this interface:
| Fieldname | Expresion |
|---|---|
- |
- |
- |
- |
4.1.2. Datamodel
Unresolved directive in <stdin> - include::autogenerated-schema-tables/forecast.f2x.v1.0.schema.adoc[]
4.1.3. Enumeration
4.1.4. Example
//include::forecast.f2x.sample.json[]4.1.5. Schema
| Version | Number | File | Published on | Changes |
|---|---|---|---|---|
current version |
1.0 |
18.12.2023 |
||
previous version |
||||
coming version |
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"required": [
"eventId",
"traceId",
"eventTime",
"version",
"context",
"eventType",
"data"
],
"properties": {
"eventId": {
"type": "string",
"description": "The unique eventId. Global uniq Id, recommended as uuid"
},
"traceId": {
"type": "string",
"description": "The unique eventId. Global uniq Id for tracing the flow of events. In case of masterdata there is no real flow, use the same value as in data->key"
},
"eventTime": {
"type": "string",
"format": "date-time",
"description": "Time at which this record(event) was technically generated in RFC3339 format with timezone ([+|-]hh:mi)"
},
"version": {
"type": "string",
"const": "1.0.0",
"description": "Number of version of this data structure. Either a sematic specification(String with major & minor nr) or the version number in the Kafka schema registry"
},
"context": {
"type": "string",
"const": "forecast.f2x",
"description": "The context of this message is always f2x' forecasts (constant forecast.f2x)"
},
"eventType": {
"type": "string",
"const": "FORECAST",
"description": "Kind of \"event\" that describes the following data. In this case always FORECAST_UPDATE"
},
"data": {
"type": "object",
"description": "Element holding the payload for this message.",
"required": [
"creationTimestamp",
"forecastType",
"forecastPeriod",
"forecastDate",
"forecastDimensions",
"forecastMeasure"
],
"properties": {
"creationTimestamp": {
"type": "string",
"format": "date-time",
"description": "Datetime at which this record(event) was actually issued in RFC3339 format with timezone ([+|-]hh:mi): yyyy-mm-ddTHH:mi:ss[+|-]HH:MI",
"examples": ["2023-01-05T17:38:00+02:00"]
},
"forecastType": {
"type": "string",
"description": "Kind / Type of forecast. Differs between 5-week, quarter and yearly forecast.",
"enum": [
"5WEEK",
"QUARTER",
"YEAR"
]
},
"forecastPeriod": {
"type": "string",
"description": "Period the forecast-date belongs to. For daily values use 'day', for week or month other matching enums. A 5-Week-Forecast forecasts single days",
"enum": [
"DAY",
"ISO_WEEK",
"MONTH"
]
},
"forecastDate": {
"type": "string",
"format": "date",
"description": "Date the forecast belongs to in format \"yyyy-mm-dd\". Depending on forecastPeriod, this refers to one particular day (\"DAY\"), the first day of the week (\"ISO_WEEK\") or the first day of the month ((\"MONTH\")"
},
"forecastDimensions": {
"type": "object",
"description": "Planning dimensions of the forecast",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"description": "F2X-Partner the forecasat is made for.",
"enum": [
"F2X_MANUFACTUM",
"F2X_PERSONALSHOP",
"F2X_SHEEGO,"
]
},
"businessModel": {
"type": "string",
"description": "Dimension busines-Model the forecast is made for.",
"enum": [
"B2B",
"B2C"
]
},
"orderType": {
"type": "string",
"description": "Ordertype-Dimension. Seperates between one position salesorders (epos) and multi position salesorders (mpos)",
"enum": [
"EPOS",
"MPOS"
]
},
}
},
"forecastMeasure": {
"type": "object",
"description": "Planned Measure",
"required": [
"name",
"value",
"unit"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the measure. For now, only differentiated between IB (Inbound), OB (Outbound) and RT (Returns) in both amount an capacity",
"enum": [
"IB",
"IB_CAPACITY",
"OB",
"OB_CAPACITY",
"RT",
"RT_CAPACITY"
]
},
"value": {
"type": "integer",
"description": "Actual value of the measure",
"examples" : [1000, 200]
},
"unit": {
"type": "string",
"description": "Unit of the measure",
"enum": [
"AK"
]
},
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}3 - CD02 Prove
- Status
-
Version 1.5 published 30.09.2024
- Approval
- Comment
- Assumption
-
_
1. Stakeholder
| Role | Application | Responsible |
|---|---|---|
Communication |
Integration Layer |
|
Leading App |
||
InterfaceOwner |
FLASH |
|
Producer |
Kmotion |
|
Consumer |
FLASH |
2. Business Context
Im Rahmen von Prove sollen definierte Prozessevents und Meldepunkte aus dem WMS (kmotion) an FINE übermittelt werden.
3. Informationflow
| Partner | Direction | FINE-Service | Topic/API | Description | Status |
|---|---|---|---|---|---|
WMS:KMOTION |
send |
CDI |
crossdomain.prove.kmotion.v1 |
Prove.v1.5 |
planned |
FLASH |
receive |
CDI |
crossdomain.prove.kmotion.v1 |
Prove.v1.5 |
planned |
4. Interface
4.1. Direction WMS to FINE and FINE to WMS
4.1.1. Header
This interface uses the Service Header
Special expresion for this interface:
| Fieldname | Expresion |
|---|---|
context |
PROCESS_INFORMATION |
eventType |
INSERT, UPDATE, DELETE |
4.1.2. Datamodel
Unresolved directive in <stdin> - include::autogenerated-schema-tables/Prove.v1.5.schema.adoc[]
4.1.3. Enumeration
4.1.4. Example
//include::Prove.v1.2_sampleMessage.json[]4.1.5. Schema
| Version | Number | File | Published on | Changes |
|---|---|---|---|---|
coming version |
1.5 |
11.09.2024 |
Aufnahme von source→ storageParentHandlingUnitId und additionalInformation → deliveryType, additionalInformation → orderBatchCreationDate |
|
current version |
1.4 |
13.08.2024 |
||
previous version |
1.3 |
18.12.2023 |
{
"$schema": "http://json-schema.org/draft-07/schema",
"$comment": "Schema for processevents in a warehouse Version 1.5",
"$id": "https://doc.fine.gcp.osp-dev.de/registry/CDI/Prove.v1.5.schema.json",
"type": "object",
"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-8138-33418faf1342"
]
},
"spanId": {
"type": "string",
"title": "The eventId of previous record or batchId",
"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), recommended as uuid, Special usecases can be specify for some interfaces",
"examples": [
"00ce536f-923a-42f4-5463-32a41877b3c2"
]
},
"eventTime": {
"type": "string",
"title": "Time of 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!",
"oneOf": [
{
"type": "string",
"pattern": "\\d+\\.\\d{1,2}",
"maxLength": 6,
"examples": ["1.01", "01.02"]
},
{
"type": "integer",
"minimum": 1,
"maximum": 99999,
"examples": [1, 2]
}
]
},
"context": {
"type": "string",
"title": "The context / business case",
"description": "The context specified here means the business domain.",
"examples": [
"PROCESS_INFORMATION"
]
},
"eventType": {
"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.",
"type": "string",
"title": "Event Type",
"examples": ["INSERT","UPDATE","DELETE"]
},
"metaData": {
"type": "object",
"title": "additional meta information",
"description": "optional, can be used with different characteristics for technical data per interface",
"properties": {
"senderSystem": {
"$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v4.schema.json"
},
"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.v6.schema.json"
}
},
"additionalProperties": false,
"required": [
"senderSystem"
]
},
"data": {
"type": "object",
"description": "contains the process data and the quantity information for a given process",
"properties": {
"processBusinessTime": {
"description": "buness timestamp of the process",
"type": "string",
"format": "date-time",
"title": "business process time",
"examples": [
"2022-03-22T09:52:00.000+01:00"
]
},
"proveId": {
"description": "reference to the prove ID",
"type": "string",
"title": "proveId"
},
"quantity": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "quantity for the process information depending on the cost driver"
},
"unit": {
"$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/unit.v1.schema.json"
}
}
},
"employeeId": {
"description": "Id of the employee",
"type": "string",
"title": "employeeId"
},
"workPlaceId": {
"description": "Id of the workplace",
"type": "string",
"title": "employeeId"
},
"location": {
"$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
},
"processData": {
"type": "array",
"description": "shows which related business entity in FINE contains more detailed process structure data such as product-information or storage locations etc.",
"movementId": {
"description": "points the the movementId from the FINE topic S03 Stock Movement",
"type": "string",
"title": "movementId",
"examples": [
"123"
]
},
"goodsInId": {
"description": "pointer to the goodsInId from the FINE topic I04 GoodsIn",
"type": "string",
"title": "goodsInId",
"examples": [
"123"
]
},
"goodsInPositionId": {
"description": "pointer to the goodsInPositionId from the FINE topic I04 GoodsIn",
"type": "string",
"title": "goodsInPositionId",
"examples": [
"123"
]
},
"storageNotificationId": {
"description": "pointer to the storageNotificationId from the FINE topic I01 StorageNotificationId",
"type": "string",
"title": "goodsInPositionId",
"examples": [
"123"
]
},
"BUAID": {
"description": "BI UUID, eindeutige Kennzeichnung eines Einzelteils (Quanten) im logistischen Prozess.",
"type": "string",
"title": "BUAID",
"examples": [ "2344545-334542-465g45ddf" ]
},
"logisticsProductId": {
"description": "technical ID 'logistics product ID'",
"type": "string",
"title": "¨Logistic Product Id",
"examples": [ "123" ]
},
"logisticsPackingUnitId": {
"description": "logistics packing unit ID",
"type": "string",
"title": "¨Logistic PackingUnit Id",
"examples": [ "123" ]
},
"logisticsSupplierId": {
"description": "technical ID 'logistics supplier ID'",
"type": "string",
"title": "¨",
"examples": [ "123" ]
},
"outgoingShipmentEntityNumber": {
"description": "outgoingShipmentEntityNumber as provided by system 'Logistikpuffer' - unique identifier for an outgoing component",
"type": "string",
"title": "outgoingShipmentEntityNumber",
"examples": [
"123"
]
},
"outgoingShipmentComponentNumber": {
"description": "outgoingShipmentComponentNumber as provided by system 'Logistikpuffer' - unique identifier for an outgoing component",
"type": "string",
"title": "outgoingShipmentComponentNumber",
"examples": [
"123"
]
},
"b2bOrderId": {
"description": "ERP Order Id",
"type": "string"
},
"outgoingShipmentOrderType ": {
"description": "concrete Type of the order, one of B2C or B2B",
"type": "string",
"title": "concrete Type of Order",
"minLength": 1,
"maxLength": 25,
"enum": [ "B2C", "B2B" ],
"examples": [ "B2C" ]
},
"outgoingShipmentOrderNumber": {
"type": "integer",
"title": "BI_SENDUNG_ID",
"description": "BI_SENDUNG_ID as provided by system 'Logistikpuffer' - unique identifier for an outgoing order",
"minimum": 1,
"maximum": 999999999999999999,
"examples": [
"12828863073836227"
]
},
"source": {
"type": "object",
"properties": {
"quantId": {
"description": "ID der feinsten bestandstrennenden Einheit",
"type": "string",
"title": "",
"examples": [ "1189582" ]
},
"storageLocationId": {
"description": "Eindeutige Identifikation eines Lagerplatzes. Weitere Details des Lagerplatzes sind aus masterdata.storageLocation ableitbar.",
"type": "string",
"title": "",
"examples": [ "123" ]
},
"storageHandlingUnitId": {
"description": "Eindeutige Identifikation eines Ladungsträgers. Weitere Details des Ladungsträgers sind aus masterdata.storageHandlingUnit ableitbar.",
"type": "string",
"title": "",
"examples": [ "123" ]
},
"storageParentHandlingUnitId": {
"description": "Eindeutige Identifikation eines Lagerhilfsmittels z.B. HUNT.",
"type": "string",
"title": "storageParentHandlingUnitId",
"examples": [ "123" ]
}
}
},
"target": {
"type": "object",
"properties": {
"quantId": {
"description": "ID der feinsten bestandstrennenden Einheit",
"type": "string",
"title": "",
"examples": [ "1189582" ]
},
"storageLocationId": {
"description": "Eindeutige Identifikation eines Lagerplatzes. Weitere Details des Lagerplatzes sind aus masterdata.storageLocation ableitbar.",
"type": "string",
"title": "",
"examples": [ "123" ]
},
"storageHandlingUnitId": {
"description": "Eindeutige Identifikation eines Ladungsträgers. Weitere Details des Ladungsträgers sind aus masterdata.storageHandlingUnit ableitbar.",
"type": "string",
"title": "",
"examples": [ "123" ]
}
}
},
"additionalInformation" :{
"type": "object",
"properties":{"orderBatchId":{"type":"string","minLength":1,"maxLength": 100},
"handlingRoute":{"type":"string","minLength":1,"maxLength": 25},
"pickingType":{"type":"string","minLength":1,"maxLength": 50},
"logisticsPackagingId":{"type":"string","minLength":1,"maxLength": 100},
"sorterName":{"type":"string","minLength":1,"maxLength": 25},
"isNoSorterHandling":{"type":"boolean"},
"errorTypeCodeList":{"type": "array","errorTypeCode": {"type": "string"}},
"reductionReasonCode":{"type":"string","minLength":1,"maxLength": 100},
"packingProcessType":{"type":"string","minLength":1,"maxLength": 50},
"processEventLocation":{"type":"string","minLength":1,"maxLength": 50},
"isTreasureItem":{"type":"boolean"},
"deliveryType":{"type":"string","examples":[ "returns","transshipments" ]},
"orderBatchCreationDate":{"type": "string","format": "date"}
},
"description": "",
"additionalProperties": true
}
}
},
"additionalProperties": false,
"required": [
"processData",
"processBusinessTime",
"proveId",
"quantity",
"location"
]
}
},
"additionalProperties": false,
"required": [
"eventId",
"traceId",
"eventTime",
"version",
"eventType",
"data"
]
}4 - CD03 Forecast Brain (for merchant OTTO)
- Status
-
Released
- Approval
- Comment
- Assumption
-
_
1. Stakeholder
| Role | Application | Responsible |
|---|---|---|
Communication |
Integration Layer |
|
Leading App |
FLASH |
|
InterfaceOwner |
FLASH, Domain RT |
|
Producer |
FLASH |
|
Consumer |
BRAIN |
|
Consumer |
2. Business Context
Customers of merchant OTTO annouce their returns via a frontend. BRAIN consumes this data and provides the positions in charge (identified via returnKey that is also known in RESY) and the parcel-Tracking-Id for the returns-basket.
This data is useful to do a forecast of items heading to the return-warehouses.
3. Informationflow
Planning- and foracastdata is put into the non-FINE-System "TM1". FLASH consumes export from TM1 via non FINE-Interface as csv-Files and delivers data to FINE-Integrationlayer.
4. Interface
4.1. Direction WMS to FINE
4.1.1. Header
This interface uses the Service Header
4.1.2. Datamodel
| Property | Type | Description |
|---|---|---|
(Root) |
object |
Additional Properties: false |
eventId* |
string |
The unique eventId. Global uniq Id, recommended as uuid |
eventTime* |
string (date-time) |
Time at which this record(event) was technically generated in RFC3339 format with timezone ([+|-]hh:mi) |
version* |
string |
Number of version of this data structure. Either a sematic specification(String with major & minor nr) or the version number in the Kafka schema registry |
context* |
string (const) |
The context of this message is always forecast (constant FORECAST) Constant: FORECAST |
eventType* |
string (const) |
Kind of "event" that describes the following data. In this case always UPDATE Constant: UPDATE |
data* |
object |
Element holding the payload for this message. Additional Properties: false |
creationTimestamp* |
string (date-time) |
Datetime at which this record(event) was actually issued in RFC3339 format with timezone ([+|-]hh:mi): yyyy-mm-ddTHH:mi:ss[+|-]HH:MI |
forecastType* |
string |
Kind / Type of forecast. Currently supported values 'TaProg_angepasst', 'WoProg_Handel'. |
forecastPeriod* |
string (enum) |
Period the forecast-date belongs to. For daily values use 'DAY', for week or month other matching enums. A 5-Week-Forecast forecasts single days for example. Any of: [
"DAY",
"ISO_WEEK",
"MONTH"
] |
forecastDate* |
string (date) |
Date the forecast belongs to in format "yyyy-mm-dd". Depending on forecastPeriod, this refers to one particular day ("DAY"), the first day of the week ("ISO_WEEK") or the first day of the month (("MONTH") |
forecastDimensions* |
object |
Planning dimensions of the forecast |
company |
string |
if applicable, actual company. Currently supported: 'OTTO' |
location* |
string |
location-dimension for a forecast measure, e.g. ILOWA_RT. Uses locations provided by FINE |
forecastMeasure* |
object |
Planned Measure |
name* |
string |
Name of the measure. Currently supported: 'Umfuhr_ex_HDL', 'Umfuhr_ex_SDH', 'Umfuhr_ex_SNF', 'WE_Lukenerfassung', 'WER', 'RT-Leistung_inkl_Zweitbearbeitung'. |
value* |
string |
Actual value of the measure, numeric datatype with 19 digits and 9 decimal places |
unit* |
string (enum) |
Unit of the measure Any of: [
"AK",
"Kolli"
] |
4.1.3. Enumeration
nothing special here
4.1.4. Example
{
"eventId": "158978534-20240415110717",
"eventTime": "2024-04-15T11:07:17+02:00",
"version": "0.1.0",
"context": "FORECAST",
"eventType": "UPDATE",
"data": {
"creationTimestamp": "2024-02-20T15:18:00",
"forecastType": "TaProg_angepasst",
"forecastPeriod": "DAY",
"forecastDate": "2024-02-20",
"forecastDimensions": {
"company": "OTTO",
"location": "HALDENSLEBEN"
},
"forecastMeasure": {
"name": "Umfuhr_ex_SNF",
"value": 0.0,
"unit": "Kolli"
}
}
}4.1.5. Schema
| Version | Number | File | Published on | Changes |
|---|---|---|---|---|
current version |
1.0 |
15.04.2024 |
final |
|
previous version |
||||
coming version |
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"required": [
"eventId",
"eventTime",
"version",
"context",
"eventType",
"data"
],
"properties": {
"eventId": {
"type": "string",
"description": "The unique eventId. Global uniq Id, recommended as uuid"
},
"eventTime": {
"type": "string",
"format": "date-time",
"description": "Time at which this record(event) was technically generated in RFC3339 format with timezone ([+|-]hh:mi)"
},
"version": {
"type": "string",
"description": "Number of version of this data structure. Either a sematic specification(String with major & minor nr) or the version number in the Kafka schema registry"
},
"context": {
"type": "string",
"const": "FORECAST",
"description": "The context of this message is always forecast (constant FORECAST)"
},
"eventType": {
"type": "string",
"const": "UPDATE",
"description": "Kind of \"event\" that describes the following data. In this case always UPDATE"
},
"data": {
"type": "object",
"description": "Element holding the payload for this message.",
"required": [
"creationTimestamp",
"forecastType",
"forecastPeriod",
"forecastDate",
"forecastDimensions",
"forecastMeasure"
],
"properties": {
"creationTimestamp": {
"type": "string",
"format": "date-time",
"description": "Datetime at which this record(event) was actually issued in RFC3339 format with timezone ([+|-]hh:mi): yyyy-mm-ddTHH:mi:ss[+|-]HH:MI",
"examples": [
"2023-01-05T17:38:00+02:00"
]
},
"forecastType": {
"type": "string",
"description": "Kind / Type of forecast. Currently supported values 'TaProg_angepasst', 'WoProg_Handel'."
},
"forecastPeriod": {
"type": "string",
"description": "Period the forecast-date belongs to. For daily values use 'DAY', for week or month other matching enums. A 5-Week-Forecast forecasts single days for example.",
"enum": [
"DAY",
"ISO_WEEK",
"MONTH"
]
},
"forecastDate": {
"type": "string",
"format": "date",
"description": "Date the forecast belongs to in format \"yyyy-mm-dd\". Depending on forecastPeriod, this refers to one particular day (\"DAY\"), the first day of the week (\"ISO_WEEK\") or the first day of the month ((\"MONTH\")"
},
"forecastDimensions": {
"type": "object",
"description": "Planning dimensions of the forecast",
"required": [
"location"
],
"properties": {
"company": {
"type": "string",
"description": "if applicable, actual company. Currently supported: 'OTTO'"
},
"location": {
"type": "string",
"description": "location-dimension for a forecast measure, e.g. ILOWA_RT. Uses locations provided by FINE"
}
}
},
"forecastMeasure": {
"type": "object",
"description": "Planned Measure",
"required": [
"name",
"value",
"unit"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the measure. Currently supported: 'Umfuhr_ex_HDL', 'Umfuhr_ex_SDH', 'Umfuhr_ex_SNF', 'WE_Lukenerfassung', 'WER', 'RT-Leistung_inkl_Zweitbearbeitung'."
},
"value": {
"type": "string",
"description": "Actual value of the measure, numeric datatype with 19 digits and 9 decimal places",
"examples": [
1000,
200
]
},
"unit": {
"type": "string",
"description": "Unit of the measure",
"enum": [
"AK",
"Kolli"
]
}
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}