Получить список элементов табличной части отгрузки sale.shipmentitem.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
saleКто может выполнять метод: администратор
Метод sale.shipmentitem.list позволяет получить список элементов табличной части отгрузки.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Массив содержит список полей, которые необходимо выбрать (смотрите поля объекта sale_order_shipment_item). Если не передан или передан пустой массив, то будут выбраны все доступные поля элементов табличной части отгрузки. |
|
filter |
Объект для фильтрации выбранных элементов табличной части отгрузки в формате Возможные значения для Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных элементов табличной части отгрузки в формате Возможные значения для Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","orderDeliveryId","basketId","quantity","xmlId","dateInsert","reservedQuantity"],"filter":{"<id":10,"@orderDeliveryId":[2431,2430],"basketId":2716},"order":{"id":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentitem.list
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","orderDeliveryId","basketId","quantity","xmlId","dateInsert","reservedQuantity"],"filter":{"<id":10,"@orderDeliveryId":[2431,2430],"basketId":2716},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.shipmentitem.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 ShipmentItemListResult = {
shipmentItems: {
id: number
orderDeliveryId: number
basketId: number
quantity: number
xmlId: string
dateInsert: ISODate | null
reservedQuantity: number
}[]
}
// sale.shipmentitem.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.
try {
const response = await $b24.actions.v2.call.make<ShipmentItemListResult>({
method: 'sale.shipmentitem.list',
params: {
select: [
'id',
'orderDeliveryId',
'basketId',
'quantity',
'xmlId',
'dateInsert',
'reservedQuantity',
],
filter: {
'<id': 10,
'@orderDeliveryId': [2431, 2430],
basketId: 2716,
},
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('Shipment items count:', result.shipmentItems.length, result.shipmentItems)
}
} 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 listShipmentItems() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// sale.shipmentitem.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.shipmentitem.list',
params: {
select: [
'id',
'orderDeliveryId',
'basketId',
'quantity',
'xmlId',
'dateInsert',
'reservedQuantity',
],
filter: {
'<id': 10,
'@orderDeliveryId': [2431, 2430],
basketId: 2716,
},
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('Shipment items count:', result.shipmentItems.length, result.shipmentItems)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listShipmentItems)
</script>
try {
$response = $b24Service
->core
->call(
'sale.shipmentitem.list',
[
'select' => [
'id',
'orderDeliveryId',
'basketId',
'quantity',
'xmlId',
'dateInsert',
'reservedQuantity',
],
'filter' => [
'<id' => 10,
'@orderDeliveryId' => [2431, 2430],
'basketId' => 2716,
],
'order' => [
'id' => 'desc',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching shipment items: ' . $e->getMessage();
}
BX24.callMethod(
"sale.shipmentitem.list", {
"select": [
"id",
"orderDeliveryId",
"basketId",
"quantity",
"xmlId",
"dateInsert",
"reservedQuantity",
],
"filter": {
"<id": 10,
"@orderDeliveryId": [2431, 2430],
"basketId": 2716,
},
"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.shipmentitem.list',
[
'select' => [
"id",
"orderDeliveryId",
"basketId",
"quantity",
"xmlId",
"dateInsert",
"reservedQuantity",
],
'filter' => [
"<id" => 10,
"@orderDeliveryId" => [2431, 2430],
"basketId" => 2716,
],
'order' => [
"id" => "desc",
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result":{
"shipmentItems":[
{
"basketId":2716,
"dateInsert":"2024-04-11T09:10:34+03:00",
"id":7,
"orderDeliveryId":2431,
"quantity":5,
"reservedQuantity":0,
"xmlId":"myNewXmlId"
},
{
"basketId":2716,
"dateInsert":"2024-04-08T10:36:24+03:00",
"id":1,
"orderDeliveryId":2430,
"quantity":5,
"reservedQuantity":0,
"xmlId":"myXmlId2"
}
]
},
"total":2,
"time":{
"start":1712819741.592596,
"finish":1712819741.796288,
"duration":0.20369195938110352,
"processing":0.01679706573486328,
"date_start":"2024-04-11T10:15:41+03:00",
"date_finish":"2024-04-11T10:15:41+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
shipmentItems |
Массив объектов с информацией о выбранных элементах табличной части отгрузки |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения элемента табличной части отгрузки |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить элемент в табличную часть отгрузки sale.shipmentitem.add
- Изменить элемент в табличной части отгрузки sale.shipmentitem.update
- Получить доступ к полям элемента sale.shipmentitem.get
- Удалить элемент коллекции sale.shipmentitem.delete
- Получить поля табличной части отгрузки sale.shipmentitem.getfields