Field Reference

This section documents the fields used by Makaira, including both customer-provided fields and internally generated fields.

Data Sources

Makaira can receive product data from multiple sources:

Source	Description
Shop Connectors	Direct integration with OXID, Shopware, Plentymarkets, Shopify
NDJSON Import	Newline-delimited JSON file imports
Persistence Layer	Optional intermediate storage with boost calculations
API Push	Direct data push via REST API

These fields must be included in your import data:

Field	Required	Type	Description
`id`	Yes	string	Unique document identifier
`type`	Yes	string	`product`, `variant`, `category`, or `manufacturer`
`active`	Yes	boolean	Whether the document is visible
`onstock`	Yes	boolean	Stock availability flag
`shop`	Yes	string	Shop identifier
`title`	Yes	string	Document title
`parent`	Variants only	string	Parent product ID
`url`	Recommended	string	Document URL

These fields are created automatically during import:

Field	Description
`es_id`	Elasticsearch document ID (`{id}_{datatype}`)
`datatype`	Normalized document type
`join_field`	Parent-child relationship structure
`makairaImport`	Import timestamp (ISO 8601)
`sequence`	Change tracking number
`suggest`	Autocomplete suggestions

When using the Persistence Layer, these additional fields are generated:

Field	Description
`mak_boost_norm_*`	Normalized boost scores (0-1)
`isPseudo`	Pseudo-variant marker
`isVariant`	Variant type indicator
`attributes`	Aggregated attributes from variants

Your `type`	Internal `datatype`	Description
`product`	`makaira-productgroup`	Parent product (contains variants)
`variant`	`makaira-product`	Product variant (child of product)
`category`	`category`	Category document
`manufacturer`	`manufacturer`	Manufacturer/brand document

Note: The naming reflects Elasticsearch's parent-child structure where a "productgroup" contains multiple "products" (variants).

When filtering or sorting, use these suffixes:

Suffix	Purpose	Example
`.unanalyzed`	Exact matching	`title.unanalyzed`
`.lowercase`	Case-insensitive matching	`manufacturer_title.lowercase`
`.sorting`	Alphabetical sorting	`title.sorting`