スマートマットのWebhook通知について

目次

• Webhook共通仕様
• Webhookイベントタイプ
  • 発注完了通知
  • Webhookを利用した連携処理実装に関する注意事項
• WebhookURL設定手順

スマートマットのWebhook通知についてご案内します。
Webhookを利用して発注データを連携することができ、高度な発注連携が可能となります。

Webhook共通仕様

Webhookの利用条件

Webhook通知を利用する場合、拡張プランへの加入が必要となります。
拡張プランは現在、新規契約の受付を停止しております。 また、対象機能は今後に予定しているリニューアル画面への移行を機にクローズする可能性がございます、ご了承ください。

WebhookURL

通知先のURLは3つまで登録可能です。
また、URL長は最大2000文字まで対応しております。

リトライ処理

通知に対して200以外のレスポンスを返却することで、通知のリトライが5秒間隔で3回実行されます。

Webhookイベントタイプ

発注完了通知

スマートマットで発注が確定したタイミングで通知され、発注を実施するために必要なデータを取得することができます。

リクエストオブジェクト

キー名	型	説明
type	文字列	通知種別。発注完了通知の場合 ‘replenishment_order’ が設定されます
customer_id	数値	組織ごとに割り振られるid
customer_name	文字列	組織名
order_id	数値	発注ごとに割り振られるid
supplier_code	文字列	仕入先コード
supplier_name	文字列	仕入先名
ordered_at	文字列	発注確定時刻。RFC 3339 例 : ‘2023-06-01T15:00:00+09:00’
item_name	文字列	商品名
order_quantity	数値	発注数量
quantity_unit	文字列	発注単位
subscription_id	数値	在庫ごとに割り振られるid
product_code	文字列	商品に設定されているコード
custom_items	配列	ユーザーが任意に指定できる値

サンプルリクエスト

{
  "type": "replenishment_order",
  "customer_id": 5000000,
  "customer_name": "株式会社スマートショッピング",
  "order_id": 100000,
  "supplier_code": "仕入先コード",
  "supplier_name": "仕入先名",
  "ordered_at": "2024-04-23T14:33:55+09:00",
  "order_items": [
    {
      "item_name": "商品A",
      "order_quantity": 1,
      "quantity_unit": "箱",
      "subscription_id": 100000,
      "product_code": "ProductCode1",
      "custom_items": {
        "add1": "custom1",
        "add2": "custom2"
      }
    },
    {
      "item_name": "商品B",
      "order_quantity": 2,
      "quantity_unit": "箱",
      "subscription_id": 200000,
      "product_code": "ProductCode2",
      "custom_items": {
        "add1": "custom1",
        "add2": "custom2"
      }
    }
  ]
}

Webhookを利用した連携処理実装に関する注意事項

各通知のリクエストオブジェクトは、今後の機能開発に伴い変更される可能性があります。
そのため、プロパティ数の変更があった場合でも稼働を継続できる設計を推奨しております。

WebhookURL設定手順

1. ページ右上の [ 企業名 ] ＞ [ 管理者設定 ] をクリック

2. [ WebHook(発注完了を通知) ] 下部のフォームに通知先のURLを設定し [ 保存 ] をクリック