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
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.orderentity.list(
select=[
"orderId",
"ownerTypeId",
"ownerId",
],
filter={
"ownerTypeId": 2,
"ownerId": 15,
},
order={
"orderId": "desc",
},
).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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.orderentity.list(
select=[
"orderId",
"ownerTypeId",
"ownerId",
],
filter={
"ownerTypeId": 2,
"ownerId": 15,
},
order={
"orderId": "desc",
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.orderentity.list(
select=[
"orderId",
"ownerTypeId",
"ownerId",
],
filter={
"ownerTypeId": 2,
"ownerId": 15,
},
order={
"orderId": "desc",
},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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}")
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.orderentity.list", b24.Params{
"select": []string{"orderId", "ownerId"},
"filter": b24.Params{
"=ownerTypeId": 2,
"@ownerId": []int{6938, 6937, 6933},
},
"order": b24.Params{
"orderId": "asc",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.orderentity.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "orderEntity".
raw, ok := b24.Unwrap(res.Result, "orderEntity")
if !ok {
return fmt.Errorf("в ответе нет ключа orderEntity")
}
var items []struct {
OrderID b24.ID `json:"orderId"`
OwnerID b24.ID `json:"ownerId"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.OrderID)
}
Ответ
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"
}

