Get a list of property groups sale.propertygroup.list
Scope:
saleWho can execute the method: administrator
This method is designed to retrieve a list of property groups.
Method Parameters
|
Name |
Description |
|
select |
An array of fields to select (see fields of the sale_order_property_group object). If the array is not provided or is empty, all available fields of property groups will be selected. |
|
filter |
An object for filtering the selected property groups in the format Possible values for An additional prefix can be specified for the key to clarify the filter behavior. Possible prefix values:
|
|
order |
An object for sorting the selected property groups in the format Possible values for Possible values for
|
Code Examples
How to Use Examples in Documentation
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
// 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.propertygroup.list',
{
"select": ["id", "name", "personTypeId", "sort"],
"filter": {
">=id": 14,
},
"order": {
"name": "asc",
"id": "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.propertygroup.list', {
"select": ["id", "name", "personTypeId", "sort"],
"filter": {
">=id": 14,
},
"order": {
"name": "asc",
"id": "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.propertygroup.list', {
"select": ["id", "name", "personTypeId", "sort"],
"filter": {
">=id": 14,
},
"order": {
"name": "asc",
"id": "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.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);
// Your logic for processing data
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>';
Response Handling
HTTP status: 200
{
"result": {
"propertyGroups": [
{
"id": 18,
"name": "New property group 2",
"personTypeId": 3,
"sort": 100
},
{
"id": 14,
"name": "New property group 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+02:00",
"date_finish": "2024-03-27T16:01:38+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
propertyGroups |
Array of objects containing information about the selected property groups |
|
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 rights to read property groups |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
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 allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Property Groups in the Online Store: Overview of Methods
- Create Property Group sale.propertygroup.add
- Update Property Group Fields sale.propertygroup.update
- Get Values of All Fields in a Property Group by ID sale.propertygroup.get
- Delete Property Group sale.propertygroup.delete
- Get Available Fields of Property Groups sale.propertygroup.getFields