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

ProductsExclusion

Type: array of object

The list of excluded products by accountId or commercial org

 No Additional Items

Each item of this array must be:

root root items
Type: object
No Additional Properties

root root items action
Type: enum (of string)

Action defines if the exclusion has to be added/updated or deleted

Must be one of:

  • "UPSERT"
  • "DELETE"

root root items list
Type: array of object
No Additional Items

Each item of this array must be:

root root items list list items

root root items list list items oneOf AccountExclusionEntry
Type: object

a list of product to exclude from the catalog for an account

root root items list list items oneOf item 0 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

root root items list list items oneOf item 0 productId
Type: string

The unique product identifier depending on each opcos backend system (like ERP product ID)
root root items list list items oneOf OrganisationExclusionEntry
Type: object

a list of product to exclude for from catalog for an organisation

root root items list list items oneOf item 1 orgId
Type: string

the identifier of the organisation

root root items list list items oneOf item 1 productId
Type: string

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

Example:

[
    {
        "action": "DELETE",
        "list": [
            {
                "accountId": "123456789",
                "productId": "productId11"
            },
            {
                "orgId": "org2",
                "productId": "productId22"
            }
        ]
    },
    {
        "action": "UPSERT",
        "list": [
            {
                "accountId": "123456789",
                "productId": "productId33"
            },
            {
                "accountId": "987654321",
                "productId": "productId44"
            },
            {
                "orgId": "org1",
                "productId": "productId45"
            },
            {
                "orgId": "org2",
                "productId": "productId46"
            }
        ]
    },
    {
        "action": "UPSERT",
        "list": [
            {
                "accountId": "123456789",
                "productId": "productId1"
            },
            {
                "accountId": "123456789",
                "productId": "productId2"
            },
            {
                "accountId": "123456789",
                "productId": "productId3"
            },
            {
                "accountId": "123456789",
                "productId": "productId4"
            },
            {
                "accountId": "123456789",
                "productId": "productId5"
            },
            {
                "accountId": "987654321",
                "productId": "productId3"
            },
            {
                "accountId": "987654321",
                "productId": "productId2"
            },
            {
                "accountId": "987654321",
                "productId": "productId5"
            },
            {
                "accountId": "987654321",
                "productId": "productId4"
            },
            {
                "orgId": "org1",
                "productId": "productId3"
            },
            {
                "orgId": "org1",
                "productId": "productId2"
            },
            {
                "orgId": "org1",
                "productId": "productId5"
            },
            {
                "orgId": "org1",
                "productId": "productId7"
            },
            {
                "orgId": "org2",
                "productId": "productId20"
            },
            {
                "orgId": "org2",
                "productId": "productId50"
            },
            {
                "orgId": "org3",
                "productId": "productId40"
            },
            {
                "orgId": "org4",
                "productId": "productId70"
            }
        ]
    }
]