sale.propertyvalue.modify
Изменить значение свойства
Описание
Метод sale.propertyvalue.modify обновляет значения свойств заказа.
Обратите внимание, что данный метод принимает на вход все значения свойств заказа. Если значения каких-то свойств не будут переданы, то их текущие значения будут удалены из заказа в результате выполнения запроса.
Параметры
fields
object
обязательный
Корневой элемент, в котором передаются параметры запроса в виде структуры:
{
"order":
{
"id": "значение",
"propertyValues": {
"orderPropsId": "значение",
"value": "значение"
},
}
}Параметр fields
order
object
обязательный
Объект, содержащий значения идентификатора заказа и значения свойств заказа в виде структуры:
"id": "значение",
"propertyValues": {
"orderPropsId": "значение",
"value": "значение"
},Параметр order
id
sale_order.id
обязательный
Идентификатор заказа
propertyValues
object[]
обязательный
Массив объектов (смотрите описание объекта propertyValues ниже), содержащих идентификатор свойства заказа и значение свойства
Параметр propertyValues
orderPropsId
sale_order_property.id
обязательный
Идентификатор свойства заказа
value
any
обязательный
Значение свойства заказа.
Для множественных свойств заказа (multiple) поддерживается передача массива значений.
Для свойств типа file нужно передать объект в формате {"fileData": ["value1", "value2"]}:
- value1 — название файла с расширением,
- value2 — файл в формате base64.
Для удаления файла используется объект в формате {"remove": "Y"}
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"order":{"id":2066,"propertyValues":[{"orderPropsId":20,"value":"John Smith"},{"orderPropsId":21,"value":"johnsmith@example.com"},{"orderPropsId":22,"value":"+10907996161"},{"orderPropsId":25,"value":"0000073738"},{"orderPropsId":26,"value":"900 S Holland Ave, Springfield, MO 65806, United States"},{"orderPropsId":51,"value":"17.04.2024"},{"orderPropsId":52,"value":"Y"},{"orderPropsId":53,"value":"948"},{"orderPropsId":54,"value":"10"}]}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.propertyvalue.modify
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"order":{"id":2066,"propertyValues":[{"orderPropsId":20,"value":"John Smith"},{"orderPropsId":21,"value":"johnsmith@example.com"},{"orderPropsId":22,"value":"+10907996161"},{"orderPropsId":25,"value":"0000073738"},{"orderPropsId":26,"value":"900 S Holland Ave, Springfield, MO 65806, United States"},{"orderPropsId":51,"value":"17.04.2024"},{"orderPropsId":52,"value":"Y"},{"orderPropsId":53,"value":"948"},{"orderPropsId":54,"value":"10"}]}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.propertyvalue.modify
// 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
// Shape of the payload returned in result (match the "response handling" section of the page)
type PropertyValueModifyResult = {
propertyValues: {
code: string
id: number
name: string
orderPropsId: number
orderPropsXmlId: string | null
value: string | object
}[]
}
try {
const response = await $b24.actions.v2.call.make<PropertyValueModifyResult>({
method: 'sale.propertyvalue.modify',
params: {
fields: {
order: {
id: 2066,
propertyValues: [
{ orderPropsId: 20, value: 'John Smith' },
{ orderPropsId: 21, value: 'johnsmith@example.com' },
{ orderPropsId: 22, value: '+10907996161' },
{ orderPropsId: 25, value: '0000073738' },
{ orderPropsId: 26, value: '900 S Holland Ave, Springfield, MO 65806, United States' },
{ orderPropsId: 51, value: '17.04.2024' },
{ orderPropsId: 52, value: 'Y' },
{ orderPropsId: 53, value: '948' },
{ orderPropsId: 54, value: '10' },
],
},
},
},
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.propertyValues)
}
} 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 modifyPropertyValues() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.propertyvalue.modify',
params: {
fields: {
order: {
id: 2066,
propertyValues: [
{ orderPropsId: 20, value: 'John Smith' },
{ orderPropsId: 21, value: 'johnsmith@example.com' },
{ orderPropsId: 22, value: '+10907996161' },
{ orderPropsId: 25, value: '0000073738' },
{ orderPropsId: 26, value: '900 S Holland Ave, Springfield, MO 65806, United States' },
{ orderPropsId: 51, value: '17.04.2024' },
{ orderPropsId: 52, value: 'Y' },
{ orderPropsId: 53, value: '948' },
{ orderPropsId: 54, value: '10' },
],
},
},
},
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.propertyValues)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', modifyPropertyValues)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"order": {
"id": 2066,
"propertyValues": [
{
"orderPropsId": 20,
"value": "John Smith",
},
{
"orderPropsId": 21,
"value": "johnsmith@example.com",
},
{
"orderPropsId": 22,
"value": "+10907996161",
},
{
"orderPropsId": 25,
"value": "0000073738",
},
{
"orderPropsId": 26,
"value": "900 S Holland Ave, Springfield, MO 65806, United States",
},
{
"orderPropsId": 51,
"value": "17.04.2024",
},
{
"orderPropsId": 52,
"value": "Y",
},
{
"orderPropsId": 53,
"value": "948",
},
{
"orderPropsId": 54,
"value": "10",
},
],
},
}
try:
bitrix_response = client.sale.propertyvalue.modify(
fields=fields,
).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.propertyvalue.modify',
[
'fields' => [
'order' => [
'id' => 2066,
'propertyValues' => [
[
'orderPropsId' => 20,
'value' => 'John Smith'
],
[
'orderPropsId' => 21,
'value' => 'johnsmith@example.com'
],
[
'orderPropsId' => 22,
'value' => '+10907996161'
],
[
'orderPropsId' => 25,
'value' => '0000073738'
],
[
'orderPropsId' => 26,
'value' => '900 S Holland Ave, Springfield, MO 65806, United States'
],
[
'orderPropsId' => 51,
'value' => '17.04.2024'
],
[
'orderPropsId' => 52,
'value' => 'Y'
],
[
'orderPropsId' => 53,
'value' => '948'
],
[
'orderPropsId' => 54,
'value' => '10'
],
],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error modifying sale property value: ' . $e->getMessage();
}
BX24.callMethod(
'sale.propertyvalue.modify', {
fields: {
order: {
id: 2066,
propertyValues: [{
orderPropsId: 20,
value: 'John Smith'
},
{
orderPropsId: 21,
value: 'johnsmith@example.com'
},
{
orderPropsId: 22,
value: '+10907996161'
},
{
orderPropsId: 25,
value: '0000073738'
},
{
orderPropsId: 26,
value: '900 S Holland Ave, Springfield, MO 65806, United States'
},
{
orderPropsId: 51,
value: '17.04.2024'
},
{
orderPropsId: 52,
value: 'Y'
},
{
orderPropsId: 53,
value: ‘948’
},
{
orderPropsId: 54,
value: ‘10’
},
],
},
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.propertyvalue.modify',
[
'fields' => [
'order' => [
'id' => 2066,
'propertyValues' => [
[
'orderPropsId' => 20,
'value' => 'John Smith'
],
[
'orderPropsId' => 21,
'value' => 'johnsmith@example.com'
],
[
'orderPropsId' => 22,
'value' => '+10907996161'
],
[
'orderPropsId' => 25,
'value' => '0000073738'
],
[
'orderPropsId' => 26,
'value' => '900 S Holland Ave, Springfield, MO 65806, United States'
],
[
'orderPropsId' => 51,
'value' => '17.04.2024'
],
[
'orderPropsId' => 52,
'value' => 'Y'
],
[
'orderPropsId' => 53,
'value' => '948' // Corrected quotation marks
],
[
'orderPropsId' => 54,
'value' => '10' // Corrected quotation marks
],
],
],
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.propertyvalue.modify", b24.Params{
"fields": b24.Params{
"order": b24.Params{
"id": 2066,
"propertyValues": []b24.Params{
{
"orderPropsId": 20,
"value": "John Smith",
},
{
"orderPropsId": 21,
"value": "johnsmith@example.com",
},
{
"orderPropsId": 22,
"value": "+10907996161",
},
{
"orderPropsId": 25,
"value": "0000073738",
},
{
"orderPropsId": 26,
"value": "900 S Holland Ave, Springfield, MO 65806, United States",
},
{
"orderPropsId": 51,
"value": "17.04.2024",
},
{
"orderPropsId": 52,
"value": "Y",
},
{
"orderPropsId": 53,
"value": "948",
},
{
"orderPropsId": 54,
"value": "10",
},
},
},
},
})
if err != nil {
return fmt.Errorf("sale.propertyvalue.modify: %w", err)
}
// Метод заворачивает ответ в объект с ключом "propertyValues".
raw, ok := b24.Unwrap(res.Result, "propertyValues")
if !ok {
return fmt.Errorf("в ответе нет ключа propertyValues")
}
var items []struct {
Code string `json:"code"`
ID b24.ID `json:"id"`
Name string `json:"name"`
OrderPropsID b24.ID `json:"orderPropsId"`
Value string `json:"value"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.Code)
}
Ответ
HTTP-статус: 200
{
"result":{
"propertyValues":[
{
"code":"DELIVERY_DATE",
"id":13167,
"name":"Дата доставки",
"orderPropsId":51,
"orderPropsXmlId":null,
"value":"17.04.2024"
},
{
"code":"DELEVERY_REQUIRED",
"id":13168,
"name":"Необходимость доставки",
"orderPropsId":52,
"orderPropsXmlId":null,
"value":"Y"
},
{
"code":"DOC",
"id":13170,
"name":"Документ подтверждающий наличие права на покупку товара",
"orderPropsId":53,
"orderPropsXmlId":null,
"value":{
"contentType":"image\/jpeg",
"description":"",
"externalId":"89359a6dc806e5dc5404962d1be0ba42",
"fileName":"fit.jpeg",
"fileSize":"84058",
"handlerId":null,
"height":"800",
"id":"948",
"meta":"",
"moduleId":"fileman",
"originalName":"fit.jpeg",
"src":"\/upload\/medialibrary\/5bd\/ukgwed4vdxe1qaqv85pqrvdgq5moyhqh\/fit.jpeg",
"subdir":"medialibrary\/5bd\/ukgwed4vdxe1qaqv85pqrvdgq5moyhqh",
"timestampX":"02.04.2024 09:13:29",
"versionOriginalId":null,
"width":"600"
}
},
{
"code":"MAX_DELIVERY_DAYS",
"id":13171,
"name":"Доставить не позднее (дней после заказа)",
"orderPropsId":54,
"orderPropsXmlId":null,
"value":"10"
},
{
"code":"FIO",
"id":13163,
"name":"Имя Фамилия",
"orderPropsId":20,
"orderPropsXmlId":null,
"value":"John Smith"
},
{
"code":"EMAIL",
"id":13164,
"name":"E-Mail",
"orderPropsId":21,
"orderPropsXmlId":null,
"value":"johnsmith@example.com"
},
{
"code":"PHONE",
"id":13165,
"name":"Телефон",
"orderPropsId":22,
"orderPropsXmlId":null,
"value":"+10907996161"
},
{
"code":"LOCATION",
"id":13166,
"name":"Местоположение",
"orderPropsId":25,
"orderPropsXmlId":"bx_63e3a3b974932",
"value":"0000073738"
},
{
"code":"ADDRESS",
"id":13162,
"name":"Адрес доставки",
"orderPropsId":26,
"orderPropsXmlId":null,
"value":"900 S Holland Ave, Springfield, MO 65806, United States"
}
]
},
"time":{
"start":1712049055.756753,
"finish":1712049056.823234,
"duration":1.066481113433838,
"processing":0.7959079742431641,
"date_start":"2024-04-02T12:10:55+03:00",
"date_finish":"2024-04-02T12:10:56+03:00"
}
}
Возвращаемые данные
result
object
Корневой элемент ответа
propertyValues
sale_order_property_value[]
Массив объектов, содержащих информацию о значениях свойств заказов
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":100,
"error_description":"Could not find value for parameter {fields}"
}
| Код | Описание | Значение |
|---|---|---|
200040300020 |
Недостаточно прав для изменения значений свойств заказа | |
100 |
Не указан или пустой параметр fields |
|
0 |
Заказ не найден | |
0 |
Не указаны обязательные параметры | |
0 |
Другие ошибки (например, фатальные ошибки) |

