Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Получить свойство отгрузки sale.shipmentproperty.get». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

Получить свойство отгрузки sale.shipmentproperty.get

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

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

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

Примеры кода

• cURL (Webhook)

    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_webbhook_here**/sale.shipmentproperty.get

• cURL (OAuth)

    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.shipmentproperty.get

• JS

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

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'sale.shipmentproperty.get',
                [
                    'id' => 22,
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        // Нужная вам логика обработки данных
        processData($result);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error getting shipment property: ' . $e->getMessage();
    }

• BX24.js

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

• PHP CRest

    require_once('crest.php');

    $result = CRest::call(
        'sale.shipmentproperty.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"
    }
}

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

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

HTTP-статус: 400

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

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

• [](./index)
• [](./sale-shipment-property-add)
• [](./sale-shipment-property-update)
• [](./sale-shipment-property-list)
• [](./sale-shipment-property-delete)
• [](./sale-shipment-property-get-fields-by-type)