Get a list of property values sale.propertyvalue.list
Scope:
saleWho can execute the method: administrator
This method retrieves a list of order property value options.
Method Parameters
|
Name |
Description |
|
select |
An array of fields to be selected (see fields of the sale_order_property_value object). If the array is not provided or an empty array is passed, all available property value fields will be selected. |
|
filter |
An object for filtering selected property values in the format Possible values for An additional prefix can be assigned to the key to clarify the filter behavior. Possible prefix values:
|
|
order |
An object for sorting selected property values in the format Possible values for Possible values for
|
|
start |
This parameter is used to manage pagination. The page size of results is always static: 50 records. To select the second page of results, pass the value The formula for calculating the
|
Code Examples
How to Use Examples in Documentation
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":"Boris",">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":"Boris",">orderId":1600},"order":{"orderId":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.propertyvalue.list
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
const parameters = {
"select": [
"code",
"id",
"name",
"orderId",
"orderPropsId",
"orderPropsXmlId",
"value",
],
"filter": {
"=code": "FIO",
"%value": "Boris",
">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: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
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: 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.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' => 'Boris',
'>orderId' => 1600,
],
'order' => [
'orderId' => 'desc',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your required data processing logic
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": "Boris",
">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' => 'Boris',
'>orderId' => 1600,
],
'order' => [
'orderId' => 'desc',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"propertyValues": [
{
"code": "FIO",
"id": 10774,
"name": "First Last Name",
"orderId": 1650,
"orderPropsId": 20,
"orderPropsXmlId": null,
"value": "Sokolov Boris Viktorovich"
},
{
"code": "FIO",
"id": 10763,
"name": "First Last Name",
"orderId": 1649,
"orderPropsId": 20,
"orderPropsXmlId": null,
"value": "Sokolov Boris Viktorovich"
},
{
"code": "FIO",
"id": 10723,
"name": "First Last Name",
"orderId": 1641,
"orderPropsId": 20,
"orderPropsXmlId": null,
"value": "Sokolov Boris Viktorovich"
},
{
"code": "FIO",
"id": 10718,
"name": "First Last Name",
"orderId": 1640,
"orderPropsId": 20,
"orderPropsXmlId": null,
"value": "Sokolov Boris Viktorovich"
},
{
"code": "FIO",
"id": 10713,
"name": "First Last Name",
"orderId": 1639,
"orderPropsId": 20,
"orderPropsXmlId": null,
"value": "Sokolov Boris Viktorovich"
},
{
"code": "FIO",
"id": 10708,
"name": "First Last Name",
"orderId": 1638,
"orderPropsId": 20,
"orderPropsXmlId": null,
"value": "Sokolov Boris Viktorovich"
},
{
"code": "FIO",
"id": 10687,
"name": "First Last Name",
"orderId": 1634,
"orderPropsId": 20,
"orderPropsXmlId": null,
"value": "Sokolov Boris Viktorovich"
},
{
"code": "FIO",
"id": 10517,
"name": "First Last Name",
"orderId": 1603,
"orderPropsId": 20,
"orderPropsXmlId": null,
"value": "Sokolov Boris Viktorovich"
}
]
},
"total": 8,
"time": {
"start": 1712061753.171393,
"finish": 1712061753.431631,
"duration": 0.2602381706237793,
"processing": 0.021820783615112305,
"date_start": "2024-04-02T15:42:33+02:00",
"date_finish": "2024-04-02T15:42:33+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
propertyValues |
An array of objects with information about the selected property values |
|
time |
Information about the request execution time |
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 permissions to read property values |
|
|
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
- Overview of Methods
- Change the value of the property sale.propertyvalue.modify
- Get Property Value by ID sale.propertyvalue.get
- Delete Order Property Value sale.propertyvalue.delete
- Get Available Fields of the Property Value sale.propertyvalue.getFields