# Webhook

<figure><img src="https://740025866-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlRf1QqJGoevCQqGbfI80%2Fuploads%2Fgit-blob-094f1326e4f5b66d3f4de825a63e55cbf0f4ac01%2Fboxhero-add-webhook.png?alt=media" alt=""><figcaption></figcaption></figure>

***

## Регистрация

Вы можете зарегистрировать вебхук в <mark style="color:синий;">**`Настройки`**</mark> **>** <mark style="color:синий;">**`Интеграции и API`**</mark> в вашей команде BoxHero.

## Поведение доставки и повторных попыток

Когда происходит событие, BoxHero отправляет HTTP `POST` запрос на ваш зарегистрированный endpoint вебхука. Тело запроса содержит JSON-данные, описывающие событие.

* Если ваш сервер отвечает **HTTP 200 OK**, событие считается успешно доставленным.
* Если ваш сервер отвечает **любой код статуса, отличный от 200**, BoxHero рассматривает это как временный сбой и повторяет доставку до 3 раз.

## Структура полезной нагрузки вебхука

Все события вебхука доставляются со следующей JSON-структурой в теле запроса:

```json
{
  "id": "1234", // Уникальный ID события
  "topic": "txs/new", // Тема события
  "version": 1, // Версия схемы полезной нагрузки
  "payload": { // Данные, специфичные для события
    ...
  },
  "created_time": "2025-08-06T09:20:48.623Z" // Временная метка возникновения события (ISO 8601)
}
```

***

## Порядок событий

BoxHero **не** гарантирует порядок доставки событий. Например, событие `item/new` может прийти после события `item/delete` для того же самого товара.

Тариф `Поле` created\_time

## Темы событий

{% hint style="info" %}
Если вам нужна поддержка дополнительных тем событий, пожалуйста, свяжитесь с [Службой поддержки](https://www.boxhero.io/docs/documentation/ru/resursy/contact).
{% endhint %}

### `txs/new`

Срабатывает, когда происходит инвентарная транзакция (приход / расход / корректировка / перемещение).

{% hint style="warning" %}
**Примечание:** Это событие *не* срабатывает для корректировок, созданных через массовое редактирование или импорт (например, при добавлении или обновлении товаров через Excel).
{% endhint %}

<table><thead><tr><th width="207">Поле</th><th width="100" data-type="checkbox">Обязательно</th><th>Описание</th><th data-hidden data-type="checkbox">Обязательность</th><th data-hidden>Описание</th><th data-hidden>Режим команды</th></tr></thead><tbody><tr><td>id</td><td>true</td><td>Уникальный ID транзакции</td><td>true</td><td>Уникальный ID истории</td><td>Общий</td></tr><tr><td>type</td><td>true</td><td>Тип транзакции<br>(in, out, adjust, move)</td><td>true</td><td><p>Тип истории.</p><ul><li>Приход : in</li><li>Расход : out</li><li>Корректировка : adjust</li><li>Перемещение : move</li></ul></td><td>Общий</td></tr><tr><td>партнера</td><td>false</td><td>Партнёр</td><td>false</td><td></td><td></td></tr><tr><td>partner.id</td><td>false</td><td>Уникальный ID партнёра</td><td>false</td><td></td><td></td></tr><tr><td>partner.name</td><td>false</td><td>Имя партнёра</td><td>false</td><td></td><td></td></tr><tr><td>partner.deleted</td><td>false</td><td>Удалён ли партнёр</td><td>false</td><td></td><td></td></tr><tr><td>from_location</td><td>false</td><td>Исходная локация</td><td>false</td><td></td><td></td></tr><tr><td>from_location.id</td><td>false</td><td>Уникальный ID исходной локации</td><td>false</td><td></td><td></td></tr><tr><td>from_location.name</td><td>false</td><td>Название исходной локации</td><td>false</td><td></td><td></td></tr><tr><td>from_location.deleted</td><td>false</td><td>Удалена ли исходная локация</td><td>false</td><td></td><td></td></tr><tr><td>to_location</td><td>true</td><td>Локация назначения</td><td>false</td><td></td><td></td></tr><tr><td>to_location.id</td><td>true</td><td>Уникальный ID локации назначения</td><td>false</td><td></td><td></td></tr><tr><td>to_location.name</td><td>true</td><td>Название локации назначения</td><td>false</td><td></td><td></td></tr><tr><td>to_location.deleted</td><td>true</td><td>Удалена ли локация назначения</td><td>false</td><td></td><td></td></tr><tr><td>items</td><td>true</td><td>Строки товаров в транзакции</td><td>true</td><td>Элементы по товарам, составляющие историю</td><td>Все режимы</td></tr><tr><td>items.id</td><td>true</td><td>Уникальный ID товара</td><td>true</td><td>Уникальный ID товара</td><td>Все режимы</td></tr><tr><td>items.name</td><td>true</td><td>Название товара</td><td>true</td><td>Название товара</td><td>Все режимы</td></tr><tr><td>items.quantity</td><td>true</td><td>Изменение запаса вследствие прихода/расхода/корректировки/перемещения</td><td>true</td><td>Количество прихода/расхода/корректировки/перемещения для данного товара</td><td>Все режимы</td></tr><tr><td>items.deleted</td><td>true</td><td>Удалён ли товар</td><td>true</td><td>Удалён ли товар</td><td></td></tr><tr><td>items.from_location_new_stock_level</td><td>false</td><td>Уровень запаса на исходной локации после транзакции</td><td>false</td><td></td><td></td></tr><tr><td>items.to_location_new_stock_level</td><td>true</td><td>Уровень запаса на локации назначения после транзакции</td><td>false</td><td></td><td></td></tr><tr><td>transaction_time</td><td>true</td><td>Время транзакции (например, время прихода/расхода)</td><td>false</td><td></td><td></td></tr><tr><td>created_at</td><td>true</td><td>Время, когда транзакция была создана</td><td>false</td><td></td><td></td></tr><tr><td>created_by</td><td>true</td><td>Участник, создавший транзакцию</td><td>false</td><td></td><td></td></tr><tr><td>created_by.id</td><td>true</td><td>Уникальный ID участника</td><td>false</td><td></td><td></td></tr><tr><td>created_by.name</td><td>true</td><td>Имя участника</td><td>false</td><td></td><td></td></tr><tr><td>created_by.deleted</td><td>true</td><td>Удалён ли участник</td><td>false</td><td></td><td></td></tr><tr><td>count_of_items</td><td>true</td><td>Количество товаров</td><td>false</td><td></td><td></td></tr><tr><td>total_quantity</td><td>true</td><td>Общее количество изменений запаса</td><td>false</td><td></td><td></td></tr><tr><td>url</td><td>true</td><td>URL-адрес для просмотра страницы с деталями транзакции</td><td>false</td><td></td><td></td></tr><tr><td>memo</td><td>false</td><td>Примечания, связанные с транзакцией</td><td>false</td><td></td><td></td></tr></tbody></table>

#### Пример полезной нагрузки вебхука – `Приход` Событие

```json
{
  "id": 16160911,
  "type": "in",
  "to_location": {
    "id": 52766,
    "name": "Склад 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14277699,
      "name": "belif Cleansing Gel Oil Enriched",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 3
    },
    {
      "id": 14277698,
      "name": "belif Aqua Bomb Jelly Cleanser",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 5
    }
  ],
  "transaction_time": "2023-04-25T05:42:27.545Z",
  "created_at": "2023-08-14T05:14:29.499Z",
  "created_by": {
    "id": 201345,
    "name": "corp",
    "deleted": false
  },
  "count_of_items": 2,
  "total_quantity": 4,
  "url": "https://web.boxhero-app.com/team/149058/mode/0#/tx/16160911"
}
```

#### Пример полезной нагрузки вебхука – `Перемещение запасов` Событие

<pre class="language-json"><code class="lang-json">{
  "id": 3692714,
  "type": "move",
  "from_location": {
    "id": 52765,
    "name": "Склад 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "Склад 3",
<strong>    "deleted": false
</strong>  },
  "items": [
    {
      "id": 14873303,
      "name": "Auto liner 3.5mm",
      "quantity": 1,
      "deleted": false,
      "from_location_new_stock_level": -1,
      "to_location_new_stock_level": 1
    }
  ],
  "transaction_time": "2025-04-25T05:42:27.545Z",
  "created_at": "2025-04-25T05:42:27.545Z",
  "created_by": {
    "id": 176829,
    "name": "Tony Lee",
    "deleted": false
  },
  "count_of_items": 1,
  "total_quantity": 1,
  "url": "https://web.boxhero-app.com/team/150581/mode/2#/ltx/3692714"
}
</code></pre>

### `txs/edit`

Отправляется, когда существующая инвентарная транзакция (приход / расход / корректировка / перемещение) **отредактирована**.

<table><thead><tr><th>Поле</th><th width="100" data-type="checkbox">Обязательно</th><th>Описание</th><th data-hidden data-type="checkbox">Обязательность</th><th data-hidden>Описание</th><th data-hidden>Режим команды</th></tr></thead><tbody><tr><td>id</td><td>true</td><td>Уникальный ID транзакции</td><td>true</td><td>Уникальный ID истории</td><td>Общий</td></tr><tr><td>type</td><td>true</td><td>Тип транзакции<br>(in, out, adjust, move)</td><td>true</td><td><p>Тип истории.</p><ul><li>Приход : in</li><li>Расход : out</li><li>Корректировка : adjust</li><li>Перемещение : move</li></ul></td><td>Общий</td></tr><tr><td>партнера</td><td>false</td><td>Партнёр</td><td>false</td><td></td><td></td></tr><tr><td>partner.id</td><td>false</td><td>Уникальный ID партнёра</td><td>false</td><td></td><td></td></tr><tr><td>partner.name</td><td>false</td><td>Имя партнёра</td><td>false</td><td></td><td></td></tr><tr><td>partner.deleted</td><td>false</td><td>Удалён ли партнёр</td><td>false</td><td></td><td></td></tr><tr><td>from_location</td><td>false</td><td>Исходная локация</td><td>false</td><td></td><td></td></tr><tr><td>from_location.id</td><td>false</td><td>Уникальный ID исходной локации</td><td>false</td><td></td><td></td></tr><tr><td>from_location.name</td><td>false</td><td>Название исходной локации</td><td>false</td><td></td><td></td></tr><tr><td>from_location.deleted</td><td>false</td><td>Удалена ли исходная локация</td><td>false</td><td></td><td></td></tr><tr><td>to_location</td><td>true</td><td>Локация назначения</td><td>false</td><td></td><td></td></tr><tr><td>to_location.id</td><td>true</td><td>Уникальный ID локации назначения</td><td>false</td><td></td><td></td></tr><tr><td>to_location.name</td><td>true</td><td>Название локации назначения</td><td>false</td><td></td><td></td></tr><tr><td>to_location.deleted</td><td>true</td><td>Удалена ли локация назначения</td><td>false</td><td></td><td></td></tr><tr><td>items</td><td>true</td><td>Строки товаров в транзакции</td><td>true</td><td>Элементы по товарам, составляющие историю</td><td>Все режимы</td></tr><tr><td>items.id</td><td>true</td><td>Уникальный ID товара</td><td>true</td><td>Уникальный ID товара</td><td>Все режимы</td></tr><tr><td>items.name</td><td>true</td><td>Название товара</td><td>true</td><td>Название товара</td><td>Все режимы</td></tr><tr><td>items.quantity</td><td>true</td><td>Изменение количества вследствие транзакции (in/out/adjust/move)</td><td>true</td><td>Количество прихода/расхода/корректировки/перемещения для данного товара</td><td>Все режимы</td></tr><tr><td>items.deleted</td><td>true</td><td>Удалён ли товар</td><td>true</td><td>Удалён ли товар</td><td></td></tr><tr><td>items.from_location_new_stock_level</td><td>false</td><td>Уровень запаса на исходной локации после транзакции</td><td>false</td><td></td><td></td></tr><tr><td>items.to_location_new_stock_level</td><td>true</td><td>Уровень запаса на локации назначения после транзакции</td><td>false</td><td></td><td></td></tr><tr><td>transaction_time</td><td>true</td><td>Время транзакции (например, время прихода/расхода)</td><td>false</td><td></td><td></td></tr><tr><td>created_at</td><td>true</td><td>Время, когда транзакция была создана</td><td>false</td><td></td><td></td></tr><tr><td>created_by</td><td>true</td><td>Участник, создавший транзакцию</td><td>false</td><td></td><td></td></tr><tr><td>created_by.id</td><td>true</td><td>Уникальный ID участника</td><td>false</td><td></td><td></td></tr><tr><td>created_by.name</td><td>true</td><td>Имя участника</td><td>false</td><td></td><td></td></tr><tr><td>created_by.deleted</td><td>true</td><td>Удалён ли участник</td><td>false</td><td></td><td></td></tr><tr><td>count_of_items</td><td>true</td><td>Количество товаров</td><td>false</td><td></td><td></td></tr><tr><td>total_quantity</td><td>true</td><td>Общее количество изменений запаса</td><td>false</td><td></td><td></td></tr><tr><td>url</td><td>true</td><td>URL-адрес для просмотра страницы с деталями транзакции</td><td>false</td><td></td><td></td></tr><tr><td>memo</td><td>false</td><td>Примечания, связанные с транзакцией</td><td>false</td><td></td><td></td></tr><tr><td>revision</td><td>true</td><td>Текущий номер версии транзакции, начиная с 1</td><td>false</td><td></td><td></td></tr></tbody></table>

#### Пример полезной нагрузки вебхука – Отредактировано `Приход` Операция

```json
{
  "id": 16160911,
  "type": "in",
  "to_location": {
    "id": 52766,
    "name": "Склад 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14277699,
      "name": "belif Cleansing Gel Oil Enriched",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 3
    },
    {
      "id": 14277698,
      "name": "belif Aqua Bomb Jelly Cleanser",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 5
    }
  ],
  "transaction_time": "2023-04-25T05:42:27.545Z",
  "created_at": "2023-08-14T05:14:29.499Z",
  "created_by": {
    "id": 201345,
    "name": "corp",
    "deleted": false
  },
  "count_of_items": 2,
  "total_quantity": 4,
  "url": "https://web.boxhero-app.com/team/149058/mode/0#/tx/16160911"
}

```

#### Пример полезной нагрузки вебхука – Отредактировано `Перемещение запасов` Операция

```json
{
  "id": 3692714,
  "type": "move",
  "from_location": {
    "id": 52765,
    "name": "Склад 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "Склад 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14873303,
      "name": "Auto liner 3.5mm",
      "quantity": 1,
      "deleted": false,
      "from_location_new_stock_level": -1,
      "to_location_new_stock_level": 1
    }
  ],
  "transaction_time": "2023-04-25T05:42:27.545Z",
  "created_at": "2023-04-25T05:42:27.545Z",
  "created_by": {
    "id": 176829,
    "name": "Джой Ким",
    "deleted": false
  },
  "count_of_items": 1,
  "total_quantity": 1,
  "url": "https://web.boxhero-app.com/team/150581/mode/2#/ltx/3692714"
}

```

### `txs/delete`

Отправляется, когда инвентарная транзакция **удалена**.

| Поле     | Описание                                     |
| -------- | -------------------------------------------- |
| id       | Уникальный ID транзакции                     |
| revision | Текущий номер версии транзакции, начиная с 1 |

#### Пример полезной нагрузки вебхука – Удалённая транзакция

```json
/{
  "id": 27036740,
  "revision": 2
}
```

### `item/new`

Отправляется, когда новый товар добавляется в инвентарь команды.

{% hint style="warning" %}
**Примечание**: Это событие *не* срабатывает при использовании функции <mark style="color:синий;">**`Add Item Variants`**</mark> или при импорте товаров через <mark style="color:синий;">**`Import Excel`**</mark>.
{% endhint %}

<table><thead><tr><th width="318">Поле</th><th>Описание</th><th data-hidden data-type="checkbox">Обязательность</th><th data-hidden>Описание</th><th data-hidden>Режим команды</th></tr></thead><tbody><tr><td>id</td><td>ID товара</td><td>true</td><td>Уникальный ID истории</td><td>Общий</td></tr><tr><td>name</td><td>Название товара</td><td>true</td><td><p>Тип истории.</p><ul><li>Приход : in</li><li>Расход : out</li><li>Корректировка : adjust</li><li>Перемещение : move</li></ul></td><td>Общий</td></tr><tr><td>sku</td><td>SKU</td><td>false</td><td></td><td></td></tr><tr><td>штрихкод</td><td>Штрихкод</td><td>false</td><td></td><td></td></tr><tr><td>photo_url</td><td>URL фотографии</td><td>false</td><td></td><td></td></tr><tr><td>cost</td><td>Себестоимость</td><td>false</td><td></td><td></td></tr><tr><td>price</td><td>Цена</td><td>false</td><td></td><td></td></tr><tr><td>attrs</td><td>Атрибуты</td><td>false</td><td></td><td></td></tr></tbody></table>

#### **Пример полезной нагрузки – Создан товар**

```json
{
  "id": 26122826,
  "name": "belif Peat Miracle Revital Cream",
  "sku": "SKU-YH2361KI",
  "barcode": "2002074321218",
  "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/30b0cc84-601d-493d-87fd-b7e8b5825601",
  "cost": "50000",
  "price": "65000",
  "attrs": [
    {
      "id": 413101,
      "name": "Категория",
      "type": "text",
      "value": "Foundation"
    },
    {
      "id": 459264,
      "name": "Дата окончания срока годности",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Страховой запас",
      "type": "number",
      "value": 33
    }
  ]
}
```

### `item/edit`

Отправляется, когда существующий товар редактируется.

{% hint style="warning" %}
**Примечание**: Это событие *не* срабатывает *для*массовых изменений, выполненных через <mark style="color:синий;">**`Центр данных`**</mark>**&#x20;>&#x20;**<mark style="color:синий;">**`Item`**</mark> или через <mark style="color:синий;">**`Import Excel`**</mark> функцию.
{% endhint %}

<table><thead><tr><th width="318">Поле</th><th>Описание</th><th data-hidden data-type="checkbox">Обязательность</th><th data-hidden>Описание</th><th data-hidden>Режим команды</th></tr></thead><tbody><tr><td>id</td><td>ID товара</td><td>true</td><td>Уникальный ID истории</td><td>Общий</td></tr><tr><td>name</td><td>Название товара</td><td>true</td><td><p>Тип истории.</p><ul><li>Приход : in</li><li>Расход : out</li><li>Корректировка : adjust</li><li>Перемещение : move</li></ul></td><td>Общий</td></tr><tr><td>sku</td><td>SKU</td><td>false</td><td></td><td></td></tr><tr><td>штрихкод</td><td>Штрихкод</td><td>false</td><td></td><td></td></tr><tr><td>photo_url</td><td>URL фотографии</td><td>false</td><td></td><td></td></tr><tr><td>cost</td><td>Себестоимость</td><td>false</td><td></td><td></td></tr><tr><td>price</td><td>Цена</td><td>false</td><td></td><td></td></tr><tr><td>attrs</td><td>Атрибуты</td><td>false</td><td></td><td></td></tr></tbody></table>

#### **Пример полезной нагрузки – Товар обновлён**

```json
{
  "id": 26122826,
  "name": "belif Peat Miracle Revital Cream",
  "sku": "SKU-YH2361KI",
  "barcode": "2002074321218",
  "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/30b0cc84-601d-493d-87fd-b7e8b5825601",
  "cost": "50000",
  "price": "65000",
  "attrs": [
    {
      "id": 413101,
      "name": "Категория",
      "type": "text",
      "value": "Foundation"
    },
    {
      "id": 459264,
      "name": "Дата окончания срока годности",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Страховой запас",
      "type": "number",
      "value": 33
    }
  ]
}
```

### `item/delete`

Отправляется, когда товар удаляется из инвентаря команды.

{% hint style="warning" %}
**Примечание**: Это событие *не* срабатывает для массовых удалений, выполненных через <mark style="color:синий;">**`Центр данных`**</mark>**&#x20;>&#x20;**<mark style="color:синий;">**`Item`**</mark>.
{% endhint %}

<table><thead><tr><th width="318">Поле</th><th>Описание</th><th data-hidden data-type="checkbox">Обязательность</th><th data-hidden>Описание</th><th data-hidden>Режим команды</th></tr></thead><tbody><tr><td>id</td><td>ID товара</td><td>true</td><td>Уникальный ID истории</td><td>Общий</td></tr></tbody></table>

#### Пример полезной нагрузки **– Товар удалён**

```json
{
  "id": 26122826
}
```