Get a list of shipment properties sale.shipmentproperty.list

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

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)

JS (TS)

JS (UMD)

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

// 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 ShipmentPropertyListResult = {
          properties: {
            id: number
            active: string
            code: string
            defaultValue: string
            description: string
            inputFieldLocation: string
            isAddress: string
            isAddressFrom: string
            isAddressTo: string
            isEmail: string
            isFiltered: string
            isLocation: string
            isPayer: string
            isPhone: string
            isProfileName: string
            isZip: string
            multiple: string
            name: string
            personTypeId: number
            propsGroupId: number
            required: string
            settings: Record<string, unknown> | unknown[]
            sort: number
            type: string
            userProps: string
            util: string
            xmlId: string
          }[]
        }
        
        try {
          // sale.shipmentproperty.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<ShipmentPropertyListResult>({
            method: 'sale.shipmentproperty.list',
            params: {
              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',
              },
              start: 0,
            },
            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('Shipment properties on this page:', result.properties.length, result.properties)
          }
        } 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 fetchShipmentPropertyList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // sale.shipmentproperty.list returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'sale.shipmentproperty.list',
                params: {
                  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',
                  },
                  start: 0,
                },
                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('Shipment properties on this page:', result.properties.length, result.properties)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', fetchShipmentPropertyList)
        </script>

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

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