# sale.shipmentpropertyvalue.modify

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

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

## Описание

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

## Параметры

- `fields` `object` — обязательный. Корневой элемент, в котором передаются параметры запроса

### Параметр fields

- `shipment` `object` — обязательный. Объект, содержащий значения идентификатора отгрузки и значения свойств отгрузки (подробное описание приведено [ниже](#shipment))

### Параметр shipment

- `id` `sale_order_shipment.id` — обязательный. Идентификатор отгрузки
- `propertyValues` `object[]` — обязательный. Массив объектов, содержащих идентификатор свойства отгрузки и значение свойства (подробное описание приведено [ниже](#propertyvalues))

### Параметр propertyValues

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

## Ответ

HTTP-статус: 200

```json
{
    "result":{
        "propertyValues":[
            {
                "code":null,
                "id":38164,
                "name":"Comments",
                "value":"Comments value"
            },
            {
                "code":null,
                "id":38165,
                "name":"Description",
                "value":"Description value"
            }
        ]
    },
    "time":{
        "start":1718022201.149589,
        "finish":1718022201.726496,
        "duration":0.5769069194793701,
        "processing":0.38397693634033203,
        "date_start":"2024-06-10T15:23:21+03:00",
        "date_finish":"2024-06-10T15:23:21+03:00"
    }
}
```

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

- `result` `object`. Корневой элемент ответа
- `propertyValues` `sale_shipment_property_value[]`. Массив объектов, содержащих информацию о значениях свойств отгрузок
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error":100,
    "error_description":"Could not find value for parameter {fields}"
}
```

- `200040300020` — Недостаточно прав для изменения значений свойств
- `100` — Не указаны обязательные параметры
- `201040400006` — Некорректный идентификатор отгрузки
- `201040400007` — Отгрузка не найдена
- `201040400008` — Ошибка сохранения заказа
- `0` — Другие ошибки (например, фатальные ошибки)

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

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"shipment":{"id":4120,"propertyValues":[{"shipmentPropsId":105,"value":"Comments value"},{"shipmentPropsId":106,"value":"Description value"}]}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentpropertyvalue.modify
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"shipment":{"id":4120,"propertyValues":[{"shipmentPropsId":105,"value":"Comments value"},{"shipmentPropsId":106,"value":"Description value"}]}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.shipmentpropertyvalue.modify
```

### 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 ModifyResult = {
  propertyValues: {
    code: string | null
    id: number
    name: string
    value: string
  }[]
}

try {
  const response = await $b24.actions.v2.call.make<ModifyResult>({
    method: 'sale.shipmentpropertyvalue.modify',
    params: {
      fields: {
        shipment: {
          id: 4120,
          propertyValues: [
            {
              shipmentPropsId: 105,
              value: 'Comments value',
            },
            {
              shipmentPropsId: 106,
              value: 'Description value',
            },
          ],
        },
      },
    },
    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.propertyValues)
  }
} 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 modifyShipmentPropertyValues() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.shipmentpropertyvalue.modify',
        params: {
          fields: {
            shipment: {
              id: 4120,
              propertyValues: [
                {
                  shipmentPropsId: 105,
                  value: 'Comments value',
                },
                {
                  shipmentPropsId: 106,
                  value: 'Description value',
                },
              ],
            },
          },
        },
        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.propertyValues)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

### Python

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

fields = {
    "shipment": {
        "id": 4120,
        "propertyValues": [
            {
                "shipmentPropsId": 105,
                "value": "Comments value",
            },
            {
                "shipmentPropsId": 106,
                "value": "Description value",
            },
        ],
    },
}

try:
    bitrix_response = client.sale.shipmentpropertyvalue.modify(
        fields=fields,
    ).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.modify',
            [
                'fields' => [
                    'shipment' => [
                        'id'            => 4120,
                        'propertyValues' => [
                            [
                                'shipmentPropsId' => 105,
                                'value'           => 'Comments value'
                            ],
                            [
                                'shipmentPropsId' => 106,
                                'value'           => 'Description value'
                            ],
                        ],
                    ],
                ],
            ]
        );

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

    echo 'Success: ' . print_r($result, true);

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

### BX24.js

```js
BX24.callMethod(
    'sale.shipmentpropertyvalue.modify', {
        fields: {
            shipment: {
                id: 4120,
                propertyValues: [{
                        shipmentPropsId: 105,
                        value: 'Comments value'
                    },
                    {
                        shipmentPropsId: 106,
                        value: 'Description value'
                    },
                ],
            },
        }
    },
    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.modify',
    [
        'fields' => [
            'shipment' => [
                'id' => 4120,
                'propertyValues' => [
                    [
                        'shipmentPropsId' => 105,
                        'value' => 'Comments value'
                    ],
                    [
                        'shipmentPropsId' => 106,
                        'value' => 'Description value'
                    ],
                ],
            ],
        ]
    ]
);

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.shipmentpropertyvalue.modify", b24.Params{
	"fields": b24.Params{
		"shipment": b24.Params{
			"id": 4120,
			"propertyValues": []b24.Params{
				{
					"shipmentPropsId": 105,
					"value":           "Comments value",
				},
				{
					"shipmentPropsId": 106,
					"value":           "Description value",
				},
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("sale.shipmentpropertyvalue.modify: %w", err)
}

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

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

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