Update Shipment Property sale.shipmentproperty.update

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: sale

Who can execute the method: administrator

This method updates the shipment property.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
sale_shipment_property.id

Identifier of the shipment property

fields*
object

Field values for updating the shipment property

Parameter fields

General parameters applicable to shipment properties of any type:

Required parameters are marked with *

Name
type

Description

name*
string

Name of the shipment property

code
string

Symbolic code of the shipment property

active
string

Indicator of whether the shipment property is active.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is Y

util
string

Indicator of whether the shipment property is a system property. System properties are not displayed in the public part.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

userProps
string

Indicator of whether the shipment property is included in the customer profile.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isFiltered
string

Indicator of whether the shipment property is available in the filter on the shipment list page.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

sort
integer

Sorting

description
string

Description of the shipment property

required
string

Indicator of whether filling in the shipment property value is mandatory.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

multiple
string

Indicator of whether the order property is multiple. For multiple properties, it is possible to specify several values.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

xmlId
string

External identifier of the shipment property

defaultValue
any

Default value of the shipment property.
For multiple shipment properties (multiple), an array of values is supported

settings
object

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 sale.shipmentproperty.add

Parameters applicable to order properties of type STRING

Name
type

Description

isProfileName
string

Indicator of whether the value of this shipment property should be used as the user's profile name.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isPayer
string

Indicator of whether the value of this shipment property should be used as the payer's name.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isEmail
string

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).
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isPhone
string

Indicator of whether the value of this shipment property should be used as a phone number.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isZip
string

Indicator of whether the value of this shipment property should be used as a postal code.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isAddress
string

Indicator of whether the value of this shipment property should be used as an address.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

Parameters applicable to shipment properties of type LOCATION

Name
type

Description

isLocation
string

Indicator of whether the value of this shipment property should be used as the customer's location for calculating delivery costs.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isLocation4tax
string

Indicator of whether the value of this shipment property should be used as the customer's location for determining tax rates.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

inputFieldLocation
string

Deprecated field. Not used

Parameters applicable to shipment properties of type ADDRESS

Name
type

Description

isAddressFrom
string

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.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isAddressTo
string

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.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

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
        
// 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 ShipmentPropertyUpdateResult = {
          property: {
            active: string
            code: string
            defaultValue: string
            description: string
            id: number
            inputFieldLocation: string
            isAddress: string
            isAddressFrom: string
            isAddressTo: string
            isEmail: string
            isFiltered: string
            isLocation: string
            isLocation4tax: string
            isPayer: string
            isPhone: string
            isProfileName: string
            isZip: string
            multiple: string
            name: string
            personTypeId: number
            propsGroupId: number
            required: string
            settings: Record<string, string>
            sort: number
            type: string
            userProps: string
            util: string
            xmlId: string
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<ShipmentPropertyUpdateResult>({
            method: 'sale.shipmentproperty.update',
            params: {
              id: 93,
              fields: {
                personTypeId: 3,
                propsGroupId: 6,
                name: 'Phone (for courier contact)',
                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',
              },
            },
            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('Updated property id:', result.property.id, 'name:', result.property.name)
          }
        } 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 updateShipmentProperty() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.shipmentproperty.update',
                params: {
                  id: 93,
                  fields: {
                    personTypeId: 3,
                    propsGroupId: 6,
                    name: 'Phone (for courier contact)',
                    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',
                  },
                },
                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('Updated property id:', result.property.id, 'name:', result.property.name)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateShipmentProperty)
        </script>
        
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
type

Description

result
object

Root element of the response

property
sale_shipment_property

Object with information about the updated shipment property

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
           "error":200840400001,
           "error_description":"property does not exist"
        }

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

200840400001

The updated shipment property was not found

200850000003

Internal error updating the property

200850000009

Error occurs when trying to update a shipment property with the multiple parameter set to Y, if the isFiltered parameter is not provided.
Filtering by multiple shipment properties is not supported

200850000010

Error occurs when trying to update a shipment property with the multiple parameter set to Y, if the isFiltered parameter value is not N.
Filtering by multiple shipment properties is not supported

200850000011

Error occurs when trying to update a shipment property of type LOCATION with the isLocation parameter set to Y, if the multiple parameter value is not specified.
Multiplicity is not supported for shipment properties marked with the isLocation indicator

200850000012

Error occurs when trying to update a shipment property of type LOCATION with the isLocation parameter set to Y, if the multiple parameter value is not N.
Multiplicity is not supported for shipment properties marked with the isLocation indicator

200850000013

Error occurs when trying to update a shipment property of type LOCATION with the isLocation4tax parameter set to Y, if the multiple parameter value is not specified.
Multiplicity is not supported for shipment properties marked with the isLocation4tax indicator

200850000014

Error occurs when trying to update a shipment property of type LOCATION with the isLocation4tax parameter set to Y, if the multiple parameter value is not N.
Multiplicity is not supported for shipment properties marked with the isLocation4tax indicator

200850000015

Error occurs when trying to update a shipment property of type STRING with the isProfileName parameter set to Y, if the required parameter value is not specified.
Profile name is mandatory and cannot be empty

200850000016

Error occurs when trying to update a shipment property of type STRING with the isProfileName parameter set to Y, if the required parameter value is not Y.
Profile name is mandatory and cannot be empty

200040300020

Insufficient permissions to update the shipment property

100

The id parameter is not specified

100

The fields parameter is not specified or is empty

0

Required fields are not provided

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 permitted for calls 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 HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only

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 "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
Add Shipment Property
Next
Get Shipment Property Value