Get Product Fields crm.product.fields

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: crm

Who can execute the method: any user

DEPRECATED

The development of this method has been halted. Please use catalog.product.getFieldsByFilter.

The method crm.product.fields returns the description of product fields.

No parameters required.

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.product.fields
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.product.fields
        
try
        {
            const response = await $b24.callMethod(
                "crm.product.fields",
                {}
            );
            
            const result = response.getData().result;
            if(result.error())
            {
                console.error(result.error());
            }
            else
            {
                console.dir(result);
            }
        }
        catch(error)
        {
            console.error('Error:', error);
        }
        
try {
            $fieldsResult = $serviceBuilder->getCRMScope()->product()->fields();
            $fieldsDescription = $fieldsResult->getFieldsDescription();
            foreach ($fieldsDescription as $field) {
                if (isset($field['DATE_CREATE'])) {
                    $field['DATE_CREATE'] = (new DateTime($field['DATE_CREATE']))->format(DateTime::ATOM);
                }
                
                if (isset($field['TIMESTAMP_X'])) {
                    $field['TIMESTAMP_X'] = (new DateTime($field['TIMESTAMP_X']))->format(DateTime::ATOM);
                }
                
                print($field['ID'] . ': ' . $field['NAME'] . PHP_EOL);
            }
        } catch (Throwable $e) {
            print('Error: ' . $e->getMessage() . PHP_EOL);
        }
        
BX24.callMethod(
            "crm.product.fields",
            {},
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.product.fields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Returned Data

Required parameters are marked with *

Name
type

Description

ACTIVE
char

Active

CATALOG_ID
integer

Catalog identifier

CREATED_BY
integer

Created by

CURRENCY_ID
string

Currency identifier

DATE_CREATE
datetime

Product creation date

DESCRIPTION
string

Description

DESCRIPTION_TYPE
string

Description type

DETAIL_PICTURE
product_file

Detailed picture, field available in the old product card

ID
integer

Product identifier

MEASURE
integer

Unit of measure

MODIFIED_BY
integer

Modified by

NAME*
string

Name

PREVIEW_PICTURE
product_file

Preview picture, field available in the old product card

PRICE
double

Price

SECTION_ID
integer

Section identifier

SORT
integer

Sort order

TIMESTAMP_X
datetime

Product modification date

VAT_ID
integer

VAT rate identifier

VAT_INCLUDED
char

VAT included in price

XML_ID
string

External code