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

Product List

Type: object

This object represents the product list associated to user's email and attached to an account
Example:

{
    "accountId": "30638",
    "listName": "Most Required Items",
    "userEmail": "john.doe@stanelec.com",
    "defaultProductList": "true",
    "products": [
        {
            "product": {
                "productId": "6453672"
            }
        },
        {
            "product": {
                "productId": "0000052"
            }
        }
    ],
    "eventHeader": {
        "source": "OPCO",
        "version": "v1"
    }
}

root accountId
Type: string

OpCo's organizatinal customer number that uniquely identifies its account. In the case of OpCo organised with a regional model or commercial organisation this should be suffix by '{orgId}'. if the accountId is 13563 and the orgId is OVIA so this field should contains 13563OVIA
Examples:

"30638"

"13563_OVIA"

root listName
Type: string

Name of the product list to integrate.
Example:

"Dimming light"

root userEmail
Type: string

email of the owner of this list.

Must match regular expression: [^@\s]+@[^@\s]+\.[^@\s]+
Example:

"john.doe@standelec.com"

root defaultProductList
Type: boolean Default: false

Allows to define as default list. Only one list can be used as default
Example:

"true"

root visibility
Type: enum (of string) Default: "PRIVATE"

Allows to define the visibility of a product list. PRIVATE: Only its owner can interact with it. PUBLIC: Anyone from the same account can interact with the list.

Must be one of:

  • "PUBLIC"
  • "PRIVATE"

root products
Type: array

list of products under one list

Must contain a minimum of 1 items

Must contain a maximum of 5000 items

No Additional Items

Each item of this array must be:

root products Product

Product

Type: object

A minimal product data to be able to display the product.

root products Product productId
Type: string

A unique identifier of the product
Example:

"9554961192345"

Example:

[
    {
        "product": {
            "productId": "6453672"
        }
    },
    {
        "product": {
            "productId": "0000052"
        }
    }
]

root eventHeader

EventHeader

Type: object

This object is used to describe some technical meta information related to the event

root eventHeader source
Type: enum (of string)

The application source of this event

Must be one of:

  • "SPARK"
  • "OPCO"

root eventHeader version
Type: enum (of string)

The version of the json format event

Must be one of:

  • "v1"