This is a html view of the json schema please take the json schema as reference DOWNLOAD THE JSON SCHEMA

Categories

Type: array

This array should contains all categories. We must have one and only one root category (where the parentNode is not present), this category will not be displayed into front but need to have the order of L0 categories.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

CategoryNode

Type: object

This is a recursive element and can hold categories, sub-categories

UPSERT

Type: object

The UPSERT action adds or update a category

Type: string

Unique identifier for this node


Example:

"S07SF070301"

Multilingual Object

Type: object

The title of this Categorisation node


Example:

{
    "fr-BE": "SYSTÈMES DE SUPPORT DE CÂBLES",
    "nl-BE": "KABELDRAAGSYSTEMEN"
}

Each additional property must conform to the following schema

Type: string

Multilingual Object

Type: object

A simple text description that will be displayed into the PLP of this category


Example:

{
    "fr-BE": "SYSTÈMES DE SUPPORT DE CÂBLES",
    "nl-BE": "KABELDRAAGSYSTEMEN"
}

Each additional property must conform to the following schema

Type: string

Multilingual Object

Type: object

A simple text that will be used for meta(title) of the PLP of this category for the SEO purpose


Example:

{
    "fr-BE": "SYSTÈMES DE SUPPORT DE CÂBLES",
    "nl-BE": "KABELDRAAGSYSTEMEN"
}

Each additional property must conform to the following schema

Type: string

Multilingual Object

Type: object

A simple text that will be used for meta(description) of the PLP of this category for the SEO purpose


Example:

{
    "fr-BE": "SYSTÈMES DE SUPPORT DE CÂBLES",
    "nl-BE": "KABELDRAAGSYSTEMEN"
}

Each additional property must conform to the following schema

Type: string

Type: enum (of string) Default: "UPSERT"

Action defines if the category has to be added/updated or deleted.
- While sending action equals delete categories, only code (categoryId) is required and title can be ignored
Before deleting a category:
- all references to this category as parentNode or childNodes should be updated by the OpCo.
- all products related to this category or one of childNodes should be moved by the OpCo to the right category.
Deleting a category will not update the search index. The right sequence when changing categories structure, will be to:
- add new categories
- update categories parentNode or childNodes
- update products affected by those changes
- delete categories after previous changes applied to the search engine
- While sending action equals delete categories, only code (categoryId) is required and title can be ignored

Must be one of:

  • "UPSERT"
  • "DELETE"

Type: string

The code of the parent node. The root node of categories tree should not have this attribute


Example:

"S07SF070301"

Type: array of string

list of code of child node

No Additional Items

Each item of this array must be:


Example:

[
    "S07SF070302",
    "S07SF070303"
]

Type: object

Type: enum (of string) Default: "OPCO_ONLY"

Define the scope of this category. A category can be used,
- only by sellers of the marketplace
- only by the opco
- by the marketplace sellers and the opco.

Must be one of:

  • "MARKETPLACE_ONLY"
  • "OPCO_ONLY"
  • "OPCO_AND_MARKETPLACE"

DELETE

Type: object

The DELETE action deletes a category, only its code is required.

Type: const
Specific value: "DELETE"

Type: string

Unique identifier for this node


Example:

"S07SF070301"

Examples:

{
    "code": "code1",
    "title": {
        "en-GB": "Root category without parent"
    },
    "childNode": [
        "code3",
        "code4"
    ]
}
{
    "code": "code2",
    "title": {
        "en-GB": "Intermediate category with parent and children"
    },
    "parentNode": "code1",
    "childNode": [
        "code3",
        "code4"
    ],
    "search": {
        "autoSuggest": true
    },
    "marketplace": {
        "scope": "MARKETPLACE_ONLY"
    }
}
{
    "code": "code4",
    "title": {
        "en-GB": "Leaf category with parent but without children"
    },
    "parentNode": "code2",
    "search": {
        "autoSuggest": false,
        "alternateText": {
            "fr-BE": "Lampe",
            "nl-BE": "Lamp"
        }
    }
}