shopify

shopifyが対応するAPIとは

人気のECサイト作成サービスShopifyはAPIを提供しています。このAPIを利用すれば独自アプリの開発や既存アプリとの連携を行うことができます。

本日はそんなShopifyのAPIについて解説します。

  • Shopifyアプリの開発者
  • APIについて知りたい方

これらに当てはまる方におすすめの記事となっています。これを読めばShopifyで利用できるAPIがまる分かりですよ。

shopifyが対応するAPIとは

APIとは「Application Programming Interface」のことを指します。ソフトウェアやアプリケーションなどの一部を外部に向けて公開することにより、誰かが開発した機能を利用することができるようになります。

簡単に言えば、外部のサービスを連携することができる機能ということです。ShopifyのAPIは様々用意されていて、これを組み合わせたものがShopifyアプリになっていきます。

ShopifyAPIを利用して開発者はより良い機能やサービスを提供することが可能になります。

代表的なAPI

ここからはShopifyの代表的なAPIを紹介していきます。

アクセスAPI

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

StorefrontAccessToken

ストアトークンを作成し、それをJavaScriptやモバイルアプリケーションなどの消費側クライアントに渡すことができます。

AccessScope

アプリのインストール中に事業者が承認したアクセススコープを表示することができます。

さらにレポートを作成、更新、削除するこができ、情報の分析に役立てることも可能です。

オンラインストアAPI

事業者とオンラインフロントとのコンテンツを更新することができます。

Blog

ストアのブログを作成することができます。

Page

ストアのページを作成&更新することができます。

Article

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

Comment

記事のコメントを管理するAPIです。コメントの作成や更新、削除だけでなく、スパムへのマーク付けやコメントの承認なども可能です。

Storefront API

ストアから商品情報を取り出してきたり、注文を入れることができます。

請求API

DiscountCode

PriceRule DiscountCodeリソースを使用して、特定の割引を利用できるようにする割引コードを作成できます。

PriceRule

条件を使用して割引を作成できます。具体的には割引をパーセンテージ、固定金額、または送料無料として指定することが可能。

Shopify Billing API

アプリ開発者が事業者に請求を行う際に利用することができます。

ApplicationCharge

ApplicationChargeは一回きりの請求を行うことができます。このタイプの料金は、定期的に請求されないアプリに推奨されます。

RecurringApplicationCharge

月額費用など定期的な請求に対して利用されます。新しい定期申請料金が有効になると、既存の定期料金はキャンセルされ、新しい料金に置き換えられるようになります。

顧客管理API

顧客データの管理に使用することができます。

CustomerSavedSearch

ショップの所有者によって定義された顧客のグループを表す検索クエリです。

Customer

連絡先の詳細、注文履歴、電子メールマーケティングの受信に同意したかどうかなど、ショップの顧客に関する情報をストックすることができるAPIです。

Customer Address

顧客の住所を取得、蓄積、更新することができます。

イベントAPI

Event

記事の作成、注文の履行、製品の追加などの特定のアクションが完了すると、一部のShopifyリソースによって生成されます。

イベントをリクエストすることで、アプリはショップで特定のアクションが発生したことを知ることができます。

在庫管理API

InventoryLevel

特定の場所での在庫アイテムの利用可能な数量を表します。

InventoryItem

顧客に出荷できる物理的な商品を表します。SKUや在庫が追跡されているかどうかなど、物理的な商品に関する重要な情報を保持しています。

Location

店舗、ポップアップストア、本社、および倉庫が存在する地理的な場所を取得します。

注文API

DraftOrder

DraftOrderリソースを使用して、事業者が顧客に代わって注文を作成できるようにすることができます。

Refund

注文の払い戻しリストを制作、計算することができるAPIです。

Order

Orderリソースを使用して、注文を作成、取得、更新、および削除できます。

Abandoned checkouts

Checkoutリソースにクエリを実行して、放棄されたチェックアウトを返すことができます。

製品管理API

Product Variant

製品バリエーションの取得、制作、削除を行うことができるAPIです。

Product Image

製品にも最大250の画像を含めることができ、画像は.png、.gif、または.jpg形式にすることが可能になります。

Collect

商品ごとのコレクションを作成して、商品を追加することができます。

Collection

ストアのコレクションを管理することができます。

Product

ストアの製品を管理します。

販売チャネルAPI

Checkout

チェックアウトを作成、更新します。

Payment

支払いを作成、管理して販売チャネルに追加することができます。

Product ResourceFeedback

アプリでショップとそのリソースのステータスをレポートできるAPIです。

配送API

FulfillmentEvent

特定のフルフィルメントに関連付けられているすべてのフルフィルメントイベントのリストを取得したり、更新、削除することができるAPIです。

CancellationRequest

CancellationRequestリソース は、フルフィルメント注文のフルフィルメントサービスに対して事業者よって行われたキャンセル要求を表します。

まとめ

いかがでしたか。本日はShopifyのAPIについて、代表的なものを紹介していきました。

APIは日々更新され、新しいものが続々と登場しています。

Shopifyの公式ブログなどでリリース情報も公開しているので、合わせてチェックしてみるのも良いかもしれません。

Shopify 14日間 無料体験

オンラインストアをこれから始めたい方におすすめなのがshopifyです。

ブランドイメージやストアの目的に合わせて、デザインテーマやアプリを選択し自分好みのストアを作成することができます。

初めての方でも、感覚的に作成することができますので、まずは無料体験してみて下さい。