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

Configurators

Type: array

List of configurators to be deleted or to be upserted for a list of products. These configurators will be displayed on the PDP and thus integrated into the customer's experience, improving user engagement and efficiency.

 No Additional Items

Each item of this array must be:

root Configurator

Configurator

Type: object

A configurator to be deleted or to be upserted for a list of products

root Configurator oneOf UPSERT

UPSERT

Type: object

UPSERT action is used to add a new configurator or update an existing a configurator for products.
If the configurator does not exist, the UPSERT action adds the configurator and its associated products.
If the configurator exists, the UPSERT action updates the configurator for its associated products.

 No Additional Properties

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

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

Must be one of:

  • "UPSERT"

root Configurator oneOf UPSERT configuratorId

Configurator ID

Type: string

The unique identifier for a configurator
Examples:

"supplier123"

"configurator456"

root Configurator oneOf UPSERT productIds

ProductIds

Type: array of string

The list of productIds associated with the configurator

 No Additional Items

Each item of this array must be:

root Configurator oneOf UPSERT productIds productIds items
Type: string

Examples:

[
    "productId1",
    "productId2"
]

[
    "productId3"
]
root Configurator oneOf DELETE

DELETE

Type: object

DELETE action is used to delete a configurator for all of its associated products.
If the configurator does not exist, the DELETE action is ignored.
If the configurator exists, the DELETE action deletes the configurator for all of its associated products.

 No Additional Properties

root Configurator oneOf DELETE action
Type: enum (of string) Default: "DELETE"

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

Must be one of:

  • "DELETE"

root Configurator oneOf DELETE configuratorId

Configurator ID

Type: string

The unique identifier for a configurator
Examples:

"supplier123"

"configurator456"

Examples:

{
    "configuratorId": "supplier123",
    "action": "UPSERT",
    "productIds": [
        "productId1",
        "productId2"
    ]
}

{
    "configuratorId": "configurator456",
    "action": "DELETE"
}

Example:

[
    {
        "configuratorId": "supplier123",
        "action": "UPSERT",
        "productIds": [
            "productId1",
            "productId2"
        ]
    },
    {
        "configuratorId": "configurator456",
        "action": "DELETE"
    }
]