Bitrix Site Manager

CSaleStatus::GetList

CDBResult
CSaleStatus::GetList(
 string &by,
 string &order,
 string strLang = LANGUAGE_ID
);

The method GetList returns an optionally sorted and filtered list of order statuses.

Parameters

ParameterDescription
by Specifies the name of a parameter by which the sorting is to be performed. 

The following values are possible:
  • SORT - sort weight (default);
  • ID - the status ID;
  • NAME - the status name.
order Sort order. Can be one of the following:
  • ASC - ascending;
  • DESC - descending.
strLang The ID of the language in which the parameters are to be retrieved. By default, the current language is used.

Return Values

Returns an instance of CDBResult containing a set of associated arrays with the following keys.

Key Description
ID The order status ID.
SORT Sort weight.
LID The language ID.
NAME The status name.
DESCRIPTION Status description.