Structure of part types

A part type is the basic data structure used by the Partium search engine.

Part IDs

A part type is identified by a unique ID. These part IDs can be freely chosen, but must be unique within the catalog. Usually, the part IDs are the same as in the ERP system.

Part names

A part type contains a name, which is presented to the user. The names are language-specific, i.e. they can be defined per language.

Structure of attributes

Additionally, a part type can contain various attributes. The possible and permitted attributes must be defined in an ontology. After the attribute definitions have been specified in the ontology, it is possible to assign attribute values to part types.

Go to Section Define your data ontology to learn about setting up the attribute ontology.

An attribute:

• is language-specific, i.e. different values can be defined for each language, which is set up in the catalog
• can contain a list of values
• can contain values, which are specific for different organizations
• can be a "text" attribute or of type "enum"

Example 1

Definition of a single value of attribute color, which is of type text. The value should be the same for all defined organizations. In that case the field organizations is empty.

{
  "attribute_id": "color",
  "values": [
    {
      "organization": "",
      "value": {
        "de": "Rot",
        "en": "Red",
      }
    }
  ]
}

Example 2

Definition of multiple values of attribute usage, which is of type text. The values should be the same for all defined organizations. In that case the field organizations is empty.

{
  "attribute_id": "usage",
  "values": [
    {
      "organization": "",
      "value": {
        "de": "Holz",
        "en": "Wood",
      }
    },
    {
      "organization": "",
      "value": {
        "de": "Metall",
        "en": "Metal",
      }
    }
  ]
}

Example 3

Definition of values of attribute price, which is of type text. Different values should be specified for the defined organizations.

{
  "attribute_id": "price",
  "values": [
    {
      "organization": "my-sub-org-1",
      "value": {
        "de": "100$",
        "en": "100$",
      }
    },
    {
      "organization": "my-sub-org-2",
      "value": {
        "de": "110$",
        "en": "110$",
      }
    }
  ]
}

Example 4

Definition of a value of attribute detachable, which is of type enum. The value should be the same for all defined organizations. In that case the field organizations is empty. In case of enum attributes a valid option_id must be specified instead of a text value. In the example below it is assumed that option_id 123 is a valid option of attribute detachable and this option e.g. represents the value true in the attribute ontology.

{
  "attribute_id": "detachable",
  "values": [
    {
      "organization": "",
      "option_id": 123
    }
  ]
}