# sale.shipmentpropertyvalue.get

URL: https://chugunov.pro/api-bitrix24/sale/shipment-property-value/sale-shipment-property-value-get/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить значения свойства отгрузки по id
Scope: `sale`
Кто может выполнять метод: администратор

## Описание

Метод `sale.shipmentpropertyvalue.get` возвращает значения свойства отгрузки.

## Параметры

- `id` `sale_shipment_property_value.id` — обязательный. Идентификатор значения свойства отгрузки

## Ответ

HTTP-статус: 200

```json
{
    "result":{
        "propertyValue":{
            "code":null,
            "id":38164,
            "name":"Comments",
            "shipmentPropsId":105,
            "value":"Comments value"
        }
    },
    "time":{
        "start":1718023082.525679,
        "finish":1718023082.798483,
        "duration":0.27280378341674805,
        "processing":0.055876970291137695,
        "date_start":"2024-06-10T15:38:02+03:00",
        "date_finish":"2024-06-10T15:38:02+03:00"
    }
}
```

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

- `result` `object`. Корневой элемент ответа
- `propertyValue` `sale_shipment_property_value.id`. Информация о значении свойства отгрузки
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error":201040400001,
    "error_description":"Property value has not been found"
}
```

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

## Примеры запроса

### cURL (Webhook)

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

### cURL (OAuth)

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

### JS (TS)

```ts
// 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 ShipmentPropertyValueGetResult = {
  propertyValue: {
    code: string | null
    id: number
    name: string
    shipmentPropsId: number
    value: string | null
  }
}

try {
  const response = await $b24.actions.v2.call.make<ShipmentPropertyValueGetResult>({
    method: 'sale.shipmentpropertyvalue.get',
    params: {
      id: 38164,
    },
    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(result.propertyValue.id, result.propertyValue.name, result.propertyValue.value)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 getShipmentPropertyValue() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.shipmentpropertyvalue.get',
        params: {
          id: 38164,
        },
        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(result.propertyValue.id, result.propertyValue.name, result.propertyValue.value)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getShipmentPropertyValue)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.sale.shipmentpropertyvalue.get(
        bitrix_id=38164,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'sale.shipmentpropertyvalue.get',
            [
                'id' => 38164,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting shipment property value: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    "sale.shipmentpropertyvalue.get", {
        "id": 38164
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.info(result.data());
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'sale.shipmentpropertyvalue.get',
    [
        'id' => 38164
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.shipmentpropertyvalue.get", b24.Params{
	"id": 38164,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("sale.shipmentpropertyvalue.get: %w", err)
}

// Метод заворачивает ответ в объект с ключом "propertyValue".
raw, ok := b24.Unwrap(res.Result, "propertyValue")
if !ok {
	return fmt.Errorf("в ответе нет ключа propertyValue")
}

var item struct {
	ID              b24.ID `json:"id"`
	Name            string `json:"name"`
	ShipmentPropsID b24.ID `json:"shipmentPropsId"`
	Value           string `json:"value"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/sale/shipment-property-value/sale-shipment-property-value-get.html