📈

【Shopify.dev和訳】 Admin API/GraphQL reference/Online store

2021/10/01に公開

この記事について

この記事は、Admin API/GraphQL 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

Online store APIs

Online store API はマーチャントのオンラインストアフロントとそのコンテンツを更新することができます。

Online store APIs Overview

  • Domain - インターネット上の Shopify ストアのアドレスを表す文字列(ドメイン)です。

  • DomainLocalization - ドメインに割り当てられた国と言語の設定です。

  • OnlineStoreArticle - OnlineStoreBlog オブジェクトの記事を表します。記事は年代を降順に表示され、最新のエントリーがブログのページの一番上に表示されます。ブログは任意の数の記事を含むことができます。現在のところ、OnlineStoreArticleを使用して、記事のidtagsAddmutation に渡すことしかできません。詳細については、tagsAddの mutation を参照してください。

  • OnlineStoreBlog - Shopify ストアにはブログエンジンが組み込まれており、ショップは 1 つまたは複数のブログを持つことができます。ブログは、ショップの雑誌やニュースレターのように使用することができ、コンテンツは時間とともに変化します。

  • OnlineStorePage - オンラインストアのカスタムページです。

  • SEO - SEO 情報です。

  • SEOInput - SEO に関する情報です。

  • ScriptTag - スクリプトタグは、ショップのストアフロントのページやチェックアウトのオーダーステータスページに読み込まれるリモートの JavaScript コードを表します。

  • ScriptTagDisplayScope - スクリプトが含まれるべきオンラインショップのページまたはページ。

  • ScriptTagInput - スクリプトタグの入力フィールドを指定します。

  • UrlRedirect - オンラインストア上のリダイレクトです。

  • UrlRedirectImport - オンラインストアにリダイレクトをインポートする要求です。

  • UrlRedirectImportPreview - URL リダイレクトのインポート行のプレビューです。

  • UrlRedirectInput - リダイレクト用の入力フィールドです。

  • UrlRedirectSortKeys - UrlRedirect クエリの有効なソートキーのセットです。

  • scriptTagCreate - 新しいスクリプトタグを作成します。

  • scriptTagDelete - スクリプトタグを削除する。

  • scriptTagUpdate - スクリプトタグの更新を行います。

  • urlRedirectBulkDeleteAll - リダイレクトを一括して非同期に削除します。

  • urlRedirectBulkDeleteByIds - リダイレクトを一括して非同期に削除します。

  • urlRedirectBulkDeleteBySavedSearch - 非同期的に一括でリダイレクトを削除します。

  • urlRedirectBulkDeleteBySearch - 非同期的にリダイレクトを一括で削除します。

  • urlRedirectCreate - リダイレクトを作成します。

  • urlRedirectDelete - リダイレクトを削除します。

  • ullRedirectImportCreate - URL リダイレクトのインポートを作成します。

  • urlRedirectImportSubmit - 処理される URL リダイレクトインポートを送信します。

  • urlRedirectUpdate - リダイレクトを更新します。


OBJECTS

Domain (object)

インターネット上の Shopify ストアのアドレスを表すユニークな文字列。

Fields

host ( String! )
ドメインのホスト名です(例:example.com)。

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

localization ( DomainLocalization )
リダイレクトしない場合のドメインのローカライズ。

sslEnabledBoolean! )
SSL が有効であるかどうか。

url ( URL! )
ドメインの URL (例: https://example.com)。

Domainの返すタイプ

Implements

Samples

query
# ドメインのIDを取得する
{
  shop {
    domains {
      id
    }
  }
}
response
{
  "data": {
    "shop": {
      "domains": [
        {
          "id": "gid://shopify/Domain/33896136726"
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 2,
      "actualQueryCost": 2,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 998,
        "restoreRate": 50
      }
    }
  }
}

DomainLocalization (object)

ドメインに割り当てられている国と言語の設定。

Fields

alternateLocales ( [String!]! )
ドメインの代替 locale の ISO コード。

country ( String )
ドメインに割り当てられている国の ISO コード、またはドメインが "Rest of world "に設定されている場合は "*"となります。

defaultLocale ( String! )
ドメインのデフォルトロケールの ISO コードです。

DomainLocalizationの返すタイプ

OnlineStoreArticle (object)

OnlineStoreBlog オブジェクトの記事を表しています。記事は逆の年代順に表示され、最新のエントリーがブログのページのトップに表示されます。ブログにはいくつでも記事を含めることができます。現在、OnlineStoreArticleを使用して、記事 ID をtagsAddmutation に渡すことしかできません。詳細については、tagsAdd mutation を参照してください。

Fields

defaultCursor ( String! )
ID で昇順にソートされた単一の次のレコードを返すデフォルトのカーソルです。

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

translations ( [PublishedTranslation!]! )
リソースに関連付けられた翻訳。

引数 説明
localeString! ) 翻訳ロケールをフィルタリングします。

Implements

OnlineStoreBlog (object)

Shopify ストアにはブログエンジンが内蔵されており、ショップは 1 つまたは複数のブログを持つことができます。ブログは、お店の雑誌やニュースレターのようなもので、内容は時間とともに変化します。

Fields

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

translations ( [PublishedTranslation!]! )
リソースに関連付けられた翻訳。

引数 説明
locale ( String! ) required 翻訳ロケールをフィルタリングします。

Implements

OnlineStorePage (object)

オンラインストアのカスタムページです。

Fields

defaultCursor ( String!)
ID で昇順にソートされた単一の次のレコードを返す、デフォルトのカーソルです。

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

translations ( [PublishedTranslation!]! )
リソースに関連付けられた翻訳です。

引数 説明
locale ( String! ) required 翻訳ロケールをフィルタリングします。

Implements

ScriptTag (object)

script タグは、ショップのストアフロントやチェックアウトの注文状況のページに読み込まれる、リモートの JavaScript コードを表します。

Fields

cache ( Boolean! )
Shopify CDN が script タグをキャッシュして提供できるかどうか。true の場合、スクリプトは CDN によってキャッシュされ、提供されます。キャッシュは script タグが正常に返されてから 15 分後に期限切れとなります。false の場合は、スクリプトがそのまま提供されます。

createdAt ( DateTime! )
スクリプトタグが作成された日付と時間。

displayScope ( ScriptTagDisplayScope! )
スクリプトが含まれるべきオンラインストア上のページまたはページ。

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

legacyResourceId ( UnsignedInt64! )
REST Admin API の対応するリソースの ID。

src ( URL! )
リモートスクリプトへの URL。

updatedAt ( DateTime! )
スクリプトタグが最後に更新された日付と時間。

ScriptTagの返すタイプ

Mutations for ScriptTag

scriptTagCreate
新しいスクリプトタグを作成する。

scriptTagDelete
スクリプトタグを削除する。

scriptTagUpdate
スクリプトタグを更新する。

Implements

Samples

query
# スクリプトタグの最初の10個を取得する
{
  scriptTags(first:10) {
    edges {
      node {
        id
      }
    }
  }
}
response
{
  "data": {
    "scriptTags": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/ScriptTag/41734045718"
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 12,
      "actualQueryCost": 3,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 997,
        "restoreRate": 50
      }
    }
  }
}

SEO (object)

SEO 情報です

Fields

description ( String )
SEO の説明。

title ( String )
SEO のタイトル。

SEOの返すタイプ

UrlRedirect

オンラインストアのリダイレクトです。

Fields

id ( ID! )
URL リダイレクトの ID です。

path ( String! )
リダイレクトされる古いパス。ユーザーがこのパスにアクセスすると、ターゲットにリダイレクトされます。

target ( String! )
ユーザーがリダイレクトされるターゲットの場所。

UrlRedirectの返すタイプ

Mutations for UrlRedirect

urlRedirectBulkDeleteAll
非同期的にリダイレクトを一括で削除します。

urlRedirectBulkDeleteByIds
リダイレクトを一括で非同期に削除します。

urlRedirectBulkDeleteBySavedSearch
リダイレクトを一括で非同期に削除します。

urlRedirectBulkDeleteBySearch
非同期的にリダイレクトを一括で削除します。

urlRedirectCreate
リダイレクトを作成します。

urlRedirectDelete
リダイレクトを削除します。

urlRedirectUpdate
リダイレクトを更新します。

Implements

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

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

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

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

UrlRedirectEdgeについて
Fields

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

node ( UrlRedirect! )
UrlRedirectEdge の末尾の項目。

UrlRedirectEdge の返すタイプ

UrlRedirectImport

リダイレクトをオンラインストアに取り込むための request です。

Fields

count ( Int )
ファイル内の行数です。

createdCountInt )
このインポートから作成されたリダイレクトの数。

failedCountInt )
このインポートからのインポートに失敗したリダイレクトの数です。

finished ( Boolean! )
インポートが終了したかどうか。

finishedAt ( DateTime )
インポートが終了した日付と時間。

id ( ID! )
URL リダイレクト インポートの ID。

previewRedirects ( [UrlRedirectImportPreview!]! )
インポートされる URL リダイレクトのプレビューを 3 つまで指定します。

updatedCount ( Int )
このインポート中に更新されたリダイレクトの数。

UrlRedirectImport の返すタイプ

UrlRedirectImportの Mutations

urlRedirectImportCreate
URL リダイレクトインポートを作成します。

urlRedirectImportSubmit
処理される URL リダイレクト インポートを送信します。

Implements

UrlRedirectImportPreview (object)

URL リダイレクトインポートの行のプレビューです。

Fields

path ( String! )
リダイレクトされる古いパスです。ユーザーがこのパスにアクセスすると、ターゲットにリダイレクトされます。

target ( String! )
ユーザーがリダイレクトされるターゲットの場所。

UrlRedirectImportPreviewの返すタイプ


MUTATIONS

scriptTagCreate (mutation)

新しいスクリプトタグを作成します。

mutation query を実行した例です。

query
mutation scriptTagCreate($input: ScriptTagInput!) {
  scriptTagCreate(input: $input) {
    scriptTag {
      id
    }
    userErrors {
      field
      message
    }
  }
}
Variables
{
  "input": {}
}

引数

引数 説明
input ( ScriptTagInput! ) required スクリプトタグの入力フィールドを指定する。

ScriptTagInput fields

cache ( Boolean )
Shopify CDN が script タグをキャッシュして提供できるかどうか。true の場合、スクリプトは CDN によってキャッシュされ、提供されます。キャッシュは script タグが正常に返されてから 15 分後に失効します。false の場合は、スクリプトはそのまま提供されます。

displayScopeScriptTagDisplayScope )
スクリプトが含まれるべきオンラインストア上のページまたはページ。

src ( URL )
リモートスクリプトの URL。

Return fields

scriptTag (ScriptTag)
作成されたスクリプトタグです。

userErrors ( [UserError!]! )
mutation を実行した際に発生したエラーのリスト。

scriptTagDelete (mutation)

スクリプトタグを削除します。

mutation query を実行した例です。

query
mutation scriptTagDelete($id: ID!) {
  scriptTagDelete(id: $id) {
    deletedScriptTagId
    userErrors {
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
id ( ID! ) required 削除するスクリプトタグの ID を指定します。

Return fields

deletedScriptTagId ( ID )
削除されたスクリプトタグの ID です。

userErrors ( [UserError!]! )
mutation を実行した際に発生したエラーのリスト。

scriptTagUpdate (mutation)

スクリプトたぐを更新する

mutation query を実行する例です。

query
mutation scriptTagUpdate($id: ID!, $input: ScriptTagInput!) {
  scriptTagUpdate(id: $id, input: $input) {
    scriptTag {
      id
    }
    userErrors {
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "input": {}
}

引数

引数 説明
id ( ID! ) required 更新するスクリプトタグの ID です。
input ( ScriptTagInput! ) required スクリプトタグの入力フィールドを指定する。

ScriptTagInput fields

cache ( Boolean )
Shopify CDN がスクリプトタグをキャッシュして提供できるかどうか。true の場合、スクリプトは CDN によってキャッシュされ、提供される。キャッシュの有効期限は、スクリプトタグが正常に返されてから 15 分後となる。false の場合は、スクリプトはそのまま提供されます。

displayScope ScriptTagDisplayScope
スクリプトが含まれるべきオンラインストア上のページまたはページ。

src ( URL )
リモートスクリプトの URL。

Return fields

scriptTag ( ScriptTag )
更新されたスクリプトタグです。

userErrors ( [UserError!]! )
mutation を実行した際に発生したエラーのリスト。

urlRedirectBulkDeleteAll (mutation)

非同期的にリダイレクトを一括して削除します。

実行例

mutation query の実行例を示します。

query
mutation urlRedirectBulkDeleteAll {
  urlRedirectBulkDeleteAll {
    job {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Return fields

job ( Job )
リダイレクトを削除する非同期のジョブです。

userErrors ( [UserError!]! )
mutation を実行する際に発生したエラーのリスト。

urlRedirectBulkDeleteByIds (mutation)

非同期にリダイレクトを一括削除する。

mutation query の実行例です。

query
mutation urlRedirectBulkDeleteByIds($ids: [ID!]!) {
  urlRedirectBulkDeleteByIds(ids: $ids) {
    job {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "ids": [
    "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
  ]
}

引数

引数 説明
ids ( [ID!]! ) required 削除するリダイレクトの ID のリスト。

Return fields

job ( Job )
リダイレクトを削除する非同期のジョブです。

userErrors ( [UrlRedirectBulkDeleteByIdsUserError!]! )
mutation を実行する際に発生したエラーのリストです。

urlRedirectBulkDeleteBySavedSearch (mutation)

非同期的にリダイレクトを一括して削除します。

query
mutation urlRedirectBulkDeleteBySavedSearch($savedSearchId: ID!) {
  urlRedirectBulkDeleteBySavedSearch(savedSearchId: $savedSearchId) {
    job {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "savedSearchId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}
引数 説明
savedSearchId ( ID! ) required フィルタリングのための URL リダイレクトの保存された検索の ID です。

Return fields

job ( Job )
リダイレクトを削除する非同期ジョブです。

userErrors ( [UrlRedictBurkDeleteBySavedSearchUserError!]! )
mutation を実行した際に発生したエラーのリストです。

urlRedirectBulkDeleteBySearch (mutation)

非同期的にリダイレクトを一括して削除します。

実行例

query
mutation urlRedirectBulkDeleteBySearch($search: String!) {
  urlRedirectBulkDeleteBySearch(search: $search) {
    job {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "search": "placeholder"
}
引数 説明
search ( String! ) required リダイレクトをフィルタリングするための検索クエリ。

Return fields

job ( Job )
リダイレクトを削除する非同期ジョブです。

userErrors ( [UrlRedirectBulkDeleteBySearchUserError!]! )
mutation を実行する際に発生したエラーのリストです。

urlRedirectCreate (mutation)

リダイレクトを作成します。

mutation query の実行例です。

query
mutation urlRedirectCreate($urlRedirect: UrlRedirectInput!) {
  urlRedirectCreate(urlRedirect: $urlRedirect) {
    urlRedirect {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "urlRedirect": {}
}

引数

引数 説明
urlRedirect ( UrlRedirectInput! ) required リダイレクトを作成する際に使用するフィールドです。

UrlRedirectInput フィールド

path ( String )
リダイレクトされる古いパスです。ユーザーがこのパスにアクセスすると、ターゲットにリダイレクトされます。

target ( String )
ユーザーがリダイレクトされるターゲットの場所。

Return fields

urlRedirect ( UrlRedirect )
作成されたリダイレクトです。

userErrors ( [UrlRedirectUserError!]!)
mutation を実行して発生したエラーのリストです。

urlRedirectDelete (mutation)

リダイレクト削除します。

query
mutation urlRedirectDelete($id: ID!) {
  urlRedirectDelete(id: $id) {
    deletedUrlRedirectId
    userErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
id ( ID! ) 削除するリダイレクトの ID。

Return fields

deletedUrlRedirectId ( ID )
削除されたリダイレクトの ID。

userErrors ( [UrlRedirectUserError!]! )
mutation を実行する際に発生したエラーのリスト。

urlRedirectImportCreate (mutation)

URL リダイレクトのインポートを作成します。

mutation query 実行した例。

query
mutation urlRedirectImportCreate($url: URL!) {
  urlRedirectImportCreate(url: $url) {
    urlRedirectImport {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "url": "placeholder"
}

引数

引数 説明
url ( URL ! ) required CSV ファイルの S3 URL です。

Return fields

urlRedirectImport ( UrlRedirectImport )
作成された URL リダイレクトインポートの

userErrors ( [UrlRedirectImportUserError!]! )
mutation を実行して発生したエラーのリストです。

urlRedirectImportSubmit (mutation)

URL リダイレクトのインポートを送信して処理を行います。

mutation query の実行例です。

query
mutation urlRedirectImportSubmit($id: ID!) {
  urlRedirectImportSubmit(id: $id) {
    job {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
id ( ID! ) required URL リダイレクトのインポートの ID です。

Return fields

job ( Job )
リダイレクトをインポートする非同期のジョブです。

userErrors ( [UrlRedirectImportUserError!]! )
mutation を実行して発生したエラーのリストです。

urlRedirectUpdate (mutation)

リダイレクトを更新する

mutation query の実行例です。

query
mutation urlRedirectUpdate($urlRedirect: UrlRedirectInput!) {
  urlRedirectUpdate(urlRedirect: $urlRedirect) {
    urlRedirect {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "urlRedirect": {}
}

引数

引数 説明
id ( ID ) 更新するリダイレクトの ID。
urlRedirect ( UrlRedirectInput! ) required リダイレクトの更新時に使用するフィールド。

UrlRedirectInput fields

path (String)
リダイレクトされる古いパスです。ユーザーがこのパスにアクセスすると、ターゲットにリダイレクトされます。

target (String)
ユーザーがリダイレクトされるターゲットの場所。

返却フィールド

urlRedirectf (UrlRedirect)
更新されたリダイレクト。

userErrors ([UrlRedirectUserError!]!)
mutation を実行する際に発生したエラーのリスト。


INPUTS

ScriptTagInput (input object)

スクリプトタグの入力フィールドを指定します。

入力フィールド

cacheBoolean )
Shopify CDN が script タグをキャッシュして提供できるかどうか。true の場合、スクリプトは CDN によってキャッシュされ、提供されます。キャッシュは script タグが正常に返されてから 15 分後に失効します。false の場合は、スクリプトはそのまま提供されます。

displayScopeScriptTagDisplayScope )
スクリプトが含まれるべきオンラインストア上のページまたはページ。

src ( URL )
リモートスクリプトの URL。

SEOInput(input object)

SEO 情報です。

Input fields

description ( String )
商品のの SEO の説明。

title ( String )
商品の SEO タイトル。

UrlRedirectInput(input object)

リダイレクト用の入力フィールドです。

Input fields

path ( String )
リダイレクトされる古いパス。ユーザーがこのパスにアクセスすると、ターゲットにリダイレクトされます。

target ( String )
ユーザーがリダイレクトされるターゲットの場所。


ENUMS

ScriptTagDisplayScope (enum)

スクリプトが含まれるべきオンラインストアのページ。

Values

ALL
ウェブストアフロントと注文ステータスページの両方にスクリプトを含めます。

ONLINE_STORE
ウェブストアフロントにのみスクリプトを含めます。

ORDER_STATUS
注文状況のページにのみスクリプトを含めます。

ScriptTagDisplayScopeの返すタイプ

UrlRedirectSortKeys (enum)

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

Values

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

PATH
path の値でソートします。

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

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

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