This is the multi-page printable view of this section. Click here to print.
10 Master Data
- 1: LSAS
- 1.1:
- 1.2:
- 1.3:
- 1.4:
- 1.5:
- 1.6: M01 Product
- 1.7: M02 Logistical Data
- 1.8: M03 Supplier
- 1.9: M04 Supplier Product
- 1.10: Response
1 - LSAS
1.1 -
1.1.1 -
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Product Master Data from ERP to FINE, 'single'-variant |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record Constant: PRODUCT_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.8.0 |
metaData* |
object |
additional meta information |
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 |
active* |
boolean |
active flag |
identification* |
object |
identification of the business object |
erpProductId* |
string |
technical ID 'erp product ID' Maximum Length: 36 |
erpProductCode |
string |
erpProductCode (erpSchluesselFachlich) Maximum Length: 36 |
ownerCompanyProductCode |
string |
ownerCompanyProductCode (referenzArtikelNummer) Maximum Length: 36 |
itemoptioncommkey |
string |
technical key, provided by ERP Maximum Length: 18 |
ownership* |
object |
ownership information concerning the business object |
ownerCompany* |
string |
stock company ID (bestandsfirma) Maximum Length: 30 |
sourceOwnerCompany |
string |
stock company origin (firmenHerkunft) Maximum Length: 30 |
product* |
object |
product |
productName* |
string |
product description (shortened, optimized for logistics use-cases) Maximum Length: 18 |
productNumber* |
integer |
product number (artikelNummer) Minimum: 0 |
size* |
string |
alphanumerical product size (groesseLogistisch) Maximum Length: 10 |
sizeNumeric |
integer |
numerical product size (groesseNumerisch) Minimum: 0 |
orderSize |
string |
additional - freely defined - alphanumerical product size Maximum Length: 18 |
eans |
array |
list of alternative EANs Minimum number of items 0 |
(Array item) |
object |
Additional Properties: false |
ean* |
integer |
The EAN number Minimum: 0 |
active* |
boolean |
active flag |
eanPriority* |
integer |
priority of the EAN on a printed content list Minimum: 1 |
season |
integer |
season (bestandsSaison) Minimum: 0 |
color |
string |
simplified color (farbe) description Maximum Length: 12 |
style |
string |
style information (style) Maximum Length: 14 |
imageUrls |
array |
array of image URLs |
(Array item) |
string |
image URL Maximum Length: 256 |
standardPrice |
integer |
selling price in cents (verkaufsPreis) Minimum: 0 |
salesBrand |
string |
salesbrand (markenName) Maximum Length: 35 |
partsQuantity |
integer |
number of parts (anzahlTeile) Minimum: 0 |
measuringUnit* |
string (enum) |
measuring unit (mengeneinheit) Any of: [
"PIECE",
"LENGTH_VARIABLE",
"LENGTH_AND_WIDTH_VARIABLE"
] |
logisticsType* |
string (enum) |
logistics type (Lagerbestandstyp) Any of: [
"PARCEL",
"BULKY",
"UNKNOWN"
] |
handlingType |
string (enum) |
type of handling (handlingId) Any of: [
"ONE_MAN_HANDLING",
"TWO_MAN_HANDLING",
"PARCEL",
"HANGING_CONFECTION"
] |
productGroup |
integer |
product group (marktId) Minimum: 0 |
assortmentClassification |
array |
use case based assortment classification |
(Array item) |
object |
|
process* |
string (enum) |
process Any of: [
"RETURNS_EVALUATION",
"RETURNS_BILLING"
] |
assortment* |
integer |
assortment ID Minimum: 0 |
organic |
object |
organic characteristics of the product |
hasOrganicCertification* |
boolean |
organic identification |
certificationType |
string (enum) |
type of organic certification Any of: [
"GOTS"
] |
batchHandling |
boolean |
Batch Handling for this product required |
shippingFromSupplier |
boolean |
shipping from supplier (VAL-Artikel) |
deliveryScope |
array |
array of components of the delivery scope |
(Array item) |
string |
component Maximum Length: 256 |
additionalNote |
string |
additional note (free text) Maximum Length: 1024 |
partnerInformation |
object |
partner |
erpPartnerId* |
string |
ERP ID of partner. Maximum Length: 36 |
erpPartnerName* |
string |
Name of partner. Maximum Length: 36 |
dangerousGoodsIdentification |
object |
dangerous goods characteristics of the product |
dangerous |
boolean |
dangerous goods identification |
dangerousGoodsType |
string (enum) |
dangerous goods type Any of: [
"G01",
"G02",
"G03",
"G04",
"G05",
"G06",
"G07",
"G08",
"G09",
"G10",
"G11",
"G12",
"G13",
"G14"
] |
physicalState |
string |
physical state Maximum Length: 50 |
accumulatorCapacity |
string |
accumulator capacity Maximum Length: 20 |
numberOfAccumulators |
string |
number of accumulators Maximum Length: 20 |
numberOfBatteries |
string |
number of batteries Maximum Length: 20 |
batteryOrAccumulatorTechnology |
string |
battery or accumulator technology Maximum Length: 1024 |
transportCategoryDangerousGoods |
string |
transport category dangerous goods Maximum Length: 1 |
clpHazardPictogram |
array |
hazard pictogram array |
(Array item) |
string |
hazard pictogram Maximum Length: 1024 |
clpProductLabel |
string |
product label Maximum Length: 1024 |
clpSafetyDataSheet |
string |
safety data sheet Maximum Length: 1024 |
dangerWarnings |
array |
danger warnings array |
(Array item) |
string |
danger warning Maximum Length: 1024 |
weightBatteriesOrAccumulator |
string |
weight of batteries or accumulator Maximum Length: 20 |
content |
string |
content Maximum Length: 4096 |
storageCategoryHazardousMaterial |
string |
storage category hazardous material Maximum Length: 20 |
accumulatorPower |
string |
accumulator power Maximum Length: 20 |
deliveryConditionBatteriesOrAccumulators |
string |
delivery condition of batteries or accumulators Maximum Length: 1024 |
limitedQuantityOfDangerousGoods |
string |
limited quantity of dangerous goods Maximum Length: 1024 |
testSummaryLithiumBatteries |
string |
test summary of lithium batteries Maximum Length: 1024 |
qualityAssuranceProgramLithiumBatteries |
string |
quality assurance program lithium batteries Maximum Length: 1024 |
relevanceClpObligation |
string |
relevance of CLP obligation Maximum Length: 1024 |
relevanceClpDangerousGoods |
string |
relevance of CLP Maximum Length: 1024 |
safetyInstructions |
array |
safety instructions array |
(Array item) |
string |
safety instruction Maximum Length: 1024 |
signalWord |
string |
signal word Maximum Length: 50 |
specialProvisionDangerousGoods |
string |
special provision of dangerous goods Maximum Length: 1024 |
accumulatorVoltage |
string |
accumulator voltage Maximum Length: 50 |
languagesClpSafetyDataSheet |
string |
languages clp safety data sheet Maximum Length: 50 |
unNumber |
string |
UN number Maximum Length: 1024 |
unStandardTestLithiumBatteries |
string |
UN standard test lithium batteries Maximum Length: 1024 |
packingGroupsDangerousGoods |
string |
packing groups dangerous goods Maximum Length: 50 |
netQuantityWeight |
string |
net quantity weight Maximum Length: 20 |
netQuantityPiece |
string |
net quantity piece Maximum Length: 20 |
netQuantityVolume |
string |
net quantity volume Maximum Length: 20 |
ottoSpecificProcessing |
object |
process-relevant information concerning the business object, specific attributes for Otto and Bonprix products |
priorityInbound |
boolean |
priority for inbound processes (chefKz) |
priorityDelivery |
integer |
priority for delivery (deliveryFlag, NAB_Kz) Minimum: 0 |
specialPackaging |
integer |
product packing information (sonderverpackung, tuetenKz) Minimum: 0 |
warehouseAreaType* |
integer (enum) |
warehouse area type (WBKZ) 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) Minimum: 0 |
oneStopShopping |
boolean |
one stop shopping code (AbwicklungsartOss) |
supplierId |
integer |
supplier ID (LKZ) Minimum: 0 |
disposal |
integer (enum) |
disposal (verwendung) 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) Minimum number of items 0 |
(Array item) |
string |
enclosure ID Maximum Length: 4 |
groupCodeComposed |
integer |
product group detail code (warengruppeGesamt) Minimum: 0 |
groupCodeBuying* |
integer |
buying group code (warengruppeFuehrungsTeam) Minimum: 0 |
groupCodeMerchandise* |
integer |
merchandise group code (warengruppeOperativesTeam) Minimum: 0 |
reconditionCode |
integer |
recondition code (wiederaufbereitung) Minimum: 0 |
individualization |
integer |
individualization (individualisierung) Minimum: 0 |
expeditionCode |
integer |
encoding for process-handling of bulkyItems (versandschluessel) Minimum: 0 |
checkRoomCode |
integer |
check room code (pruefraumId) Minimum: 0 |
ownershipId |
integer (enum) |
ownership of the product (verfuegbarkeitsId) Any of: [
0,
1,
3,
9
] |
location |
integer (enum) |
master warehouse ID (stammlager) 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) Minimum: 0 |
packingUnits* |
array |
packing units array (packstuecke) Minimum number of items 1 |
(Array item) |
object |
|
identification* |
object |
identification of the packing unit |
erpPackingUnitId* |
string |
ERP packing unit ID Maximum Length: 36 |
packingUnitIndex |
integer |
Index of the packing unit (packstueckNr) Minimum: 1 |
packingUnitDescription |
string |
ERP packing unit description Maximum Length: 1024 |
geometry |
object |
geometric data of the packing unit |
length |
integer |
length Minimum: 0 |
width |
integer |
width Minimum: 0 |
height |
integer |
height Minimum: 0 |
weight |
integer |
weight Minimum: 0 |
volume |
integer |
volume Minimum: 0 |
1.1.2 -
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Product Master Data from FINE to WMS |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record = PRODUCT_UPDATE Constant: PRODUCT_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.8.0 |
metaData* |
object |
additional meta information |
sender* |
string (const) |
Sender of the 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 Any of: [
"RELEVANT",
"REMOVED"
] |
data* |
object |
Data of the business object |
creationTime* |
string (date-time) |
Creation timestamp |
updateTime* |
string (date-time) |
Last update timestamp |
deletionTime |
string (date-time) |
Deletion timestamp |
active* |
boolean |
active flag |
identification* |
object |
identification of the business object |
logisticsProductId* |
string |
technical ID 'logistics product ID' Maximum Length: 36 |
erpProductId* |
string |
technical ID 'erp product ID' Maximum Length: 36 |
erp* |
string |
ERP identifier Maximum Length: 30 |
erpProductCode |
string |
erpProductCode (erpSchluesselFachlich) Maximum Length: 36 |
ownerCompanyProductCode |
string |
ownerCompanyProductCode (referenzArtikelNummer) Maximum Length: 36 |
itemoptioncommkey |
string |
technical key, provided by ERP Maximum Length: 18 |
ownership* |
object |
ownership information concerning the business object |
ownerCompany* |
string |
stock company ID (bestandsfirma) Maximum Length: 30 |
sourceOwnerCompany |
string |
stock company origin (firmenHerkunft) Maximum Length: 30 |
product* |
object |
product |
productName* |
string |
product description (shortened, optimized for logistics use-cases) Maximum Length: 18 |
productNumber* |
integer |
product number (artikelNummer) Minimum: 0 |
size* |
string |
alphanumerical product size (groesseLogistisch) Maximum Length: 10 |
sizeNumeric |
integer |
numerical product size (groesseNumerisch) Minimum: 0 |
orderSize |
string |
additional - freely defined - alphanumerical product size Maximum Length: 18 |
eans |
array |
list of EANs associated with this product Minimum number of items 0 |
(Array item) |
object |
Additional Properties: false |
ean* |
integer |
The EAN number Minimum: 0 |
active* |
boolean |
active flag |
eanPriority* |
integer |
priority of the EAN on a printed content list Minimum: 1 |
deletionTime |
string (date-time) |
Deletion timestamp |
season |
integer |
season (bestandsSaison) Minimum: 0 |
color |
string |
simplified color (farbe) description Maximum Length: 12 |
style |
string |
style information (style) Maximum Length: 14 |
imageUrls |
array |
array of image URLs |
(Array item) |
string |
image URL Maximum Length: 256 |
standardPrice |
integer |
selling price in cents (verkaufsPreis) Minimum: 0 |
salesBrand |
string |
salesbrand (markenName) Maximum Length: 35 |
partsQuantity |
integer |
number of parts (anzahlTeile) Minimum: 0 |
measuringUnit* |
string (enum) |
measuring unit (mengeneinheit) Any of: [
"PIECE",
"LENGTH_VARIABLE",
"LENGTH_AND_WIDTH_VARIABLE"
] |
handlingType |
string (enum) |
type of handling (handlingId) Any of: [
"ONE_MAN_HANDLING",
"TWO_MAN_HANDLING",
"PARCEL",
"HANGING_CONFECTION"
] |
productGroup |
integer |
product group (marktId) Minimum: 0 |
assortmentClassification |
array |
use case based assortment classification |
(Array item) |
object |
|
process* |
string (enum) |
process Any of: [
"RETURNS_EVALUATION",
"RETURNS_BILLING"
] |
assortment* |
integer |
assortment ID Minimum: 0 |
organic |
object |
organic characteristics of the product |
hasOrganicCertification* |
boolean |
organic identification |
certificationType |
string (enum) |
type of organic certification Any of: [
"GOTS"
] |
batchHandling |
boolean |
Batch Handling for this product required |
shippingFromSupplier |
boolean |
shipping from supplier (VAL-Artikel) |
deliveryScope |
array |
array of components of the delivery scope |
(Array item) |
string |
component Maximum Length: 256 |
additionalNote |
string |
additional note (free text) Maximum Length: 1024 |
partnerInformation |
object |
partner |
erpPartnerId* |
string |
ERP ID of partner. Maximum Length: 36 |
erpPartnerName* |
string |
Name of partner. Maximum Length: 36 |
dangerousGoodsIdentification |
object |
dangerous goods characteristics of the product |
dangerous |
boolean |
dangerous goods identification |
dangerousGoodsType |
string (enum) |
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 Maximum Length: 2 |
exemptionNotice |
string |
dangerous goods exemption notice Maximum Length: 15 |
dangerousGoodsShare |
integer |
dangerous goods share Minimum: 0 |
physicalState |
string |
physical state Maximum Length: 50 |
accumulatorCapacity |
string |
accumulator capacity Maximum Length: 20 |
numberOfAccumulators |
string |
number of accumulators Maximum Length: 20 |
numberOfBatteries |
string |
number of batteries Maximum Length: 20 |
batteryOrAccumulatorTechnology |
string |
battery or accumulator technology Maximum Length: 1024 |
transportCategoryDangerousGoods |
string |
transport category dangerous goods Maximum Length: 1 |
clpHazardPictogram |
array |
hazard pictogram array |
(Array item) |
string |
hazard pictogram Maximum Length: 1024 |
clpProductLabel |
string |
product label Maximum Length: 1024 |
clpSafetyDataSheet |
string |
safety data sheet Maximum Length: 1024 |
dangerWarnings |
array |
danger warnings array |
(Array item) |
string |
danger warning Maximum Length: 1024 |
weightBatteriesOrAccumulator |
string |
weight of batteries or accumulator Maximum Length: 20 |
content |
string |
content Maximum Length: 4096 |
storageCategoryHazardousMaterial |
string |
storage category hazardous material Maximum Length: 20 |
accumulatorPower |
string |
accumulator power Maximum Length: 20 |
deliveryConditionBatteriesOrAccumulators |
string |
delivery condition of batteries or accumulators Maximum Length: 1024 |
limitedQuantityOfDangerousGoods |
string |
limited quantity of dangerous goods Maximum Length: 1024 |
testSummaryLithiumBatteries |
string |
test summary of lithium batteries Maximum Length: 1024 |
qualityAssuranceProgramLithiumBatteries |
string |
quality assurance program lithium batteries Maximum Length: 1024 |
relevanceClpObligation |
string |
relevance of CLP obligation Maximum Length: 1024 |
relevanceClpDangerousGoods |
string |
relevance of CLP Maximum Length: 1024 |
safetyInstructions |
array |
safety instructions array |
(Array item) |
string |
safety instruction Maximum Length: 1024 |
signalWord |
string |
signal word Maximum Length: 50 |
specialProvisionDangerousGoods |
string |
special provision of dangerous goods Maximum Length: 1024 |
accumulatorVoltage |
string |
accumulator voltage Maximum Length: 50 |
languagesClpSafetyDataSheet |
string |
languages clp safety data sheet Maximum Length: 50 |
unNumber |
string |
UN number Maximum Length: 4 |
unStandardTestLithiumBatteries |
string |
UN standard test lithium batteries Maximum Length: 1024 |
packingGroupsDangerousGoods |
string |
packing groups dangerous goods Maximum Length: 50 |
netQuantityWeight |
string |
net quantity weight Maximum Length: 20 |
netQuantityPiece |
string |
net quantity piece Maximum Length: 20 |
netQuantityVolume |
string |
net quantity volume Maximum Length: 20 |
ottoSpecificProcessing |
object |
process-relevant information concerning the business object, specific attributes for Otto and Bonprix products |
priorityInbound |
boolean |
priority for inbound processes (chefKz) |
priorityDelivery |
integer |
priority for delivery (deliveryFlag, NAB_Kz) Minimum: 0 |
specialPackaging |
integer |
product packing information (sonderverpackung, tuetenKz) Minimum: 0 |
warehouseAreaType* |
integer (enum) |
warehouse area type (WBKZ) 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) Minimum: 0 |
oneStopShopping |
boolean |
one stop shopping code (AbwicklungsartOss) |
supplierId |
integer |
supplier ID (LKZ) Minimum: 0 |
disposal |
integer (enum) |
disposal (verwendung) 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) Minimum number of items 0 |
(Array item) |
string |
enclosure ID Maximum Length: 4 |
groupCodeComposed |
integer |
product group detail code (warengruppeGesamt) Minimum: 0 |
groupCodeBuying* |
integer |
buying group code (warengruppeFuehrungsTeam) Minimum: 0 |
groupCodeMerchandise* |
integer |
merchandise group code (warengruppeOperativesTeam) Minimum: 0 |
reconditionCode |
integer |
recondition code (wiederaufbereitung) Minimum: 0 |
individualization |
integer |
individualization (individualisierung) Minimum: 0 |
expeditionCode |
integer |
encoding for process-handling of bulkyItems (versandschluessel) Minimum: 0 |
checkRoomCode |
integer |
check room code (pruefraumId) Minimum: 0 |
ownershipId |
integer (enum) |
ownership of the product (verfuegbarkeitsId) Any of: [
0,
1,
3,
9
] |
location |
integer (enum) |
master warehouse ID (stammlager) 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) Minimum: 0 |
packingUnits* |
array |
packing units array (packstuecke) Minimum number of items 1 |
(Array item) |
object |
|
metaData |
object |
meta data for packing units |
measured |
boolean |
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. |
identification* |
object |
identification of the packing unit |
logisticsPackingUnitId* |
string |
logistics packing unit ID Maximum Length: 36 |
erpPackingUnitId |
string |
ERP packing unit ID Maximum Length: 36 |
packingUnitIndex |
integer |
Index of the packing unit (packstueckNr) Minimum: 1 |
packingUnitDescription |
string |
ERP packing unit description Maximum Length: 1024 |
geometry |
object |
geometric data of the packing unit |
length |
integer |
length Minimum: 0 |
width |
integer |
width Minimum: 0 |
height |
integer |
height Minimum: 0 |
weight |
integer |
weight Minimum: 0 |
volume |
integer |
volume Minimum: 0 |
loadingUnitTypePicking |
string (enum) |
loading unit type for picking Any of: [
"TROLLY_AUTO_SORTING",
"TROLLY_NO_AUTO_SORTING",
"PALLET"
] |
autoSorting |
boolean |
auto-sortable flag |
autoSortingTypes |
array |
auto-sorting-types listing |
(Array item) |
object |
|
type* |
string (enum) |
auto-sorter-type identification Any of: [
"BEUMER_BIG_POCKET_MANUAL",
"BEUMER_BIG_POCKET_AUTO",
"SPLIT_TILT_TRAYSORTER"
] |
capable* |
boolean |
Capable - flag concerning the auto-sorter type |
warehousePackingForShipping |
boolean |
deprecated: replaced/removed by shippingInOriginalPackaging with next schema change |
shippingInOriginalPackaging |
boolean |
need of additional warehouse packaging |
polyBagPacking |
boolean |
poly-bag-packing capability |
polyBagAutoPacking |
boolean |
poly-bag-autopacking capability |
polyBagAutoPackingTypes |
array |
poly-bag auto-packing types listing |
(Array item) |
object |
|
type* |
string (enum) |
poly-bag auto-packing type identification Any of: [
"BECK",
"HUGO_BECK",
"BVM"
] |
capable* |
boolean |
Capable - flag concerning the poly-bag auto-packing type |
temptsTheft |
boolean |
theft-prone flag |
1.2 -
1.2.1 -
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for logistical product data from the WAREHOUSE to FINE |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record Constant: LOGISTICAL_DATA_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.2.0 |
metaData* |
object |
additional meta information |
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. Maximum Length: 36 |
data* |
object |
Data of the business object |
identification* |
object |
identification of the business object |
logisticsProductId* |
string |
technical ID 'logistics product ID' Maximum Length: 36 |
logisticsPackingUnitId |
string |
logistics packing unit ID Maximum Length: 36 |
packingUnit* |
object |
packing unit (packstueck) |
geometry* |
object |
geometric data of the packing unit |
length* |
integer |
length Minimum: 0 |
width* |
integer |
width Minimum: 0 |
height* |
integer |
height Minimum: 0 |
weight* |
integer |
weight Minimum: 0 |
volume* |
integer |
volume Minimum: 0 |
specialPackaging |
integer |
product packing information (sonderverpackung, tuetenKz) Minimum: 0 |
warehouseAreaType |
integer (enum) |
warehouse area type (wbkz) 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 Any of: [
"TROLLY_AUTO_SORTING",
"TROLLY_NO_AUTO_SORTING",
"PALLET"
] |
autoSorting |
boolean |
auto-sortable flag |
autoSortingTypes |
array |
auto-sorting-types listing |
(Array item) |
object |
|
type* |
string (enum) |
auto-sorter-type identification Any of: [
"BEUMER_BIG_POCKET_MANUAL",
"BEUMER_BIG_POCKET_AUTO",
"SPLIT_TILT_TRAYSORTER"
] |
capable* |
boolean |
Capable - flag concerning the auto-sorter type |
warehousePackingForShipping |
boolean |
deprecated: replaced/removed by shippingInOriginalPackaging with next schema change |
shippingInOriginalPackaging |
boolean |
need of additional warehouse packaging |
polyBagPacking |
boolean |
poly-bag-packing capability |
polyBagAutoPacking |
boolean |
poly-bag-autopacking capability |
polyBagAutoPackingTypes |
array |
poly-bag auto-packing types listing |
(Array item) |
object |
|
type* |
string (enum) |
poly-bag auto-packing type identification Any of: [
"BECK",
"HUGO_BECK",
"BVM"
] |
capable* |
boolean |
Capable - flag concerning the poly-bag auto-packing type |
temptsTheft |
boolean |
theft-prone flag |
1.2.2 -
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Logistical Product Data (packing unit) from FINE to the ERP or WAREHOUSE |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context* |
string (const) |
The context / business case = MASTERDATA Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record Constant: LOGISTICAL_DATA_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.2.0 |
metaData* |
object |
additional meta information |
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). Maximum Length: 36 |
data* |
object |
Data of the business object |
identification* |
object |
identification of the business object |
erpProductId* |
string |
technical ID 'erp product ID' Maximum Length: 36 |
erpPackingUnitId* |
string |
erp packing unit ID Maximum Length: 36 |
dangerousGoodsIdentification |
object |
dangerous goods characteristics of the product |
dangerousGoodsStorageArea |
string |
dangerous goods storage area Maximum Length: 2 |
ottoSpecificProcessing |
object |
process-relevant information concerning the business object, specific attributes for Otto and Bonprix products |
specialPackaging |
integer |
product packing information (sonderverpackung, tuetenKz) Minimum: 0 |
warehouseAreaType |
integer (enum) |
warehouse area type (wbkz) Any of: [
0,
1,
2,
3,
4,
6,
7,
8,
9,
11,
12,
13,
14,
15,
16,
17,
18
] |
packingUnit |
object |
packing unit (packstueck) |
geometry |
object |
geometric data of the packing unit |
length |
integer |
length Minimum: 0 |
width |
integer |
width Minimum: 0 |
height |
integer |
height Minimum: 0 |
weight |
integer |
weight Minimum: 0 |
volume |
integer |
volume Minimum: 0 |
autoSorting |
boolean |
auto-sortable flag |
autoSortingTypes |
array |
auto-sorting-types listing |
(Array item) |
object |
|
type* |
string (enum) |
auto-sorter-type identification Any of: [
"BEUMER_BIG_POCKET_MANUAL",
"BEUMER_BIG_POCKET_AUTO",
"SPLIT_TILT_TRAYSORTER"
] |
capable* |
boolean |
Capable - flag concerning the auto-sorter type |
temptsTheft |
boolean |
theft-prone flag |
1.3 -
1.3.1 -
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Supplier Master Data from ERP to FINE, 'single'-variant |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record Constant: SUPPLIER_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.2.0 |
metaData* |
object |
additional meta information |
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 |
active* |
boolean |
active flag |
identification* |
object |
identification of the business object |
erpSupplierId* |
string |
technical ID 'erp supplier ID' Maximum Length: 36 |
supplierId |
integer |
supplier ID (LKZ) Minimum: 0 |
ownership* |
object |
ownership information concerning the business object |
ownerCompany* |
string |
stock owner company (bestandsfirma) Maximum Length: 30 |
supplier* |
object |
supplier |
supplierName* |
string |
name of the supplier Maximum Length: 35 |
creditorNumber |
integer |
number of the creditor Minimum: 0 |
address |
object |
suppliers address |
addressName |
string |
name of the supplier (address header) Maximum Length: 100 |
addressStreet |
string |
address street Maximum Length: 100 |
addressZip |
string |
address ZIP Code Maximum Length: 10 |
addressCity |
string |
address city Maximum Length: 100 |
addressCountryCode |
string |
address country code Maximum Length: 2 |
1.3.2 -
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Supplier Master Data from FINE to the WMS |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record Constant: SUPPLIER_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.2.0 |
metaData* |
object |
additional meta information |
sender* |
string (const) |
Sender of the 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 Any of: [
"RELEVANT",
"REMOVED"
] |
data* |
object |
Data of the business object |
creationTime* |
string (date-time) |
Creation timestamp |
updateTime* |
string (date-time) |
Last update timestamp |
deletionTime |
string (date-time) |
Deletion timestamp |
active* |
boolean |
active flag |
identification* |
object |
identification of the business object |
erpSupplierId* |
string |
technical ID 'erp supplier ID' Maximum Length: 36 |
logisticsSupplierId |
string |
technical ID 'logistics supplier ID' Maximum Length: 36 |
supplierId |
integer |
supplier ID (LKZ) Minimum: 0 |
ownership* |
object |
ownership information concerning the business object |
ownerCompany* |
string |
stock owner company (bestandsfirma) Maximum Length: 30 |
supplier* |
object |
supplier |
supplierName* |
string |
name of the supplier Maximum Length: 35 |
creditorNumber |
integer |
number of the creditor Minimum: 0 |
address |
object |
suppliers address |
addressName |
string |
name of the supplier (address header) Maximum Length: 100 |
addressStreet |
string |
address street Maximum Length: 100 |
addressZip |
string |
address ZIP Code Maximum Length: 10 |
addressCity |
string |
address city Maximum Length: 100 |
addressCountryCode |
string |
address country code Maximum Length: 2 |
1.4 -
1.4.1 -
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Supplier-Product Master Data from ERP to FINE, 'single'-variant |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record Constant: SUPPLIER_PRODUCT_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.1.4 |
metaData* |
object |
additional meta information |
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 |
data* |
object |
Data of the business object |
active* |
boolean |
active flag |
identification* |
object |
identification of the business object |
erpSupplierProductId* |
string |
technical ID 'erp supplier product ID' Maximum Length: 36 |
erpProductId* |
string |
technical ID 'erp product ID' Maximum Length: 36 |
erpSupplierId* |
string |
technical ID 'erp supplier ID' Maximum Length: 36 |
ownership* |
object |
ownership information concerning the business object |
ownerCompany* |
string |
stock company ID (bestandsfirma) Maximum Length: 30 |
supplierProduct* |
object |
supplier-product |
productNameSupplier |
string |
product name used by the supplier Maximum Length: 35 |
supplierSize |
string |
product - size defined by supplier Maximum Length: 18 |
ean |
array |
list of EAN Minimum number of items 0 |
(Array item) |
object |
Additional Properties: false |
ean* |
integer |
The EAN number Minimum: 0 |
active* |
boolean |
active flag |
eanPriority* |
integer |
priority of the EAN on a printed content list Minimum: 1 |
goodsReceiptAllowed |
boolean |
goods receipt allowed - flag |
testingAccuracy |
string (enum) |
testing accuracy Any of: [
"R",
"N",
"V",
"T",
"I",
"S",
"K"
] |
testingLevel |
integer |
Needed for the 'offline' sample drawing in QA-process (Prüfniveau) (sample calculation according to DIN ISO 2859). Minimum: 0 |
acceptableQualityLimit |
integer |
Needed for the 'offline' sample drawing in QA-process (AQL) (sample calculation according to DIN ISO 2859). Minimum: 0 |
salesUnit |
string (enum) |
sales unit Any of: [
"NOT_DEFINED",
"PIECE",
"PAIR"
] |
supplierType |
integer |
supplier type Minimum: 1 |
returnsHandling |
integer |
returns handling identification Minimum: 0 |
supplierSequence |
integer |
supplier-sequence Minimum: 0 |
approvedPurchasePrice |
integer |
approved purchase price Minimum: 0 |
1.4.2 -
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Supplier-Product Master Data from FINE to WMS |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case = MASTERDATA Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record = SUPPLIER_PRODUCT_UPDATE Constant: SUPPLIER_PRODUCT_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.1.4 |
metaData* |
object |
additional meta information |
sender* |
string (const) |
Sender of the 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 Any of: [
"RELEVANT",
"REMOVED"
] |
data* |
object |
Data of the business object |
creationTime* |
string (date-time) |
Creation timestamp |
updateTime* |
string (date-time) |
Last update timestamp |
deletionTime |
string (date-time) |
Deletion timestamp |
active* |
boolean |
active flag |
identification* |
object |
identification of the business object |
erpSupplierProductId* |
string |
technical ID 'erp supplier product ID' Maximum Length: 36 |
logisticsSupplierProductId* |
string |
technical ID 'logistics supplier-product ID' Maximum Length: 36 |
logisticsProductId* |
string |
technical ID 'logistics product ID' Maximum Length: 36 |
logisticsSupplierId* |
string |
technical ID 'logistics supplier ID' Maximum Length: 36 |
productNumber |
integer |
product number (artikelNummer) Minimum: 0 |
sizeNumeric |
integer |
numerical product size (groesseNumerisch) Minimum: 0 |
supplierId |
integer |
supplier ID (LKZ) Minimum: 0 |
season |
integer |
season (bestandsSaison) Minimum: 100 |
ownership* |
object |
ownership information concerning the business object |
ownerCompany* |
string |
stock company ID (bestandsfirma) Maximum Length: 30 |
supplierProduct* |
object |
supplier-product |
productNameSupplier |
string |
product name used by the supplier Maximum Length: 35 |
supplierSize |
string |
product - size defined by supplier Maximum Length: 18 |
ean |
array |
list of EAN Minimum number of items 0 |
(Array item) |
object |
Additional Properties: false |
logisticsEanId* |
string |
technical ID 'logistics EAN ID' Maximum Length: 36 |
ean* |
integer |
The EAN number Minimum: 0 |
active* |
boolean |
active flag |
deletionTime |
string (date-time) |
Time of deletion (active = false) of the EAN |
eanPriority* |
integer |
priority of the EAN on a printed content list Minimum: 1 |
goodsReceiptAllowed |
boolean |
goods receipt allowed - flag |
testingAccuracy |
string (enum) |
testing accuracy Any of: [
"R",
"N",
"V",
"T",
"I",
"S",
"K"
] |
testingLevel |
integer |
Needed for the 'offline' sample drawing in QA-process (Prüfniveau) (sample calculation according to DIN ISO 2859). Minimum: 0 |
acceptableQualityLimit |
integer |
Needed for the 'offline' sample drawing in QA-process (AQL) (sample calculation according to DIN ISO 2859). Minimum: 0 |
salesUnit |
string (enum) |
sales unit Any of: [
"NOT_DEFINED",
"PIECE",
"PAIR"
] |
supplierType |
integer |
supplier type Minimum: 1 |
returnsHandling |
integer |
returns handling identification Minimum: 0 |
supplierSequence |
integer |
supplier-sequence Minimum: 0 |
approvedPurchasePrice |
integer |
approved purchase price Minimum: 0 |
1.5 -
1.5.1 -
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for response message from LSAS, Version 1 |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (enum) |
The concrete type record. Any of: [
"PRODUCT_RESPONSE",
"SUPPLIER_RESPONSE",
"SUPPLIER_PRODUCT_RESPONSE",
"LOGISTICAL_DATA_RESPONSE"
] |
version* |
string (const) |
The number of version of schema Constant: 1.1 |
metaData* |
object |
additional meta information |
sender* |
string (const) |
Sender of the message Constant: LSAS |
data* |
object |
Data of the business object |
logisticsEntityId |
string |
Technical ID of the referenced entity in LSAS Maximum Length: 36 |
entityId* |
string |
technical ID of the referenced entity within the message Maximum Length: 36 |
status* |
boolean |
Status |
detailedStatus* |
string (enum) |
Detailed information about the outcome of the message received. Any of: [
"INSERTED",
"UPDATED",
"UNCHANGED",
"INSERT_REJECTED",
"UPDATE_REJECTED",
"INTERNAL_ERROR",
"UNAVAILABLE"
] |
errors |
array |
|
(Array item) |
object |
|
code* |
integer |
|
description |
string |
1.6 - M01 Product
1. Business Context
The service is used for the distribution of master data from the retailer to all consumers on the logistics side as well as in the FINE applications (e.g. FLASH, RESY). The retailers send their master data to LSAS. Here the product master is stored and enriched with attributes, e. g. identifiers like logisticsProductId.
Master data is identified differently depending on the merchant and the system. To standardize this, the logisticsProductID is used in FINE. It encapsulates the specifics of the merchants. All FINE apps and all WMS/return systems must identify products with this ID in the interfaces.
For more details to LSAS see also here.
2. Interfaces
2.1. Direction ERP to FINE
LSAS provides an interface to receive product data provided by an ERP-system. This interface is currently provided as REST-interface, reading a list of products.
Version 1.0 has reached end of life and is no longer supported.
Starting from version 2.0, LSAS is additionally providing a kafka-topic, where an ERP-system can send the product data with one dataset per message. All messages are validated and a response is provided on another topic. See: Response. For new systems, the connection with kafka is preferable to a REST-connection. Systems already connected to the REST-interface should consider to migrate to the kafka-solution.
2.1.1. Header
Since version 2.0 the Service Header is used.
2.1.2. Datamodel of upcoming version 2.8.0 ('single'-variant)
A Product with all its associated data. Variant of the schema to send a single dataset.
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Product Master Data from ERP to FINE, 'single'-variant |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record Constant: PRODUCT_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.8.0 |
metaData* |
object |
additional meta information |
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 |
active* |
boolean |
active flag |
identification* |
object |
identification of the business object |
erpProductId* |
string |
technical ID 'erp product ID' Maximum Length: 36 |
erpProductCode |
string |
erpProductCode (erpSchluesselFachlich) Maximum Length: 36 |
ownerCompanyProductCode |
string |
ownerCompanyProductCode (referenzArtikelNummer) Maximum Length: 36 |
itemoptioncommkey |
string |
technical key, provided by ERP Maximum Length: 18 |
ownership* |
object |
ownership information concerning the business object |
ownerCompany* |
string |
stock company ID (bestandsfirma) Maximum Length: 30 |
sourceOwnerCompany |
string |
stock company origin (firmenHerkunft) Maximum Length: 30 |
product* |
object |
product |
productName* |
string |
product description (shortened, optimized for logistics use-cases) Maximum Length: 18 |
productNumber* |
integer |
product number (artikelNummer) Minimum: 0 |
size* |
string |
alphanumerical product size (groesseLogistisch) Maximum Length: 10 |
sizeNumeric |
integer |
numerical product size (groesseNumerisch) Minimum: 0 |
orderSize |
string |
additional - freely defined - alphanumerical product size Maximum Length: 18 |
eans |
array |
list of alternative EANs Minimum number of items 0 |
(Array item) |
object |
Additional Properties: false |
ean* |
integer |
The EAN number Minimum: 0 |
active* |
boolean |
active flag |
eanPriority* |
integer |
priority of the EAN on a printed content list Minimum: 1 |
season |
integer |
season (bestandsSaison) Minimum: 0 |
color |
string |
simplified color (farbe) description Maximum Length: 12 |
style |
string |
style information (style) Maximum Length: 14 |
imageUrls |
array |
array of image URLs |
(Array item) |
string |
image URL Maximum Length: 256 |
standardPrice |
integer |
selling price in cents (verkaufsPreis) Minimum: 0 |
salesBrand |
string |
salesbrand (markenName) Maximum Length: 35 |
partsQuantity |
integer |
number of parts (anzahlTeile) Minimum: 0 |
measuringUnit* |
string (enum) |
measuring unit (mengeneinheit) Any of: [
"PIECE",
"LENGTH_VARIABLE",
"LENGTH_AND_WIDTH_VARIABLE"
] |
logisticsType* |
string (enum) |
logistics type (Lagerbestandstyp) Any of: [
"PARCEL",
"BULKY",
"UNKNOWN"
] |
handlingType |
string (enum) |
type of handling (handlingId) Any of: [
"ONE_MAN_HANDLING",
"TWO_MAN_HANDLING",
"PARCEL",
"HANGING_CONFECTION"
] |
productGroup |
integer |
product group (marktId) Minimum: 0 |
assortmentClassification |
array |
use case based assortment classification |
(Array item) |
object |
|
process* |
string (enum) |
process Any of: [
"RETURNS_EVALUATION",
"RETURNS_BILLING"
] |
assortment* |
integer |
assortment ID Minimum: 0 |
organic |
object |
organic characteristics of the product |
hasOrganicCertification* |
boolean |
organic identification |
certificationType |
string (enum) |
type of organic certification Any of: [
"GOTS"
] |
batchHandling |
boolean |
Batch Handling for this product required |
shippingFromSupplier |
boolean |
shipping from supplier (VAL-Artikel) |
deliveryScope |
array |
array of components of the delivery scope |
(Array item) |
string |
component Maximum Length: 256 |
additionalNote |
string |
additional note (free text) Maximum Length: 1024 |
partnerInformation |
object |
partner |
erpPartnerId* |
string |
ERP ID of partner. Maximum Length: 36 |
erpPartnerName* |
string |
Name of partner. Maximum Length: 36 |
dangerousGoodsIdentification |
object |
dangerous goods characteristics of the product |
dangerous |
boolean |
dangerous goods identification |
dangerousGoodsType |
string (enum) |
dangerous goods type Any of: [
"G01",
"G02",
"G03",
"G04",
"G05",
"G06",
"G07",
"G08",
"G09",
"G10",
"G11",
"G12",
"G13",
"G14"
] |
physicalState |
string |
physical state Maximum Length: 50 |
accumulatorCapacity |
string |
accumulator capacity Maximum Length: 20 |
numberOfAccumulators |
string |
number of accumulators Maximum Length: 20 |
numberOfBatteries |
string |
number of batteries Maximum Length: 20 |
batteryOrAccumulatorTechnology |
string |
battery or accumulator technology Maximum Length: 1024 |
transportCategoryDangerousGoods |
string |
transport category dangerous goods Maximum Length: 1 |
clpHazardPictogram |
array |
hazard pictogram array |
(Array item) |
string |
hazard pictogram Maximum Length: 1024 |
clpProductLabel |
string |
product label Maximum Length: 1024 |
clpSafetyDataSheet |
string |
safety data sheet Maximum Length: 1024 |
dangerWarnings |
array |
danger warnings array |
(Array item) |
string |
danger warning Maximum Length: 1024 |
weightBatteriesOrAccumulator |
string |
weight of batteries or accumulator Maximum Length: 20 |
content |
string |
content Maximum Length: 4096 |
storageCategoryHazardousMaterial |
string |
storage category hazardous material Maximum Length: 20 |
accumulatorPower |
string |
accumulator power Maximum Length: 20 |
deliveryConditionBatteriesOrAccumulators |
string |
delivery condition of batteries or accumulators Maximum Length: 1024 |
limitedQuantityOfDangerousGoods |
string |
limited quantity of dangerous goods Maximum Length: 1024 |
testSummaryLithiumBatteries |
string |
test summary of lithium batteries Maximum Length: 1024 |
qualityAssuranceProgramLithiumBatteries |
string |
quality assurance program lithium batteries Maximum Length: 1024 |
relevanceClpObligation |
string |
relevance of CLP obligation Maximum Length: 1024 |
relevanceClpDangerousGoods |
string |
relevance of CLP Maximum Length: 1024 |
safetyInstructions |
array |
safety instructions array |
(Array item) |
string |
safety instruction Maximum Length: 1024 |
signalWord |
string |
signal word Maximum Length: 50 |
specialProvisionDangerousGoods |
string |
special provision of dangerous goods Maximum Length: 1024 |
accumulatorVoltage |
string |
accumulator voltage Maximum Length: 50 |
languagesClpSafetyDataSheet |
string |
languages clp safety data sheet Maximum Length: 50 |
unNumber |
string |
UN number Maximum Length: 1024 |
unStandardTestLithiumBatteries |
string |
UN standard test lithium batteries Maximum Length: 1024 |
packingGroupsDangerousGoods |
string |
packing groups dangerous goods Maximum Length: 50 |
netQuantityWeight |
string |
net quantity weight Maximum Length: 20 |
netQuantityPiece |
string |
net quantity piece Maximum Length: 20 |
netQuantityVolume |
string |
net quantity volume Maximum Length: 20 |
ottoSpecificProcessing |
object |
process-relevant information concerning the business object, specific attributes for Otto and Bonprix products |
priorityInbound |
boolean |
priority for inbound processes (chefKz) |
priorityDelivery |
integer |
priority for delivery (deliveryFlag, NAB_Kz) Minimum: 0 |
specialPackaging |
integer |
product packing information (sonderverpackung, tuetenKz) Minimum: 0 |
warehouseAreaType* |
integer (enum) |
warehouse area type (WBKZ) 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) Minimum: 0 |
oneStopShopping |
boolean |
one stop shopping code (AbwicklungsartOss) |
supplierId |
integer |
supplier ID (LKZ) Minimum: 0 |
disposal |
integer (enum) |
disposal (verwendung) 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) Minimum number of items 0 |
(Array item) |
string |
enclosure ID Maximum Length: 4 |
groupCodeComposed |
integer |
product group detail code (warengruppeGesamt) Minimum: 0 |
groupCodeBuying* |
integer |
buying group code (warengruppeFuehrungsTeam) Minimum: 0 |
groupCodeMerchandise* |
integer |
merchandise group code (warengruppeOperativesTeam) Minimum: 0 |
reconditionCode |
integer |
recondition code (wiederaufbereitung) Minimum: 0 |
individualization |
integer |
individualization (individualisierung) Minimum: 0 |
expeditionCode |
integer |
encoding for process-handling of bulkyItems (versandschluessel) Minimum: 0 |
checkRoomCode |
integer |
check room code (pruefraumId) Minimum: 0 |
ownershipId |
integer (enum) |
ownership of the product (verfuegbarkeitsId) Any of: [
0,
1,
3,
9
] |
location |
integer (enum) |
master warehouse ID (stammlager) 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) Minimum: 0 |
packingUnits* |
array |
packing units array (packstuecke) Minimum number of items 1 |
(Array item) |
object |
|
identification* |
object |
identification of the packing unit |
erpPackingUnitId* |
string |
ERP packing unit ID Maximum Length: 36 |
packingUnitIndex |
integer |
Index of the packing unit (packstueckNr) Minimum: 1 |
packingUnitDescription |
string |
ERP packing unit description Maximum Length: 1024 |
geometry |
object |
geometric data of the packing unit |
length |
integer |
length Minimum: 0 |
width |
integer |
width Minimum: 0 |
height |
integer |
height Minimum: 0 |
weight |
integer |
weight Minimum: 0 |
volume |
integer |
volume Minimum: 0 |
2.1.3. Schema
Version | Status | Changes |
---|---|---|
upcoming version |
1. extend |
|
current version |
1. switch from global enum references to strings |
|
previous version |
1. new field |
|
previous version |
1. new fields |
|
previous version |
1. for company enums: switch from global enum references to strings |
|
previous version |
1. |
|
previous version |
1. Added |
|
previous version |
1. accept ownershipId = 9 when clientSystem = Resy |
|
previous version |
1. update |
|
previous version |
1. switch from pattern to constant for field |
|
previous version |
1. New attributes for F2X - connection ( |
|
deprecated version |
initial version (released on 03.05.2022) |
2.2. Direction FINE to WMS
Version 1.0 has reached end of life and is no longer supported.
2.2.1. Header
Since version 2.0 the Service Header is used.
2.2.2. Datamodel of upcoming version 2.8.0
A Product with all its associated data.
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Product Master Data from FINE to WMS |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record = PRODUCT_UPDATE Constant: PRODUCT_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.8.0 |
metaData* |
object |
additional meta information |
sender* |
string (const) |
Sender of the 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 Any of: [
"RELEVANT",
"REMOVED"
] |
data* |
object |
Data of the business object |
creationTime* |
string (date-time) |
Creation timestamp |
updateTime* |
string (date-time) |
Last update timestamp |
deletionTime |
string (date-time) |
Deletion timestamp |
active* |
boolean |
active flag |
identification* |
object |
identification of the business object |
logisticsProductId* |
string |
technical ID 'logistics product ID' Maximum Length: 36 |
erpProductId* |
string |
technical ID 'erp product ID' Maximum Length: 36 |
erp* |
string |
ERP identifier Maximum Length: 30 |
erpProductCode |
string |
erpProductCode (erpSchluesselFachlich) Maximum Length: 36 |
ownerCompanyProductCode |
string |
ownerCompanyProductCode (referenzArtikelNummer) Maximum Length: 36 |
itemoptioncommkey |
string |
technical key, provided by ERP Maximum Length: 18 |
ownership* |
object |
ownership information concerning the business object |
ownerCompany* |
string |
stock company ID (bestandsfirma) Maximum Length: 30 |
sourceOwnerCompany |
string |
stock company origin (firmenHerkunft) Maximum Length: 30 |
product* |
object |
product |
productName* |
string |
product description (shortened, optimized for logistics use-cases) Maximum Length: 18 |
productNumber* |
integer |
product number (artikelNummer) Minimum: 0 |
size* |
string |
alphanumerical product size (groesseLogistisch) Maximum Length: 10 |
sizeNumeric |
integer |
numerical product size (groesseNumerisch) Minimum: 0 |
orderSize |
string |
additional - freely defined - alphanumerical product size Maximum Length: 18 |
eans |
array |
list of EANs associated with this product Minimum number of items 0 |
(Array item) |
object |
Additional Properties: false |
ean* |
integer |
The EAN number Minimum: 0 |
active* |
boolean |
active flag |
eanPriority* |
integer |
priority of the EAN on a printed content list Minimum: 1 |
deletionTime |
string (date-time) |
Deletion timestamp |
season |
integer |
season (bestandsSaison) Minimum: 0 |
color |
string |
simplified color (farbe) description Maximum Length: 12 |
style |
string |
style information (style) Maximum Length: 14 |
imageUrls |
array |
array of image URLs |
(Array item) |
string |
image URL Maximum Length: 256 |
standardPrice |
integer |
selling price in cents (verkaufsPreis) Minimum: 0 |
salesBrand |
string |
salesbrand (markenName) Maximum Length: 35 |
partsQuantity |
integer |
number of parts (anzahlTeile) Minimum: 0 |
measuringUnit* |
string (enum) |
measuring unit (mengeneinheit) Any of: [
"PIECE",
"LENGTH_VARIABLE",
"LENGTH_AND_WIDTH_VARIABLE"
] |
handlingType |
string (enum) |
type of handling (handlingId) Any of: [
"ONE_MAN_HANDLING",
"TWO_MAN_HANDLING",
"PARCEL",
"HANGING_CONFECTION"
] |
productGroup |
integer |
product group (marktId) Minimum: 0 |
assortmentClassification |
array |
use case based assortment classification |
(Array item) |
object |
|
process* |
string (enum) |
process Any of: [
"RETURNS_EVALUATION",
"RETURNS_BILLING"
] |
assortment* |
integer |
assortment ID Minimum: 0 |
organic |
object |
organic characteristics of the product |
hasOrganicCertification* |
boolean |
organic identification |
certificationType |
string (enum) |
type of organic certification Any of: [
"GOTS"
] |
batchHandling |
boolean |
Batch Handling for this product required |
shippingFromSupplier |
boolean |
shipping from supplier (VAL-Artikel) |
deliveryScope |
array |
array of components of the delivery scope |
(Array item) |
string |
component Maximum Length: 256 |
additionalNote |
string |
additional note (free text) Maximum Length: 1024 |
partnerInformation |
object |
partner |
erpPartnerId* |
string |
ERP ID of partner. Maximum Length: 36 |
erpPartnerName* |
string |
Name of partner. Maximum Length: 36 |
dangerousGoodsIdentification |
object |
dangerous goods characteristics of the product |
dangerous |
boolean |
dangerous goods identification |
dangerousGoodsType |
string (enum) |
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 Maximum Length: 2 |
exemptionNotice |
string |
dangerous goods exemption notice Maximum Length: 15 |
dangerousGoodsShare |
integer |
dangerous goods share Minimum: 0 |
physicalState |
string |
physical state Maximum Length: 50 |
accumulatorCapacity |
string |
accumulator capacity Maximum Length: 20 |
numberOfAccumulators |
string |
number of accumulators Maximum Length: 20 |
numberOfBatteries |
string |
number of batteries Maximum Length: 20 |
batteryOrAccumulatorTechnology |
string |
battery or accumulator technology Maximum Length: 1024 |
transportCategoryDangerousGoods |
string |
transport category dangerous goods Maximum Length: 1 |
clpHazardPictogram |
array |
hazard pictogram array |
(Array item) |
string |
hazard pictogram Maximum Length: 1024 |
clpProductLabel |
string |
product label Maximum Length: 1024 |
clpSafetyDataSheet |
string |
safety data sheet Maximum Length: 1024 |
dangerWarnings |
array |
danger warnings array |
(Array item) |
string |
danger warning Maximum Length: 1024 |
weightBatteriesOrAccumulator |
string |
weight of batteries or accumulator Maximum Length: 20 |
content |
string |
content Maximum Length: 4096 |
storageCategoryHazardousMaterial |
string |
storage category hazardous material Maximum Length: 20 |
accumulatorPower |
string |
accumulator power Maximum Length: 20 |
deliveryConditionBatteriesOrAccumulators |
string |
delivery condition of batteries or accumulators Maximum Length: 1024 |
limitedQuantityOfDangerousGoods |
string |
limited quantity of dangerous goods Maximum Length: 1024 |
testSummaryLithiumBatteries |
string |
test summary of lithium batteries Maximum Length: 1024 |
qualityAssuranceProgramLithiumBatteries |
string |
quality assurance program lithium batteries Maximum Length: 1024 |
relevanceClpObligation |
string |
relevance of CLP obligation Maximum Length: 1024 |
relevanceClpDangerousGoods |
string |
relevance of CLP Maximum Length: 1024 |
safetyInstructions |
array |
safety instructions array |
(Array item) |
string |
safety instruction Maximum Length: 1024 |
signalWord |
string |
signal word Maximum Length: 50 |
specialProvisionDangerousGoods |
string |
special provision of dangerous goods Maximum Length: 1024 |
accumulatorVoltage |
string |
accumulator voltage Maximum Length: 50 |
languagesClpSafetyDataSheet |
string |
languages clp safety data sheet Maximum Length: 50 |
unNumber |
string |
UN number Maximum Length: 4 |
unStandardTestLithiumBatteries |
string |
UN standard test lithium batteries Maximum Length: 1024 |
packingGroupsDangerousGoods |
string |
packing groups dangerous goods Maximum Length: 50 |
netQuantityWeight |
string |
net quantity weight Maximum Length: 20 |
netQuantityPiece |
string |
net quantity piece Maximum Length: 20 |
netQuantityVolume |
string |
net quantity volume Maximum Length: 20 |
ottoSpecificProcessing |
object |
process-relevant information concerning the business object, specific attributes for Otto and Bonprix products |
priorityInbound |
boolean |
priority for inbound processes (chefKz) |
priorityDelivery |
integer |
priority for delivery (deliveryFlag, NAB_Kz) Minimum: 0 |
specialPackaging |
integer |
product packing information (sonderverpackung, tuetenKz) Minimum: 0 |
warehouseAreaType* |
integer (enum) |
warehouse area type (WBKZ) 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) Minimum: 0 |
oneStopShopping |
boolean |
one stop shopping code (AbwicklungsartOss) |
supplierId |
integer |
supplier ID (LKZ) Minimum: 0 |
disposal |
integer (enum) |
disposal (verwendung) 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) Minimum number of items 0 |
(Array item) |
string |
enclosure ID Maximum Length: 4 |
groupCodeComposed |
integer |
product group detail code (warengruppeGesamt) Minimum: 0 |
groupCodeBuying* |
integer |
buying group code (warengruppeFuehrungsTeam) Minimum: 0 |
groupCodeMerchandise* |
integer |
merchandise group code (warengruppeOperativesTeam) Minimum: 0 |
reconditionCode |
integer |
recondition code (wiederaufbereitung) Minimum: 0 |
individualization |
integer |
individualization (individualisierung) Minimum: 0 |
expeditionCode |
integer |
encoding for process-handling of bulkyItems (versandschluessel) Minimum: 0 |
checkRoomCode |
integer |
check room code (pruefraumId) Minimum: 0 |
ownershipId |
integer (enum) |
ownership of the product (verfuegbarkeitsId) Any of: [
0,
1,
3,
9
] |
location |
integer (enum) |
master warehouse ID (stammlager) 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) Minimum: 0 |
packingUnits* |
array |
packing units array (packstuecke) Minimum number of items 1 |
(Array item) |
object |
|
metaData |
object |
meta data for packing units |
measured |
boolean |
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. |
identification* |
object |
identification of the packing unit |
logisticsPackingUnitId* |
string |
logistics packing unit ID Maximum Length: 36 |
erpPackingUnitId |
string |
ERP packing unit ID Maximum Length: 36 |
packingUnitIndex |
integer |
Index of the packing unit (packstueckNr) Minimum: 1 |
packingUnitDescription |
string |
ERP packing unit description Maximum Length: 1024 |
geometry |
object |
geometric data of the packing unit |
length |
integer |
length Minimum: 0 |
width |
integer |
width Minimum: 0 |
height |
integer |
height Minimum: 0 |
weight |
integer |
weight Minimum: 0 |
volume |
integer |
volume Minimum: 0 |
loadingUnitTypePicking |
string (enum) |
loading unit type for picking Any of: [
"TROLLY_AUTO_SORTING",
"TROLLY_NO_AUTO_SORTING",
"PALLET"
] |
autoSorting |
boolean |
auto-sortable flag |
autoSortingTypes |
array |
auto-sorting-types listing |
(Array item) |
object |
|
type* |
string (enum) |
auto-sorter-type identification Any of: [
"BEUMER_BIG_POCKET_MANUAL",
"BEUMER_BIG_POCKET_AUTO",
"SPLIT_TILT_TRAYSORTER"
] |
capable* |
boolean |
Capable - flag concerning the auto-sorter type |
warehousePackingForShipping |
boolean |
deprecated: replaced/removed by shippingInOriginalPackaging with next schema change |
shippingInOriginalPackaging |
boolean |
need of additional warehouse packaging |
polyBagPacking |
boolean |
poly-bag-packing capability |
polyBagAutoPacking |
boolean |
poly-bag-autopacking capability |
polyBagAutoPackingTypes |
array |
poly-bag auto-packing types listing |
(Array item) |
object |
|
type* |
string (enum) |
poly-bag auto-packing type identification Any of: [
"BECK",
"HUGO_BECK",
"BVM"
] |
capable* |
boolean |
Capable - flag concerning the poly-bag auto-packing type |
temptsTheft |
boolean |
theft-prone flag |
2.2.3. Schema
Version | Status | Changes |
---|---|---|
upcoming version |
1. extend |
|
current version |
1. new field |
|
previous version |
1. new field |
|
previous version |
1. new fields |
|
previous version |
1. for company enums: switch from global enum references to strings |
|
previous version |
1. accept ownershipId = 9 when clientSystem = Resy |
|
previous version |
1. update |
|
previous version |
1. switch from pattern to constant for field |
|
previous version |
1. New attributes for F2X - connection ( |
|
deprecated version |
1. Added ERP ID 5 (F2X), removed ERP ID 1 (Internal). |
|
deprecated version |
initial version |
3. Kafka Topics
Unresolved directive in <stdin> - include::../../../../integration-layer/topics/interfaces/M01.adoc[]
1.7 - M02 Logistical Data
1. Business Context
The service is used for the distribution of geometrical data updates for products, respectively the packing units of products, from the WMS on logistics side to all retailers. The WMS send their geometrical data updates to LSAS. LSAS then distributes the update to all relevant retailer-systems and - within updates on products - also again to other WMS.
The logisticsPackingUnitId is used in LSAS to identify the packing units of products, which needs to be updated. All WMS must identify products with this ID in the interfaces to LSAS.
For more details to LSAS see also here.
2. Interface
Starting from version 2.0, LSAS is providing a kafka-topic, where an WMS can send the products logistical data with one dataset per message. All messages are validated and a response is provided on another topic. See: Response.
2.1. Direction WMS to FINE
2.1.1. Header
Since version 2.0 the Service Header is used.
2.1.2. Datamodel of upcoming version 2.2.0
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for logistical product data from the WAREHOUSE to FINE |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record Constant: LOGISTICAL_DATA_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.2.0 |
metaData* |
object |
additional meta information |
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. Maximum Length: 36 |
data* |
object |
Data of the business object |
identification* |
object |
identification of the business object |
logisticsProductId* |
string |
technical ID 'logistics product ID' Maximum Length: 36 |
logisticsPackingUnitId |
string |
logistics packing unit ID Maximum Length: 36 |
packingUnit* |
object |
packing unit (packstueck) |
geometry* |
object |
geometric data of the packing unit |
length* |
integer |
length Minimum: 0 |
width* |
integer |
width Minimum: 0 |
height* |
integer |
height Minimum: 0 |
weight* |
integer |
weight Minimum: 0 |
volume* |
integer |
volume Minimum: 0 |
specialPackaging |
integer |
product packing information (sonderverpackung, tuetenKz) Minimum: 0 |
warehouseAreaType |
integer (enum) |
warehouse area type (wbkz) 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 Any of: [
"TROLLY_AUTO_SORTING",
"TROLLY_NO_AUTO_SORTING",
"PALLET"
] |
autoSorting |
boolean |
auto-sortable flag |
autoSortingTypes |
array |
auto-sorting-types listing |
(Array item) |
object |
|
type* |
string (enum) |
auto-sorter-type identification Any of: [
"BEUMER_BIG_POCKET_MANUAL",
"BEUMER_BIG_POCKET_AUTO",
"SPLIT_TILT_TRAYSORTER"
] |
capable* |
boolean |
Capable - flag concerning the auto-sorter type |
warehousePackingForShipping |
boolean |
deprecated: replaced/removed by shippingInOriginalPackaging with next schema change |
shippingInOriginalPackaging |
boolean |
need of additional warehouse packaging |
polyBagPacking |
boolean |
poly-bag-packing capability |
polyBagAutoPacking |
boolean |
poly-bag-autopacking capability |
polyBagAutoPackingTypes |
array |
poly-bag auto-packing types listing |
(Array item) |
object |
|
type* |
string (enum) |
poly-bag auto-packing type identification Any of: [
"BECK",
"HUGO_BECK",
"BVM"
] |
capable* |
boolean |
Capable - flag concerning the poly-bag auto-packing type |
temptsTheft |
boolean |
theft-prone flag |
2.1.3. Schema
Version | Status | Changes |
---|---|---|
upcoming version |
1. introduce |
|
current version |
1. switch from enum to string for field |
|
previous version |
1. switch from pattern to constant for field |
|
previous version |
version 2 in English, containing header, all attributes from NEON WEN2 |
2.2. Direction FINE to ERP
2.2.1. Header
Since version 2.0 the Service Header is used.
2.2.2. Datamodel of upcoming version 2.2.0
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Logistical Product Data (packing unit) from FINE to the ERP or WAREHOUSE |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context* |
string (const) |
The context / business case = MASTERDATA Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record Constant: LOGISTICAL_DATA_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.2.0 |
metaData* |
object |
additional meta information |
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). Maximum Length: 36 |
data* |
object |
Data of the business object |
identification* |
object |
identification of the business object |
erpProductId* |
string |
technical ID 'erp product ID' Maximum Length: 36 |
erpPackingUnitId* |
string |
erp packing unit ID Maximum Length: 36 |
dangerousGoodsIdentification |
object |
dangerous goods characteristics of the product |
dangerousGoodsStorageArea |
string |
dangerous goods storage area Maximum Length: 2 |
ottoSpecificProcessing |
object |
process-relevant information concerning the business object, specific attributes for Otto and Bonprix products |
specialPackaging |
integer |
product packing information (sonderverpackung, tuetenKz) Minimum: 0 |
warehouseAreaType |
integer (enum) |
warehouse area type (wbkz) Any of: [
0,
1,
2,
3,
4,
6,
7,
8,
9,
11,
12,
13,
14,
15,
16,
17,
18
] |
packingUnit |
object |
packing unit (packstueck) |
geometry |
object |
geometric data of the packing unit |
length |
integer |
length Minimum: 0 |
width |
integer |
width Minimum: 0 |
height |
integer |
height Minimum: 0 |
weight |
integer |
weight Minimum: 0 |
volume |
integer |
volume Minimum: 0 |
autoSorting |
boolean |
auto-sortable flag |
autoSortingTypes |
array |
auto-sorting-types listing |
(Array item) |
object |
|
type* |
string (enum) |
auto-sorter-type identification Any of: [
"BEUMER_BIG_POCKET_MANUAL",
"BEUMER_BIG_POCKET_AUTO",
"SPLIT_TILT_TRAYSORTER"
] |
capable* |
boolean |
Capable - flag concerning the auto-sorter type |
temptsTheft |
boolean |
theft-prone flag |
2.2.3. Schema
Version | Status | Changes |
---|---|---|
upcoming version |
1. introduce |
|
current version |
1. switch from enum to string for field |
|
previous version |
1. include |
|
previous version |
version 2 in English, containing header, all attributes from NEON WEN2 |
1.8 - M03 Supplier
1. Business Context
The service is used for the distribution of master data from the retailer to all consumers on the logistics side as well as in the FINE applications (e.g. FLASH, RESY). The retailers send their master data to LSAS. Here the supplier master is stored and enriched with attributes, mainly identifiers like logisticsSupplierId.
Master data is identified differently depending on the merchant and the system. To standardize this, the logisticsSupplierId is used in FINE. It encapsulates the specifics of the merchants. All FINE apps and all WMS/return systems must identify products with this ID in the interfaces.
For more details to LSAS see also here.
2. Interfaces
2.1. Direction ERP to FINE
LSAS provides an interface to receive supplier data provided by an ERP-system. This interface is currently provided as REST-interface, reading a list of suppliers.
Starting from version 2.0, LSAS will also provide a kafka-topic, where an ERP-system can send the supplier data with one dataset per message. All messages are validated and a response is provided on another topic. See: Response.
2.1.1. Header
Since version 2.0, this interface uses the Service Header.
2.1.2. Datamodel upcoming version 2.2.0 ('single'-variant)
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Supplier Master Data from ERP to FINE, 'single'-variant |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record Constant: SUPPLIER_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.2.0 |
metaData* |
object |
additional meta information |
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 |
active* |
boolean |
active flag |
identification* |
object |
identification of the business object |
erpSupplierId* |
string |
technical ID 'erp supplier ID' Maximum Length: 36 |
supplierId |
integer |
supplier ID (LKZ) Minimum: 0 |
ownership* |
object |
ownership information concerning the business object |
ownerCompany* |
string |
stock owner company (bestandsfirma) Maximum Length: 30 |
supplier* |
object |
supplier |
supplierName* |
string |
name of the supplier Maximum Length: 35 |
creditorNumber |
integer |
number of the creditor Minimum: 0 |
address |
object |
suppliers address |
addressName |
string |
name of the supplier (address header) Maximum Length: 100 |
addressStreet |
string |
address street Maximum Length: 100 |
addressZip |
string |
address ZIP Code Maximum Length: 10 |
addressCity |
string |
address city Maximum Length: 100 |
addressCountryCode |
string |
address country code Maximum Length: 2 |
2.1.3. Schema
Version | Status | Changes |
---|---|---|
upcoming version |
1. remove deprecated attributes |
|
current version |
1. changed |
|
previous version |
1. changed company fields from enum to string |
|
previous version |
1. update |
|
previous version |
1. switch from pattern to constant for field |
|
previous version |
new v4 global enum references, |
|
deprecated version |
initial version |
2.2. Direction FINE to WMS
2.2.1. Header
Since version 2.0, this interface uses the Service Header.
2.2.2. Datamodel of upcoming version 2.2.0
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Supplier Master Data from FINE to the WMS |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record Constant: SUPPLIER_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.2.0 |
metaData* |
object |
additional meta information |
sender* |
string (const) |
Sender of the 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 Any of: [
"RELEVANT",
"REMOVED"
] |
data* |
object |
Data of the business object |
creationTime* |
string (date-time) |
Creation timestamp |
updateTime* |
string (date-time) |
Last update timestamp |
deletionTime |
string (date-time) |
Deletion timestamp |
active* |
boolean |
active flag |
identification* |
object |
identification of the business object |
erpSupplierId* |
string |
technical ID 'erp supplier ID' Maximum Length: 36 |
logisticsSupplierId |
string |
technical ID 'logistics supplier ID' Maximum Length: 36 |
supplierId |
integer |
supplier ID (LKZ) Minimum: 0 |
ownership* |
object |
ownership information concerning the business object |
ownerCompany* |
string |
stock owner company (bestandsfirma) Maximum Length: 30 |
supplier* |
object |
supplier |
supplierName* |
string |
name of the supplier Maximum Length: 35 |
creditorNumber |
integer |
number of the creditor Minimum: 0 |
address |
object |
suppliers address |
addressName |
string |
name of the supplier (address header) Maximum Length: 100 |
addressStreet |
string |
address street Maximum Length: 100 |
addressZip |
string |
address ZIP Code Maximum Length: 10 |
addressCity |
string |
address city Maximum Length: 100 |
addressCountryCode |
string |
address country code Maximum Length: 2 |
2.2.3. Schema
Version | Status | Changes |
---|---|---|
upcoming version |
1. remove deprecated attributes |
|
current version |
1. changed |
|
previous version |
1. changed company fields from enum to string |
|
previous version |
1. update |
|
previous version |
1. switch from pattern to constant for field |
|
previous version |
new v4 global enum references, |
|
deprecated version |
added ERP ID 5 (F2X), removed ERP ID 1 (Internal). |
|
deprecated version |
initial version |
3. Kafka Topics
Unresolved directive in <stdin> - include::../../../../integration-layer/topics/interfaces/M03.adoc[]
1.9 - M04 Supplier Product
1. Business Context
The service is used for the distribution of master data from the merchants to all consumers on the logistics side as well as in the FINE Layer (e.g. FLASH, RESY).
The merchants ERP system send their master data to LSAS. Here the supplier-product master, as representation of supplier-specific product data is stored and enriched with attributes, mainly the technical identifiers for the logistics logisticsSupplierProductId is added.
Master data is identified differently depending on the merchant and the system. To standardize this, the logisticsSupplierProductId is used in FINE. It encapsulates the specifics of the merchants and provides a unique technical identifier for all logistic systems over all connected merchants. All FINE apps and all WMS/return systems must identify the entity with this ID in the interfaces.
For more details to LSAS see also here.
2. Interfaces
2.1. Direction ERP to FINE
LSAS provides an interface to receive supplier-product data provided by an ERP-system.
There is a REST-interface, where a list of multiple datasets can be sent to LSAS.
Version 1.0 has reached end of life and is no longer supported.
Starting from version 2.0, LSAS is also providing a kafka-topic, where an ERP-system can send the data with one dataset per message. All messages are validated and a response is provided on another topic. See: Response.
2.1.1. Header
Since version 2.0 the Service Header is used.
2.1.2. Datamodel of upcoming version 2.1.4 ('single'-variant)
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Supplier-Product Master Data from ERP to FINE, 'single'-variant |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record Constant: SUPPLIER_PRODUCT_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.1.4 |
metaData* |
object |
additional meta information |
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 |
data* |
object |
Data of the business object |
active* |
boolean |
active flag |
identification* |
object |
identification of the business object |
erpSupplierProductId* |
string |
technical ID 'erp supplier product ID' Maximum Length: 36 |
erpProductId* |
string |
technical ID 'erp product ID' Maximum Length: 36 |
erpSupplierId* |
string |
technical ID 'erp supplier ID' Maximum Length: 36 |
ownership* |
object |
ownership information concerning the business object |
ownerCompany* |
string |
stock company ID (bestandsfirma) Maximum Length: 30 |
supplierProduct* |
object |
supplier-product |
productNameSupplier |
string |
product name used by the supplier Maximum Length: 35 |
supplierSize |
string |
product - size defined by supplier Maximum Length: 18 |
ean |
array |
list of EAN Minimum number of items 0 |
(Array item) |
object |
Additional Properties: false |
ean* |
integer |
The EAN number Minimum: 0 |
active* |
boolean |
active flag |
eanPriority* |
integer |
priority of the EAN on a printed content list Minimum: 1 |
goodsReceiptAllowed |
boolean |
goods receipt allowed - flag |
testingAccuracy |
string (enum) |
testing accuracy Any of: [
"R",
"N",
"V",
"T",
"I",
"S",
"K"
] |
testingLevel |
integer |
Needed for the 'offline' sample drawing in QA-process (Prüfniveau) (sample calculation according to DIN ISO 2859). Minimum: 0 |
acceptableQualityLimit |
integer |
Needed for the 'offline' sample drawing in QA-process (AQL) (sample calculation according to DIN ISO 2859). Minimum: 0 |
salesUnit |
string (enum) |
sales unit Any of: [
"NOT_DEFINED",
"PIECE",
"PAIR"
] |
supplierType |
integer |
supplier type Minimum: 1 |
returnsHandling |
integer |
returns handling identification Minimum: 0 |
supplierSequence |
integer |
supplier-sequence Minimum: 0 |
approvedPurchasePrice |
integer |
approved purchase price Minimum: 0 |
2.1.3. Schema
Version | Status | Changes |
---|---|---|
upcoming version |
1. changed |
|
current version |
1. changed company fields from enum to string |
|
previous version |
1. update |
|
previous version |
1. switch from pattern to constant for field |
|
previous version |
1. switch to English interface |
|
deprecated version |
initial version |
2.2. Direction FINE to WMS
Version 1.0 has reached end of life and is no longer supported.
2.2.1. Header
Since version 2.0 the Service Header is used.
2.2.2. Datamodel of upcoming Version 2.1.4
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for Supplier-Product Master Data from FINE to WMS |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case = MASTERDATA Constant: MASTERDATA |
eventType* |
string (const) |
The concrete type record = SUPPLIER_PRODUCT_UPDATE Constant: SUPPLIER_PRODUCT_UPDATE |
version* |
string (const) |
The number of version of schema Constant: 2.1.4 |
metaData* |
object |
additional meta information |
sender* |
string (const) |
Sender of the 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 Any of: [
"RELEVANT",
"REMOVED"
] |
data* |
object |
Data of the business object |
creationTime* |
string (date-time) |
Creation timestamp |
updateTime* |
string (date-time) |
Last update timestamp |
deletionTime |
string (date-time) |
Deletion timestamp |
active* |
boolean |
active flag |
identification* |
object |
identification of the business object |
erpSupplierProductId* |
string |
technical ID 'erp supplier product ID' Maximum Length: 36 |
logisticsSupplierProductId* |
string |
technical ID 'logistics supplier-product ID' Maximum Length: 36 |
logisticsProductId* |
string |
technical ID 'logistics product ID' Maximum Length: 36 |
logisticsSupplierId* |
string |
technical ID 'logistics supplier ID' Maximum Length: 36 |
productNumber |
integer |
product number (artikelNummer) Minimum: 0 |
sizeNumeric |
integer |
numerical product size (groesseNumerisch) Minimum: 0 |
supplierId |
integer |
supplier ID (LKZ) Minimum: 0 |
season |
integer |
season (bestandsSaison) Minimum: 100 |
ownership* |
object |
ownership information concerning the business object |
ownerCompany* |
string |
stock company ID (bestandsfirma) Maximum Length: 30 |
supplierProduct* |
object |
supplier-product |
productNameSupplier |
string |
product name used by the supplier Maximum Length: 35 |
supplierSize |
string |
product - size defined by supplier Maximum Length: 18 |
ean |
array |
list of EAN Minimum number of items 0 |
(Array item) |
object |
Additional Properties: false |
logisticsEanId* |
string |
technical ID 'logistics EAN ID' Maximum Length: 36 |
ean* |
integer |
The EAN number Minimum: 0 |
active* |
boolean |
active flag |
deletionTime |
string (date-time) |
Time of deletion (active = false) of the EAN |
eanPriority* |
integer |
priority of the EAN on a printed content list Minimum: 1 |
goodsReceiptAllowed |
boolean |
goods receipt allowed - flag |
testingAccuracy |
string (enum) |
testing accuracy Any of: [
"R",
"N",
"V",
"T",
"I",
"S",
"K"
] |
testingLevel |
integer |
Needed for the 'offline' sample drawing in QA-process (Prüfniveau) (sample calculation according to DIN ISO 2859). Minimum: 0 |
acceptableQualityLimit |
integer |
Needed for the 'offline' sample drawing in QA-process (AQL) (sample calculation according to DIN ISO 2859). Minimum: 0 |
salesUnit |
string (enum) |
sales unit Any of: [
"NOT_DEFINED",
"PIECE",
"PAIR"
] |
supplierType |
integer |
supplier type Minimum: 1 |
returnsHandling |
integer |
returns handling identification Minimum: 0 |
supplierSequence |
integer |
supplier-sequence Minimum: 0 |
approvedPurchasePrice |
integer |
approved purchase price Minimum: 0 |
2.2.3. Schema
Version | Status | Changes |
---|---|---|
upcoming version |
1. changed |
|
current version |
1. changed company fields from enum to string |
|
previous version |
1. update version-const |
|
previous version |
1. update version-const |
|
previous version |
1. switch to English interface |
|
deprecated version |
1. erpId and bestandsfirmaId enums adapted to the current state: - erpId: added F2X, remove unused KR1 - bestandsfirmaId: added F2X companies, remove unused Schwab and Eddi Baur 2. Remove examples 3. Remove unnecessary min/max-boundaries |
|
deprecated version |
initial version |
1.10 - Response
1. Business Context
Here the response message from LSAS to all interfaces (M01, M02, M03, M04) is described. An interface partner of LSAS will receive this response message on a kafka topic after sending a message to LSAS and LSAS validating the data. An error, as well as the "OK"-case will be answered.
2. Interface
2.1. Direction from LSAS to any interface partner
2.1.1. Header
This interface uses the Service Header.
2.1.2. Datamodel (single variant)
Property | Type | Description |
---|---|---|
(Root) |
object |
Schema for response message from LSAS, Version 1 |
eventId* |
string |
The unique eventId |
traceId* |
string |
The unique traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
context |
string (const) |
The context / business case Constant: MASTERDATA |
eventType* |
string (enum) |
The concrete type record. Any of: [
"PRODUCT_RESPONSE",
"SUPPLIER_RESPONSE",
"SUPPLIER_PRODUCT_RESPONSE",
"LOGISTICAL_DATA_RESPONSE"
] |
version* |
string (const) |
The number of version of schema Constant: 1.1 |
metaData* |
object |
additional meta information |
sender* |
string (const) |
Sender of the message Constant: LSAS |
data* |
object |
Data of the business object |
logisticsEntityId |
string |
Technical ID of the referenced entity in LSAS Maximum Length: 36 |
entityId* |
string |
technical ID of the referenced entity within the message Maximum Length: 36 |
status* |
boolean |
Status |
detailedStatus* |
string (enum) |
Detailed information about the outcome of the message received. Any of: [
"INSERTED",
"UPDATED",
"UNCHANGED",
"INSERT_REJECTED",
"UPDATE_REJECTED",
"INTERNAL_ERROR",
"UNAVAILABLE"
] |
errors |
array |
|
(Array item) |
object |
|
code* |
integer |
|
description |
string |
2.1.3. Example (single variant)
{
"eventId":"2b6105df-d03a-4913-b1ea-5fdffb0d2b1c",
"traceId":"9b183e1ab13fda5ed1c59ef838b609bd",
"context":"MASTERDATA",
"eventTime":"2023-01-25T12:12:28.079Z",
"eventType":"LOGISTICAL_DATA_RESPONSE",
"version":"1.1",
"metaData":{
"sender":"LSAS"
},
"data":{
"entityId":"ABCDEFGHIJKLMNOPQ",
"status":false,
"detailedStatus": "INSERTED_REJECTED",
"errors":[
{
"code":51,
"description":"Unknown logisticsProductId."
}
]
}
}
2.1.4. Example (list variant)
{
"eventId":"2b6105df-d03a-4913-b1ea-5fdffb0d2b1c",
"traceId":"9b183e1ab13fda5ed1c59ef838b609bd",
"context":"MASTERDATA",
"eventTime":"2023-01-25T12:12:28.079Z",
"eventType":"LOGISTICAL_DATA_RESPONSE",
"version":"1.1",
"metaData":{
"sender":"LSAS"
},
"data":{
"status":false,
"items": [
{
"status": true,
"entityId":"000001",
"detailedStatus": "INSERTED",
"errors":[]
},
{
"status": false,
"entityId":"000003",
"detailedStatus": "UPDATE_REJECTED",
"errors":[
{
"code":51,
"description":"Unknown logisticsProductId."
}
]
}
]
}
}
2.1.5. Schema
Version |
Status |
Changes |
current version |
added |
|
previous version |
initial version |
2.1.6. Handling of new detailed status
To improve the clarity and usefulness of our responses, we have introduced a new detailedStatus
field. This field will help you categorize and better understand the outcome of all messages your system sends to LSAS, making it easier to address issues when they arise.
The goal of providing this information is so you know how to proceed with each error type, and also so you are aware who is responsible for the fixes in each case.
Status | Description | Responsible system | Severity |
---|---|---|---|
INSERTED |
The record has been successfully inserted. |
- |
- |
UPDATED |
The record has been successfully updated. |
- |
- |
UNCHANGED |
The record has not changed (either because the data in the message was equal to what we already had or because the message was ignored due to a newer message having been processed first). |
- |
- |
INSERT_REJECTED |
Problem: The record could not be inserted because it is missing required attributes (e.g., the product is not yet logistics-ready). |
ERP |
Low |
UPDATE_REJECTED |
Problem: The record could not be updated due to validation issues (e.g., the product is logistics-ready but fails validation). |
ERP |
High |
INTERNAL_ERROR |
Problem: An internal error occurred in LSAS due to specific inputs. |
LSAS |
High |
UNAVAILABLE |
Problem: LSAS is currently unavailable, possibly due to high load. |
ERP + LSAS |
Medium |
By understanding these statuses, users can take appropriate actions to resolve issues and know who to contact for further assistance.