Shopify API リリース：2021年10月版

開発者必見。2021年10月版のAPI機能をまとめました。刷新されたCart APIと特定のリソースをIDで取得できる機能など、Storefront APIの大幅な改良を解説します。

最終更新： 2021年10月19日

2021年10月版のAPI機能リリースのまとめにようこそ。アプリの品質向上のために最新の変更を適用したり、開発環境を合理化したりするのに役立つ情報をお届けします。

今回のバージョンには、刷新されたCart APIと特定のリソースをIDで取得できる機能など、Storefront APIの大幅な改良が含まれます。また、Bulk Operation Webhooks、予約注文などを簡単に管理できるようにするManual Fulfillment Holds、お客さまがSMSのマーケティングコミュニケーションを受けとるという同意を示すSMS marketing consent endpointsなども含まれています。

今回のリリースにより、2020-10バージョンが削除となりますので、互換性の確保のためAPIヘルスレポートのチェックと、今後の変更の確認を忘れずにお願いします。このバージョンに関連するAPI変更の全体リストは、2021-10リリースノート(英語)でご確認いただけます。

Shopifyマーチャント向けのアプリを構築する

Shopifyアプリストア向けのアプリ開発、カスタムアプリの開発サービス、ユーザーベースの成長促進、あなたが望むことがなんであれ、Shopifyパートナープログラムがその成功をサポートします。無料で登録して、教育リソース、開発者プレビュー環境、継続的な収益シェアプログラムを利用しましょう。

登録する

1 Cart API

これまで、Storefront APIでカートを管理する場合にいくつかの大きな障害がありました。リアルタイムで商品の在庫や価格、割引などを取得する唯一の方法は、チェックアウトの作成か更新でした。Shopifyは、お客さまの体験を高いレベルに維持するために慎重にチェックアウトを制限します。この「擬似カート」を管理するリクエストは、チェックアウトスロットルの制限にカウントされます。

2021-10バージョンでは、Storefront APIを使用してカートと直接やり取りすることが可能です。このCart APIは、ユーザビリティの飛躍的な進歩であり、お客さまの支払い準備ができるまではチェックアウトの作成を必要とせずに次の注文に関する文脈的なすべての情報を取得可能にします。さらに、これらのカートはチェックアウトスロットルに関連付けされません。かわりに、ほかのストアフロントのリクエストと同じスロットルが考慮されます。フラッシュセールはこのアップデートから大きなメリットを享受できます。チェックアウトのキューは、Storefront APIで作成されたカートで利用可能になりました。

Storefront APIでカートを作成するミューテーションの例がこちらです。

変数です：

その後にAPIは1つのカートデータを返します

Storefront APIでカートを管理する方法（英語）の詳細はドキュメントでご確認いただけます。

2 Storefront APIの改良

個別リソースを取得するのを簡単にするため、QueryRootに新しいフィールドが追加されました。たとえば、ブログ、コレクション、ページ、商品をIDやハンドルで直接クエリ可能です。このフィールドは、必要なリソースを素早く効率的に取得できるようにします。インデックスから返された全リソースのリストを探したり、検索エンドポイントを使ってGraphQLのレスポンスの各リソースごとにedgesとnodesを行ったり来たりする必要はありません。

以下は、個々の商品をハンドルから取得するGraphQLクエリの例です。

レスポンスがこちらです：

3 Bulk Operation Webhooks

以前のバージョンでは、Shopifyが処理を完了したときを知るには一括操作のステータスをポーリングする必要がありました。2021-10のリリースには、一括処理の完了、失敗、キャンセルについてクライアントに通知するwebhookが含まれています。webhookはAPIコール制限における一括操作の影響をさらに軽減し、一括操作のステータスを含むwebhookのレスポンスを待てばいいだけになっています。もうポーリングの必要はありません！

Bulk Operation Webhooksのサブスクリプションを作成するミューテーションの例が下記になります。花

一括操作が完了したら特定のURLに送信されるペイロードの例がこちらです。

詳しくは、ドキュメントのGraphQL Admin APIによるbulk operationの実行(英語)をご確認ください。

4 Manual Fulfillment Holds

2021-10バージョンには、Fulfillment Ordersを使用するクライアントのフルフィルメントワークフローをよりパワフルにするサポートが追加されています。Fulfillment Ordersは「hold」のアクションをサポート可能となり、バックオーダーや予約注文などのアイテムがフルフィルメントで利用可能となる前にアプリがフルフィルメントを保留に設定できます。

以下は、fulfillment orderをholdにするためのミューテーションの例です。

変数です:

こちらがレスポンスです:

これらの新しいアクションは、従来のfulfillment platformではなく、Fulfillment Ordersによって利用可能となります。わたしたちはフルフィルメントを操作するクライアントが従来のOrder Fulfillment EndpointではなくFulfillment Ordersを使っておこなうことを強く推奨します。

5 SMS Consent

APIクライアントは、SMSでマーケティング資料を受け取ることのお客さまの同意を取得、追加、更新できるようになりました。この設定を更新すると、CUSTOMERS_MARKETING_CONSENT_UPDATE webhookがトリガーされ、お客さまのマーケティング設定をつねに最新の状態で把握できます。

これらの設定は、customerSmsMarketingConsentUpdateミューテーションによって更新されます。下記がその例になります。

変数がこちら：

レスポンスです：

これはリマインドになりますが、マーケティングアクティビティを実行するすべてのアプリは、お客さまから収集したマーケティング設定に関してShopifyで顧客レコードを更新することが必須になっています。Shopifyにおけるお客さまのマーケティング設定情報が最新状態に保たれることで、ストアのすべてのアプリが個々の顧客マーケティング設定を尊重することができます。

利用可能なmarketing statesとオプトインレベルについての詳細は、customerSmsMarketingConsentUpdateミューテーション(英語)のドキュメントにあります。