注文更新Webhook 仕様書

1. 概要

本ドキュメントは、工場で注文が更新された際に、連携先システムがWebhookを通じてその更新情報を受け取るための仕様を説明します。Webhookの登録を行うことで、注文のステータス更新をリアルタイムで取得できます。

2. Webhookリクエスト仕様

2.1 HTTPメソッド

2.2 HTTPヘッダー

項目 設定される値 例
x-webhook-signature リクエストボディのJSONを共有シークレットでHMAC署名したもの（Base64UrlSafe形式） 1n7n5mlZ2vu6CIYDMLWaEzwGcGsQwxEBEuSd7iu5Fqg

2.3 リクエストボディ

リクエストボディはJSON形式で以下の内容を含みます。

{
	"app_id": "your_app_id",
	"order_no": "12345",
	"ec_order_no": "EC98765",
	"status_id": 140,
	"shipping_number": "SN1234567890",
	"delivery_company_name": "配送会社名",
	"shipping_method_name": "配送方法名",
	"scheduled_shipping_date": "2025-03-23"
	"order_details": [
		{
			"order_detail_no": "12345-1",
			"ec_order_detail_no": "EC98765-1",
			"status_id": 140
		},
		{
			"order_detail_no": "12345-2",
			"ec_order_detail_no": "EC98765-2",
			"status_id": 140
		}
	],
	"updated_at": "2025-03-19 14:30:00",
	"timestamp": 1732093800
}
項目 説明
app_id アプリID
order_no 注文番号
ec_order_no EC注文番号
status_id 注文のステータスID
shipping_number 配送番号 ※ステータスID：140（出荷完了）の場合に設定される
delivery_company_name 配送会社名 ※ステータスID：140（出荷完了）の場合に設定される
shipping_method_name 配送方法名 ※ステータスID：140（出荷完了）の場合に設定される
scheduled_shipping_date 出荷予定日（YYYY-MM-DD）
order_details 配列項目
> order_detail_no 注文明細番号
> ec_order_detail_no EC注文明細番号
> status_id 注文明細のステータスID
updated_at ステータス更新日時（YYYY-MM-DD HH:mm:ss）
timestamp リクエスト時のUNIXタイムスタンプ

3. ステータスID

注文の状態を示すステータスIDは以下の通りです。

ステータスID ステータス表示名 説明
100 工場確認中 注文が登録され、工場が対応を開始する前
110 工場対応中 工場が対応を開始した状態（資材の用意など）
120 工場対応中 工場が製造を行っている
130 工場対応中 工場の製造が終わって出荷準備中
140 出荷済 出荷が完了した状態

4. リトライ仕様