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

catalog.product.list

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

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

Метод получает список товаров торгового каталога по фильтру.

Если операция успешна, возвращается список товаров в теле ответа.

Параметры

ПараметрТип Описание
selectobject Поля, соответствующие доступному списку полей getFieldsByFilter.

Кроме того, имеются два дополнительных значения:
  • * – вернуть все поля, включая свойства;
  • property_* – вернуть значения всех свойств (не полей)

Оба этих значения необходимо использовать только в случае крайней необходимости, поскольку их применение может создать нагрузку на сервер.

Внимание! Поля id и iblockId необходимо указывать всегда, даже при использовании вышеперечисленных ключей.

Рекомендуется также указывать все поля, которые используются в ключе order.
filterobject Поля, соответствующие доступному списку полей getFieldsByFilter.
orderobject Поля, соответствующие доступному списку полей getFieldsByFilter.
startstring Номер страницы вывода. Работает для https запросов.


Примеры

Для JS

BX24.callMethod(
	'catalog.product.list',
	{
		select: [
			'id',
			'iblockId',
			'name',
		],
		filter:{
			'iblockId' : 14,
			'>property109':{
				value: '2019-03-01T16:10:00+02:00'
			}
		},
		order:{
			'id': 'ASC'
		},
	},
	function(result)
	{
		if(result.error())
			console.error(result.error().ex);
		else
			console.log(result.data());
		result.next();
	}
);

Для HTTPS

https://ваш_портал/rest/catalog.product.list?auth=_ключ_авторизации_&start=50

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