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.
detailsProductDetailsrequiredProduct 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 …
productGtinsarray | nullGlobal Trade Item Numbers (GTINs) for the product. Can include GTIN-8, GTIN-12, GTIN-13, or GTIN-14.
unbrandedProductboolean | nullIndicates whether this is an unbranded/white-label product.
brandNamestring | nullmin: 1, max: 50Brand name of the product.
productAnnouncementDatestring | nulldateDate when the product was announced. ISO 8601 date format (YYYY-MM-DD).
productObsolescenceDatestring | nulldateDate when the product becomes obsolete. ISO 8601 date format (YYYY-MM-DD).
customsCommodityCodestring | nullmin: 6, max: 16Customs/HS commodity code for the product.
factorCustomsCommodityCodenumber | nulldecimal≥ 0, ≤ 99999999999.9999Factor for customs commodity code calculations. Supports up to 4 decimal places. Converted from ETIM xChange string p…
countryOfOriginarray | nullISO 3166-1 alpha-2 country codes for country of origin.
productStatusProductStatusPRE-LAUNCH | ACTIVE | ON HOLD | PLANNED WITHDRAWAL | OBSOLETE | null
productTypeProductTypePHYSICAL | CONTRACT | LICENCE | SERVICE | null
customisableProductboolean | nullIndicates whether the product can be customised.
hasSerialNumberboolean | nullIndicates whether the product has a serial number.
warrantyConsumerinteger | null≥ 0Consumer warranty period in months.
warrantyBusinessinteger | null≥ 0Business/B2B warranty period in months.
relatedManufacturerProductGrouparray | nullRelated manufacturer product groups for categorization.
descriptionsarray | nullArray of multilingual product descriptions. Each item contains descriptions in a specific language.
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.
uniqueMainProductDescriptionstring | nullmin: 1, max: 255Unique main product description (maximum 255 characters). A concise but comprehensive description that uniquely ident…
fullProductDescriptionstring | nullmin: 1, max: 10000Complete detailed product description (maximum 10,000 characters). Comprehensive technical and functional description…
productMarketingTextstring | nullmin: 1, max: 10000Marketing-focused product text (maximum 10,000 characters). Promotional content highlighting product benefits and fea…
productSpecificationTextstring | nullmin: 1, max: 10000Technical specification text (maximum 10,000 characters). Detailed technical specifications and characteristics of th…
productApplicationInstructionsstring | nullmin: 1, max: 10000Product application and usage instructions (maximum 10,000 characters). Guidelines on how to use and apply the produc…
productKeywordarray | nullKeywords for product search and categorization (maximum 50 characters each). Array of search terms and keywords assoc…
productPageUrlstring | nulluriURL to the manufacturer's product page. Direct link to detailed product information on the manufacturer's website.
etimClassificationsarray | nullArray 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 | null≥ 1Version number of the ETIM class. Incremented when class definition changes. Optional field matching ETIM xChange spe…
etimDynamicReleaseDatestring | nulldateRelease date for dynamic ETIM classes. ISO 8601 date format (YYYY-MM-DD). Only applicable when `etimReleaseVersion` i…
etimFeaturesarray | nullArray 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…
etimValueCodestring | nullpatternETIM standardized value code for alphanumeric features (e.g., enumerations, selections). Format: EV followed by 6 dig…
etimValueNumericnumber | nulldecimal≥ -999999999999.9999, ≤ 999999999999.9999Numeric value for the ETIM feature (supports up to 4 decimal places). Converted from ETIM xChange string pattern to n…
etimValueRangeLowernumber | nulldecimal≥ -999999999999.9999, ≤ 999999999999.9999Lower bound of a numeric range for the feature value. Converted from ETIM xChange string pattern to number type.
etimValueRangeUppernumber | nulldecimal≥ -999999999999.9999, ≤ 999999999999.9999Upper bound of a numeric range for the feature value. Converted from ETIM xChange string pattern to number type.
etimValueLogicalboolean | nullBoolean/logical value for yes/no type features.
etimValueDetailsarray | nullMultilingual free-text descriptions providing additional details about the feature value.
reasonNoValuestring | nullMV | NA | UN | nullReason code when no feature value is provided.
lcaEnvironmentalLcaEnvironmental | nullLife Cycle Assessment and Environmental Product Declaration (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.
declaredUnitGwpTotalnumber | nulldecimalTotal Global Warming Potential (GWP) in kg CO2 equivalent per declared unit.
declaredUnitGwpFossilnumber | nulldecimalFossil Global Warming Potential in kg CO2 equivalent per declared unit.
declaredUnitGwpBiogenicnumber | nulldecimalBiogenic Global Warming Potential in kg CO2 equivalent per declared unit.
declaredUnitApnumber | nulldecimalAcidification Potential (AP) in kg SO2 equivalent per declared unit.
declaredUnitEpFreshwaternumber | nulldecimalEutrophication Potential for freshwater in kg PO4 equivalent per declared unit.
declaredUnitOdpnumber | nulldecimalOzone Depletion Potential (ODP) in kg CFC-11 equivalent per declared unit.
declaredUnitGwpLulucnumber | nulldecimalGlobal Warming Potential from Land Use and Land Use Change (GWP-LULUC) in kg CO2 equivalent per declared unit.
declaredUnitEpMarinenumber | nulldecimalEutrophication Potential for marine water (EP-marine) in kg N equivalent per declared unit.
declaredUnitEpTerrestrialnumber | nulldecimalEutrophication Potential for terrestrial ecosystems (EP-terrestrial) in mol N equivalent per declared unit.
declaredUnitPocpnumber | nulldecimalPhotochemical Ozone Creation Potential (POCP) in kg NMVOC equivalent per declared unit. Also known as summer smog pot…
declaredUnitAdpenumber | nulldecimalAbiotic Depletion Potential for non-fossil resources (ADP-elements) in kg Sb equivalent per declared unit.
declaredUnitAdpfnumber | nulldecimalAbiotic Depletion Potential for fossil resources (ADP-fossil) in MJ per declared unit.
declaredUnitWdpnumber | nulldecimalWater Deprivation Potential (WDP) in m³ world equivalent per declared unit.
declaredUnitPertnumber | nulldecimalUse of renewable primary energy resources (PERT) in MJ per declared unit. Total renewable primary energy.
declaredUnitPenrtnumber | nulldecimalUse of non-renewable primary energy resources (PENRT) in MJ per declared unit. Total non-renewable primary energy.
declaredUnitPmnumber | nulldecimalParticulate Matter emissions (PM) expressed as disease incidence per declared unit.
declaredUnitIrpnumber | nulldecimalIonising Radiation Potential (IRP) in kBq U235 equivalent per declared unit.
declaredUnitEtpfwnumber | nulldecimalEcotoxicity Potential for freshwater (ETP-fw) in CTUe (Comparative Toxic Unit for ecosystems) per declared unit.
declaredUnitHtpcnumber | nulldecimalHuman Toxicity Potential - cancer effects (HTP-c) in CTUh (Comparative Toxic Unit for humans) per declared unit.
declaredUnitHtpncnumber | nulldecimalHuman Toxicity Potential - non-cancer effects (HTP-nc) in CTUh (Comparative Toxic Unit for humans) per declared unit.
declaredUnitSqpnumber | nulldecimalSoil Quality Potential (SQP) - dimensionless indicator per declared unit. Measures the impact on soil quality.
functionalUnitDescriptionarray | nullMultilingual descriptions of the functional unit for LCA.
epdValidityExpiryDatestring | nulldateExpiry date of EPD validity period. ISO 8601 date format (YYYY-MM-DD).
epdOperatorNamestring | nullmin: 1, max: 100Name of the EPD program operator that published the Environmental Product Declaration.
epdOperatorUristring | nulluriURI/URL to the EPD program operator's website.
operatorEpdIdstring | nullmin: 1, max: 35EPD identifier assigned by the program operator.
manufacturerEpdIdstring | nullmin: 1, max: 35EPD identifier assigned by the manufacturer for internal reference.
productCategoryRulesDescriptionstring | nullmin: 1, max: 100Description of the Product Category Rules (PCR) used for the LCA/EPD. PCR defines the rules for the environmental ass…
productCategoryRulesUristring | nulluriURI/URL to the Product Category Rules (PCR) document.
productSpecificRulesDescriptionstring | nullmin: 1, max: 100Description of Product Specific Rules (PSR) applied in addition to PCR. PSR provides additional rules for sub-categor…
productSpecificRulesUristring | nulluriURI/URL to the Product Specific Rules (PSR) document.
attachmentsarray | nullArray of product attachments including images, documents, certificates, and other files.
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.
attachmentLanguagearray | nullLanguages applicable to this attachment in ISO 639-1 and ISO 3166-1 format (e.g., "en-GB", "de-DE"). Multiple languag…
attachmentFilenamestring | nullmin: 1, max: 100Original filename of the attachment (maximum 100 characters).
attachmentDescriptionarray | nullMultilingual descriptions of the attachment (maximum 255 characters per description).
attachmentIssueDatestring | nulldateDate when the attachment was issued or published. ISO 8601 date format (YYYY-MM-DD).
attachmentExpiryDatestring | nulldateDate 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 | MDX999 | nullAdditional specification code providing more detail about the attachment type.
attachmentOrderinteger | null≥ 1Display order/sequence number for this attachment when multiple attachments are present. Lower numbers indicate highe…