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

`PATCH /v1/order-properties/:id`

Изменяет название, флаги и настройки существующего поля интернет-магазина для оформления заказа.

Передайте только изменяемые поля плоско в корне JSON, без обёртки `fields`.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `id` (path) | number | да | ID свойства заказа. Список: [`GET /v1/order-properties`](./list.md) |

## Поля запроса (body)

| Поле | Тип | Обяз. | Описание |
|------|------|------|------|
| `name` | string | нет | Название поля заказа |
| `code` | string \| null | нет | Символьный код |
| `sort` | number | нет | Порядок сортировки |
| `defaultValue` | any | нет | Значение по умолчанию. Скаляр или структура в зависимости от типа и `multiple`. Для `FILE` с сохранённым файлом задайте явную замену. Загрузка — `{ "fileData": ["имя файла", "base64"] }`, очистка файла — `{ "remove": "Y" }` |
| `description` | string \| null | нет | Описание поля |
| `settings` | object | нет | Настройки типа свойства. JSON-объект. Переданные верхние ключи заменяются, остальные сохраняются. `null` и массивы отклоняются. Поля самого свойства передавайте на верхнем уровне тела |
| `xmlId` | string \| null | нет | Внешний идентификатор |
| `inputFieldLocation` | number | нет | Устаревшее поле. Битрикс24 его не использует |
| `active` | boolean | нет | Свойство активно |
| `required` | boolean | нет | Значение обязательно при оформлении заказа |
| `multiple` | boolean | нет | Свойство содержит несколько значений |
| `userProps` | boolean | нет | Сохранять значение в профиле покупателя |
| `util` | boolean | нет | Служебное свойство |
| `isAddress` | boolean | нет | Свойство содержит адрес |
| `isAddressFrom` | boolean | нет | Адрес отправления |
| `isAddressTo` | boolean | нет | Адрес назначения |
| `isEmail` | boolean | нет | Свойство содержит электронную почту |
| `isFiltered` | boolean | нет | Использовать свойство в фильтре |
| `isLocation` | boolean | нет | Свойство содержит местоположение |
| `isLocation4tax` | boolean | нет | Местоположение для расчёта налогов |
| `isPayer` | boolean | нет | Имя плательщика |
| `isPhone` | boolean | нет | Телефон |
| `isProfileName` | boolean | нет | Название профиля покупателя |
| `isZip` | boolean | нет | Почтовый индекс |

## Примеры

### curl — личный ключ

```bash
curl -X PATCH "https://vibecode.bitrix24.tech/v1/order-properties/125" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Комментарий к доставке",
  "settings": {
    "maxlength": 300
  }
}'
```

### curl — OAuth-приложение

```bash
curl -X PATCH "https://vibecode.bitrix24.tech/v1/order-properties/125" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Комментарий к доставке",
  "settings": {
    "maxlength": 300
  }
}'
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-properties/125', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Комментарий к доставке",
    "settings": {
      "maxlength": 300
    }
  }),
})

const { success, data } = await res.json()
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-properties/125', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Комментарий к доставке",
    "settings": {
      "maxlength": 300
    }
  }),
})

const { success, data } = await res.json()
```

## Поля ответа

| Поле | Тип | Описание |
|------|------|------|
| `success` | boolean | `true` при успехе. HTTP-статус — `200` |
| `data` | object | Обновлённое свойство заказа. Полный список полей: [Поля свойства заказа](./fields.md) |

## Пример ответа

Показаны основные поля. Полный список: [Поля свойства заказа](./fields.md).

```json
{
  "success": true,
  "data": {
    "id": 125,
    "personTypeId": 5,
    "type": "STRING",
    "name": "Комментарий к доставке",
    "propsGroupId": 9,
    "code": "DELIVERY_COMMENT",
    "active": false,
    "defaultValue": "Позвонить перед доставкой",
    "settings": {
      "maxlength": 300,
      "multiline": "N"
    }
  }
}
```

## Пример ответа при ошибке

404 — свойство уже удалено:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "property is not exists"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `EMPTY_UPDATE_BODY` | Тело запроса пустое |
| 400 | `NO_RECOGNIZED_UPDATE_FIELDS` | В теле нет ни одного изменяемого поля свойства заказа |
| 400 | `READONLY_FIELD` | Передано `id`, `type`, `personTypeId`, `propsGroupId`, `relations` или `variants`, в том числе любое из этих полей внутри `settings` |
| 400 | `INVALID_PARAMS` | В скалярное поле передан объект или массив |
| 400 | `INVALID_PARAMS` | В числовое поле передана нечисловая строка, пустая строка или boolean |
| 400 | `INVALID_PARAMS` | Флаг не равен boolean `true`/`false` или одной из строк `"Y"`/`"N"`, `"yes"`/`"no"`, `"1"`/`"0"`, `"true"`/`"false"` (без учёта регистра и пробелов по краям) |
| 400 | `INVALID_PARAMS` | `settings` не является JSON-объектом |
| 400 | `INVALID_PARAMS` | У свойства `FILE` уже есть файл в `defaultValue`, но явная замена `defaultValue` не передана |
| 400 | `INVALID_PARAMS` | Предварительное чтение свойства, привязок или вариантов не даёт данных, необходимых для сохранения |
| 400 | `INVALID_PARAMS` | ID изменяемого свойства не является положительным целым числом |
| 404 | `ENTITY_NOT_FOUND` | Свойства с таким `id` нет. Текст — `property is not exists` |
| 422 | `BITRIX_ERROR` | Битрикс24 отклонил операцию. Текст причины — в `message` |
| 422 | `BITRIX_ERROR` | У пользователя ключа нет прав в Битрикс24. Код Битрикс24 — в `error.b24Code`: `200040300010` или `200040300020` |
| 403 | `BITRIX_ACCESS_DENIED` | У учётных данных портала нет скоупа `sale` (`insufficient_scope`) |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ работает в режиме только для чтения |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `sale` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

Полный список общих ошибок API — [Коды ошибок](/docs/errors).

## Известные особенности

Перед записью сохраняются все привязки к платёжным системам и службам доставки. Для `ENUM` сохраняются все варианты списка, в том числе полученные со следующих страниц. Общие правила сохранения полей и одновременных изменений — в [свойствах заказа](/docs/entities/order-properties).

## Смотрите также

- [Свойства заказа](/docs/entities/order-properties)
- [Получить свойство заказа](./get.md)
- [Создать свойство заказа](./create.md)
- [Поля свойства заказа](./fields.md)
- [Удалить свойство заказа](./delete.md)