Получить список значений свойств sale.propertyvalue.list
Scope:
saleКто может выполнять метод: администратор
Метод получает список вариантов значений свойств заказа.
Параметры метода
|
Название |
Описание |
|
select |
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_order_property_value). Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля значений свойств |
|
filter |
Объект для фильтрации выбранных значений свойств в формате Возможные значения для Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных значений свойств в формате Возможные значения для Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["code","id","name","orderId","orderPropsId","orderPropsXmlId","value"],"filter":{"=code":"FIO","%value":"Борис",">orderId":1600},"order":{"orderId":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.propertyvalue.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["code","id","name","orderId","orderPropsId","orderPropsXmlId","value"],"filter":{"=code":"FIO","%value":"Борис",">orderId":1600},"order":{"orderId":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.propertyvalue.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
const parameters = {
"select": [
"code",
"id",
"name",
"orderId",
"orderPropsId",
"orderPropsXmlId",
"value",
],
"filter": {
"=code": "FIO",
"%value": "Борис",
">orderId": 1600,
},
"order": {
"orderId": "desc",
},
};
try {
const response = await $b24.callListMethod(
'sale.propertyvalue.list',
parameters,
(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.propertyvalue.list', parameters, '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.propertyvalue.list', parameters, 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.propertyvalue.list',
[
'select' => [
'code',
'id',
'name',
'orderId',
'orderPropsId',
'orderPropsXmlId',
'value',
],
'filter' => [
'=code' => 'FIO',
'%value' => 'Борис',
'>orderId' => 1600,
],
'order' => [
'orderId' => 'desc',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching sale property values: ' . $e->getMessage();
}
BX24.callMethod(
"sale.propertyvalue.list", {
"select": [
"code",
"id",
"name",
"orderId",
"orderPropsId",
"orderPropsXmlId",
"value",
],
"filter": {
"=code": "FIO",
"%value": "Борис",
">orderId": 1600,
},
"order": {
"orderId": "desc",
},
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.propertyvalue.list',
[
'select' => [
'code',
'id',
'name',
'orderId',
'orderPropsId',
'orderPropsXmlId',
'value',
],
'filter' => [
'=code' => 'FIO',
'%value' => 'Борис',
'>orderId' => 1600,
],
'order' => [
'orderId' => 'desc',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result":{
"propertyValues":[
{
"code":"FIO",
"id":10774,
"name":"Имя Фамилия",
"orderId":1650,
"orderPropsId":20,
"orderPropsXmlId":null,
"value":"Соколов Борис Викторович"
},
{
"code":"FIO",
"id":10763,
"name":"Имя Фамилия",
"orderId":1649,
"orderPropsId":20,
"orderPropsXmlId":null,
"value":"Соколов Борис Викторович"
},
{
"code":"FIO",
"id":10723,
"name":"Имя Фамилия",
"orderId":1641,
"orderPropsId":20,
"orderPropsXmlId":null,
"value":"Соколов Борис Викторович"
},
{
"code":"FIO",
"id":10718,
"name":"Имя Фамилия",
"orderId":1640,
"orderPropsId":20,
"orderPropsXmlId":null,
"value":"Соколов Борис Викторович"
},
{
"code":"FIO",
"id":10713,
"name":"Имя Фамилия",
"orderId":1639,
"orderPropsId":20,
"orderPropsXmlId":null,
"value":"Соколов Борис Викторович"
},
{
"code":"FIO",
"id":10708,
"name":"Имя Фамилия",
"orderId":1638,
"orderPropsId":20,
"orderPropsXmlId":null,
"value":"Соколов Борис Викторович"
},
{
"code":"FIO",
"id":10687,
"name":"Имя Фамилия",
"orderId":1634,
"orderPropsId":20,
"orderPropsXmlId":null,
"value":"Соколов Борис Викторович"
},
{
"code":"FIO",
"id":10517,
"name":"Имя Фамилия",
"orderId":1603,
"orderPropsId":20,
"orderPropsXmlId":null,
"value":"Соколов Борис Викторович"
}
]
},
"total":8,
"time":{
"start":1712061753.171393,
"finish":1712061753.431631,
"duration":0.2602381706237793,
"processing":0.021820783615112305,
"date_start":"2024-04-02T15:42:33+03:00",
"date_finish":"2024-04-02T15:42:33+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
propertyValues |
Массив объектов с информацией о выбранных значениях свойств |
|
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.propertyvalue.modify
- Получить значение свойства по id sale.propertyvalue.get
- Удалить значение свойства sale.propertyvalue.delete
- Получить доступные поля значения свойства sale.propertyvalue.getfields