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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

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

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

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

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

Название
тип

Описание

fields*
object

Значения полей для создания привязки

Параметр fields

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

Название
тип

Описание

orderId*
sale_order.id

Идентификатор заказа

ownerTypeId*
integer

Идентификатор типа объекта CRM.

Привязка возможна только к сделке или счету

ownerId*
integer

Идентификатор объекта CRM.

Для сделок может быть получен методом crm.deal.list.

Для счетов может быть получен методом crm.invoice.list

Примеры кода

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

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

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.add
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.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type OrderEntityAddResult = {
  dealOrder: {
    orderId: number
    ownerId: number
    ownerTypeId: number
  }
}

try {
  const response = await $b24.actions.v2.call.make<OrderEntityAddResult>({
    method: 'crm.orderentity.add',
    params: {
      fields: {
        orderId: 5125,
        ownerId: 6933,
        ownerTypeId: 2,
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.dealOrder)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function addOrderEntity() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.orderentity.add',
        params: {
          fields: {
            orderId: 5125,
            ownerId: 6933,
            ownerTypeId: 2,
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.dealOrder)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addOrderEntity)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.orderentity.add(
        fields={
            "orderId": 123,
            "ownerTypeId": 2,
            "ownerId": 15,
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
BX24.callMethod(
    "crm.orderentity.add",
    {
        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.add',
    [
        'fields' => [
            'orderId' => 5125,
            'ownerId' => 6933,
            'ownerTypeId' => 2
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.orderentity.add", b24.Params{
	"fields": b24.Params{
		"orderId":     5125,
		"ownerId":     6933,
		"ownerTypeId": 2,
	},
})
if err != nil {
	return fmt.Errorf("crm.orderentity.add: %w", err)
}

// Метод заворачивает ответ в объект с ключом "dealOrder".
raw, ok := b24.Unwrap(res.Result, "dealOrder")
if !ok {
	return fmt.Errorf("в ответе нет ключа dealOrder")
}

var item struct {
	OrderID     b24.ID `json:"orderId"`
	OwnerID     b24.ID `json:"ownerId"`
	OwnerTypeID b24.ID `json:"ownerTypeId"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.OrderID, item.OwnerID)

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

HTTP-статус: 200

{
    "result": {
        "dealOrder": {
            "orderId": 5125,
            "ownerId": 6933,
            "ownerTypeId": 2
        }
    },
    "time": {
        "start": 1719325851.568441,
        "finish": 1719325852.546479,
        "duration": 0.9780380725860596,
        "processing": 0.32780981063842773,
        "date_start": "2024-06-25T16:30:51+02:00",
        "date_finish": "2024-06-25T16:30:52+02:00",
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

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

dealOrder
crm_orderentity

Объект с информацией о созданной привязке

time
time

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

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

HTTP-статус: 400

{
    "error": "201650000001",
    "error_description": "Duplicate entry for key [ownerId, ownerTypeId, orderId]"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

Код

Описание

200040300020

Access Denied
Недостаточно прав доступа

201650000001

Duplicate entry for key [ownerId, ownerTypeId, orderId]
Привязка уже существует

200540400001

order does not exist
Не найден заказ

0

Required fields: #FIELDS#
Не указаны обязательные поля (#FIELDS# — список полей через запятую)

0

Различные ошибки сохранения заказа

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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