метод REST scope: sale

sale.tradePlatform.list

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

Кто может выполнять: любой пользователь с правом «Просмотр каталога товаров»

Описание

Метод sale.tradePlatform.list получает список источников заказов.

Параметры

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

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

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

Список полей для фильтрации. При указании нескольких полей используется логика AND.

Поля соответствуют соответствуют полям объекта sale_order_trade_platform.

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

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

Параметры сортировки. Формат: {поле: направление (ASC, DESC)}.

Поля соответствуют соответствуют полям объекта sale_order_trade_platform.

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","code"],"filter":{"%code":"smart"},"order":{"code":"asc"},"start":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.tradePlatform.list

Ответ

HTTP-статус: 200

{
    "result": {
        "tradePlatforms": [
            {
                "code": "smart_invoice",
                "id": 2
            }
        ]
    },
    "total": 1,
    "time": { 
        "start": 1712135957.057659, 
        "finish": 1712135957.407821, 
        "duration": 0.3501620292663574, 
        "processing": 0.011919021606445312, 
        "date_start": "2024-04-03T11:19:17+02:00", 
        "date_finish": "2024-04-03T11:19:17+02:00", 
        "operating_reset_at": 1705765533, 
        "operating": 3.3076241016387939 
    } 
}

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

result object

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

tradePlatforms sale_order_trade_platform[]

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

total integer

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

time time

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

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

HTTP-статус: 400

{
    "error":200040300010,
    "error_description":"Access Denied"
}
Код Описание Значение
200040300010 Недостаточно прав для выполнения метода

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

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