Get a list of section settings for properties catalog.productPropertySection.list

We are still updating this page

Some data may be missing — we will fill it in shortly.

Scope: catalog

Who can execute the method: any user

catalog.productPropertySection.list(select, filter, order, start)
        

The method retrieves a list of section settings for product properties or variations based on the filter.

Parameters

Parameter

Description

select
object

Fields corresponding to the available list of fields fields, as well as propertyId (identifier of product properties or variations)

filter
object

Fields corresponding to the available list of fields fields, as well as propertyId (identifier of product properties or variations)

order
object

Fields corresponding to the available list of fields fields, as well as propertyId (identifier of product properties or variations)

start
string

Page number for output. Works for HTTPS requests

Required parameters are marked with *

Examples

// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            'catalog.productPropertySection.list',
            {
              filter: {
                propertyId: 128
              }
            },
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('catalog.productPropertySection.list', { filter: { propertyId: 128 } }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('catalog.productPropertySection.list', { filter: { propertyId: 128 } }, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.productPropertySection.list',
                    [
                        'filter' => [
                            'propertyId' => 128
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error()->ex);
            } else {
                echo 'Success: ' . print_r($result->data(), true);
                $result->next();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error listing product property sections: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'catalog.productPropertySection.list',
            {
                filter:{
                    propertyId: 128
                },
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error().ex);
                else
                    console.log(result.data());
                result.next();
            }
        );
        

Example HTTPS request

https://your_account/rest/catalog.productPropertySection.list?auth=_authorization_key_&start=50
        

How to Use Examples in Documentation