Documentation

catalog.document.element.list

Scope: catalog Permissions to execute: for all

catalog.document.element.list(order, filter, select, offset, limit)

Method gets list of products in the inventory management items.

Returns list of items on in response body on success.

Parameters

ParameterType Description
orderarray Sorting.
filterarray Filter.
selectarray List of retrieved fields.
offsetinteger Selection page, operates the same as start.
startstring Print page number. Works for https queries.
limitinteger Page size from 1 to 500 (when set to 0 or higher than maximum, uses the default value 50).

Example

BX24.callMethod(
    'catalog.document.element.list', 
    {
        'order': {
            'ID': 'ASC',
        },
        'filter': {
          '>ID': 0,
        },
        'offset': 0,
        'limit': 50,
    }, 
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.log(result.data());
    }
);
$result = CRest::call(
    'catalog.document.element.list',
    [
        'order' => [
            'ID' => 'ASC',
        ],
        'filter' => [
            '>ID' => 0,
        ],
        'offset' => 0,
        'limit' => 5,
    ]
);

echo '<pre>';
print_r($result);
echo '</pre>';

© «Bitrix24», 2001-2024