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

Scope: crm

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

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

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

Обязательные параметры отмечены *

Название `тип`	Описание
fields* `object`	Значения полей для удаления привязки

Параметр fields

Обязательные параметры отмечены *

Название `тип`	Описание
orderId* `sale_order.id`	Идентификатор заказа
ownerTypeId* `integer`	Идентификатор типа объекта CRM. Привязка возможна только к сделке или счету
ownerId* `integer`	Идентификатор объекта CRM. Для сделок может быть получен методом crm.deal.list. Для счетов может быть получен методом crm.invoice.list

Примеры кода

Как использовать примеры в документации

Добавить привязку заказа к сделке:

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"orderId":5125,"ownerId":6933,"ownerTypeId":2}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.orderentity.deletebyfilter

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"orderId":5125,"ownerId":6933,"ownerTypeId":2},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.orderentity.deletebyfilter

try
        {
        	const response = await $b24.callMethod(
        		"crm.orderentity.deletebyfilter",
        		{
        			fields: {
        				orderId: 5125,
        				ownerId: 6933,
        				ownerTypeId: 2
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.orderentity.deletebyfilter',
                    [
                        'fields' => [
                            'orderId'     => 5125,
                            'ownerId'     => 6933,
                            'ownerTypeId' => 2,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error deleting order entity: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.orderentity.deletebyfilter",
            {
                fields: {
                    orderId: 5125,
                    ownerId: 6933,
                    ownerTypeId: 2
                }
            },
        )
            .then(
                function(result)
                {
                    if (result.error())
                    {
                        console.error(result.error());
                    }
                    else
                    {
                        console.log(result);
                    }
                },
                function(error)
                {
                    console.info(error);
                }
            );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.orderentity.deletebyfilter',
            [
                'fields' => [
                    'orderId' => 5125,
                    'ownerId' => 6933,
                    'ownerTypeId' => 2
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1719325693.109545,
                "finish": 1719325695.863527,
                "duration": 2.7539820671081543,
                "processing": 1.773292064666748,
                "date_start": "2024-06-25T16:28:13+02:00",
                "date_finish": "2024-06-25T16:28:15+02:00",
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `boolean`	Содержит признак успешного завершения операции
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": "0",
            "error_description": "Required fields: ownerId, orderId"
        }

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

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

Код	Описание
`200040300020`	`Access Denied` Недостаточно прав доступа
`201640400004`	`entity relation is not exists` Не найдена привязка заказа к объекту CRM
`200540400001`	`order does not exist` Не найден заказ
`0`	`Required fields: #FIELDS#` Не указаны обязательные поля (`#FIELDS#` — список полей через запятую)
`0`	Различные ошибки сохранения заказа

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

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.orderentity.deleteByFilter

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

Параметр fieldsПараметр fields

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

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

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

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

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

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

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