(Root)

object

Definition of the recommended minimum structure of a JSON message in FINE

    eventId*

string

The unique eventId
Global unique Id, recommended as UUID.

    traceId*

string

The unique traceId
Global unique Id for tracing the flow of events, recommended as UUID.

    spanId

string

The eventId of previous record or batchId (optional)
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 or event is a part of a batch, recommended as UUID.

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record/event was technically generated.

    version*

Schema version number
Schema version number of this data structure. This can be a sematic version number as a string (MAJOR.Minor) or the version number in the Kafka schema registry.

    context

string

Context or business case (optional)

    eventType*

string

Concrete type/kind of record/event
Describes the characteristics of the record/event.

    metaData

object

Additional meta information (optional)
Any optional or required attributes for additional technical information can be defined here individually for each interface. The attributes listed here cover the most common use cases. The same attribute names as listed here should be used when describing the same thing.

        sender

string (enum)

Name of sender/producer
Name of the source system that generated this data. The global/common enumeration system should be referenced here. The permitted values can also be restricted further if necessary (e.g. using allOf).

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

        instance

string

Software instance of producing system
Name of the source instance that generated this data.

        client

string

Client / Tenant
Name of the client, for example if messages from different clients have different processing rules or destinations.

        messageNumber

integer

Current number of the message in this batch. The first message has the number 1.

Minimum: 1
Maximum: 999999999

        messageCount

integer

Total number of messages to be transferred in this batch.

Minimum: 1
Maximum: 999999999

    data*

object

Data of the business object

(Root)

object

Schema for Product Master Data from ERP to FINE, 'single'-variant
A Product with all its associated data. Variant of the schema to send a single dataset.

    eventId*

string

The unique eventId
Global unique Id, recommended as uuid

    traceId*

string

The unique traceId
Global unique Id for tracing the flow of events, recommended as uuid

    spanId

string

The eventId of previous record or batchId
Optional spanID.

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

    context

string (const)

The context / business case
The optional context specified here means the business domain.

Constant: MASTERDATA

    eventType*

string (const)

The concrete type record
The concrete type record.

Constant: PRODUCT_UPDATE

    version*

string (const)

The number of version of schema
Number of version of this data structure. A semantic specification with major & minor version numbers

Constant: 2.9.0

    metaData*

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender*

string

Name of the source system, that has sent this message.

Maximum Length: 30

        company*

string

Name of the source company.

Maximum Length: 30

        clientSystems*

array

List of client system, this dataset should be sent to. LSAS uses this for filtering the messages.

            (Array item)

string

Maximum Length: 30

    data*

object

Data of the business object
business data, can be used with different characteristics per interface

        active*

boolean

active flag
Provides information about whether the product is active (true) or inactive/deleted (false).

        identification*

object

identification of the business object
Technical and business - identifiers concerning the business object 'product'.

            erpProductId*

string

technical ID 'erp product ID'
Unique technical key of the ERP for this product. Within logistics and FINE only unique in combination with the sourceErp. must be used for all communication with an ERP referencing a product.

Maximum Length: 36

            erpProductCode

string

erpProductCode (erpSchluesselFachlich)
Unique business identifier of the ERP for this product. Within logistics and FINE only unique in combination with the sourceErp.

Maximum Length: 36

            ownerCompanyProductCode

string

ownerCompanyProductCode (referenzArtikelNummer)
Unique business identifier of the stock-owner company for this product. Within logistics and FINE only unique in combination with the owner company.

Maximum Length: 36

            itemoptioncommkey

string

technical key, provided by ERP
Created and transmitted via LDH to LSAS, unique within this ERP; needed by KR1- and COBRA-system for parallel testing (deprecated afterwards).

Maximum Length: 18

        ownership*

object

ownership information concerning the business object
Ownership information concerning the business object 'product'

            ownerCompany*

string

stock company ID (bestandsfirma)
stock-owner company for the product

Maximum Length: 30

            sourceOwnerCompany

string

stock company origin (firmenHerkunft)
Original stock company before the conversion to Corso, relevant for bookings to ERP. Mandatory field if ownerCompany = CORSO

Maximum Length: 30

        product*

object

product
basic product information

            productName*

string

product description (shortened, optimized for logistics use-cases)
Name/short description of the product

Maximum Length: 18

            productNumber*

integer

product number (artikelNummer)
Product number, used in warehouses to identify a product. Will be replaced later by new business and technical identifiers.

Minimum: 0
Maximum: 99999999

            size*

string

alphanumerical product size (groesseLogistisch)
Product size as String. For OTTO-Products the maxLength is 3 characters due to restrictions in consuming systems.

Maximum Length: 10

            sizeNumeric

integer

numerical product size (groesseNumerisch)
Numerical product size (OTTO-specific legacy-attribute). Alphanumerical sizes can be mapped to numerical sizes using a mapping table (see further documentation).

Minimum: 0
Maximum: 999

            orderSize

string

additional - freely defined - alphanumerical product size
Size which was used for purchase and thus used for declaration of packages in the goods in processes. Can be freely defined by the producer of the message.

Maximum Length: 18

            eans

array

list of alternative EANs
Provides a list of EANs and additional meta information concerning the single EANs.

Minimum number of items 0
Maximum number of items: 99

                (Array item)

object

Additional Properties: false

                    ean*

integer

The EAN number
The EAN number itself.

Minimum: 0
Maximum: 9999999999999

                    active*

boolean

active flag
Provides information about whether the EAN is active (true) or inactive/deleted (false).

                    eanPriority*

integer

priority of the EAN on a printed content list
Priority of the EAN on a printed content list. EAN always has lowest priority (=1). Primary EAN should have priority 1. The rest should be correlative numbers >1.

Minimum: 1
Maximum: 9

            season

integer

season (bestandsSaison)
Season in which the article is used, OTTO-specific encoding

Minimum: 0
Maximum: 999

            color

string

simplified color (farbe) description
Simplified color description of the product for logistical processes.

Maximum Length: 12

            style

string

style information (style)
Style information for the packing slip. Appears on the print document ContentList (COBRA). According to NEON also relevant for PL

Maximum Length: 14

            eudrRelevance

string (enum)

EU Deforestation Regulation relevant
Provides information on whether the product is relevant for the EU Deforestation Regulation.

Any of: [ "RELEVANT", "NOT_RELEVANT", "UNKNOWN" ]

            imageUrls

array

array of image URLs
List of image URLs.

                (Array item)

string

image URL

Maximum Length: 256

            standardPrice

integer

selling price in cents (verkaufsPreis)
Selling price of the product in cents

Minimum: 0
Maximum: 9999999

            salesBrand

string

salesbrand (markenName)
salesbrand, e.g. Nike, Marco Polo, Jack & Jones

Maximum Length: 35

            partsQuantity

integer

number of parts (anzahlTeile)
The number of individual parts of an product within the package (must not be confused with the number of packages). Required for returns processing to determine if the product was returned complete. Example: double pack of T-shirts = 2 parts, bikini = 2 parts. The ERP determines which items should carry this attribute. The decision is mainly based on the meaningfulness (no puzzles, no Lego, small items are not checked for completeness in the return). Default value is then 1.

Minimum: 0
Maximum: 1000000000000000000

            measuringUnit*

string (enum)

measuring unit (mengeneinheit)
Identifies the measuring unit. PIECE = piece goods, LENGTH_VARIABLE = length can be specified but width is fixed (e.g. for curtains, fabric,…​), LENGTH_AND_WIDTH_VARIABLE = lenght and width can be specified (e.g. for custom made pleats)

Any of: [ "PIECE", "LENGTH_VARIABLE", "LENGTH_AND_WIDTH_VARIABLE" ]

            logisticsType*

string (enum)

logistics type (Lagerbestandstyp)
The logistics type should provide information on whether the product is a parcel logistics (Paketlogistik) or a bulky items logistics (Großstuecklogistik) product.

Any of: [ "PARCEL", "BULKY", "UNKNOWN" ]

            handlingType

string (enum)

type of handling (handlingId)
Indicates, how the product is going to be handled. ONE_MAN_HANDLING and TWO_MAN_HANDLING products belong to the bulky items logistics (GL).

Any of: [ "ONE_MAN_HANDLING", "TWO_MAN_HANDLING", "PARCEL", "HANGING_CONFECTION" ]

            productGroup

integer

product group (marktId)
Classification of products (phone, watch, cosmetics, etc.)

Minimum: 0
Maximum: 999

            assortmentClassification

array

use case based assortment classification
Provides information about specific assortments, differentiated by requirements of specific processes.

                (Array item)

object

                    process*

string (enum)

process
Identifies the process, which specifies the permissibility of the transmitted assortment.

Any of: [ "RETURNS_EVALUATION", "RETURNS_BILLING" ]

                    assortment*

integer

assortment ID
Identifies the assortment, which is connected to a process and its specific requirements.

Minimum: 0
Maximum: 999

            organic

object

organic characteristics of the product
Provides information about the organic characteristics of the product.

                hasOrganicCertification*

boolean

organic identification
Provides information on whether the product is an organic good.

                certificationType

string (enum)

type of organic certification
Identifies the type of organic certification of the product.

Any of: [ "GOTS" ]

            batchHandling

boolean

Batch Handling for this product required
This product requires a batch number (chargenNummer) and specific handling, e.g. the batch number of each item must be recorded in the inbound process and all items within an order must have the same batch number in the outbound process.

            shippingFromSupplier

boolean

shipping from supplier (VAL-Artikel)
Identifies, if the product is shipped directly from the supplier or not.

            deliveryScope

array

array of components of the delivery scope
List components of the delivery scope.

                (Array item)

string

component

Maximum Length: 256

            additionalNote

string

additional note (free text)
An additional note about the product, which can be freely defined.

Maximum Length: 1024

            partnerInformation

object

partner
Basic partner information.

                erpPartnerId*

string

ERP ID of partner.
ID of partner used by ERP.

Maximum Length: 36

                erpPartnerName*

string

Name of partner.
Name of partner.

Maximum Length: 36

        dangerousGoodsIdentification

object

dangerous goods characteristics of the product
Includes all relevant dangerous goods information concerning the product.

            dangerous

boolean

dangerous goods identification
Provides information on whether the product is a dangerous good.

            dangerousGoodsType

string (enum)

dangerous goods type
Provides information about the dangerous goods type.

Any of: [ "G01", "G02", "G03", "G04", "G05", "G06", "G07", "G08", "G09", "G10", "G11", "G12", "G13", "G14" ]

            physicalState

string

physical state
Provides information about the physical state of the product.

Maximum Length: 50

            accumulatorCapacity

string

accumulator capacity
Provides information about the accumulator capacity of the product in mAh.

Maximum Length: 20

            numberOfAccumulators

string

number of accumulators
Provides information about the number of accumulators of the product, between 1 and 10.

Maximum Length: 20

            numberOfBatteries

string

number of batteries
Provides information about the number of batteries of the product, between 1 and 10.

Maximum Length: 20

            batteryOrAccumulatorTechnology

string

battery or accumulator technology
Provides information about the battery or accumulator technology.

Maximum Length: 1024

            transportCategoryDangerousGoods

string

transport category dangerous goods
Provides information about the transport category of dangerous goods, between 0 and 4.

Maximum Length: 1

            clpHazardPictogram

array

hazard pictogram array
A hazard pictogram is a picture on a label with a warning symbol and certain colors to provide information about the damage that a certain substance or mixture can do to our health or the environment.

                (Array item)

string

hazard pictogram

Maximum Length: 1024

            clpProductLabel

string

product label
The attribute describes whether a CLP-product label is necessary.

Maximum Length: 1024

            clpSafetyDataSheet

string

safety data sheet
The safety data sheet is the central element of communication in the supply chain for hazardous substances and mixtures. It provides the user of chemicals with important information on the identity of the product.

Maximum Length: 1024

            dangerWarnings

array

danger warnings array
Packaging that contains dangerous substances or a dangerous mixture must be labeled to protect the user and the environment.

                (Array item)

string

danger warning

Maximum Length: 1024

            weightBatteriesOrAccumulator

string

weight of batteries or accumulator
Weight batteries/accumulator // Free field (without specifications)/indication of the mass of the installed or enclosed accumulator or battery in g.

Maximum Length: 20

            content

string

content
freetxt // specification of the content of the product.

Maximum Length: 4096

            storageCategoryHazardousMaterial

string

storage category hazardous material
A list of different storage classes.

Maximum Length: 20

            accumulatorPower

string

accumulator power
The specification of accumulator power in Wh. // Freetext

Maximum Length: 20

            deliveryConditionBatteriesOrAccumulators

string

delivery condition of batteries or accumulators
Information on whether a battery or accumulator is built into the product or if it is separated from the product.

Maximum Length: 1024

            limitedQuantityOfDangerousGoods

string

limited quantity of dangerous goods
Limited Quantities (LQ) is the abbreviation for the term dangerous goods, which are packed in limited amounts, that is stated by dangerous goods regulation.

Maximum Length: 1024

            testSummaryLithiumBatteries

string

test summary of lithium batteries
Test summary lithium batteries.

Maximum Length: 1024

            qualityAssuranceProgramLithiumBatteries

string

quality assurance program lithium batteries
Quality assurance program lithium batteries.

Maximum Length: 1024

            relevanceClpObligation

string

relevance of CLP obligation
The CLP regulation deals with the question, whether a substance or mixture has properties that can be considered as dangerous.

Maximum Length: 1024

            relevanceClpDangerousGoods

string

relevance of CLP
Relevance of CLP

Maximum Length: 1024

            safetyInstructions

array

safety instructions array
List of up to 127 safety notes

                (Array item)

string

safety instruction

Maximum Length: 1024

            signalWord

string

signal word
CAUTION/DANGER: The signal word indicates the level of danger and severity of injury or property damage.

Maximum Length: 50

            specialProvisionDangerousGoods

string

special provision of dangerous goods
For certain substances or objects the special regulations are applied, through which the shipping of these substances or objects is wholly or partially exempt from the regulations of the ADR. ADR: European agreement concerning the international carriage of dangerous goods by road.

Maximum Length: 1024

            accumulatorVoltage

string

accumulator voltage
The attribute describes the different voltages of accumulators.

Maximum Length: 50

            languagesClpSafetyDataSheet

string

languages clp safety data sheet
list of 28 languages

Maximum Length: 50

            unNumber

string

UN number
specification of UN-number

Maximum Length: 1024

            unStandardTestLithiumBatteries

string

UN standard test lithium batteries
The UN 38.3 test ensures that lithium batteries can be shipped safely.

Maximum Length: 1024

            packingGroupsDangerousGoods

string

packing groups dangerous goods
Assignment of different packing groups, selection 1-3.

Maximum Length: 50

            netQuantityWeight

string

net quantity weight
Specification of the net quantity of the product in gram (g).

Maximum Length: 20

            netQuantityPiece

string

net quantity piece
Specification of the net quantity of the product in piece (pc).

Maximum Length: 20

            netQuantityVolume

string

net quantity volume
Specification of the net quantity of the product in volume (ml).

Maximum Length: 20

            safetyDatasheets

array

array of safety datasheet URLs
List of safety datasheet URLs.

                (Array item)

string

safety datasheet URL

Maximum Length: 256

        ottoSpecificProcessing

object

process-relevant information concerning the business object, specific attributes for Otto and Bonprix products
Process-relevant information concerning the business object 'product'

            priorityInbound

boolean

priority for inbound processes (chefKz)
Product will be prioritized for inbound processes (true=yes, false=no). Bonprix only.

            priorityDelivery

integer

priority for delivery (deliveryFlag, NAB_Kz)
Product will be prioritized for delivery according to the level set. Bonprix only.

Minimum: 0
Maximum: 5

            specialPackaging

integer

product packing information (sonderverpackung, tuetenKz)
Product packing information indicates whether an article is bagable

Minimum: 0
Maximum: 9

            warehouseAreaType*

integer (enum)

warehouse area type (WBKZ)
Classifies an article with regard to the warehouse area, provides information about e. g. Sorter-Ability, Risk of theft, etc.

Any of: [ 0, 1, 2, 3, 4, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18 ]

            returnsSortCode*

integer

returns sort code (retourenSortierId)
Each article has a standard return destination that is stored in the master data

Minimum: 0
Maximum: 999

            oneStopShopping

boolean

one stop shopping code (AbwicklungsartOss)
Indicates if an product is processed as one stop shopping; true=OSS, false=no OSS

            supplierId

integer

supplier ID (LKZ)
Unique ID for the supplier (currently only known for Otto ERP), used by KR1 to identify the main supplier

Minimum: 0
Maximum: 999999

            disposal

integer (enum)

disposal (verwendung)
Indicates the current usage of an article

Any of: [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 17, 18, 19 ]

            enclosures

array

enclosures array (beilagen)
List of enclosures.

Minimum number of items 0
Maximum number of items: 3

                (Array item)

string

enclosure ID

Maximum Length: 4

            groupCodeComposed

integer

product group detail code (warengruppeGesamt)
Composed group Code

Minimum: 0
Maximum: 999

            groupCodeBuying*

integer

buying group code (warengruppeFuehrungsTeam)
Optional filter for the removal of goods, goods are classified by these attributes (needed for COBRA)

Minimum: 0
Maximum: 99

            groupCodeMerchandise*

integer

merchandise group code (warengruppeOperativesTeam)
Optional filter for the removal from storage, goods are classified by these attributes (needed for COBRA)

Minimum: 0
Maximum: 9

            reconditionCode

integer

recondition code (wiederaufbereitung)
Code for the routing label for rework of returned articles

Minimum: 0
Maximum: 9

            individualization

integer

individualization (individualisierung)
Indicates if an article has embossing or engraving

Minimum: 0
Maximum: 9

            expeditionCode

integer

encoding for process-handling of bulkyItems (versandschluessel)
Encoding for process-handling of bulkyItems, includes transport system, goods distribution centre, etc.

Minimum: 0
Maximum: 9999999

            checkRoomCode

integer

check room code (pruefraumId)
Testroom ID to filter removal from storage - results from quality tests

Minimum: 0
Maximum: 5

            ownershipId

integer (enum)

ownership of the product (verfuegbarkeitsId)
The attribute is used to logistically distinguish certain groups of goods. E.g. for stock removal processes (e. g. to prevent throughput goods from being outsourced); 0=OWN_GOODS, 1=EXTERNAL_GOODS_CONSIGNMENT, 3=EXTERNAL_GOODS_THROUGHPUT, 9=UNKNOWN.

Any of: [ 0, 1, 3, 9 ]

            location

integer (enum)

master warehouse ID (stammlager)
The master warehouse provides information about where an article comes from.

Any of: [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 40, 43, 47, 48, 49, 54, 55, 56, 57, 58, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 88, 92, 99 ]

            returnsVolumeClass

integer

volume class of an article (retourenVolumenklasse)
Volume class of an article, categorized in IDs.

Minimum: 0
Maximum: 13

        packingUnits*

array

packing units array (packstuecke)
List of all packing units

Minimum number of items 1
Maximum number of items: 99

            (Array item)

object

                identification*

object

identification of the packing unit
technical and business - identifiers concerning the packing unit

                    erpPackingUnitId*

string

ERP packing unit ID
Common technical key between LSAS and ERP.

Maximum Length: 36

                    packingUnitIndex

integer

Index of the packing unit (packstueckNr)
Index (number, starting with 1) of this packing unit within the list of all packing unit. If more than one packing unit is present, the packingUnitIndex is required.

Minimum: 1
Maximum: 99

                packingUnitDescription

string

ERP packing unit description
Describes in particular what is inside a packing unit.

Maximum Length: 1024

                geometry

object

geometric data of the packing unit
includes the geometric data of the packing unit

                    length

integer

length
Length in mm

Minimum: 0
Maximum: 99999

                    width

integer

width
Width in mm

Minimum: 0
Maximum: 99999

                    height

integer

height
Height in mm

Minimum: 0
Maximum: 99999

                    weight

integer

weight
Weight in g

Minimum: 0
Maximum: 9999999

                    volume

integer

volume
Volume in dl

Minimum: 0
Maximum: 9999999

(Root)

object

Schema for Product Master Data from FINE to WMS
A Product with all its associated data.

    eventId*

string

The unique eventId
Global unique Id, recommended as uuid

    traceId*

string

The unique traceId
Global unique Id for tracing the flow of events, recommended as uuid

    spanId

string

The eventId of previous record or batchId
Optional. Not provided by LSAS.

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

    context

string (const)

The context / business case
The optional context specified here means the business domain.

Constant: MASTERDATA

    eventType*

string (const)

The concrete type record = PRODUCT_UPDATE
The concrete type record. Always 'PRODUCT_UPDATE'

Constant: PRODUCT_UPDATE

    version*

string (const)

The number of version of schema
Number of version of this data structure. A semantic specification with major & minor version numbers

Constant: 2.9.0

    metaData*

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender*

string (const)

Sender of the message
Name of the source system, that has sent this message.

Constant: LSAS

        sourceSystem*

string

The system that produced this dataset and originally sent it to LSAS. Usually an ERP-system.

Maximum Length: 30

        sourceCompany*

string

Name of the source company.

Maximum Length: 30

        clientSystems*

array

List of client systems this dataset is relevant for. Used for filtering for the different client systems.

            (Array item)

object

                client*

string

Name of client system.

Maximum Length: 30

                status*

string (enum)

Export status
Status to show, if a client should receive this dataset. RELEVANT - client must receive it, REMOVED - previously this item was relevant for a client, now it must be deleted (client must take care to delete the dataset by itself)

Any of: [ "RELEVANT", "REMOVED" ]

    data*

object

Data of the business object
business data, can be used with different characteristics per interface

        creationTime*

string (date-time)

Creation timestamp
Time of creation of the product in LSAS in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

        updateTime*

string (date-time)

Last update timestamp
Time of last update in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

        deletionTime

string (date-time)

Deletion timestamp
Time of the deletion of this product (when the active flag switched to false) in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

        active*

boolean

active flag
Provides information about whether the product is active (true) or inactive/deleted (false).

        identification*

object

identification of the business object
Technical and business - identifiers concerning the business object 'product'.

            logisticsProductId*

string

technical ID 'logistics product ID'
Unique technical key in all logistics systems, assigned by LSAS. Must be used in all communication between logistics systems and FINE, when referencing a product.

Maximum Length: 36

            erpProductId*

string

technical ID 'erp product ID'
Unique technical key of the ERP for this product. Within logistics and FINE only unique in combination with the sourceErp. Must be used for all communication with an ERP referencing a product.

Maximum Length: 36

            erp*

string

ERP identifier
Identifies the ERP as producer of the message. In combination with the erpProductId it is unique.

Maximum Length: 30

            erpProductCode

string

erpProductCode (erpSchluesselFachlich)
Unique business identifier of the ERP for this product. Within logistics and FINE only unique in combination with the sourceErp.

Maximum Length: 36

            ownerCompanyProductCode

string

ownerCompanyProductCode (referenzArtikelNummer)
Unique business identifier of the stock-owner company for this product. Within logistics and FINE only unique in combination with the owner company.

Maximum Length: 36

            itemoptioncommkey

string

technical key, provided by ERP
Created and transmitted via LDH to LSAS, unique within this ERP; needed by KR1- and COBRA-system for parallel testing (deprecated afterwards).

Maximum Length: 18

        ownership*

object

ownership information concerning the business object
Ownership information concerning the business object 'product'

            ownerCompany*

string

stock company ID (bestandsfirma)
stock-owner company for the product

Maximum Length: 30

            sourceOwnerCompany

string

stock company origin (firmenHerkunft)
Original stock company before the conversion to Corso, relevant for bookings to ERP. Mandatory field if ownerCompany = CORSO

Maximum Length: 30

        product*

object

product
basic product information

            productName*

string

product description (shortened, optimized for logistics use-cases)
Name/short description of the product

Maximum Length: 18

            productNumber*

integer

product number (artikelNummer)
Product number, used in warehouses to identify a product. Will be replaced later by new business and technical identifiers like logisticsProductCode, logisticsProductId, erpProductId,…​

Minimum: 0
Maximum: 99999999

            size*

string

alphanumerical product size (groesseLogistisch)
Product size as String. For OTTO-Products the maxLength is 3 characters due to restrictions in consuming systems.

Maximum Length: 10

            sizeNumeric

integer

numerical product size (groesseNumerisch)
Numerical product size (OTTO-specific legacy-attribute). Alphanumerical sizes can be mapped to numerical sizes using a mapping table (see further documentation).

Minimum: 0
Maximum: 999

            orderSize

string

additional - freely defined - alphanumerical product size
Size which was used for purchase and thus used for declaration of packages in the goods in processes. Can be freely defined by the producer of the message.

Maximum Length: 18

            eans

array

list of EANs associated with this product
Provides a list of EANs and additional meta information concerning the single EANs.

Minimum number of items 0
Maximum number of items: 99

                (Array item)

object

Additional Properties: false

                    ean*

integer

The EAN number
The EAN number itself.

Minimum: 0
Maximum: 9999999999999

                    active*

boolean

active flag
Provides information about whether the EAN is active (true) or inactive/deleted (false).

                    eanPriority*

integer

priority of the EAN on a printed content list
Priority of the EAN on a printed content list. EAN always has lowest priority (=1). Primary EAN should have priority 1. The rest should be correlative numbers >1.

Minimum: 1
Maximum: 9

                    deletionTime

string (date-time)

Deletion timestamp
Time of the deletion of this ean (when the active flag switched to false) in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

            season

integer

season (bestandsSaison)
Season in which the article is used, OTTO-specific encoding

Minimum: 0
Maximum: 999

            color

string

simplified color (farbe) description
Simplified color description of the product for logistical processes.

Maximum Length: 12

            style

string

style information (style)
Style information for the packing slip. Appears on the print document ContentList (COBRA). According to NEON also relevant for PL

Maximum Length: 14

            eudrRelevance

string (enum)

EU Deforestation Regulation relevant
Provides information on whether the product is relevant for the EU Deforestation Regulation.

Any of: [ "RELEVANT", "NOT_RELEVANT", "UNKNOWN" ]

            imageUrls

array

array of image URLs
List of image URLs.

                (Array item)

string

image URL

Maximum Length: 256

            standardPrice

integer

selling price in cents (verkaufsPreis)
Selling price of the product in cents

Minimum: 0
Maximum: 9999999

            salesBrand

string

salesbrand (markenName)
salesbrand, e.g. Nike, Marco Polo, Jack & Jones

Maximum Length: 35

            partsQuantity

integer

number of parts (anzahlTeile)
The number of individual parts of an product within the package (must not be confused with the number of packages). Required for returns processing to determine if the product was returned complete. Example: double pack of T-shirts = 2 parts, bikini = 2 parts. The ERP determines which items should carry this attribute. The decision is mainly based on the meaningfulness (no puzzles, no Lego, small items are not checked for completeness in the return). Default value is then 1.

Minimum: 0
Maximum: 1000000000000000000

            measuringUnit*

string (enum)

measuring unit (mengeneinheit)
Identifies the measuring unit. PIECE = piece goods, LENGTH_VARIABLE = length can be specified but width is fixed (e.g. for curtains, fabric,…​), LENGTH_AND_WIDTH_VARIABLE = lenght and width can be specified (e.g. for custom made pleats)

Any of: [ "PIECE", "LENGTH_VARIABLE", "LENGTH_AND_WIDTH_VARIABLE" ]

            handlingType

string (enum)

type of handling (handlingId)
Indicates, how the product is going to be handled. ONE_MAN_HANDLING and TWO_MAN_HANDLING products belong to the bulky items logistics (GL).

Any of: [ "ONE_MAN_HANDLING", "TWO_MAN_HANDLING", "PARCEL", "HANGING_CONFECTION" ]

            productGroup

integer

product group (marktId)
Classification of products (phone, watch, cosmetics, etc.)

Minimum: 0
Maximum: 999

            assortmentClassification

array

use case based assortment classification
Provides information about specific assortments, differentiated by requirements of specific processes.

                (Array item)

object

                    process*

string (enum)

process
Identifies the process, which specifies the permissibility of the transmitted assortment.

Any of: [ "RETURNS_EVALUATION", "RETURNS_BILLING" ]

                    assortment*

integer

assortment ID
Identifies the assortment, which is connected to a process and its specific requirements.

Minimum: 0
Maximum: 999

            organic

object

organic characteristics of the product
Provides information about the organic characteristics of the product.

                hasOrganicCertification*

boolean

organic identification
Provides information on whether the product is an organic good.

                certificationType

string (enum)

type of organic certification
Identifies the type of organic certification of the product.

Any of: [ "GOTS" ]

            batchHandling

boolean

Batch Handling for this product required
This product requires a batch number (chargenNummer) and specific handling, e.g. the batch number of each item must be recorded in the inbound process and all items within an order must have the same batch number in the outbound process.

            shippingFromSupplier

boolean

shipping from supplier (VAL-Artikel)
Identifies, if the product is shipped directly from the supplier or not.

            deliveryScope

array

array of components of the delivery scope
List components of the delivery scope.

                (Array item)

string

component

Maximum Length: 256

            additionalNote

string

additional note (free text)
An additional note about the product, which can be freely defined.

Maximum Length: 1024

            partnerInformation

object

partner
Basic partner information.

                erpPartnerId*

string

ERP ID of partner.
ID of partner used by ERP.

Maximum Length: 36

                erpPartnerName*

string

Name of partner.
Name of partner.

Maximum Length: 36

        dangerousGoodsIdentification

object

dangerous goods characteristics of the product
Includes all relevant dangerous goods information concerning the product.

            dangerous

boolean

dangerous goods identification
Provides information on whether the product is a dangerous good.

            dangerousGoodsType

string (enum)

dangerous goods type
Provides information about the dangerous goods type.

Any of: [ "G01", "G02", "G03", "G04", "G05", "G06", "G07", "G08", "G09", "G10", "G11", "G12", "G13", "G14" ]

            dangerousGoodsStorageArea

string

dangerous goods storage area
Provides information about the dangerous goods storage area. Calculated in LSAS, based on dangerWarnings - and unNumber - attributes.

Maximum Length: 2

            exemptionNotice

string

dangerous goods exemption notice
This information should be attached, so that carriers know, that there are transport simplifications for the product concerning handling. Calculated in LSAS, based on unNumber - attribute.

Maximum Length: 15

            dangerousGoodsShare

integer

dangerous goods share
In most cases not the whole product is dangerous, but only a part of it is. Therefore a share in % is calculated in LSAS, based on productGroup and unNumber combination.

Minimum: 0
Maximum: 100

            physicalState

string

physical state
Provides information about the physical state of the product.

Maximum Length: 50

            accumulatorCapacity

string

accumulator capacity
Provides information about the accumulator capacity of the product in mAh.

Maximum Length: 20

            numberOfAccumulators

string

number of accumulators
Provides information about the number of accumulators of the product, between 1 and 10.

Maximum Length: 20

            numberOfBatteries

string

number of batteries
Provides information about the number of batteries of the product, between 1 and 10.

Maximum Length: 20

            batteryOrAccumulatorTechnology

string

battery or accumulator technology
Provides information about the battery or accumulator technology.

Maximum Length: 1024

            transportCategoryDangerousGoods

string

transport category dangerous goods
Provides information about the transport category of dangerous goods, between 0 and 4.

Maximum Length: 1

            clpHazardPictogram

array

hazard pictogram array
A hazard pictogram is a picture on a label with a warning symbol and certain colors to provide information about the damage that a certain substance or mixture can do to our health or the environment.

                (Array item)

string

hazard pictogram

Maximum Length: 1024

            clpProductLabel

string

product label
The attribute describes whether a CLP-product label is necessary.

Maximum Length: 1024

            clpSafetyDataSheet

string

safety data sheet
The safety data sheet is the central element of communication in the supply chain for hazardous substances and mixtures. It provides the user of chemicals with important information on the identity of the product.

Maximum Length: 1024

            dangerWarnings

array

danger warnings array
Packaging that contains dangerous substances or a dangerous mixture must be labeled to protect the user and the environment.

                (Array item)

string

danger warning

Maximum Length: 1024

            weightBatteriesOrAccumulator

string

weight of batteries or accumulator
Weight batteries/accumulator // Free field (without specifications)/indication of the mass of the installed or enclosed accumulator or battery in g.

Maximum Length: 20

            content

string

content
freetxt // specification of the content of the product.

Maximum Length: 4096

            storageCategoryHazardousMaterial

string

storage category hazardous material
A list of different storage classes.

Maximum Length: 20

            accumulatorPower

string

accumulator power
The specification of accumulator power in Wh. // Freetext

Maximum Length: 20

            deliveryConditionBatteriesOrAccumulators

string

delivery condition of batteries or accumulators
Information on whether a battery or accumulator is built into the product or if it is separated from the product.

Maximum Length: 1024

            limitedQuantityOfDangerousGoods

string

limited quantity of dangerous goods
Limited Quantities (LQ) is the abbreviation for the term dangerous goods, which are packed in limited amounts, that is stated by dangerous goods regulation.

Maximum Length: 1024

            testSummaryLithiumBatteries

string

test summary of lithium batteries
Test summary lithium batteries.

Maximum Length: 1024

            qualityAssuranceProgramLithiumBatteries

string

quality assurance program lithium batteries
Quality assurance program lithium batteries.

Maximum Length: 1024

            relevanceClpObligation

string

relevance of CLP obligation
The CLP regulation deals with the question, whether a substance or mixture has properties that can be considered as dangerous.

Maximum Length: 1024

            relevanceClpDangerousGoods

string

relevance of CLP
Relevance of CLP

Maximum Length: 1024

            safetyInstructions

array

safety instructions array
List of up to 127 safety notes

                (Array item)

string

safety instruction

Maximum Length: 1024

            signalWord

string

signal word
CAUTION/DANGER: The signal word indicates the level of danger and severity of injury or property damage.

Maximum Length: 50

            specialProvisionDangerousGoods

string

special provision of dangerous goods
For certain substances or objects the special regulations are applied, through which the shipping of these substances or objects is wholly or partially exempt from the regulations of the ADR. ADR: European agreement concerning the international carriage of dangerous goods by road.

Maximum Length: 1024

            accumulatorVoltage

string

accumulator voltage
The attribute describes the different voltages of accumulators.

Maximum Length: 50

            languagesClpSafetyDataSheet

string

languages clp safety data sheet
list of 28 languages

Maximum Length: 50

            unNumber

string

UN number
specification of UN-number

Maximum Length: 4

            unStandardTestLithiumBatteries

string

UN standard test lithium batteries
The UN 38.3 test ensures that lithium batteries can be shipped safely.

Maximum Length: 1024

            packingGroupsDangerousGoods

string

packing groups dangerous goods
Assignment of different packing groups, selection 1-3.

Maximum Length: 50

            netQuantityWeight

string

net quantity weight
Specification of the net quantity of the product in gram (g).

Maximum Length: 20

            netQuantityPiece

string

net quantity piece
Specification of the net quantity of the product in piece (pc).

Maximum Length: 20

            netQuantityVolume

string

net quantity volume
Specification of the net quantity of the product in volume (ml).

Maximum Length: 20

            safetyDatasheets

array

array of safety datasheet URLs
List of safety datasheet URLs.

                (Array item)

string

safety datasheet URL

Maximum Length: 256

        ottoSpecificProcessing

object

process-relevant information concerning the business object, specific attributes for Otto and Bonprix products
Process-relevant information concerning the business object 'product'

            priorityInbound

boolean

priority for inbound processes (chefKz)
Product will be prioritized for inbound processes (true=yes, false=no). Bonprix only.

            priorityDelivery

integer

priority for delivery (deliveryFlag, NAB_Kz)
Product will be prioritized for delivery according to the level set. Bonprix only.

Minimum: 0
Maximum: 5

            specialPackaging

integer

product packing information (sonderverpackung, tuetenKz)
Product packing information indicates whether an article is bagable

Minimum: 0
Maximum: 9

            warehouseAreaType*

integer (enum)

warehouse area type (WBKZ)
Classifies an article with regard to the warehouse area, provides information about e. g. Sorter-Ability, Risk of theft, etc.

Any of: [ 0, 1, 2, 3, 4, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18 ]

            returnsSortCode*

integer

returns sort code (retourenSortierId)
Each article has a standard return destination that is stored in the master data

Minimum: 0
Maximum: 999

            oneStopShopping

boolean

one stop shopping code (AbwicklungsartOss)
Indicates if an product is processed as one stop shopping; true=OSS, false=no OSS

            supplierId

integer

supplier ID (LKZ)
Unique ID for the supplier (currently only known for Otto ERP), used by KR1 to identify the main supplier

Minimum: 0
Maximum: 999999

            disposal

integer (enum)

disposal (verwendung)
Indicates the current usage of an article

Any of: [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 17, 18, 19 ]

            enclosures

array

enclosures array (beilagen)
List of enclosures.

Minimum number of items 0
Maximum number of items: 3

                (Array item)

string

enclosure ID

Maximum Length: 4

            groupCodeComposed

integer

product group detail code (warengruppeGesamt)
Composed group Code

Minimum: 0
Maximum: 999

            groupCodeBuying*

integer

buying group code (warengruppeFuehrungsTeam)
Optional filter for the removal of goods, goods are classified by these attributes (needed for COBRA)

Minimum: 0
Maximum: 99

            groupCodeMerchandise*

integer

merchandise group code (warengruppeOperativesTeam)
Optional filter for the removal from storage, goods are classified by these attributes (needed for COBRA)

Minimum: 0
Maximum: 9

            reconditionCode

integer

recondition code (wiederaufbereitung)
Code for the routing label for rework of returned articles

Minimum: 0
Maximum: 9

            individualization

integer

individualization (individualisierung)
Indicates if an article has embossing or engraving

Minimum: 0
Maximum: 9

            expeditionCode

integer

encoding for process-handling of bulkyItems (versandschluessel)
Encoding for process-handling of bulkyItems, includes transport system, goods distribution centre, etc.

Minimum: 0
Maximum: 9999999

            checkRoomCode

integer

check room code (pruefraumId)
Testroom ID to filter removal from storage - results from quality tests

Minimum: 0
Maximum: 5

            ownershipId

integer (enum)

ownership of the product (verfuegbarkeitsId)
The attribute is used to logistically distinguish certain groups of goods. E.g. for stock removal processes (e. g. to prevent throughput goods from being outsourced); 0=OWN_GOODS, 1=EXTERNAL_GOODS_CONSIGNMENT, 3=EXTERNAL_GOODS_THROUGHPUT, 9=UNKNOWN

Any of: [ 0, 1, 3, 9 ]

            location

integer (enum)

master warehouse ID (stammlager)
The master warehouse provides information about where an article comes from

Any of: [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 40, 43, 47, 48, 49, 54, 55, 56, 57, 58, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 88, 92, 99 ]

            returnsVolumeClass

integer

volume class of an article (retourenVolumenklasse)
Volume class of an article, categorized in IDs.

Minimum: 0
Maximum: 13

        packingUnits*

array

packing units array (packstuecke)
List of all packing units

Minimum number of items 1
Maximum number of items: 99

            (Array item)

object

                metaData

object

meta data for packing units
Contains meta data for packing units.

                    measured

boolean

Identifies if the packingUnit was already measured in a warehouse.
Identifies if the packingUnit was already measured in a warehouse.

                    sourceSystem

string

Name of the source system, the measurements come from.

Maximum Length: 30

                    measurementTime

(date-time)

Timestamp of the latest measurement.
Timestamp of the latest measurement in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

                identification*

object

identification of the packing unit
technical and business - identifiers concerning the packing unit

                    logisticsPackingUnitId*

string

logistics packing unit ID
Common technical key between LSAS and warehouse management system. Assigned by LSAS, shared with the WMS.

Maximum Length: 36

                    erpPackingUnitId

string

ERP packing unit ID
Common technical key between LSAS and ERP.

Maximum Length: 36

                    packingUnitIndex

integer

Index of the packing unit (packstueckNr)
Index (number, starting with 1) of this packing unit within the list of all packing unit. If more than one packing unit is present, the packingUnitIndex is required.

Minimum: 1
Maximum: 99

                packingUnitDescription

string

ERP packing unit description
Describes in particular what is inside a packing unit.

Maximum Length: 1024

                geometry

object

geometric data of the packing unit
includes the geometric data of the packing unit

                    length

integer

length
Length in mm

Minimum: 0
Maximum: 99999

                    width

integer

width
Width in mm

Minimum: 0
Maximum: 99999

                    height

integer

height
Height in mm

Minimum: 0
Maximum: 99999

                    weight

integer

weight
Weight in g

Minimum: 0
Maximum: 9999999

                    volume

integer

volume
Volume in dl

Minimum: 0
Maximum: 9999999

                loadingUnitTypePicking

string (enum)

loading unit type for picking
The loading unit type for the process of picking.

Any of: [ "TROLLY_AUTO_SORTING", "TROLLY_NO_AUTO_SORTING", "PALLET" ]

                autoSorting

boolean

auto-sortable flag
Provides information about whether the product is auto-sortable or not.

                autoSortingTypes

array

auto-sorting-types listing
Provides information about on which auto-sorter type the product can be handled.

                    (Array item)

object

                        type*

string (enum)

auto-sorter-type identification
Identifies the auto-sorter type.

Any of: [ "BEUMER_BIG_POCKET_MANUAL", "BEUMER_BIG_POCKET_AUTO", "SPLIT_TILT_TRAYSORTER" ]

                        capable*

boolean

Capable - flag concerning the auto-sorter type
Identifies, if the product can be handled on a specific auto-sorter type.

                warehousePackingForShipping

boolean

deprecated: replaced/removed by shippingInOriginalPackaging with next schema change
Deprecated: Will be replaced/removed by shippingInOriginalPackaging with next schema change. Provides information about whether a product can be shipped in the storage packing without additional shipping packaging or not.

                shippingInOriginalPackaging

boolean

need of additional warehouse packaging
Provides information about whether a product can be shipped in the original product packaging without additional warehouse packaging or not.

                polyBagPacking

boolean

poly-bag-packing capability
Identifies, if the product can be packed in a poly-bag. Here the physical characteristics (not the size/weight!) should be evaluated. E.g. sharp or fragile objects cannot be packed into a polybag. If the product is to big for a bag or not has to be decided later by the ERP within the shipment-order-message (via logisticsbuffer).

                polyBagAutoPacking

boolean

poly-bag-autopacking capability
Identifies, if the product can be auto-packed in a poly-bag.

                polyBagAutoPackingTypes

array

poly-bag auto-packing types listing
Provides information about on which poly-bag auto-packing type the product can be handled.

                    (Array item)

object

                        type*

string (enum)

poly-bag auto-packing type identification
Identifies the poly-bag auto-packing type.

Any of: [ "BECK", "HUGO_BECK", "BVM" ]

                        capable*

boolean

Capable - flag concerning the poly-bag auto-packing type
Identifies, if the product can be handled on a specific poly-bag auto-packing type.

                temptsTheft

boolean

theft-prone flag
Provides information about whether the product is theft-prone or not.

(Root)

object

Schema for logistical product data from the WAREHOUSE to FINE
Contains geometrical and further logistical data concerning the product.

    eventId*

string

The unique eventId
Global unique Id, recommended as uuid

    traceId*

string

The unique traceId
Global unique Id for tracing the flow of events, recommended as uuid

    spanId

string

The eventId of previous record or batchId
Optional. Not provided by LSAS.

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

    context

string (const)

The context / business case
The optional context specified here means the business domain.

Constant: MASTERDATA

    eventType*

string (const)

The concrete type record
The concrete type record.

Constant: LOGISTICAL_DATA_UPDATE

    version*

string (const)

The number of version of schema
Number of version of this data structure. A semantic specification with major & minor version numbers

Constant: 2.2.0

    metaData*

object

additional meta information
required for identifying the source system of the geometrical and/or logistical data update

        sender*

string

Name of the source system, that has sent this message. Usually a WMS. E.g. one of: [KR1_SHF, KR1_HHSTR, KMOTION_ILO, KMOTION_GHM].

Maximum Length: 30

        measurementTime*

(date-time)

Timestamp of the latest measurement.
Timestamp of the latest measurement in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

Maximum Length: 36

    data*

object

Data of the business object
business data, can be used with different characteristics per interface

        identification*

object

identification of the business object
technical identifiers

            logisticsProductId*

string

technical ID 'logistics product ID'
Technical key referencing the product.

Maximum Length: 36

            logisticsPackingUnitId

string

logistics packing unit ID
Technical key for a specific packing unit of the product. This identifier is only needed, if the product has more than one packingUnit (especially in bulky items logistics).

Maximum Length: 36

        packingUnit*

object

packing unit (packstueck)
Attributes concerning the packing unit

            geometry*

object

geometric data of the packing unit
includes the geometric data of the packing unit

                length*

integer

length
Length in mm

Minimum: 0
Maximum: 99999

                width*

integer

width
Width in mm

Minimum: 0
Maximum: 99999

                height*

integer

height
Height in mm

Minimum: 0
Maximum: 99999

                weight*

integer

weight
Weight in g

Minimum: 0
Maximum: 9999999

                volume*

integer

volume
volume in dl

Minimum: 0
Maximum: 9999999

            specialPackaging

integer

product packing information (sonderverpackung, tuetenKz)
Product packing information indicates whether an article is bagable

Minimum: 0
Maximum: 9

            warehouseAreaType

integer (enum)

warehouse area type (wbkz)
Classifies an article with regard to the warehouse area, provides information about e. g. Sorter-Ability, Risk of theft, etc.

Any of: [ 0, 1, 2, 3, 4, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18 ]

            loadingUnitTypePicking

string (enum)

loading unit type for picking
The loading unit type for the process of picking.

Any of: [ "TROLLY_AUTO_SORTING", "TROLLY_NO_AUTO_SORTING", "PALLET" ]

            autoSorting

boolean

auto-sortable flag
Provides information about whether the product is auto-sortable or not.

            autoSortingTypes

array

auto-sorting-types listing
Provides information about on which auto-sorter type the product can be handled.

                (Array item)

object

                    type*

string (enum)

auto-sorter-type identification
Identifies the auto-sorter type.

Any of: [ "BEUMER_BIG_POCKET_MANUAL", "BEUMER_BIG_POCKET_AUTO", "SPLIT_TILT_TRAYSORTER" ]

                    capable*

boolean

Capable - flag concerning the auto-sorter type
Identifies, if the product can be handled on a specific auto-sorter type.

            warehousePackingForShipping

boolean

deprecated: replaced/removed by shippingInOriginalPackaging with next schema change
Deprecated: Will be replaced/removed by shippingInOriginalPackaging with next schema change. Provides information about whether a product can be shipped in the storage packing without additional shipping packaging or not.

            shippingInOriginalPackaging

boolean

need of additional warehouse packaging
Provides information about whether a product can be shipped in the original product packaging without additional warehouse packaging or not.

            polyBagPacking

boolean

poly-bag-packing capability
Identifies, if the product can be packed in a poly-bag. Here the physical characteristics (not the size/weight!) should be evaluated. E.g. sharp or fragile objects cannot be packed into a polybag. If the product is to big for a bag or not has to be decided later by the ERP within the shipment-order-message (via logisticsbuffer).

            polyBagAutoPacking

boolean

poly-bag-autopacking capability
Identifies, if the product can be auto-packed in a poly-bag.

            polyBagAutoPackingTypes

array

poly-bag auto-packing types listing
Provides information about on which poly-bag auto-packing type the product can be handled.

                (Array item)

object

                    type*

string (enum)

poly-bag auto-packing type identification
Identifies the poly-bag auto-packing type.

Any of: [ "BECK", "HUGO_BECK", "BVM" ]

                    capable*

boolean

Capable - flag concerning the poly-bag auto-packing type
Identifies, if the product can be handled on a specific poly-bag auto-packing type.

            temptsTheft

boolean

theft-prone flag
Provides information about whether the product is theft-prone or not.

(Root)

object

Schema for Logistical Product Data (packing unit) from FINE to the ERP or WAREHOUSE
A Product with its associated logistical data and packing unit.

    eventId*

string

The unique eventId
Unique id for this event, set by the sender of the message. It is recommended to be set as a uuid.

    traceId*

string

The unique traceId
Unique id to trace the event/request through several systems. Also used for storing a reference to the original message payload. It is recommended to be set as a uuid.

    spanId

string

The eventId of previous record or batchId
Optional. Not provided by LSAS.

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

    context*

string (const)

The context / business case = MASTERDATA
The optional context specified here means the business domain. Always 'MASTERDATA'

Constant: MASTERDATA

    eventType*

string (const)

The concrete type record
The concrete type record.

Constant: LOGISTICAL_DATA_UPDATE

    version*

string (const)

The number of version of schema
Number of version of this data structure. A semantic specification with major & minor version numbers

Constant: 2.3.0

    metaData*

object

additional meta information
Used to send other relevant information for the message, like sender.

        sender*

(const)

Name of the source system, that has sent this message. Always 'LSAS'.

Constant: LSAS

        sourceSystem

string

The system that produced this dataset and originally sent it to LSAS. Usually a WMS-system.

Maximum Length: 30

        measurementTime

(date-time)

Timestamp of the latest measurement (includes LSAS-internal calculations).
Timestamp of the latest measurement in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

Maximum Length: 36

        measured

boolean

Identifies if the packingUnit was already measured in a warehouse.
Identifies if the packingUnit was already measured in a warehouse.

    data*

object

Data of the business object
business data, can be used with different characteristics per interface

        identification*

object

identification of the business object
technical and business

            erpProductId*

string

technical ID 'erp product ID'
Unique technical key of the ERP for this product. Withing logistics and FINE only unique in combination with the sourceErp. must be used for all communication with an ERP referencing a product.

Maximum Length: 36

            erpPackingUnitId*

string

erp packing unit ID
Technical key for a specific packing unit of the product. This identifier is only needed, if the product has more than one packingUnit (especially in bulky items logistics).

Maximum Length: 36

        dangerousGoodsIdentification

object

dangerous goods characteristics of the product
Includes all relevant dangerous goods information concerning the product.

            dangerousGoodsStorageArea

string

dangerous goods storage area
Provides information about the dangerous goods storage area. Calculated in LSAS, based on dangerWarnings - and unNumber - attributes.

Maximum Length: 2

        ottoSpecificProcessing

object

process-relevant information concerning the business object, specific attributes for Otto and Bonprix products
Process-relevant information concerning the business object 'product'

            specialPackaging

integer

product packing information (sonderverpackung, tuetenKz)
Product packing information indicates whether an article is bagable

Minimum: 0
Maximum: 9

            warehouseAreaType

integer (enum)

warehouse area type (wbkz)
Classifies an article with regard to the warehouse area, provides information about e. g. Sorter-Ability, Risk of theft, etc.

Any of: [ 0, 1, 2, 3, 4, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18 ]

        packingUnit

object

packing unit (packstueck)
Attributes concerning the packing unit

            geometry

object

geometric data of the packing unit
includes the geometric data of the packing unit

                length

integer

length
Length in mm

Minimum: 0
Maximum: 99999

                width

integer

width
Width in mm

Minimum: 0
Maximum: 99999

                height

integer

height
Height in mm

Minimum: 0
Maximum: 99999

                weight

integer

weight
Weight in g

Minimum: 0
Maximum: 9999999

                volume

integer

volume
volume in dl

Minimum: 0
Maximum: 9999999

            autoSorting

boolean

auto-sortable flag
Provides information about whether the product is auto-sortable or not.

            autoSortingTypes

array

auto-sorting-types listing
Provides information about on which auto-sorter type the product can be handled.

                (Array item)

object

                    type*

string (enum)

auto-sorter-type identification
Identifies the auto-sorter type.

Any of: [ "BEUMER_BIG_POCKET_MANUAL", "BEUMER_BIG_POCKET_AUTO", "SPLIT_TILT_TRAYSORTER" ]

                    capable*

boolean

Capable - flag concerning the auto-sorter type
Identifies, if the product can be handled on a specific auto-sorter type.

            temptsTheft

boolean

theft-prone flag
Provides information about whether the product is theft-prone or not.

(Root)

object

Schema for Supplier Master Data from ERP to FINE, 'single'-variant
A Supplier with all its associated data. Variant of the schema to send a single dataset.

    eventId*

string

The unique eventId
Global unique Id, recommended as uuid

    traceId*

string

The unique traceId
Global unique Id for tracing the flow of events, recommended as uuid

    spanId

string

The eventId of previous record or batchId
Optional spanID.

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

    context

string (const)

The context / business case
The optional context specified here means the business domain.

Constant: MASTERDATA

    eventType*

string (const)

The concrete type record
The concrete type record.

Constant: SUPPLIER_UPDATE

    version*

string (const)

The number of version of schema
Number of version of this data structure. A semantic specification with major & minor version numbers

Constant: 2.2.0

    metaData*

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender*

string

Name of the source system, that has sent this message.

Maximum Length: 30

        company*

string

Name of the source company.

Maximum Length: 30

        clientSystems*

array

List of client system, this dataset should be sent to. LSAS uses this for filtering the messages.

            (Array item)

string

Maximum Length: 30

    data*

object

Data of the business object
business data, can be used with different characteristics per interface

        active*

boolean

active flag
Provides information about whether the supplier is active (true) or inactive/deleted (false)

        identification*

object

identification of the business object
technical and business - identifiers concerning the business object 'supplier'

            erpSupplierId*

string

technical ID 'erp supplier ID'
Unique technical key of the ERP for this supplier. Within logistics and FINE only unique in combination with the sourceErp. Must be used for all communication with an ERP referencing a supplier.

Maximum Length: 36

            supplierId

integer

supplier ID (LKZ)
Unique ID for the supplier (currently only known for Otto ERP), used by KR1 to identify the main supplier

Minimum: 0
Maximum: 999999

        ownership*

object

ownership information concerning the business object
Ownership information concerning the business object 'supplier'

            ownerCompany*

string

stock owner company (bestandsfirma)
stock owner company for the supplier

Maximum Length: 30

        supplier*

object

supplier
basic supplier information

            supplierName*

string

name of the supplier
Provides information about the name of the supplier.

Maximum Length: 35

            creditorNumber

integer

number of the creditor
Provides information about the creditor number of a supplier.

Minimum: 0
Maximum: 9999999999

        address

object

suppliers address
address information of the supplier

            addressName

string

name of the supplier (address header)
Provides information about the name of the supplier in the address header.

Maximum Length: 100

            addressStreet

string

address street
Provides information about the name of the street, where the supplier is located.

Maximum Length: 100

            addressZip

string

address ZIP Code
Provides information about the ZIP - code, where the supplier is located.

Maximum Length: 10

            addressCity

string

address city
Provides information about the name of the city, where the supplier is located.

Maximum Length: 100

            addressCountryCode

string

address country code
Provides information about the address country code of the suppliers origin (ISO standard).

Maximum Length: 2

(Root)

object

Schema for Supplier Master Data from FINE to the WMS
A Supplier with all its associated data.

    eventId*

string

The unique eventId
Global unique Id, recommended as uuid

    traceId*

string

The unique traceId
Global unique Id for tracing the flow of events, recommended as uuid

    spanId

string

The eventId of previous record or batchId
Optional. Not provided by LSAS.

    eventTime*

string (date-time)

Time of occurrence of the event
Time at which this record (event) was technically generated in RFC3339 format in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

    context

string (const)

The context / business case
The optional context specified here means the business domain.

Constant: MASTERDATA

    eventType*

string (const)

The concrete type record
The concrete type record.

Constant: SUPPLIER_UPDATE

    version*

string (const)

The number of version of schema
Number of version of this data structure. A semantic specification with major & minor version numbers

Constant: 2.2.0

    metaData*

object

additional meta information
optional, can be used with different characteristics for technical data per interface

        sender*

string (const)

Sender of the message
Name of the source system, that has sent this message.

Constant: LSAS

        sourceSystem*

string

The system that produced this dataset and originally sent it to LSAS. Usually an ERP-system.

Maximum Length: 30

        sourceCompany*

string

Name of the source company.

Maximum Length: 30

        clientSystems*

array

List of client systems this dataset is relevant for. Used for filtering for the different client systems.

            (Array item)

object

                client*

string

Name of client system.

Maximum Length: 30

                status*

string (enum)

Export status
Status to show, if a client should receive this dataset. RELEVANT - client must receive it, REMOVED - previously this item was relevant for a client, now it must be deleted (client must take care to delete the dataset by itself)

Any of: [ "RELEVANT", "REMOVED" ]

    data*

object

Data of the business object
business data, can be used with different characteristics per interface

        creationTime*

string (date-time)

Creation timestamp
Time of creation of the supplier in LSAS in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

        updateTime*

string (date-time)

Last update timestamp
Time of last update in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

        deletionTime

string (date-time)

Deletion timestamp
Time of the deletion of this supplier (when the active flag switched to false) in UTC time. Format: YYYY-MM-ddThh:mm:ss.SSSZ

        active*

boolean

active flag
Provides information about whether the supplier is active (true) or inactive/deleted (false)

        identification*

object

identification of the business object
technical and business - identifiers concerning the business object 'supplier'

            erpSupplierId*

string

technical ID 'erp supplier ID'
Unique technical key of the ERP for this supplier. Within logistics and FINE only unique in combination with the sourceErp. Must be used for all communication with an ERP referencing a supplier.

Maximum Length: 36

            logisticsSupplierId

string

technical ID 'logistics supplier ID'
Unique technical key in all logistics systems, assigned by LSAS. must be used in all communication between logistics systems and FINE, when referencing a supplier.

Maximum Length: 36

            supplierId

integer

supplier ID (LKZ)
Unique ID for the supplier (currently only known for Otto ERP), used by KR1 to identify the main supplier

Minimum: 0
Maximum: 999999

        ownership*

object

ownership information concerning the business object
Ownership information concerning the business object 'supplier'

            ownerCompany*

string

stock owner company (bestandsfirma)
stock owner company for the supplier

Maximum Length: 30

        supplier*

object

supplier
basic supplier information

            supplierName*

string

name of the supplier
Provides information about the name of the supplier.

Maximum Length: 35

            creditorNumber

integer

number of the creditor
Provides information about the creditor number of a supplier.

Minimum: 0
Maximum: 9999999999

        address

object

suppliers address
address information of the supplier

            addressName

string

name of the supplier (address header)
Provides information about the name of the supplier in the address header.

Maximum Length: 100

            addressStreet

string

address street
Provides information about the name of the street, where the supplier is located.

Maximum Length: 100

            addressZip

string

address ZIP Code
Provides information about the ZIP - code, where the supplier is located.

Maximum Length: 10

            addressCity

string

address city
Provides information about the name of the city, where the supplier is located.

Maximum Length: 100

            addressCountryCode

string

address country code
Provides information about the address country code of the suppliers origin (ISO standard).

Maximum Length: 2

(Root)

object

Schema for Supplier-Product Master Data from ERP to FINE, 'single'-variant
A Supplier-Product with all its associated data. Variant of the schema to send a single dataset.

    eventId*

string

The unique eventId
Global unique Id, recommended as uuid

    traceId*