Update Shipment Property sale.shipmentproperty.update
Scope:
saleWho can execute the method: administrator
This method updates the shipment property.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Identifier of the shipment property |
|
|
fields* |
Field values for updating the shipment property |
Parameter fields
General parameters applicable to shipment properties of any type:
Required parameters are marked with *
|
Name |
Description |
|
name* |
Name of the shipment property |
|
code |
Symbolic code of the shipment property |
|
active |
Indicator of whether the shipment property is active.
If not provided, the default value is |
|
util |
Indicator of whether the shipment property is a system property. System properties are not displayed in the public part.
If not provided, the default value is |
|
userProps |
Indicator of whether the shipment property is included in the customer profile.
If not provided, the default value is |
|
isFiltered |
Indicator of whether the shipment property is available in the filter on the shipment list page.
If not provided, the default value is |
|
sort |
Sorting |
|
description |
Description of the shipment property |
|
required |
Indicator of whether filling in the shipment property value is mandatory.
If not provided, the default value is |
|
multiple |
Indicator of whether the order property is multiple. For multiple properties, it is possible to specify several values.
If not provided, the default value is |
|
xmlId |
External identifier of the shipment property |
|
defaultValue |
Default value of the shipment property. |
|
settings |
An object in the format {"field_1": "value_1", ... "field_N": "value_N"} for passing additional settings for the shipment property. The list of supported keys for this object depends on the property type. For some property types (e.g., Y/N), additional properties are not provided. The description of the settings parameter for different property types is provided in the description of the method |
Parameters applicable to order properties of type STRING
|
Name |
Description |
|
isProfileName |
Indicator of whether the value of this shipment property should be used as the user's profile name.
If not provided, the default value is |
|
isPayer |
Indicator of whether the value of this shipment property should be used as the payer's name.
If not provided, the default value is |
|
isEmail |
Indicator of whether the value of this shipment property should be used as an e-mail (e.g., when registering a new user during order placement).
If not provided, the default value is |
|
isPhone |
Indicator of whether the value of this shipment property should be used as a phone number.
If not provided, the default value is |
|
isZip |
Indicator of whether the value of this shipment property should be used as a postal code.
If not provided, the default value is |
|
isAddress |
Indicator of whether the value of this shipment property should be used as an address.
If not provided, the default value is |
Parameters applicable to shipment properties of type LOCATION
|
Name |
Description |
|
isLocation |
Indicator of whether the value of this shipment property should be used as the customer's location for calculating delivery costs.
If not provided, the default value is |
|
isLocation4tax |
Indicator of whether the value of this shipment property should be used as the customer's location for determining tax rates.
If not provided, the default value is |
|
inputFieldLocation |
Deprecated field. Not used |
Parameters applicable to shipment properties of type ADDRESS
|
Name |
Description |
|
isAddressFrom |
Indicator of whether the value of this shipment property should be used as the customer's address from which the order needs to be picked up for calculating delivery costs.
If not provided, the default value is |
|
isAddressTo |
Indicator of whether the value of this shipment property should be used as the customer's address to which the order needs to be delivered for calculating delivery costs.
If not provided, the default value is |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":93,"fields":{"personTypeId":3,"propsGroupId":6,"name":"Phone (for contacting the courier)","type":"STRING","code":"PHONE","active":"Y","util":"N","userProps":"Y","isFiltered":"N","sort":500,"description":"property description","required":"Y","multiple":"N","settings":{"multiline":"Y","maxlength":100},"xmlId":"","defaultValue":"","isProfileName":"Y","isPayer":"Y","isEmail":"N","isPhone":"N","isZip":"N","isAddress":"N"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.shipmentproperty.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":93,"fields":{"personTypeId":3,"propsGroupId":6,"name":"Phone (for contacting the courier)","type":"STRING","code":"PHONE","active":"Y","util":"N","userProps":"Y","isFiltered":"N","sort":500,"description":"property description","required":"Y","multiple":"N","settings":{"multiline":"Y","maxlength":100},"xmlId":"","defaultValue":"","isProfileName":"Y","isPayer":"Y","isEmail":"N","isPhone":"N","isZip":"N","isAddress":"N"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentproperty.update
try
{
const response = await $b24.callMethod(
'sale.shipmentproperty.update', {
id: 93,
fields: {
personTypeId: 3,
propsGroupId: 6,
name: 'Phone (for contacting the courier)',
type: 'STRING',
code: 'PHONE',
active: 'Y',
util: 'N',
userProps: 'Y',
isFiltered: 'N',
sort: 500,
description: 'property description',
required: 'Y',
multiple: 'N',
settings: {
multiline: 'Y',
maxlength: 100
},
xmlId: '',
defaultValue: '',
isProfileName: 'Y',
isPayer: 'Y',
isEmail: 'N',
isPhone: 'N',
isZip: 'N',
isAddress: 'N',
}
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'sale.shipmentproperty.update',
[
'id' => 93,
'fields' => [
'personTypeId' => 3,
'propsGroupId' => 6,
'name' => 'Phone (for contacting the courier)',
'type' => 'STRING',
'code' => 'PHONE',
'active' => 'Y',
'util' => 'N',
'userProps' => 'Y',
'isFiltered' => 'N',
'sort' => 500,
'description' => 'property description',
'required' => 'Y',
'multiple' => 'N',
'settings' => [
'multiline' => 'Y',
'maxlength' => 100
],
'xmlId' => '',
'defaultValue' => '',
'isProfileName' => 'Y',
'isPayer' => 'Y',
'isEmail' => 'N',
'isPhone' => 'N',
'isZip' => 'N',
'isAddress' => 'N',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating shipment property: ' . $e->getMessage();
}
BX24.callMethod(
'sale.shipmentproperty.update', {
id: 93,
fields: {
personTypeId: 3,
propsGroupId: 6,
name: 'Phone (for contacting the courier)',
type: 'STRING',
code: 'PHONE',
active: 'Y',
util: 'N',
userProps: 'Y',
isFiltered: 'N',
sort: 500,
description: 'property description',
required: 'Y',
multiple: 'N',
settings: {
multiline: 'Y',
maxlength: 100
},
xmlId: '',
defaultValue: '',
isProfileName: 'Y',
isPayer: 'Y',
isEmail: 'N',
isPhone: 'N',
isZip: 'N',
isAddress: 'N',
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.shipmentproperty.update',
[
'id' => 93,
'fields' => [
'personTypeId' => 3,
'propsGroupId' => 6,
'name' => 'Phone (for contacting the courier)',
'type' => 'STRING',
'code' => 'PHONE',
'active' => 'Y',
'util' => 'N',
'userProps' => 'Y',
'isFiltered' => 'N',
'sort' => 500,
'description' => 'property description',
'required' => 'Y',
'multiple' => 'N',
'settings' => [
'multiline' => 'Y',
'maxlength' => 100
],
'xmlId' => '',
'defaultValue' => '',
'isProfileName' => 'Y',
'isPayer' => 'Y',
'isEmail' => 'N',
'isPhone' => 'N',
'isZip' => 'N',
'isAddress' => 'N',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Successful Response
HTTP status: 200
{
"result":{
"property":{
"active":"Y",
"code":"PHONE",
"defaultValue":"",
"description":"property description",
"id":96,
"inputFieldLocation":"0",
"isAddress":"N",
"isAddressFrom":"N",
"isAddressTo":"N",
"isEmail":"N",
"isFiltered":"N",
"isLocation":"N",
"isLocation4tax":"N",
"isPayer":"Y",
"isPhone":"N",
"isProfileName":"Y",
"isZip":"N",
"multiple":"N",
"name":"Phone (for contacting the courier)",
"personTypeId":3,
"propsGroupId":6,
"required":"Y",
"settings":{
"maxlength":"100",
"multiline":"Y"
},
"sort":500,
"type":"STRING",
"userProps":"Y",
"util":"N",
"xmlId":""
}
},
"time":{
"start":1712818736.235335,
"finish":1712818736.611224,
"duration":0.3758888244628906,
"processing":0.18679594993591309,
"date_start":"2024-04-11T09:58:56+02:00",
"date_finish":"2024-04-11T09:58:56+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
property |
Object with information about the updated shipment property |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error":200840400001,
"error_description":"property does not exist"
}
|
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 |
|
|
The updated shipment property was not found |
|
|
Internal error updating the property |
|
|
Error occurs when trying to update a shipment property with the |
|
|
Error occurs when trying to update a shipment property with the |
|
|
Error occurs when trying to update a shipment property of type |
|
|
Error occurs when trying to update a shipment property of type |
|
|
Error occurs when trying to update a shipment property of type |
|
|
Error occurs when trying to update a shipment property of type |
|
|
Error occurs when trying to update a shipment property of type |
|
|
Error occurs when trying to update a shipment property of type |
|
|
Insufficient permissions to update the shipment property |
|
|
The |
|
|
The |
|
|
Required fields are not provided |
|
|
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 allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users |
|
|
|
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
- Shipping Properties in the Online Store: Overview of Methods
- Add Shipment Property sale.shipmentproperty.add
- Get Shipment Property sale.shipmentproperty.get
- Get a list of shipment properties sale.shipmentproperty.list
- Delete Shipment Property sale.shipmentproperty.delete
- Get Fields and Settings of Shipment Property for a Specific Property Type sale.shipmentproperty.getfieldsbytype