Получить список вариантов свойств sale.propertyvariant.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: sale

Кто может выполнять метод: администратор

Метод sale.propertyvariant.list возвращает список вариантов значений свойств заказа. Чтобы получить варианты одного свойства, передайте в filter его orderPropsId.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

select
array

Поля варианта, которые нужно вернуть: id, orderPropsId, name, value, sort, description. Описание полей.

Если параметр не передан или массив пустой, возвращаются все поля

filter
object

Фильтр в формате {"поле": "значение"}. Доступные поля: id, orderPropsId, name, value, sort, description.

Чтобы получить варианты одного свойства, передайте {"orderPropsId": идентификатор свойства}. Получить идентификатор свойства можно методом sale.property.list.

К ключу можно добавить префикс оператора:

  • + — равно или значение не задано (NULL)
  • >=, >, <=, < — больше или равно, больше, меньше или равно, меньше
  • % — содержит подстроку, символ % в значении передавать не нужно
  • != или ! — не равно

Поле, которого нет в варианте, метод игнорирует без ошибки

order
object

Сортировка в формате {"поле": "направление"}. Поля те же, что в filter. Направление:

  • asc — по возрастанию
  • desc — по убыванию

По умолчанию {"id": "asc"}

start
integer

Смещение для постраничной навигации. Метод возвращает до 50 записей за вызов. Чтобы получить страницу N, передайте start = (N-1) * 50.

По умолчанию 0

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","name","orderPropsId","value"],"filter":{">=id":5},"order":{"orderPropsId":"desc","id":"asc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.propertyvariant.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","name","orderPropsId","value"],"filter":{">=id":5},"order":{"orderPropsId":"desc","id":"asc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.propertyvariant.list
// 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 PropertyVariantResult = {
  propertyVariants: {
    id: number
    name: string
    orderPropsId: number
    value: string
  }[]
}

try {
  // sale.propertyvariant.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<PropertyVariantResult>({
    method: 'sale.propertyvariant.list',
    params: {
      select: ['id', 'name', 'orderPropsId', 'value'],
      filter: {
        '>=id': 5,
      },
      order: {
        orderPropsId: 'desc',
        id: '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('Property variants:', result.propertyVariants.length, result.propertyVariants)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- 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 listPropertyVariants() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // sale.propertyvariant.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.propertyvariant.list',
        params: {
          select: ['id', 'name', 'orderPropsId', 'value'],
          filter: {
            '>=id': 5,
          },
          order: {
            orderPropsId: 'desc',
            id: '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('Property variants:', result.propertyVariants.length, result.propertyVariants)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listPropertyVariants)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.sale.propertyvariant.list(
        select=[
            "id",
            "name",
            "orderPropsId",
            "value",
        ],
        filter={
            ">=id": 5,
        },
        order={
            "orderPropsId": "desc",
            "id": "asc",
        },
    ).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}")
try {
    $response = $b24Service
        ->core
        ->call(
            'sale.propertyvariant.list',
            [
                'select' => ['id', 'name', 'orderPropsId', 'value'],
                'filter' => [
                    '>=id' => 5,
                ],
                'order' => [
                    'orderPropsId' => 'desc',
                    'id' => 'asc',
                ],
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
    
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error fetching property variants: ' . $e->getMessage();
}
BX24.callMethod(
    "sale.propertyvariant.list", {
        "select": ["id", "name", "orderPropsId", "value"],
        "filter": {
            ">=id": 5,
        },
        "order": {
            "orderPropsId": "desc",
            "id": "asc",
        }
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.info(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'sale.propertyvariant.list',
    [
        'select' => ['id', 'name', 'orderPropsId', 'value'],
        'filter' => ['>=id' => 5],
        'order' => [
            'orderPropsId' => 'desc',
            'id' => 'asc',
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.propertyvariant.list", b24.Params{
	"select": []string{"id", "name", "orderPropsId", "value"},
	"filter": b24.Params{
		">=id": 5,
	},
	"order": b24.Params{
		"orderPropsId": "desc",
		"id":           "asc",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("sale.propertyvariant.list: %w", err)
}

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

var items []struct {
	ID           b24.ID `json:"id"`
	Name         string `json:"name"`
	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.ID)
}

Обработка ответа

HTTP-статус: 200

{
    "result":{
        "propertyVariants":[
            {
                "id":8,
                "name":"M",
                "orderPropsId":50,
                "value":"m"
            },
            {
                "id":9,
                "name":"L",
                "orderPropsId":50,
                "value":"l"
            },
            {
                "id":6,
                "name":"Красный",
                "orderPropsId":49,
                "value":"red"
            },
            {
                "id":7,
                "name":"Зеленый",
                "orderPropsId":49,
                "value":"green"
            }
        ]
    },
    "total":4,
    "time":{
        "start":1711633054.631642,
        "finish":1711633054.872368,
        "duration":0.24072599411010742,
        "processing":0.011013984680175781,
        "date_start":"2024-03-28T16:37:34+03:00",
        "date_finish":"2024-03-28T16:37:34+03:00"
    }
}

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

Название
тип

Описание

result
object

Корневой элемент ответа

propertyVariants
sale_order_property_variant[]

Массив вариантов (подробное описание). Содержит до 50 записей

total
integer

Общее количество вариантов, подходящих под фильтр

next
integer

Значение start для следующей страницы. Возвращается, только если записей больше, чем на текущей странице

time
time

Информация о времени выполнения запроса

sale_order_property_variant

Название
тип

Описание

id
integer

Идентификатор варианта

orderPropsId
integer

Идентификатор свойства заказа, к которому относится вариант

name
string

Название варианта, которое видит покупатель

value
string

Символьный код варианта. Сохраняется в заказе как значение свойства

sort
integer

Порядок вывода варианта в списке

description
string

Описание варианта. null, если описание не задано

Обработка ошибок

HTTP-статус: 400

{
    "error": "200040300010",
    "error_description": "Access Denied"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

400

200040300010

Access Denied

У пользователя нет права на чтение настроек магазина

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение