sale.shipmentpropertyvalue.list
Получить список значений свойств отгрузки
Описание
Метод sale.shipmentpropertyvalue.list возвращает список значений свойств отгрузки.
Параметры
select
array
необязательный
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_shipment_property_value).
Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля значений свойств
filter
object
необязательный
Объект для фильтрации выбранных значений свойств в формате {"field_1": "value_1", ... "field_N": "value_N"}.
Возможные значения для fieldсоответствуют полям объекта sale_shipment_property_value.
Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- %= — LIKE (аналогично =%)
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, не начинающиеся с «мол»
- "%мол" — ищет значения, не заканчивающиеся на «мол»
- "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
- !%= — NOT LIKE (аналогично !=%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно
order
object
необязательный
Объект для сортировки выбранных значений свойств в формате {"field_1": "order_1", ... "field_N": "order_N"}.
Возможные значения для field соответствуют полям объекта sale_shipment_property_value.
Возможные значения для order:
- asc — в порядке возрастания
- desc — в порядке убывания
start
integer
необязательный
Параметр используется для управления постраничной навигацией.
Размер страницы результатов всегда статичный: 50 записей.
Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.
Формула расчета значения параметра start:
start = (N-1) * 50, где N – номер нужной страницы
Примеры запроса
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
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type ShipmentPropertyValueResult = {
propertyValues: {
code: string | null
id: number
name: string
shipmentId: number
shipmentPropsId: number
shipmentPropsXmlId: string
value: string
}[]
}
// sale.shipmentpropertyvalue.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<ShipmentPropertyValueResult>({
method: 'sale.shipmentpropertyvalue.list',
params: {
select: [
'code',
'id',
'name',
'shipmentId',
'shipmentPropsId',
'shipmentPropsXmlId',
'value',
],
filter: {
'@shipmentId': [4120],
},
order: {
shipmentId: '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('Property values:', result.propertyValues, 'Count on page:', result.propertyValues.length)
}
} 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 listShipmentPropertyValues() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// sale.shipmentpropertyvalue.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.shipmentpropertyvalue.list',
params: {
select: [
'code',
'id',
'name',
'shipmentId',
'shipmentPropsId',
'shipmentPropsXmlId',
'value',
],
filter: {
'@shipmentId': [4120],
},
order: {
shipmentId: '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('Property values:', result.propertyValues, 'Count on page:', result.propertyValues.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listShipmentPropertyValues)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.shipmentpropertyvalue.list(
select=[
"code",
"id",
"name",
"shipmentId",
"shipmentPropsId",
"shipmentPropsXmlId",
"value",
],
filter={
"@shipmentId": [
4120,
],
},
order={
"shipmentId": "desc",
},
start='1718023945.124614',
).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.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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.shipmentpropertyvalue.list", b24.Params{
"select": []string{"code", "id", "name", "shipmentId", "shipmentPropsId", "shipmentPropsXmlId", "value"},
"filter": b24.Params{
"@shipmentId": []int{4120},
},
"order": b24.Params{
"shipmentId": "desc",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.shipmentpropertyvalue.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "propertyValues".
raw, ok := b24.Unwrap(res.Result, "propertyValues")
if !ok {
return fmt.Errorf("в ответе нет ключа propertyValues")
}
var items []struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
ShipmentID b24.ID `json:"shipmentId"`
ShipmentPropsID b24.ID `json:"shipmentPropsId"`
ShipmentPropsXmlID string `json:"shipmentPropsXmlId"`
Value string `json:"value"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
Ответ
HTTP-статус: 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+03:00",
"date_finish":"2024-06-10T15:52:25+03:00"
}
}
Возвращаемые данные
result
object
Корневой элемент ответа
propertyValues
sale_shipment_property_value[]
Массив объектов с информацией о выбранных значениях свойств отгрузки
total
integer
Общее количество найденных записей
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
| Код | Описание | Значение |
|---|---|---|
200040300010 |
Недостаточно прав для чтения значений свойств | |
0 |
Другие ошибки (например, фатальные ошибки) |

