> For the complete documentation index, see [llms.txt](https://www.boxhero.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.boxhero.io/docs/documentation/ja/lian-xie/webhook.md).

# Webhook

<figure><img src="/files/75d1abad6f7bf9c52c22e47a39d9f9d1229b9fa7" alt=""><figcaption></figcaption></figure>

***

## 登録

Webhook を登録できます <mark style="color:青;">**`設定`**</mark> **>** <mark style="color:青;">**`連携とAPI`**</mark> あなたの BoxHero チームで。

<figure><img src="/files/59c04d8c1556fde3e3afce2480b4272ba70b438b" alt=""><figcaption></figcaption></figure>

## 配信と再試行の動作

イベントが発生すると、BoxHero は HTTP `POST` リクエストを登録済みの webhook エンドポイントに送信します。リクエスト本文には、そのイベントを説明する JSON ペイロードが含まれます。

* サーバーが **HTTP 200 OK**を返すと、イベントは正常に配信されたと見なされます。
* サーバーが **200以外のステータスコード**を返すと、BoxHero は一時的な失敗と見なし、最大 3 回まで配信を再試行します。

## Webhook ペイロードの構造

すべての webhook イベントは、リクエスト本文に以下の 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` フィールドは実際のイベント時刻を表します。Webhook ハンドラーでは、イベントを確実に処理できるよう、冪等で順序に耐性のあるロジックを実装してください。

## イベントトピック

{% hint style="info" %}
追加のイベントトピックに関するサポートが必要な場合は、 [サポート](/docs/documentation/ja/rissu/contact.md).
{% 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>partner</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>

#### Webhook ペイロードの例 – `入庫` イベント

```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"
}
```

#### Webhook ペイロードの例 – `在庫移動` イベント

<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>partner</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><tr><td>revision</td><td>true</td><td>取引の現在のバージョン番号。1から始まります</td><td>false</td><td></td><td></td></tr></tbody></table>

#### Webhook ペイロードの例 – 編集済み `入庫` 取引

```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"
}

```

#### Webhook ペイロードの例 – 編集済み `在庫移動` 取引

```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": "Joy Kim",
    "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から始まります |

#### Webhook ペイロードの例 – 削除された取引

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

### `item/new`

チームの在庫に新しい商品が追加されたときに送信されます。

{% hint style="warning" %}
**注**: このイベントは *ありません* 次の機能を使用したときにトリガーされます <mark style="color:青;">**`商品バリアントを追加`**</mark> 機能、または次を通じた商品インポート <mark style="color:青;">**`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>barcode</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>

#### **Webhook ペイロードの例 – 商品作成**

```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": "ファンデーション"
    },
    {
      "id": 459264,
      "name": "有効期限",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "安全在庫",
      "type": "number",
      "value": 33
    }
  ]
}
```

### `item/edit`

既存の商品が編集されたときに送信されます。

{% hint style="warning" %}
**注**: このイベントは *ありません* トリガーされます *f*または次を通じて行われた一括編集 <mark style="color:青;">**`データセンター`**</mark>**&#x20;>&#x20;**<mark style="color:青;">**`商品`**</mark> または次を通じて <mark style="color:青;">**`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>barcode</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>

#### **Webhook ペイロードの例 – 商品更新**

```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": "ファンデーション"
    },
    {
      "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:青;">**`商品`**</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
}
```