Product Domain Model

Interactive treeview — generated from the OpenAPI specification.

type data type Schema nested schema (click to expand) REQUIRED required field format format hint A | B enum values
Product
Complete product information including identification, details, descriptions, classifications, and lifecycle data. St…
manufacturerIdGlnGlnrequiredGlobal Location Number (GLN) of the manufacturer. Primary key component.
manufacturerProductNumberstringrequiredmin: 1, max: 35Manufacturer's unique product number (MPN). Primary key component.
detailsProductDetailsProduct identification and operational details, combining fields from ETIM xChange `ProductIdentification` and `Produ…
Core product information combining identification and details without the composite key fields. Contains identifiers,…
productValidityDatestringdaterequiredDate when the product becomes valid/available. ISO 8601 date format (YYYY-MM-DD). Defaults to CatalogueValidityStart …
productGtinsGtin[]Global Trade Item Numbers (GTINs) for the product. Can include GTIN-8, GTIN-12, GTIN-13, or GTIN-14.
unbrandedProductbooleanIndicates whether this is an unbranded/white-label product.
brandNamestringmin: 1, max: 50Brand name of the product.
productAnnouncementDatestringdateDate when the product was announced. ISO 8601 date format (YYYY-MM-DD).
productObsolescenceDatestringdateDate when the product becomes obsolete. ISO 8601 date format (YYYY-MM-DD).
customsCommodityCodestringmin: 6, max: 16Customs/HS commodity code for the product.
factorCustomsCommodityCodenumberdecimal≥ 0, ≤ 99999999999.9999Factor for customs commodity code calculations. Supports up to 4 decimal places. Converted from ETIM xChange string p…
countryOfOriginstring[]ISO 3166-1 alpha-2 country codes for country of origin.
productStatusProductStatusPRE-LAUNCH | ACTIVE | ON HOLD | PLANNED WITHDRAWAL | OBSOLETE
productTypeProductTypePHYSICAL | CONTRACT | LICENCE | SERVICE
customisableProductbooleanIndicates whether the product can be customised.
hasSerialNumberbooleanIndicates whether the product has a serial number.
warrantyConsumerinteger≥ 0Consumer warranty period in months.
warrantyBusinessinteger≥ 0Business/B2B warranty period in months.
relatedManufacturerProductGroupstring[]Related manufacturer product groups for categorization.
descriptionsProductDescription[]Array of multilingual product descriptions. Each item contains descriptions in a specific language. Absent when no de…
descriptionLanguageLanguageCoderequiredLanguage code for the description in ISO 639-1 and ISO 3166-1 format (e.g., "en-GB", "de-DE"). Sourced from ETIM xCha…
minimalProductDescriptionstringrequiredmin: 1, max: 80Short product description (maximum 80 characters). Minimal required description for product identification.
uniqueMainProductDescriptionstringmin: 1, max: 255Unique main product description (maximum 255 characters). A concise but comprehensive description that uniquely ident…
fullProductDescriptionstringmin: 1, max: 10000Complete detailed product description (maximum 10,000 characters). Comprehensive technical and functional description…
productMarketingTextstringmin: 1, max: 10000Marketing-focused product text (maximum 10,000 characters). Promotional content highlighting product benefits and fea…
productSpecificationTextstringmin: 1, max: 10000Technical specification text (maximum 10,000 characters). Detailed technical specifications and characteristics of th…
productApplicationInstructionsstringmin: 1, max: 10000Product application and usage instructions (maximum 10,000 characters). Guidelines on how to use and apply the produc…
productKeywordstring[]Keywords for product search and categorization (maximum 50 characters each). Array of search terms and keywords assoc…
productPageUrlstringuriURL to the manufacturer's product page. Direct link to detailed product information on the manufacturer's website.
etimClassificationsEtimClassification[]Array of ETIM classifications for this product with embedded features. Multiple classifications can exist across diff…
etimClassCodestringrequiredpatternETIM class code identifying the product category. Format: EC followed by 6 digits.
etimReleaseVersionstringrequiredpatternETIM release version where this classification is valid. Release number (e.g., "9.0", "10.0", "11.0") or "DYNAMIC" fo…
etimClassVersioninteger≥ 1Version number of the ETIM class. Incremented when class definition changes. Optional field matching ETIM xChange spe…
etimDynamicReleaseDatestringdateRelease date for dynamic ETIM classes. ISO 8601 date format (YYYY-MM-DD). Only applicable when `etimReleaseVersion` i…
etimFeaturesEtimFeature[]Array of ETIM feature values that characterize the product according to the ETIM class. Features define standardized …
etimFeatureCodestringrequiredpatternETIM standardized feature code identifying a specific product characteristic. Format: EF followed by 6 digits, or EFI…
etimValueCodestringpatternETIM standardized value code for alphanumeric features (e.g., enumerations, selections). Format: EV followed by 6 dig…
etimValueNumericnumberdecimal≥ -999999999999.9999, ≤ 999999999999.9999Numeric value for the ETIM feature (supports up to 4 decimal places). Converted from ETIM xChange string pattern to n…
etimValueRangeLowernumberdecimal≥ -999999999999.9999, ≤ 999999999999.9999Lower bound of a numeric range for the feature value. Converted from ETIM xChange string pattern to number type.
etimValueRangeUppernumberdecimal≥ -999999999999.9999, ≤ 999999999999.9999Upper bound of a numeric range for the feature value. Converted from ETIM xChange string pattern to number type.
etimValueLogicalbooleanBoolean/logical value for yes/no type features.
etimValueDetailsobject[]Multilingual free-text descriptions providing additional details about the feature value.
reasonNoValuestringMV | NA | UNReason code when no feature value is provided.
lcaEnvironmentalLcaEnvironmentalLife Cycle Assessment and Environmental Product Declaration (EPD) data. Absent if the product has no LCA/EPD data.
declaredUnitUnitstringrequiredKGM | LTR | MTK | MTQ | MTR | PCE | TNE | FOT | FTK | FTQ | LBR | LTN | YDK | YRDUnit of measurement for the declared/functional unit in LCA.
declaredUnitQuantitynumberdecimalrequired≥ 0, ≤ 99999999999.9999Quantity of the declared/functional unit for LCA calculations. Converted from ETIM xChange string pattern to number t…
lcaReferenceLifetimeintegerrequired≥ 0Reference service life/lifetime for LCA calculations in years.
thirdPartyVerificationstringrequirednone | internally | externallyType of third-party verification for LCA/EPD data.
epdValidityStartDatestringdaterequiredStart date of EPD validity period. ISO 8601 date format (YYYY-MM-DD). Defaults to CatalogueValidityStart if not overr…
lcaDeclarationLcaDeclaration[]requiredArray of LCA declarations for different life cycle stages.
lifeCycleStagestringrequiredA1 | A2 | A3 | A1-A3 | A4 | A5 | B1 | B2 | B3 | B4 | B5 | B6 | B7 | B1-B7 | C1 | C2 | C3 | C4 | C1-C4 | DLife cycle assessment stage according to EN 15804.
lcaDeclarationIndicatorstringrequiredMDE | MND | MNR | AGGType of LCA declaration data.
declaredUnitGwpTotalnumberdecimalTotal Global Warming Potential (GWP) in kg CO2 equivalent per declared unit.
declaredUnitGwpFossilnumberdecimalFossil Global Warming Potential in kg CO2 equivalent per declared unit.
declaredUnitGwpBiogenicnumberdecimalBiogenic Global Warming Potential in kg CO2 equivalent per declared unit.
declaredUnitApnumberdecimalAcidification Potential (AP) in kg SO2 equivalent per declared unit.
declaredUnitEpFreshwaternumberdecimalEutrophication Potential for freshwater in kg PO4 equivalent per declared unit.
declaredUnitOdpnumberdecimalOzone Depletion Potential (ODP) in kg CFC-11 equivalent per declared unit.
declaredUnitGwpLulucnumberdecimalGlobal Warming Potential from Land Use and Land Use Change (GWP-LULUC) in kg CO2 equivalent per declared unit.
declaredUnitEpMarinenumberdecimalEutrophication Potential for marine water (EP-marine) in kg N equivalent per declared unit.
declaredUnitEpTerrestrialnumberdecimalEutrophication Potential for terrestrial ecosystems (EP-terrestrial) in mol N equivalent per declared unit.
declaredUnitPocpnumberdecimalPhotochemical Ozone Creation Potential (POCP) in kg NMVOC equivalent per declared unit. Also known as summer smog pot…
declaredUnitAdpenumberdecimalAbiotic Depletion Potential for non-fossil resources (ADP-elements) in kg Sb equivalent per declared unit.
declaredUnitAdpfnumberdecimalAbiotic Depletion Potential for fossil resources (ADP-fossil) in MJ per declared unit.
declaredUnitWdpnumberdecimalWater Deprivation Potential (WDP) in m³ world equivalent per declared unit.
declaredUnitPertnumberdecimalUse of renewable primary energy resources (PERT) in MJ per declared unit. Total renewable primary energy.
declaredUnitPenrtnumberdecimalUse of non-renewable primary energy resources (PENRT) in MJ per declared unit. Total non-renewable primary energy.
declaredUnitPmnumberdecimalParticulate Matter emissions (PM) expressed as disease incidence per declared unit.
declaredUnitIrpnumberdecimalIonising Radiation Potential (IRP) in kBq U235 equivalent per declared unit.
declaredUnitEtpfwnumberdecimalEcotoxicity Potential for freshwater (ETP-fw) in CTUe (Comparative Toxic Unit for ecosystems) per declared unit.
declaredUnitHtpcnumberdecimalHuman Toxicity Potential - cancer effects (HTP-c) in CTUh (Comparative Toxic Unit for humans) per declared unit.
declaredUnitHtpncnumberdecimalHuman Toxicity Potential - non-cancer effects (HTP-nc) in CTUh (Comparative Toxic Unit for humans) per declared unit.
declaredUnitSqpnumberdecimalSoil Quality Potential (SQP) - dimensionless indicator per declared unit. Measures the impact on soil quality.
functionalUnitDescriptionobject[]Multilingual descriptions of the functional unit for LCA.
epdValidityExpiryDatestringdateExpiry date of EPD validity period. ISO 8601 date format (YYYY-MM-DD).
epdOperatorNamestringmin: 1, max: 100Name of the EPD program operator that published the Environmental Product Declaration.
epdOperatorUristringuriURI/URL to the EPD program operator's website.
operatorEpdIdstringmin: 1, max: 35EPD identifier assigned by the program operator.
manufacturerEpdIdstringmin: 1, max: 35EPD identifier assigned by the manufacturer for internal reference.
productCategoryRulesDescriptionstringmin: 1, max: 100Description of the Product Category Rules (PCR) used for the LCA/EPD. PCR defines the rules for the environmental ass…
productCategoryRulesUristringuriURI/URL to the Product Category Rules (PCR) document.
productSpecificRulesDescriptionstringmin: 1, max: 100Description of Product Specific Rules (PSR) applied in addition to PCR. PSR provides additional rules for sub-categor…
productSpecificRulesUristringuriURI/URL to the Product Specific Rules (PSR) document.
attachmentsProductAttachment[]Array of product attachments including images, documents, certificates, and other files. Absent when no attachments a…
attachmentTypeAttachmentTyperequiredATX001 | ATX002 | ATX003 | ATX004 | ATX010 | ATX011 | ATX012 | ATX013 | ATX014 | ATX015 | ATX016 | ATX017 | ATX018 | ATX019 | ATX020 | ATX021 | ATX022 | ATX023 | ATX024 | ATX025 | ATX026 | ATX099ETIM standardized type code for the attachment.
attachmentDetailsAttachmentDetails[]requiredArray of attachment file details. Multiple files can be provided for the same attachment type (e.g., same datasheet i…
attachmentUristringurirequiredURI/URL to access the attachment file. This is the direct link to download or view the document, image, or video.
attachmentLanguageLanguageCode[]Languages applicable to this attachment in ISO 639-1 and ISO 3166-1 format (e.g., "en-GB", "de-DE"). Multiple languag…
attachmentFilenamestringmin: 1, max: 100Original filename of the attachment (maximum 100 characters).
attachmentDescriptionobject[]Multilingual descriptions of the attachment (maximum 255 characters per description).
attachmentIssueDatestringdateDate when the attachment was issued or published. ISO 8601 date format (YYYY-MM-DD).
attachmentExpiryDatestringdateDate when the attachment expires or becomes obsolete. ISO 8601 date format (YYYY-MM-DD).
attachmentTypeSpecificationAttachmentTypeSpecificationMDX002 | MDX005 | MDX007 | MDX008 | MDX010 | MDX012 | MDX013 | MDX014 | MDX015 | MDX016 | MDX017 | MDX018 | MDX019 | MDX020 | MDX021 | MDX022 | MDX023 | MDX024 | MDX025 | MDX026 | MDX027 | MDX028 | MDX029 | MDX030 | MDX033 | MDX034 | MDX035 | MDX037 | MDX038 | MDX039 | MDX041 | MDX042 | MDX045 | MDX047 | MDX048 | MDX049 | MDX050 | MDX051 | MDX052 | MDX053 | MDX054 | MDX055 | MDX057 | MDX058 | MDX059 | MDX060 | MDX061 | MDX062 | MDX063 | MDX064 | MDX065 | MDX100 | MDX101 | MDX102 | MDX103 | MDX104 | MDX105 | MDX106 | MDX107 | MDX108 | MDX109 | MDX999Additional specification code providing more detail about the attachment type.
attachmentOrderinteger≥ 1Display order/sequence number for this attachment when multiple attachments are present. Lower numbers indicate highe…