S14 Accumulated Warehouse Stock

{
    "eventId":"f48cfc26-0615-4351-9966-cdb4ec41bbcc",
    "traceId":"f48cfc26-0615-4351-9966-cdb4ec41bbcc",
    "eventTime":"2016-04-16T01:03:17Z",
    "version":"1.1",
    "eventType":"STOCK",
    "metaData":{
        "sender":"BUBE",
        "client":"FBO",
        "messageNumber":1,
        "lastMessageNumber":10,
        "dailySnapshotNumber":1,
        "snapshotTime":"2016-04-16T01:00:00Z"
    },
    "data":{
        "erpSnapshotId":427,
        "erpProductId":"Artikel1",
        "erpPackingUnitId":"Teil1",
        "location":"ILOWA",
        "quantity":13,
        "erpStockType":"DELIVERABLE_STOCK"
    }
}

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$comment": "Schema for accumulated stock in a warehouse direction ERP Version 1.1",
    "$id": "https://doc.fine.gcp.osp-dev.de/registry/Stock/AccumulatedWarehouseStock.v1.1.schema.json",
    "type": "object",
    "definitions": {
        "erpStockType": {
            "title": "Type of the stock",
            "description": "stockType, which are defined at ERP",
            "type": "string",
            "maxLength": 50,
            "enum": ["DELIVERABLE_STOCK", "QUALITY_LOCKED_STOCK", "LOCKED_STOCK", "STOCK_IN_FULFILLMENT","RESERVABLE_LOCKED_STOCK","STOCK_IN_TRANSIT", "RESERVABLE_STOCK_IN_TRANSIT", "STOCK_IN_FULFILLMENT_QUALITY_LOCKED"]
        }
    },
    "properties": {
        "eventId": {
            "title": "The unique eventId",
            "description": "Global unique Id",
            "type": "string",
            "format": "uuid",
            "minLength": 36,
            "maxLength": 36,
            "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": {
            "title": "Time of occurrence of the event",
            "description": "Time at which the record was generated (single event - not the businessEvent/snapshot) in UTC +ISO-8601 format YYYY-MM-DD'T'HH24:MM:SS'Z'",
            "type": "string",
            "format": "date-time",
            "examples": [
                "2022-04-16T16:06:05.123456Z",
                "2022-04-19T08:51:05+02:00"
            ]
        },
        "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}",
                    "examples": ["1.01", "01.02"]
                },
                {
                    "type": "integer",
                    "examples": [1, 2]
                }
            ]
        },
        "context": {
            "title": "The context / business case",
            "description": "The context specified here means the business domain.",
            "type": "string",
            "maxLength":50,
            "enum": [
                "ACCUMULATED_WAREHOUSE_STOCK"
            ]
        },
        "eventType": {
            "title": "Snapshot event",
            "description": "the snapshot type to which the data belongs, currently only snapshots are supported",
            "type": "string",
            "maxLength": 20,
            "enum": ["STOCK"],
            "examples":["STOCK"]
        },
        "metaData": {
            "title": "additional meta information",
            "description": "optional, can be used with different characteristics for technical data per interface",
            "type": "object",
            "properties": {
                "sender": {
                    "title":"sender",
                    "description":"Name of the source system, that has sent this message.",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v7.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.v5.schema.json"
                },
                "messageNumber": {
                    "title": "current message number",
                    "description": "the current message number that is transmitted",
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 999999999999999999
                },
                "lastMessageNumber": {
                    "title": "last message number",
                    "description": "how many messages are to be transferred",
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 999999999999999999
                },
                "dailySnapshotNumber": {
                    "title": "daily snapshot number",
                    "description": "sequence number of the snapshot per day, starts every day again with number 1",
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 100
                },
                "snapshotTime": {
                    "title": "snapshot time",
                    "description": "time of the snapshot creation",
                    "type": "string",
                    "format": "date-time",
                    "examples": [
                        "2022-04-16T16:06:05.123456Z",
                        "2022-04-19T08:51:05+02:00"
                    ]
                }
            }, 
            "required": [
                "sender",
                "client",
                "dailySnapshotNumber"
            ]   
        },
        "data": {
            "type": "object",
            "properties": {
                "erpSnapshotId": {
                    "title": "the id of the inventory snapshot",
                    "description": "Consecutive number (sequence) of a long number. each inventory snapshot gets its own ID from WMS, which is identical for all records of the snapshot. all bookings get the id of the following snapshot, generated by wms, each wms has his own scope",
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 999999999999999999,
                    "maxLength": 18,
                    "examples": [
                        122
                    ]
                },
                "erpProductId": {
                    "title": "¨ERP Product Id",
                    "description": "master communication key between Erp and LSAS for item sizes",
                    "type": "string",
                    "maxLength": 36,
                    "examples":["123"]
                },  
                "erpPackingUnitId": {
                    "title": "¨ERP PackingUnit Id",
                    "description": "master communication key between LSAS and ERP for packing units of an item sized - used in Deep Sea for identification",
                    "type": "string",
                    "maxLength": 36,
                    "examples":["123"]
                },
                "packingUnitIndex": {
                    "title": "¨PackingUnit Number",
                    "description": "Part Number for products with multiple parts - use 1 for PL",
                    "type": "integer",
                    "mininmum": 1,
                    "maximum": 99,
                    "examples":["123"]
                },              
                "location": {
                    "title": "location",
                    "description": "the location where the event was created",
                    "$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
                },
                "quantity": {
                    "title": "quantity",
                    "description": "quantity containing to this stock type",
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 9999999999,
                    "examples":[90]
                },
                "erpStockType": {
                    "title": "ERP Stock Type",
                    "description": "stock type, which are defined at ERP",
                    "$ref": "#/definitions/erpStockType"
                }
            },
            "required": [
                "erpSnapshotId",
                "erpProductId",
                "erpPackingUnitId",
                "location",
                "quantity",
                "erpStockType"
            ]              
        }
    },
    "required": [
      "eventId",
      "traceId",
      "eventTime",
      "version",
      "eventType",
      "metaData",
      "data"
    ],
    
    "examples":[
        {
            "eventId":"f48cfc26-0615-4351-9966-cdb4ec41bbcc",
            "traceId":"f48cfc26-0615-4351-9966-cdb4ec41bbcc",
            "eventTime":"2016-04-16T01:03:17Z",
            "version":"1.1",
            "eventType":"STOCK",
            "metaData":{
                "sender":"BUBE",
                "client":"FBO",
                "messageNumber":1,
                "lastMessageNumber":10,
                "dailySnapshotNumber":1,
                "snapshotTime":"2016-04-16T01:00:00Z"
            },
            "data":{
                "erpSnapshotId":427,
                "erpProductId":"Artikel1",
                "erpPackingUnitId":"Teil1",
                "location":"ILOWA",
                "quantity":13,
                "erpStockType":"DELIVERABLE_STOCK"
            }
        }
    ]
}