# sale.status.list

URL: https://chugunov.pro/api-bitrix24/sale/status/sale-status-list/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить список статусов
Scope: `sale`
Кто может выполнять метод: администратор

## Описание

Метод `sale.status.list` получает список статусов.

## Параметры

- `select` `array` — необязательный. Массив со списком полей, которые необходимо выбрать (смотрите поля объекта [sale_status](https://apidocs.bitrix24.ru/api-reference/sale/data-types.html)).
  Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля статусов
- `filter` `object` — необязательный. Объект для фильтрации выбранных групп свойств в формате `{"field_1": "value_1", ... "field_N": "value_N"}`.
  Возможные значения для `field` соответствуют полям объекта [sale_status](https://apidocs.bitrix24.ru/api-reference/sale/data-types.html).
  Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
  - `>=` — больше либо равно
  - `>` — больше
  - `<=` — меньше либо равно
  - `<` — меньше
  - `%` — LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  - `=%` — LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры:
      - `"мол%"` — ищет значения, начинающиеся с «мол»
      - `"%мол"` — ищет значения, заканчивающиеся на «мол»
      - `"%мол%"` — ищет значения, где «мол» может быть в любой позиции
  - `%=` — LIKE (аналогично `=%`)
  - `!%` — NOT LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск идет с обеих сторон
  - `!=%` — NOT LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры:
      - `"мол%"` — ищет значения, не начинающиеся с «мол»
      - `"%мол"` — ищет значения, не заканчивающиеся на «мол»
      - `"%мол%"` — ищет значения, где подстроки «мол» нет в любой позиции
  - `!%=` — NOT LIKE (аналогично `!=%`)
  - `=` — равно, точное совпадение (используется по умолчанию)
  - `!=` — не равно
  - `!` — не равно
- `order` `object` — необязательный. Объект для сортировки выбранных статусов в формате `{"field_1": "order_1", ... "field_N": "order_N"}`.
  Возможные значения для `field` соответствуют полям объекта [sale_status](https://apidocs.bitrix24.ru/api-reference/sale/data-types.html).
  Возможные значения для `order`:
  - `asc` — в порядке возрастания
  - `desc` — в порядке убывания
- `start` `integer` — необязательный. Параметр используется для управления постраничной навигацией.
  Размер страницы результатов всегда статичный — 50 записей.
  Чтобы выбрать вторую страницу результатов, передайте значение `50`. Чтобы выбрать третью страницу результатов — значение `100` и так далее.
  Формула расчета значения параметра `start`:
  `start = (N-1) * 50`, где `N` — номер нужной страницы

## Ответ

HTTP-статус: 200

```json
{
    "result":{
        "statuses":[
            {
                "color":"#BEEDF1",
                "id":"N",
                "notify":"Y",
                "sort":10,
                "type":"O",
                "xmlId":null
            }
        ]
    },
    "total":1,
    "time":{
        "start":1712655587.593758,
        "finish":1712655587.816158,
        "duration":0.22239995002746582,
        "processing":0.016273975372314453,
        "date_start":"2024-04-09T12:39:47+03:00",
        "date_finish":"2024-04-09T12:39:47+03:00"
    }
}
```

### Возвращаемые данные

- `result` `object`. Корневой элемент ответа
- `status` `sale_status[]`. Массив объектов с информацией о выбранных статусах
- `total` `integer`. Общее количество найденных записей
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error":0,
    "error_description":"error"
}
```

- `200040300010` — Недостаточно прав для чтения статусов
- `0` — Другие ошибки (например, фатальные ошибки)

## Примеры запроса

### cURL (Webhook)

```http
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","type","notify","color","sort","xmlId"],"filter":{"id":"N"},"order":{"type":"asc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.status.list
```

### cURL (OAuth)

```http
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","type","notify","color","sort","xmlId"],"filter":{"id":"N"},"order":{"type":"asc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.status.list
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type SaleStatusListResult = {
  statuses: {
    id: string
    type: string
    notify: string
    color: string
    sort: number
    xmlId: string | null
  }[]
}

try {
  // sale.status.list returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<SaleStatusListResult>({
    method: 'sale.status.list',
    params: {
      select: [
        'id',
        'type',
        'notify',
        'color',
        'sort',
        'xmlId',
      ],
      filter: {
        id: 'N',
      },
      order: {
        type: 'asc',
      },
      start: 0,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Statuses:', result.statuses, 'Count:', result.statuses.length)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function fetchStatusList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // sale.status.list returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'sale.status.list',
        params: {
          select: [
            'id',
            'type',
            'notify',
            'color',
            'sort',
            'xmlId',
          ],
          filter: {
            id: 'N',
          },
          order: {
            type: 'asc',
          },
          start: 0,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Statuses:', result.statuses, 'Count:', result.statuses.length)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', fetchStatusList)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.sale.status.list(
        select=[
            "id",
            "type",
            "notify",
            "color",
            "sort",
            "xmlId",
        ],
        filter={
            "id": "N",
        },
        order={
            "type": "asc",
        },
        start='1712655587.593758',
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'sale.status.list',
            [
                'select' => [
                    'id',
                    'type',
                    'notify',
                    'color',
                    'sort',
                    'xmlId',
                ],
                'filter' => [
                    'id' => 'N',
                ],
                'order' => [
                    'type' => 'asc',
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error fetching sale status list: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    "sale.status.list", {
        "select": [
            "id",
            "type",
            "notify",
            "color",
            "sort",
            "xmlId",
        ],
        "filter": {
            "id": "N",
        },
        "order": {
            "type": "asc",
        }
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.info(result.data());
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call('sale.status.list', [
    'select' => [
        'id',
        'type',
        'notify',
        'color',
        'sort',
        'xmlId',
    ],
    'filter' => [
        'id' => 'N',
    ],
    'order' => [
        'type' => 'asc',
    ]
]);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.status.list", b24.Params{
	"select": []string{"id", "type", "notify", "color", "sort", "xmlId"},
	"filter": b24.Params{
		"id": "N",
	},
	"order": b24.Params{
		"type": "asc",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("sale.status.list: %w", err)
}

// Метод заворачивает ответ в объект с ключом "statuses".
raw, ok := b24.Unwrap(res.Result, "statuses")
if !ok {
	return fmt.Errorf("в ответе нет ключа statuses")
}

var items []struct {
	Color  string `json:"color"`
	ID     string `json:"id"`
	Notify string `json:"notify"`
	Sort   int    `json:"sort"`
	Type   string `json:"type"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.Color)
}
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/sale/status/sale-status-list.html