Products Taxonomy

root root items

Either a feature or valueType to be added/updated or deleted

No Additional Properties

All of

UPSERT or DELETE

root root items allOf UPSERT or DELETE

UPSERT or DELETE

Action can be UPSERT (default if not present) or DELETE

One of

UPSERT
DELETE

root root items allOf UPSERT or DELETE oneOf UPSERT

UPSERT

Type: object

if action is UPSERT (or not present) then the feature or valueList is to be added/updated

root root items allOf UPSERT or DELETE oneOf UPSERT action

Type: enum (of string)

Must be one of:

"UPSERT"

root root items allOf UPSERT or DELETE oneOf UPSERT feature

Type: object
No Additional Properties

Example:

{
    "categories": [
        {
            "categoryCode": "SCC060101",
            "rank": 19,
            "requirementLevel": "OPTIONAL"
        },
        {
            "categoryCode": "SCC060107",
            "rank": 17,
            "requirementLevel": "OPTIONAL"
        }
    ],
    "code": "EF016286",
    "name": {
        "fr-BE": "appareil de commande échangeable"
    }
}

root root items allOf UPSERT or DELETE oneOf UPSERT feature code

Type: string

Unique identifier of the taxonomy feature to be upserted. It is used to manage (update/delete) this feature and is displayed on the marketplace backend.

Examples:

"designation_de_lampe"

"EF016286"

root root items allOf UPSERT or DELETE oneOf UPSERT feature name

Multilingual Object

Type: object

The name of the taxonomy feature. It is used on spark front-end as the feature label.

No Additional Properties

Example:

{
    "fr-BE": "Désignation de lampe",
    "nl-BE": "Lampaanduiding"
}

Pattern Property

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]{2}-[A-Z]{2}$

root root items allOf UPSERT or DELETE oneOf UPSERT feature name ^[a-z]{2}-[A-Z]{2}$

Type: string

root root items allOf UPSERT or DELETE oneOf UPSERT feature categories

Type: array of object

The list of categories to which this taxonomy feature is attached. It should be the full list of categories, partial update is not supported

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root root items allOf UPSERT or DELETE oneOf UPSERT feature categories categories items

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature categories categories items categoryCode

Type: string

Unique identifier of the category to which this taxonomy feature is attached

Example:

"S07SF070301"

root root items allOf UPSERT or DELETE oneOf UPSERT feature categories categories items rank

Type: integer

Rank of this feature in this category.
Needs to be unique per category (no two features can share the same rank for a given category).
Used as the ordering criteria for the top essential specifications of a product and also as the feature order in the marketplace backend.

Example:

root root items allOf UPSERT or DELETE oneOf UPSERT feature categories categories items requirementLevel

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

Requirement level of this feature in the taxonomy for this category (and its children).
- REQUIRED: this feature is required
- RECOMMENDED: this feature is strongly advised but a product would still be valid without it
- OPTIONAL: this feature is optional
- DISABLED: this feature is not a valid

Must be one of:

"REQUIRED"
"RECOMMENDED"
"OPTIONAL"
"DISABLED"

Example:

"RECOMMENDED"

root root items allOf UPSERT or DELETE oneOf UPSERT feature miraklRoles

Type: array of string

List of roles as defined in mirakl

No Additional Items

Each item of this array must be:

root root items allOf UPSERT or DELETE oneOf UPSERT feature miraklRoles miraklRoles items

root root items allOf UPSERT or DELETE oneOf UPSERT feature miraklRoles miraklRoles items oneOf item 0

Type: enum (of string)

Must be one of:

"BRAND"
"CATEGORY"
"DESCRIPTION"
"MAIN_IMAGE"
"SHOP_SKU"
"TITLE"
"VARIANT_GROUPE_CODE"
"TOTAL_MEASUREMENT_OF_PRODUCT"

root root items allOf UPSERT or DELETE oneOf UPSERT feature miraklRoles miraklRoles items oneOf item 1

Type: object
Must match regular expression: ^UNIQUE_IDENTIFIER\|.*$

Examples:

"BRAND"

"TITLE"

"UNIQUE_IDENTIFIER|GTIN"

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping

Type: array
No Additional Items

Each item of this array must be:

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping SingleValueSparkMapping

Type: object

Defines how to map this feature to spark model.

One of

Option 1
Option 2

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0

Either a strongly typed role in the spark model

One of

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 oneOf item 0

Type: object

Fields of type array

No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 oneOf item 0 role

Type: enum (of string)

Must be one of:

"categories"

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 oneOf item 0 order

Type: object

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 oneOf item 1

Type: object

Fields of type array and are multilingual

No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 oneOf item 1 role

Type: enum (of string)

Must be one of:

"identifier.keywords"
"description.additionalInfo"
"description.specialInstructions"
"description.legalDisclaimer"
"assets.images"
"assets.documents"
"assets.weblinks"
"assets.videos"

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 oneOf item 1 order

Type: object

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 oneOf item 1 lang

Type: object

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 oneOf item 2

Type: object

Fields of type string

No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 oneOf item 2 role

Type: enum (of string)

Must be one of:

"opcoId"
"identifier.opcoProductId"
"identifier.manufacturerRefId"
"identifier.manufacturerReference"
"identifier.manufacturerName"
"identifier.brandName"
"identifier.gtin"
"identifier.stockIndicator"
"identifier.customProductId1"
"identifier.customProductId2"
"identifier.customProductId3"
"identifier.customProductId4"
"identifier.customProductId5"

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 oneOf item 3

Type: object

Fields of type string which are multilingual

No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 oneOf item 3 role

Type: enum (of string)

Must be one of:

"identifier.productTitle"
"description.longDescription"
"description.erpShortDescription"

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 oneOf item 3 lang

Type: object

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 role

Type: string

The actual spark role to map this feature to

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 0 order

Type: integer Default: 0

The 0 based order of this attribute. Used when multiple mirakl attributes are mapped to the same spark field. The order is not strict and any gaps in the sequence should be ignored, ex: if there are 3 attributes with the orders [A:2, B:5, C:4] they are mapped to the spark array as [A,C,B]

Value must be greater or equal to 0

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1

Or a loosely typed feature which can optionally be hidden

One of

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 oneOf item 0

Type: object

A loosely typed feature, not hidden.
The 'lang', 'unit' and 'code' properties tells spark which lang, unit and code to use when mapping this feature from mirakl to spark model.

No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 oneOf item 0 lang

Type: object

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 oneOf item 0 unit

Type: object

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 oneOf item 0 code

Type: object

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 oneOf item 1

Type: object

A loosely typed feature, hidden. As such there is no need for hidden features to be internationalized and the 'lang' property is not used

No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 oneOf item 1 isHidden

Type: object

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 oneOf item 2

Type: object

A loosely typed feature which should be ignored by spark during product synchronization

No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 oneOf item 2 isIgnored

Type: object

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 isIgnored

Type: boolean Default: false

True if this feature should be ignored by spark during synchronization

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 isHidden

Type: boolean

True if this feature should be hidden from spark front end. These are used to 'silently' forward attributes from Sellers to the OpCo about a given product.

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 lang

Type: object

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 unit

Type: object

This loosely typed feature is a unit on spark side. Contains the unit to be used on the conversion back to spark

Example:

{
    "value": {
        "fr-FR": "V",
        "en-US": "V"
    }
}

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 unit value

Multilingual Object

Type: object

This object is used to describe the translation of a text field. The key is the locale in IETF BCP 47 format (with 2 letters from ISO 639 set 1 language code, and 2 letters from ISO 3166-1 alpha-2 region code), the value is the translation for this locale

No Additional Properties

Example:

{
    "de-CH": "ein Text in Schweizerdeutsch",
    "fr-CH": "un texte en français suisse"
}

Pattern Property

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]{2}-[A-Z]{2}$

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 unit value ^[a-z]{2}-[A-Z]{2}$

Type: string

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items oneOf item 1 code

Type: string

This loosely typed feature is to be mapped to a spark feature with this 'code'.
It should only be used to overcome the lack of internationalized values on mirakl side.

root root items allOf UPSERT or DELETE oneOf UPSERT feature sparkMapping sparkMapping items lang

Type: string

The locale, in IETF BCP 47 format (with 2 letters from ISO 639 set 1 language code, and 2 letters from ISO 3166-1 alpha-2 region code) to be used for this attribute when mapped between mirakl and spark. If not present the default opco locale is used.

Must match regular expression: ^[a-z]{2}-[A-Z]{2}$

Examples:

"fr-FR"

"en-GB"

root root items allOf UPSERT or DELETE oneOf UPSERT feature description

Multilingual Object

Type: object

Additional details of the taxonomy feature, this can be used on spark front-end as a more verbose description of a feature

No Additional Properties

Example:

{
    "fr-BE": "Autre",
    "nl-BE": "Overig"
}

Pattern Property

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]{2}-[A-Z]{2}$

root root items allOf UPSERT or DELETE oneOf UPSERT feature description ^[a-z]{2}-[A-Z]{2}$

Type: string

root root items allOf UPSERT or DELETE oneOf UPSERT feature type

Type: object Default: {"text": {}}

Defines the type of a feature

No Additional Properties

One of

root root items allOf UPSERT or DELETE oneOf UPSERT feature type oneOf text

text

Type: object

The following properties are required:

text

root root items allOf UPSERT or DELETE oneOf UPSERT feature type oneOf media

media

Type: object

The following properties are required:

media

root root items allOf UPSERT or DELETE oneOf UPSERT feature type oneOf number

number

Type: object

The following properties are required:

number

root root items allOf UPSERT or DELETE oneOf UPSERT feature type oneOf date

date

Type: object

The following properties are required:

date

root root items allOf UPSERT or DELETE oneOf UPSERT feature type oneOf valueList

valueList

Type: object

The following properties are required:

valueList

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text isLong

Type: boolean

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations

Type: array of object

List of all validations which are enforced by mirakl on a text attribute

No Additional Items

Each item of this array must be:

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items

A mirakl validation

One of

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf ValidationMinLength

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf item 0 minLength

Type: integer

Minimum length of this text field

Value must be greater or equal to 0

Example:

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf ValidationMaxLength

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf item 1 maxLength

Type: integer

Maximum length of this text field

Value must be greater or equal to 0

Example:

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf ValidationRegExp

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf item 2 regExp

Type: string

Expression must match this regexp

Example:

"^[0-9]{8}$"

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf ValidationProductReference

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf item 3 productReference

Type: array of enum (of string)

A list of valid product reference type this field can hold

No Additional Items

Each item of this array must be:

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf item 3 productReference productReference items

Type: enum (of string)

Must be one of:

"EAN-8"
"UPC"
"EAN-13"
"EAN-14"
"ISBN-10"
"ISBN-13"

Example:

[
    "EAN-14"
]

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf ValidationForbiddenWords

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf item 4 forbiddenWords

Type: array of string

A list of forbidden words. Value matching ignores case and accents.

No Additional Items

Each item of this array must be:

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf item 4 forbiddenWords forbiddenWords items

Type: string

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf ValidationScript

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text validations validations items oneOf item 5 script

Type: string

A mirakl validation script, see https://help.mirakl.net/bundle/customers/page/topics/Mirakl/mci/Operator/catalogstructcreation/bo/defineattributes/defineattribute_rules/validations.html

Example:

"if ((context.data['description-fr_FR'] && context.data['description-fr_FR'].length > 0) ||\n    (context.data['description-en_GB'] && context.data['description-en_GB'].length > 0) ||\n    (context.data['description-de_DE'] && context.data['description-de_DE'].length > 0)) {\n    result.valid = true;\n} else {\n    result.valid   = false;\n    result.message = 'The description must be filled in at least 1 language (French or English or German)';\n}"

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text i18n

Internationalised

Type: object

It represents a feature of type text with internationalised values. To overcome mirakl lack of such attribute type, by default, spark automatically creates one per lang provided on the name attribute, with the following properties:
- code: {feature.code}-{lang}
- name: {feature.name} [{lang}]
- sparkMapping: [{ 'lang': '{lang}', 'code': '{code}']

This behavior can be customised using the fields below, however it is advised to leave this object empty and rely on the default logic.

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text i18n miraklFeatureCodes

Type: object

Optional list of feature code per lang for which this feature needs to be localised, this allows to define, per mirakl feature, properties such as having different validation per lang

Example:

{
    "fr-FR": "feature1-fr-FR",
    "en-GB": "feautre1-en-GB"
}

Each additional property must conform to the following schema

root root items allOf UPSERT or DELETE oneOf UPSERT feature type text i18n miraklFeatureCodes additionalProperties

Type: string

Feature code to be used for this locale.

root root items allOf UPSERT or DELETE oneOf UPSERT feature type media

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type media type

Type: enum (of string)

Must be one of:

"DOCUMENT"
"IMAGE"
"VIDEO"

root root items allOf UPSERT or DELETE oneOf UPSERT feature type media maxSize

Type: integer

Max size of the media in kb

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number

One of

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number oneOf item 0

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number oneOf item 0 precision

Type: object

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number oneOf item 1

Type: object

The following properties are required:

gs1UnitCode

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number oneOf item 2

Type: object

The following properties are required:

miraklUnitCode

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number precision

Type: integer

Maximum number of decimals allowed. Optional, default is 0.

Value must be greater or equal to 0

Example:

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number gs1UnitCode

Type: enum (of string)

Defines the unit code as per the GS1 standard (PCE, MTR, etc.). https://resources.gs1us.org/GS1-US-Data-Hub-Help-Center/ArtMID/3451/ArticleID/116/Unit-of-Measure-Codes.

Must be one of:

"FOT"
"PCE"
"MTR"
"KGM"
"CMT"
"LTR"
"EA"
"MTK"
"PK"
"MTQ"
"TN"
"MLT"

Example:

"KGM"

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number miraklUnitCode

Type: enum (of string)

Defines the unit code as per the list supported in mirakl

Must be one of:

"SQUARE_MILLIMETER"
"SQUARE_CENTIMETER"
"SQUARE_DECIMETER"
"SQUARE_METER"
"CENTIARE"
"SQUARE_DECAMETER"
"ARE"
"SQUARE_HECTOMETER"
"HECTARE"
"SQUARE_KILOMETER"
"SQUARE_MIL"
"SQUARE_INCH"
"SQUARE_FOOT"
"SQUARE_YARD"
"ARPENT"
"ACRE"
"SQUARE_FURLONG"
"SQUARE_MILE"
"MICROMETER"
"NAUTICAL_MILE"
"MILLIMETER"
"CENTIMETER"
"DECIMETER"
"METER"
"DECAMETER"
"HECTOMETER"
"KILOMETER"
"MIL"
"INCH"
"FEET"
"YARD"
"CHAIN"
"FURLONG"
"MILE"
"CHAR"
"KILOBIT"
"MEGABIT"
"GIGABIT"
"BIT"
"BYTE"
"KILOBYTE"
"MEGABYTE"
"GIGABYTE"
"TERABYTE"
"MICROLITER"
"HECTOLITER"
"CUBIC_MILLIMETER"
"CUBIC_CENTIMETER"
"MILLILITER"
"CENTILITER"
"DECILITER"
"CUBIC_DECIMETER"
"LITER"
"CUBIC_METER"
"FLUID_OUNCE"
"PINT"
"BARREL"
"GALLON"
"CUBIC_FOOT"
"CUBIC_INCH"
"CUBIC_YARD"
"MILLIGRAM"
"GRAM"
"KILOGRAM"
"TON"
"GRAIN"
"OUNCE"
"POUND"
"CENTIBAR"
"DECIBAR"
"KILOBAR"
"MEGABAR"
"KILOPASCAL"
"MEGAPASCAL"
"GIGAPASCAL"
"BAR"
"PASCAL"
"HECTOPASCAL"
"MILLIBAR"
"ATM"
"PSI"
"TORR"
"MMHG"
"CUBIC_METER_PER_SECOND"
"CUBIC_METER_PER_MINUTE"
"CUBIC_METER_PER_HOUR"
"CUBIC_METER_PER_DAY"
"MILLILITER_PER_SECOND"
"MILLILITER_PER_MINUTE"
"MILLILITER_PER_HOUR"
"MILLILITER_PER_DAY"
"CUBIC_CENTIMETER_PER_SECOND"
"CUBIC_CENTIMETER_PER_MINUTE"
"CUBIC_CENTIMETER_PER_HOUR"
"CUBIC_CENTIMETER_PER_DAY"
"CUBIC_DECIMETER_PER_MINUTE"
"CUBIC_DECIMETER_PER_HOUR"
"LITER_PER_SECOND"
"LITER_PER_MINUTE"
"LITER_PER_HOUR"
"LITER_PER_DAY"
"KILOLITER_PER_HOUR"
"DECIBEL"
"HERTZ"
"KILOHERTZ"
"MEGAHERTZ"
"GIGAHERTZ"
"TERAHERTZ"
"WATT"
"KILOWATT"
"KILOWATTHOUR"
"MEGAWATT"
"GIGAWATT"
"TERAWATT"
"MILLIVOLT"
"CENTIVOLT"
"DECIVOLT"
"VOLT"
"DECAVOLT"
"HECTOVOLT"
"KILOVOLT"
"MILLIAMPERE"
"CENTIAMPERE"
"DECIAMPERE"
"AMPERE"
"DECAMPERE"
"HECTOAMPERE"
"KILOAMPERE"
"MILLIOHM"
"CENTIOHM"
"DECIOHM"
"OHM"
"DECAOHM"
"HECTOHM"
"KILOHM"
"MEGOHM"
"METER_PER_SECOND"
"METER_PER_MINUTE"
"METER_PER_HOUR"
"KILOMETER_PER_HOUR"
"FOOT_PER_SECOND"
"FOOT_PER_HOUR"
"YARD_PER_HOUR"
"MILE_PER_HOUR"
"MILLIAMPEREHOUR"
"AMPEREHOUR"
"MILLICOULOMB"
"CENTICOULOMB"
"DECICOULOMB"
"COULOMB"
"DECACOULOMB"
"HECTOCOULOMB"
"KILOCOULOMB"
"MILLISECOND"
"SECOND"
"MINUTE"
"HOUR"
"DAY"
"WEEK"
"MONTH"
"YEAR"
"CELSIUS"
"FAHRENHEIT"
"KELVIN"
"RANKINE"
"REAUMUR"
"JOULE"
"CALORIE"
"KILOCALORIE"
"KILOJOULE"
"PIECE"
"DOZEN"
"LUMEN"
"NIT"
"MILLINEWTON"
"NEWTON"
"KILONEWTON"
"MEGANEWTON"
"RADIAN"
"MILLIRADIAN"
"MICRORADIAN"
"DEGREE"
"ANGLE_MINUTE"
"ANGLE_SECOND"
"GON"
"REVOLUTION"
"ATTOFARAD"
"PICOFARAD"
"NANOFARAD"
"MICROFARAD"
"MILLIFARAD"
"FARAD"
"KILOFARAD"

Example:

"KILOGRAM"

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number validations

Type: array of object

List of all validations which are enforced by mirakl on a text attribute

No Additional Items

Each item of this array must be:

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number validations validations items

A mirakl validation

One of

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number validations validations items oneOf ValidationMin

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number validations validations items oneOf item 0 min

Type: number

Minimum value of this numeric field

Examples:

-5.05

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number validations validations items oneOf ValidationMax

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number validations validations items oneOf item 1 max

Type: number

Maximum value of this numeric field

Examples:

-5.05

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number validations validations items oneOf ValidationScript

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type number validations validations items oneOf item 2 script

Type: string

A mirakl validation script, see https://help.mirakl.net/bundle/customers/page/topics/Mirakl/mci/Operator/catalogstructcreation/bo/defineattributes/defineattribute_rules/validations.html

Example:

"if ((context.data['description-fr_FR'] && context.data['description-fr_FR'].length > 0) ||\n    (context.data['description-en_GB'] && context.data['description-en_GB'].length > 0) ||\n    (context.data['description-de_DE'] && context.data['description-de_DE'].length > 0)) {\n    result.valid = true;\n} else {\n    result.valid   = false;\n    result.message = 'The description must be filled in at least 1 language (French or English or German)';\n}"

root root items allOf UPSERT or DELETE oneOf UPSERT feature type date

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type date pattern

Type: string

root root items allOf UPSERT or DELETE oneOf UPSERT feature type valueList

Type: object
No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type valueList code

Type: string

root root items allOf UPSERT or DELETE oneOf UPSERT feature type valueList multiple

Type: boolean Default: false

root root items allOf UPSERT or DELETE oneOf UPSERT feature type valueList defaults

Type: array of string

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root root items allOf UPSERT or DELETE oneOf UPSERT feature type valueList defaults defaults items

Type: string

root root items allOf UPSERT or DELETE oneOf UPSERT feature type valueList isVariant

Type: boolean Default: false

Indicates whether the attribute is variant. Product variants are variations of a product such as the color or the size of a dress.

root root items allOf UPSERT or DELETE oneOf UPSERT feature type valueList validations

Type: array of object

List of all validations which are enforced by mirakl on a text attribute

No Additional Items

Each item of this array must be:

root root items allOf UPSERT or DELETE oneOf UPSERT feature type valueList validations ValidationScript

Type: object

A mirakl validation

No Additional Properties

root root items allOf UPSERT or DELETE oneOf UPSERT feature type valueList validations validations items script

Type: string

A mirakl validation script, see https://help.mirakl.net/bundle/customers/page/topics/Mirakl/mci/Operator/catalogstructcreation/bo/defineattributes/defineattribute_rules/validations.html

Example:

"if ((context.data['description-fr_FR'] && context.data['description-fr_FR'].length > 0) ||\n    (context.data['description-en_GB'] && context.data['description-en_GB'].length > 0) ||\n    (context.data['description-de_DE'] && context.data['description-de_DE'].length > 0)) {\n    result.valid = true;\n} else {\n    result.valid   = false;\n    result.message = 'The description must be filled in at least 1 language (French or English or German)';\n}"

root root items allOf UPSERT or DELETE oneOf UPSERT valueList

Type: object

A list of allowed values for a feature

No Additional Properties

Example:

{
    "values": [
        {
            "code": "EV000072",
            "value": {
                "fr-BE": "aluminium",
                "en-GB": "aluminium"
            }
        },
        {
            "code": "EV000080",
            "value": {
                "fr-BE": "bleu",
                "en-GB": "blue"
            }
        }
    ],
    "label": {
        "fr-BE": "Couleur",
        "en-GB": "Colour"
    },
    "code": "VL_EC000005_EF000007"
}

root root items allOf UPSERT or DELETE oneOf UPSERT valueList code

Type: string

Unique identifier of the value list to be upserted. It is used to manage (update/delete) this value list and is displayed on the marketplace backend.

Examples:

"VL_EC000005_EF000007"

"a_unique_valuelist_code_009"

root root items allOf UPSERT or DELETE oneOf UPSERT valueList values

Type: array

Only the values declared in this list are allowed for the features associated to this value type

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root root items allOf UPSERT or DELETE oneOf UPSERT valueList values TaxonomyFeatureValueListItem

Type: object

A specific item in a value list, it defines the label of this value and an optional code

Example:

{
    "code": "EV000080",
    "value": {
        "fr-BE": "bleu",
        "en-GB": "blue"
    }
}

root root items allOf UPSERT or DELETE oneOf UPSERT valueList values values items value

Multilingual Object

Type: object

No Additional Properties

Example:

{
    "de-CH": "ein Text in Schweizerdeutsch",
    "fr-CH": "un texte en français suisse"
}

Pattern Property

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]{2}-[A-Z]{2}$

root root items allOf UPSERT or DELETE oneOf UPSERT valueList values values items value ^[a-z]{2}-[A-Z]{2}$

Type: string

root root items allOf UPSERT or DELETE oneOf UPSERT valueList values values items code

Type: string

The value list item code. It is a unique code for this value list item entry. Not used by spark but sent to the marketplace backend, it can be used by sellers for automated value list item mapping with their own catalog

Example:

"EV000072"

Example:

[
    {
        "code": "EV000072",
        "value": {
            "fr-BE": "aluminium",
            "en-GB": "aluminium"
        }
    },
    {
        "code": "EV000080",
        "value": {
            "fr-BE": "bleu",
            "en-GB": "blue"
        }
    }
]

root root items allOf UPSERT or DELETE oneOf UPSERT valueList label

Multilingual Object

Type: object

Optional value list label as displayed in mirakl backend

No Additional Properties

Example:

{
    "de-CH": "ein Text in Schweizerdeutsch",
    "fr-CH": "un texte en français suisse"
}

Pattern Property

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]{2}-[A-Z]{2}$

root root items allOf UPSERT or DELETE oneOf UPSERT valueList label ^[a-z]{2}-[A-Z]{2}$

Type: string

root root items allOf UPSERT or DELETE oneOf UPSERT valueList separator

Multilingual Object

Type: object

Optional separator to be used by spark when building the string representation of this value list.
Default value is , for any locale.
Empty separator values are supported and simply concatenates values together with no separator.

No Additional Properties

Example:

{
    "fr-FR": ", ",
    "en-GB": " - "
}

Pattern Property

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]{2}-[A-Z]{2}$

root root items allOf UPSERT or DELETE oneOf UPSERT valueList separator ^[a-z]{2}-[A-Z]{2}$

Type: string

root root items allOf UPSERT or DELETE oneOf DELETE

DELETE

Type: object

if action is DELETE then the feature or valueList is to be deleted

root root items allOf UPSERT or DELETE oneOf DELETE action

Type: enum (of string)

Must be one of:

"DELETE"

root root items allOf UPSERT or DELETE oneOf DELETE feature

Type: object

A wrapper of the field needed to delete a taxonomy feature

No Additional Properties

Example:

{
    "code": "EF016286"
}

root root items allOf UPSERT or DELETE oneOf DELETE feature code

Type: string

The code of the taxonomy feature to be removed

Examples:

"designation_de_lampe"

"EF016286"

root root items allOf UPSERT or DELETE oneOf DELETE valueList

Type: object

A wrapper for the field needed to delete a value list

No Additional Properties

Example:

{
    "code": "VL_EU570448"
}

root root items allOf UPSERT or DELETE oneOf DELETE valueList code

Type: string

The code of the value type to be removed

Examples:

"VL_EU570448"

"a_unique_valuetype_code_009"

root root items allOf

An item is either a feature or a valueList (but only one at a time)

One of

Option 1
Option 2

root root items allOf oneOf item 0

Type: object

The following properties are required:

feature

root root items allOf oneOf item 1

Type: object

The following properties are required:

valueList

root root items action

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

Action defines if the feature or valueType has to be added/updated or deleted

Must be one of:

"UPSERT"
"DELETE"

Examples:

"UPSERT"

"DELETE"

root root items feature

Feature describes the feature to be added/updated or deleted

Any of

TaxonomyFeature
DeleteTaxonomyFeature

root root items feature anyOf TaxonomyFeature

Type: object
No Additional Properties

Example:

{
    "categories": [
        {
            "categoryCode": "SCC060101",
            "rank": 19,
            "requirementLevel": "OPTIONAL"
        },
        {
            "categoryCode": "SCC060107",
            "rank": 17,
            "requirementLevel": "OPTIONAL"
        }
    ],
    "code": "EF016286",
    "name": {
        "fr-BE": "appareil de commande échangeable"
    }
}

root root items feature anyOf item 0 code

Type: string

Unique identifier of the taxonomy feature to be upserted. It is used to manage (update/delete) this feature and is displayed on the marketplace backend.

Examples:

"designation_de_lampe"

"EF016286"

root root items feature anyOf item 0 name

Multilingual Object

Type: object

The name of the taxonomy feature. It is used on spark front-end as the feature label.

No Additional Properties

Example:

{
    "fr-BE": "Désignation de lampe",
    "nl-BE": "Lampaanduiding"
}

Pattern Property

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]{2}-[A-Z]{2}$

root root items feature anyOf item 0 name ^[a-z]{2}-[A-Z]{2}$

Type: string

root root items feature anyOf item 0 categories

Type: array of object

The list of categories to which this taxonomy feature is attached. It should be the full list of categories, partial update is not supported

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root root items feature anyOf item 0 categories categories items

Type: object
No Additional Properties

root root items feature anyOf item 0 categories categories items categoryCode

Type: string

Unique identifier of the category to which this taxonomy feature is attached

Example:

"S07SF070301"

root root items feature anyOf item 0 categories categories items rank

Type: integer

Example:

root root items feature anyOf item 0 categories categories items requirementLevel

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

Must be one of:

"REQUIRED"
"RECOMMENDED"
"OPTIONAL"
"DISABLED"

Example:

"RECOMMENDED"

root root items feature anyOf item 0 miraklRoles

Type: array of string

List of roles as defined in mirakl

No Additional Items

Each item of this array must be:

root root items feature anyOf item 0 miraklRoles miraklRoles items

One of

Option 1
Option 2

root root items feature anyOf item 0 miraklRoles miraklRoles items oneOf item 0

Type: enum (of string)

Must be one of:

"BRAND"
"CATEGORY"
"DESCRIPTION"
"MAIN_IMAGE"
"SHOP_SKU"
"TITLE"
"VARIANT_GROUPE_CODE"
"TOTAL_MEASUREMENT_OF_PRODUCT"

root root items feature anyOf item 0 miraklRoles miraklRoles items oneOf item 1

Type: object
Must match regular expression: ^UNIQUE_IDENTIFIER\|.*$

Examples:

"BRAND"

"TITLE"

"UNIQUE_IDENTIFIER|GTIN"

root root items feature anyOf item 0 sparkMapping

Type: array
No Additional Items

Each item of this array must be:

root root items feature anyOf item 0 sparkMapping SingleValueSparkMapping

Type: object

Defines how to map this feature to spark model.

One of

Option 1
Option 2

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0

Either a strongly typed role in the spark model

One of

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 oneOf item 0

Type: object

Fields of type array

No Additional Properties

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 oneOf item 0 role

Type: enum (of string)

Must be one of:

"categories"

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 oneOf item 0 order

Type: object

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 oneOf item 1

Type: object

Fields of type array and are multilingual

No Additional Properties

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 oneOf item 1 role

Type: enum (of string)

Must be one of:

"identifier.keywords"
"description.additionalInfo"
"description.specialInstructions"
"description.legalDisclaimer"
"assets.images"
"assets.documents"
"assets.weblinks"
"assets.videos"

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 oneOf item 1 order

Type: object

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 oneOf item 1 lang

Type: object

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 oneOf item 2

Type: object

Fields of type string

No Additional Properties

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 oneOf item 2 role

Type: enum (of string)

Must be one of:

"opcoId"
"identifier.opcoProductId"
"identifier.manufacturerRefId"
"identifier.manufacturerReference"
"identifier.manufacturerName"
"identifier.brandName"
"identifier.gtin"
"identifier.stockIndicator"
"identifier.customProductId1"
"identifier.customProductId2"
"identifier.customProductId3"
"identifier.customProductId4"
"identifier.customProductId5"

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 oneOf item 3

Type: object

Fields of type string which are multilingual

No Additional Properties

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 oneOf item 3 role

Type: enum (of string)

Must be one of:

"identifier.productTitle"
"description.longDescription"
"description.erpShortDescription"

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 oneOf item 3 lang

Type: object

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 role

Type: string

The actual spark role to map this feature to

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 0 order

Type: integer Default: 0

Value must be greater or equal to 0

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1

Or a loosely typed feature which can optionally be hidden

One of

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 oneOf item 0

Type: object

A loosely typed feature, not hidden.
The 'lang', 'unit' and 'code' properties tells spark which lang, unit and code to use when mapping this feature from mirakl to spark model.

No Additional Properties

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 oneOf item 0 lang

Type: object

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 oneOf item 0 unit

Type: object

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 oneOf item 0 code

Type: object

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 oneOf item 1

Type: object

A loosely typed feature, hidden. As such there is no need for hidden features to be internationalized and the 'lang' property is not used

No Additional Properties

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 oneOf item 1 isHidden

Type: object

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 oneOf item 2

Type: object

A loosely typed feature which should be ignored by spark during product synchronization

No Additional Properties

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 oneOf item 2 isIgnored

Type: object

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 isIgnored

Type: boolean Default: false

True if this feature should be ignored by spark during synchronization

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 isHidden

Type: boolean

True if this feature should be hidden from spark front end. These are used to 'silently' forward attributes from Sellers to the OpCo about a given product.

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 lang

Type: object

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 unit

Type: object

This loosely typed feature is a unit on spark side. Contains the unit to be used on the conversion back to spark

Example:

{
    "value": {
        "fr-FR": "V",
        "en-US": "V"
    }
}

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 unit value

Multilingual Object

Type: object

No Additional Properties

Example:

{
    "de-CH": "ein Text in Schweizerdeutsch",
    "fr-CH": "un texte en français suisse"
}

Pattern Property

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]{2}-[A-Z]{2}$

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 unit value ^[a-z]{2}-[A-Z]{2}$

Type: string

root root items feature anyOf item 0 sparkMapping sparkMapping items oneOf item 1 code

Type: string

This loosely typed feature is to be mapped to a spark feature with this 'code'.
It should only be used to overcome the lack of internationalized values on mirakl side.

root root items feature anyOf item 0 sparkMapping sparkMapping items lang

Type: string

Must match regular expression: ^[a-z]{2}-[A-Z]{2}$

Examples:

"fr-FR"

"en-GB"

root root items feature anyOf item 0 description

Multilingual Object

Type: object

Additional details of the taxonomy feature, this can be used on spark front-end as a more verbose description of a feature

No Additional Properties

Example:

{
    "fr-BE": "Autre",
    "nl-BE": "Overig"
}

Pattern Property

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]{2}-[A-Z]{2}$

root root items feature anyOf item 0 description ^[a-z]{2}-[A-Z]{2}$

Type: string

root root items feature anyOf item 0 type

Type: object Default: {"text": {}}

Defines the type of a feature

No Additional Properties

One of

root root items feature anyOf item 0 type oneOf text

text

Type: object

The following properties are required:

text

root root items feature anyOf item 0 type oneOf media

media

Type: object

The following properties are required:

media

root root items feature anyOf item 0 type oneOf number

number

Type: object

The following properties are required:

number

root root items feature anyOf item 0 type oneOf date

date

Type: object

The following properties are required:

date

root root items feature anyOf item 0 type oneOf valueList

valueList

Type: object

The following properties are required:

valueList

root root items feature anyOf item 0 type text

Type: object
No Additional Properties

root root items feature anyOf item 0 type text isLong

Type: boolean

root root items feature anyOf item 0 type text validations

Type: array of object

List of all validations which are enforced by mirakl on a text attribute

No Additional Items

Each item of this array must be:

root root items feature anyOf item 0 type text validations validations items

A mirakl validation

One of

root root items feature anyOf item 0 type text validations validations items oneOf ValidationMinLength

Type: object
No Additional Properties

root root items feature anyOf item 0 type text validations validations items oneOf item 0 minLength

Type: integer

Minimum length of this text field

Value must be greater or equal to 0

Example:

root root items feature anyOf item 0 type text validations validations items oneOf ValidationMaxLength

Type: object
No Additional Properties

root root items feature anyOf item 0 type text validations validations items oneOf item 1 maxLength

Type: integer

Maximum length of this text field

Value must be greater or equal to 0

Example:

root root items feature anyOf item 0 type text validations validations items oneOf ValidationRegExp

Type: object
No Additional Properties

root root items feature anyOf item 0 type text validations validations items oneOf item 2 regExp

Type: string

Expression must match this regexp

Example:

"^[0-9]{8}$"

root root items feature anyOf item 0 type text validations validations items oneOf ValidationProductReference

Type: object
No Additional Properties

root root items feature anyOf item 0 type text validations validations items oneOf item 3 productReference

Type: array of enum (of string)

A list of valid product reference type this field can hold

No Additional Items

Each item of this array must be:

root root items feature anyOf item 0 type text validations validations items oneOf item 3 productReference productReference items

Type: enum (of string)

Must be one of:

"EAN-8"
"UPC"
"EAN-13"
"EAN-14"
"ISBN-10"
"ISBN-13"

Example:

[
    "EAN-14"
]

root root items feature anyOf item 0 type text validations validations items oneOf ValidationForbiddenWords

Type: object
No Additional Properties

root root items feature anyOf item 0 type text validations validations items oneOf item 4 forbiddenWords

Type: array of string

A list of forbidden words. Value matching ignores case and accents.

No Additional Items

Each item of this array must be:

root root items feature anyOf item 0 type text validations validations items oneOf item 4 forbiddenWords forbiddenWords items

Type: string

root root items feature anyOf item 0 type text validations validations items oneOf ValidationScript

Type: object
No Additional Properties

root root items feature anyOf item 0 type text validations validations items oneOf item 5 script

Type: string

A mirakl validation script, see https://help.mirakl.net/bundle/customers/page/topics/Mirakl/mci/Operator/catalogstructcreation/bo/defineattributes/defineattribute_rules/validations.html

Example:

"if ((context.data['description-fr_FR'] && context.data['description-fr_FR'].length > 0) ||\n    (context.data['description-en_GB'] && context.data['description-en_GB'].length > 0) ||\n    (context.data['description-de_DE'] && context.data['description-de_DE'].length > 0)) {\n    result.valid = true;\n} else {\n    result.valid   = false;\n    result.message = 'The description must be filled in at least 1 language (French or English or German)';\n}"

root root items feature anyOf item 0 type text i18n

Internationalised

Type: object

This behavior can be customised using the fields below, however it is advised to leave this object empty and rely on the default logic.

root root items feature anyOf item 0 type text i18n miraklFeatureCodes

Type: object

Optional list of feature code per lang for which this feature needs to be localised, this allows to define, per mirakl feature, properties such as having different validation per lang

Example:

{
    "fr-FR": "feature1-fr-FR",
    "en-GB": "feautre1-en-GB"
}

Each additional property must conform to the following schema

root root items feature anyOf item 0 type text i18n miraklFeatureCodes additionalProperties

Type: string

Feature code to be used for this locale.

root root items feature anyOf item 0 type media

Type: object
No Additional Properties

root root items feature anyOf item 0 type media type

Type: enum (of string)

Must be one of:

"DOCUMENT"
"IMAGE"
"VIDEO"

root root items feature anyOf item 0 type media maxSize

Type: integer

Max size of the media in kb

root root items feature anyOf item 0 type number

One of

root root items feature anyOf item 0 type number oneOf item 0

Type: object
No Additional Properties

root root items feature anyOf item 0 type number oneOf item 0 precision

Type: object

root root items feature anyOf item 0 type number oneOf item 1

Type: object

The following properties are required:

gs1UnitCode

root root items feature anyOf item 0 type number oneOf item 2

Type: object

The following properties are required:

miraklUnitCode

root root items feature anyOf item 0 type number precision

Type: integer

Maximum number of decimals allowed. Optional, default is 0.

Value must be greater or equal to 0

Example:

root root items feature anyOf item 0 type number gs1UnitCode

Type: enum (of string)

Defines the unit code as per the GS1 standard (PCE, MTR, etc.). https://resources.gs1us.org/GS1-US-Data-Hub-Help-Center/ArtMID/3451/ArticleID/116/Unit-of-Measure-Codes.

Must be one of:

"FOT"
"PCE"
"MTR"
"KGM"
"CMT"
"LTR"
"EA"
"MTK"
"PK"
"MTQ"
"TN"
"MLT"

Example:

"KGM"

root root items feature anyOf item 0 type number miraklUnitCode

Type: enum (of string)

Defines the unit code as per the list supported in mirakl

Must be one of:

"SQUARE_MILLIMETER"
"SQUARE_CENTIMETER"
"SQUARE_DECIMETER"
"SQUARE_METER"
"CENTIARE"
"SQUARE_DECAMETER"
"ARE"
"SQUARE_HECTOMETER"
"HECTARE"
"SQUARE_KILOMETER"
"SQUARE_MIL"
"SQUARE_INCH"
"SQUARE_FOOT"
"SQUARE_YARD"
"ARPENT"
"ACRE"
"SQUARE_FURLONG"
"SQUARE_MILE"
"MICROMETER"
"NAUTICAL_MILE"
"MILLIMETER"
"CENTIMETER"
"DECIMETER"
"METER"
"DECAMETER"
"HECTOMETER"
"KILOMETER"
"MIL"
"INCH"
"FEET"
"YARD"
"CHAIN"
"FURLONG"
"MILE"
"CHAR"
"KILOBIT"
"MEGABIT"
"GIGABIT"
"BIT"
"BYTE"
"KILOBYTE"
"MEGABYTE"
"GIGABYTE"
"TERABYTE"
"MICROLITER"
"HECTOLITER"
"CUBIC_MILLIMETER"
"CUBIC_CENTIMETER"
"MILLILITER"
"CENTILITER"
"DECILITER"
"CUBIC_DECIMETER"
"LITER"
"CUBIC_METER"
"FLUID_OUNCE"
"PINT"
"BARREL"
"GALLON"
"CUBIC_FOOT"
"CUBIC_INCH"
"CUBIC_YARD"
"MILLIGRAM"
"GRAM"
"KILOGRAM"
"TON"
"GRAIN"
"OUNCE"
"POUND"
"CENTIBAR"
"DECIBAR"
"KILOBAR"
"MEGABAR"
"KILOPASCAL"
"MEGAPASCAL"
"GIGAPASCAL"
"BAR"
"PASCAL"
"HECTOPASCAL"
"MILLIBAR"
"ATM"
"PSI"
"TORR"
"MMHG"
"CUBIC_METER_PER_SECOND"
"CUBIC_METER_PER_MINUTE"
"CUBIC_METER_PER_HOUR"
"CUBIC_METER_PER_DAY"
"MILLILITER_PER_SECOND"
"MILLILITER_PER_MINUTE"
"MILLILITER_PER_HOUR"
"MILLILITER_PER_DAY"
"CUBIC_CENTIMETER_PER_SECOND"
"CUBIC_CENTIMETER_PER_MINUTE"
"CUBIC_CENTIMETER_PER_HOUR"
"CUBIC_CENTIMETER_PER_DAY"
"CUBIC_DECIMETER_PER_MINUTE"
"CUBIC_DECIMETER_PER_HOUR"
"LITER_PER_SECOND"
"LITER_PER_MINUTE"
"LITER_PER_HOUR"
"LITER_PER_DAY"
"KILOLITER_PER_HOUR"
"DECIBEL"
"HERTZ"
"KILOHERTZ"
"MEGAHERTZ"
"GIGAHERTZ"
"TERAHERTZ"
"WATT"
"KILOWATT"
"KILOWATTHOUR"
"MEGAWATT"
"GIGAWATT"
"TERAWATT"
"MILLIVOLT"
"CENTIVOLT"
"DECIVOLT"
"VOLT"
"DECAVOLT"
"HECTOVOLT"
"KILOVOLT"
"MILLIAMPERE"
"CENTIAMPERE"
"DECIAMPERE"
"AMPERE"
"DECAMPERE"
"HECTOAMPERE"
"KILOAMPERE"
"MILLIOHM"
"CENTIOHM"
"DECIOHM"
"OHM"
"DECAOHM"
"HECTOHM"
"KILOHM"
"MEGOHM"
"METER_PER_SECOND"
"METER_PER_MINUTE"
"METER_PER_HOUR"
"KILOMETER_PER_HOUR"
"FOOT_PER_SECOND"
"FOOT_PER_HOUR"
"YARD_PER_HOUR"
"MILE_PER_HOUR"
"MILLIAMPEREHOUR"
"AMPEREHOUR"
"MILLICOULOMB"
"CENTICOULOMB"
"DECICOULOMB"
"COULOMB"
"DECACOULOMB"
"HECTOCOULOMB"
"KILOCOULOMB"
"MILLISECOND"
"SECOND"
"MINUTE"
"HOUR"
"DAY"
"WEEK"
"MONTH"
"YEAR"
"CELSIUS"
"FAHRENHEIT"
"KELVIN"
"RANKINE"
"REAUMUR"
"JOULE"
"CALORIE"
"KILOCALORIE"
"KILOJOULE"
"PIECE"
"DOZEN"
"LUMEN"
"NIT"
"MILLINEWTON"
"NEWTON"
"KILONEWTON"
"MEGANEWTON"
"RADIAN"
"MILLIRADIAN"
"MICRORADIAN"
"DEGREE"
"ANGLE_MINUTE"
"ANGLE_SECOND"
"GON"
"REVOLUTION"
"ATTOFARAD"
"PICOFARAD"
"NANOFARAD"
"MICROFARAD"
"MILLIFARAD"
"FARAD"
"KILOFARAD"

Example:

"KILOGRAM"

root root items feature anyOf item 0 type number validations

Type: array of object

List of all validations which are enforced by mirakl on a text attribute

No Additional Items

Each item of this array must be:

root root items feature anyOf item 0 type number validations validations items

A mirakl validation

One of

root root items feature anyOf item 0 type number validations validations items oneOf ValidationMin

Type: object
No Additional Properties

root root items feature anyOf item 0 type number validations validations items oneOf item 0 min

Type: number

Minimum value of this numeric field

Examples:

-5.05

root root items feature anyOf item 0 type number validations validations items oneOf ValidationMax

Type: object
No Additional Properties

root root items feature anyOf item 0 type number validations validations items oneOf item 1 max

Type: number

Maximum value of this numeric field

Examples:

-5.05

root root items feature anyOf item 0 type number validations validations items oneOf ValidationScript

Type: object
No Additional Properties

root root items feature anyOf item 0 type number validations validations items oneOf item 2 script

Type: string

A mirakl validation script, see https://help.mirakl.net/bundle/customers/page/topics/Mirakl/mci/Operator/catalogstructcreation/bo/defineattributes/defineattribute_rules/validations.html

Example:

"if ((context.data['description-fr_FR'] && context.data['description-fr_FR'].length > 0) ||\n    (context.data['description-en_GB'] && context.data['description-en_GB'].length > 0) ||\n    (context.data['description-de_DE'] && context.data['description-de_DE'].length > 0)) {\n    result.valid = true;\n} else {\n    result.valid   = false;\n    result.message = 'The description must be filled in at least 1 language (French or English or German)';\n}"

root root items feature anyOf item 0 type date

Type: object
No Additional Properties

root root items feature anyOf item 0 type date pattern

Type: string

root root items feature anyOf item 0 type valueList

Type: object
No Additional Properties

root root items feature anyOf item 0 type valueList code

Type: string

root root items feature anyOf item 0 type valueList multiple

Type: boolean Default: false

root root items feature anyOf item 0 type valueList defaults

Type: array of string

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root root items feature anyOf item 0 type valueList defaults defaults items

Type: string

root root items feature anyOf item 0 type valueList isVariant

Type: boolean Default: false

Indicates whether the attribute is variant. Product variants are variations of a product such as the color or the size of a dress.

root root items feature anyOf item 0 type valueList validations

Type: array of object

List of all validations which are enforced by mirakl on a text attribute

No Additional Items

Each item of this array must be:

root root items feature anyOf item 0 type valueList validations validations items

Type: object

A mirakl validation

No Additional Properties

root root items feature anyOf item 0 type valueList validations validations items script

Type: string

A mirakl validation script, see https://help.mirakl.net/bundle/customers/page/topics/Mirakl/mci/Operator/catalogstructcreation/bo/defineattributes/defineattribute_rules/validations.html

Example:

"if ((context.data['description-fr_FR'] && context.data['description-fr_FR'].length > 0) ||\n    (context.data['description-en_GB'] && context.data['description-en_GB'].length > 0) ||\n    (context.data['description-de_DE'] && context.data['description-de_DE'].length > 0)) {\n    result.valid = true;\n} else {\n    result.valid   = false;\n    result.message = 'The description must be filled in at least 1 language (French or English or German)';\n}"

root root items feature anyOf DeleteTaxonomyFeature

Type: object

A wrapper of the field needed to delete a taxonomy feature

No Additional Properties

Example:

{
    "code": "EF016286"
}

root root items feature anyOf item 1 code

Type: string

The code of the taxonomy feature to be removed

Examples:

"designation_de_lampe"

"EF016286"

root root items valueList

Describes the value type to be added/updated or deleted

Any of

TaxonomyFeatureValueList
DeleteTaxonomyFeatureValueList

root root items valueList anyOf TaxonomyFeatureValueList

Type: object

A list of allowed values for a feature

No Additional Properties

Example:

{
    "values": [
        {
            "code": "EV000072",
            "value": {
                "fr-BE": "aluminium",
                "en-GB": "aluminium"
            }
        },
        {
            "code": "EV000080",
            "value": {
                "fr-BE": "bleu",
                "en-GB": "blue"
            }
        }
    ],
    "label": {
        "fr-BE": "Couleur",
        "en-GB": "Colour"
    },
    "code": "VL_EC000005_EF000007"
}

root root items valueList anyOf item 0 code

Type: string

Unique identifier of the value list to be upserted. It is used to manage (update/delete) this value list and is displayed on the marketplace backend.

Examples:

"VL_EC000005_EF000007"

"a_unique_valuelist_code_009"

root root items valueList anyOf item 0 values

Type: array

Only the values declared in this list are allowed for the features associated to this value type

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root root items valueList anyOf item 0 values TaxonomyFeatureValueListItem

Type: object

A specific item in a value list, it defines the label of this value and an optional code

Example:

{
    "code": "EV000080",
    "value": {
        "fr-BE": "bleu",
        "en-GB": "blue"
    }
}

root root items valueList anyOf item 0 values values items value

Multilingual Object

Type: object

No Additional Properties

Example:

{
    "de-CH": "ein Text in Schweizerdeutsch",
    "fr-CH": "un texte en français suisse"
}

Pattern Property

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]{2}-[A-Z]{2}$

root root items valueList anyOf item 0 values values items value ^[a-z]{2}-[A-Z]{2}$

Type: string

root root items valueList anyOf item 0 values values items code

Type: string

Example:

"EV000072"

Example:

[
    {
        "code": "EV000072",
        "value": {
            "fr-BE": "aluminium",
            "en-GB": "aluminium"
        }
    },
    {
        "code": "EV000080",
        "value": {
            "fr-BE": "bleu",
            "en-GB": "blue"
        }
    }
]

root root items valueList anyOf item 0 label

Multilingual Object

Type: object

Optional value list label as displayed in mirakl backend

No Additional Properties

Example:

{
    "de-CH": "ein Text in Schweizerdeutsch",
    "fr-CH": "un texte en français suisse"
}

Pattern Property

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]{2}-[A-Z]{2}$

root root items valueList anyOf item 0 label ^[a-z]{2}-[A-Z]{2}$

Type: string

root root items valueList anyOf item 0 separator

Multilingual Object

Type: object

No Additional Properties

Example:

{
    "fr-FR": ", ",
    "en-GB": " - "
}

Pattern Property

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]{2}-[A-Z]{2}$

root root items valueList anyOf item 0 separator ^[a-z]{2}-[A-Z]{2}$

Type: string

root root items valueList anyOf DeleteTaxonomyFeatureValueList

Type: object

A wrapper for the field needed to delete a value list

No Additional Properties

Example:

{
    "code": "VL_EU570448"
}

root root items valueList anyOf item 1 code

Type: string

The code of the value type to be removed

Examples:

"VL_EU570448"

"a_unique_valuetype_code_009"

Products Taxonomy

Each item of this array must be:

All of

UPSERT or DELETE

One of

UPSERT

action

Must be one of:

feature

code Required

name Required

Multilingual Object

^[a-z]{2}-[A-Z]{2}$ Pattern Property

Pattern Property

categories Required

Each item of this array must be:

categoryCode Required

rank Required

requirementLevel

Must be one of:

miraklRoles

Each item of this array must be:

One of

Must be one of:

sparkMapping

Each item of this array must be:

One of

One of

role

Must be one of:

order

role

Must be one of:

order

lang

role

Must be one of:

role

Must be one of:

lang

role Required

order

One of

lang

unit

code

isHidden

isIgnored

isIgnored

isHidden

lang

unit

value

Multilingual Object

^[a-z]{2}-[A-Z]{2}$ Pattern Property

Pattern Property

code

lang

description

Multilingual Object

^[a-z]{2}-[A-Z]{2}$ Pattern Property

Pattern Property

type

One of

text

The following properties are required:

media

The following properties are required:

number

The following properties are required:

date

The following properties are required:

valueList

The following properties are required:

text

isLong

validations

Each item of this array must be:

One of

minLength