# catalog.document.element.add

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

Добавить товар в документ складского учета
Scope: `catalog`
Кто может выполнять метод: пользователь с правом «Создание и редактирование» на тип документа в запросе

## Описание

Метод `catalog.document.element.add` добавляет товарную позицию в документ складского учета.

## Параметры

- `fields` `object` — обязательный. Поля добавляемого товара  ([подробное описание](#fields))

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

- `docId` `catalog_document.id` — обязательный. Идентификатор документа складского учета, можно получить методом [catalog.document.list](https://chugunov.pro/api-bitrix24/catalog/document/catalog-document-list/). Документ должен иметь статус `N` — не проведен
- `elementId` `catalog_product.id` — обязательный. Идентификатор товара каталога. Значение можно получить методами [catalog.product.*](https://chugunov.pro/api-bitrix24/catalog/product/)
- `storeFrom` `catalog_store.id` — необязательный. Идентификатор склада-источника, можно получить методом [catalog.store.list](https://chugunov.pro/api-bitrix24/catalog/store/catalog-store-list/). Используется для документов списания
- `storeTo` `catalog_store.id` — необязательный. Идентификатор склада-получателя, можно получить методом [catalog.store.list](https://chugunov.pro/api-bitrix24/catalog/store/catalog-store-list/). Используется для документов поступления и перемещения
- `amount` `double` — необязательный. Количество товара. Значение указывается в единицах учета документа
- `purchasingPrice` `double` — необязательный. Закупочная цена в валюте документа

## Ответ

```json
{
    "result": {
        "documentElement": {
            "amount": 15,
            "docId": 64,
            "elementId": 312,
            "id": 148,
            "purchasingPrice": 1250.5,
            "storeFrom": null,
            "storeTo": 2
        }
    },
    "time": {
        "start": 1759482001.102334,
        "finish": 1759482001.215487,
        "duration": 0.11315321922302246,
        "processing": 0.018451929092407227,
        "date_start": "2025-11-02T12:20:01+03:00",
        "date_finish": "2025-11-02T12:20:01+03:00",
        "operating": 0
    }
}
```

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

- `result` `object`. Корневой элемент ответа
- `documentElement` `catalog_document_element`. Объект с информацией о добавленном товаре
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

```json
{
    "error": "ERROR_DOCUMENT_STATUS",
    "error_description": "Conducted document"
}
```

- `ERROR_DOCUMENT_RIGHTS` — Access denied. Недостаточно прав на документ или один из указанных складов
- `ERROR_DOCUMENT_STATUS` — Document not found / Conducted document. Документ не найден, недоступен или уже проведен
- `0` — Error of adding new document element. Внутренняя ошибка при сохранении позиции

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

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"docId":64,"elementId":312,"storeTo":2,"amount":15,"purchasingPrice":1250.5}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.element.add
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"docId":64,"elementId":312,"storeTo":2,"amount":15,"purchasingPrice":1250.5},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.document.element.add
```

### 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 DocumentElementResult = {
  documentElement: {
    amount: number
    docId: number
    elementId: number
    id: number
    purchasingPrice: number
    storeFrom: number | null
    storeTo: number
  }
}

try {
  const response = await $b24.actions.v2.call.make<DocumentElementResult>({
    method: 'catalog.document.element.add',
    params: {
      fields: {
        docId: 64,
        elementId: 312,
        storeTo: 2,
        amount: 15,
        purchasingPrice: 1250.5,
      },
    },
    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.documentElement)
  }
} 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 addDocumentElement() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'catalog.document.element.add',
        params: {
          fields: {
            docId: 64,
            elementId: 312,
            storeTo: 2,
            amount: 15,
            purchasingPrice: 1250.5,
          },
        },
        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.documentElement)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

### Python

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

try:
    bitrix_response = client.catalog.document.element.add(
        fields={
            "docId": 64,
            "elementId": 312,
            "storeTo": 2,
            "amount": 15,
            "purchasingPrice": 1250.5,
        },
    ).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(
            'catalog.document.element.add',
            [
                'fields' => [
                    'docId' => 64,
                    'elementId' => 312,
                    'storeTo' => 2,
                    'amount' => 15,
                    'purchasingPrice' => 1250.5,
                ],
            ]
        );

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

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding document element: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'catalog.document.element.add',
    {
        fields: {
            docId: 64,
            elementId: 312,
            storeTo: 2,
            amount: 15,
            purchasingPrice: 1250.5
        }
    },
    function(result)
    {
        if (result.error())
            console.error(result.error());
        else
            console.log(result.data());
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'catalog.document.element.add',
    [
        'fields' => [
            'docId' => 64,
            'elementId' => 312,
            'storeTo' => 2,
            'amount' => 15,
            'purchasingPrice' => 1250.5,
        ],
    ]
);

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.element.add", b24.Params{
	"fields": b24.Params{
		"docId":           64,
		"elementId":       312,
		"storeTo":         2,
		"amount":          15,
		"purchasingPrice": 1250.5,
	},
})
if err != nil {
	return fmt.Errorf("catalog.document.element.add: %w", err)
}

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

var item struct {
	Amount          int     `json:"amount"`
	DocID           b24.ID  `json:"docId"`
	ElementID       b24.ID  `json:"elementId"`
	ID              b24.ID  `json:"id"`
	PurchasingPrice float64 `json:"purchasingPrice"`
	StoreTo         int     `json:"storeTo"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Amount, item.DocID)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/catalog/document/document-element/catalog-document-element-add.html