Construction Material Product Standard (CMPS)

Motivation

Für bobbie als digitalen Baustoffhändler spielt die Qualität, Struktur und Verfügbarkeit von Produktdaten eine zentrale Rolle. Bisherige Standards zum Austausch von Produktdaten in der Baubranche sind jedoch nicht auf das Semantic Web zugeschnitten.

bobbie definiert deshalb mit dem Construction Material Product Standard (CMPS) eine eigene Schnittstelle zum Austausch von Produktdaten. CMPS baut auf gebräuchlichen Webstandards auf, der Datenaustausch erfolgt ausschließlich im LD+JSON Format und erfüllt das Format von schema.org/Product.

Präambel

Die Schlüsselwörter "MUSS", "DARF NICHT", "ERFORDERLICH", "SOLL", "VERBOTEN", "NÖTIG", "NICHT NÖTIG", "SOLL NICHT", "EMPFOHLEN", "DARF", "KANN" und "OPTIONAL" werden nach RFC 2119de interpretiert.

Datenstruktur

Einzelnes Produkt

Ein Produkt wird im Format schema.org/Product dargestellt, die Kodierung MUSS im Format LD+JSON erfolgen. Die Daten KÖNNEN in HTML-Code in einem <script> Tag ausgegeben werden.

Eigenschaften eines Produkts SOLLEN nach Möglichkeit in den dafür vorgesehenen Feldern (properties) des Typs schema.org/Product dargestellt werden. Ansonsten MUSS die Eigenschaft schema.org/additionalProperty genutzt werden.

Wenn eine Eigenschaft Teil der Standards IFC4 Building Elements, Uniclass, Minnd, ETIM oder UniversalTypes ist, SOLL die zugehörige additionalProperty zusätzlich die entsprechende Klassifizierung im Feld additionalType enthalten. Die Integration dieser Standards SOLL gemäß Stolz und Hepp 2018 erfolgen.

Konfigurierbares Produkt

Ein Produkt mit mehreren Varianten (z.B. Farbe oder Größe) wird entsprechend der Typspezifikation schema.org/ProductGroup dargestellt. Die einzelnen Produktvarianten SOLLEN in diesem Fall in der Eigenschaft hasVariant integriert, jeweils als Typ schema.org/Product.

Produktkatalog

Sollen mehrere Produkte auf einmal ausgegeben werden, so MUSS die Anzahl der Produkte maximal 1000 betragen. Für höhere Anzahlen SOLL der Standard sitemap.xml verwendet werden und darin die einzelnen Produkte verlinkt werden. Diese Links SOLLEN jeweils den Parameter CMPSonly beinhalten.

Datenübertragung

Die Referenzierung von Produkten MUSS per URL erfolgen und SOLL das https-Protokoll nutzen. Beim Aufruf einer einzelnen URL DÜRFEN die Daten mehrerer Produkte ausgegeben werden. Wird der URL-Parameter CMPSonly angegeben, SOLLEN reine LD+JSON-Daten ausgegeben werden (ohne HTML, ohne <script> Tag usw.). Da diese Bedingung OPTIONAL ist, MUSS der Client es unterstützen, trotz Angabe des Parameters bspw. HTML-Code zu erhalten.

Authentifizierung KANN per Standard HTTP Mechanismus erfolgen, jedoch wird empfohlen auf Authentifizierung zu verzichten, um einen offenen Austausch von Produktdaten zu ermöglichen.

Versionierung

Produktdaten sind einem ständigen Wandel ausgesetzt, gängige Kennungen wie SKUs oder GTIN bleiben jedoch in der Regel unverändert. Der Typ schema.org/Product beinhaltet derzeit noch keine Eigenschaft zur Versionierung (schema.org/version ist hier nicht verfügbar, eine entsprechende Anfrage zur Integration ist noch in Bearbeitung). Deshalb wird die Version eines Produktes durch eine Zusatzeigenschaft (schema.org/additionalProperty) mit dem Namen version integriert. Implementationen von CMPS MÜSSEN beide Varianten unterstützen.

Änderungen in Produktdaten, die sich auf die folgenden Eigenschaften beschränken, SOLLEN NICHT zu einer Anpassung der Produktversion führen:

aggregateRating
offers
productionDate
purchaseDate
review

Beispiele

Die folgende Beispiele zeigen LD+JSON Output eines einzelnen Produktes sowie eines konfigurierbaren Produktes (ProductGroup).

Product

ProductGroup

{
  "@context": "https://schema.org",
  "@type": "Product",
  "name": "Garagen-Begrünungspaket",
  "description": "für 10 m², mit Systemerde, incl. Fracht",
  "image": "https://bobbie.de/media/catalog/product/cache/505eeda3461bba6a55f3396bec3df5ea/z/i/zincgaragenpaket_neu_bearb.png",
  "offers": {
    "priceCurrency": "EUR",
    "availability": "https://schema.org/BackOrder",
    "itemCondition": "https://schema.org/NewCondition",
    "seller": {
      "@type": "Organization",
      "name": "bobbie - Baustoffhandel 4.0"
    },
    "url": "https://bobbie.de/zinco-gmbh/garten_und_landschaftsbau/pflanzen_baeume/blumen/garagen-begrunungspaket-zinc3802-3802",
    "@type": "Offer",
    "price": 315.97,
    "shippingDetails": {
      "@type": "OfferShippingDetails",
      "shippingDestination": {
        "@type": "DefinedRegion",
        "addressCountry": "DE"
      },
      "shippingRate": {
        "@type": "MonetaryAmount",
        "value": "0",
        "currency": "EUR"
      }
    }
  },
  "url": "https://bobbie.de/zinco-gmbh/garten_und_landschaftsbau/pflanzen_baeume/blumen/garagen-begrunungspaket-zinc3802-3802",
  "aggregateRating": [],
  "review": [],
  "brand": {
    "@type": "Brand",
    "name": "ZinCo GmbH"
  },
  "manufacturer": {
    "@type": "Organization",
    "name": "ZinCo GmbH"
  },
  "sku": "zinc3802@16",
  "mpn": "zinc3802@16",
  "weight": {
    "@type": "QuantitativeValue",
    "value": 700,
    "unitCode": "KGM",
    "unitText": "Kilogramm"
  },
  "gtin": "4034049004459",
  "additionalProperty": [
    {
      "@type": "PropertyValue",
      "name": "bobbie Artikelnummer",
      "propertyID": "sku",
      "value": "zinc3802@16"
    },
    {
      "@type": "PropertyValue",
      "name": "Hersteller Artikelnummer",
      "propertyID": "vsku",
      "value": "3802"
    },
    {
      "@type": "PropertyValue",
      "name": "Pflegehinweise",
      "propertyID": "care",
      "value": "Pflege Extensive Pflanzungen sind sehr pflegearm, jedoch sollte bis zum Keimen und Anwachsen die Dachoberfläche gut feucht gehalten werden. Pflanzungen im Frühjahr und Herbst bringen dabei die besten Ergebnisse. Ein bis zwei Mal pro Jahr sollte außerdem unverwünschter Fremdbewuchs entfernt werden. Dabei werden auch die An- und Abschlüsse inklusive der Entwässerungseinrichtungen kontrolliert."
    }
  ]
}

{
  "@context": "https://schema.org",
  "@type": "ProductGroup",
  "name": "DIEPHAUS Mauerstein LISCO PICO [3 Varianten]",
  "description": "Diephaus  Mauerstein [3 Varianten]",
  "image": "https://bobbie.de/media/catalog/product/cache/505eeda3461bba6a55f3396bec3df5ea/d/i/diep4250039999387_2.jpg",
  "offers": {
    "priceCurrency": "EUR",
    "availability": "https://schema.org/BackOrder",
    "itemCondition": "https://schema.org/NewCondition",
    "seller": {
      "@type": "Organization",
      "name": "bobbie - Baustoffhandel 4.0"
    },
    "url": "https://bobbie.de/diephaus-betonwerk-gmbh/garten_und_landschaftsbau/mauern_zaeune/mauern/diephaus-mauerstein-lisco-pico-130118",
    "@type": "AggregateOffer",
    "lowPrice": 3.78,
    "highPrice": 3.87,
    "offerCount": 3,
    "shippingDetails": {
      "@type": "OfferShippingDetails",
      "shippingDestination": {
        "@type": "DefinedRegion",
        "addressCountry": "DE"
      },
      "shippingRate": {
        "@type": "MonetaryAmount",
        "value": "192.78",
        "currency": "EUR"
      }
    }
  },
  "url": "https://bobbie.de/diephaus-betonwerk-gmbh/garten_und_landschaftsbau/mauern_zaeune/mauern/diephaus-mauerstein-lisco-pico-130118",
  "aggregateRating": [],
  "review": [],
  "brand": {
    "@type": "Brand",
    "name": "DIEPHAUS BETONWERK GMBH"
  },
  "manufacturer": {
    "@type": "Organization",
    "name": "DIEPHAUS BETONWERK GMBH"
  },
  "sku": "diep130118@6",
  "mpn": "diep130118@6",
  "hasVariant": [
    {
      "@type": "Product",
      "name": "DIEPHAUS Mauerstein LISCO PICO WEIß SCHWARZ 40/10/10 CM",
      "url": "https://bobbie.de/garten_und_landschaftsbau/mauern_zaeune/mauern/diephaus-mauerstein-lisco-pico-130118#161=13638",
      "color": "WEIß-SCHWARZ"
    },
    {
      "@type": "Product",
      "name": "DIEPHAUS Mauerstein LISCO PICO SANDSTEIN 40/10/10 CM",
      "url": "https://bobbie.de/garten_und_landschaftsbau/mauern_zaeune/mauern/diephaus-mauerstein-lisco-pico-130118#161=4560",
      "color": "SANDSTEIN"
    },
    {
      "@type": "Product",
      "name": "DIEPHAUS Mauerstein LISCO PICO BASALT 40/10/10 CM",
      "url": "https://bobbie.de/garten_und_landschaftsbau/mauern_zaeune/mauern/diephaus-mauerstein-lisco-pico-130118#161=4559",
      "color": "BASALT"
    }
  ],
  "variesBy": "color"
}

Bitte gucken Sie sich die Beispiele auf PC oder Latop an, die können auf Mobile nicht angezeigt werden.