Документация для разработчиков
Темная тема

catalog.product.getFieldsByFilter

Scope: catalog Права на выполнение: для всех

Описание, параметры, пример

catalog.product.getFieldsByFilter(filter)

Метод возвращает поля товара торгового каталога по фильтру.

Параметры

ПараметрТип Описание
filterobjectВ фильтр передаются обязательных поля:
  • iblockId - тип информационного блока;
  • productType - тип продукта:
    • [1] => простой
    • [2] => комплект
    • [3] => товар с предложениями
    • [4] => предложение
    • [5] => предложение без товара
  • iblockSectionId - идентификатор раздела.
  • name - название.


Примеры

BX24.callMethod(
	'catalog.product.getFieldsByFilter', 
	{
		filter: {
			iblockId: 13,
			productType: 1
		}
	},
	function(result) {
		if (result.error())
			console.error(result.error().ex);
		else
			console.log(result.data());
	}
);

Возвращаемые поля

Поле ОписаниеТипПримечание
active Активность char
available Доступность char Только для чтения
bundle Набор char Только для чтения
canBuyZero Покупка при отсутствии char
code Символьный код string
createdBy Кем создан (id) integer
dateActiveFrom Начало активности datetime
dateActiveTo Окончание активности datetime
dateCreate Дата создания datetime
detailPicture Детальная картинка file
detailText Детальное описание string
detailTextType Тип детального описания string
height Высота double
iblockId Идентификатор информационного блока integer Обязательное поле.
iblockSectionId Идентификатора раздела информационного блока integer Обязательное поле.
id Идентификатор товара integer Только для чтения.
length Длина double
measure Единица измерения integer
modifiedBy Кем изменен integer
name Название string Обязательное поле.
negativeAmountTrace Разрешение отрицательного количества товара char Только для чтения.
previewPicture Картинка для анонса file
previewText Описание для анонса string
previewTextType Тип описания для анонса string
priceType Тип цены char
propertyN Свойства товара array Зависит от типа свойства. Массив включает в себя value (описание свойства в зависимости от типа) и valueId (идентификатор свойства).
purchasingCurrency Валюта string
purchasingPrice Цена string
quantity Доступное количество double
quantityReserved Зарезервированное количество double
quantityTrace Включить количественный учет char
sort Сортировка integer
subscribe Подписка на товар char
timestampX Дата изменения datetime
type Тип integer Только для чтения.
vatId Идентификатор НДС integer
vatIncluded НДС включен в цену char
weight Вес double
width Ширина double
xmlId Внешний код string


© «Битрикс», 2001-2024, «1С-Битрикс», 2024