Return mutationによる売上更新（以前はRefund時まで変更なし）

返品処理のミューテーションが売上を更新するようになりました（以前は返金時まで変更されませんでした）

Shopify技術者の皆さん、こんにちは。Shopifyの新たな更新についてお知らせします。2024年2月20日から、返品処理のミューテーションが売上を更新するようになります。具体的には、returnCreate ミューテーションと returnApproveRequest ミューテーションが、注文に対して返品売上を作成します。それぞれの返品アイテムは product タイプの返品売上を作成します。これまでのこれらのミューテーションは売上を作成していませんでした。

技術的課題と現状分析

これまで、Shopifyの返品処理は売上を更新することなく行われていました。これにより、返品が行われても売上の反映が遅くなるという問題が生じていました。また、返品と返金が同時に行われる場合、売上の計算が複雑となるという問題もありました。

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

この問題を解決するために、Shopifyでは新たなミューテーション returnCreate と returnApproveRequest を導入します。これらのミューテーションは、返品が行われた際に即座に売上を更新します。具体的には、返品された商品ごとに product タイプの返品売上を作成します。

実装手順とコード例

以下に、新たなミューテーションを使用して返品処理を行う手順とコード例を示します。GraphQL APIを使用して返品処理を行います。

```graphql mutation { returnCreate(input: { order: "gid://shopify/Order/1234567890", returnMerchandise: true, items: [{ lineItemId: "gid://shopify/LineItem/1234567890", quantity: 1 }] }) { return { id status returnNumber } userErrors { field message } } } ```

このコードは、注文IDが1234567890の注文に対して、1つの商品を返品する処理を行います。その結果、返品のステータスと返品番号が返されます。

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

新たなミューテーションを使用することで、返品処理の売上更新が即座に行われるようになります。これにより、売上の計算が簡素化され、計算処理のパフォーマンスが改善されます。また、リアルタイムに売上が更新されることで、販売データの精度が向上します。

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

新たなミューテーションを使用する際は、返品処理の結果を確認するために、返品のステータスと返品番号を取得するようにしてください。また、返品処理が正常に行われたかどうかを確認するため、エラーメッセージも取得するようにしてください。

次のステップ・発展案

今後、Shopifyでは返品に関連するウェブフックの情報を提供する予定です。これにより、返品による注文の行項目や値の変更を追跡することができるようになります。詳細が公開され次第、すぐにご報告しますので、お楽しみに。

参考記事: Return mutation will update sales (previously unchanged until time of Refund)