Update Shipment Property Values sale.shipmentpropertyvalue.modify

Scope: sale

Who can execute the method: administrator

This method updates the shipment property values.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	The root element that carries the request parameters

Parameter fields

Required parameters are marked with *

Name `type`	Description
shipment* `object`	The object containing the shipment ID and shipment property values (detailed description provided below)

Parameter shipment

Required parameters are marked with *

Name `type`	Description
id* `sale_order_shipment.id`	Shipment ID
propertyValues* `object[]`	An array of objects containing the shipment property ID and property value (detailed description provided below)

Parameter propertyValues

Required parameters are marked with *

Name `type`	Description
shipmentPropsId* `sale_shipment_property.id`	Shipment property ID
value* `string`	Property value

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"shipment":{"id":4120,"propertyValues":[{"shipmentPropsId":105,"value":"Comments value"},{"shipmentPropsId":106,"value":"Description value"}]}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentpropertyvalue.modify

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"shipment":{"id":4120,"propertyValues":[{"shipmentPropsId":105,"value":"Comments value"},{"shipmentPropsId":106,"value":"Description value"}]}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.shipmentpropertyvalue.modify

try
        {
        	const response = await $b24.callMethod(
        		'sale.shipmentpropertyvalue.modify', {
        			fields: {
        				shipment: {
        					id: 4120,
        					propertyValues: [{
        							shipmentPropsId: 105,
        							value: 'Comments value'
        						},
        						{
        							shipmentPropsId: 106,
        							value: 'Description value'
        						},
        					],
        				},
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.shipmentpropertyvalue.modify',
                    [
                        'fields' => [
                            'shipment' => [
                                'id'            => 4120,
                                'propertyValues' => [
                                    [
                                        'shipmentPropsId' => 105,
                                        'value'           => 'Comments value'
                                    ],
                                    [
                                        'shipmentPropsId' => 106,
                                        'value'           => 'Description value'
                                    ],
                                ],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error modifying shipment property value: ' . $e->getMessage();
        }

BX24.callMethod(
            'sale.shipmentpropertyvalue.modify', {
                fields: {
                    shipment: {
                        id: 4120,
                        propertyValues: [{
                                shipmentPropsId: 105,
                                value: 'Comments value'
                            },
                            {
                                shipmentPropsId: 106,
                                value: 'Description value'
                            },
                        ],
                    },
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.shipmentpropertyvalue.modify',
            [
                'fields' => [
                    'shipment' => [
                        'id' => 4120,
                        'propertyValues' => [
                            [
                                'shipmentPropsId' => 105,
                                'value' => 'Comments value'
                            ],
                            [
                                'shipmentPropsId' => 106,
                                'value' => 'Description value'
                            ],
                        ],
                    ],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Successful Response

HTTP status: 200

{
            "result": {
                "propertyValues": [
                    {
                        "code": null,
                        "id": 38164,
                        "name": "Comments",
                        "value": "Comments value"
                    },
                    {
                        "code": null,
                        "id": 38165,
                        "name": "Description",
                        "value": "Description value"
                    }
                ]
            },
            "time": {
                "start": 1718022201.149589,
                "finish": 1718022201.726496,
                "duration": 0.5769069194793701,
                "processing": 0.38397693634033203,
                "date_start": "2024-06-10T15:23:21+02:00",
                "date_finish": "2024-06-10T15:23:21+02:00"
            }
        }

Returned Data

Name `type`	Description
result `object`	The root element of the response
propertyValues `sale_shipment_property_value[]`	An array of objects containing information about shipment property values
time `time`	Information about the execution time of the request

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 may consist of digits, Latin letters, and underscores
error_description `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
`200040300020`	Insufficient permissions to modify property values
`100`	Required parameters are missing
`201040400006`	Invalid shipment ID
`201040400007`	Shipment not found
`201040400008`	Error saving order
`0`	Other errors (e.g., fatal errors)

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	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
`500`	`PORTAL_DELETED` Portal was deleted	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

Get Shipment Property Value by ID

Update Shipment Property Values sale.shipmentpropertyvalue.modify

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter shipmentParameter shipment

Parameter propertyValuesParameter propertyValues

Code ExamplesCode Examples

Successful ResponseSuccessful Response

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Continue LearningContinue Learning

Method Parameters

Parameter fields

Parameter shipment

Parameter propertyValues

Code Examples

Successful Response

Returned Data

Error Handling

Possible Error Codes

Continue Learning