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

Products

Type: array

a product object description

 No Additional Items

Each item of this array must be:

root ProductAction
Type: object

root root items oneOf UPSERT

UPSERT

Type: object

Used to add a new or update an existing a product.

 No Additional Properties

root root items oneOf UPSERT action
Type: enum (of string) Default: "UPSERT"

Action defines if the product has to be:
- UPSERT: added or updated
- DELETE: deleted

Must be one of:

  • "UPSERT"

root root items oneOf UPSERT product

Product

Type: object

a product object description

 No Additional Properties

root root items oneOf UPSERT product productId
Type: string

The unique product identifier depending on each opcos backend system (like ERP product ID)

 Must match regular expression: ^[a-zA-Z0-9_-]+$
Examples:

"000428"

"az_000428"

"000428-TY"

root root items oneOf UPSERT product opcoId
Type: string

tenant identifier for an Opco in SPARK multitenant platform
Example:

"BEL-CEBEO"

root root items oneOf UPSERT product grossPrice

Price

Type: object

gross price of the product

root root items oneOf UPSERT product grossPrice amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root root items oneOf UPSERT product grossPrice scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root root items oneOf UPSERT product grossPrice currency
Type: string

the currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Example:

"EUR"

root root items oneOf UPSERT product identifier
Type: object

product identifier attributes
Example:

{
    "gtin": "4012196097579",
    "opcoProductId": "65",
    "productTitle": [
        {
            "fr-BE": "PIQUETS DE TERRE EN CROIX 213/1.",
            "nl-BE": "Aardstaaf 1,5m 50x50x3"
        }
    ],
    "manufacturerRefId": "1360167",
    "manufacturerName": "HUPPERTZ",
    "manufacturerReference": "2742037 12-20 LGR638",
    "brandName": "Jokari",
    "tags": [
        "NEW",
        "END_OF_LIFE"
    ],
    "stockIndicator": "A",
    "keywords": [
        {
            "fr-BE": "Tige de mise à la terre",
            "nl-BE": "Aardingsstaaf"
        },
        {
            "fr-BE": "Mise à la terre / profondeur de la tige",
            "nl-BE": "Staafaarding/diepteaarding"
        }
    ]
}

root root items oneOf UPSERT product identifier gtin
Type: string

global trade identifier number e.g EAN, UPC etc
Example:

"4012196097579"

root root items oneOf UPSERT product identifier opcoProductId
Type: string

This is the local product id could be specific to opcos, most cases it is same as manufacturer id but could be different as well
Example:

"732D16"

root root items oneOf UPSERT product identifier manufacturerRefId
Type: string

This is the equivalent of manufacturer PID and used for search and identifying the product
Example:

"1360167"

root root items oneOf UPSERT product identifier productTitle

Multilingual Object

Type: object

short description of the product
Example:

{
    "fr-BE": "PIQUETS DE TERRE EN CROIX 213/1.",
    "nl-BE": "Aardstaaf 1,5m 50x50x3"
}

Each additional property must conform to the following schema

root root items oneOf UPSERT product identifier productTitle additionalProperties
Type: string

root root items oneOf UPSERT product identifier manufacturerName
Type: string

manufacturer name, one manufacturer could have one or multiple brands
Example:

"HUPPERTZ"

root root items oneOf UPSERT product identifier manufacturerReference
Type: string

manufacturer type description identifier, represents the references
Example:

"2037 12-20 LGR"

root root items oneOf UPSERT product identifier brandName
Type: string

brand name of the product
Example:

"Jokari"

root root items oneOf UPSERT product identifier customProductId1
Type: string

A custom product id that will be searchable and Facetable. A label should be configured into CMS to give meaningful display to the user
Example:

"0001"

root root items oneOf UPSERT product identifier customProductId2
Type: string

A custom product id that will be searchable and Facetable. A label should be configured into CMS to give meaningful display to the user
Example:

"0002"

root root items oneOf UPSERT product identifier customProductId3
Type: string

A custom product id that will be searchable and Facetable. A label should be configured into CMS to give meaningful display to the user
Example:

"0003"

root root items oneOf UPSERT product identifier customProductId4
Type: string

A custom product id that will be searchable and Facetable. A label should be configured into CMS to give meaningful display to the user
Example:

"0004"

root root items oneOf UPSERT product identifier customProductId5
Type: string

A custom product id that will be searchable and Facetable. A label should be configured into CMS to give meaningful display to the user
Example:

"0005"

root root items oneOf UPSERT product identifier stockIndicator
Type: enum (of string)

a classification for availability of stocks at branch, CDC. A= branch (+CDC), B= CDC, C= OnDemand L = Liquidation (product is sold until our stock runs out, no backorders allowed, no longer available from the supplier)

Must be one of:

  • "A"
  • "B"
  • "C"
  • "L"

root root items oneOf UPSERT product identifier tags
Type: array of enum (of string)

The tags for the product to represent the combination of associated labels

 No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product identifier tags tags items
Type: enum (of string)

The possible tags for the product are
- NEW: for new product.
- ENDOFLIFE: for end of life product
- SUSTAINABLE: related to green offer
- CIRCULAR: the product is made of recycled materials or reused materials
- OUTLET: for Damaged (aesthetically) goods but fully functional products with very limited quantity

Must be one of:

  • "NEW"
  • "END_OF_LIFE"
  • "SUSTAINABLE"
  • "CIRCULAR"
  • "OUTLET"

root root items oneOf UPSERT product identifier keywords
Type: array

array of keywords used for seo and search readiness

 No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product identifier keywords Multilingual Object

Multilingual Object

Type: object

This is object used to describe the translation of text field. the locale use the IETF BCP 47 language tag of the locale (language and country)
Example:

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

Each additional property must conform to the following schema

root root items oneOf UPSERT product identifier keywords Multilingual Object additionalProperties
Type: string

Example:

[
    {
        "fr-BE": "Tige de mise à la terre",
        "nl-BE": "Aardingsstaaf"
    },
    {
        "fr-BE": "Mise à la terre / profondeur de la tige",
        "nl-BE": "Staafaarding/diepteaarding"
    }
]

root root items oneOf UPSERT product orderingDetail
Type: object

ordering details comprising units,packing steps and quantity details
Example:

{
    "orderUnit": "TN",
    "contentUnit": "MLT",
    "packingQuantity": 200,
    "minQuantity": 6,
    "isSoldLoose": true,
    "quantitySteps": 6
}

root root items oneOf UPSERT product orderingDetail orderUnit
Type: enum (of string)

order unit are the units in which a product is being sold, e.g TN - tin, This must comply with GS1 unit of measure as on stocks

Must be one of:

  • "FOT"
  • "PCE"
  • "MTR"
  • "KGM"
  • "CMT"
  • "LTR"
  • "EA"
  • "MTK"
  • "PK"
  • "MTQ"
  • "TN"
  • "MLT"
  • "BG"
  • "PR"
  • "RO"
  • "SET"
  • "LN"
  • "ST"
  • "RL"
  • "BX"
  • "CS"
  • "JR"
  • "LBR"
  • "INH"
  • "DZN"
  • "SO"
  • "CL"
  • "CG"
  • "CT"

Example:

"TN"

root root items oneOf UPSERT product orderingDetail contentUnit
Type: enum (of string)

content unit is the exact measurable unit e.g MLT - milliliter, This must comply with GS1 unit of measure as on stocks

Must be one of:

  • "FOT"
  • "PCE"
  • "MTR"
  • "KGM"
  • "CMT"
  • "LTR"
  • "EA"
  • "MTK"
  • "MTQ"
  • "MLT"
  • "BG"
  • "PR"
  • "RO"
  • "SET"
  • "PK"
  • "LN"
  • "ST"
  • "RL"
  • "BX"
  • "CS"
  • "JR"
  • "LBR"
  • "INH"
  • "DZN"
  • "SO"
  • "CL"
  • "CG"
  • "CT"

Example:

"MLT"

root root items oneOf UPSERT product orderingDetail packingQuantity
Type: integer

It is number of content unit per order unit e.g 200 (Spray tin 200 ML)
Example:

200

root root items oneOf UPSERT product orderingDetail minQuantity
Type: integer

minimum quantity that the customer can add to cart and order.
Example:

6

root root items oneOf UPSERT product orderingDetail isSoldLoose
Type: boolean

Is it sold in loose apart from packing
Example:

true

root root items oneOf UPSERT product orderingDetail quantitySteps
Type: integer

sold in steps or quantity intervals
Example:

6

root root items oneOf UPSERT product description
Type: object

This object contains all available informations of the product
Example:

{
    "additionalInfo": [
        {
            "en-US": "The product shall be shipped with extra care (e.g horizontal aligned)",
            "fr-FR": "Le produit doit être expédié avec un soin particulier (par exemple aligné horizontalement)"
        }
    ],
    "erpShortDescription": {
        "en-US": "pressure clamp nylon",
        "fr-FR": "pince de pression en nylon"
    },
    "longDescription": {
        "en-US": "High performance, Long life and Superior light quality A compact, energy efficient metal halide lamp that provides crisp, sparkling light with long life and high efficiency.",
        "fr-FR": "Haute performance, longue durée de vie et qualité de lumière supérieure Une lampe aux halogénures métalliques compacte et économe en énergie qui fournit une lumière vive et étincelante avec une longue durée de vie et un rendement élevé."
    },
    "specialInstructions": [
        {
            "en-US": "MSDS or ECCN info",
            "fr-FR": "Informations MSDS ou ECCN"
        },
        {
            "en-US": "MSDS or ECCN info",
            "fr-FR": "Informations MSDS ou ECCN"
        }
    ],
    "legalDisclaimer": [
        {
            "en-US": "WARNING: Certain home improvement projects are inherently dangerous, and even the most benign tool can cause serious injury or death if not used properly",
            "fr-FR": "AVERTISSEMENT: certains projets de rénovation résidentielle sont intrinsèquement dangereux, et même l'outil le plus bénin peut causer des blessures graves ou la mort s'il n'est pas utilisé correctement"
        }
    ]
}

root root items oneOf UPSERT product description additionalInfo
Type: array

contains any additional remarks or info for the product

 No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product description additionalInfo Multilingual Object

Multilingual Object

Type: object

This is object used to describe the translation of text field. the locale use the IETF BCP 47 language tag of the locale (language and country)
Example:

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

Each additional property must conform to the following schema

root root items oneOf UPSERT product description additionalInfo Multilingual Object additionalProperties
Type: string

Example:

[
    {
        "en-US": "The product shall be shipped with extra care (e.g horizontal aligned)",
        "fr-FR": "Le produit doit être expédié avec un soin particulier (par exemple aligné horizontalement)"
    }
]

root root items oneOf UPSERT product description erpShortDescription

Multilingual Object

Type: object

A very short ERP description to be shown on PDP and also used while generating invoices
Example:

{
    "en-US": "iC60a 3P 25A  C",
    "fr-FR": "iC60a 3P 25A  C"
}

Each additional property must conform to the following schema

root root items oneOf UPSERT product description erpShortDescription additionalProperties
Type: string

root root items oneOf UPSERT product description longDescription

Multilingual Object

Type: object

contains detailed 1-2 lines of description for the product
Example:

{
    "en-US": "High performance, Long life and Superior light quality A compact, energy efficient metal halide lamp that provides crisp, sparkling light with long life and high efficiency.",
    "fr-FR": "Haute performance, longue durée de vie et qualité de lumière supérieure Une lampe aux halogénures métalliques compacte et économe en énergie qui fournit une lumière vive et étincelante avec une longue durée de vie et un rendement élevé."
}

Each additional property must conform to the following schema

root root items oneOf UPSERT product description longDescription additionalProperties
Type: string

root root items oneOf UPSERT product description specialInstructions
Type: array

contains any special instructions based on special treatment class such as hazardous goods

 No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product description specialInstructions Multilingual Object

Multilingual Object

Type: object

This is object used to describe the translation of text field. the locale use the IETF BCP 47 language tag of the locale (language and country)
Example:

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

Each additional property must conform to the following schema

root root items oneOf UPSERT product description specialInstructions Multilingual Object additionalProperties
Type: string

Example:

[
    {
        "en-US": "MSDS or ECCN info",
        "fr-FR": "Informations MSDS ou ECCN"
    }
]

root root items oneOf UPSERT product description legalDisclaimer
Type: array

contains the list of legal disclaimers associated with a product

 No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product description legalDisclaimer Multilingual Object

Multilingual Object

Type: object

This is object used to describe the translation of text field. the locale use the IETF BCP 47 language tag of the locale (language and country)
Example:

[
    {
        "en-US": "WARNING: Certain home improvement projects are inherently dangerous, and even the most benign tool can cause serious injury or death if not used properly",
        "fr-FR": "AVERTISSEMENT: certains projets de rénovation résidentielle sont intrinsèquement dangereux, et même l'outil le plus bénin peut causer des blessures graves ou la mort s'il n'est pas utilisé correctement"
    }
]

Each additional property must conform to the following schema

root root items oneOf UPSERT product description legalDisclaimer Multilingual Object additionalProperties
Type: string

root root items oneOf UPSERT product categories
Type: array of string

References to the categorisation leaf nodes on the full categories tree, where the product resides. We suppose that the meganav is a sub set of the full categories, so

No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product categories categories items
Type: string

Example:

[
    "S07SF070301",
    "S06SF0611"
]

root root items oneOf UPSERT product localProductCategory
Type: string

Reference to the local product categorisation leaf node, where the product resides in Spark AX for the OpCo.
Examples:

"S07SF070301_local"

"S06SF0611_local"

root root items oneOf UPSERT product features
Type: array

Associated technical features for the product

 No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product features Features
Type: object

root root items oneOf UPSERT product features features items name

Multilingual Object

Type: object

name of the feature
Example:

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

Each additional property must conform to the following schema

root root items oneOf UPSERT product features features items name additionalProperties
Type: string

root root items oneOf UPSERT product features features items value

Multilingual Object

Type: object

value for the feature
Example:

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

Each additional property must conform to the following schema

root root items oneOf UPSERT product features features items value additionalProperties
Type: string

root root items oneOf UPSERT product features features items unit

Multilingual Object

Type: object

unit for the feature
Example:

{
    "fr-BE": "Pouce",
    "nl-BE": "Duim"
}

Each additional property must conform to the following schema

root root items oneOf UPSERT product features features items unit additionalProperties
Type: string

root root items oneOf UPSERT product features features items detail

Multilingual Object

Type: object

additional details of the feature
Example:

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

Each additional property must conform to the following schema

root root items oneOf UPSERT product features features items detail additionalProperties
Type: string

root root items oneOf UPSERT product features features items rank
Type: integer

Rank for showing the top essential specifications of the product, 1 being the best and shown on top on PLP: Must be a distinct value for all features
Example:

2

root root items oneOf UPSERT product features features items isUsedForVariation
Type: boolean

The boolean if true for a feature then feature can be used to choose variants if false then feature can not be used to choose variants
Example:

true

root root items oneOf UPSERT product features features items variationOrder
Type: integer

In Pilot: A numeric value that specifies the sorting order of product variations in ascending order. This value is applicable only when 'isUsedForVariation' is set to true.
Example:

30

root root items oneOf UPSERT product features features items code
Type: string

Unique identifier of this feature.
Mandatory when marketplace is enabled (or when relying on a taxonomy). It corresponds to the feature code on the taxonomy model.
Example:

"feature1uniquecode"

root root items oneOf UPSERT product features features items valueCodes
Type: array of string

Unique identifier of this feature value(s).
It is only used for features which have a fixed list of possible values (enum, called valueList in the product-taxonomy model).

As an example, a feature which represents the color of a product could have the feature code EF000007, be declared of type valueList with the code VL_EF000007 and have as an actual list of possible values VL_EF000007_BLACK, VL_EF000007_WHITE, VL_EF000007_BLUE, VL_EF000007_ORANGE.
In such case:
- a product with the color blue would have its value set to 'fr-FR': 'Bleu','en-GB': 'Blue' and its valueCodes set to ['VL_EF000007_BLUE'].
- a product with more than one color (say black and blue) would have its value set to 'fr-FR': 'Noir, Bleu','en-GB': 'Black, Blue' and its valueCodes would be ['VL_EF000007_BLACK','VL_EF000007_BLUE']

No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product features features items valueCodes valueCodes items
Type: string

Must be at least 1 characters long


Example:

[
    "VL_EF000007_BLACK",
    "VL_EF000007_BLUE"
]

Example:

[
    {
        "name": {
            "fr-BE": "Hélices axialles",
            "nl-BE": "Axiaal filament"
        },
        "value": {
            "fr-BE": "Oui",
            "nl-BE": "Ja"
        },
        "unit": {
            "fr-BE": "Pouce",
            "nl-BE": "Duim"
        },
        "detail": {
            "fr-BE": "bleu",
            "nl-BE": "blauw"
        },
        "rank": 2
    },
    {
        "name": {
            "fr-BE": "Désignation de lampe",
            "nl-BE": "Lampaanduiding"
        },
        "value": {
            "fr-BE": "autre",
            "nl-BE": "Overig"
        },
        "unit": {
            "fr-BE": "kilogramme",
            "nl-BE": "Kilogram"
        },
        "detail": {
            "fr-BE": "autre",
            "nl-BE": "Overig"
        },
        "rank": 1
    }
]

root root items oneOf UPSERT product references
Type: array

References to similar products, accessories, spare parts, mandatory essentials, component parts, successors, variants etc Used in cases of cross and up sell

 No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product references References

References

Type: object

references to the current product e.g accessories, followup and similar

root root items oneOf UPSERT product references References type
Type: enum (of string)

the reference type of the product such as accessories, followup and similar

Must be one of:

  • "accessories"
  • "followup"
  • "similar"
  • "variation"

root root items oneOf UPSERT product references References productIdTo
Type: string

the reference product id to which this product belongs
Example:

"000236"

Example:

[
    {
        "type": "accessories",
        "productIdTo": "000428"
    },
    {
        "type": "similar",
        "productIdTo": "000653"
    },
    {
        "type": "similar",
        "productIdTo": "002354"
    },
    {
        "type": "followup",
        "productIdTo": "000987"
    }
]

root root items oneOf UPSERT product packingInfo
Type: array

detailed information for various format of packing the product

 No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product packingInfo Packing Details

Packing Details

Type: object

packing details of various formats in which the product could be packed and delivered

root root items oneOf UPSERT product packingInfo Packing Details type
Type: enum (of string)

packing type of the product such as box or carton

Must be one of:

  • "UNIT"
  • "BOX"
  • "CARTON"
  • "PALLET"
  • "CONTAINER"
  • "CARD"
  • "REEL"
  • "PACK"
  • "BAG"
  • "PIECE"
  • "JUG"
  • "JAR"
  • "EACH"
  • "CASE"
  • "LENGTH"
  • "PAIR"
  • "BLISTER"

Example:

"BOX"

root root items oneOf UPSERT product packingInfo Packing Details code
Type: string

[Deprecated - Use type instead]
Example:

"box"

root root items oneOf UPSERT product packingInfo Packing Details dimensionUnit
Type: string

The units in which the dimensions are computed and displayed in e.g cm, mm, inch etc applicable for length, width, height, diameter
Example:

"mm"

root root items oneOf UPSERT product packingInfo Packing Details weightUnit
Type: string

The units in which the weights are computed and displayed in e.g gm,kg etc
Example:

"kg"

root root items oneOf UPSERT product packingInfo Packing Details volumeUnit
Type: string

The units in which the volumes are computed and displayed in e.g mm^3
Example:

"cm^3"

root root items oneOf UPSERT product packingInfo Packing Details count
Type: integer

no of products being packaged in a packing
Example:

6

root root items oneOf UPSERT product packingInfo Packing Details minQuantity
Type: integer

min quantity which is compliant to packing units (crate or box). This only a display information about the packing
Example:

2

root root items oneOf UPSERT product packingInfo Packing Details maxQuantity
Type: integer

max quantity which is compliant to packing units (crate or box). This only a display information about the packing
Example:

12

root root items oneOf UPSERT product packingInfo Packing Details isPackageBreak
Type: boolean

This determines if the packing is mandatory or not based on min-max quantity
Example:

true

root root items oneOf UPSERT product packingInfo Packing Details length
Type: number

length of packing object
Example:

2.4

root root items oneOf UPSERT product packingInfo Packing Details width
Type: number

width of packing object
Example:

1.2

root root items oneOf UPSERT product packingInfo Packing Details depth
Type: number

depth of packing object
Example:

3.5

root root items oneOf UPSERT product packingInfo Packing Details weight
Type: number

weight of packing object
Example:

2.2

root root items oneOf UPSERT product packingInfo Packing Details diameter
Type: number

diameter of packing object
Example:

5.2

root root items oneOf UPSERT product packingInfo Packing Details volume
Type: number

volume of packing object
Example:

1.2

root root items oneOf UPSERT product packingInfo Packing Details packingGtin
Type: string

unique identifier of the packing
Example:

"4012196097545"

Example:

[
    {
        "code": "box",
        "count": 6,
        "dimensionUnit": "mm",
        "weightUnit": "kg",
        "volumeUnit": "mm^3",
        "minQuantity": 2,
        "maxQuantity": 12,
        "isPackageBreak": true,
        "length": 2.4,
        "width": 1.2,
        "depth": 3.5,
        "weight": 2.2,
        "diameter": 5.2,
        "volume": 1.2,
        "packingGtin": "4012196097545"
    },
    {
        "code": "carton",
        "count": 36,
        "dimensionUnit": "cm",
        "weightUnit": "g",
        "volumeUnit": "cm^3",
        "minQuantity": 18,
        "maxQuantity": 36,
        "isPackageBreak": true,
        "length": 12.4,
        "width": 11.2,
        "depth": 13.5,
        "weight": 12.2,
        "diameter": 15.2,
        "volume": 11.2,
        "packingGtin": "4012196097522"
    }
]

root root items oneOf UPSERT product lifeCycle
Type: object

product validity range when it became active and when it expires
Example:

{
    "manufactureDate": "2020-10-14T10:22:00.116Z",
    "expireDate": "2020-10-14T10:22:00.116Z"
}

root root items oneOf UPSERT product lifeCycle manufactureDate
Type: stringFormat: date-time

date when the product is manufactured and is active (All date formats follow ISO 8601 standard)
Example:

"2020-10-14T10:22:00.116Z"

root root items oneOf UPSERT product lifeCycle expireDate
Type: stringFormat: date-time

date until when the product is active or when it is due to expire
Example:

"2020-10-14T10:22:00.116Z"

root root items oneOf UPSERT product expectedDeliveryTime
Type: integer

the expected time of delivery in days from the date of order, specially in cases of non stocked products
Example:

2

root root items oneOf UPSERT product warranty
Type: integer

warranty of a product in years by manufacturer
Example:

2

root root items oneOf UPSERT product series
Type: string

The series to which the product belongs to depending on opco
Example:

"JUSSI"

root root items oneOf UPSERT product isEcommerceReady
Type: boolean

Is the current product commerce ready. To be used for analytics to prioritise enriching the product data based on its demand and make it ready for e-commerce
Example:

true

root root items oneOf UPSERT product isCuttable
Type: boolean Default: false

If true the product is considered a cuttable product that allows the customer to add multiple cuts in multiple lengths from the PLP and PDP.
Example:

true

root root items oneOf UPSERT product reelOptions
Type: object

When customers select cables to be cut to length, the customer can have the option to choose to receive the cable in different reel options: Spooled or Coiled.
Example:

{
    "values": [
        "COILED",
        "SPOOLED"
    ],
    "defaultValue": "COILED"
}

root root items oneOf UPSERT product reelOptions values
Type: array

array of possible reelOption

 No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product reelOptions values ReelOption

ReelOption

Type: enum (of string)

Reel option for cuttable cables

Must be one of:

  • "COILED"
  • "SPOOLED"

Example:

"SPOOLED"

root root items oneOf UPSERT product reelOptions defaultValue

ReelOption

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

Reel option for cuttable cables

Must be one of:

  • "COILED"
  • "SPOOLED"

Example:

"SPOOLED"

root root items oneOf UPSERT product isReturnable
Type: boolean Default: true

If true then the product is considered returnable and if false the product is considered non-returnable
Example:

false

root root items oneOf UPSERT product isPartOfOpenCatalog
Type: boolean Default: true
  • When true then the product is considered part of the open catalog and can be searchable and viewed when not logged in and all accounts.
  • When false the product will be visible only for allowed accounts, the opco can configure that using the inclusion feed.
Example:

false

root root items oneOf UPSERT product organisations
Type: array of object

Array containing for each organistion the list of product properties overriden for this organisation

 No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product organisations organisations items
Type: object

root root items oneOf UPSERT product organisations organisations items orgId
Type: string

This is the identifier for commercial orgnanisation

root root items oneOf UPSERT product organisations organisations items orgRelatedFields
Type: object

This object list all product fields that can be override by an organisation. Needed by OpCo organised with a regional model or commercial organisation

root root items oneOf UPSERT product organisations organisations items orgRelatedFields stockIndicator
Type: enum (of string)

a classification for availability of stocks at branch, CDC. A= branch (+CDC), B= CDC, C= OnDemand L = Liquidation (product is sold until our stock runs out, no backorders allowed, no longer available from the supplier)

Must be one of:

  • "A"
  • "B"
  • "C"
  • "L"

root root items oneOf UPSERT product organisations organisations items orgRelatedFields tags
Type: array of enum (of string)

The tags for the product to represent the combination of associated labels

 No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product organisations organisations items orgRelatedFields tags tags items
Type: enum (of string)

The possible tags for the product are
- NEW: for new product.
- ENDOFLIFE: for end of life product
- SUSTAINABLE: related to green offer
- CIRCULAR: the product is made of recycled materials or reused materials
- OUTLET: for Damaged (aesthetically) goods but fully functional products with very limited quantity

Must be one of:

  • "NEW"
  • "END_OF_LIFE"
  • "SUSTAINABLE"
  • "CIRCULAR"
  • "OUTLET"

root root items oneOf UPSERT product organisations organisations items orgRelatedFields orderingDetail
Type: object

ordering details comprising units,packing steps and quantity details
Example:

{
    "orderUnit": "TN",
    "contentUnit": "MLT",
    "packingQuantity": 200,
    "minQuantity": 6,
    "isSoldLoose": true,
    "quantitySteps": 6
}

root root items oneOf UPSERT product organisations organisations items orgRelatedFields orderingDetail orderUnit
Type: enum (of string)

order unit are the units in which a product is being sold, e.g TN - tin, This must comply with GS1 unit of measure as on stocks

Must be one of:

  • "FOT"
  • "PCE"
  • "MTR"
  • "KGM"
  • "CMT"
  • "LTR"
  • "EA"
  • "MTK"
  • "PK"
  • "MTQ"
  • "TN"
  • "MLT"
  • "BG"
  • "PR"
  • "RO"
  • "SET"
  • "LN"
  • "ST"
  • "RL"
  • "BX"
  • "CS"
  • "JR"
  • "LBR"
  • "INH"
  • "DZN"
  • "SO"
  • "CL"
  • "CG"
  • "CT"

Example:

"TN"

root root items oneOf UPSERT product organisations organisations items orgRelatedFields orderingDetail contentUnit
Type: enum (of string)

content unit is the exact measurable unit e.g MLT - milliliter, This must comply with GS1 unit of measure as on stocks

Must be one of:

  • "FOT"
  • "PCE"
  • "MTR"
  • "KGM"
  • "CMT"
  • "LTR"
  • "EA"
  • "MTK"
  • "MTQ"
  • "MLT"
  • "BG"
  • "PR"
  • "RO"
  • "SET"
  • "PK"
  • "LN"
  • "ST"
  • "RL"
  • "BX"
  • "CS"
  • "JR"
  • "LBR"
  • "INH"
  • "DZN"
  • "SO"
  • "CL"
  • "CG"
  • "CT"

Example:

"MLT"

root root items oneOf UPSERT product organisations organisations items orgRelatedFields orderingDetail packingQuantity
Type: integer

It is number of content unit per order unit e.g 200 (Spray tin 200 ML)
Example:

200

root root items oneOf UPSERT product organisations organisations items orgRelatedFields orderingDetail minQuantity
Type: integer

minimum quantity that the customer can add to cart and order.
Example:

6

root root items oneOf UPSERT product organisations organisations items orgRelatedFields orderingDetail isSoldLoose
Type: boolean

Is it sold in loose apart from packing
Example:

true

root root items oneOf UPSERT product organisations organisations items orgRelatedFields orderingDetail quantitySteps
Type: integer

sold in steps or quantity intervals
Example:

6

root root items oneOf UPSERT product iconCodes
Type: array of enum (of string)

Array of icon codes to be displayed on the product. Allowed icon codes could be found here https://sonepardigital.atlassian.net/wiki/spaces/DFSP/pages/2967044168/SPM-5296+Attribute+based+icons

 No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product iconCodes iconCodes items
Type: enum (of string)

Must be one of:

  • "CPREN50575"
  • "SINGLE_CABLE"
  • "MULTI_CABLE"
  • "LS0H"
  • "FIRE_RES0H30"
  • "FIRE_RES1H"
  • "FIRE_RES1H30"
  • "FIRE_RES2H"
  • "REEL"
  • "DRUM"
  • "ENERGY_A"
  • "ENERGY_B"
  • "ENERGY_C"
  • "ENERGY_D"
  • "ENERGY_E"
  • "ENERGY_F"
  • "ENERGY_G"
  • "RETHINK"
  • "REUSE"
  • "RECYCLE"
  • "PROP65"
  • "ENERGY_STAR"
  • "GREEN_PRODUCT"

Example:

[
    "CPREN50575",
    "FIRE_RES2H",
    "REEL"
]

root root items oneOf UPSERT product greenOffer
Type: object

This object contains the attributes related to green offer details associated with the product
Examples:

{
    "carbonFootprint": {
        "value": 34.9,
        "unit": "KGM"
    },
    "rating": "B"
}

{
    "carbonFootprint": {
        "value": 0.9,
        "unit": "GRM"
    },
    "rating": "A"
}

root root items oneOf UPSERT product greenOffer carbonFootprint
Type: object

the carbon footprint of the product.

root root items oneOf UPSERT product greenOffer carbonFootprint value
Type: number

the carbon footprint value.

root root items oneOf UPSERT product greenOffer carbonFootprint unit
Type: enum (of string)

the carbon footprint unit.

Must be one of:

  • "GRM"
  • "KGM"
  • "MTR"
  • "KMT"

root root items oneOf UPSERT product greenOffer rating
Type: enum (of string)

the green rating of this product.

Must be one of:

  • "A"
  • "B"
  • "C"
  • "X"

root root items oneOf UPSERT product marketplace
Type: object

Property containing all marketplace related data for this product.
It also acts as a hint telling spark if this product is synchronised on the marketplace.

This property is only intended to be used in the event based product integration and not expected in the file based product ingestion flow.
Example:

{
    "sellers": {
        "Seller1OpcoId": {
            "opcoProductId": "SEL1_1234567890",
            "sku": "0987654321"
        },
        "Seller2OpcoId": {
            "opcoProductId": "SEL2_1234567890",
            "taxCode": "TAX_5_5",
            "ecoTaxes": [
                {
                    "code": "FR-DEEE",
                    "taxAmount": {
                        "amount": 100,
                        "scale": 2,
                        "currency": "EUR"
                    }
                }
            ]
        }
    }
}

root root items oneOf UPSERT product marketplace sellers
Type: object

This object properties key is the opcoSellerId
Example:

{
    "Seller1OpcoId": {
        "opcoProductId": "SEL1_1234567890",
        "sku": "0987654321"
    },
    "Seller2OpcoId": {
        "opcoProductId": "SEL2_1234567890",
        "taxCode": "TAX_5_5",
        "ecoTaxes": [
            {
                "code": "FR-DEEE",
                "taxAmount": {
                    "amount": 100,
                    "scale": 2,
                    "currency": "EUR"
                }
            }
        ]
    }
}

Each additional property must conform to the following schema

root root items oneOf UPSERT product marketplace sellers additionalProperties
Type: object

Marketplace information for this product for this seller

root root items oneOf UPSERT product marketplace sellers additionalProperties opcoProductId
Type: string

Product identifier defined by the opco when sold by this seller. This field is optional and if defined it overrides identifier.opcoProductId.

root root items oneOf UPSERT product marketplace sellers additionalProperties sku
Type: string

Unique product id for this product as used by this seller, provided by the seller through the marketplace platform

root root items oneOf UPSERT product marketplace sellers additionalProperties taxCode
Type: string

Product tax code, as received from mirakl per seller. Its value is a label defined by the OpCo, not an actual amount

root root items oneOf UPSERT product marketplace sellers additionalProperties ecoTaxes
Type: array

List of eco-contribution amounts and corresponding producer identifiers, if applicable.

 No Additional Items

Each item of this array must be:

root root items oneOf UPSERT product marketplace sellers additionalProperties ecoTaxes EcoTax

EcoTax

Type: object

Eco-contribution code and amount

root root items oneOf UPSERT product marketplace sellers additionalProperties ecoTaxes EcoTax code
Type: string

Code of the eco tax
Example:

"FR-DEEE"

root root items oneOf UPSERT product marketplace sellers additionalProperties ecoTaxes EcoTax taxAmount

Price

Type: object

Amount of the eco tax

root root items oneOf UPSERT product marketplace sellers additionalProperties ecoTaxes EcoTax taxAmount amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root root items oneOf UPSERT product marketplace sellers additionalProperties ecoTaxes EcoTax taxAmount scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root root items oneOf UPSERT product marketplace sellers additionalProperties ecoTaxes EcoTax taxAmount currency
Type: string

the currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Example:

"EUR"

root root items oneOf UPSERT product marketplace sellers additionalProperties marketplaceSellerId
Type: string

Id of the seller as known by the marketplace platform

root root items oneOf UPSERT product marketplace miraklProductId
Type: string

Product identifier as referenced by mirakl
Example:

"5aea55dd-8671-406d-9dbe-093d626e40ee"

root root items oneOf UPSERT product hiddenFeatures
Type: object

A bag of values for marketplace product features which don't have any direct mapping to spark data model. Used for the opco to retrieve/store product features which are hidden from spark. It should only be used in the context of marketplace integration.
Example:

{
    "etimclass": "EC000011",
    "gtin": [
        "11111111",
        "11111112"
    ]
}
root root items oneOf DELETE

DELETE

Type: object

Used to delete a product

 No Additional Properties

root root items oneOf DELETE action
Type: enum (of string)

Action defines if the product has to be:
- UPSERT: added or updated
- DELETE: deleted

Must be one of:

  • "DELETE"

root root items oneOf DELETE product

DeletedProduct

Type: object

The product id to be deleted

 No Additional Properties

root root items oneOf DELETE product productId
Type: string

The unique product identifier depending on each opcos backend system (like ERP product ID)

 Must match regular expression: ^[a-zA-Z0-9_-]+$
Examples:

"000428"

"az_000428"

"000428-TY"