Set Section Settings for catalog.productPropertySection.set

We are still updating this page

Some data may be missing here — we will complete it shortly.

Scope: catalog

Who can execute the method: any user

The method sets (creates or updates) section settings for product properties or variations.

Parameter

Description

propertyId
integer

Identifier of the product or variation property.

fields
object

An array containing the following fields:

  • smartFilter – show in smart filter (Y/N);
  • displayType – view in smart filter; possible values:
    • "F" – checkboxes;
    • "K" – radio buttons;
    • "P" – dropdown list.
  • displayExpanded – show expanded (Y/N);
  • filterHint – hint in the smart filter for visitors.

Example

try
        {
        	const response = await $b24.callMethod(
        		'catalog.productPropertySection.set',
        		{
        			propertyId: 128,
        			fields: {
        				displayType: "F",
        				displayExpanded: "Y",
        				filterHint: "Product Size"
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        	{
        		console.error(result.error().ex);
        	}
        	else
        	{
        		console.log(result);
        	}
        }
        catch(error)
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.productPropertySection.set',
                    [
                        'propertyId' => 128,
                        'fields' => [
                            'displayType'     => "F",
                            'displayExpanded' => "Y",
                            'filterHint'      => "Product Size"
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error()->ex);
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting product property section: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'catalog.productPropertySection.set',
            {
                propertyId: 128,
                fields: {
                    displayType: "F",
                    displayExpanded: "Y",
                    filterHint: "Product Size"
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error().ex);
                else
                    console.log(result.data());
            }
        );

How to Use Examples in Documentation

Previous
Get List of Section Property Settings
Next
Overview of Methods