Update Shipment Property Values sale.shipmentpropertyvalue.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:
saleWho can execute the method: administrator
The method sale.shipmentpropertyvalue.modify 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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"shipment": {
"id": 4120,
"propertyValues": [
{
"shipmentPropsId": 105,
"value": "Comments value",
},
{
"shipmentPropsId": 106,
"value": "Description value",
},
],
},
}
try:
bitrix_response = client.sale.shipmentpropertyvalue.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.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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "sale.shipmentpropertyvalue.modify", b24.Params{
"fields": b24.Params{
"shipment": b24.Params{
"id": 4120,
"propertyValues": []b24.Params{
{
"shipmentPropsId": 105,
"value": "Comments value",
},
{
"shipmentPropsId": 106,
"value": "Description value",
},
},
},
},
})
if err != nil {
return fmt.Errorf("sale.shipmentpropertyvalue.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 {
ID b24.ID `json:"id"`
Name string `json:"name"`
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.ID)
}
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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
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: 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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |