Change the Value of the Property sale.propertyvalue.modify

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: sale

Who can execute the method: administrator

The method sale.propertyvalue.modify updates the property values of an order.

Please note that this method accepts all property values of the order as input. If values for any properties are not provided, their current values will be removed from the order as a result of the request.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

The root element that transmits the request parameters in the form of a structure:

{
            "order":
            {
                "id": "value",
                "propertyValues": {
                    "orderPropsId": "value",
                    "value": "value"
                },
            }
        }

Parameter fields

Required parameters are marked with *

Name
type

Description

order*
object

An object containing the order ID and property values in the form of a structure:

"id": "value",
        "propertyValues": {
            "orderPropsId": "value",
            "value": "value"
        },

Parameter order

Required parameters are marked with *

Name
type

Description

id*
sale_order.id

Order identifier

propertyValues*
object[]

An array of objects (see the description of the propertyValues object below), containing the order property identifier and property value

Parameter propertyValues

Required parameters are marked with *

Value
type

Description

orderPropsId*
sale_order_property.id

Order property identifier

value*
any

Order property value.

For multiple order properties, an array of values can be transmitted.

For properties of type file, an object in the format {"fileData": ["value1", "value2"]} should be provided:

  • value1 — file name with extension,
  • value2 — file in base64 format.

To delete a file, use an object in the format {"remove": "Y"}

Code Examples

How to Use Examples in Documentation

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":"04/17/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":"04/17/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 error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {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'        => '04/17/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: '04/17/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' => '04/17/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 and ctx are already created — see the Go SDK section
        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)
        }
        
        // The method wraps the response in an object with the "propertyValues" key.
        raw, ok := b24.Unwrap(res.Result, "propertyValues")
        if !ok {
        	return fmt.Errorf("no propertyValues key in the response")
        }
        
        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("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.Code)
        }

Response Handling

HTTP Status: 200

{
            "result": {
                "propertyValues": [
                    {
                        "code": "DELIVERY_DATE",
                        "id": 13167,
                        "name": "Delivery Date",
                        "orderPropsId": 51,
                        "orderPropsXmlId": null,
                        "value": "04/17/2024"
                    },
                    {
                        "code": "DELEVERY_REQUIRED",
                        "id": 13168,
                        "name": "Delivery Required",
                        "orderPropsId": 52,
                        "orderPropsXmlId": null,
                        "value": "Y"
                    },
                    {
                        "code": "DOC",
                        "id": 13170,
                        "name": "Document Confirming the Right to Purchase the Product",
                        "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": "04/02/2024 09:13:29",
                            "versionOriginalId": null,
                            "width": "600"
                        }
                    },
                    {
                        "code": "MAX_DELIVERY_DAYS",
                        "id": 13171,
                        "name": "Deliver No Later Than (Days After Order)",
                        "orderPropsId": 54,
                        "orderPropsXmlId": null,
                        "value": "10"
                    },
                    {
                        "code": "FIO",
                        "id": 13163,
                        "name": "Full 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": "Phone",
                        "orderPropsId": 22,
                        "orderPropsXmlId": null,
                        "value": "+10907996161"
                    },
                    {
                        "code": "LOCATION",
                        "id": 13166,
                        "name": "Location",
                        "orderPropsId": 25,
                        "orderPropsXmlId": "bx_63e3a3b974932",
                        "value": "0000073738"
                    },
                    {
                        "code": "ADDRESS",
                        "id": 13162,
                        "name": "Delivery Address",
                        "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+02:00",
                "date_finish": "2024-04-02T12:10:56+02:00"
            }
        }

Returned Data

Name
type

Description

result
object

The root element of the response

propertyValues
sale_order_property_value[]

An array of objects containing information about the order property values

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": 100,
            "error_description": "Could not find value for parameter {fields}"
        }

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

200040300020

Insufficient permissions to change order property values

100

Parameter fields is not specified or is empty

0

Order not found

0

Required parameters are not specified

0

Other errors (e.g., fatal errors)

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Previous
Overview of Methods
Next
Get Property Value