Get a list of shipment properties sale.shipmentproperty.list

Scope: sale

Who can execute the method: administrator

The method retrieves a list of shipment properties.

Method Parameters

Name `type`	Description
select `array`	An array containing the list of fields to select (see the fields of the sale_shipment_property object). If not provided or an empty array is passed, all available property fields will be selected.
filter `object`	An object for filtering the selected shipment properties in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Possible values for `field` correspond to the fields of the sale_shipment_property object. An additional prefix can be assigned to the key to clarify the filter behavior. Possible prefix values: `=` — equals (works with arrays as well) `%` — LIKE, substring search. The % symbol in the filter value does not need to be passed. The search looks for the substring in any position of the string. `>` — greater than `<` — less than `!=` — not equal `!%` — NOT LIKE, substring search. The % symbol in the filter value does not need to be passed. The search goes from both sides. `>=` — greater than or equal to `<=` — less than or equal to `=%` — LIKE, substring search. The % symbol needs to be passed in the value. Examples: `"mol%"` — searching for values starting with "mol" `"%mol"` — searching for values ending with "mol" `"%mol%"` — searching for values where "mol" can be in any position `%=` — LIKE (see description above) `!=%` — NOT LIKE, substring search. The % symbol needs to be passed in the value. Examples: `"mol%"` — searching for values not starting with "mol" `"%mol"` — searching for values not ending with "mol" `"%mol%"` — searching for values where the substring "mol" is not present in any position `!%=` — NOT LIKE (see description above)
order `object`	An object for sorting the selected shipment properties in the format `{"field_1": "order_1", ... "field_N": "order_N"}`. Possible values for `field` correspond to the fields of the sale_shipment_property object. Possible values for `order`: `asc` — in ascending order `desc` — in descending order
start `integer`	This parameter is used to manage pagination. The page size of results is always static: 50 records. To select the second page of results, you need to pass the value `50`. To select the third page of results, the value is `100`, and so on. The formula for calculating the `start` parameter value: `start = (N-1) * 50`, where `N` — the desired page number

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 '{"select":["id","active","code","defaultValue","description","inputFieldLocation","isAddress","isAddressFrom","isAddressTo","isEmail","isFiltered","isLocation","isLocation4tax","isPayer","isPhone","isProfileName","isZip","multiple","name","personTypeId","propsGroupId","required","settings","sort","type","userProps","util","xmlId"],"filter":{"@type":"STRING","%code":"EMAIL"},"order":{"id":"desc"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentproperty.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","active","code","defaultValue","description","inputFieldLocation","isAddress","isAddressFrom","isAddressTo","isEmail","isFiltered","isLocation","isLocation4tax","isPayer","isPhone","isProfileName","isZip","multiple","name","personTypeId","propsGroupId","required","settings","sort","type","userProps","util","xmlId"],"filter":{"@type":"STRING","%code":"EMAIL"},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.shipmentproperty.list

// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            'sale.shipmentproperty.list',
            {
              "select": [
                "id",
                "active",
                "code",
                "defaultValue",
                "description",
                "inputFieldLocation",
                "isAddress",
                "isAddressFrom",
                "isAddressTo",
                "isEmail",
                "isFiltered",
                "isLocation",
                "isLocation4tax",
                "isPayer",
                "isPhone",
                "isProfileName",
                "isZip",
                "multiple",
                "name",
                "personTypeId",
                "propsGroupId",
                "required",
                "settings",
                "sort",
                "type",
                "userProps",
                "util",
                "xmlId",
              ],
              "filter": {
                "@type": "STRING",
                "%code": "EMAIL",
              },
              "order": {
                "id": "desc",
              }
            },
            (progress) => { console.log('Progress:', progress) }
          );
          const items = response.getData() || [];
          for (const entity of items) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('sale.shipmentproperty.list', {
            "select": [
              "id",
              "active",
              "code",
              "defaultValue",
              "description",
              "inputFieldLocation",
              "isAddress",
              "isAddressFrom",
              "isAddressTo",
              "isEmail",
              "isFiltered",
              "isLocation",
              "isLocation4tax",
              "isPayer",
              "isPhone",
              "isProfileName",
              "isZip",
              "multiple",
              "name",
              "personTypeId",
              "propsGroupId",
              "required",
              "settings",
              "sort",
              "type",
              "userProps",
              "util",
              "xmlId",
            ],
            "filter": {
              "@type": "STRING",
              "%code": "EMAIL",
            },
            "order": {
              "id": "desc",
            }
          }, 'id');
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity); }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('sale.shipmentproperty.list', {
            "select": [
              "id",
              "active",
              "code",
              "defaultValue",
              "description",
              "inputFieldLocation",
              "isAddress",
              "isAddressFrom",
              "isAddressTo",
              "isEmail",
              "isFiltered",
              "isLocation",
              "isLocation4tax",
              "isPayer",
              "isPhone",
              "isProfileName",
              "isZip",
              "multiple",
              "name",
              "personTypeId",
              "propsGroupId",
              "required",
              "settings",
              "sort",
              "type",
              "userProps",
              "util",
              "xmlId",
            ],
            "filter": {
              "@type": "STRING",
              "%code": "EMAIL",
            },
            "order": {
              "id": "desc",
            }
          }, 0);
          const result = response.getData().result || [];
          for (const entity of result) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.shipmentproperty.list',
                    [
                        'select' => [
                            'id',
                            'active',
                            'code',
                            'defaultValue',
                            'description',
                            'inputFieldLocation',
                            'isAddress',
                            'isAddressFrom',
                            'isAddressTo',
                            'isEmail',
                            'isFiltered',
                            'isLocation',
                            'isLocation4tax',
                            'isPayer',
                            'isPhone',
                            'isProfileName',
                            'isZip',
                            'multiple',
                            'name',
                            'personTypeId',
                            'propsGroupId',
                            'required',
                            'settings',
                            'sort',
                            'type',
                            'userProps',
                            'util',
                            'xmlId',
                        ],
                        'filter' => [
                            '@type' => 'STRING',
                            '%code' => 'EMAIL',
                        ],
                        'order' => [
                            'id' => 'desc',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching shipment properties: ' . $e->getMessage();
        }

BX24.callMethod(
            "sale.shipmentproperty.list", {
                "select": [
                    "id",
                    "active",
                    "code",
                    "defaultValue",
                    "description",
                    "inputFieldLocation",
                    "isAddress",
                    "isAddressFrom",
                    "isAddressTo",
                    "isEmail",
                    "isFiltered",
                    "isLocation",
                    "isLocation4tax",
                    "isPayer",
                    "isPhone",
                    "isProfileName",
                    "isZip",
                    "multiple",
                    "name",
                    "personTypeId",
                    "propsGroupId",
                    "required",
                    "settings",
                    "sort",
                    "type",
                    "userProps",
                    "util",
                    "xmlId",
                ],
                "filter": {
                    "@type": "STRING",
                    "%code": "EMAIL",
                },
                "order": {
                    "id": "desc",
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.shipmentproperty.list',
            [
                'select' => [
                    "id",
                    "active",
                    "code",
                    "defaultValue",
                    "description",
                    "inputFieldLocation",
                    "isAddress",
                    "isAddressFrom",
                    "isAddressTo",
                    "isEmail",
                    "isFiltered",
                    "isLocation",
                    "isLocation4tax",
                    "isPayer",
                    "isPhone",
                    "isProfileName",
                    "isZip",
                    "multiple",
                    "name",
                    "personTypeId",
                    "propsGroupId",
                    "required",
                    "settings",
                    "sort",
                    "type",
                    "userProps",
                    "util",
                    "xmlId",
                ],
                'filter' => [
                    "@type" => "STRING",
                    "%code" => "EMAIL",
                ],
                'order' => [
                    "id" => "desc",
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Successful Response

HTTP status: 200

{
           "result": {
              "properties": [
                 {
                    "active": "Y",
                    "code": "EMAIL",
                    "defaultValue": "",
                    "description": "",
                    "id": 47,
                    "inputFieldLocation": "0",
                    "isAddress": "N",
                    "isAddressFrom": "N",
                    "isAddressTo": "N",
                    "isEmail": "Y",
                    "isFiltered": "Y",
                    "isLocation": "N",
                    "isPayer": "N",
                    "isPhone": "N",
                    "isProfileName": "N",
                    "isZip": "N",
                    "multiple": "N",
                    "name": "E-Mail",
                    "personTypeId": 3,
                    "propsGroupId": 5,
                    "required": "Y",
                    "settings": [],
                    "sort": 300,
                    "type": "STRING",
                    "userProps": "Y",
                    "util": "N",
                    "xmlId": ""
                 },
                 {
                    "active": "Y",
                    "code": "EMAIL",
                    "defaultValue": "",
                    "description": "",
                    "id": 33,
                    "inputFieldLocation": "0",
                    "isAddress": "N",
                    "isAddressFrom": "N",
                    "isAddressTo": "N",
                    "isEmail": "Y",
                    "isFiltered": "N",
                    "isLocation": "N",
                    "isPayer": "N",
                    "isPhone": "N",
                    "isProfileName": "N",
                    "isZip": "N",
                    "multiple": "N",
                    "name": "E-Mail",
                    "personTypeId": 4,
                    "propsGroupId": 8,
                    "required": "Y",
                    "settings": {
                       "size": 40
                    },
                    "sort": 250,
                    "type": "STRING",
                    "userProps": "Y",
                    "util": "N",
                    "xmlId": ""
                 },
                 {
                    "active": "Y",
                    "code": "EMAIL",
                    "defaultValue": "",
                    "description": "",
                    "id": 21,
                    "inputFieldLocation": "0",
                    "isAddress": "N",
                    "isAddressFrom": "N",
                    "isAddressTo": "N",
                    "isEmail": "Y",
                    "isFiltered": "Y",
                    "isLocation": "N",
                    "isPayer": "N",
                    "isPhone": "N",
                    "isProfileName": "N",
                    "isZip": "N",
                    "multiple": "N",
                    "name": "E-Mail",
                    "personTypeId": 3,
                    "propsGroupId": 5,
                    "required": "Y",
                    "settings": {
                       "size": 40
                    },
                    "sort": 110,
                    "type": "STRING",
                    "userProps": "Y",
                    "util": "N",
                    "xmlId": ""
                 }
              ]
           },
           "total": 3,
           "time": {
              "start": 1712818881.719586,
              "finish": 1712818881.960037,
              "duration": 0.24045109748840332,
              "processing": 0.06902408599853516,
              "date_start": "2024-04-11T10:01:21+02:00",
              "date_finish": "2024-04-11T10:01:21+02:00"
           }
        }

Returned Data

Name `type`	Description
result `object`	The root element of the response
properties `sale_shipment_property[]`	An array of objects with information about the selected properties
total `integer`	The total number of records found
time `time`	Information about the execution time of the request

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 rights to read shipment properties
`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

Get Shipment Property Value

Delete Shipment Property

Get a list of shipment properties sale.shipmentproperty.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Successful ResponseSuccessful Response

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Continue LearningContinue Learning