NDJSON-Import

Makaira can import NDJSON files. NDJSON stands for newline delimited JSON. So one document must be stored per line in the data feed. Each document must adhere to certain field names depending on the type.

General information about import data:

timestamp
- Timestamp at the time of export from the store (format: YYYY-MM-DD HH:MM:ss)
additionalData
- Any key-value pairs of data to be available in addition to the products in the API
groups
- A set of data that is overridden based on the constraint "group" in the API - e.g. useful for discount groups. But also for target group based targeting.

Note: For better clarity, the documents are displayed in multiple lines in the following. In the final data feed, of course, each document must be delivered on one line without line breaks.

Document type product (product)

{
  "id": "10013859950",
  "type": "product",
  "parent": "",
  "shop": "4",
  "ean": "48690A",
  "isVariant": false,
  "active": true,
  "sort": 0,
  "stock": 0,
  "onstock": true,
  "picture_url_main": "https:\/\/images.makaira.io\/out\/pictures\/generated\/250_250\/pboxx-pixelboxx-2652106\/GRAPH%27IT+%22Brush+%26+Extra+fine%22+Marker+Komplett-Set%2C+Display+mit+96+Markern.jpg",
  "title": "GRAPH'IT \"Brush & Extra fine\" Marker Komplett-Set, Display mit 96 Markern",
  "shortdesc": "Das GRAPH'IT \"Brush & Extra fine\" enth\u00e4lt 96 Marker mit Qualit\u00e4tstinte auf Alkoholbasis und zwei unterschiedlichen Spitzen. Ideal geeignet f\u00fcr unterschiedlichste Mal- und Zeichentechniken.",
  "longdesc": "Das Komplett-Set enthält alle 96 Farbtöne der GRAPH'IT \"Brush & Extra fine\" Marker. Das transparente Display ermöglicht Ihnen jederzeit gute Übersicht und einen schnellen Zugriff zu Ihren Markern.Der GRAPH'IT \"Brush & Extra fine\" Marker verfügt über zwei unterschiedliche Spitzen. Eine lange, flexible Spitze mit synthetischen Pinselfasern, die eine optimale Strömung der Tinte gewährt. Und eine extrafeine 0,5 mm-Spitze mit Metallfassung, die sich insbesondere für Illustrationen eignet.GRAPH'IT \"Brush & Extra fine\" Marker \u2013 Die Produkt-Eigenschaften im ÜberblickKorpus aus weißem Kunststoff mit Dreikantform für hervorragende Haptik und Mal-KomfortQualitätstinte auf AlkoholbasisLeicht zu öffnender Deckel mit Farbcode zur einfachen IdentifizierungDer GRAPH'IT Marker ist ideal geeignet für:ComicsArchitekturDesignLandschaftsmalereiIllustrationuvm.",
  "price": 220.50,
  "soldamount": 0,
  "searchable": true,
  "searchkeys": "GRAPH'IT \"Brush & Extra fine\", Twin Tip, Marker, Pinselmarker, Pinselstift, Stift, Doppelmarker, Kalligrafie, Twin Marker, 2 Spitzen Maker, Comic, Architektur, Design, Illustration, GRAPH'IT Marker, Set, Komplett-Set, Brushpen, Brush Pen, Sortiment",
  "meta_keywords": "GRAPH'IT \"Brush & Extra fine\", Twin Tip, Marker, Pinselmarker, Pinselstift, Stift, Doppelmarker, Kalligrafie, Twin Marker, 2 Spitzen Maker, Comic, Architektur, Design, Illustration, GRAPH'IT Marker, Set, Komplett-Set, Brushpen, Brush Pen, Sortiment",
  "meta_description": "Das GRAPH'IT \"Brush & Extra fine\" Marker Komplett-Set finden Sie in unserem Onlineshop. \u2713 Marker mit Qualit\u00e4tstinte auf Alkoholbasis und zwei unterschiedlichen Spitzen. \u2713 Ideal f\u00fcr unterschiedlichste Mal- und Zeichentechniken. \u2713 \u00dcberzeugen Sie sich selbst! \u2794 Jetzt g\u00fcnstig online kaufen.",
  "manufacturerid": "f58f91bac483a6ea628e9d2be7a4b1e1",
  "manufacturer_title": "pebeo",
  "url": "https:\/\/demo.makaira.io\/GRAPH-IT-Brush-Extra-fine-Marker-Komplett-Set-Display-mit-96-Markern.html",
  "maincategory": "9fb3ea945468f7c61b471c7401e7bad4",
  "maincategoryurl": "https:\/\/demo.makaira.io\/Zeichnen-Grafik-Design\/",
  "groups": {
    "DISCOUNT80": {
      "price": 2.00,
      "price_no_vat": 1.68
    }
  },
  "category": [
    {
      "catid": "cb38ac47b6005b97cd1bbed61c70fb18",
      "shopid": [
        "4"
      ],
      "path": "shop\/unser-angebot\/grafik-design\/stifte-marker\/copic-layoutmarker\/",
      "title": "Layoutmarker",
      "pos": 9 # Position des Produkts innerhalb der Kategorie
    }
  ],
  "attributes": [
    {
      "d6238d67c4448e37c6bff847b097826e": [
        "Nur Neuheiten anzeigen"
      ],
      "5f65a4212ad959feb266af566d8f3b8f": [
        "Grafik + Design"
      ],
      "852264d68055531b4018323a7d2ba706": [
        "Einsteiger",
        "Schulen",
        "Studenten",
        "Hobbyk\u00fcnstler"
      ],
      "a33c9d88a89257f81eef0f4a001cc365": [
        "Marker + Fineliner"
      ],
      "4c9369a9a485d7ce007f58fa695e5812": [
        "Tinte auf Alkoholbasis"
      ],
      "d8008f87168439ac398f6927cdbd812d": [
        "Set"
      ],
      "6d9b20c89a0ffb28b56bb07ff5bb39ba": [
        "Pinselspitze",
        "metallgefasste Spitze"
      ],
      "76c7e398b67f441fdc9220e11b419945": [
        "0,5 mm"
      ]
    }
  ],
  "attributeStr": [
    {
      "id": "d6238d67c4448e37c6bff847b097826e",
      "title": "Neuheiten",
      "value": "Nur Neuheiten anzeigen"
    },
    {
      "id": "5f65a4212ad959feb266af566d8f3b8f",
      "title": "Empfohlen f\u00fcr Technik",
      "value": ["Grafik + Design", "Einsteiger", "Schulen", "Studenten", "Hobbyk\u00fcnstler"]
    },
    {
      "id": "a33c9d88a89257f81eef0f4a001cc365",
      "title": "Produktart",
      "value": "Marker + Fineliner"
    },
    {
      "id": "4c9369a9a485d7ce007f58fa695e5812",
      "title": "Marker-Basis",
      "value": "Tinte auf Alkoholbasis"
    },
    {
      "id": "d8008f87168439ac398f6927cdbd812d",
      "title": "Auswahl",
      "value": "Set"
    },
    {
      "id": "6d9b20c89a0ffb28b56bb07ff5bb39ba",
      "title": "Form Marker (Spitze)",
      "value": ["Pinselspitze", "metallgefasste Spitze"]
    },
    {
      "id": "76c7e398b67f441fdc9220e11b419945",
      "title": "Strichbreite",
      "value": "0,5 mm"
    }
  ],
  "attributeInt": [],
  "attributeFloat": [],
  "mak_boost_norm_insert": 0.07301991452214238,
  "mak_boost_norm_sold": 0.2763039747051342,
  "mak_boost_norm_rating": 0,
  "mak_boost_norm_revenue": 0.2664841710697083,
  "mak_boost_norm_profit_margin": 0,
  "timestamp": "2019-09-27 15:34:42",
  "additionalData": {}
}

Special features:

parent
- always empty string with products
attributes contains all attributes of the variants, grouped by variant (in the example only one variant exists)
- key: Attribute-ID
- value: List of attribute values (or values separated with unique delimiter - we separate them during import)
- Attributes that are globally available on the product must be specified here once again for each variant.
attributeStr, attributeInt, attributeFloat
- All attributes of the product and variants
- unsorted, one entry per value (or values separated with unique delimiter - we separate them during import)
- depending on the value type into the respective array: String (attributeStr) / Integer (attributeInt) / Float (attributeFloat)
mak_boost_norm*
- Fields with logarithmically normalized values for:
  - Novelty (mak_boost_norm_insert)
  - Number of sales (mak_boost_norm_sold)
  - Rating (mak_boost_norm_rating)
  - Sales (mak_boost_norm_revenue)
  - Margin (mak_boost_norm_profit_margin)

Document type variant (variant)

{
  "id": "10013860005",   "type": "variant",
  "parent": "10013859950",
  "shop": "4",
  "ean": "48690",
  "isVariant": true,
  "active": true,
  "sort": 4001,
  "stock": 10,
  "onstock": true,
  "picture_url_main": "https:\/\/images.makaira.io\/out\/pictures\/generated\/250_250\/pboxx-pixelboxx-2616996\/GRAPH%27IT+%22Brush+%26+Extra+fine%22+Marker+Komplett-Set%2C+Display+mit+96+Markern.jpg",
  "title": "GRAPH'IT \"Brush & Extra fine\" Marker Komplett-Set, Display mit 96 Markern",
  "shortdesc": "Das GRAPH'IT \"Brush & Extra fine\" enth\u00e4lt 96 Marker mit Qualit\u00e4tstinte auf Alkoholbasis und zwei unterschiedlichen Spitzen. Ideal geeignet f\u00fcr unterschiedlichste Mal- und Zeichentechniken.",
  "longdesc": "Das Komplett-Set enthält alle 96 Farbtöne der GRAPH'IT \"Brush & Extra fine\" Marker. Das transparente Display ermöglicht Ihnen jederzeit gute Übersicht und einen schnellen Zugriff zu Ihren Markern.Der GRAPH'IT \"Brush & Extra fine\" Marker verfügt über zwei unterschiedliche Spitzen. Eine lange, flexible Spitze mit synthetischen Pinselfasern, die eine optimale Strömung der Tinte gewährt. Und eine extrafeine 0,5 mm-Spitze mit Metallfassung, die sich insbesondere für Illustrationen eignet.GRAPH'IT \"Brush & Extra fine\" Marker \u2013 Die Produkt-Eigenschaften im ÜberblickKorpus aus weißem Kunststoff mit Dreikantform für hervorragende Haptik und Mal-KomfortQualitätstinte auf AlkoholbasisLeicht zu öffnender Deckel mit Farbcode zur einfachen IdentifizierungDer GRAPH'IT Marker ist ideal geeignet für:ComicsArchitekturDesignLandschaftsmalereiIllustrationuvm.",
  "price": 220,
  "soldamount": 0,
  "searchable": true,
  "searchkeys": "GRAPH'IT \"Brush & Extra fine\", Twin Tip, Marker, Pinselmarker, Pinselstift, Stift, Doppelmarker, Kalligrafie, Twin Marker, 2 Spitzen Maker, Comic, Architektur, Design, Illustration, GRAPH'IT Marker, Set, Komplett-Set, Brushpen, Brush Pen, Sortiment",
  "meta_keywords": "GRAPH'IT \"Brush & Extra fine\", Twin Tip, Marker, Pinselmarker, Pinselstift, Stift, Doppelmarker, Kalligrafie, Twin Marker, 2 Spitzen Maker, Comic, Architektur, Design, Illustration, GRAPH'IT Marker, Set, Komplett-Set, Brushpen, Brush Pen, Sortiment",
  "meta_description": "Das GRAPH'IT \"Brush & Extra fine\" Marker Komplett-Set finden Sie in unserem Onlineshop. \u2713 Marker mit Qualit\u00e4tstinte auf Alkoholbasis und zwei unterschiedlichen Spitzen. \u2713 Ideal f\u00fcr unterschiedlichste Mal- und Zeichentechniken. \u2713 \u00dcberzeugen Sie sich selbst! \u2794 Jetzt g\u00fcnstig online kaufen.",
  "manufacturerid": "f58f91bac483a6ea628e9d2be7a4b1e1",
  "manufacturer_title": "pebeo",
  "url": "https:\/\/demo.makaira.io\/GRAPH-IT-Brush-Extra-fine-Marker-Komplett-Set-Display-mit-96-Markern.html",
  "maincategory": "9fb3ea945468f7c61b471c7401e7bad4",
  "maincategoryurl": "https:\/\/demo.makaira.io\/Zeichnen-Grafik-Design\/",
  "groups": {
    "DISCOUNT80": {
      "price": 2.00,
      "price_no_vat": 1.68
    }
  },
  "category": [
    {
      "catid": "cb38ac47b6005b97cd1bbed61c70fb18",
      "shopid": [
        "4"
      ],
      "path": "shop\/unser-angebot\/grafik-design\/stifte-marker\/copic-layoutmarker\/",
      "title": "Layoutmarker"
    }
  ],
  "attributeStr": [
    {
      "id": "76c7e398b67f441fdc9220e11b419945",
      "title": "Strichbreite",
      "value": "0,5 mm"
    }
  ],
  "attributeInt": [],
  "attributeFloat": [],
  "timestamp": "2019-09-27 15:34:42",
  "additionalData": {}
}

Special features:

parent
- always id of the parent product
attributeStr, attributeInt, attributeFloat
- All attributes of the parent product and the current variant
- unsorted, one entry per value (or values separated with unique delimiter - we separate them during import)
- depending on the value type into the respective array: String (attributeStr) / Integer (attributeInt) / Float (attributeFloat)

Document type Manufacturer (manufacturer)

{
  "id": "f58f91bac483a6ea628e9d2be7a4b1e1",
  "type": "manufacturer",
  "manufacturer_title": "pebeo",
  "shortdesc": "",
  "meta_keywords": "",
  "meta_description": "",
  "timestamp": "2019-09-27 15:34:42",
  "url": "https:\/\/demo.makaira.io\/markenwelt\/pebeo-gs\/",
  "active": true,
  "shop": "4",
  "additionalData": {}
}

Document type category

{
  "id": "ffa7bbaff96b15da5579d99247e981bf",
  "type": "category",
  "active": true,
  "hidden": false,
  "sort": 26,
  "category_title": "Tempera + Gouache Farbe",
  "shortdesc": "",
  "longdesc": "",
  "meta_keywords": "",
  "meta_description": "",
  "hierarchy": "6c52086cb1550335611b759cdf8681bd\/\/baafc2f8b5664298b7fb865762918b32\/\/ffa7bbaff96b15da5579d99247e981bf",
  "depth": 3,
  "subcategories": [],
  "timestamp": "2019-09-27 15:34:42",
  "url": "https:\/\/demo.makaira.io\/farben-hilfsmittel\/kuenstlerfarben\/tempera-gouache-farbe\/",
  "shop": "4",
  "additionalData": {}
}

Special features::

depth
- Starting from the root (depth = 1).
- All categories must be provided, otherwise no category trees can be created
subcategories
- List of all IDs of the subcategories
hierarchy
- the category ids of the category path from the root category to the current category - ids separated by double slash "//"

Mapping of Makaira names to OXID and legacy names

Makaira Name	Makaira Name legacy	Product	Category	Manufacturer
id	-	OXID	OXID	OXID
title	mak_title	OXTITLE	OXTITLE	OXTITLE
searchkeys	mak_searchkeys	OXSEARCHKEYS	custom	custom
category_title	mak_category_title	-	OXTITLE	-
hidden	mak_hidden	-	OXHIDDEN	-
sort	mak_sort	OXSORT	OXSORT	-
active	mak_active	(gesamte Shoplogik für active)
longdesc	mak_longdesc	OXLONGDESC	OXLONGDESC	-
shortdesc	mak_shortdesc	OXSHORTDESC	OXDESC	OXSHORTDESC
onstock	mak_onstock	(gesamte Shoplogik für onstock)	-	-
manufacturerid	mak_manufacturerId	OXMANUFACTURERID	-	-
manufacturer_title		MARM_OXSEARCH_MANUFACTURERTITLE	-	OXTITLE
category_title		-	OXTITLE	-
price	mak_price	OXPRICE	-	-
insert	mak_insert	OXINSERT	-	-
soldamount	mak_soldamount	OXSOLDAMOUNT	-	-
rating	mak_rating	OXRATING	-	-
picture_url_main	mak_pic_main	OXPIC1	-	-
searchable	mak_searchable	OXISSEARCH	-	-
stock	mak_stock	OXSTOCK (OXVARSTOCK)	-	-
ean	mak_ean	OXARTNUM	-	-
maincategory	mainCategory	ID der Hauptkategorie	-	-
maincategoryurl	mainCategoryUrl	Seo URL der Hauptkategorie	-	-

Setup

Configuration

OXID modules version differences

Overrides in the OXID eShop

Modifier (OXID)

Templating

Templating in OXID eShop

Data manipulation in OXID eShop

Sorting in OXID eShop

Unsupported features

NDJSON-Import

NDJSON-Import

Document type product (product)

Document type variant (variant)

Document type Manufacturer (manufacturer)

Document type category

Mapping of Makaira names to OXID and legacy names