Get a list of shipment item table elements sale.shipmentitem.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
saleWho can execute the method: store manager
The method sale.shipmentitem.list returns items of shipment table parts: which basket items are included in a shipment and in what quantity.
The selection also includes items of the system shipment, which holds the order's unallocated product. Its orderDeliveryId is not present in the response of the sale.shipment.list method. For details, see the section overview.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
select |
The list of fields to return. Available fields are listed in the sale_order_shipment_item object. If not provided or an empty array is passed, all fields are returned |
|
filter |
An object for filtering the selected shipment item table elements in the format Possible values for To retrieve the contents of a single shipment, filter by The method ignores unknown fields in An additional prefix can be assigned to the key to specify the filter behavior. Possible prefix values:
|
|
order |
An object for sorting the selected shipment item table elements in the format Possible values for Possible values for
By default, items are sorted by |
|
start |
Offset for pagination. The page size is 50 records. Defaults to For the second page, pass The formula for calculating the value of the
The value for the next page is returned in the |
Code Examples
How to Use Examples in Documentation
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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {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 and ctx are already created — see the Go SDK section
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)
}
// The method wraps the response in an object with the "shipmentItems" key.
raw, ok := b24.Unwrap(res.Result, "shipmentItems")
if !ok {
return fmt.Errorf("no shipmentItems key in the response")
}
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("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.BasketID)
}
Response Handling
HTTP status: 200
{
"result": {
"shipmentItems": [
{
"basketId": 2716,
"dateInsert": "2024-04-11T09:10:34+02:00",
"id": 7,
"orderDeliveryId": 2431,
"quantity": 5,
"reservedQuantity": 0,
"xmlId": "myNewXmlId"
},
{
"basketId": 2716,
"dateInsert": "2024-04-08T10:36:24+02: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+02:00",
"date_finish": "2024-04-11T10:15:41+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response (detailed description) |
|
next |
The |
|
total |
Total number of records found |
|
time |
Information about the execution time of the request |
Object result
|
Name |
Description |
|
shipmentItems |
An array of shipment table part items. The set of fields in each item is defined by the |
Error Handling
HTTP status: 400
{
"error": "200040300010",
"error_description": "Access Denied"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient permissions to read the shipment item table elements |
|
|
The sort direction passed in |
|
|
The sort direction in |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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 |
Continue Learning
- Shipment Table Section in the Online Store: Overview of Methods
- Add an item to the shipment table part sale.shipmentitem.add
- Update an item in the shipment table part sale.shipmentitem.update
- Get a Shipment Table Part Item sale.shipmentitem.get
- Delete a Shipment Table Part Item sale.shipmentitem.delete
- Get Fields of a Shipment Table Part Item sale.shipmentitem.getFields