Shopify API:2021年1月のリリース情報

2021年1月版のAPI機能ラウンドアップへようこそ。これは、アプリの品質を向上させ、開発経験を効率化するために、最新の変更点をすべて採用する方法を理解していただくことを目的としています。

このバージョンでは、これまでで最も要望の多かった機能の1つである、新しいサブスクリプションAPIによるサブスクリプションのネイティブサポートをリリースしました。プリペイドサブスクリプションを促進するためのスケジュールフルフィルメント、アプリ料金の自動アクティベーション、手数料やチップの合計などの注文やトランザクションに関するより詳細な財務情報です。

2021-01のリリースは、バージョン2020-01の削除と一致していますので、互換性があることを確認し、変更点を確認するためにAPIヘルスレポートを確認することを忘れないでください。

この記事では、2021-01リリースに含まれる機能を紹介いたします。

1.サブスクリプションAPI

このバージョンには、Shopify上でのサブスクリプションを強化するために開発された新しいAPIが含まれています。これらの追加機能により、パートナーや開発者は、チェックアウトとネイティブに統合するアプリを開発することができ、サブスクリプションを提供するショップの顧客体験を劇的に向上させることができます。サブスクリプションAPIは、注文のライフサイクル全体にわたってShopifyと完全に統合されているため、正確な配送料金を提供し、割引の適用を可能にし、Shopify管理者から注文を管理し、実行することが簡単にできます。

マーチャントに代わってサブスクリプションを管理するのに役立つ、いくつかの新しいエンドポイントとリソースが含まれています。販売プランは、商品グループの「購読して保存」のような配送ポリシーや課金ポリシーを設定するための柔軟なリソースです。顧客が販売プランを含む製品を注文すると、開発者はサブスクリプション契約を管理して、利用可能な顧客のお支払い方法を問わず、簡単に定期的な支払いができるようにすることができます。

Shopify API release January 2021: coffee subscription checkout
コーヒーの定期購入プランをサブスクリプションAPIで実現したショップ

 

サブスクリプション契約、サブスクリプション請求の送信、および顧客の支払い方法は、すべて独自のWebhook topicを受信しているため、サブスクリプションの一般的なイベントを常に最新の状態に保つことができます。

商品サブスクリプションApp extension

新しいサブスクリプション体験の中心となるネイティブツールを強化するために、アプリ開発者がShopify管理画面で直接サブスクリプション管理を促進できるようにする新しい種類のApp extension(アプリ拡張機能)をリリースしました。この新しい種類のApp extensionは、Shopify App CLIから単一のコマンドを使用して作成することができ、優れたマーチャント体験を提供するために必要なすべての土台が含まれています。


また、Shopify App CLIには、商品サブスクリプションApp extension用のシミュレーターが完全に装備されており、スキャフォールドされたApp extensionのコードの変更をリアルタイムでプレビューすることができます。

Shopify API release January 2021: app extension simulator browser tool

App extension シミュレータブラウザツールでは、Shopifyがどのようにアプリ拡張機能をレンダリングするかを管理画面で確認することができます。

App extensionをデプロイする準備ができたら、バージョン履歴を完全にコントロールできるパートナーダッシュボード(パートナー管理画面)にプッシュし、ボタンをクリックするだけでアプリをインストールしているすべてのショップにApp extensionを公開することができます。

Shopify-API-release-January-2021: screengrab of subscription app manager in the partner dashboard

パートナー ダッシュボードから商品サブスクリプションApp extensionを管理することで、下書きを作成し、アプリを使用しているすべてのストアに特定のバージョンを公開することができます。

サブスクリプションアプリがインストールされているショップは、Shopify管理画面で商品ページ上のサブスクリプションカードをレンダリングし、そのデータを、公開されているApp extensionのコードを動力源とするモーダルに渡します。この全体のやり取りは、Shopify上でホストされているコード間で行われるため、商品サブスクリプションApp extensionは信じられないほど高速です。

Shopify-API-release-January-2021: screengrab of subscription card in the app

サブスクリプションカードは、Shopify管理画面でレンダリングされます。追加オプションをクリックすると、公開されたアプリの拡張子コードがレンダリングされます。

商品サブスクリプションApp extensionの開発方法は、こちらのチュートリアルをご覧ください。

3.スケジュールフルフィルメント

このバージョンでの最後のサブスクリプションベースの変更点は、スケジュール(予約)設定可能なフルフィルメントです。フルフィルメント注文はSCHEDULEDステータスをサポートするようになり、プリペイドサブスクリプションを含むすべての注文に表示されます。これらのフルフィルメント注文には fulfillAt日付が含まれており、 SCHEDULEDフルフィルメント注文の有効期限が切れるとOPEN状態に移行します。 

2021-01の時点で、APIクライアントは、新しいfulfillmentOrderReschedule転換を使用して、将来的にフルフィルメント注文の日付を指定することで、フルフィルメントオーダーを後日にリスケジュールすることもできます。フルフィルメント注文を再スケジュールすることは、特にプリペイド定期購入の場合に便利です。この機能はShopify管理画面UIからはまだ利用できません。

下記がフルフィルメント 必要な注文を再スケジュールリクエストを送る例です:

 

サブスクリプションとフルフィルメントがどのように連携するかの詳細については、こちらのチュートリアルをご覧ください。

4. アプリ課金の自動有効化

以前のバージョンでは、REST API を使用したアプリの課金は 3 段階のプロセスでした。

  • ステップ①アプリケーションの課金を作成する
  • ステップ② 加盟店が料金を受け入れるか、または拒否する
  • ステップ③請求が承認された場合、APIコールを行い、保留中だったAcceptチャージを有効化します。


2021-01の時点では、アプリはこの3つ目のステップを実行する必要はありません。承認されたアプリ課金は自動的に「アクティブ」状態に移行するため、アプリが作成し、加盟店に承認されたが、その後アクティブ化されず、パートナーに支払われなかった課金の可能性がなくなります。

 5.財務レポートの改善

2021-01バージョンでは、会計アプリの精度を向上させるために2つの変更点が含まれています。

1つ目は、Admin GraphQL APIの一部として利用可能な新しいオブジェクトであるTransactionFeeです。この新しいオブジェクトには、Shopify Paymentsの支払いの一部として収集された手数料に関するより詳細な情報が含まれており、定額料金、パーセンテージ料金、これらの手数料にかかる税金の内訳などが含まれています。

次に、GraphQL Admin APIでは、注文オブジェクトのtotalTipReceivedSetフィールドを使用して、ショップ通貨と決済通貨の両方で注文の一部として受け取ったチップが含まれるようになりました。この粒度の向上により、会計アプリは、特定の注文トランザクションの手数料やチップをより正確にレポートすることができるようになります。

 

Shopifyパートナープログラムでビジネスを成長させる
マーケティング、カスタマイズ、またはWebデザインや開発など提供するサービスに関係なく、Shopifyパートナープログラムはあなたを成功へと導きます。プログラムの参加は無料で、収益分配の機会が得られ、ビジネスを成長させる豊富なツールにアクセスできます。情熱的なコマースコミュニティに今すぐ参加しましょう!

今すぐ登録
トピック: