Получить список элементов табличной части отгрузки sale.shipmentitem.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
saleКто может выполнять метод: менеджер магазина
Метод sale.shipmentitem.list возвращает элементы табличных частей отгрузок: какие позиции корзины и в каком количестве входят в отгрузку.
В выборку попадают и элементы системной отгрузки, в которой числится нераспределенный товар заказа. Ее orderDeliveryId нет в ответе метода sale.shipment.list. Подробнее — в обзоре раздела.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Список полей, которые нужно вернуть. Доступные поля — в объекте sale_order_shipment_item. Если не передан или передан пустой массив, возвращаются все поля |
|
filter |
Объект для фильтрации выбранных элементов табличной части отгрузки в формате Возможные значения для Чтобы получить состав одной отгрузки, фильтруйте по Неизвестные поля в Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных элементов табличной части отгрузки в формате Возможные значения для Возможные значения для
По умолчанию элементы сортируются по возрастанию |
|
start |
Смещение для постраничной навигации. Размер страницы — 50 записей. По умолчанию Для второй страницы передайте Формула расчета значения параметра
Значение для следующей страницы приходит в поле |
Примеры кода
Как использовать примеры в документации
curl -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"},"start":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentitem.list
curl -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"},"start":0,"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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.shipmentitem.list(
select=[
"id",
"orderDeliveryId",
"basketId",
"quantity",
"xmlId",
"dateInsert",
"reservedQuantity",
],
filter={
"<id": 10,
"@orderDeliveryId": [
2431,
2430,
],
"basketId": 2716,
},
order={
"id": "desc",
},
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(
'sale.shipmentitem.list',
[
'select' => [
'id',
'orderDeliveryId',
'basketId',
'quantity',
'xmlId',
'dateInsert',
'reservedQuantity',
],
'filter' => [
'<id' => 10,
'@orderDeliveryId' => [2431, 2430],
'basketId' => 2716,
],
'order' => [
'id' => 'desc',
],
'start' => 0,
]
);
$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",
},
"start": 0
},
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",
],
'start' => 0
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.shipmentitem.list", b24.Params{
"select": []string{"id", "orderDeliveryId", "basketId", "quantity", "xmlId", "dateInsert", "reservedQuantity"},
"filter": b24.Params{
"<id": 10,
"@orderDeliveryId": []int{2431, 2430},
"basketId": 2716,
},
"order": b24.Params{
"id": "desc",
},
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.shipmentitem.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "shipmentItems".
raw, ok := b24.Unwrap(res.Result, "shipmentItems")
if !ok {
return fmt.Errorf("в ответе нет ключа shipmentItems")
}
var items []struct {
BasketID b24.ID `json:"basketId"`
DateInsert string `json:"dateInsert"`
ID b24.ID `json:"id"`
OrderDeliveryID b24.ID `json:"orderDeliveryId"`
Quantity float64 `json:"quantity"`
ReservedQuantity float64 `json:"reservedQuantity"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.BasketID)
}
Обработка ответа
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 |
Корневой элемент ответа (подробное описание) |
|
next |
Значение |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
shipmentItems |
Массив элементов табличной части отгрузки. Набор полей в каждом элементе задает параметр |
Обработка ошибок
HTTP-статус: 400
{
"error":"200040300010",
"error_description":"Access Denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения элементов табличной части отгрузки |
|
|
В |
|
|
Направление сортировки в |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Табличная часть отгрузки в Интернет-магазине: обзор методов
- Добавить элемент в табличную часть отгрузки sale.shipmentitem.add
- Изменить элемент в табличной части отгрузки sale.shipmentitem.update
- Получить элемент табличной части отгрузки sale.shipmentitem.get
- Удалить элемент табличной части отгрузки sale.shipmentitem.delete
- Получить поля элемента табличной части отгрузки sale.shipmentitem.getFields