📈

【Shopify.dev和訳】Admin API/GraphQL reference/Store properties②

2021/10/02に公開

GraphQL

API

Shopify

tech

この記事について

この記事は、Admin API/Graph QL reference/Store propertiesの記事を和訳したものです。

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

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

Store properties APIs (OBJECTS 後半)

`Shop` (続き)

非推奨フィールド

channelCount (Int!) deprecated
チャンネルの数を公開します。

channels (ChannelConnection!) deprecated
ショップの有効な販売チャネルのリストです。

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

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

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

collectionSaveSearches (SavedSearchConnection!) deprecated
ショップのコレクションの保存検索の一覧。

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

collections (CollectionConnection!) deprecated
ショップのコレクションの一覧です。

引数	詳細
`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`

customerSavedSearches (SavedSearchConnection!) deprecated
ショップのお客様が保存した検索結果の一覧。

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

customers (CustomerConnection!) deprecated
ショップに関連するお客様のアカウント

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

draftOrderSavedSearches (SavedSearchConnection!) deprecated
ショップのドラフトオーダーの保存検索の一覧。
!

非推奨の警告

代わりにQueryRoot.draftOrderSavedSearchesを使用して下さい
:::

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

draftOrders (DraftOrderConnection!) deprecated
ショップに保存されているドラフトオーダーの一覧。

引数	詳細
`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`

inventoryItems (InventoryItemConnection!) deprecated
ショップの在庫アイテムのリスト。

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

locations (LocationConnection!) deprecated

引数	詳細
`after` ( `String` )	指定されたカーソルの後にある要素を返します。
`before` ( `String` )	指定されたカーソルの前にある要素を返します。
`first` ( `Int` )	リストから最初の `n` 個の要素までを返します。
`last` ( `Int` )	リストから最後の `n` 個の要素までを返します。
`query` ( `String` )	サポートされているフィルタパラメータです。・`active` ・`address1` ・`address2` ・`city` ・`country` ・`legacy` ・`name` ・`province` ・`zip` フィルターの使用に関する詳細は、詳細な検索構文を参照してください。
`reverse` ( `Boolean` )	基礎となるリストの順序を逆にします。デフォルト値：`false`
`sortKey` ( `LocationSortKeys` )	基礎となるリストを、与えられたキーでソートします。デフォルトの値です。`NAME`

marketingEvents (MarketingEventConnection!) deprecated
ショップのマーケティングイベントの一覧です。

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

orderSaveSearches (SavedSearchConnection!) deprecated

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

order (OrderConnection!) deprecated
ショップに寄せられたオーダーの一覧。

引数	詳細
`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` ・`fullfillment_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`
`sortKey` ( `OrderSortKeys` )	基礎となるリストを、与えられたキーでソートします。デフォルトの値です。`PROCESSED_AT`

pendingOrderCount (Int!) deprecated
ショップでの保留中の注文数

priceRuleSavedSearches (SavedSearchConnection!) deprecated
ショップでの予約注文数

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

priceRules (PriceRuleConnection!) deprecated
ショップの価格ルールの一覧。

引数	詳細
`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`
`sortKey` ( `PriceRuleSortKeys` )	基礎となるリストを、与えられたキーでソートします。デフォルトの値です。`ID`

productByHandle (Product) deprecated
製品をハンドルで返す。

引数	詳細
`handle` ( `String!` ) `required`	指定されたカーソルの後にある要素を返します。

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

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

productVariants (ProductVariantConnection!) deprecated
ショップの商品バリエーションの一覧。

引数	詳細
`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`
`sortKey` ( `PriceVariantSortKeys` )	基礎となるリストを、与えられたキーでソートします。デフォルトの値です。`ID`

products (ProductConnection!) deprecated
ショップの商品の一覧です。

引数	詳細
`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` ・`tag` ・`taxable` ・`title` ・`updated_at` ・`vendor` フィルターの使用に関する詳細は、詳細な検索構文を参照してください。
`reverse` ( `Boolean` )	基礎となるリストの順序を逆にします。デフォルト値：`false`
`savedSearchId` ( `ID` )	既存の保存された検索の ID です。検索のクエリ文字列が query 引数として使用されます。SavedSearchを参照してください。
`sortKey` ( `PriceVariantSortKeys` )	基礎となるリストを、与えられたキーでソートします。デフォルトの値です。`ID`

shopifyPaymentsAccount (ShopifyPaymentsAccount) deprecated
Shopify Payments のアカウント情報（残高や支払いなど）。

storefrontUrl (URL!) deprecated
ショップのストアフロントの URL です。

Samples

query

# ショップの名前とIDを取得する
{
  shop {
    name
    id
  }
}

response

{
  "data": {
    "shop": {
      "name": "graphql-admin",
      "id": "gid://shopify/Shop/6587023382"
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 1,
      "actualQueryCost": 1,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 999,
        "restoreRate": 50
      }
    }
  }
}

query

# ショップの配送地域のリストを取得する
{
  shop {
    countriesInShippingZones {
      countryCodes
    }
  }
}

response

{
  "data": {
    "shop": {
      "countriesInShippingZones": {
        "countryCodes": [
          "CA"
        ]
      }
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 2,
      "actualQueryCost": 2,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 998,
        "restoreRate": 50
      }
    }
  }
}

query

# ショップの最大の商品オプションとバリエーションを取得する
{
  shop {
    resourceLimits {
      maxProductOptions
      maxProductVariants
    }
  }
}

response

{
  "data": {
    "shop": {
      "resourceLimits": {
        "maxProductOptions": 3,
        "maxProductVariants": 100
      }
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 2,
      "actualQueryCost": 2,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 998,
        "restoreRate": 50
      }
    }
  }
}

query

# アップロードされた最初の10枚の画像のaltテキストを取得する
{
  shop {
    uploadedImages(first: 10) {
      edges {
        node {
          altText
        }
      }
    }
  }
}

response

{
  "errors": [
    {
      "message": "Field 'uploadedImages' doesn't exist on type 'Shop'",
      "locations": [
        {
          "line": 5,
          "column": 5
        }
      ],
      "path": [
        "query",
        "shop",
        "uploadedImages"
      ],
      "extensions": {
        "code": "undefinedField",
        "typeName": "Shop",
        "fieldName": "uploadedImages"
      }
    }
  ]
}

ShopFeatures (`object`)

ショップで利用できる機能セットを表します。

フィールド

avalaraAvatax (Boolean!)
ショップが avarara avatax にアクセスできるかどうか。

branding (ShopBranding!)
ショップのブランディング。

captcha (Boolean!)
ショップのストアフロントに CAPTCHA 対策ができるかどうか。

captchaExternalDomains (Boolean!)
ショップのストアフロントが、Shopify が管理していないドメインに対して CAPTCHA プロテクションを行えるかどうか。

dynamicRemarketing (Boolean!)
ショップがダイナミックリマーケティング機能にアクセスできるかどうか。

eligibleForSubscriptionMigration (Boolean!)
ショップが Shopify のサブスクリプションを使用するために移行できるかどうか。

eligibleForSubscriptions (Boolean!)
ショップがサブスクリプションを販売するために適切に設定されているかどうか。

giftCards (Boolean!)
ショップがギフトカードを作成できるかどうか。

harmonizedSystemCode (Boolean!)
商品にハーモナイズドシステムコードを表示するかどうか。国境を越えて出荷するときに税関で使用されます。

internationalDomains (Boolean!)
ショップがインターナショナルドメインを有効にできるかどうか。

internationalPriceOverrides (Boolean!)
ショップが国際価格のオーバーライドを有効にできるかどうか。

internationalPriceRules (Boolean!)
ショップがインターナショナルプライスルールを有効にできるかどうか。

legacySubscriptionGatewayEnabled (Boolean!)
ショップが古いサブスクリプションを処理するためにレガシーサブスクリプションゲートウェイを有効にしているかどうか。

liveView (Boolean!)
ライブビューを表示するかどうか。ライブビューは、トライアル中のマーチャントやストアフロントを持たないマーチャントには非表示です。

multiLocation (Boolean!)
このショップでマルチロケーション機能が有効になっているかどうか。

onboardingVisual(Boolean!)
ショップがオンボーディングビジュアルにアクセスできるかどうか。

paypalExpressSubscriptionGatewayStatus (PaypalExpressSubscriptionsGatewayStatus!)
ショップが PayPal Express でサブスクリプションを販売するように設定されているかどうか。

reports (Boolean!)
ショップがすべてのレポート機能にアクセスできるかどうか。

sellsSubscriptions (Boolean!)
ショップが定期購入商品を持ったことがあるかどうか。

showMetrics (Boolean!)
メトリクスを表示するかどうか。新しいマーチャントの場合、メトリックスは意味を持つようになるまで隠されます。

storefront (Boolean!)
ショップがオンライン・ストアフロントを持っているかどうか。

usingShopifyBalance (Boolean!)
ショップが Shopify Balance を使用しているかどうか。

ShopFeatures の返却型

Shop.features

非推奨フィールド

deliveryProfiles (Boolean!) deprecated
このショップで配送プロファイル機能が有効になっているかどうか。

shopifyPlus (Boolean!) deprecated
ショップが Shopify Plus のサブスクリプションを持っているかどうか。

ShopPlan (`object`)

ショップの課金プランを表します。

フィールド

displayName (String!)
ショップの課金プランの名前です。

partnerDevelopment (Boolean!)
ショップがテスト目的のパートナー開発ショップであるかどうか。

shopifyPlus (Boolean!)
ショップが Shopify Plus のサブスクリプションを持っているかどうか。

ShopPlan の返却型

Shop.plan

ShopPolicy (`object`)

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

フィールド

body (HTML!)
ポリシーの本文です。最大サイズは 512kb です。

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

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

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

type (ShopPolicyType!)
ショップポリシーのタイプです。

url (URL!)
ポリシーの公開 URL。

ShopPolicy の返却型

Shop.shopPolicies

ShopPolicy ミューテーション

shopPolicyUpdate
ショップポリシーの更新。

Implements

ShopResourceLimits (`object`)

ショップのリソース制限

フィールド

locationLimit (Int!)
許可されるロケーションの最大数。

maxProductOptions (Int!)
許容される商品オプションの最大数

maxProductVariants (Int!)
製品ごとに許可されるバリアントの最大数。

redirectLimitReached (Boolean!)
ショップがリソースに対して行える URL リダイレクトの数の上限に達しているかどうか。

skuResourceLimits (ResourceLimit!)
ショップごとに許可されるバリアントの最大数です。ショップが無制限の SKU を持っている場合、使用されている数量を取得することはできません。

ShopResourceLimits の返却型

Shop.rewourceLimits

Shopify アプリのご紹介

Discussion

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

この記事について

Shopify アプリのご紹介

Store properties APIs (OBJECTS 後半)

Shop (続き)

非推奨フィールド

非推奨の警告

Samples

ShopFeatures (object)

フィールド

ShopFeatures の返却型

非推奨フィールド

ShopPlan (object)

フィールド

ShopPlan の返却型

ShopPolicy (object)

フィールド

ShopPolicy の返却型

ShopPolicy ミューテーション

Implements

ShopResourceLimits (object)

フィールド

ShopResourceLimits の返却型

Shopify アプリのご紹介

Discussion

`Shop` (続き)

ShopFeatures (`object`)

ShopPlan (`object`)

ShopPolicy (`object`)

ShopResourceLimits (`object`)