# sale.status.get

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

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

## Описание

Метод `sale.status.get` получает значения всех полей статуса.

## Параметры

- `id` `sale_status.id` — обязательный. Символьный идентификатор статуса

## Ответ

HTTP-статус: 200

```json
{
    "result":{
        "status":{
            "color":"#BEEDF1",
            "id":"N",
            "notify":"Y",
            "sort":10,
            "type":"O",
            "xmlId":null
        }
    },
    "time":{
        "start":1712144798.388861,
        "finish":1712144798.636187,
        "duration":0.24732613563537598,
        "processing":0.012362003326416016,
        "date_start":"2024-04-03T14:46:38+03:00",
        "date_finish":"2024-04-03T14:46:38+03:00"
    }
}
```

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

- `result` `object`. Корневой элемент ответа
- `status` `sale_status`. Информация о статусе
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error":201340400001,
    "error_description":"status is not exists"
}
```

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

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

### cURL (Webhook)

```http
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":"N"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.status.get
```

### cURL (OAuth)

```http
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":"N","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.status.get
```

### 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 SaleStatusGetResult = {
  status: {
    color: string
    id: string
    notify: string
    sort: number
    type: string
    xmlId: string | null
  }
}

try {
  const response = await $b24.actions.v2.call.make<SaleStatusGetResult>({
    method: 'sale.status.get',
    params: {
      id: 'N',
    },
    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(result.status)
  }
} 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 getSaleStatus() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.status.get',
        params: {
          id: 'N',
        },
        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(result.status)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

### Python

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

try:
    bitrix_response = client.sale.status.get(
        bitrix_id='N',
    ).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.get',
            [
                'id' => 'N',
            ]
        );

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

    if ($result->error()) {
        error_log($result->error());
        echo 'Error: ' . $result->error();
    } else {
        echo 'Info: ' . print_r($result->data(), true);
    }

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

### BX24.js

```js
BX24.callMethod(
    "sale.status.get", {
        "id": "N"
    },
    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.get', [
    'id' => 'N'
]);

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.status.get", b24.Params{
	"id": "N",
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("sale.status.get: %w", err)
}

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

var item 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, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Color, item.ID)
```

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