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

Scope: 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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

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"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.orderentity.list

// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'crm.orderentity.list',
            {
              select: [
                'orderId',
                'ownerId',
              ],
              filter: {
                '=ownerTypeId': 2,
                '@ownerId': [6938, 6937, 6933],
              },
              order: {
                orderId: 'asc'
              },
            },
            (progress) => { console.log('Progress:', progress) }
          );
          const items = response.getData() || [];
          for (const entity of items) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
          const generator = $b24.fetchListMethod('crm.orderentity.list', {
            select: [
              'orderId',
              'ownerId',
            ],
            filter: {
              '=ownerTypeId': 2,
              '@ownerId': [6938, 6937, 6933],
            },
            order: {
              orderId: 'asc'
            },
          }, 'orderId');
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity); }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.orderentity.list', {
            select: [
              'orderId',
              'ownerId',
            ],
            filter: {
              '=ownerTypeId': 2,
              '@ownerId': [6938, 6937, 6933],
            },
            order: {
              orderId: 'asc'
            },
          }, 0);
          const result = response.getData().result || [];
          for (const entity of result) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.orderentity.list',
                    [
                        'select' => [
                            'orderId',
                            'ownerId',
                        ],
                        'filter' => [
                            '=ownerTypeId' => 2,
                            '@ownerId'    => [6938, 6937, 6933],
                        ],
                        'order'  => [
                            'orderId' => 'asc',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching order entities: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.orderentity.list",
            {
                select: [
                    'orderId',
                    'ownerId',
                ],
                filter: {
                    '=ownerTypeId': 2,
                    '@ownerId': [6938, 6937, 6933],
                },
                order: {
                    orderId: 'asc'
                },
            },)
            .then(
                function(result)
                {
                    if (result.error())
                    {
                        console.error(result.error());
                    }
                    else
                    {
                        console.log(result.data);
                    }
                },
                function(error)
                {
                    console.info(error);
                }
            );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.orderentity.list',
            [
                'select' => [
                    'orderId',
                    'ownerId',
                ],
                'filter' => [
                    '=ownerTypeId' => 2,
                    '@ownerId' => [6938, 6937, 6933],
                ],
                'order' => [
                    'orderId' => 'asc'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

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"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание
`200040300010`	`Access Denied` Недостаточно прав доступа
`200540400002`	`module sale does not exist` Отсутствует модуль `Интернет-магазин` (sale)

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Добавить привязку заказа к объекту CRM

Удалить привязку заказа к объекту CRM

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

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

Примеры кодаПримеры кода

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

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

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

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

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

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