見出し画像

Shopify APIを叩いてみよう 〜注文一覧取得APIを叩く方法〜

TALO@Shopifyアプリエンジニア

今回は、Shopify APIを叩くはじめの第一歩目として、プライベートアプリの作成からPostmanで注文一覧取得apiを叩き、レスポンスを取得するところまでを順を追って解説したいと思います。

StoreFront APIを用いたアプリケーションの開発はこちらから。


それでは、やっていきましょう。


プライベートアプリの作成

まずはshopoify管理画面を開き、左のメニューから「アプリ管理」を選択します。

アプリ管理

右側の、「アプリを開発」をクリック。

アプリを開発

サイトに紐づいているアプリが表示される画面にて、「アプリを作成」ボタンをクリック

アプリを作成

任意のアプリ名を入力しましょう

アプリ名を入力

これで、apiを使用できるアプリが作成されました。
次に、apiを叩く上で必須の、アクセストークンの作成を行っていきます。


アクセストークンの作成

Admin APIを叩く際、認証としてアクセストークンをAPIリクエストに付与して送信する必要があります。そのために、アクセストークンを作成しましょう。

「API資格情報」から、「アプリをインストール」ボタンをクリックします。

アプリをインストール

インストール」をクリック。

インストール

インストールが終わると、アプリの設定についてのタブが新たに表示されます。タブの中から「API資格情報」を選択し、Admin APIのアクセストークンをメモします。
このアクセストークンは、APIをリクエストする際に必須なので、必ずメモで残しておきましょう。

トークンを一度開示し、メモ


これで、管理画面側での設定が終わりました。

APIを叩いてみよう

次は、設定したアプリに対して、実際にAPIリクエストをしてみましょう。
今回は、注文情報を全件取得するAPIをリクエストします。

テストとして、以下の2件の注文情報を作成し、実際に情報を取得できるか試します。

注文管理画面

注文情報に関する情報のやりとりは、Order APIで行うことができます。


叩くエンドポイントのURLは、以下になります。
https://[あなたのサイトのURL].myshopify.com/admin/api/2022-04/orders.json

そしてpostmanを開き、GETリクエストで上記のエンドポイントを入力、そしてHeaders情報に以下の二つのヘッダーを追記します。

Content-Type: application/json
X-Shopify-Access-Token: メモしたアクセストークン

特に、「X-Shopify-Access-Token: メモしたアクセストークン」はお忘れなく。ここが抜けると認証が通らずにAPIリクエストが受付けられません

それでは送信してみましょう。

status 200 OKと、レスポンスボディに"orders"というキーのオブジェクトが返却されていれば成功です。

レスポンス情報


今回はshopify APIをpostmanで叩く流れをざっと解説しました。ご一読ありがとうござした。


関連記事


この記事が気に入ったら、サポートをしてみませんか?
気軽にクリエイターの支援と、記事のオススメができます!
TALO@Shopifyアプリエンジニア
Shopifyアプリを開発しています。カスタムアプリや、ストアフロントの開発を得意としています。 お問い合わせ: https://forms.gle/B3BWQX2Hk1aSorpf8