sale.order.list
Получить список заказов
Описание
Метод sale.order.list получает список заказов.
Параметры
select
array
необязательный
Массив содержит список полей, которые необходимо выбрать (смотрите поля объекта sale_order).
Если не передан или передан пустой массив, то будут выбраны все доступные поля заказов.
filter
object
необязательный
Объект для фильтрации выбранных заказов в формате {"field_1": "value_1", ... "field_N": "value_N"}.
Возможные значения для field соответствуют полям объекта sale_order.
Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
>=— больше либо равно>— больше<=— меньше либо равно<— меньше@— IN (в качестве значения передаётся массив)!@— NOT IN (в качестве значения передаётся массив)%— LIKE, поиск по подстроке. Символ%в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки=%— LIKE, поиск по подстроке. Символ%нужно передавать в значении. Примеры:
- "мол%" — ищем значения, начинающиеся с «мол»
- "%мол" — ищем значения, заканчивающиеся на «мол»
- "%мол%" — ищем значения, где «мол» может быть в любой позиции%=— LIKE (см. описание выше)!%— NOT LIKE, поиск по подстроке. Символ%в значении фильтра передавать не нужно. Поиск идет с обоих сторон.!=%— NOT LIKE, поиск по подстроке. Символ%нужно передавать в значении. Примеры:
- "мол%" — ищем значения, не начинающиеся с «мол»
- "%мол" — ищем значения, не заканчивающиеся на «мол»
- "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции!%=— NOT LIKE (см. описание выше)=— равно, точное совпадение (используется по умолчанию)!=- не равно!— не равно
order
object
необязательный
Объект для сортировки выбранных заказов в формате {"field_1": "order_1", ... "field_N": "order_N"}.
Возможные значения для field соответствуют полям объекта sale_order.
Возможные значения для order:
- asc — в порядке возрастания
- desc — в порядке убывания
start
integer
необязательный
Параметр используется для управления постраничной навигацией.
Размер страницы результатов всегда статичный: 50 записей.
Чтобы выбрать вторую страницу результатов необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее.
Формула расчета значения параметра start:
start = (N-1) * 50, где N — номер нужной страницы
Примеры запроса
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
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type SaleOrderListResult = {
orders: {
id: number
accountNumber: string
additionalInfo: string
affiliateId: number | null
canceled: string
comments: string
companyId: number | null
currency: string
dateCanceled: ISODate | null
dateInsert: ISODate
dateLock: ISODate | null
dateMarked: ISODate | null
dateStatus: ISODate
dateUpdate: ISODate
deducted: string
discountValue: number
empCanceledId: number | null
empMarkedId: number | null
empStatusId: number
externalOrder: string
id1c: string
lid: string
lockedBy: string
marked: string
orderTopic: string
payed: string
personTypeId: number
personTypeXmlId: string
price: number
reasonCanceled: string
reasonMarked: string
recountFlag: string
recurringId: string
responsibleId: number
statusId: string
statusXmlId: string
taxValue: number
updated1c: string
userDescription: string
userId: number
version: number
version1c: string
xmlId: string
}[]
}
try {
// sale.order.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<SaleOrderListResult>({
method: 'sale.order.list',
params: {
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',
},
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(`Fetched ${result.orders.length} orders, first order id: ${result.orders[0]?.id}`)
}
} 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 fetchOrderList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// sale.order.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: 'sale.order.list',
params: {
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',
},
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(`Fetched ${result.orders.length} orders, first order id: ${result.orders[0]?.id}`)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchOrderList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.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",
},
start='1712847891.436862',
).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}")
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.order.list", b24.Params{
"select": []string{"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": b24.Params{
"<id": 10,
"@personTypeId": []int{3, 4},
"payed": "N",
},
"order": b24.Params{
"id": "desc",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.order.list: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
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
object
Корневой элемент ответа
orders
sale_order[]
Массив объектов с информацией о выбранных заказах
total
integer
Общее количество найденных записей
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
| Код | Описание | Значение |
|---|---|---|
200040300010 |
Недостаточно прав для чтения заказов | |
0 |
Другие ошибки (например, фатальные ошибки) |

