## Создать свойство позиции корзины

`POST /v1/basket-item-properties`

Создаёт свойство существующей позиции корзины для хранения дополнительных данных о товаре.

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

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

| Поле | Тип | Обяз. | Описание |
|------|------|------|------|
| `basketId` | number | да | ID позиции корзины. Источник: [`GET /v1/basket-items`](/docs/entities/basket-items/list) |
| `name` | string | да | Название свойства |
| `value` | string \| null | да | Значение свойства. При создании `null` и пустая строка отклоняются |
| `code` | string \| null | да | Символьный код свойства. При создании `null` и пустая строка отклоняются |
| `sort` | number | нет | Порядок сортировки |
| `xmlId` | string \| null | нет | Внешний идентификатор |
| `id` | number | нет | ID свойства. Источник: [`GET /v1/basket-item-properties`](./list.md). `RO`. Только чтение, задаётся сервером. |

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/basket-item-properties" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "basketId": 1001,
  "name": "Цвет",
  "value": "Синий",
  "code": "COLOR",
  "sort": 100
}'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/basket-item-properties" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "basketId": 1001,
  "name": "Цвет",
  "value": "Синий",
  "code": "COLOR",
  "sort": 100
}'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/basket-item-properties', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "basketId": 1001,
    "name": "Цвет",
    "value": "Синий",
    "code": "COLOR",
    "sort": 100
  }),
})

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

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/basket-item-properties', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "basketId": 1001,
    "name": "Цвет",
    "value": "Синий",
    "code": "COLOR",
    "sort": 100
  }),
})

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

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

| Поле | Тип | Описание |
|------|------|------|
| `success` | boolean | `true` при успехе. HTTP-статус — `201` |
| `data` | object | Созданное свойство позиции корзины |
| `data.id` | number | ID свойства. Источник: [`GET /v1/basket-item-properties`](./list.md) |
| `data.basketId` | number | ID позиции корзины. Источник: [`GET /v1/basket-items`](/docs/entities/basket-items/list) |
| `data.name` | string | Название свойства |
| `data.value` | string \| null | Значение свойства |
| `data.code` | string \| null | Символьный код свойства |
| `data.sort` | number | Порядок сортировки |
| `data.xmlId` | string \| null | Внешний идентификатор |

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

```json
{
  "success": true,
  "data": {
    "basketId": 1001,
    "code": "COLOR",
    "id": 1037,
    "name": "Цвет",
    "sort": 100,
    "value": "Синий",
    "xmlId": "bx_6acd18b609cf1"
  }
}
```

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

400 — не передано обязательное поле `code`:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "Body field \"code\" is required to create basketItemProperty."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|------|------|
| 400 | `MISSING_REQUIRED_FIELDS` | Обязательное поле `basketId`, `name`, `value` или `code` отсутствует или равно `null`. Поле `name`, `value` или `code` равно пустой строке |
| 400 | `INVALID_PARAMS` | В `basketId` передана пустая или нечисловая строка |
| 400 | `READONLY_FIELD` | Передано поле `id`, доступное только для чтения |
| 404 | `ENTITY_NOT_FOUND` | Указанная позиция корзины не найдена |
| 415 | `FST_ERR_CTP_INVALID_MEDIA_TYPE` | Передан неподдерживаемый тип содержимого, например `application/xml` |
| 422 | `BITRIX_ERROR` | Битрикс24 отклонил операцию. Причина — в `message` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ работает в режиме только для чтения |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `sale` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 429 | `RATE_LIMITED` | Превышен лимит запросов |

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

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

- [Список свойств позиций корзины](./list.md)
- [Получить свойство позиции корзины](./get.md)
- [Обновить свойство позиции корзины](./update.md)
- [Удалить свойство позиции корзины](./delete.md)
- [Поля свойства позиции корзины](./fields.md)
- [Свойства позиций корзины](/docs/entities/basket-item-properties)
- [Список позиций корзины](/docs/entities/basket-items/list)
- [Пакетные вызовы](/docs/batch)
- [Общий контракт методов сущностей](/docs/entity-api)