2月 22, 2026

アプリケーションクレジット作成のPartner APIへの移行

2月 22, 2026

アプリケーションクレジット作成のPartner APIへの移行

Admin APIでのアプリケーションクレジットの作成が廃止され、パートナーAPIを用いた作成が必要となる新たな変更が発表されました。Admin APIバージョン2023-07以降、RESTリソースおよびGraphQLミューテーションを通じたアプリケーションクレジットの作成は廃止されます。今後、アプリケーションクレジットの作成はPartner API内の新たなミューテーション、appCreditCreateを用いて行ってください。

技術的課題と現状分析

既存のAdmin APIを用いたアプリケーションクレジットの作成方法には、アプリをアンインストールしたショップにクレジットを発行することができないという制約がありました。これは、特定の状況下でショップへのクレジット発行を必要とするパートナーにとって大きな課題となっていました。

新たな技術的ソリューションの提案

新たに導入されるappCreditCreateミューテーションにより、パートナーはアプリをアンインストールしたショップに対してもクレジットを発行することが可能となります。これにより、より柔軟なクレジット管理が可能となります。

実装手順とコード例

新たなappCreditCreateミューテーションはPartner API内で使用することが可能です。以下に簡単なコード例を示します。

mutation {
  appCreditCreate(
    input: {
      amount: "100.0"
      description: "Refund for item A"
      test: true
    }
  ) {
    appCredit {
      id
      amountSet {
        shopMoney {
          amount
          currencyCode
        }
      }
      description
      createdAt
    }
    userErrors {
      field
      message
    }
  }
}

この例では、100.0という金額のクレジットを"Refund for item A"という説明文付きで作成しています。なお、"test"オプションをtrueに設定することで、テストモードでクレジットを作成することが可能です。