catalog.document.element.list
Получить список товаров в документах складского учета
Описание
Метод catalog.document.element.list возвращает позиции товаров, связанные с документами складского учета. Записи автоматически ограничиваются доступными типами документов и правами пользователя на склады.
Параметры
select
array
необязательный
Массив со списком полей catalog_document_element, которые необходимо выбрать
filter
object
необязательный
Объект для фильтрации выбранных записей товаров в формате {"field_1": "value_1", ..., "field_N": "value_N"}.
Возможные значения для field соответствуют полям объекта catalog_document_element.
Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно,
- > — больше,
- <= — меньше либо равно,
- < — меньше,
- @ — IN, в качестве значения передается массив,
- !@ — NOT IN, в качестве значения передается массив,
- = — равно, точное совпадение, используется по умолчанию,
- != — не равно,
- ! — не равно
order
object
необязательный
Объект для сортировки выбранных записей товаров в формате {"field_1": "order_1", ... "field_N": "order_N"}.
Возможные значения для field соответствуют полям объекта catalog_document_element.
Возможные значения для 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","docId","elementId","amount","storeFrom","storeTo"],"filter":{"docId":64},"order":{"id":"ASC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.element.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","docId","elementId","amount","storeFrom","storeTo"],"filter":{"docId":64},"order":{"id":"ASC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.document.element.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
type DocumentElement = {
id: number
docId: number
elementId: number
amount: number
purchasingPrice: number
storeFrom: number | null
storeTo: number | null
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type DocumentElementListResult = {
documentElements: DocumentElement[]
}
try {
// catalog.document.element.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<DocumentElementListResult>({
method: 'catalog.document.element.list',
params: {
select: [
'id',
'docId',
'elementId',
'amount',
'storeFrom',
'storeTo',
],
filter: {
docId: 64,
},
order: {
id: '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(result.documentElements.length, result.documentElements)
}
} 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 listDocumentElements() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// catalog.document.element.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: 'catalog.document.element.list',
params: {
select: [
'id',
'docId',
'elementId',
'amount',
'storeFrom',
'storeTo',
],
filter: {
docId: 64,
},
order: {
id: '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(result.documentElements.length, result.documentElements)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listDocumentElements)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.document.element.list(
select=[
"id",
"docId",
"elementId",
"amount",
"storeFrom",
"storeTo",
],
filter={
"docId": 64,
},
order={
"id": "ASC",
},
start=0,
).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(
'catalog.document.element.list',
[
'select' => [
'id',
'docId',
'elementId',
'amount',
'storeFrom',
'storeTo',
'purchasingPrice'
],
'filter' => [
'docId' => 64
],
'order' => [
'id' => 'ASC'
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
$result->next();
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching document elements: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.document.element.list',
{
select: [
'id',
'docId',
'elementId',
'amount',
'storeFrom',
'storeTo'
],
filter: {
docId: 64
},
order: {
id: 'ASC'
}
},
function(result)
{
if (result.error())
console.error(result.error());
else
console.log(result.data());
result.next();
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.document.element.list',
[
'select' => [
'id',
'docId',
'elementId',
'amount',
'storeFrom',
'storeTo'
],
'filter' => [
'docId' => 64
],
'order' => [
'id' => 'ASC'
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.element.list", b24.Params{
"select": []string{"id", "docId", "elementId", "amount", "storeFrom", "storeTo"},
"filter": b24.Params{
"docId": 64,
},
"order": b24.Params{
"id": "ASC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.document.element.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "documentElements".
raw, ok := b24.Unwrap(res.Result, "documentElements")
if !ok {
return fmt.Errorf("в ответе нет ключа documentElements")
}
var items []struct {
Amount int `json:"amount"`
DocID b24.ID `json:"docId"`
ElementID b24.ID `json:"elementId"`
ID b24.ID `json:"id"`
PurchasingPrice int `json:"purchasingPrice"`
StoreTo int `json:"storeTo"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.Amount)
}
Ответ
HTTP-статус: 200
{
"result": {
"documentElements": [
{
"amount": 5,
"docId": 64,
"elementId": 312,
"id": 148,
"purchasingPrice": 1180,
"storeFrom": null,
"storeTo": 2
},
{
"amount": 12,
"docId": 64,
"elementId": 420,
"id": 149,
"purchasingPrice": 560,
"storeFrom": null,
"storeTo": 2
}
]
},
"total": 2,
"time": {
"start": 1759482402.511337,
"finish": 1759482402.642843,
"duration": 0.13150620460510254,
"processing": 0.02694106101989746,
"date_start": "2025-11-02T12:26:42+03:00",
"date_finish": "2025-11-02T12:26:42+03:00",
"operating": 0
}
}
Возвращаемые данные
result
object
Корневой элемент ответа
documentElements
catalog_document_element[]
Массив объектов с информацией о товарах документа, структура ответа зависит от параметра select
next
integer
Значение для получения следующей страницы
total
integer
Общее количество записей
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_DOCUMENT_RIGHTS",
"error_description": "Access denied"
}
| Код | Описание | Значение |
|---|---|---|
ERROR_DOCUMENT_RIGHTS |
Access denied | Недостаточно прав на чтение |
0 |
Прочие ошибки обработки |

