Admin API Orderリソースにおける支払いプロパティの非推奨化について

技術的課題の定義と現状分析

ShopifyのRESTおよびGraphQL Admin APIのOrderリソースにおいて、いくつかのプロパティが非推奨となりました。具体的には、gateway、payment_details、およびprocessing_methodです。これらはwebhooksを含むOrderリソースのプロパティであり、各プロパティの非推奨化により、これまでこれらのプロパティを使用していた開発者は、新たな実装方法を検討する必要があります。

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

非推奨となったgatewayおよびpayment_detailsプロパティは、対応するTransactionリソース上で利用可能です。したがって、これらのプロパティが必要な場合には、OrderリソースからTransactionリソースへの参照を適切に行うことで対応が可能です。

一方、processing_methodプロパティは、複数のトランザクションをサポートする注文に対応するため、不正確なデータを含む可能性があるため、利用できなくなりました。このプロパティが提供していた値は、以下のようにさまざまなソースから推測できます。

• free: 注文合計を通じてアクセス可能です。
• checkout: 注文にcheckout_idが存在することにより確定できます。
• express、direct、offsite、およびmanual: これらはOrderTransactionのgatewayおよびpayment_detailsプロパティを通じて推測可能です。

実装手順とコード例

新しい実装方法に移行するには、以下の手順を参照してください。

1. OrderリソースからTransactionリソースへの参照を作成します。
2. 必要に応じて、Transactionリソース上のgatewayとpayment_detailsプロパティを使用します。
3. processing_methodプロパティの代わりに、上述のソースから適切な値を推測します。

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

この変更により、少なくとも初期段階では、コードのリファクタリングによる開発コストが発生します。しかし、不正確なデータが生じる可能性を排除することで、長期的なパフォーマンスとデータの信頼性が向上します。

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

非推奨となったプロパティを新たな実装方法に置き換える際は、APIの変更に伴う影響範囲を十分に理解し、テストを行うことが重要です。また、非推奨プロパティの削除予定日（2023年1月）を確認し、それまでに必要な対応を行うようにしましょう。

次のステップ・発展案

これらのプロパティが非推奨となった後の公式の変更は、2023年4月のAdmin APIバージョンで決定される予定です。今後のAPIのアップデートに注目し、新たな実装方法に適切に対応することが求められます。

参考記事: Payment properties deprecation on the Admin API Order resource