【アプリ開発者必見】Shopify が提供する API 一覧

Shopify は、Shopify パートナーに向けて API を提供しています。Shopify が提供している API の種類は非常に豊富です。

Shopify のアプリを開発しようとしているの方は、どのような API が用意されているのか気になると思います。

今回は、アプリ開発パートナーが開発に使うことができる API について紹介します。

Shopify が提供する API 一覧

Shopify がアプリ開発用に提供している API は、非常に豊富です。アプリ開発者は、提供するサービスに必要な API を選んで利用することができます。

Shopify が提供する API は次のものになります。

• アクセス API
• 分析 API
• 請求 API
• 顧客管理 API
• 割引 API
• イベント API
• 在庫管理 API
• オンラインストア API
• 注文 API
• 拡張 API
• 製品管理 API
• 販売チャネル API
• 配送およびフルフィルメント API
• Shopify PaymentsAPI
• ストアプロパティ API

API を使ってできること

アクセス API（Access APIs）

販売者から与えられたアクセス表示・管理することができます。

StorefrontAccessToken

Storefront API にアクセスするために必要なストアアクセストークンを生成します。

AccessScope

アプリのインストール中に販売者が承認したアクセススコープを表示します。

分析 API（Analytics APIs）

販売者に詳細なレポートを提供し、ビジネスのパフォーマンスを分析できます。

AccessScope

Shopify 管理者のレポートを作成、更新、削除をします。各レポートは、

Shopify クエリ言語（ShopifyQL）で記述されたクエリから作成されます。

Shopify Query Language

利用可能な Shopify スキーマからデータをフェッチするクエリを記述します。ShopifyQL クエリは、レポート API を使用してレポートを公開するために使用できます。

請求 API（Billing APIs）

一回限りの料金、サブスクリプション手数料、従量制の手数料を収集して、アプリの支払いを受け取ります。

ApplicationCharge

アプリケーション料金を作成して、ショップに一度限りの料金を請求します。

RecurringApplicationCharge

ショップにアプリのサブスクリプション料金を請求します。請求は 30 日ごとに行われます。

UsageCharge

毎月のアプリの利用状況に応じて、様々な金額を請求することができます。

ApplicationCredit

特定のショップのアプリケーションクレジットの作成をリクエストします。

顧客管理 API（Customer APIs）

マーチャントが顧客データを管理するのに役立ちます。

CustomerSavedSearch

顧客の保存された検索を追加や更新することができます。保存された検索は、顧客をグループに整理し、管理画面から素早くアクセスできるようにするのに役立ちます。また、特定の割引コードを使用できる顧客など、顧客のセットを指定するのにも便利です。

Customer

顧客の住所やストアでアクティブな顧客アカウントを持っているかどうかなど、ストアの顧客に関する情報を追加または更新できます。

Customer Address

ストアの顧客アドレスを管理します。顧客は複数のアドレスを持つことができ、そのうちの 1 つは税金や送料の計算に使用されるデフォルトのアドレスです。

割引 API（Discount APIs）

マーチャントが柔軟な割引を提供するのに役立ちます。

DiscountCode

PriceRule API を使用して割引のロジックを設定した後、DiscountCode API を使用して割引をコードに関連付け、チェックアウト時に入力して割引を適用することができます。

PriceRule

割引のロジックを作成し、DiscountCode API を使用してコードを割引に関連付け、チェックアウト時に適用できるようにします。

イベント API（Event APIs）

イベントデータを取得するか、Webhook を登録して、アプリをマーチャントストアと同期させます。

Event

ショップの運営において重要なアクションであるイベントのリストを取得します。Shopify は様々なリソースのイベントを記録し、各リソースにはイベントを作成するアクションのセットがあります。

Webhook

Webhook を使用してイベントデータを取得および保存します。

在庫管理 API（Inventory APIs）

複数の場所の在庫を管理します。

InventoryLevel

ある場所での在庫商品の在庫レベルを取得または更新します。各在庫レベルは、単一の在庫商品遠場所に関連づけられてます。

InventoryItem

バリアントの在庫商品の在庫を一覧表示したり、更新したりします。各バリアントは 1 つの在庫商品を持つことができ、各在庫商品は多くの場所を持つことができます。店舗の場所は、売上を追跡したり、チェックアウト時に適用される税率を設定したりするために使用されます。

Location

マーチャントが設定した場所を Shopify 管理者から取得します。各場所は、企業の本社、小売店およびポップアップストアの住所を指します。ストアの場所は、売り上げを追跡し、チェックアウト時に適用される税率を構成するために使用されます。

オンラインストア API（Online store APIs）

マーチャントのオンラインフロントとそのコンテンツを更新します。

Page

オンラインストアの静的ページを作成および更新します。

Blog

ストアのブログを作成、編集、および削除します。各ストアには、複数のブログを含めることができ、各ブログには多くの記事を含めることができます。Article API を使用して、各ブログ記事を管理します。

ScriptTag

リモート JavaScript をオンラインストアのストアフロントページと注文ステータスページにロードして、ストアのテーマファイルを変更せずに機能を追加します。

Redirect

マーチャントのオンラインストアの 301 リダイレクトを管理します。

Article

ストアの記事を管理します。各記事はブログに属しており、多くのコメントをつけることができます。

Theme

オンラインストアの見た目と雰囲気をコントロールするストアのテーマを管理します。Asset API を使用して、テーマ内の特定ファイルを更新することができます。

Asset

ストアのテーマを構成するファイルを管理して、オンラインストアの外観を変更します。

Comment

記事に対する読者のコメントを管理します。各記事には多くのコメントをつけることができます。利用可能なアクションには、コメントの作成、コメントの更新、コメントの削除、コメントのスパムとしてのマーク付け、コメントの承認などがあります。

Sections

セクションテーマのアーキテクチャための REST API です。

注文 API（Order APIs）

マーチャントに新しい方法で注文を受け取り、処理し、管理します。

DraftOrder

マーチャントが顧客に代わって手動で注文を作成できるようにします。注文は、完了されるまで、Shopify の管理者に下書きとして保存されます。

Refund

注文の払い戻しを作成して取得します。各払い戻しは、顧客に返金されたお金の記録です。計算エンドポイントを使用して、作成した払い戻しが正確であることを確認します。

Transaction

注文のトランザクションを作成および更新します。取引は、両替につながる注文ごとに作成されます。

Order

ストアの注文を作成および更新します。各注文は、顧客、カート、およびトランザクションの詳細を含む完全な購入者の記録です。

Order Risk

注文の詳細ページに不正分析と推奨事項を表示します。

Abandoned checkouts

不完全なチェックアウトのリストを取得します。各 Checkout オブジェクトには、顧客が購入を完了することができるオンラインチェックアウトへの URL が含まれています。

プラス API（Plus APIs）

Shopify Plus 専用の API を使用して、GMV の高いマーチャント向けのカスタム機能を作成します。

Gift Card

ギフトカードコードを作成および管理します。このコードは、チェックアウト時に入力してギフトカードを使用して支払うことができます。

Multipass

複数のアプリケーションに渡る顧客の認証を管理して、それらのウェブサイトに単一のオグインエクスペリエンスを提供します。

User

スタッフアカウントの権限を取得します。Shopify 管理者から、マーチャントは各スタッフアカウントに、Shopify の一部へのアクセスを制御する完全なアクセス許可または個別のアクセス許可を与えることができます。

製品管理 API（Product APIs）

製品およびコレクション API を使用して、ストアのカタログにアクセスして操作します。

Product Variant

製品のバリエーションを追加または更新します。バリアントは、製品オプションの様々な組み合わせです。たとえば、サイズと色のオプションがある T シャツ製品には、小さいサイズと青い色のバリエーションがある場合があります。

Product Image

販売チャネルがユーザーに商品を表示するために使用する店舗の商品画像を追加または更新します。

Collect

カスタムコレクションを作成したら、商品ごとのコレクションを作成して、商品を追加します。各コレクションは、1 つの製品を 1 つのカスタムコレクションに関連づけます。

SmartCollection

選択条件を定義して、スマートコレクションを作成または更新します。条件に一致する商品は自動的にコレクションに含まれます。

Collection

ストアのコレクションを管理します。コレクションは、マーチャントが店舗を閲覧しやすくするために作成できる商品のグループです。

CustomCollection

ストアのカスタムコレクションを管理します。カスタムコレクションは、製品が選択条件を満たすために自動的に含まれるものではなく、手動で含まれるコレクションです。

Product

ストアで販売されるここおアイテムおよびサービスであるストアの製品を管理します。

販売チャネル API（Sales channel APIs）

独自の販売チャネルを作成します。販売チャネルは、モバイルアプリ、ウェブサイト、オンラインマーケットプレイスなどです。

Checkout

チェックアウトを作成しておよび更新して、販売チャネルにカスタムチェックアウトエクスペリエンスを提供します。

Payment

支払いを作成および更新して、販売チャネルにカスタムチャックアウトエクスペリエンスを提供します。

CollectionListing

販売チャネルに公開されているコレクションを管理し、それらの情報を取得します。

ProductListing

販売チャネルで利用可能な製品を管理し、それらの情報を取得します。

ResourceFeedback

アプリのエラーを解決するために必要なアクションについて販売者に通知します。

Product ResourceFeedback

商品のリソースのフィードバックにより、アプリケーションに関連するショップの個々の商品の状態を伝えることができます。

配送およびフルフィルメント API（Shipping and fulfillment APIs）

FulfillmentEvent

注文のフルフィルメントのためのフルフィルメントイベントを作成します。フルフィルメントイベントは注文ステータスページに表示されるため、顧客は配達の進行状況を追跡できます。

FulfillmentOrder

同じ場所から実行される順序でアイテムまたはアイテムのグループを管理します。フルフィルメントオーダーを取得してキャンセルするか、フルフィルメントオーダーを未完了としてマークするか、フルフィルメントオーダーを新しい場所に移動します。

CancellationRequest

フルフィルメントサービスに割り当てられたフルフィルメント注文のキャンセルリクエストフローを管理します。

Fulfillment

注文のラインアイテムのフルフィルメントを管理します。出荷ごとにフルフィルメントを作成し、追跡情報を提供して商品が出荷されたことを顧客に通知します。

FulfillmentRequest

フルフィルメントサービスに割り当てられたフルフィルメント注文のフルフィルメントリクエストフローを管理します。

CarrierService

カスタム配送サービスでチェックアウトする前に、リアルタイムの配送計算を提供します。

FulfillmentService

フルフィルメントサービスをストアに登録します。その後、マーチャントはそれを自社製品のフルフィルメントサービスとして設定でき、サービスは Fulfillment および FulfillmentEventAPI を使用してそれらの製品のフルフィルメントを管理できます。

AssignedFulfillmentOrder

アプリに割り当てられているショップのフルフィルメント注文を表示します。

LocationsForMove

フルフィルメントオーダーが移動する可能性のある場所を表示します。

Shopify PaymentsAPI（Shopify Payments APIs）

Transactions

ShopifyPayments の国際収支取引に関する情報を取得します。

Dispute

ShopifyPayments の揉め事に関する情報を取得します。

Payouts

ShopifyPayments の支払いに関する情報を取得します。

Balance

ShopifyPayments アカウントの現在の残高を表示します。

ストアプロパティ API（Store property APIs）

Shop

Shopify 管理者のマーチャントによって構成されたストアの一般設定と情報にアクセスします。

Country

チェックアウト時に該当するアイテムに適用される国および地域の税率を管理します。

Province

特定の州または州からの注文に適用される税率を管理します。

Policy

払い戻しポリシー、プライバシーポリシー、利用規約など、ショップのポリシーのリストを取得します。

Currency

有効な通貨のリストと、それらの換算レートが最後に更新された時刻を取得します。

ShippingZone

マーチャントが設定した配送ゾーンを Shopify 管理者から取得します。各配送ゾーンオブジェクトには、配送ゾーンに追加された国と地方、および設定された税率と配送料金が含まれます。

まとめ

今回は、Shopify が提供している API について紹介してみました。

それぞれの API ができることについては、こちらの公式ページで詳しく説明してありますので、是非ご覧ください。（説明は英語です）

【shopify developers】REST Admin API reference

最後までご覧いただき、ありがとうございました。