## Обновить позицию складского документа

`PATCH /v1/catalog-document-elements/:id`

Изменяет позицию складского документа.

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

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `id` (path) | number | да | Идентификатор позиции. Список: [`GET /v1/catalog-document-elements`](/docs/entities/catalog-document-elements/list) |

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

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|---------|
| `amount` | number | нет | Количество товара |
| `purchasingPrice` | number | нет | Закупочная цена за единицу |
| `storeFrom` | number | нет | Склад отправления. Список: [`GET /v1/warehouses`](/docs/entities/warehouses/list). Какой склад нужен документу, зависит от его типа — см. [позиции складских документов](/docs/entities/catalog-document-elements) |
| `storeTo` | number | нет | Склад получения. Список: [`GET /v1/warehouses`](/docs/entities/warehouses/list) |
| `docId` | number | нет | RO. Задаётся только при создании. Список: [`GET /v1/catalog-documents`](/docs/entities/catalog-documents/list) |
| `elementId` | number | нет | RO. Задаётся только при создании. Список: [`GET /v1/catalog-products`](/docs/entities/catalog-products/list) |
| `id` | number | нет | RO. Идентификатор позиции передаётся в пути |

## Примеры

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

```bash
curl -X PATCH "https://vibecode.bitrix24.tech/v1/catalog-document-elements/33" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 5
  }'
```

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

```bash
curl -X PATCH "https://vibecode.bitrix24.tech/v1/catalog-document-elements/33" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 5
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-document-elements/33', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    amount: 5,
  }),
})

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

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-document-elements/33', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    amount: 5,
  }),
})

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | `true` при успешном обновлении |
| `data.id` | number | Идентификатор позиции |
| `data.docId` | number | Идентификатор документа. Документ — [`GET /v1/catalog-documents/:id`](/docs/entities/catalog-documents/get) |
| `data.elementId` | number | Идентификатор товара. Товар — [`GET /v1/catalog-products/:id`](/docs/entities/catalog-products/get) |
| `data.amount` | number \| null | Количество товара. `null`, если не задано |
| `data.purchasingPrice` | number \| null | Закупочная цена за единицу. `null`, если не задана |
| `data.storeFrom` | number \| null | Склад отправления. `null`, если не задан. Склады — [`GET /v1/warehouses`](/docs/entities/warehouses/list) |
| `data.storeTo` | number \| null | Склад получения. `null`, если не задан. Склады — [`GET /v1/warehouses`](/docs/entities/warehouses/list) |
| `meta.warnings` | array | Приходит, только если в теле есть поле, которого нет среди полей позиции. Элемент — `code: "UNRECOGNIZED_WRITE_FIELD"`, `field` с именем поля и `message`. Объект `fields` на маршруте, который сам оборачивает карту полей и где схема не объявляет `fields`, отклоняется с `400 NESTED_FIELDS_ENVELOPE`; передавайте поля плоско в корне JSON. |

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

```json
{
  "success": true,
  "data": {
    "amount": 5,
    "docId": 299,
    "elementId": 6595,
    "id": 33,
    "purchasingPrice": 11000,
    "storeFrom": null,
    "storeTo": 11
  }
}
```

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

422 — документ позиции проведён:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Conducted document",
    "b24Code": "ERROR_DOCUMENT_STATUS"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 422 | `BITRIX_ERROR` | Документ позиции проведён. Сообщение `Conducted document`, `b24Code` — `ERROR_DOCUMENT_STATUS`. Сначала [отмените проведение](/docs/entities/catalog-documents/cancel) |
| 404 | `ENTITY_NOT_FOUND` | Позиции с указанным `id` нет |
| 400 | `READONLY_FIELD` | В теле передан `docId`, `elementId` или `id`. Сообщение называет поле: `Field 'docId' is read-only and cannot be set` |
| 400 | `EMPTY_UPDATE_BODY` | Тело запроса пустое |
| 400 | `NO_RECOGNIZED_UPDATE_FIELDS` | В теле нет ни одного изменяемого поля, например поля обёрнуты в `fields` |
| 400 | `INVALID_PARAMS` | `id` в пути — не целое неотрицательное число |
| 400 | `INVALID_PARAMS` | Значение поля не подходит по типу: нечисловая строка в числовом поле, например `"amount": "abc"`, либо объект или массив вместо числа или строки. Имя поля — в `error.message` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ работает в режиме только для чтения |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `catalog` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `INVALID_API_KEY` | Переданный API-ключ не найден |

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

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

- [Получить позицию](/docs/entities/catalog-document-elements/get)
- [Создать позицию](/docs/entities/catalog-document-elements/create)
- [Удалить позицию](/docs/entities/catalog-document-elements/delete)
- [Поля позиции](/docs/entities/catalog-document-elements/fields)
- [Отменить проведение](/docs/entities/catalog-documents/cancel)
- [Batch](/docs/batch)