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

Related Product Group

Type: object

In Pilot Define the related product groups for a given product

root allOf Common fields

Common fields

Type: object

root allOf Common fields eventHeader
Type: object

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

root allOf Common fields eventHeader source
Type: enum (of string)

The application source of this event

Must be one of:

  • "OPCO"

root allOf Common fields eventHeader version
Type: enum (of string)

The version of the json format event

Must be one of:

  • "v1"

root allOf Common fields productId
Type: string

Product unique identifier.

Must be at least 1 characters long


Example:

"9554961192345"

root allOf Common fields id
Type: string

The ID of the related product group

Must be at least 1 characters long


Example:

"01255478"
root allOf Action

Action


root allOf Action oneOf UPSERT

UPSERT

Type: object

Used to add new or update existing related product groups for a given product

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

Action defines if the related product groups have to be:
- UPSERT: added or updated
- DELETE: deleted

Must be one of:

  • "UPSERT"

root allOf Action oneOf UPSERT sequence
Type: integer

The order in which the group is displayed. The group with the lowest number is displayed first
Example:

"01255478"

root allOf Action oneOf UPSERT name

Multilingual Object

Type: object

The localized name of this related product group
Example:

{
    "fr-FR": "Accessoires",
    "nl-BE": "Accessories"
}

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 allOf Action oneOf UPSERT name ^[a-z]{2}-[A-Z]{2}$
Type: string

Each additional property must conform to the following schema

root allOf Action oneOf UPSERT name additionalProperties
Type: string
Must match regular expression: $fake pattern for invalid keys to help codegen

root allOf Action oneOf UPSERT productList
Type: array of string

List of products related to the product {productId} and associated with the product group {name}

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root allOf Action oneOf UPSERT productList productList items
Type: string

Product unique identifier.
Example:

"9554961192345"
root allOf Action oneOf DELETE

DELETE

Type: object

Used to delete a related product group for a given product

root allOf Action oneOf DELETE action
Type: enum (of string)

Action defines if the related product groups have to be:
- UPSERT: added or updated
- DELETE: deleted

Must be one of:

  • "DELETE"