Get a list of shipment property values sale.shipmentpropertyvalue.list
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
saleWho can execute the method: administrator
The method returns a list of shipment property values.
Method Parameters
|
Name |
Description |
|
select |
An array of fields to select (see fields of the sale_shipment_property_value object). If the array is not provided or an empty array is passed, all available property value fields will be selected. |
|
filter |
An object for filtering selected property values in the format Possible values for An additional prefix can be assigned to the key to specify the filter behavior. Possible prefix values:
|
|
order |
An object for sorting selected property values in the format Possible values for Possible values for
|
|
start |
This parameter is used to manage pagination. The page size of results is always static: 50 records. To select the second page of results, pass the value The formula for calculating the
|
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["code","id","name","shipmentId","shipmentPropsId","shipmentPropsXmlId","value"],"filter":{"@shipmentId":[4120]},"order":{"shipmentId":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentpropertyvalue.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["code","id","name","shipmentId","shipmentPropsId","shipmentPropsXmlId","value"],"filter":{"@shipmentId":[4120]},"order":{"shipmentId":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.shipmentpropertyvalue.list
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
try {
const response = await $b24.callListMethod(
'sale.shipmentpropertyvalue.list',
{
"select": [
"code",
"id",
"name",
"shipmentId",
"shipmentPropsId",
"shipmentPropsXmlId",
"value",
],
"filter": {
"@shipmentId": [4120],
},
"order": {
"shipmentId": "desc",
},
},
(progress) => { console.log('Progress:', progress) }
)
const items = response.getData() || []
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
try {
const generator = $b24.fetchListMethod('sale.shipmentpropertyvalue.list', {
"select": [
"code",
"id",
"name",
"shipmentId",
"shipmentPropsId",
"shipmentPropsXmlId",
"value",
],
"filter": {
"@shipmentId": [4120],
},
"order": {
"shipmentId": "desc",
},
}, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
try {
const response = await $b24.callMethod('sale.shipmentpropertyvalue.list', {
"select": [
"code",
"id",
"name",
"shipmentId",
"shipmentPropsId",
"shipmentPropsXmlId",
"value",
],
"filter": {
"@shipmentId": [4120],
},
"order": {
"shipmentId": "desc",
},
}, 0)
const result = response.getData().result || []
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'sale.shipmentpropertyvalue.list',
[
'select' => [
'code',
'id',
'name',
'shipmentId',
'shipmentPropsId',
'shipmentPropsXmlId',
'value',
],
'filter' => [
'@shipmentId' => [4120],
],
'order' => [
'shipmentId' => 'desc',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching shipment property values: ' . $e->getMessage();
}
BX24.callMethod(
"sale.shipmentpropertyvalue.list", {
"select": [
"code",
"id",
"name",
"shipmentId",
"shipmentPropsId",
"shipmentPropsXmlId",
"value",
],
"filter": {
"@shipmentId": [4120],
},
"order": {
"shipmentId": "desc",
},
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.shipmentpropertyvalue.list',
[
'select' => [
"code",
"id",
"name",
"shipmentId",
"shipmentPropsId",
"shipmentPropsXmlId",
"value",
],
'filter' => [
"@shipmentId" => [4120],
],
'order' => [
"shipmentId" => "desc",
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Successful Response
HTTP status: 200
{
"result": {
"propertyValues": [
{
"code": null,
"id": 38164,
"name": "Comments",
"shipmentId": 4120,
"shipmentPropsId": 105,
"shipmentPropsXmlId": "bx_6661d1b6690d5",
"value": "Comments value"
},
{
"code": null,
"id": 38166,
"name": "Description",
"shipmentId": 4120,
"shipmentPropsId": 106,
"shipmentPropsXmlId": "bx_6666cc212db52",
"value": "Description value"
}
]
},
"total": 2,
"time": {
"start": 1718023945.124614,
"finish": 1718023945.312019,
"duration": 0.18740510940551758,
"processing": 0.016345977783203125,
"date_start": "2024-06-10T15:52:25+02:00",
"date_finish": "2024-06-10T15:52:25+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
propertyValues |
An array of objects with information about the selected shipment property values |
|
total |
Total number of records found |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error": 0,
"error_description": "error"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient permissions to read property values |
|
|
Other errors (e.g., fatal errors) |
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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
- Update Shipment Property Values sale.shipmentpropertyvalue.modify
- Get Shipment Property Value by ID sale.shipmentpropertyvalue.get
- Delete Shipment Property Value sale.shipmentpropertyvalue.delete
- Get Available Fields of Shipment Property Values sale.shipmentpropertyvalue.getfields