Получить список заказов sale.order.list
Scope:
saleКто может выполнять метод: администратор
Метод sale.order.list получает список заказов.
Параметры метода
|
Название |
Описание |
|
select |
Массив содержит список полей, которые необходимо выбрать (смотрите поля объекта sale_order). Если не передан или передан пустой массив, то будут выбраны все доступные поля заказов. |
|
filter |
Объект для фильтрации выбранных заказов в формате Возможные значения для Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных заказов в формате Возможные значения для Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов необходимо передавать значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","lid","dateInsert","dateUpdate","personTypeId","personTypeXmlId","statusId","dateStatus","empStatusId","marked","dateMarked","empMarkedId","reasonMarked","price","discountValue","taxValue","userDescription","additionalInfo","comments","companyId","responsibleId","recurringId","lockedBy","dateLock","recountFlag","affiliateId","updated1c","orderTopic","xmlId","statusXmlId","id1c","version","version1c","externalOrder","canceled","dateCanceled","empCanceledId","reasonCanceled","userId","currency","accountNumber","payed","deducted"],"filter":{"<id":10,"@personTypeId":[3,4],"payed":"N"},"order":{"id":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.order.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","lid","dateInsert","dateUpdate","personTypeId","personTypeXmlId","statusId","dateStatus","empStatusId","marked","dateMarked","empMarkedId","reasonMarked","price","discountValue","taxValue","userDescription","additionalInfo","comments","companyId","responsibleId","recurringId","lockedBy","dateLock","recountFlag","affiliateId","updated1c","orderTopic","xmlId","statusXmlId","id1c","version","version1c","externalOrder","canceled","dateCanceled","empCanceledId","reasonCanceled","userId","currency","accountNumber","payed","deducted"],"filter":{"<id":10,"@personTypeId":[3,4],"payed":"N"},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.order.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'sale.order.list',
{
"select": [
"id",
"lid",
"dateInsert",
"dateUpdate",
"personTypeId",
"personTypeXmlId",
"statusId",
"dateStatus",
"empStatusId",
"marked",
"dateMarked",
"empMarkedId",
"reasonMarked",
"price",
"discountValue",
"taxValue",
"userDescription",
"additionalInfo",
"comments",
"companyId",
"responsibleId",
"recurringId",
"lockedBy",
"dateLock",
"recountFlag",
"affiliateId",
"updated1c",
"orderTopic",
"xmlId",
"statusXmlId",
"id1c",
"version",
"version1c",
"externalOrder",
"canceled",
"dateCanceled",
"empCanceledId",
"reasonCanceled",
"userId",
"currency",
"accountNumber",
"payed",
"deducted",
],
"filter": {
"<id": 10,
"@personTypeId": [3, 4],
"payed": "N",
},
"order": {
"id": "desc",
}
},
(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('sale.order.list', {
"select": [
"id",
"lid",
"dateInsert",
"dateUpdate",
"personTypeId",
"personTypeXmlId",
"statusId",
"dateStatus",
"empStatusId",
"marked",
"dateMarked",
"empMarkedId",
"reasonMarked",
"price",
"discountValue",
"taxValue",
"userDescription",
"additionalInfo",
"comments",
"companyId",
"responsibleId",
"recurringId",
"lockedBy",
"dateLock",
"recountFlag",
"affiliateId",
"updated1c",
"orderTopic",
"xmlId",
"statusXmlId",
"id1c",
"version",
"version1c",
"externalOrder",
"canceled",
"dateCanceled",
"empCanceledId",
"reasonCanceled",
"userId",
"currency",
"accountNumber",
"payed",
"deducted",
],
"filter": {
"<id": 10,
"@personTypeId": [3, 4],
"payed": "N",
},
"order": {
"id": "desc",
}
}, 'ID');
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('sale.order.list', {
"select": [
"id",
"lid",
"dateInsert",
"dateUpdate",
"personTypeId",
"personTypeXmlId",
"statusId",
"dateStatus",
"empStatusId",
"marked",
"dateMarked",
"empMarkedId",
"reasonMarked",
"price",
"discountValue",
"taxValue",
"userDescription",
"additionalInfo",
"comments",
"companyId",
"responsibleId",
"recurringId",
"lockedBy",
"dateLock",
"recountFlag",
"affiliateId",
"updated1c",
"orderTopic",
"xmlId",
"statusXmlId",
"id1c",
"version",
"version1c",
"externalOrder",
"canceled",
"dateCanceled",
"empCanceledId",
"reasonCanceled",
"userId",
"currency",
"accountNumber",
"payed",
"deducted",
],
"filter": {
"<id": 10,
"@personTypeId": [3, 4],
"payed": "N",
},
"order": {
"id": "desc",
}
}, 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(
'sale.order.list',
[
'select' => [
'id',
'lid',
'dateInsert',
'dateUpdate',
'personTypeId',
'personTypeXmlId',
'statusId',
'dateStatus',
'empStatusId',
'marked',
'dateMarked',
'empMarkedId',
'reasonMarked',
'price',
'discountValue',
'taxValue',
'userDescription',
'additionalInfo',
'comments',
'companyId',
'responsibleId',
'recurringId',
'lockedBy',
'dateLock',
'recountFlag',
'affiliateId',
'updated1c',
'orderTopic',
'xmlId',
'statusXmlId',
'id1c',
'version',
'version1c',
'externalOrder',
'canceled',
'dateCanceled',
'empCanceledId',
'reasonCanceled',
'userId',
'currency',
'accountNumber',
'payed',
'deducted',
],
'filter' => [
'<id' => 10,
'@personTypeId' => [3, 4],
'payed' => 'N',
],
'order' => [
'id' => 'desc',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching order list: ' . $e->getMessage();
}
BX24.callMethod(
"sale.order.list", {
"select": [
"id",
"lid",
"dateInsert",
"dateUpdate",
"personTypeId",
"personTypeXmlId",
"statusId",
"dateStatus",
"empStatusId",
"marked",
"dateMarked",
"empMarkedId",
"reasonMarked",
"price",
"discountValue",
"taxValue",
"userDescription",
"additionalInfo",
"comments",
"companyId",
"responsibleId",
"recurringId",
"lockedBy",
"dateLock",
"recountFlag",
"affiliateId",
"updated1c",
"orderTopic",
"xmlId",
"statusXmlId",
"id1c",
"version",
"version1c",
"externalOrder",
"canceled",
"dateCanceled",
"empCanceledId",
"reasonCanceled",
"userId",
"currency",
"accountNumber",
"payed",
"deducted",
],
"filter": {
"<id": 10,
"@personTypeId": [3, 4],
"payed": "N",
},
"order": {
"id": "desc",
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.order.list',
[
'select' => [
"id",
"lid",
"dateInsert",
"dateUpdate",
"personTypeId",
"personTypeXmlId",
"statusId",
"dateStatus",
"empStatusId",
"marked",
"dateMarked",
"empMarkedId",
"reasonMarked",
"price",
"discountValue",
"taxValue",
"userDescription",
"additionalInfo",
"comments",
"companyId",
"responsibleId",
"recurringId",
"lockedBy",
"dateLock",
"recountFlag",
"affiliateId",
"updated1c",
"orderTopic",
"xmlId",
"statusXmlId",
"id1c",
"version",
"version1c",
"externalOrder",
"canceled",
"dateCanceled",
"empCanceledId",
"reasonCanceled",
"userId",
"currency",
"accountNumber",
"payed",
"deducted",
],
'filter' => [
"<id" => 10,
"@personTypeId" => [3, 4],
"payed" => "N",
],
'order' => [
"id" => "desc",
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"orders": [
{
"accountNumber": "165",
"additionalInfo": "",
"affiliateId": null,
"canceled": "N",
"comments": "",
"companyId": null,
"currency": "RUB",
"dateCanceled": null,
"dateInsert": "2022-10-14T17:19:11+03:00",
"dateLock": null,
"dateMarked": null,
"dateStatus": "2022-10-14T17:19:03+03:00",
"dateUpdate": "2022-10-14T17:19:11+03:00",
"deducted": "N",
"discountValue": 0,
"empCanceledId": null,
"empMarkedId": null,
"empStatusId": 1,
"externalOrder": "N",
"id": 9,
"id1c": "",
"lid": "s1",
"lockedBy": "",
"marked": "N",
"orderTopic": "",
"payed": "N",
"personTypeId": 4,
"personTypeXmlId": "",
"price": 1176,
"reasonCanceled": "",
"reasonMarked": "",
"recountFlag": "Y",
"recurringId": "",
"responsibleId": 1,
"statusId": "N",
"statusXmlId": "",
"taxValue": 196,
"updated1c": "N",
"userDescription": "",
"userId": 2,
"version": 0,
"version1c": "",
"xmlId": "bx_63498bf7c8d31"
},
]
},
"total": 1,
"time": {
"start": 1712847891.436862,
"finish": 1712847892.028163,
"duration": 0.5913009643554688,
"processing": 0.1332709789276123,
"date_start": "2024-04-11T18:04:51+03:00",
"date_finish": "2024-04-11T18:04:52+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
orders |
Массив объектов с информацией о выбранных заказах |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения заказов |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить заказ sale.order.add
- Изменить заказ sale.order.update
- Получить значения полей заказа и связанных объектов sale.order.get
- Удалить заказ и связанные объекты sale.order.delete
- Получить поля заказа sale.order.getfields