Add Shipment Property 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
        

// 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 ShipmentPropertyAddResult = {
          property: {
            id: number
            active: string
            code: string
            defaultValue: string
            description: string
            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<ShipmentPropertyAddResult>({
            method: 'sale.shipmentproperty.add',
            params: {
              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('Added shipment property id:', result.property.id, result.property)
          }
        } 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 addShipmentProperty() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.shipmentproperty.add',
                params: {
                  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('Added shipment property id:', result.property.id, result.property)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addShipmentProperty)
        </script>
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        fields = {
            "personTypeId": 3,
            "propsGroupId": 6,
            "name": "Phone (to contact 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",
        }
        
        try:
            bitrix_response = client.sale.shipmentproperty.add(
                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.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>';
        

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sale.shipmentproperty.add", b24.Params{
        	"fields": b24.Params{
        		"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": b24.Params{
        			"multiline": "Y",
        			"maxlength": 100,
        		},
        		"xmlId":         "",
        		"defaultValue":  "",
        		"isProfileName": "Y",
        		"isPayer":       "Y",
        		"isEmail":       "N",
        		"isPhone":       "N",
        		"isZip":         "N",
        		"isAddress":     "N",
        	},
        })
        if err != nil {
        	return fmt.Errorf("sale.shipmentproperty.add: %w", err)
        }
        
        // The method wraps the response in an object with the "property" key.
        raw, ok := b24.Unwrap(res.Result, "property")
        if !ok {
        	return fmt.Errorf("no property key in the response")
        }
        
        var item struct {
        	Active             string `json:"active"`
        	Code               string `json:"code"`
        	DefaultValue       string `json:"defaultValue"`
        	Description        string `json:"description"`
        	ID                 b24.ID `json:"id"`
        	InputFieldLocation string `json:"inputFieldLocation"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.Active, item.Code)