Получить список значений свойств отгрузки sale.shipmentpropertyvalue.list
Scope:
saleКто может выполнять метод: администратор
Метод возвращает список значений свойств отгрузки.
Параметры метода
|
Название |
Описание |
|
select |
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_shipment_property_value). Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля значений свойств |
|
filter |
Объект для фильтрации выбранных значений свойств в формате Возможные значения для Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных значений свойств в формате Возможные значения для Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
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: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
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: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
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: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем 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>';
Ответ в случае успеха
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 |
Корневой элемент ответа |
|
propertyValues |
Массив объектов с информацией о выбранных значениях свойств отгрузки |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения значений свойств |
|
|
Другие ошибки (например, фатальные ошибки) |
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Обновить значения свойств отгрузки sale.shipmentpropertyvalue.modify
- Получить значения свойства отгрузки по id sale.shipmentpropertyvalue.get
- Удалить значения свойства отгрузки sale.shipmentpropertyvalue.delete
- Получить доступные поля значений свойств отгрузки sale.shipmentpropertyvalue.getfields