Storefront APIに新たに追加されたCartオブジェクトのcheckoutChargeAmountフィールド

ShopifyのStorefront APIの最新バージョン2022-04で、新たにcheckoutChargeAmountフィールドがCartオブジェクトに追加されました。このフィールドは、チェックアウト時にカート全体で支払われる小計を示すもので、繰り延べられた支払いは含まれません。ただし、現在はextend_selling_plans_apiのβフラグ制限下にあります。

技術的課題と現状分析

これまでのCartオブジェクトでは、subtotalフィールドによりカート全体の小計を取得できましたが、これには後日支払われる分も含まれていました。そのため、チェックアウト時点での実際の支払い額を正確に把握することが難しかったのです。

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

この問題を解決するために、新たにcheckoutChargeAmountフィールドが導入されました。このフィールドを利用することで、チェックアウト時に実際に支払われる額を正確に取得することが可能になります。

実装手順とコード例

GraphQL Storefront APIの最新バージョンを利用して、checkoutChargeAmountフィールドを取得するには、次のようなクエリを使用します。

{
  cart(id: "カートID") {
    checkoutChargeAmount
  }
}

これにより、チェックアウト時の支払い額が取得できます。

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

この新フィールドを使用することで、チェックアウト時の正確な料金を瞬時に取得でき、ユーザー体験の向上に寄与します。また、後日の支払いを含まない小計を把握できるため、ビジネス上の予測や分析の精度も向上します。

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

ただし、このフィールドは現在extend_selling_plans_apiのβフラグ制限下にあるため、利用する際は注意が必要です。また、checkoutChargeAmountフィールドはチェックアウト時の支払い額を示していますので、全体の小計を取得する場合は引き続きsubtotalフィールドを使用してください。

次のステップ・発展案

この新フィールドを活用し、より精度の高いビジネス分析や、ユーザーに対する正確な料金情報の提示を行いましょう。今後のAPIのアップデートにも注目し、新たなフィールドの追加や利用制限の変更に対応していきましょう。

参考記事: New checkoutChargeAmount field added to Cart object on Storefront API