Get Fields and Settings of Shipment Property for a Specific Property Type sale.shipmentproperty.getfieldsbytype

Scope: sale

Who can execute the method: administrator

This method retrieves the available fields of shipment properties by property type.

Method Parameters

Required parameters are marked with *

Name `type`	Description
type* `string`	Shipment property type Possible values: `STRING` `Y/N` `NUMBER` `ENUM` `FILE` `DATE` `LOCATION` `ADDRESS`

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"type":"NUMBER"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentproperty.getfieldsbytype

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"type":"NUMBER","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.shipmentproperty.getfieldsbytype

try
        {
        	const response = await $b24.callMethod(
        		"sale.shipmentproperty.getfieldsbytype", {
        			"type": "NUMBER",
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.shipmentproperty.getfieldsbytype',
                    [
                        'type' => 'NUMBER',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting shipment property fields by type: ' . $e->getMessage();
        }

BX24.callMethod(
            "sale.shipmentproperty.getfieldsbytype", {
                "type": "NUMBER",
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.shipmentproperty.getfieldsbytype',
            [
                'type' => 'NUMBER'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Successful Response

HTTP Status: 200

{
           "result": {
              "property": {
                 "active": {
                    "isImmutable": false,
                    "isReadOnly": false,
                    "isRequired": false,
                    "type": "char"
                 },
                 "code": {
                    "isImmutable": false,
                    "isReadOnly": false,
                    "isRequired": false,
                    "type": "string"
                 },
                 "defaultValue": {
                    "isImmutable": false,
                    "isReadOnly": false,
                    "isRequired": false,
                    "type": "string"
                 },
                 "description": {
                    "isImmutable": false,
                    "isReadOnly": false,
                    "isRequired": false,
                    "type": "string"
                 },
                 "id": {
                    "isImmutable": false,
                    "isReadOnly": true,
                    "isRequired": false,
                    "type": "integer"
                 },
                 "isFiltered": {
                    "isImmutable": false,
                    "isReadOnly": false,
                    "isRequired": false,
                    "type": "char"
                 },
                 "multiple": {
                    "isImmutable": false,
                    "isReadOnly": false,
                    "isRequired": false,
                    "type": "char"
                 },
                 "name": {
                    "isImmutable": false,
                    "isReadOnly": false,
                    "isRequired": true,
                    "type": "string"
                 },
                 "personTypeId": {
                    "isImmutable": true,
                    "isReadOnly": false,
                    "isRequired": true,
                    "type": "integer"
                 },
                 "propsGroupId": {
                    "isImmutable": true,
                    "isReadOnly": false,
                    "isRequired": true,
                    "type": "integer"
                 },
                 "required": {
                    "isImmutable": false,
                    "isReadOnly": false,
                    "isRequired": false,
                    "type": "char"
                 },
                 "settings": {
                    "fields": {
                       "max": {
                          "isImmutable": false,
                          "isReadOnly": false,
                          "isRequired": false,
                          "type": "integer"
                       },
                       "min": {
                          "isImmutable": false,
                          "isReadOnly": false,
                          "isRequired": false,
                          "type": "integer"
                       },
                       "step": {
                          "isImmutable": false,
                          "isReadOnly": false,
                          "isRequired": false,
                          "type": "integer"
                       }
                    },
                    "isImmutable": false,
                    "isReadOnly": false,
                    "isRequired": false,
                    "type": "datatype"
                 },
                 "sort": {
                    "isImmutable": false,
                    "isReadOnly": false,
                    "isRequired": false,
                    "type": "integer"
                 },
                 "type": {
                    "isImmutable": true,
                    "isReadOnly": false,
                    "isRequired": true,
                    "type": "string"
                 },
                 "userProps": {
                    "isImmutable": false,
                    "isReadOnly": false,
                    "isRequired": false,
                    "type": "char"
                 },
                 "util": {
                    "isImmutable": false,
                    "isReadOnly": false,
                    "isRequired": false,
                    "type": "char"
                 },
                 "xmlId": {
                    "isImmutable": false,
                    "isReadOnly": false,
                    "isRequired": false,
                    "type": "string"
                 }
              }
           },
           "time": {
              "start": 1712325081.703631,
              "finish": 1712325082.067712,
              "duration": 0.36408114433288574,
              "processing": 0.023890972137451172,
              "date_start": "2024-04-05T16:51:21+02:00",
              "date_finish": "2024-04-05T16:51:22+02:00"
           }
        }

Error Handling

HTTP Status: 400

{
           "error": 0,
           "error_description": "error"
        }

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
`200040300010`	Insufficient permissions to read available shipment property fields
`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

Delete Shipment Property

Overview of Methods

Get Fields and Settings of Shipment Property for a Specific Property Type sale.shipmentproperty.getfieldsbytype

Method ParametersMethod Parameters

Code ExamplesCode Examples

Successful ResponseSuccessful Response

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Continue LearningContinue Learning