catalog.product.list

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

The method gets list of commercial catalog products by filter.

When successful, returns list of products in the response body.

Parameters

Additionally, there are two additional values:

• * – return all fields, including properties;
• property_* – return values of all properties (not fields)

Both these values must be used only in case of extra necessity, because they can may create excessive server load.


Its recommended also to specify all fields which are used in the key order.

Parameter	Type	Description
select	object	Fields, corresponding to the available list of getFieldsByFilter.
filter	object	Fields, corresponding to the available list of getFieldsByFilter.
order	object	Fields, corresponding to the available list of getFieldsByFilter.
start	string	Retrieved page number. Works for https queries.

Examples

For 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();
});

For HTTPS

https://your_account/rest/catalog.product.list?auth=_authentication_key_&start=50