метод REST scope: sale

sale.basketproperties.list

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

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

Описание

Метод sale.basketproperties.list возвращает набор свойств элементов корзины, выбранных по фильтру.

Параметры

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

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

Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля свойств элементов (позиций) корзины

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

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

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

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

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

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

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

start integer необязательный

Параметр используется для управления постраничной навигацией.
Размер страницы результатов всегда статичный - 50 записей.
Чтобы выбрать вторую страницу результатов, необходимо передавать значение - 50. Чтобы выбрать третью страницу результатов значение - 100 и т.д.
Формула расчета значения параметра start:
start = (N-1) * 50, где N – номер нужной страницы

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","basketId","value","name","code"],"filter":{"basketId":6806},"order":{"id":"desc"},"start":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketproperties.list

Ответ

HTTP-статус: 200

{
    "result": {
        "basketProperties": [
            {
                "basketId": 6806,
                "code": "PARTNUM",
                "id": 18,
                "name": "Номер партии",
                "value": "Ф45ТК266"
            },
            {
                "basketId": 6806,
                "code": "ARTICUL",
                "id": 17,
                "name": "Артикул",
                "value": "123-456-789"
            }
        ]
    },
    "total": 2,
    "time": {
        "start": 1714052872.323321,
        "finish": 1714052872.818371,
        "duration": 0.49504995346069336,
        "processing": 0.0272219181060791,
        "date_start": "2024-04-25T15:47:52+02:00",
        "date_finish": "2024-04-25T15:47:52+02:00",
        "operating": 0
    }
}

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

result object

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

basketProperties sale_basket_item_property[]

Массив объектов с информацией о выбранных свойствах элементов (позиций) корзины в заказах

total integer

Общее количество найденных записей

time time

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

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

HTTP-статус: 400

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

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

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