Update Shipment Property Values sale.shipmentpropertyvalue.modify
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
saleWho can execute the method: administrator
This method updates the shipment property values.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
The root element that carries the request parameters |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
shipment* |
The object containing the shipment ID and shipment property values (detailed description provided below) |
Parameter shipment
Required parameters are marked with *
|
Name |
Description |
|
Shipment ID |
|
|
propertyValues* |
An array of objects containing the shipment property ID and property value (detailed description provided below) |
Parameter propertyValues
Required parameters are marked with *
|
Name |
Description |
|
shipmentPropsId* |
Shipment property ID |
|
value* |
Property value |
Code Examples
How to Use Examples in Documentation
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
// 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 ModifyResult = {
propertyValues: {
code: string | null
id: number
name: string
value: string
}[]
}
try {
const response = await $b24.actions.v2.call.make<ModifyResult>({
method: 'sale.shipmentpropertyvalue.modify',
params: {
fields: {
shipment: {
id: 4120,
propertyValues: [
{
shipmentPropsId: 105,
value: 'Comments value',
},
{
shipmentPropsId: 106,
value: 'Description value',
},
],
},
},
},
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 modifyShipmentPropertyValues() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.shipmentpropertyvalue.modify',
params: {
fields: {
shipment: {
id: 4120,
propertyValues: [
{
shipmentPropsId: 105,
value: 'Comments value',
},
{
shipmentPropsId: 106,
value: 'Description value',
},
],
},
},
},
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', modifyShipmentPropertyValues)
</script>
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 |
Description |
|
result |
The root element of the response |
|
propertyValues |
An array of objects containing information about shipment property values |
|
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 |
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 modify property values |
|
|
Required parameters are missing |
|
|
Invalid shipment ID |
|
|
Shipment not found |
|
|
Error saving order |
|
|
Other errors (e.g., fatal errors) |
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 permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |