метод REST scope: crm

crm.orderentity.list

Получить список привязок заказов к объектам CRM

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

Описание

Метод возвращает список привязок заказов к объектам CRM.

Параметры

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

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

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

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

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

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

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

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

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

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

Если объект не передан или передан пустой объект, сортировка будет по возрастанию поля crm_orderentity.OWNER_ID

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

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный: 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы.

Если указать значение -1, будут выбраны все записи, отвечающие условиям фильтра

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["orderId","ownerId"],"filter":{"=ownerTypeId":2,"@ownerId":[6938,6937,6933]},"order":{"orderId":"asc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.orderentity.list

Ответ

HTTP-статус: 200

{
    "result": {
        "orderEntity": [
            {
                "orderId": 5125,
                "ownerId": 6933
            },
            {
                "orderId": 5127,
                "ownerId": 6937
            },
            {
                "orderId": 5128,
                "ownerId": 6938
            }
        ]
    },
    "total": 3,
    "time": {
        "start": 1719315806.858516,
        "finish": 1719315807.569731,
        "duration": 0.7112150192260742,
        "processing": 0.039324045181274414,
        "date_start": "2024-06-25T13:43:26+02:00",
        "date_finish": "2024-06-25T13:43:27+02:00",
        "operating": 0
    }
}

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

result object

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

orderEntity crm_orderentity[]

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

total integer

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

time time

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

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

HTTP-статус: 400

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

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

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