INVENTORY API

在庫入荷APIにキャンセル受領アクション追加

GraphQL Admin API 2026-10 で「CANCELED」受領アクションが正式サポート。入荷しないと判明したユニットを誤りなく記録できるようになった。

入荷シップメントInventoryShipmentACCEPTED ✓REJECTED ✗CANCELED 🚫 NEWtotalReceivedQuantity= accepted + rejected + canceled

GraphQL Admin API バージョン 2026-10 から、在庫入荷シップメントに CANCELED 受領アクションが追加されました。入荷しないと判明したユニットを正確にキャンセル済みとして記録でき、WMSや3PLと受領状態を同期するアプリが完全な受領内訳を扱えるようになります。既存アプリへの影響はなく、対応は任意です。

1変更内容 — Before / After 図解

Before (〜2026-07)After (2026-10〜)受領アクション: ACCEPTED / REJECTED入荷しない分 → 未受領のまま or 誤REJECTEDtotalCanceledQuantity: なしcanceledQuantity: なし (LineItem)webhookにold/new_canceled_quantityなしACCEPTED / REJECTED / CANCELED 追加入荷しない分を正確にCANCELEDとして記録totalCanceledQuantity 追加 (InventoryShipment)canceledQuantity 追加 (LineItem)old/new_canceled_quantity をwebhookで受信可能

2追加されたフィールドとEnum値

InventoryShipment 新フィールド
  • totalCanceledQuantity — シップメント全体のキャンセル数合計
  • 既存の totalAcceptedQuantity / totalRejectedQuantity と並列
  • totalReceivedQuantity = accepted + rejected + canceled
InventoryShipmentLineItem 新フィールド
  • canceledQuantity — 行単位のキャンセル数
  • 既存の acceptedQuantity / rejectedQuantity と並列
Enum 新値: CANCELED
  • InventoryShipmentReceiveLineItemReason に追加
  • inventoryShipmentReceive mutation の reason に指定
  • bulkReceiveAction にも使用可 — 残全ユニットを一括キャンセル
Webhook: inventory_shipments/receive_items
  • 2026-10以降のサブスクリプション: old_canceled_quantity / new_canceled_quantity が items_received の各エントリに追加
  • キャンセルのみの受領もwebhookをトリガー
  • 旧バージョンのサブスクリプション: フィールド省略・キャンセル専用受領はトリガー不発のまま

3業務で活かせるユースケース

課題
サプライヤーから「今回の発注のうち5ユニットは製造中止で入荷しない」と連絡があったが、APIでは未受領のまま放置するしかなかった
打ち手
inventoryShipmentReceive に reason: CANCELED を渡して該当ユニットを即座にクローズ
効果
在庫の未消化レコードが消え、発注管理画面の受領ステータスが実態と一致する
技術メモ
2026-04以降、 @idempotent(key: ...) ディレクティブが必須。ユニークなUUIDを毎回生成してセットすること
課題
3PL(物流委託先)がWMSでキャンセル受領を記録しても、Shopify側に反映できず二重管理が発生していた
打ち手
inventory_shipments/receive_items webhookを2026-10で再サブスクライブし、new_canceled_quantity の変化を検知してWMSステータスと自動同期
効果
手動修正オペレーションをゼロに。受領内訳(accepted/rejected/canceled)がShopify・WMS双方で一致
技術メモ
旧バージョンのwebhookサブスクリプションはキャンセル専用受領でトリガーされないため、2026-10以降への更新が必須
課題
購買管理アプリで発注書の「受領進捗率」を表示しているが、キャンセル分が未受領として残り進捗が100%にならない
打ち手
totalCanceledQuantity を進捗計算に組み込み、「入荷予定数 = 発注数 - canceled」として最終受領完了判定ロジックを修正
効果
発注書が正確にクローズされ、オープン発注の一覧から誤ったレコードが消える。バイヤーの確認工数を削減
技術メモ
totalReceivedQuantity は accepted + rejected + canceled の合計になるため、既存の計算ロジックへの影響を確認すること

4技術者向けポイント

観点 詳細
対象APIバージョン 2026-10以降(unstableを含む)。2026-07以前は影響なし・フィールド非公開
Additive変更 2026-10リリース候補への加算的追加。破壊的変更なし。既存アプリの対応不要
idempotencyキー inventoryShipmentReceive mutationは2026-04以降 @idempotent(key: ...) が必須。毎リクエストにユニークUUIDを生成
totalReceivedQuantity の変化 2026-10以降、canceled分も加算される。受領完了判定・進捗率算出ロジックを要確認
webhookトリガー条件変更 2026-10サブスクリプションのみ、canceledのみの受領操作でもdeliveryが発生。旧版は不発のまま維持
bulkReceiveAction 残全ユニットを一括CANCELEDにする場合は bulkReceiveAction: CANCELED で対応可

5実装サンプル

▼ mutation例: 5ユニットをキャンセル済みとしてマーク

mutation ReceiveShipment {
  inventoryShipmentReceive(
    id: "gid://shopify/InventoryShipment/123"
    lineItems: [
      {
        shipmentLineItemId: "gid://shopify/InventoryShipmentLineItem/456"
        quantity: 5
        reason: CANCELED
      }
    ]
  ) @idempotent(key: "b105ab7c-4680-4bfc-b350-c766e01a431f") {
    inventoryShipment {
      totalCanceledQuantity
      lineItems(first: 10) {
        nodes {
          id
          canceledQuantity
        }
      }
    }
    userErrors { code field message }
  }
}

※ IDとidempotencyキーは実際の値に置き換えること

入荷キャンセルを「誤REJECTED」や「未受領放置」なく正確に記録できるようになり、WMS・3PL・購買管理との受領状態同期が完結します。

Source: https://shopify.dev/changelog/adding-a-canceled-receive-action-to-the-inventory-shipments-api | 公開日: 2026-09-17