sale.propertygroup.list
Получить список групп свойств
Описание
Метод sale.propertygroup.list получает список групп свойств.
Параметры
select
array
необязательный
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_order_property_group).
Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля групп свойств
filter
object
необязательный
Объект для фильтрации выбранных групп свойств в формате {"field_1": "value_1", ... "field_N": "value_N"}.
Возможные значения для field соответствуют полям объекта sale_order_property_group.
Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- + — фильтрация по точному значению заданного поля; при этом в выборку также попадают и те элементы, у которых значение поля не определено (NULL)
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- != — не равно
- ! — не равно
order
object
необязательный
Объект для сортировки выбранных групп свойств в формате {"field_1": "order_1", ... "field_N": "order_N"}.
Возможные значения для field соответствуют полям объекта sale_order_property_group.
Возможные значения для order:
- asc — в порядке возрастания
- desc — в порядке убывания
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","name","personTypeId","sort"],"filter":{">=id":14},"order":{"name":"asc","id":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.propertygroup.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","name","personTypeId","sort"],"filter":{">=id":14},"order":{"name":"asc","id":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.propertygroup.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
type PropertyGroup = {
id: number
name: string
personTypeId: number
sort: number
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type PropertyGroupListResult = {
propertyGroups: PropertyGroup[]
}
try {
// sale.propertygroup.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<PropertyGroupListResult>({
method: 'sale.propertygroup.list',
params: {
select: ['id', 'name', 'personTypeId', 'sort'],
filter: {
'>=id': 14,
},
order: {
name: 'asc',
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(result.propertyGroups.length, result.propertyGroups)
}
} 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 fetchPropertyGroups() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// sale.propertygroup.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.propertygroup.list',
params: {
select: ['id', 'name', 'personTypeId', 'sort'],
filter: {
'>=id': 14,
},
order: {
name: 'asc',
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(result.propertyGroups.length, result.propertyGroups)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchPropertyGroups)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.propertygroup.list(
select=[
"id",
"name",
"personTypeId",
"sort",
],
filter={
">=id": 14,
},
order={
"name": "asc",
"id": "desc",
},
).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.propertygroup.list',
[
'select' => ['id', 'name', 'personTypeId', 'sort'],
'filter' => [
'>=id' => 14,
],
'order' => [
'name' => 'asc',
'id' => 'desc',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching property groups: ' . $e->getMessage();
}
BX24.callMethod(
"sale.propertygroup.list", {
"select": ["id", "name", "personTypeId", "sort"],
"filter": {
">=id": 14,
},
"order": {
"name": "asc",
"id": "desc",
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.propertygroup.list',
[
'select' => ['id', 'name', 'personTypeId', 'sort'],
'filter' => ['>=id' => 14],
'order' => [
'name' => 'asc',
'id' => 'desc',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.propertygroup.list", b24.Params{
"select": []string{"id", "name", "personTypeId", "sort"},
"filter": b24.Params{
">=id": 14,
},
"order": b24.Params{
"name": "asc",
"id": "desc",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.propertygroup.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "propertyGroups".
raw, ok := b24.Unwrap(res.Result, "propertyGroups")
if !ok {
return fmt.Errorf("в ответе нет ключа propertyGroups")
}
var items []struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
PersonTypeID b24.ID `json:"personTypeId"`
Sort int `json:"sort"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
Ответ
HTTP-статус: 200
{
"result":{
"propertyGroups":[
{
"id":18,
"name":"Новая группа свойств 2",
"personTypeId":3,
"sort":100
},
{
"id":14,
"name":"Новая группа свойств 1",
"personTypeId":3,
"sort":100
}
]
},
"total":2,
"time":{
"start":1711544498.747502,
"finish":1711544498.987554,
"duration":0.2400519847869873,
"processing":0.010115861892700195,
"date_start":"2024-03-27T16:01:38+03:00",
"date_finish":"2024-03-27T16:01:38+03:00"
}
}
Возвращаемые данные
result
object
Корневой элемент ответа
propertyGroups
sale_order_property_group[]
Массив объектов с информацией о выбранных группах свойств
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
| Код | Описание | Значение |
|---|---|---|
200040300010 |
Недостаточно прав для чтения групп свойств | |
0 |
Другие ошибки (например, фатальные ошибки) |

