GetList

• id - element ID. Can have the following values:
  • asc - by ascension;
  • desc - by descension;
  • array with IDs - in this case the elements will be printed in the order as listed in the array. (From version 18.6.700)
    Important! The same array must be passed to the filter (parameter arFilter).

• sort - sort index;
• timestamp_x - modification date;
• name - name;
• active_from or date_active_from - date an element is active from;
• active_to or date_active_to - date an element is active till;
• status - workflow status of an element;
• code - element mnemonic code;
• iblock_id - information block ID;
• modified_by - ID of the last user who modified an element;
• active - element is active;
• show_counter - number of the element shows (counted by CounterInc);
• show_counter_start - time of the first show (counted by CounterInc);
• shows - average shows (shows / show duration);
• rand - random order;
• xml_id or external_id – the external ID;
• tags – specifies the item tags;
• created – by the creation time;
• created_date – by the date the item was created (without time);
• cnt – by the number of items (if using the grouping only);
• property_<PROPERTY_CODE> - by value of the property identified by the PROPERTY_CODE (e.g. PROPERTY_123 or PROPERTY_NEWS_SOURCE)
• propertysort_<PROPERTY_CODE> - by the sort index of a property variant. This key is for the list properties only;
• catalog_<CATALOG_FIELD>_<PRICE_TYPE> - by the field CATALOG_FIELD (can be PRICE, CURRENCY or PRICE_SCALE - price with currency factored in) of price of the type PRICE_TYPE (e.g. catalog_PRICE_1 or CATALOG_CURRENCY_3). Starting from Commercial catalog module version 16.0.3, the sorting by price will account the currency as well.
• IBLOCK_SECTION_ID - section ID;
• *CATALOG_QUANTITY - total product quantity;
• *CATALOG_WEIGHT - product weight;
• *CATALOG_AVAILABLE - product availability attribute (Y|N). Product is deemed as unavailable, if its quantity is lower or equals to zero, stock control is enabled and the option 'Make out-of-stock items available for purchase' is disabled.
• *CATALOG_STORE_AMOUNT_<warehouse_identifier> - sorting by product quantity at the specific warehouse (available starting from Commercial catalog module version 15.5.5).
• *CATALOG_BUNDLE - sorting by available set/bundle for a product (available starting from Commercial catalog module version 16.0.3).
• PROPERTY_<PROPERTY_CODE>.<FIELD> - by value of element field indicated as binding attribute.
• PROPERTY_<PROPERTY_CODE>.<FIELD> - by the value of an element binding field. FIELD can be one of the following:
  • ID
  • TIMESTAMP_X
  • MODIFIED_BY
  • CREATED
  • CREATED_DATE
  • CREATED_BY
  • IBLOCK_ID
  • ACTIVE
  • ACTIVE_FROM
  • ACTIVE_TO
  • SORT
  • NAME
  • SHOW_COUNTER
  • SHOW_COUNTER_START
  • CODE
  • TAGS
  • XML_ID
  • STATUS
• PROPERTY_<PROPERTY_CODE>.PROPERTY_<PROPERTY_CODE2> - by the value of an element binding property. PROPERTY_CODE is a mnemonic or symbolic code of a "link to element" property. PROPERTY_CODE2 is the property code of the bound elements.
• HAS_PREVIEW_PICTURE and HAS_DETAIL_PICTURE – by the availability or absence of images.
• order – by the element sort order:
  • asc - ascending;
  • nulls,asc - ascending, put empty values at the beginning;
  • asc,nulls - ascending, put empty values at the end;
  • desc - descending;
  • nulls,desc - descending, put empty values at the beginning;
  • desc,nulls - descending, put empty values at the end;
    
  This key is optional. The default value is Array("sort"=>"asc")

• ID - by the identifier;
• ACTIVE - by the active state (Y|N); passing an empty value ("ACTIVE"=>"") causes the method to return all elements disregarding their state;
• NAME - by name;
• CODE - by the mnemonic code;
• TAGS – by tags;
• XML_ID or EXTERNAL_ID - by the external ID;
• PREVIEW_TEXT - by the brief text;
• PREVIEW_TEXT_TYPE - by the brief text type (html|text);
• PREVIEW_PICTURE - by the code of a preamble image;
• DETAIL_TEXT - by the detailed text;
• DETAIL_TEXT_TYPE - by the detailed text type (html|text);
• DETAIL_PICTURE - by the code of a large image;
• CHECK_PERMISSIONS - if "Y", the selection will respect the permissions to access the information blocks. By default, the permissions are not checked.
• MIN_PERMISSION - minimum allowed access permission. Effective if only CHECK_PERMISSIONS is "Y". Default is "R". For the full list of access permissions, see CIBlock::SetPermission.
• SEARCHABLE_CONTENT - by the all available searchable content. Includes title, brief and detailed description text;
• SORT - by the sort weight;
• TIMESTAMP_X - by modification date;
• DATE_MODIFY_FROM – by the date/time the required elements was modified. Use this key to fetch elements modified after the time specified here in the website format. A NOT operator is possible: "!DATE_MODIFY_FROM";
• DATE_MODIFY_TO - by the date/time the required elements was modified. Use this key to fetch elements modified prior the time specified here in the website format. A NOT operator is possible: "!DATE_MODIFY_TO";
• MODIFIED_USER_ID or MODIFIED_BY- by the code of a user who modified an element;
• DATE_CREATE - by creation date;
• CREATED_USER_ID or CREATED_BY - by the code of a user who created an element;
• DATE_ACTIVE_FROM - by the date an element is active from. The date must be in the website format;
• DATE_ACTIVE_TO - by the date until which an element is active. The date must be in the website format;
• ACTIVE_DATE - a non-empty value enables sorting by fields DATE_ACTIVE_FROM and DATE_ACTIVE_TO. If the value is empty (""), no filtering is performed;
• IBLOCK_ID - by the information block ID;
• IBLOCK_CODE - by the information block mnemonic code;
• IBLOCK_SITE_ID or IBLOCK_LID or SITE_ID or LID - by site;
• IBLOCK_TYPE - by the information block type;
• IBLOCK_ACTIVE - by the information block active state (Y|N);
• SECTION_ID - by the parent section. If the SECTION_ID key is false, an empty string "" or zero (0), only the orphan elements without parent sections will be returned. Otherwise, the method returns the elements of the specified section ID. The SECTION_ID key may be an array, in which case the method will return elements of at least one of the specified sections. A NOT operator ("!") is possible, which negates the condition;
• SECTION_CODE – by the parent group mnemonic code; similar to SECTION_ID;
• INCLUDE_SUBSECTIONS - if the SECTION_ID is specified, selects elements of all child sections of this section;
• SUBSECTION - specifies to return only the elements belonging to a specified subsection. The key value may be a two-element array specifying the left and right boundaries in the subsection tree. A NOT operator ("!") is possible, which negates the condition;
• SECTION_ACTIVE – if "Y", returns only elements of active sections. If "N", returns only elements of inactive sections.
• SECTION_GLOBAL_ACTIVE – similar to SECTION_ACTIVE but also checks if the parent sections are active;
• SECTION_SCOPE - задает уточнение для фильтров SECTION_ACTIVE и SECTION_GLOBAL_ACTIVE. Если значение "IBLOCK", то учитываются только привязки к разделам инфоблока. Если значение "PROPERTY", то учитываются только привязки к разделам свойств. "PROPERTY_" - привязки к разделам конкретного свойства.
• *CATALOG_AVAILABLE - product availability attribute (Y|N). Product is deemed as unavailable, if its quantity is lower or equals to zero, stock control is enabled and the option 'Make out-of-stock items available for purchase' is disabled;
• *CATALOG_CATALOG_GROUP_ID_N - by price type;
• *CATALOG_SHOP_QUANTITY_N - filtering by quantity range in price;
• *CATALOG_QUANTITY - by total product quantity;
• *CATALOG_WEIGHT - by product weight;
• *CATALOG_STORE_AMOUNT<warehouse_identifier> - sorting by product quantity at the specific warehouse (available starting from Commercial catalog module version 15.0.2). Filter receives the product quantity available at the warehouse or false.
• *CATALOG_PRICE_SCALE_<price_type> - filtering by price with account of currency (available starting from Commercial catalog module version 16.0.3).
• *CATALOG_BUNDLE - filtering sorting by available set/bundle for a product (available starting from Commercial catalog module version 16.0.3).
• SUBQUERY - array

  $filter = array("SUBQUERY" => array(
       "FIELD" => "field name",
      "FILTER" => array(filter for selecting queries)
  ))

  with two parameters:
  • FIELD - [link=128069]string[/link], field name
  • FILTER - array, filter for filtering queries.
  Inside GetList converts to:

  ID => CIBlockElement::SubQuery($filter['SUBQUERY']['FIELD'], $filter['SUBQUERY']['FILTER'])

  Available starting from iblock module version 21.300.0.
• SHOW_COUNTER - by number of shows;
• SHOW_COUNTER_START - by the time of the first show;
• WF_COMMENTS - by the workflow comment;
• WF_STATUS_ID or WF_STATUS - by the workflow status;
• SHOW_HISTORY - if set to "Y", result will include history of elements. By default, only the published elements are selected;
• SHOW_NEW - if the SHOW_HISTORY is not set or not "Y" and SHOW_NEW is set to "Y", unpublished elements are also selected;
• WF_PARENT_ELEMENT_ID - by the code of the parent element in the workflow (for revision history);
• WF_NEW - by the unpublished state of an element (Y/N);
• WF_LOCK_STATUS - by the lock state in the workflow (red|green|yellow);
• PROPERTY_<PROPERTY_CODE> - specifies to filter by the property values. PROPERTY_CODE is the property or mnemonic code. This must be a number for list, number, bind to elements or bind to sections properties, or wildcard for other types;
• PROPERTY_<PROPERTY_CODE>_VALUE – for the list type properties. Specifies to filter by the list values (wildcard); the method will search by a string text rather than an ID;
• CATALOG_<CATALOG_FIELD>_<PRICE_TYPE> by the CATALOG_FIELD field of PRICE_TYPE price (the price type ID). CATALOG_FIELD may be: PRICE or CURRENCY.
• PROPERTY_<PROPERTY_CODE>.<FIELD> - specifies to filter by the field values of the bound elements. PROPERTY_CODE – is the binding property ID or mnemonic code. FIELD is a field of a bound element, can be one of the following: ACTIVE, DETAIL_TEXT_TYPE, PREVIEW_TEXT_TYPE, EXTERNAL_ID, NAME, XML_ID, TMP_ID, DETAIL_TEXT, SEARCHABLE_CONTENT, PREVIEW_TEXT, CODE, TAGS, WF_COMMENTS, ID, SHOW_COUNTER, WF_PARENT_ELEMENT_ID, WF_STATUS_ID, SORT, CREATED_BY, PREVIEW_PICTURE, DETAIL_PICTURE, IBLOCK_ID, TIMESTAMP_X, DATE_CREATE, SHOW_COUNTER_START, DATE_ACTIVE_FROM, DATE_ACTIVE_TO, ACTIVE_FROM, ACTIVE_TO, ACTIVE_DATE, DATE_MODIFY_FROM, DATE_MODIFY_TO, MODIFIED_USER_ID, MODIFIED_BY, CREATED_USER_ID, CREATED_BY.
• PRODUCT_BARCODE - by barcode.
• PRODUCT_BARCODE_STORE - by binding to barcode's warehouse.
• PRODUCT_BARCODE_ORDER - by binding to barcode's order.

• "!" - not equal;
• "<" – less than;
• "<=" - less than or equal;
• ">" - more than;
• ">=" - more than or equal;
• "><" - the value of the key is an array specifying the range of possible values (see the Remarks below).

• nTopCount - number of upper elements. Если задать nTopCount и хранить свойства в общей таблице, то этот параметр ограничивает именно количество запросов. Если есть множественные свойства, то это будет отдельный запрос. То есть чтобы сделать запрос к 2 элементам со множественным свойством из 2 и 3 значений, то nTopCount должен быть равен 5. Решение проблемы: переместить свойства в отдельную таблицу. ;
• nOffset - offset. Key operates only when passing non-empty value to the key nTopCount. Available from the iblock module version 21.700.100;
• bShowAll - directs to retrieve all elements.
• iNumPage - number of page;
• nPageSize - the desired number of elements per page;
• nElementID – the ID of an element that will be returned along with its neighbors. The number of neighbors is defined by the nPageSize key. Example: if nPageSize is 2, the maximum of 5 elements will be returned. The neighbors returned are defined by the arOrder parameter (see earlier). The following restrictions and rules apply when using the nElementID key:
  • If an element with such ID is missing from the returned data, the result is undefined.
  • The nElementID key cannot be used with the arGroupBy parameter.
  • The arSelect parameter must define an "ID" key.
  • The arOrder parameter is required.
  • The returned elements cannot be sorted by "catalog_*".
  • The returned array includes a RANK key containing the position of an element in the full selection (i.e. the one unrestricted by nElementID).

List of element fields can show the values of its properties. You must use the fields IBLOCK_ID and ID, otherwise it will operate incorrectly. Additionally, you need to indicate PROPERTY_<PROPERTY_CODE>, as one of fields, where PROPERTY_CODE - ID or symbolic code (specified in upper case, even if it's specified in lower case in the defined iblock property).

The result will print element properties as fields PROPERTY_<PROPERTY_CODE>_VALUE - value; PROPERTY_<PROPERTY_CODE>_ID - element code; PROPERTY_<PROPERTY_CODE>_ENUM_ID - value code (for list properties).

You can show element prices as well with the installed Commercial catalog module. You must indicate *CATALOG_GROUP_<PRICE_CODE>, where PRICE_CODE - price type ID.

Also, you can retrieve element fields by "Bind to elements" property values. You must indicate  PROPERTY_<PROPERTY_CODE>.<FIELD>, where PROPERTY_CODE - ID or binding property symbolic code, and FIELD - is the field of element specified in the binding. See "Bind element fields for sorting".

You can also fetch element property values by "Bind to element" property values. You must indicate  PROPERTY_<PROPERTY_CODE>.PROPERTY_<PROPERTY_CODE2>, where PROPERTY_CODE - ID or binding property code, and PROPERTY_CODE2 - element property specified in the binding.