doc_attribute.json

[
  {
    "description": "the name of the attribute (should match the name of the attribute provided in the doc_product table in either string_attributes, numeric_attributes or localized_numeric_attributes",
    "type": "STRING",
    "name": "name",
    "mode": "REQUIRED"
  },
  {
    "type": "STRING",
    "name": "internal_id",
    "description": "the internal identifier of the attribute"
  },
  {
    "type": "STRING",
    "name": "external_id",
    "description": "the external identifier of the attribute (can be the same as the internal identifier)"
  },
  {
    "fields": [
      {
        "type": "STRING",
        "name": "language",
        "mode": "REQUIRED"
      },
      {
        "type": "STRING",
        "name": "value",
        "mode": "REQUIRED"
      }
    ],
    "description": "the title of the attribute",
    "type": "RECORD",
    "name": "label",
    "mode": "REPEATED"
  },
  {
    "fields": [
      {
        "type": "STRING",
        "name": "language",
        "mode": "REQUIRED"
      },
      {
        "type": "STRING",
        "name": "value",
        "mode": "REQUIRED"
      }
    ],
    "description": "the attribute group in which this attribute belongs",
    "type": "RECORD",
    "name": "attribute_group",
    "mode": "REPEATED"
  },
  {
    "fields": [
      {
        "type": "STRING",
        "name": "language",
        "mode": "REQUIRED"
      },
      {
        "type": "STRING",
        "name": "value",
        "mode": "REQUIRED"
      }
    ],
    "description": "the attribute sub-group in which this attribute belongs",
    "type": "RECORD",
    "name": "attribute_sub_group",
    "mode": "REPEATED"
  },
  {
    "description": "the stores",
    "type": "STRING",
    "name": "stores",
    "mode": "REPEATED"
  },
  {
    "description": "the type format of the attribute : 'numeric', 'string' or 'datetime', it is supported to set it to string but provide numeric attributes in the products, as lon as you have a mapping logic in the attribute values",
    "type": "STRING",
    "name": "format",
    "mode": "REQUIRED"
  },
  {
    "description": "are the values localized (different for every language) or not, it is supported to set it to true but provide non-localized attributes in the products, as lon as you have a mapping logic in the attribute values",
    "type": "BOOLEAN",
    "name": "localized",
    "mode": "REQUIRED"
  },
  {
    "fields": [
      {
        "type": "STRING",
        "name": "language",
        "mode": "REQUIRED"
      },
      {
        "type": "STRING",
        "name": "value",
        "mode": "REQUIRED"
      }
    ],
    "description": "the link of the attribute value",
    "type": "RECORD",
    "name": "link",
    "mode": "REPEATED"
  },
  {
    "description": "the list of related data types ('product', 'blog', 'content', ...), by default 'all' if empty",
    "type": "STRING",
    "name": "data_types",
    "mode": "REPEATED"
  },
  {
    "description": "is it possible for this attribute to have more than 1 value per sku (or final content), set to false unless necessary, as multi-valued vields cannot be sorted or grouped by",
    "type": "BOOLEAN",
    "name": "multi_value",
    "mode": "REQUIRED"
  },
  {
    "description": "is it an attribute that has a hierarchy of values (e.g.: category tree)",
    "type": "BOOLEAN",
    "name": "hierarchical",
    "mode": "REQUIRED"
  },
  {
    "description": "should be indexed as part of the searcheable : 0 : values not indexed for search, 1 : values indexed for search only in main index, 2 : values indexed for search in specialized field which can be boosted individually",
    "type": "INTEGER",
    "name": "search_by",
    "mode": "REQUIRED"
  },
  {
    "description": "should this attribute values be used as search suggestions",
    "type": "BOOLEAN",
    "name": "search_suggestion",
    "mode": "REQUIRED"
  },
  {
    "description": "is it an attribute that needs to be used as a filter in some requests",
    "type": "BOOLEAN",
    "name": "filter_by",
    "mode": "REQUIRED"
  },
  {
    "description": "is it a attribute that needs to be grouped by in some requests (if set to true, then multi_value must be set to false)",
    "type": "BOOLEAN",
    "name": "group_by",
    "mode": "REQUIRED"
  },
  {
    "description": "is it a attribute that needs to be ordered by in some requests (if set to true, then multi_value must be set to false)",
    "type": "BOOLEAN",
    "name": "order_by",
    "mode": "REQUIRED"
  },
  {
    "description": "should this attribute values be indexed independantly so they can be searched for (e.g.: author, brand, ...)",
    "type": "BOOLEAN",
    "name": "indexed",
    "mode": "REQUIRED"
  },
  {
    "fields": [
      {
        "type": "STRING",
        "name": "customer_groups",
        "mode": "REPEATED"
      },
      {
        "fields": [
          {
            "type": "STRING",
            "name": "language",
            "mode": "REQUIRED"
          },
          {
            "type": "INTEGER",
            "name": "value",
            "mode": "REQUIRED"
          }
        ],
        "type": "RECORD",
        "name": "values",
        "mode": "REPEATED"
      }
    ],
    "description": "the product visibility :VISIBILITY_NOT_VISIBLE = 1; VISIBILITY_IN_CATALOG = 2; VISIBILITY_IN_SEARCH = 3; VISIBILITY_BOTH = 4;",
    "type": "RECORD",
    "name": "visibility",
    "mode": "REPEATED"
  },
  {
    "fields": [
      {
        "type": "STRING",
        "name": "language",
        "mode": "REQUIRED"
      },
      {
        "type": "INTEGER",
        "name": "value",
        "mode": "REQUIRED"
      }
    ],
    "description": "the product status",
    "type": "RECORD",
    "name": "status",
    "mode": "REPEATED"
  },
  {
    "fields": [
      {
        "fields": [
          {
            "type": "STRING",
            "name": "language",
            "mode": "REQUIRED"
          },
          {
            "type": "DATETIME",
            "name": "value",
            "mode": "REQUIRED"
          }
        ],
        "type": "RECORD",
        "name": "start_datetime",
        "mode": "REPEATED"
      },
      {
        "fields": [
          {
            "type": "STRING",
            "name": "language",
            "mode": "REQUIRED"
          },
          {
            "type": "DATETIME",
            "name": "value",
            "mode": "REQUIRED"
          }
        ],
        "type": "RECORD",
        "name": "end_datetime",
        "mode": "REPEATED"
      }
    ],
    "description": "information about the activity periods of the product group",
    "type": "RECORD",
    "name": "periods",
    "mode": "REPEATED"
  },
  {
    "description": "technical field",
    "type": "DATETIME",
    "name": "creation_tm",
    "mode": "REQUIRED"
  },
  {
    "description": "technical field",
    "type": "INTEGER",
    "name": "client_id",
    "mode": "REQUIRED"
  },
  {
    "description": "technical field",
    "type": "INTEGER",
    "name": "src_sys_id",
    "mode": "REQUIRED"
  }
]