sale.shipmentitem.list
Получить список элементов табличной части отгрузки
Описание
Метод sale.shipmentitem.list позволяет получить список элементов табличной части отгрузки.
Параметры
select
array
необязательный
Массив содержит список полей, которые необходимо выбрать (смотрите поля объекта sale_order_shipment_item).
Если не передан или передан пустой массив, то будут выбраны все доступные поля элементов табличной части отгрузки.
filter
object
необязательный
Объект для фильтрации выбранных элементов табличной части отгрузки в формате {"field_1": "value_1", ... "field_N": "value_N"}.
Возможные значения для field соответствуют полям объекта sale_order_shipment_item.
Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- @ — 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_shipment_item.
Возможные значения для order:
- asc — в порядке возрастания
- desc — в порядке убывания
start
integer
необязательный
Параметр используется для управления постраничной навигацией.
Размер страницы результатов всегда статичный: 50 записей.
Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.
Формула расчета значения параметра start:
start = (N-1) * 50, где N — номер нужной страницы
Примеры запроса
-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>
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='1712819741.592596',
).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',
],
]
);
$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>';
// 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",
},
}, 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 int `json:"quantity"`
ReservedQuantity int `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
object
Корневой элемент ответа
shipmentItems
sale_order_shipment_item[]
Массив объектов с информацией о выбранных элементах табличной части отгрузки
total
integer
Общее количество найденных записей
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
| Код | Описание | Значение |
|---|---|---|
200040300010 |
Недостаточно прав для чтения элемента табличной части отгрузки | |
0 |
Другие ошибки (например, фатальные ошибки) |

