# catalog.ratio.list

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

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

## Описание

Метод возвращает список коэффициентов единиц измерения.

## Параметры

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

## Ответ

HTTP-статус: 200

```json
{
    "result": {
        "ratios": [
            {
                "id": 1,
                "isDefault": "Y",
                "productId": 1,
                "ratio": 1
            }
        ]
    },
    "total": 1,
    "time": {
        "start": 1729676806.653016,
        "finish": 1729676807.083635,
        "duration": 0.4306190013885498,
        "processing": 0.02678680419921875,
        "date_start": "2024-10-23T12:46:46+03:00",
        "date_finish": "2024-10-23T12:46:47+03:00",
    }
}
```

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

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

## Ошибки

HTTP-статус: 400

```json
{
    "error":200040300010,
    "error_description":"Access denied"
}
```

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

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

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","productId","ratio","isDefault"],"filter":{"@productId":[1,2],">ratio":0.5,"isDefault":"Y"},"order":{"id":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.ratio.list
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","productId","ratio","isDefault"],"filter":{"@productId":[1,2],">ratio":0.5,"isDefault":"Y"},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.ratio.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

type CatalogRatioItem = {
  id: number,
  productId: number,
  ratio: number,
  isDefault: 'Y' | 'N',
}

// Shape of the payload returned in result (match the "response handling" section of the page)
type RatioListResult = {
  ratios: CatalogRatioItem[],
}

try {
  // catalog.ratio.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<RatioListResult>({
    method: 'catalog.ratio.list',
    params: {
      select: ['id', 'productId', 'ratio', 'isDefault'],
      filter: {
        '@productId': [1, 2],
        '>ratio': 0.5,
        isDefault: 'Y',
      },
      order: {
        id: 'desc',
      },
      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('Ratios:', result.ratios, 'Count:', result.ratios.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 fetchRatioList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // catalog.ratio.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: 'catalog.ratio.list',
        params: {
          select: ['id', 'productId', 'ratio', 'isDefault'],
          filter: {
            '@productId': [1, 2],
            '>ratio': 0.5,
            isDefault: 'Y',
          },
          order: {
            id: 'desc',
          },
          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('Ratios:', result.ratios, 'Count:', result.ratios.length)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

### Python

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

try:
    bitrix_response = client.catalog.ratio.list(
        select=[
            "id",
            "productId",
            "ratio",
            "isDefault",
        ],
        filter={
            "productId": 1,
        },
        order={
            "id": "desc",
        },
        start=0,
    ).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(
            'catalog.ratio.list',
            [
                'select' => [
                    'id',
                    'productId',
                    'ratio',
                    'isDefault',
                ],
                'filter' => [
                    '@productId' => [1, 2],
                    '>ratio'     => 0.5,
                    'isDefault'  => 'Y',
                ],
                'order' => [
                    'id' => 'desc',
                ],
            ]
        );

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

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

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

### BX24.js

```js
BX24.callMethod(
    'catalog.ratio.list',
        {
            select:[
                'id',
                'productId',
                'ratio',
                'isDefault',
            ],
            filter:{
                '@productId': [1, 2],
                '>ratio': 0.5,
                'isDefault': 'Y',
            },
            order:{
                id: 'desc',
            },
        },
        function(result)
        {
            if(result.error()) {
                console.error(result.error());
            } else {
                console.log(result.data());
            }
        }
);
```

### PHP CRest

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

$result = CRest::call(
    'catalog.ratio.list',
    [
        'select' => [
            'id',
            'productId',
            'ratio',
            'isDefault',
        ],
        'filter' => [
            '@productId' => [1, 2],
            '>ratio' => 0.5,
            'isDefault' => 'Y',
        ],
        'order' => [
            'id' => 'desc',
        ],
    ]
);

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.ratio.list", b24.Params{
	"select": []string{"id", "productId", "ratio", "isDefault"},
	"filter": b24.Params{
		"@productId": []int{1, 2},
		">ratio":     0.5,
		"isDefault":  "Y",
	},
	"order": b24.Params{
		"id": "desc",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.ratio.list: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
```

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