Get the list of orders sale.order.list
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
saleWho can execute the method: administrator
The method sale.order.list retrieves a list of orders.
Method Parameters
|
Name |
Description |
|
select |
An array containing the list of fields to be selected (see fields of the sale_order object). If not provided or an empty array is passed, all available order fields will be selected. |
|
filter |
An object for filtering the selected orders in the format Possible values for An additional prefix can be specified for the key to clarify the filter behavior. Possible prefix values:
|
|
order |
An object for sorting the selected orders in the format Possible values for Possible values for
|
|
start |
This parameter is used to manage pagination. The page size of results is always static: 50 records. To select the second page of results, the value The formula for calculating the
|
Code Examples
How to Use Examples in Documentation
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>
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>';
Response Handling
HTTP status: 200
{
"result": {
"orders": [
{
"accountNumber": "165",
"additionalInfo": "",
"affiliateId": null,
"canceled": "N",
"comments": "",
"companyId": null,
"currency": "USD",
"dateCanceled": null,
"dateInsert": "2022-10-14T17:19:11+02:00",
"dateLock": null,
"dateMarked": null,
"dateStatus": "2022-10-14T17:19:03+02:00",
"dateUpdate": "2022-10-14T17:19:11+02: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+02:00",
"date_finish": "2024-04-11T18:04:52+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response |
|
orders |
An array of objects containing information about the selected orders |
|
total |
The total number of records found |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error":0,
"error_description":"error"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient permissions to read orders |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |