Return Refund APIからReturns Processing APIへの移行

ShopifyのAdmin APIにおけるリターン管理を簡略化し、強化するための重要な変更が発表されました。具体的には、returnRefund mutationが非推奨となり、新たにreturnProcess mutationが導入されました。

変更内容とは？

以下のような主要な変更があります。

• returnRefund mutationは非推奨となり、新たにreturnProcess mutationが導入されました。この新たなmutationは、返品ライフサイクルの管理を合理化するため、処分決定と金融処理を一つの呼び出しに統合します。
• フィールドReturn.suggestedReturnRefundが非推奨となり、新たにReturn.suggestedFinancialOutcomeフィールドが導入されました。
• 交換フルフィルメントオーダーは、交換ラインアイテムが処理される際にのみ作成されるようになり、その精度が向上しました。
• 返金と返品処理では、返品されるラインアイテムの管理に対してより高精度を提供します。
• 購入者による純粋な支払い残高がある交換のみが、AWAITING_PAYMENT という保留理由で保留されます。

これらの変更に伴い、アプリが現在returnCreateまたはreturnApproveRequestを使用して返品を作成したり、返品リクエストを承認している場合は、新たに導入されたreturnProcess mutationを使用して返品と交換を処理する必要があります。

これらの変更の影響

これらの変更により、返品管理のプロセスがより合理化され、効率化されます。返品ライフサイクルの管理を一つの呼び出しに統合することにより、不要なステップが省かれ、システム全体のパフォーマンスが向上します。また、新たに導入されたフィールドReturn.suggestedFinancialOutcomeにより、返金管理の処理がより簡単になり、より正確な返金予測が可能となります。

実装時の注意点

新たに導入されたreturnProcess mutationを使用する際、旧式のmutation(refundCreate, returnRefund)とクエリフィールド(Return.suggestedRefund)は非推奨であることに注意が必要です。これらは、returnProcess mutationとReturn.suggestedFinancialOutcomeフィールドに置き換えるべきです。

次のステップ

これらのAPIの変更は、APIバージョン2025-07で正式にローンチされました。詳細については、更新された移行ガイドをご覧ください。

参考記事: Returns Processing APIs replaces Return Refund APIs