Получить свойство заказа sale.property.get

Scope: sale

Кто может выполнять метод: администратор

Метод получает свойство заказа.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
id* `sale_order_property.id`	Идентификатор свойства заказа

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":22}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.property.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":22,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.property.get

try
        {
        	const response = await $b24.callMethod(
        		"sale.property.get", {
        			"id": 22
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.property.get',
                    [
                        'id' => 22
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Info: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting sale property: ' . $e->getMessage();
        }

BX24.callMethod(
            "sale.property.get", {
                "id": 22
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.property.get',
            [
                'id' => 22
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Ответ в случае успеха

HTTP-статус: 200

{
            "result": {
                "property": {
                    "active": "Y",
                    "code": "PHONE",
                    "defaultValue": "",
                    "description": "",
                    "id": 22,
                    "inputFieldLocation": "0",
                    "isAddress": "N",
                    "isAddressFrom": "N",
                    "isAddressTo": "N",
                    "isEmail": "N",
                    "isFiltered": "N",
                    "isLocation": "N",
                    "isLocation4tax": "N",
                    "isPayer": "N",
                    "isPhone": "Y",
                    "isProfileName": "N",
                    "isZip": "N",
                    "multiple": "N",
                    "name": "Телефон",
                    "personTypeId": 3,
                    "propsGroupId": 5,
                    "required": "Y",
                    "settings": [],
                    "sort": 120,
                    "type": "STRING",
                    "userProps": "Y",
                    "util": "N",
                    "xmlId": ""
                }
            },
            "time": {
                "start": 1712818820.026505,
                "finish": 1712818820.232912,
                "duration": 0.2064070701599121,
                "processing": 0.018364906311035156,
                "date_start": "2024-04-11T10:00:20+03:00",
                "date_finish": "2024-04-11T10:00:20+03:00"
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `object`	Корневой элемент ответа
property `sale_order_property`	Информация о свойстве заказа
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
           "error":200840400001,
           "error_description":"property is not exists"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание
`200840400001`	Свойство заказа не найдено
`200040300010`	Недостаточно прав для чтения свойства заказа
`100`	Не указан параметр `id`
`0`	Другие ошибки (например, фатальные ошибки)

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Обновить свойство заказа

Получить список свойств заказа

Получить свойство заказа sale.property.get

Параметры методаПараметры метода

Примеры кодаПримеры кода

Ответ в случае успехаОтвет в случае успеха

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Продолжите изучениеПродолжите изучение