🧑‍💻

【Shopify.dev和訳】Ajax API/Overview

2021/09/12に公開約2,800字

この記事について

この記事は、Ajax API/Overviewの記事を和訳したものです。

記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

https://apps.shopify.com/shopify-application-314?locale=ja&from=daniel

Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

https://apps.shopify.com/font-picker-1?locale=ja&from=daniel

Shopify Ajax API

Ajax API は、Shopify テーマを開発するための軽量な REST API エンドポイント群を提供します。

ユースケース

Ajax API の使用例としては、以下のようなものが考えられます。

  • 商品をカートに入れ、カートの商品カウンターを更新する。
  • おすすめの関連商品を表示する。
  • 訪問者が検索フィールドに入力すると、製品やコレクションを提案する。

利用可能な API エンドポイントの一覧は、Ajax API リファレンスを参照してください。

API へのリクエスト

Ajax API は、2 種類の HTTP リクエストを受け付けます。

  • カートと一部の製品データを読み込むための GET リクエスト
  • 現在のセッションでカートを更新するための POST リクエスト

例えば、現在のカートの内容を取得するには、クライアントサイドのリクエストをストアの /cart.js エンドポイントに送信します。

var cartContents = fetch("/cart.js")
  .then((response) => response.json())
  .then((data) => {
    return data
  })

要件と制限

  • 本 API は、認証されていない API です。アクセスにアクセストークンや API キーは必要ありません。
  • また、Ajax API にはレートの制限はありません。ただし、Shopify の標準的な API 乱用防止策の対象となります。
  • すべての API レスポンスは JSON 形式のデータを返します。
  • Ajax API は、顧客や注文データの読み取りや、店舗データの更新には使用できません。より広範なアクセスが必要な場合は、Admin API をご確認ください。

チュートリアル


以下は、Shopify Ajax API referenceの和訳です。

Shopify Ajax API reference

Shopify の Ajax API は、Shopify テーマで使用することができ、購入者がページを更新することなく、カートにアイテムを追加したり、おすすめ商品を表示したりといったアクションを実行することができます。

Ajax API には、以下のエンドポイントがあります。

  • Cart - カートのラインアイテム、属性、およびノートを更新します。
  • Product - カタログ内の任意の製品に関する情報をフェッチします。
  • Product Recommendations - 製品ページにおすすめの製品を表示します。
  • Predictive Search - 購入者が検索キーワードを入力すると、製品、コレクション、ページ、記事を提案します。

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

https://apps.shopify.com/shopify-application-314?locale=ja&from=daniel

Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

https://apps.shopify.com/font-picker-1?locale=ja&from=daniel

Discussion

ログインするとコメントできます