Configuring product placement suggestions

To configure product placement suggestions in the PIM, the following steps should be executed:

• Collect the IDs (Guids) of example products to use
• For each attribute to be used as an example attribute, collect the following:
  • Attribute ID (Guid)
  • System Name of the attribute field (e.g. VALUE, NAME)
• For each master data property to be used as an example attribute, collect the following:
  • System Name (e.g. ProductName)
• Call the POST /api/baia/product-category-placement-suggestions/-configuration endpoint on the PIM preview API, using the information collected in the previous steps

Here is an example of the request model for the POST /api/baia/product-category-placement-suggestions/-configuration endpoint:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

{
    "exampleProducts": [
        "2198c95b-68bd-4980-aeab-228546c013f3",
        "959ba885-ac10-487a-9c30-c7a23a5a2803",
        "e13bed2b-0731-47a1-aced-837e2f9db155"
    ],
    "exampleRelevantAttributes": [
        {
            "ordinal": "AttributeFieldConfiguration",
            "attributeFieldConfiguration": {
                "id": "04c094e2-4d22-4938-bfab-50b1547c55ee",
                "fieldSystemName": "VALUE"
            }
        },
        {
            "ordinal": "AttributeFieldConfiguration",
            "attributeFieldConfiguration": {
                "id": "6b7a2e8d-a8c5-4ee5-a914-5848442a43c3",
                "fieldSystemName": "VALUE"
            }
        },
        {
            "ordinal": "MasterDataProperty",
            "masterDataProperty": "ProductName"
        }
    ]
}

After execution of these steps, the product placement suggestions feature becomes available in the PIM UI.