Get Product Catalog Fields crm.catalog.fields

Scope: crm

Who can execute the method: any user

The method returns the description of the product catalog fields.

No parameters.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.catalog.fields
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/crm.catalog.fields?auth=**put_access_token_here**
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.catalog.fields',
        		{}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.catalog.fields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching catalog fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.catalog.fields",
            {},
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.catalog.fields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Returned Data

Name
type

Description

ID
integer

Identifier. Read-only

NAME
string

Title

ORIGINATOR_ID
string

Identifier of the data source. Used only for linking to an external source

ORIGIN_ID
string

Identifier of the element in the data source. Used only for linking to an external source

XML_ID
string

Symbolic code. Read-only