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

Project

Type: object

A project

EventHeader

Type: object

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

Type: enum (of string)

The application source of this event

Must be one of:

  • "SPARK"
  • "OPCO"

Type: enum (of string)

The version of the json format event

Must be one of:

  • "v1"

Type: string

The identifier of the commercial organisation for OpCo organised with a regional model or commercial organisation. If provided, then it will be used to get product details for the project corresponding to the organisation.


Examples:

"org123"
"SNE"

Type: string

Opco-provided ID of the project.


Example:

"52721026"

Type: string

OpCo's organizatinal customer number that uniquely identifies its account.


Examples:

"ABD4999569661752721026"
"1234563_SNE"

Type: string

The name of the project


Example:

"StandElec project"

Type: stringFormat: date-time

start date time of the project


Examples:

"2020-10-12T08:30:22.804Z"
"2020-10-12T14:30:45.107+01:00"

Type: stringFormat: date-time

end date time of the project.


Examples:

"2020-10-12T14:30:45.107Z"
"2020-10-12T14:30:45.107+01:00"

Type: stringFormat: date-time

Creation date time of the project


Examples:

"2020-10-12T08:30:22.804Z"
"2020-10-12T08:30:22.804+01:00"

Type: stringFormat: date-time

last modification date time of the project.


Examples:

"2020-10-12T14:30:22.107Z"
"2020-10-12T14:30:22.107+01:00"

LogisticDetails

Type: object

the default logistic details (method and address or facility) of the project


Example:

{
    "logisticMethod": "PICK_UP",
    "facilityId": "395"
}

Type: enum (of string)

Logistic method that will be chosen for the cart

Must be one of:

  • "DELIVERY"
  • "PICK_UP"

Example:

"PICK_UP"

Type: string

Unique identifier of the facility used when logistic method is 'PICK_UP'.


Example:

"395"

Type: string

A reference to an address that can be used for delivery when logistic method is 'DELIVERY'. This address should be sent created before the creation of the project


Examples:

"ACB395"
"3245"

Type: array of string

List of product associated with the project.If there are no items sent on this array the project is supported for all of the catalog

Must contain a minimum of 0 items

No Additional Items

Each item of this array must be:

Type: string

Product unique identifier.


Example:

"9554961192345"

Example:

[
    "9554961192345",
    "9554961192346"
]