Zenn
👩‍💻

【Shopify.dev和訳】Storefront API/Reference/Online store

2021/10/23に公開
API
Shopify
GraphiQL
tech

この記事について

この記事は、Apps/Storefront API/Reference/Online storeの記事を和訳したものです。

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

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

オンラインストア API

オンラインストアを管理する。

このセクションでは

  • Article - オンラインストアのブログにある記事です。
  • ArticleAuthor - 記事の作成者です。
  • ArticleSortKeys - Article クエリの有効なソートキーのセットです。
  • Blog - オンラインストアのブログです。
  • BlogSortKeys - Blog クエリの有効なソートキーのセットです。
  • Comment - 記事に対するコメントです。
  • CommentAuthor - コメントの作成者です。
  • LocationAddress - ロケーションのアドレスを表します。
  • Page - Shopify マーチャントは静的な HTML コンテンツを保持するためにページを作成することができます。各 Page オブジェクトは、オンラインストアのカスタムページを表します。
  • PageSortKeys - ページクエリの有効なソートキーのセットです。
  • Shop - Shop はショップの一般的な設定と情報のコレクションを表します。
  • ShopPolicy - 返金やプライバシーポリシーなど、マーチャントがストア用に設定したポリシーです。

OBJECTS

Article(object)

オンラインストアのブログに掲載されている記事です。

このページについて

コネクション

comments (CommentConnection!)
記事に投稿されたコメントのリスト

引数 説明
after ( String ) 指定したカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルより前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
reverse ( Boolean ) 対象となるリストの順序を逆にします。
デフォルト値：false

metafields (MetafieldConnection!)
リソースに関連するメタフィールドのページングされたリスト。

引数 説明
after ( String ) 指定したカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルより前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
namespace ( String ) メタフィールドのセットのためのコンテナ（最大 20 文字）。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値：false

フィールド

authorV2 (ArticleAuthor)
記事の著者。

blog (Blog!)
記事が属しているブログ。

content (String!)
記事のストリップされたコンテンツ、HTML タグが削除された一行。

引数 説明
truncateAt ( Int ) 与えられた長さ以降の String）を切り捨てます。

contentHtml (HTML!)
HTML フォーマットを含む、記事のコンテンツ。

excerpt (String)
HTML タグを削除した 1 行の記事の抜粋。

引数 説明
truncateAt ( Int ) 与えられた長さ以降の String）を切り捨てます。

excerptHtml (HTML)
HTML フォーマットを含む、記事の抜粋。

handle (String!)
記事のタイトルから自動的に生成された、人間に優しいユニークな String）。

id (ID!)
グローバルに一意な識別子。

image (Image)
記事に関連する画像。

引数 説明
crop ( CropRegion ) 指定された領域に従って画像を切り取ります。この引数は非推奨です。代わりに Image.transformedSrc の crop を使用してください。
maxHeight ( Int ) 画像の高さを 1 から 2048 までのピクセル数で指定します。この引数は推奨されません。代わりに Image.transformedSrc の maxHeight を使用してください。
maxWidth ( Int ) 1 から 2048 までのピクセル単位での画像の幅。この引数は推奨されません。代わりに Image.transformedSrc の maxWidth を使用してください。
scale ( Int ) 高解像度の Retina ディスプレイ用の画像サイズの乗数。1 から 3 までの値でなければなりません。この引数は推奨されません。代わりに Image.transformedSrc の scale を使用する。
デフォルト値：1

metafield (Metafield)
namespace と key で見つかった metafield を返します。

引数 説明
key ( String! ) required メタフィールドの識別子（最大 30 文字）。
namespace ( String! ) required メタフィールドのセットのためのコンテナ（最大 20 文字）。

publishedAt (DateTime!)
記事が公開された日付と時間。

seo (SEO)
記事の SEO 情報です。

tags ([String!]!)
記事がタグ付けできるカテゴリー分類。

title (String!)
記事の名前。

url (URL!)
ウェブからアクセス可能な記事を指し示す URL。

Article を返す型

実装するもの

非推奨のフィールド

複数の記事をページングするために自動生成されるタイプ。

このページについて

フィールド

edges ([ArticleEdge!]!)
エッジのリスト。

pageInfo (PageInfo!)
ページネーションを助けるための情報。

自動生成されたタイプで、ページネーションの際に 1 つのアーティクルとカーソルを保持します。

このページでは

フィールド

cursor (String!)
ページネーションで使用するためのカーソル。

node (Article!)
ArticleEdge の末尾にある項目。

ArticleEdge を返す型

ArticleAuthor(object)

記事の著者

このページについて

フィールド

bio (String)
著者の経歴。

email (String)
著者の E メール

firstName (String!)
著者のファーストネーム

lastName (String!)
著者のラストネーム

name (String!)
著者のフルネーム。

ArticleAuthor を返す型

Blog(object)

オンラインストアのブログです。

このページについて

コネクション

articles (ArticleConnection!)
ブログの記事のリスト。

引数 説明
after ( String ) 指定したカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query ( String ) サポートされているフィルタパラメータです。
・author
・blog_title
・created_at
・tag
・updated_at
フィルターの使い方については、詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値：false
sortKey ( ArticleSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値は ID

metafields (MetafieldConnection!)
リソースに関連するメタフィールドのページングされたリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルより前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
namespace ( String ) メタフィールドのセットのためのコンテナ（最大 20 文字）。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値：false

フィールド

articleByHandle (Article)
ハンドルによる記事の検索。

引数 説明
handle ( String! ) required 記事のハンドル。

authors ([ArticleAuthor!]!)
ブログに寄稿した著者。

handle (String!)
タイトルから自動的に生成された、ブログの人間に優しいユニークな文字列。

id (ID!)
グローバルに一意な識別子。

metafield (Metafield)
名前空間とキーで見つかったメタフィールドを返します。

引数 説明
key ( String! ) required メタフィールドの識別子（最大 30 文字）。
namespace ( String! ) required メタフィールドのセットのためのコンテナ（最大 20 文字）。

seo (SEO)
ブログの SEO 情報を表示します。

title (String!)
ブログのタイトルを指定します。

url (URL!)
ウェブからアクセス可能なブログを指し示す URL。

Blog を返す型

インプリメント

複数の Blog をページングするために自動生成されたタイプです。

このページについて

フィールド

edges ([BlogEdge!]!)
エッジのリスト。

pageInfo (PageInfo!)
ページネーションを助けるための情報。

自動生成されるタイプで、ページネーションの際に 1 つのブログとカーソルを保持します。

このページについて

フィールド

cursor (String!)
ページネーションで使用するためのカーソル。

node (Blog!)
BlogEdge の最後にある項目。

BlogEdge を返す型

Comment(object)

ある記事に対するコメントです。

このページ内

フィールド

author (CommentAuthor!)
コメントの作者。

content (String!)
HTML タグが削除された 1 行のコメントのストリップされたコンテンツ。

引数 説明
truncateAt ( Int ) 与えられた長さ以降の文字列を切り捨てます。

contentHtml (HTML!)
HTML フォーマットを含む、コメントのコンテンツ。

id (ID!)
グローバルに一意な識別子。

Comment を返す方

インプルメント

  • Node
    複数の Comment をページングするために自動生成された型。

このページについて

フィールド

edges ([CommentEdge!]!)
エッジのリスト。

pageInfo (PageInfo!)
ページネーションを助けるための情報。

自動生成されるタイプで、ページネーションの際に 1 つの Comment とカーソルを保持します。

このページでは

フィールド

cursor (String!s)
ページネーションで使用するためのカーソル。

node (Comment!)
CommentEdge の末尾にある項目。

CommentEdge を返す型

CommentAuthor(object)

コメントの著者。

このページについて

フィールド

email (String!)
作者のメールアドレス。

name (String!)
作者の名前。

CommentAuthor を返す型

LocationAddress(object)

ロケーションのアドレスを表します。

このページについて

フィールド

address1 (String)
ロケーションの住所の 1 行目。

address2 (String)
その場所の住所の 2 行目。

city (String)
位置情報の都市名。

country (String)
位置情報の国名。

countryCode (String)
位置情報の 2 文字の国コード。

formatted ([String!]!)
場所の住所のフォーマットされたバージョン。

latitude (Float)
位置情報の緯度座標です。

longitude (Float)
位置情報の経度座標。

phone (String)
位置情報の電話番号。

province (String)
位置情報の都道府県名。

provinceCode (String)
住所の地域を表すコード（都道府県、州、区など）。例えば、QC はカナダのケベック州を意味します。

zip (String)
位置情報の郵便番号。

LocationAddress を返す型

Page(object)

Shopify のマーチャントは、静的な HTML コンテンツを保持するページを作成できます。各ページオブジェクトは、オンラインストアのカスタムページを表します。

このページについて

コネクション

metafields (MetafieldConnection!)
リソースに関連するメタフィールドのページングされたリスト。

引数 説明
after ( String ) 指定したカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルより前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
namespace ( String ) メタフィールドのセットのためのコンテナ（最大 20 文字）。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値：false

フィールド

body (HTML!)
HTML フォーマットを含む、ページの説明。

bodySummary (String!)
ページ本体の概要。

createdAt (DateTime!)
ページ作成時のタイムスタンプ。

handle (String!)
タイトルから自動的に生成された、人間に優しいページのユニークな文字列。

id (ID!)
グローバルに一意な識別子。

metafield (Metafield)
名前空間とキーで見つかったメタフィールドを返します。

引数 説明
key ( String! ) required メタフィールドの識別子（最大 30 文字）。
namespace ( String! ) required メタフィールドのセットのためのコンテナ（最大 20 文字）。

seo (SEO)
ページの SEO 情報です。

title (String!)
ページのタイトルを指定します。

updatedAt (DateTime!)
最新のページ更新のタイムスタンプ。

url (URL!)
ウェブからアクセスできるページを指し示す URL。

Page を返す型

インプリメント

  • HasMetafields
  • Node
    複数の Pages をページングするために自動生成されるタイプです。

このページについて

フィールド

edges ([PageEdge!]!)
エッジのリスト。

pageInfo (PageInfo!)
ページネーションを補助する情報。

自動生成されたタイプで、ページネーションの際に 1 つのページとカーソルを保持します。

このページについて

フィールド

curdor (String!)
ページネーションで使用するためのカーソル。

node（Page!)
PageEdge の最後にある項目。

PageEdge を返す型

Shop(object)

Shop は、ショップの一般的な設定や情報の集まりを表します。

このページについて

コネクション

metafields (MetafieldConnection!)
リソースに関連するメタフィールドのページングされたリスト。

引数 説明
after ( String ) 指定したカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルより前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
namespace ( String ) メタフィールドのセットのためのコンテナ（最大 20 文字）。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値：false

フィールド

description (String)
ショップの説明。

metafield (Metafield)
名前空間とキーで見つかったメタフィールドを返します。

引数 説明
key ( String! ) required メタフィールドの識別子（最大 30 文字）。
namespace ( String! ) required メタフィールドのセットのためのコンテナ（最大 20 文字）。

moneyFormat (String!)
通貨が指定されていない場合の通貨のフォーマット方法を表す文字列です。

name (String!)
ショップの名前。

paymentSettings (PaymentSettings!)
支払いに関する設定。

primaryDomain (Domain!)
ショップのプライマリドメインを指定します。

privacyPolicy (ShopPolicy)
ショップのプライバシーポリシー。

refundPolicy (ShopPolicy)
ショップの返金ポリシー

shippingPolicy (ShopPolicy)
ショップの配送に関するポリシー

shipsToCountries ([CountryCode!]!)
ショップが配送する国

termsOfService (ShopPolicyap)
ショップの利用規約を指定します。

Shop を返す型

インプリメント

非推奨のフィールド

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query ( String ) サポートされているフィルタパラメータです。
・author
・blog_title
・created_at
・tag
・updated_at
フィルターの使い方については、詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値：false
sortKey ( ArticleSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値は ID
  • blogs (BlogConnection!) deprecated
    ショップのブログのリスト。
引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query ( String ) サポートされているフィルタパラメータです。
・created_at
・handle
・title
・updated_at
フィルターの使い方については、詳細な検索構文を参照してください。
reverse ( Boolean ) 対象となるリストの順序を逆にします。
デフォルト値：false
sortKey ( BlogSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値は ID
  • collectionByHandle (Collection) deprecated
    ハンドルでコレクションを検索します。
引数 説明
handle ( String! ) required コレクションのハンドルです。
引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query ( String ) サポートされるフィルタパラメータ。
・collection_type
・title
・updated_at
フィルターの使い方の詳細は、詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値：false
sortKey ( CollectionSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値は ID
  • currencyCode (CurrencyCode!) deprecated
    ショップが受け入れている通貨の 3 文字コード。
  • productByHandle (Product) 非推奨
    ハンドルネームで商品を検索します。
引数 説明
handle ( String! ) required 製品のハンドルです。

製品に追加されている tag のリストです。追加のアクセススコープが必要：unauthenticated_read_product_tags

引数 説明
first ( Int! ) required リストから最初の n 個の要素までを返します。

ショップの商品タイプのリスト。

引数 説明
first ( Int! ) required リストから最初の n 個の要素までを返します。
引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query ( String ) サポートされるフィルタパラメータ。
・available_for_sale
・created_at
・product_type
・tag
・title
・updated_at
・variants.price
・vendor
フィルターの使い方については、詳細な検索構文を参照してください。
reverse ( Boolean ) 対象となるリストの順序を逆にします。
デフォルト値：false
sortKey ( ProductSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値は ID
  • shopifyPaymentsAccountId (String) deprecated
    ショップの Shopify Payments アカウント ID です。

ShopPolicy(object)

返金やプライバシーポリシーなど、マーチャントがストア用に設定したポリシーです。

このページについて

フィールド

body (String)
ポリシーのテキスト、最大サイズは 64kb です。

handle (String!)
ポリシーのハンドル。

id (ID!)
グローバルに一意な識別子です。

title (String!)
ポリシーのタイトル。

url (URL!)
ポリシーのパブリック URL。

ShopPolicy を返す型

インプリメント

ENUMS

ArticleSortKeys(enums)

Article クエリの有効なソートキーのセットです。

値

  • AUTHOR
    autherの値でソートします。

  • BLOG_TITLE
    blog_titleの値でソートします。

  • ID
    IDの値でソートします。

  • PUBLISHED_AT
    published_atの値でソートします。

  • RELEVANCE
    検索時（接続時にquery・パラメータが指定されている場合）に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソートキーは決定性がないため、使用しないでください。

  • TITLE
    titleの値でソートします。

  • UPDATED_AT
    updated_at の値でソートします。

BlogSortKeys(enums)

Blog クエリの有効なソートキーのセット。

値

  • HANDLE
    handleの値でソートします。

  • ID
    id の値でソートします。

  • RELEVANCE
    検索時（接続時にquery・パラメータが指定されている場合）に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソート・キーは決定論的ではないので使用しないでください。

  • TITLE
    titleの値でソートします。

PageSortKeys(enums)

Page クエリの有効なソートキーのセット。

値

  • ID
    id値でソートします。

  • RELEVANCE
    検索時（接続時にquery・パラメータが指定されている場合）に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソート・キーは決定論的ではないので使用しないでください。

  • TITLE
    titleの値でソートします。

  • UPDATED_AT
    updated_at の値でソートします。

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

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