📈

【Shopify.dev和訳】Admin API/GraphQL reference/Common Objects②

2021/10/01に公開約72,900字

この記事について

株式会社 UnReact はプロジェクトの一環としてShopify 開発者ドキュメントの和訳を行っています。

この記事は、Admin API/GraphQL reference Common Objects2の記事を和訳したものです。

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

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

Common APIs

Common Admin API objects の続きです。

QueryRoot

スキーマのクエリのエントリーポイントです。これは、すべてのクエリの出発点となるパブリックなトップレベル API として機能します。

Connections

appInstallations (AppInstallationConnection!)
アプリのインストール状況の一覧。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
category ( AppInstallationCategory ) フェッチするアプリインストールのカテゴリーです。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
privacy ( AppInstallationPrivacy ) フェッチするアプリインストールのプライバシーレベル。
デフォルト値です。PUBLIC
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
sortKey ( AppInstallationSortKeys ) 指定されたキーで基礎となるリストをソートします。
デフォルトの値: INSTALLED_AT

automaticDiscountNodes (DiscountAutomaticNodeConnection!)
自動割引のリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
category ( AppInstallationCategory ) フェッチするアプリインストールのカテゴリーです。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ。
status
type
フィルターの使い方については、詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
savedSearchId ( ID ) 既存の保存された検索の ID を指定します。検索のクエリ文字列が query 引数として使用されます。SavedSearch を参照してください。
sortKey ( AppInstallationSortKeys ) 指定されたキーで基礎となるリストをソートします。
デフォルトの値: INSTALLED_AT

automaticDiscountSavedSearches (SavedSearchConnection!)
ショップの自動割引の保存された検索のリスト。

codeDiscountNodes (DiscountCodeNodeConnection!)
コード割引のリスト。query, params のための特別なフィールド :

  • status: active, expired, scheduled
  • discount_type: bogo, fixed_amount, free_shipping, percentage.
引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
category ( AppInstallationCategory ) フェッチするアプリインストールのカテゴリーです。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:
created_at
discount_type
ends_at
starts_at
status
times_used
type
updated_at
フィルターの使い方については、詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
savedSearchId ( ID ) 既存の保存された検索の ID を指定します。検索のクエリ文字列が query 引数として使用されます。SavedSearch を参照してください。
sortKey ( CodeDiscountSortKeys ) 指定されたキーでリストをソートします。
デフォルトの値: CREATED_AT

codeDiscountSavedSearches (SavedSearchConnection!)
ショップのコードディスカウントの保存された検索のリスト。

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

collectionSavedSearches (SavedSearchConnection!)
ショップのコレクションの保存された検索のリスト。

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

collections (CollectionConnection!)
コレクションのリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:
collection_type
publishable_status
published_status
title
updated_at
フィルターの使い方については、詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
savedSearchId ( ID ) 既存の保存された検索の ID を指定します。検索のクエリ文字列が query 引数として使用されます。SavedSearch を参照してください。
sortKey ( CollectionSortKeys ) 指定されたキーでリストをソートします。
デフォルトの値: ID

customPaymentMethods (CustomPaymentMethodConnection!)
カスタム・ペイメント・メソッドのリスト

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

customerSavedSearches (SavedSearchConnection!)
ショップの顧客の保存された検索のリスト。

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

customers (CustomerConnection!)
顧客のリスト。

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

deletionEvents (DeletionEventConnection!)
削除イベントのページ付けされたリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:
occurred_at
詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
sortKey ( DeletionEventSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値: ID
subjectTypes ([DeletionEventSubjectType!]) フィルタリングするサブジェクトタイプのリストです。

deliveryProfiles (DeliveryProfileConnection!)
保存されたデリバリープロファイルのリスト

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
merchantOwnedOnly (Boolean) マーチャントが作成した配信プロファイルのみが対象となります。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false

discountRedeemCodeSavedSearches (SavedSearchConnection!)
ショップの還元された割引コードの保存された検索のリスト。

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

draftOrderSavedSearches (SavedSearchConnection!)
ショップのドラフトオーダーの保存された検索のリスト。

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

draftOrders (DraftOrderConnection!)
保存されたドラフトオーダーのリスト

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

fileSavedSearches (SavedSearchConnection!)
ショップのファイル保存検索のリスト。

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

files(FileConnection!)
ファイルのリストです。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:
created_at
filename
media_type
original_upload_size
satatus
詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
savedSearchId ( ID ) 既存の保存された検索の ID を指定します。検索のクエリ文字列が query 引数として使用されます。SavedSearch を参照してください。
sortKey ( FileSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値: ID

giftCards (GiftCardConnection!)
ギフトカードのリストを返します。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:
balance_status
created_at
expires_on
initial_value
source
satatus
詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
savedSearchId ( ID ) 既存の保存された検索の ID を指定します。検索のクエリ文字列が query 引数として使用されます。SavedSearch を参照してください。
sortKey ( GiftCardSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値: ID

inventoryItems (InventoryItemConnection!)
インベントリアイテムのリスト。

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

locations (LocationConnection!)
アクティブなロケーションのリスト

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
includeInactive (Boolean) trueの場合、無効化されているロケーションも含めます。
デフォルト値:false
includeLengacy (Boolean) trueの場合、フルフィルメントサービスのレガシーロケーションも含めます。
デフォルト値:false
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:
active
address1
address2
city
country
legacy
name
province
zip
詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
sortKey ( LocationSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値: NAME

locationAvailableForDeliveryProfilesConnection (LocationConnection!)
デリバリー・プロファイルで利用可能なすべてのオリジン・ロケーションのリストを返します。

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

marketingActivities (MarketingActivityConnection!)
キャンペーンのマーケティング活動のリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:
app_id
created_at
marketing_campaign_id
scheduled_to_end_at
scheduled_to_start_at
tactic
title
updated_at
詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
savedSearchId ( ID ) 既存の保存された検索の ID を指定します。検索のクエリ文字列が query 引数として使用されます。SavedSearch を参照してください。
sortKey ( MarketingActivitySortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値: CREATED_AT

marketingEvents (MarketingEventConnection!)
マーケティング・イベントのリスト

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:
app_id
description
started_at
type
詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
savedSearchId ( ID ) 既存の保存された検索の ID を指定します。検索のクエリ文字列が query 引数として使用されます。SavedSearch を参照してください。
sortKey ( MarketingEventSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値: ID

metafieldStorefrontVisibilities (MetafieldStorefrontVisibilityConnection!)
Storefront APIで表示可能なメタフィールドの名前空間とキーのリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
namespace (String) メタフィールドのストアフロント・ホワイトリストを名前空間でフィルタリングします。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false

orderSavedSearches (SavedSearchConnection!)
ショップの注文の保存された検索のリスト。

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

orders (OrderConnection!)
発注されたオーダーのリストを返します。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:
cart_token
channel_id
chargeback_status
checkout_token
created_at
credit_card_last4
customer_id
delivery_method
discount_code
email
financial_status
fraud_protection_level
fulfillment_location_id
fulfillment_status
gateway
location_id
name
payment_provider_id
processed_at
reference_location_id
return_status
risk_level
sales_channel
source_identifier
source_name
status
tag
test
updated_at
詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
savedSearchId ( ID ) 既存の保存された検索の ID を指定します。検索のクエリ文字列が query 引数として使用されます。SavedSearch を参照してください。
sortKey ( OrderSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値: PROCESSED_AT

paymentProviders (PaymentProviderConnection!)
支払いプロバイダのリスト

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
countried (CountryCode!) 国別に検索できます。
eligibleOnly (Boolean) 対象となるプロバイダーのみをフィルタリングします。この引数は非推奨です。サポートされなくなりました。
デフォルト値:true
enabledOnly (Boolean) 有効なプロバイダのみをフィルタリングします。
first ( Int ) リストから最初の n 個の要素までを返します。
group ( [ProviderGroup!] ) グループ別にプロバイダーを検索することができます。
last ( Int ) リストから最後の n 個の要素までを返します。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false

priceLists (PriceListConnection!)
あるショップのすべての価格表

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
matchRule (PriceListContext) 価格表が適用されるコンテキスト。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
sortKey ( OrderSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値: ID

priceRuleSavedSearches (SavedSearchConnection!)
ショップの価格ルールの保存された検索のリスト。

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

priceRules (PriceRuleConnection!)
プライスルールのリスト

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:
created_at
discount_type
ends_at
starts_at
status
times_used
updated_at
詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
savedSearchId ( ID ) 既存の保存された検索の ID を指定します。検索のクエリ文字列が query 引数として使用されます。SavedSearch を参照してください。
sortKey ( PriceRuleSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値: ID

privateMetafields (PrivateMetafieldConnection!)
プライベート・メタフィールドのリスト

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
namespace (String) プライベート・メタフィールドを名前空間でフィルタリングします。
owner (ID!) リソースIDで指定された特定のリソースのプライベートメタフィールドを取得します。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false

productSavedSearches (SavedSearchConnection!)
ショップの製品の保存された検索のリスト。

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

productVariants (ProductVariantConnection!)
製品バリアントのリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:
barcode
collection
delivery_profile_id
gift_card
inventory_quantity
location_id
managed
managed_by
product_id
product_status
product_type
publishable_status
published_status
sku
tag
taxable
title
updated_at
vendor
詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
savedSearchId ( ID ) 既存の保存された検索の ID を指定します。検索のクエリ文字列が query 引数として使用されます。SavedSearch を参照してください。
sortKey ( ProductVariantSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値: ID

products (ProductConnection!)
製品のリストです。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:<
barcode
created_at
delivery_profile_id
error_feedback
gift_card
has_only_default_variant
inventory_total
is_price_reduced
out_of_stock_somewhere
price
product_type
publishable_status
published_status
sku
status
tag
title
updated_at
vendor
詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
savedSearchId ( ID ) 既存の保存された検索の ID を指定します。検索のクエリ文字列が query 引数として使用されます。SavedSearch を参照してください。
sortKey ( ProductSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値: ID

publications (PublicationConnection!)
活動中の出版物の一覧です。

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

scriptTags (ScriptTagConnection!)
スクリプトタグのリスト

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
src (URL) フィルタリングするスクリプトタグのソースURLです。

sellingPlanGroups (SellingPlanGroupConnection!)
販売計画グループを一覧表示します。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:<
delivery_frequency
percentage_off
name
created_at
・`app_id [CURRENT
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
sortKey ( SellingPlanGroupSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値: ID

subscriptionContracts (SubscriptionContractConnection!)
サブスクリプション契約をリストアップします。

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

tenderTransactions (TenderTransactionConnection!)
Shopに関連する入札取引のリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ:<
point_of_sale_device_id
processed_at
test
詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false

translatableResources (TranslatableResourceConnection!)
翻訳可能なリソースのリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
resourceType (TranslatableResourceType!) あるタイプのリソースのみを返します。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false

urlRedirectSavedSearches (SavedSearchConnection!)
ショップのURLリダイレクトの保存された検索のリストです。

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

urlRedirects (UrlRedirectConnection!)
ショップのリダイレクトのリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
category ( AppInstallationCategory ) フェッチするアプリインストールのカテゴリーです。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ。
created_at
path
target
フィルターの使い方については、詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
savedSearchId ( ID ) 既存の保存された検索の ID を指定します。検索のクエリ文字列が query 引数として使用されます。SavedSearch を参照してください。
sortKey ( UrlRedirectSortKeys ) 指定されたキーで基礎となるリストをソートします。
デフォルトの値: ID

webhookSubscriptions (WebhookSubscriptionConnection!)
Webhookサブスクリプションのリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
callbackUrl (URL) フィルターにかけるコールバックURL
first ( Int ) リストから最初の n 個の要素までを返します。
format(WebhookSubscriptionFormat) フィルタリングするレスポンスフォーマット
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ。
created_at
updated_at
フィルターの使い方については、詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
sortKey ( WebhookSubscriptionSortKeys ) 指定されたキーで基礎となるリストをソートします。
デフォルトの値: CREATED_AT
topics([WebhookSubscriptionTopic!]) フィルタリングするWebhookサブスクリプショントピックのリスト。

Fields

app (App)
IDでAppを検索したり、現在認証されているAppを返したりします。

引数 説明
id ( ID ) Appを検索するためのIDです。

appByHandle (App)
ハンドルでアプリを取得します。アプリが存在しない場合はnullを返します。

引数 説明
handle ( String! ) required アプリのハンドル。

appByKey (App)
apiKeyでアプリを取得します。アプリが存在しない場合はnullを返します。

引数 説明
apiKey (String!) required アプリのAPIキー

appInstallation (AppInstallation)
IDAppInstallation を検索するか、現在認証されている AppAppInstallation を返します。

引数 説明
id (ID) AppInstallationの検索に使用されるID。

automaticDiscountNodeDiscountAutomaticNode )
自動割引リソースをIDで返します。

引数 説明
id (ID!) required 返すべきDiscountAutomaticNodeIDを指定します。

availableCarrierServices ([DeliveryCarrierServiceAndLocations!]!)
有効化されたキャリアサービスのリストと、どのショップロケーションがそれらをサポートしているかを示します。

availableLocales ([Locale!]!)
利用可能なロケールのリスト。

carrierService (DeliveryCarrierService)
キャリアサービスをIDで検索する。

引数 説明
id (ID!) required 返すべきDeliveryCarrierServiceIDです。

codeDiscountNode(DiscountCodeNode)
コードディスカウントリソースをIDで返す。

引数 説明
id (ID!) required 返すべきcodeDiscountNodeIDです。

codeDiscountNodeByCode (DiscountCodeNode)
コードで識別されるコードディスカウントを返します。

引数 説明
code ( String! ) required 返すべきDiscountCodeNodeのコード。

collection (Collection)
IDによるCollectionリソースを返します。

引数 説明
id (ID!) required 返すべきCollectionIDです。

collectionByHandle (Collection)
ハンドルでコレクションを返します。

引数 説明
handle ( String! ) required コレクションのハンドルです。

collectionRulesConditions ([CollectionRuleConditions!]!)
ルールを持つコレクションの作成方法を定義するルール条件のリストです。

currentAppInstallation (AppInstallation!)
現在認証されているAppAppInstallationを返す。

currentBulkOperationBulkOperation)
現在のアプリの直近のBulkOperationを返す。

引数 説明
type ( BulkOperationType ) 一括操作のタイプ。
デフォルト値: QUERY

customer (Customer)
IDで指定したCustomerリソースを返します。

引数 説明
id (ID!) required 返すべきCustomerIDです。

customerPaymentMethod (CustomerPaymentMethod)
IDCustomerPaymentMethodリソースを返します。

引数 説明
id (ID!) required 返すべきCustomerPaymentMethodIDです。
showRevoked (Boolean) 顧客が取り消した支払い方法を表示するかどうか。
デフォルト値:false

deliveryProfile (DeliveryProfile)
デリバリープロファイルをIDで検索します。

引数 説明
id (ID!) required 返すべきDeliveryProfileIDです。

deliverySettings (DeliverySetting)
ショップ全体の配送設定です。

discountCodeCount (Int!)
ショップの割引コードの合計数。

引数 説明
query(String) サポートしているフィルターパラメーター:
times_used

discountRedeemCodeBulkCreation (DiscountRedeemCodeBulkCreation)
バルクコード作成リソースをIDで返す。

引数 説明
id (ID!) required 返すべきDiscountRedeemCodeBulkCreationIDです。

domain (Domain)
IDでドメインを検索します。

引数 説明
id (ID!) required 返すべきDomainIDです。

draftOrder (DraftOrder)
DraftOrderリソースをIDで返します。

引数 説明
id (ID) 返すべきDraftOrderIDです。

fulfillment (Fulfillment)
fulfillmentリソースをIDで返します。

引数 説明
id (ID!) required 返すべきfulfillmentIDです。

fulfillmentOrder (FulfillmentOrder)
fulfillmentリソースをIDで返します

引数 説明
id (ID!) required 返すべきfulfillmentOrderIDです。

fulfillmentService (FulfillmentService)
fulfillmentリソースをIDで返します

引数 説明
id (ID!) required 返すべきFulfillmentServiceIDです。

giftCard (GiftCard)
giftCardリソースをIDで返します

引数 説明
id (ID!) required 返すべきgiftCardIDです。

giftCardsCount (UnsignedInt64!)
ショップで発行されたギフトカードの合計数。

引数 説明
enabled ( Boolean ) 有効か無効か、またはすべてのギフトカードをカウントするかどうか。

inventoryItem (InventoryItem)
inventoryItemリソースをIDで返します

引数 説明
id (ID!) required 返すべきinventoryItemIDです。

inventoryLevel (InventoryLevel)
inventoryLevelリソースをIDで返します

引数 説明
id (ID!) required 返すべきinventoryLevelIDです。

job (Job)
IDJobリソースを返します。内部のジョブの状態や、該当する変更を確認するために使用します。

引数 説明
id (ID!) required ジョブqueryIDです。

location (Location)
inventory LocationリソースをIDで返します

引数 説明
id (ID) 返すべきlocationIDです。IDが指定されていない場合は、ショップの主要な場所が返されます。

marketingActivity (MarketingActivity)
marketingActivityリソースをIDで返します

引数 説明
id (ID!) required 返すべきmarketingActivityIDです。

marketingEvent (MarketingEvent)
marketingEventリソースをIDで返します

引数 説明
id (ID!) required 返すべきmarketingEventIDです。

metafield (Metafield)
metafieldリソースをIDで返します

引数 説明
id (ID!) required 返すべきmetafieldIDです。

metafieldStorefrontVisibility (MetafieldStorefrontVisibility)
metafieldStorefrontVisibilityリソースをIDで返します

引数 説明
id (ID!) required 返すべきmetafieldStorefrontVisibilityIDです。

node (Node)
特定のnodeIDで返します

引数 説明
id (ID) required NodeのIDを返す。

nodes ([Node]!)
与えられたIDを持つノードのリストを返します。

引数 説明
ids ( [ID!]! ) required 返すべきNodesID

order (Order)
OrderリソースをIDで返します

引数 説明
id (ID!) required 返すべきOrderIDです。

paymentAuthorizationSettings (PaymentAuthorizationSettings!)
ショップの決済認証設定。

paymentProvider (PaymentProvider)
プロバイダリソースをIDで返します。

引数 説明
id (ID!) required 返すべきPaymentProviderIDです。

priceList (PriceList)
価格表の一覧です。

引数 説明
id (ID!) required 価格表のリソースをIDで返します。

priceRule (PriceRule)
プライスルールをIDで検索します。

引数 説明
id (ID!) required 返すべきPriceRuleIDです。

privateMetafield (PrivateMetafield)
プライベートのメタフィールドをIDで返します。

引数 説明
id (ID!) required 返すべきPrivateMetafieldIDです。

product (Product)
商品リソースをIDで返します。

引数 説明
id (ID!) required 返すべきProductIDです。

productByHandle (Product)
productをハンドルで返す。

引数 説明
handle ( String! ) required productのハンドル

productVariant (ProductVariant)
ProductVariantリソースをIDで返します。

引数 説明
id (ID!) required ProductVariantIDを返す。

publicApiVersions ([ApiVersion!]!)
サポートされているバージョン、リリース候補バージョン、不安定バージョンを含む、公開されている Admin API バージョンのリストです。

publication (Publication)
IDで出版物を検索することができます。

引数 説明
id (ID!) required PublicationIDを返す。

refund (Refund)
RefundリソースをIDで返します。

引数 説明
id (ID!) required RefundIDを返す。

scriptTag (ScriptTag)
IDによるスクリプトタグリソースの検索。

引数 説明
id (ID!) required ScriptTagIDを返す。

sellingPlanGroup (SellingPlanGroup)
Selling Plan GroupのリソースをIDで返します。

引数 説明
id (ID!) required SellingPlanGroupIDを返す。

shop (Shop!)
リクエストで使用されたアクセストークンに対応するShopリソースを返します。

shopLocales ([ShopLocale!]!)
ショップで利用可能なロケールの一覧

引数 説明
published ( Boolean ) 公開されているロケールのみを返します。

subscriptionBillingAttempt (SubscriptionBillingAttempt)
SubscriptionBillingAttemptIDを返します。

引数 説明
id (ID!) required SubscriptionBillingAttemptIDを返す。

subscriptionContract (SubscriptionContract)
IDでSubscription Contractリソースを返します。

引数 説明
id (ID!) required Subscription ContractIDを返す。

subscriptionDraft (SubscriptionDraft)
Subscription DraftリソースをIDで返します。

引数 説明
id (ID!) required Subscription DraftIDを返す。

translatableResource (TranslatableResource)
翻訳可能なリソースです。

引数 説明
resourceId ( ID! ) required 翻訳可能なリソースをIDで検索します。

urlRedirect (UrlRedirect)
リダイレクトリソースをIDで返します。

引数 説明
id (ID!) required UrlRedirectIDを返す。

urlRedirectImport (UrlRedirectImport)
リダイレクトインポートリソースをIDで返します。

引数 説明
id (ID!) required UrlRedirectImportIDを返す。

webhookSubscription (WebhookSubscription)
WebhookのサブスクリプションをIDで返します。

引数 説明
id (ID!) required WebhookSubscriptionIDを返す。

Deprecated fields

  • automaticDiscount (DiscountAutomatic) deprecated
    自動割引のリソースをIDで返します。
引数 説明
id (ID!) required DiscountAutomaticIDを返す。
引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
callbackUrl (URL) フィルターにかけるコールバックURL
first ( Int ) リストから最初の n 個の要素までを返します。
format(WebhookSubscriptionFormat) フィルタリングするレスポンスフォーマット
last ( Int ) リストから最後の n 個の要素までを返します。
query (String) サポートされているフィルタパラメータ。
status
type
フィルターの使い方については、詳細な検索構文を参照してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
savedSearchId (ID) 既存の保存された検索のIDです。検索のクエリ文字列が query 引数として使用されます。SavedSearchを参照してください。
sortKey ( AutomaticDiscountSortKeys ) 指定されたキーで基礎となるリストをソートします。
デフォルトの値: CREATED_AT
  • channel (Channel) deprecated
    チャンネルをIDで検索します。
引数 説明
id (ID!) required ChannelIDを返す。
  • channels (ChannelConnection!) deprecated
    アクティブな販売チャネルのリスト。
引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
  • locationsAvailableForDeliveryProfiles ([Location!]) deprecated
    配信プロファイルで利用可能なすべてのオリジンロケーションのリストを返します。

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

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