紛争防止のためのサポートが追加されました

Shopify APIにおける紛争ステータスの取り扱いについて、新たな価値としてpreventedが導入されました。紛争ステータスの全説明が更新され、より現実的な結果とプロセッサの用語を反映するようになりました。

技術的課題の定義

これまでのShopify APIでは、紛争ステータスが統一的に扱われており、紛争が早期に防止された場合のステータスを詳細に扱うことができませんでした。これにより、ECサイト運営者は紛争ステータスの詳細な分析や、紛争を防止した結果の反映が難しくなっていました。

具体的な技術的ソリューションの提案

新たにpreventedステータスが導入されました。これにより、紛争が早期に防止された場合でもその情報をAPIから取得し、ECサイトに反映することが可能になります。また、紛争ステータスの説明も更新され、より現実的な結果とプロセッサの用語を反映したものになっています。

実装手順とコード例

Admin API（GraphQLとREST）でpreventedステータスを受け取ることが可能になりました。これは、Webhooksやペイロードに組み込むことも可能です。

GraphQLを使用する場合のコード例は次の通りです。

  query {
    paymentDispute(id: "gid://shopify/PaymentDispute/1") {
      status
    }
  }

APIから受け取ったpreventedステータスは、UIやレポートに反映することが可能です。

パフォーマンス・コスト分析

preventedステータスの導入により、紛争が早期に防止された場合でも詳細な情報を取得できるようになります。これにより、紛争の状況をより詳細に分析し、適切な対応を行うための情報を得ることが可能になります。

実装時の注意点・ベストプラクティス

preventedステータスを正しく扱うためには、enumの取り扱い（スイッチ、バリデーション、データベースの制約）を見直す必要があります。また、UIのコピー、翻訳、フィルタを更新し、preventedをopen, won, lostの状態とは異なるものとして表現することが重要です。

次のステップ・発展案

今後は、preventedステータスを利用して、紛争の状況をより詳細に分析し、適切な対応を行うことが求められます。また、preventedステータスが反映された結果をUIやレポートに反映することで、ユーザーにとってより使いやすいECサイトを作り上げることが可能です。

参考記事: Added support for dispute preventions