## Удалить свойство заказа

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

Удаляет определение поля заказа из справочника интернет-магазина по указанному идентификатору. Восстановить удалённое определение через API нельзя — при необходимости создайте новое.

## Параметры

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

## Примеры

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

```bash
curl -X DELETE "https://vibecode.bitrix24.tech/v1/order-properties/125" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl -X DELETE "https://vibecode.bitrix24.tech/v1/order-properties/125" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-properties/125', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

if (res.status === 204) {
  console.log('Свойство заказа удалено')
}
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-properties/125', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

if (res.status === 204) {
  console.log('Свойство заказа удалено')
}
```

## Ответ

При успешном удалении возвращается HTTP-статус `204 No Content` с пустым телом. Признак успеха — код ответа.

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

```http
HTTP/1.1 204 No Content
```

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

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

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

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 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`: `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).

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

Значения в существующих заказах сохраняются, но теряют связь с определением свойства. Удаляются варианты списка, значения в профилях покупателей и привязки определения к платёжным системам и службам доставки.

Для отключения своего свойства вместо удаления передайте `active: false` в [`PATCH /v1/order-properties/:id`](./update.md).

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

- [Свойства заказа](/docs/entities/order-properties)
- [Обновить свойство заказа](./update.md)
- [Получить свойство заказа](./get.md)
- [Создать свойство заказа](./create.md)