Get Product Fields by Filter catalog.product.getFieldsByFilter
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
catalogWho can execute the method: a user with the "View product catalog", "View catalog products", or "Edit selling price" permission
The catalog.product.getFieldsByFilter method retrieves the descriptions of simple product fields in the specified catalog, including catalog properties.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
filter* |
An object with the catalog identifier (detailed description) |
Filter Parameter
Required parameters are marked with *
|
Name |
Description |
|
iblockId* |
Identifier of the product trade catalog. You can retrieve the identifier using the catalog.catalog.list method. For a variation catalog, the method returns the |
The method always returns the fields of a simple product. The productType key in filter is ignored.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"iblockId":25}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.getFieldsByFilter
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"iblockId":25},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.product.getFieldsByFilter
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type FieldItem = {
isImmutable: boolean
isReadOnly: boolean
isRequired: boolean
name: string
type: string
isDynamic?: boolean
isMultiple?: boolean
propertyType?: string
userType?: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type ProductFieldsByFilterResult = {
product: Record<string, FieldItem>
}
try {
const response = await $b24.actions.v2.call.make<ProductFieldsByFilterResult>({
method: 'catalog.product.getFieldsByFilter',
params: {
filter: {
iblockId: 25,
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.product)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getProductFieldsByFilter() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.product.getFieldsByFilter',
params: {
filter: {
iblockId: 25,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.product)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getProductFieldsByFilter)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product.get_fields_by_filter(
filter={
"iblockId": 25,
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'catalog.product.getFieldsByFilter',
[
'filter' => [
'iblockId' => 25,
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'catalog.product.getFieldsByFilter',
{
filter: {
iblockId: 25,
}
},
function(result) {
if (result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.product.getFieldsByFilter',
[
'filter' => [
'iblockId' => 25
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.product.getFieldsByFilter", b24.Params{
"filter": b24.Params{
"iblockId": 25,
},
})
if err != nil {
return fmt.Errorf("catalog.product.getFieldsByFilter: %w", err)
}
// The method wraps the response in an object with the "product" key.
raw, ok := b24.Unwrap(res.Result, "product")
if !ok {
return fmt.Errorf("no product key in the response")
}
fmt.Printf("%s\n", raw)
Response Handling
HTTP status: 200
{
"result": {
"product": {
"active": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Active",
"type": "char"
},
"available": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"name": "Available for purchase",
"type": "char"
},
"bundle": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"name": "In bundle",
"type": "char"
},
"code": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Symbolic code",
"type": "string"
},
"dateActiveFrom": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "DATE_ACTIVE_FROM",
"type": "datetime"
},
"dateCreate": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Created on",
"type": "datetime"
},
"detailPicture": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Full image",
"type": "file"
},
"iblockId": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": true,
"name": "Information block ID",
"type": "integer"
},
"iblockSection": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Sections",
"type": "list"
},
"iblockSectionId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Main section",
"type": "integer"
},
"id": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"name": "ID",
"type": "integer"
},
"measure": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Unit of measurement",
"type": "integer"
},
"name": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": true,
"name": "Name",
"type": "string"
},
"previewPicture": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Preview image",
"type": "file"
},
"property301": {
"isDynamic": true,
"isImmutable": false,
"isMultiple": false,
"isReadOnly": false,
"isRequired": false,
"name": "Article number",
"propertyType": "S",
"type": "productproperty",
"userType": ""
},
"property305": {
"isDynamic": true,
"isImmutable": false,
"isMultiple": true,
"isReadOnly": false,
"isRequired": false,
"name": "Material",
"propertyType": "S",
"type": "productproperty",
"userType": null
},
"purchasingCurrency": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Purchase price currency",
"type": "string"
},
"purchasingPrice": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Purchase price",
"type": "string"
},
"quantity": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Quantity in stock",
"type": "double"
},
"type": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"name": "Product type",
"type": "integer"
},
"vatId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Tax ID",
"type": "integer"
},
"vatIncluded": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Tax included",
"type": "char"
},
"xmlId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "External ID",
"type": "string"
}
}
},
"time": {
"start": 1793892123,
"finish": 1793892123.226906,
"duration": 0.22690606117248535,
"processing": 0,
"date_start": "2026-11-05T18:22:03+01:00",
"date_finish": "2026-11-05T18:22:03+01:00",
"operating_reset_at": 1793892720,
"operating": 0
}
}
The method returns the descriptions of all product fields and catalog properties. The example shows some of the fields.
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
result.product |
An object in the format Catalog properties are returned with the
|
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error": "200040300010",
"error_description": "Access Denied"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Cause |
|
|
|
|
The user has none of the "View product catalog", "View catalog products", or "Edit selling price" permissions |
|
|
|
|
The required |
|
|
|
|
The |
|
|
|
|
The |
|
|
|
|
The information block with the specified |
|
|
|
|
A variation catalog identifier was passed. Pass the identifier of the product catalog |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Add Product catalog.product.add
- Update Product catalog.product.update
- Get Product by ID catalog.product.get
- Get a List of Products by Filter catalog.product.list
- Download Product Files catalog.product.download
- Delete Product catalog.product.delete
- Get Product Fields by Filter v 3.0 catalog.product.fields.getbyfilter