Add Shipment Property sale.shipmentproperty.add

Scope: sale

Who can execute the method: administrator

This method adds a shipment property.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Field values for creating a shipment property

Parameter fields

Common parameters applicable to shipment properties of any type:

Required parameters are marked with *

Name `type`	Description
personTypeId* `sale_person_type.id`	Identifier of the payer type
propsGroupId* `sale_order_property_group.id`	Identifier of the property group
name* `string`	Name of the shipment property
type* `string`	Type of the shipment property. Possible values: `STRING` `Y/N` `NUMBER` `ENUM` `FILE` `DATE` `LOCATION` `ADDRESS`
code `string`	Symbolic code of the shipment property
active `string`	Indicator of the activity status of the shipment property. Possible values: `Y` — yes `N` — no If not provided, the default value is `Y` (the property is added as active)
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 the value of the shipment property is required. Possible values: `Y` — yes `N` — no If not provided, the default value is `N`
multiple `string`	Indicator of whether the shipment 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 below

Parameters applicable to shipment properties of type STRING

Name `type`	Description
isProfileName `string`	Indicator of whether the value of this shipment property should be used as the user 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

Parameter settings

Parameters applicable to shipment properties of type STRING

Name `type`	Description
minlength `integer`	Minimum allowable length (number of characters) of the shipment property value
maxlength `integer`	Maximum allowable length (number of characters) of the shipment property value
pattern `string`	Regular expression for validating the shipment property value. Examples: Regular expression for validating a phone number `^((8\\|\+1)[\- ]?)?($?\d{3}$?[\- ]?)?[\d\- ]{7,10}$` Regular expression for validating the date format DD/MM/YYYY: `^(0?[1-9]\|[12][0-9]\|3[01])[\/\-](0?[1-9]\|1[012])[\/\-]\d{4}$`
multiline `string`	Indicator of whether to display a multiline input field for the shipment property value. Possible values: `Y` — yes `N` — no If not provided, the default value is `N`
cols `integer`	Deprecated parameter. Not used
rows `integer`	Deprecated parameter. Not used
size `integer`	Deprecated parameter. Not used

Parameters applicable to shipment properties of type NUMBER

Name `type`	Description
min `integer`	Minimum allowable value for this shipment property
max `integer`	Maximum allowable value for this shipment property
step `integer`	Step for changing the value. Used in some user interfaces for convenience in changing the shipment property value

Parameters applicable to shipment properties of type ENUM

Name
type

Description

multielement
string

Indicator of whether to display the shipment property as a list of checkboxes.
Value is used in some user interfaces.
Possible values:

Y — yes
N — no

If not provided, the default value is N

size
integer

Number of displayed values of the shipment property. Value is used in some user interfaces

Parameters applicable to shipment properties of type FILE

Name `type`	Description
maxsize `integer`	Maximum allowable size of the uploaded file in bytes
accept `string`	List of file extensions that are allowed to be uploaded as the value of this shipment property. Example: png, doc, zip

Parameters applicable to shipment properties of type DATE

Name
type

Description

time
string

Indicator of whether to add the option to select time when working with the value of this shipment property. Value is used in some user interfaces.
Possible values:

Y — yes
N — no

If not provided, the default value is N

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"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.add

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"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.add

try
        {
        	const response = await $b24.callMethod(
        		'sale.shipmentproperty.add', {
        			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.add',
                    [
                        '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 adding shipment property: ' . $e->getMessage();
        }

BX24.callMethod(
        'sale.shipmentproperty.add', {
            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.add',
            [
                '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":1712818563.754118,
              "finish":1712818566.840385,
              "duration":3.0862669944763184,
              "processing":1.0286660194396973,
              "date_start":"2024-04-11T09:56:03+02:00",
              "date_finish":"2024-04-11T09:56:06+02:00"
           }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
property `sale_shipment_property`	Object containing information about the added shipment property
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
           "error":0,
           "error_description":"Required fields: propsGroupId"
        }

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
`200850000005`	An empty value is specified for the payer type
`200850000006`	Internal error adding property
`200850000009`	Error occurs when trying to create 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 create a shipment property with the `multiple` parameter set to `Y`, if the `isFiltered` parameter is not equal to `N`. Filtering by multiple shipment properties is not supported
`200850000011`	Error occurs when trying to create a shipment property of type `LOCATION` with the `isLocation` parameter set to `Y`, if the `multiple` parameter is not specified. Multiplicity is not supported for shipment properties marked with the `isLocation` indicator
`200850000012`	Error occurs when trying to create a shipment property of type `LOCATION` with the `isLocation` parameter set to `Y`, if the `multiple` parameter is not equal to `N`. Multiplicity is not supported for shipment properties marked with the `isLocation` indicator
`200850000013`	Error occurs when trying to create a shipment property of type `LOCATION` with the `isLocation4tax` parameter set to `Y`, if the `multiple` parameter is not specified. Multiplicity is not supported for shipment properties marked with the `isLocation4tax` indicator
`200850000014`	Error occurs when trying to create a shipment property of type `LOCATION` with the `isLocation4tax` parameter set to `Y`, if the `multiple` parameter is not equal to `N`. Multiplicity is not supported for shipment properties marked with the `isLocation4tax` indicator
`200850000015`	Error occurs when trying to create a shipment property of type `STRING` with the `isProfileName` parameter set to `Y`, if the `required` parameter is not specified. Profile name is required and cannot be empty
`200850000016`	Error occurs when trying to create a shipment property of type `STRING` with the `isProfileName` parameter set to `Y`, if the `required` parameter is not equal to `Y`. Profile name is required and cannot be empty
`200040300020`	Insufficient permissions to add shipment property
`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 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

Update Shipment Property

Add Shipment Property sale.shipmentproperty.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter settingsParameter settings

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 settings

Code Examples

Successful Response

Returned Data

Error Handling

Possible Error Codes

Continue Learning