метод REST scope: sale

sale.propertyvariant.list

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

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

Описание

Метод sale.propertyvariant.list получает список вариантов значений свойств. Метод актуален только для свойств с типом ENUM.

Параметры

select array необязательный

Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_order_property_variant).

Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля вариантов значений свойств

filter object необязательный

Объект для фильтрации выбранных вариантов значений свойств в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Возможные значения для field соответствуют полям объекта sale_order_property_variant.

Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- + — фильтрация по точному значению заданного поля; при этом в выборку также попадают и те элементы, у которых значение поля не определено (NULL)
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- != — не равно
- ! — не равно

order object необязательный

Объект для сортировки выбранных вариантов значений свойств в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Возможные значения для field соответствуют полям объекта sale_order_property_variant.

Возможные значения для order:
- asc — в порядке возрастания
- desc — в порядке убывания

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

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

Ответ

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[]

Массив объектов с информацией о выбранных вариантах значений свойств

time time

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

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

HTTP-статус: 400

{
    "error":0,
    "error_description":"error"
}
Код Описание Значение
200040300010 Недостаточно прав для чтения вариантов значений свойств
0 Другие ошибки (например, фатальные ошибки)

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.