配送約束参加者APIへの新たな追加機能

Shopifyの配送約束プログラムにおけるAPIの利用に関して、一部の重要な変更が行われました。この記事では、その新機能とその実装方法について詳しく解説します。

これまでは、配送約束プログラムの参加者を特定するために主に店舗情報が利用されていました。しかし、それでは、特定のロケーションをプログラムから除外するといった細かい設定が難しくなってしまいます。また、商品クエリで配送約束参加者にフィルターをかけることも困難でした。

これらの問題を解決するため、Shopifyのunstableバージョンにて新たなAPIが提供されています。これにより、店舗約束プログラムから除外すべきロケーションを指定することが可能となります。さらに、商品クエリにおいて配送約束参加者にフィルターをかける機能も追加されました。

この新たな機能は、deliveryPromiseParticipantsクエリとdeliveryPromiseParticipantsUpdateミューテーションを強化することで実現しています。これらにより、Shop Promiseプログラムから除外したいロケーションを指定することができます。

// 例：特定のロケーションを除外
mutation {
  deliveryPromiseParticipantsUpdate(input: {
    excludeLocations: ["location_id"]
  }) {
    deliveryPromiseParticipants {
      excludeLocations
    }
  }
}

また、delivery_promise_participants_handleを商品クエリで使用することで、配送約束参加者である商品バリアントにフィルターをかけ、特定の商品バリアントの配送約束参加者のリストを取得することができます。

// 例：配送約束参加者でフィルタリング
{
  products(query: "delivery_promise_participants_handle:delivery_promise") {
    edges {
      node {
        title
      }
    }
  }
}

これらの新機能により、配送約束プログラムの管理がより効率的になります。特定のロケーションを除外することで、不必要な送料のコストを削減することが可能となり、また商品クエリでのフィルタリングにより、より具体的な商品情報の取得が可能となります。

これらの新たなAPIを使用する際には、まずunstableバージョンでのテストが推奨されます。また、正式リリースは2025-07バージョンに予定されているため、それ以降に本番環境での適用を検討してください。

今回追加されたAPIは、配送約束プログラムの管理をより効率的に行うためのものです。今後はこれらのAPIを活用し、より具体的な配送管理を行っていくことが求められます。