# sale.propertyvalue.list

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

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

## Описание

Метод `sale.propertyvalue.list` получает список вариантов значений свойств заказа.

## Параметры

- `select` `array` — необязательный. Массив со списком полей, которые необходимо выбрать (смотрите поля объекта [sale_order_property_value](https://apidocs.bitrix24.ru/api-reference/sale/data-types.html)).
  Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля значений свойств
- `filter` `object` — необязательный. Объект для фильтрации выбранных значений свойств в формате `{"field_1": "value_1", ... "field_N": "value_N"}`.
  Возможные значения для `field`соответствуют полям объекта [sale_order_property_value](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_order_property_value](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":{
        "propertyValues":[
            {
                "code":"FIO",
                "id":10774,
                "name":"Имя Фамилия",
                "orderId":1650,
                "orderPropsId":20,
                "orderPropsXmlId":null,
                "value":"Соколов Борис Викторович"
            },
            {
                "code":"FIO",
                "id":10763,
                "name":"Имя Фамилия",
                "orderId":1649,
                "orderPropsId":20,
                "orderPropsXmlId":null,
                "value":"Соколов Борис Викторович"
            },
            {
                "code":"FIO",
                "id":10723,
                "name":"Имя Фамилия",
                "orderId":1641,
                "orderPropsId":20,
                "orderPropsXmlId":null,
                "value":"Соколов Борис Викторович"
            },
            {
                "code":"FIO",
                "id":10718,
                "name":"Имя Фамилия",
                "orderId":1640,
                "orderPropsId":20,
                "orderPropsXmlId":null,
                "value":"Соколов Борис Викторович"
            },
            {
                "code":"FIO",
                "id":10713,
                "name":"Имя Фамилия",
                "orderId":1639,
                "orderPropsId":20,
                "orderPropsXmlId":null,
                "value":"Соколов Борис Викторович"
            },
            {
                "code":"FIO",
                "id":10708,
                "name":"Имя Фамилия",
                "orderId":1638,
                "orderPropsId":20,
                "orderPropsXmlId":null,
                "value":"Соколов Борис Викторович"
            },
            {
                "code":"FIO",
                "id":10687,
                "name":"Имя Фамилия",
                "orderId":1634,
                "orderPropsId":20,
                "orderPropsXmlId":null,
                "value":"Соколов Борис Викторович"
            },
            {
                "code":"FIO",
                "id":10517,
                "name":"Имя Фамилия",
                "orderId":1603,
                "orderPropsId":20,
                "orderPropsXmlId":null,
                "value":"Соколов Борис Викторович"
            }
        ]
    },
    "total":8,
    "time":{
        "start":1712061753.171393,
        "finish":1712061753.431631,
        "duration":0.2602381706237793,
        "processing":0.021820783615112305,
        "date_start":"2024-04-02T15:42:33+03:00",
        "date_finish":"2024-04-02T15:42:33+03:00"
    }
}
```

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

- `result` `object`. Корневой элемент ответа
- `propertyValues` `sale_order_property_value[]`. Массив объектов с информацией о выбранных значениях свойств
- `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":["code","id","name","orderId","orderPropsId","orderPropsXmlId","value"],"filter":{"=code":"FIO","%value":"Борис",">orderId":1600},"order":{"orderId":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.propertyvalue.list
```

### cURL (OAuth)

```http
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["code","id","name","orderId","orderPropsId","orderPropsXmlId","value"],"filter":{"=code":"FIO","%value":"Борис",">orderId":1600},"order":{"orderId":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.propertyvalue.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 PropertyValueListResult = {
  propertyValues: Array<{
    code: string
    id: number
    name: string
    orderId: number
    orderPropsId: number
    orderPropsXmlId: string | null
    value: string
  }>
}

try {
  // sale.propertyvalue.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<PropertyValueListResult>({
    method: 'sale.propertyvalue.list',
    params: {
      select: [
        'code',
        'id',
        'name',
        'orderId',
        'orderPropsId',
        'orderPropsXmlId',
        'value',
      ],
      filter: {
        '=code': 'FIO',
        '%value': 'Boris',
        '>orderId': 1600,
      },
      order: {
        orderId: '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('Property values count:', result.propertyValues.length)
    console.info('First property value:', result.propertyValues[0])
  }
} 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 getPropertyValueList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // sale.propertyvalue.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.propertyvalue.list',
        params: {
          select: [
            'code',
            'id',
            'name',
            'orderId',
            'orderPropsId',
            'orderPropsXmlId',
            'value',
          ],
          filter: {
            '=code': 'FIO',
            '%value': 'Boris',
            '>orderId': 1600,
          },
          order: {
            orderId: '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('Property values count:', result.propertyValues.length)
      console.info('First property value:', result.propertyValues[0])
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

### Python

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

try:
    bitrix_response = client.sale.propertyvalue.list(
        select=[
            "code",
            "id",
            "name",
            "orderId",
            "orderPropsId",
            "orderPropsXmlId",
            "value",
        ],
        filter={
            "=code": "FIO",
            "%value": "Борис",
            ">orderId": 1600,
        },
        order={
            "orderId": "desc",
        },
        start='1712061753.171393',
    ).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.propertyvalue.list',
            [
                'select' => [
                    'code',
                    'id',
                    'name',
                    'orderId',
                    'orderPropsId',
                    'orderPropsXmlId',
                    'value',
                ],
                'filter' => [
                    '=code'    => 'FIO',
                    '%value'   => 'Борис',
                    '>orderId' => 1600,
                ],
                'order' => [
                    'orderId' => 'desc',
                ],
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

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

### BX24.js

```js
BX24.callMethod(
    "sale.propertyvalue.list", {
        "select": [
            "code",
            "id",
            "name",
            "orderId",
            "orderPropsId",
            "orderPropsXmlId",
            "value",
        ],
        "filter": {
            "=code": "FIO",
            "%value": "Борис",
            ">orderId": 1600,
        },
        "order": {
            "orderId": "desc",
        },
    },
    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.propertyvalue.list',
    [
        'select' => [
            'code',
            'id',
            'name',
            'orderId',
            'orderPropsId',
            'orderPropsXmlId',
            'value',
        ],
        'filter' => [
            '=code' => 'FIO',
            '%value' => 'Борис',
            '>orderId' => 1600,
        ],
        'order' => [
            'orderId' => 'desc',
        ],
    ]
);

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.propertyvalue.list", b24.Params{
	"select": []string{"code", "id", "name", "orderId", "orderPropsId", "orderPropsXmlId", "value"},
	"filter": b24.Params{
		"=code":    "FIO",
		"%value":   "Борис",
		">orderId": 1600,
	},
	"order": b24.Params{
		"orderId": "desc",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("sale.propertyvalue.list: %w", err)
}

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

var items []struct {
	Code         string `json:"code"`
	ID           b24.ID `json:"id"`
	Name         string `json:"name"`
	OrderID      b24.ID `json:"orderId"`
	OrderPropsID b24.ID `json:"orderPropsId"`
	Value        string `json:"value"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.Code)
}
```

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