Получить список привязок заказов к объектам CRM crm.orderentity.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: менеджер интернет-магазина
Метод возвращает список привязок заказов к объектам CRM.
Параметры метода
|
Название |
Описание |
|
select |
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта crm_orderentity). Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля привязки заказа к объекту CRM |
|
filter |
Объект для фильтрации выбранных записей в формате Возможные значения для Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки записей в формате Возможные значения для
Если объект не передан или передан пустой объект, сортировка будет по возрастанию поля crm_orderentity.OWNER_ID |
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение Формула расчета значения параметра
Если указать значение |
Примеры кода
Как использовать примеры в документации
Получить идентификаторы заказов, привязанных к трем сделкам:
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
// 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 OrderEntityListResult = {
orderEntity: {
orderId: number
ownerId: number
}[]
}
try {
// crm.orderentity.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<OrderEntityListResult>({
method: 'crm.orderentity.list',
params: {
select: [
'orderId',
'ownerId',
],
filter: {
'=ownerTypeId': 2,
'@ownerId': [6938, 6937, 6933],
},
order: {
orderId: 'asc',
},
start: 0,
},
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('Order entities:', result.orderEntity.length, result.orderEntity)
}
} 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 listOrderEntities() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.orderentity.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'crm.orderentity.list',
params: {
select: [
'orderId',
'ownerId',
],
filter: {
'=ownerTypeId': 2,
'@ownerId': [6938, 6937, 6933],
},
order: {
orderId: 'asc',
},
start: 0,
},
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('Order entities:', result.orderEntity.length, result.orderEntity)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listOrderEntities)
</script>
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 |
Корневой элемент ответа |
|
orderEntity |
Массив объектов с информацией о выбранных заказах |
|
total |
Общее число выбранных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "200040300010",
"error_description": "Access Denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные ошибки
|
Код |
Описание |
|
|
|
|
|
|
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |