👩‍💻

【Shopify.dev和訳】Storefront API/Reference/Products

2021/10/23に公開約79,700字

この記事について

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

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

Product API

製品や製品バリエーションを作成・管理することができます。

このセクションでは

  • Collection - コレクションとは、ショップオーナーが商品を整理したり、ショップを見やすくするために作成できる商品のグループを表します。
  • CollectionSortKeys - Collection クエリの有効なソートキーのセットです。
  • ExternalVideo - Shopify の外部でホストされているビデオを表します。
  • Media - 複数のメディアをページングするために自動生成されたタイプです。
  • MediaContentType - メディアオブジェクトで使用可能なコンテンツタイプです。
  • MediaHost - メディアリソースのホストです。
  • MediaImage - Shopify がホストするイメージを表します。
  • Model3d - Shopify がホストする 3D モデルを表します。
  • Model3dSource - Shopify がホストする 3D モデルのソースを表します。
  • PriceRangeFilter - 特定の価格帯にマッチするコレクション内の商品のサブセットを表示するために使用されるフィルターです。
  • Product - 商品は Shopify ストアで販売される個々のアイテムを表します。商品はしばしば物理的なものですが、必ずしもそうである必要はありません。例えば、デジタルダウンロード(映画、音楽、電子書籍など)も商品として認められますし、サービス(機器のレンタル、レンタルワーク、他の製品のカスタマイズ、延長保証など)も商品として認められます。
  • ProductCollectionSortKeys - ProductCollection クエリで有効なソートキーのセットです。
  • ProductFilter - コレクション内の製品のサブセットを表示するために使用されるフィルタです。
  • ProductImageSortKeys - ProductImage クエリの有効なソートキーのセットです。
  • ProductMediaSortKeys - ProductMedia クエリで有効なソートキーのセットです。
  • ProductOption - 顧客が選択可能な「サイズ」、「カラー」、「素材」などの商品プロパティ名です。バリアントは、これらのオプションの組み合わせに基づいて選択されます。それぞれ 255 文字の制限があります。
  • ProductPriceRange - 製品の価格帯です。
  • ProductSortKeys - Product クエリの有効なソートキーのセットです。
  • ProductVariant - 商品のバリエーションとは、サイズ違いや色違いなど、商品の異なるバージョンを表します。
  • ProductVariantPricePair - 比較対象となる価格と、通貨を共有するバリアントの価格です。
  • ProductVariantSortKeys - ProductVariant クエリの有効なソートキーのセットです。
  • SelectedOption - 顧客が製品バリアントを選択する際に使用されるプロパティです。製品には、異なるサイズや色など、複数のオプションがあります。
  • SelectedOptionInput - 選択されたオプションに必要な入力フィールドを指定します。
  • SellingPlan - 製品やバリアントがどのように販売・購入されるかを表しています。
  • SellingPlanAllocation - バリアントと販売計画の間の関連を表します。販売計画の割り当てでは、各バリアントに提供されるオプションと、販売計画で購入した場合のバリアントの価格を記述します。
  • SellingPlanAllocationPriceAdjustment - 特定の販売プランで購入されたときのバリアントの結果の価格です。
  • SellingPlanFixedAmountPriceAdjustment - 元のバリアントの価格から差し引かれる固定額です。例えば、10 ドル引きなどです。
  • SellingPlanFixedPriceAdjustment - 販売プランで購入されたバリアントの固定価格の調整です。
  • SellingPlanGroup - 販売方法を表します。例えば、「Subscribe and save」は、顧客が配送ごとに商品やサービスの代金を支払う販売方法です。販売プラングループは、個々の販売プランを含んでいます。
  • SellingPlanGroupOption - ストアフロントのドロップダウンリストで利用可能な販売プラングループのオプションを表します。
  • SellingPlanOption - セリングプランで提供されるオプションを表します。
  • SellingPlanPercentagePriceAdjustment - 元の商品価格から差し引かれるパーセンテージの金額です。例えば、10%オフなど。
  • SellingPlanPriceAdjustment - 販売計画に関連付けられたバリアントの価格がどのくらい調整されるかを表します。各バリアントは最大 2 つの価格調整を持つことができます。
  • SellingPlanPriceAdjustmentValue - 販売計画に関連付けられたバリアントの価格がどのくらい調整されるかを表します。各バリアントは最大 2 つの価格調整を持つことができます。
  • UnitPriceMeasurement - 製品バリアントの単価を計算するために使用される測定値です(例:$9.99 / 100ml)。
  • UnitPriceMeasurementMeasuredType - 受け入れられる測定単位のタイプです。
  • UtitPriceMeasurementMeasuredUnit - 受け入れられる測定単位です。
  • VariantOptionFilter - 特定のバリアントオプションに一致するコレクション内の製品のサブセットを表示するために使用されるフィルタです。
  • Video - Shopify がホストするビデオを表します。
  • VideoSource - Shopify がホストするビデオのソースを表しています。

UNIONS

SellingPlanPriceAdjustmentValue(union)

販売計画に関連付けられたバリアントの価格がどれだけ調整されたかを表します。各バリアントは最大 2 つの価格調整を持つことができます。

可能なタイプ

Collection(object)

コレクションは、ショップオーナーが商品を整理したり、ショップを閲覧しやすくするために作成できる商品のグループを表します。

このページ内

コネクション

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

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

products (ProductConnection!)
コレクション内の製品のリスト。

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

フィールド

description (String!)
HTML タグを削除した 1 行のコレクションの説明。

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

descriptionHtml (HTML!)
HTML フォーマットを含む、コレクションの説明。

handle (String!)
コレクションのタイトルから自動的に生成された、人間に優しい固有の文字列。制限は 255 文字です。

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

image (Image)
コレクションに関連付けられた画像。

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

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

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

titleString!)
コレクションの名前です。最大 255 文字です。

updatedAt (DateTime!)
コレクションが最後に変更された日付と時間。

コレクションを返す型

インプリメント

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

このページでは

フィールド

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

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

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

このページについて

フィールド

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

node (Collection!)
CollectionEdge の末尾にある項目。

CollectionEdge を返す型

ExternalVideo(object)

Shopify の外部でホストされているビデオを表します。

このページについて

フィールド

alt (String)
メディアの性質やコンテンツを共有するための単語やフレーズ。

embeddedUrl (URL!)
URL を指定します。

host (MediaHost!)
外部動画のホスト。

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

mediaContentType (MediaContentType!)
メディアコンテンツタイプ。

previewImage (Image)
メディアのプレビュー画像。

実装するもの

Media(object)

複数の Media をページングするための自動生成型。

このページについて

フィールド

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

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

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

このページについて

フィールド

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

node (Media!)
MediaEdge の末尾の項目。

MediaEdge を返す型

メディアインターフェースを表します。

フィールド

alt(String)
メディアの性質や内容を共有するための単語やフレーズ。

mediaContentType (MediaContentType!)
メディアのコンテンツタイプです。

previewImage (Image)
メディアのプレビュー画像。

Media を実装するタイプ

MediaImage(object)

Shopify がホストする画像を表します。

このページの

フィールド

alt (String)
メディアの性質やコンテンツを共有するための単語やフレーズ。

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

image (Image)
メディアのイメージです。

mediaContentType (MediaContentType!)
メディアのコンテンツタイプ。

previewImage (Image)
メディアのプレビュー画像。

インプリメント

Model3d(object)

Shopify がホストする 3D モデルを表します。

このページについて

フィールド

alt (String)
メディアの性質やコンテンツを共有するための単語やフレーズ。

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

mediaContentType (MediaContentType!)
メディアのコンテンツタイプです。

previewImage (Image)
メディアのプレビュー画像。

sources ([Model3dSource!]!)
3D モデルのソースです。

インプリメント

Model3dSource(object)

Shopify がホストする 3D モデルのソースを表します。

このページの

フィールド

filesize (Int!)
3d モデルのファイルサイズ。

format (String!)
3d モデルのフォーマット。

mimeType (String!)
3d モデルの MIME タイプを指定します。

url (String!)
3d モデルの URL です。

Model3dSource を返す型

Product(object)

商品とは、Shopify ストアで販売される個々のアイテムを表します。商品は物理的なものが多いですが、必ずしもそうである必要はありません。例えば、デジタルダウンロード(映画、音楽、電子書籍など)も商品として認められますし、サービス(機器のレンタル、貸し出し、他の商品のカスタマイズ、延長保証など)も商品として認められます。

このページについて

コネクション

collections (CollectionConnection!)
製品が属するコレクションのリスト

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

images (ImageConnection!)
製品に関連する画像のリスト。

引数 説明
after ( String ) 指定したカーソルの後にある要素を返します。
before ( String ) 指定されたカーソルより前にある要素を返す。
crop ( CropRegion ) 指定された領域に従って画像をクロップします。この引数は、非推奨です。代わりに Image.transformedSrccrop を使用してください。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リスト内の最後の n 個の要素までを返します。
maxHeight ( Int ) 画像の高さを 1 から 2048 までのピクセル数で指定します。この引数は非推奨です。代わりに Image.transformedSrcmaxHeight を使用してください。
maxWidth ( Int ) 1 から 2048 までのピクセル単位での画像の幅。この引数は推奨されません。代わりに Image.transformedSrcmaxWidth を使用してください。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false
scale ( Int ) 高解像度の網膜ディスプレイのための画像サイズの乗数。1 から 3 までの値でなければなりません。この引数は非推奨です。代わりに Image.transformedSrcscale を使用する。
デフォルト値:1
sortKey ( ProductImageSortKeys ) 対象となるリストを、与えられたキーでソートします。
デフォルトの値: POSITION

media (MediaConnection!)
製品に関連するメディア。

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

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

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

sellingPlanGroups (SellingPlanGroupConnection!)
商品の利用可能な販売計画グループのリストです。販売計画グループは、販売方法を表します。例えば、「Subscribe and save」は、顧客が配送ごとに商品やサービスの代金を支払う販売方法です。販売プラングループは、個々の販売プランを含みます。

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

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

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

フィールド

availableForSale (Boolean!)
少なくとも 1 つの製品バリアントが販売可能かどうかを示す。

compareAtPriceRange (ProductPriceRange!)
すべてのバリアントにおける製品の比較対象価格。

createdAt (DateTime!)
製品が作成された日付と時間。

description (String!)
HTML タグが削除された 1 行の製品の説明。

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

descriptionHtml (HTML!)
製品の説明を HTML 形式で表示します。

handle (String!)
商品のタイトルから自動的に生成された、人間にとって使いやすいユニークな文字列です。Liquid のテンプレート言語では、オブジェクトを参照するために使用されます。

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

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

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

onlineStoreUrl (URL)
ショップのオンラインストアでリソースを表示するための URL です。リソースが現在オンラインストアの販売チャネルに公開されていない場合は、NULL とすることができます。

options ([ProductOption!]!)
製品オプションのリスト。

引数 説明
first ( Int ) 配列の結果をこのサイズに切り詰める。

priceRange (ProductPriceRange!)
価格帯を指定します。

productType (String!)
製品がタグ付けできるカテゴリーで、一般的にフィルタリングや検索に使用されます。

publishedAt (DateTime!)
商品がチャンネルに公開された日時。

requiresSellingPlan (Boolean!)
商品がセリングプランを利用しないと購入できないかどうか。

seo (SEO!)
商品の SEO 情報。

tags ([String!]!)
製品に追加されているタグのコンマ区切りリスト。プライベートアプリに必要な追加のアクセススコープ:unauthenticated_read_product_tags。

title (String!)
商品のタイトルです。

totalInventory (Int)
この商品の在庫の総量。

updatedAt (DateTime!)
製品が最後に変更された日時。製品の updatedAt 値は様々な理由で変更される可能性があります。例えば、在庫追跡が設定されている商品に注文が入った場合、在庫調整が更新としてカウントされます。

variantBySelectedOptions (ProductVariant)
選択されたオプションに基づいて、製品のバリアントを検索します。これは、ユーザーが選択した製品オプションを、1 つのマッチするバリアントに変換するのに便利です。選択されたオプションに対応するバリアントがない場合は、NULL が返されます。

引数 説明
selectedOptions ( [SelectedOptionInput!]! ) required 選択されたオプションに使用される入力フィールド。

vendor (String!)
製品のベンダー名。

Product を返す型

インプリメント

非推奨のフィールド

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
presentmentCurrencies ( [CurrencyCode!] ) 価格帯を返すプレセンテーション通貨を指定します。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false

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

このページについて

フィールド

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

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

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

このページについて

フィールド

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

node (Product!)
ProductEdge の末尾の項目。

ProductEdge を返す型

ProductOption(object)

お客様が選択できる「サイズ」「カラー」「素材」などの商品プロパティ名。バリアントは、これらのオプションの組み合わせに基づいて選択されます。それぞれ 255 文字の制限があります。

このページについて

フィールド

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

name (String!)
製品オプションの名前。

value ([String!]!)
商品オプション名に対応する値。

製品オプションを返す型

インプリメント

ProductPriceRange(object)

商品の価格帯です。

このページについて

フィールド

maxVariantPrice (MoneyV2!)
最高のバリアントの価格です。

minVariantPrice (MoneyV2!)
製品の最低価格。

ProductPriceRange を返す型

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

このページについて

フィールド

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

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

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

このページについて

フィールド

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

node (ProductPriceRange!)
ProductPriceRangeEdge の末尾の項目。

ProductPriceRangeEdge を返す型

ProductVariant(object)

ProductVariant は、サイズ違いや色違いなど、製品の異なるバージョンを表します。

このページについて

コネクション

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

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

sellingPlanAllocations (SellingPlanAllocationConnection!)
バリアントと販売計画の間の関連を表します。販売計画の割り当ては、各バリアントでどの販売計画が利用可能か、またその価格への影響を記述します。

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

storeAvailability (StoreAvailabilityConnection!)
このバリアントのロケーション別のインストアピックアップの可用性。

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

フィールド

availableForSale ( Boolean )
製品バリアントが販売可能かどうかを示す。

compareAtPriceV2 (MoneyV2)
バリアントの比較対象価格。compareAtPriceV2priceV2 よりも高い場合に、バリアントを販売中としてマークするために使用できます。

currentlyNotInStock (Boolean!)
商品が在庫切れであるが、まだ購入可能であるかどうか(バックオーダーに使用)。

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

image (Image)
商品のバリエーションに関連する画像。このフィールドは、画像がない場合、製品画像にフォールバックします。

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

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

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

priceV2 (MoneyV2!)
製品バリアントの価格です。

product (Product!)
製品バリアントが属する製品オブジェクト。

quantityAvailable (Int)
オンライン販売チャネル用の商品バリアントの総販売可能数量。

requiresShipping (Boolean!)
製品バリアントの注文時に、顧客が配送先住所を提供する必要があるかどうか。

selectedOptions ([SelectedOption!]!)
バリアントに適用される製品オプションのリスト。

sku (String)
バリアントに関連する SKU (stock keeping unit)。

title (String!)
製品バリアントのタイトル。

unitPrice (MoneyV2)
バリアントの計測値に基づく単価値です。

unitPriceMeasurement (UnitPriceMeasurement)
variant の単位価格の測定値。

weight (Float)
weight_unit で指定された単位系での製品 variant の重量。

weightUnit (WeightUnit!)
重量の測定単位。

ProductVariant を返す型

インプリメント

非推奨のフィールド

  • available (Boolean) deprecated
    製品バリアントが在庫ありであるかどうかを示します。

compareAtPrice (Money) 非推奨
variant の compareAtPrice です。これは、compareAtPrice が価格よりも高い場合に、バリアントを販売中としてマークするために使用できます。

presentmentPrices (ProductVariantPricePairConnection!) deprecated
このショップのプレセント通貨の価格と compare-at price のリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
presentmentCurrencies ( [CurrencyCode!] ) 価格が返すべき予約通貨を指定します。
reverse ( Boolean ) 対象となるリストの順序を逆にします。
デフォルト値:false

presentmentUnitPrices (MoneyV2Connection!) deprecated
このショップのプレセント通貨での単価のリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
presentmentCurrencies ( [CurrencyCode!] ) プレセンテーションの単価を返す通貨を指定します。
reverse ( Boolean ) 対象となるリストの順序を逆にします。
デフォルト値:false

price (Money!) 非推奨
商品バリアントの価格です。

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

このページでは

フィールド

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

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

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

このページでは

フィールド

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

node (ProductVariant!)
ProductVariantEdge の末尾の項目。

ProductVariantEdge を返す型

ProductVariantPricePair(object)

比較対象となる価格と、通貨を共有するバリアントの価格です。

このページについて

フィールド

compareAtPrice (MoneyV2)
通貨を共有しているバリアントの比較時の価格。

price (MoneyV2!)
関連する通貨でのバリアントの価格。

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

このページについて

フィールド

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

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

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

このページについて

フィールド

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

node (ProductVariantPricePair!)
ProductVariantPricePairEdge の末尾の項目。

ProductVariantPricePairEdge を返す型

SelectedOption(object)

顧客が製品のバリエーションを選択する際に使用されるプロパティです。商品は、異なるサイズや色など、複数のオプションを持つことができます。

このページについて

フィールド

name (String!)
製品オプションの名称です。

value (String!)
製品オプションの値

SelectedOption を返す型

SellingPlan(object)

製品やバリアントの販売・購入方法を表す。

このページについて

フィールド

description (String)
販売計画の説明。

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

name (String!)
販売プランの名前です。例えば、「6 週間分のプリペイドグラノーラを毎週お届け」など。

options ([SellingPlanOption!]!)
ストアフロントのドロップダウンリストで利用できる販売プランのオプションを表す。例えば、'Delivery every week' や 'Delivery every 2 weeks' は、商品の配送頻度オプションを指定します。

priceAdjustments ([SellingPlanPriceAdjustment!]!)
販売プランでバリアントが購入されたときに、販売プランが価格にどのように影響するかを表します。

recurringDeliveries (Boolean!)
セリングプランを購入すると、複数回の配送が行われるかどうか。

SellingPlan を返す型

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

このページについて

フィールド

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

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

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

このページについて

フィールド

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

node (SellingPlan!)
SellingPlanEdge の末尾の項目。

SellingPlanEdge を返す型

SellingPlanAllocation(object)

バリアントとセリングプランの関連を表します。販売プランの割り当てでは、各バリアントに提供されるオプションと、販売プランと一緒に購入した場合のバリアントの価格を記述します。

このページについて

フィールド

priceAdjustments ([SelingPlanAllocationPriceAdjustment!]!)
価格調整のリストで、最大 2 つです。2 つの場合、最初の価格調整は購入時に有効となり、2 つ目の価格調整は一定の注文数の後に開始されます。

sellingPlan (SellingPlan!)
製品やバリアントがどのように販売・購入されるかを表現したもの。例えば、個々の販売計画は「6 週間分のプリペイドグラノーラを毎週お届けします」となります。

SellingPlanAllocation を返す型

ProductVariant.sellingPlanAllocations
複数の SellingPlanAllocations をページングするために自動生成される型です。

このページについて

フィールド

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

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

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

このページについて

フィールド

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

node (SellingPlanAllocation!)
SellingPlanAllocationEdge の末尾の項目。

SellingPlanAllocationEdge を返す型

SellingPlanAllocationPriceAdjustment(object)

特定の販売プランで購入された場合のバリアントの結果の価格。

このページについて

フィールド

compareAtPrice (MoneyV2!)
同じ配送回数で販売プランなしで購入された場合のバリアントの価格。例えば、お客様が 10 ドルのグラノーラを 6 回分購入した場合、価格は 6×10 ドル= 60 ドルとなります。

perDeliveryPrice (MoneyV2!)
1 回の配送にかかる実効価格です。例えば、48 ドルの価格で 6 回の配送を行うプリペイド式定期購入プランの場合、配送 1 回あたりの価格は 8 ドルとなります。

price (MoneyV2!)
販売プランと一緒に購入された場合のバリアントの価格 例えば、お客様が 20%オフになる 10 ドルのグラノーラを 6 回お届けするプリペイド式定期購入プランの場合、価格は 6×10.00 ドル ×0.80 = 48.00 ドルとなります。

unitPrice (MoneyV2)
販売計画に関連付けられたバリアントの結果としての 1 個あたりの価格。バリアントが数量や測定によって販売されていない場合は、このフィールドは null を返します。

SelingPlanAllocationPriceAdjustment を返す型

SellingPlanFixedAmountPriceAdjustment(object)

元のバリアント価格から差し引かれる固定額。例えば、10 ドル引きなど。

このページについて

フィールド

adjustmentAmount (MoneyV2!)
価格調整の貨幣価値。

SellingPlanFixedPriceAdjustment(object)

販売プランで購入されたバリアントの固定価格調整。

このページについて

フィールド

price (MoneyV2!)
販売プランで購入された場合の、バリアントの新しい価格。

SellingPlanGroup(object)

販売方法を表す。例えば、「Subscribe and save」は、顧客が商品やサービスの代金を配送ごとに支払う販売方法である。販売プラングループには、個々の販売プランが含まれます。

このページについて

コネクション

sellingPlans (SellingPlanConnection!)
販売計画グループ内の販売計画のリスト。販売計画とは、製品やバリエーションをどのように販売・購入できるかを表したものです。例えば、個々の販売計画は「6 週間分のプリペイドグラノーラ、毎週配達」となります。

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

フィールド

z
appName (String)
販売計画グループを作成したアプリの表示に適した名前です。

name (String!)
販売計画グループの名前です。

options ([SellingPlanGroupOption!]!)
ストアフロントのドロップダウンリストで利用可能な販売プランのオプションを表します。例えば、'Delivery every week' や 'Delivery every 2 weeks' は、商品の配送頻度オプションを指定します。

SellingPlanGroup を返す型

このページについて

フィールド

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

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

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

このページについて

フィールド

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

node (SellingPlanGroup!)
SellingPlanGroupEdge の末尾の項目。

SellingPlanGroupEdge を返す型

SellingPlanGroupOption(object)

ストアフロントのドロップダウンリストで利用可能な販売プラングループのオプションを表します。

このページについて

フィールド

name (String!)
オプションの名前です。例えば、'Delivery every' です。

values ([String!]!)
販売プラングループ内の販売プランで指定されたオプションの値です。例えば、'1 週間'、'2 週間'、'3 週間'などです。

SellingPlanGroupOption を返す型

SellingPlanOption(object)

セリングプランが提供するオプションです。

このページについて

フィールド

name (String)
オプションの名前(例:"Delivery every")。

value (String)
オプションの値(例:"Month")を指定します。

SellingPlanOption を返す型

SellingPlanPercentagePriceAdjustment(object)

元のバリアント価格から差し引かれるパーセンテージの金額。例えば、10%オフなど。

このページについて

フィールド

  • adjustmentPercentage (Int!)
    価格調整のパーセント値です。

SellingPlanPriceAdjustment(object)

販売計画に関連付けられたバリアントの価格がどれだけ調整されたかを表す。各バリアントは、最大 2 つの価格調整を持つことができます。

このページについて

フィールド

adjustmentValue (SellingPlanPriceAdjustmentValue!)
価格調整のタイプです。調整値には、パーセンテージ、割引額、新価格の 3 つのタイプがあります。

orderCount (Int)
価格調整が常に適用される場合は、このフィールドは null です。

SellingPlanPriceAdjustment を返す型

UnitPriceMeasurement(object)

商品のバリエーションの単価を計算するために使用される測定値です(例:$9.99 / 100ml)。

このページについて

フィールド

measuredType (UnitPriceMeasurementMeasuredType)
UnitPriceMeasurement の測定単位のタイプです。

quantityUnit (UnitPriceMeasurementMeasuredUnit)
単位価格測定のための数量単位。

quantityValue (Float!)
単位価格測定のための量の値を表します。

referenceUnit (UnitPriceMeasurementMeasuredUnit)
単位価格測定のための参照単位です。

referenceValue (Int!)
単位価格測定の参照値。

UnitPriceMeasurement を返す型

Video(object)

Shopify がホストするビデオを表します。

このページについて

フィールド

alt (String)
メディアの性質やコンテンツを共有するための単語やフレーズ。

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

mediaContentType (MediaContentType!)
メディアのコンテンツタイプです。

previewImage (Image)
メディアのプレビュー画像。

sources ([VideoSource!]!)
ビデオのソースです。

インプリメント

VideoSource(object)

Shopify がホストするビデオのソースを表します。

このページについて

フィールド

format (String!)
ビデオソースのフォーマット。

height (Int!)
ビデオの高さ。

mimeType (String!)
動画の MIME タイプ。

url (String!)
動画の URL です。

width (Int!)
ビデオの幅。

VideoSource を返す型

INPUTS

PriceRangeFilter(input, object)

コレクションの中で、特定の価格帯に合致する商品のサブセットを表示するために使用されるフィルタです。

入力フィールド

max (Float)
範囲内の最大価格。空の場合は、最大価格がないことを示します。

min (Float)
レンジ内の最小価格。デフォルトは 0 です。

ProductFilter(input, object)

コレクション内の製品のサブセットを表示するために使用されるフィルタです。

入力フィールド

inStock (Boolean)
商品が在庫ありかどうかのフィルタです。

price (PriceRangeFilter)
フィルタリングする価格の範囲。

productType (String)
フィルタリングの対象となる製品タイプ。

productVendor (String)
フィルタリングの対象となる製品のベンダー。

variantOption (VariantOptionFilter)
絞り込みたいバリアントオプション。

SelectedOptionInput(input, object)

選択されたオプションに必要な入力フィールドを指定します。

入力フィールド

name (String!) required
製品オプションの名前です。

value (String!) required
商品オプションの値を指定します。

VariantOptionFilter(input, object)

特定のバリアントオプションにマッチするコレクション内の商品のサブセットを表示するために使用されるフィルタです。

入力フィールド

name (String!) required
フィルタリングするバリアントオプションの名前です。

value (String!) required
フィルタリングの対象となるバリアントオプションの値。

CollectionSortKeys(enum)

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

ID
id値でソートします。

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

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

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

MediacontentType(enum)

メディア オブジェクトで使用可能なコンテンツ タイプ。

EXTERNAL_VIDEO
外部でホストされているビデオ。

IMAGE
Shopify がホストする画像

MODEL_3D
3D モデル

VIDEO
Shopify が提供するビデオ

MediaContentType を返す型

MediaHost(enum)

メディアリソースのホスト。

VIMEO
Vimeo の埋め込みビデオ用のホストです。

YOUTUBE
YouTube の埋め込みビデオ用のホスト。

MediaHost を返す型

ProductCollectionSortKeys(enum)

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

BEST_SELLING
best-sellingの値でソートします。

COLLECTION_DEFAULT
collection-defaoutの値でソートします。

CREATED
createdの値でソートします。

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

MANUAL
manualの値でソートします。

PRICE
priceの値でソートします。

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

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

ProductImageSortKeys(enum)

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

CREATED_AT
created_at の値でソートします。

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

POSITION
positionの値でソートします。

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

ProductMediaSrtKeys(enum)

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

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

POSITION
positonの値でソートします。

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

ProductSortKeys(enum)

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

BEST_SELLING
best_sellingの値でソートします。

CREATED_AT
created_atの値でソートします。

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

PRICE
priceの値でソートします。

PRODUCT_TYPE
product_typeの値でソートします。

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

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

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

VENDOR
venderの値でソートします。

ProductVariantSortKeys(enum)

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

ID
id 値でソートします。

POSITION
positionの値でソートします。

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

SKU
sku の値でソートします。

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

UnitPriceMeasurementMeasuredType(enum)

受け入れられる測定単位のタイプ。

AREA
面積を表す測定単位

LENGTH
長さを表す測定単位

VOLUME
体積を表す計測単位。

WEIGHT
重さを表す測定単位。

UnitPriceMeasurementMeasuredType を返す型

UnitPriceMeasurementMeasuredUnit(enum)

単位価格測定のための有効な測定単位。

CL
100 センチリットルは 1 リットルに相当します。

CM
100 センチは 1 メートルに相当する。

G
メートル法による重さの単位。

KG
1 キログラムは 1000 グラムに相当します。

L
メートル法による体積の単位。

M
長さを表すメートル法の単位。

M2
面積を表すメートル法の単位。

M3
1 立方メートルは 1000 リットルに相当します。

MG
1000 ミリグラムが 1 グラムに相当する。

ML
1000 ミリリットル(1 リットル)。

MM
1000 ミリメートルは 1 メートルに相当します。

UnitPriceMeasurementMeasuredUnit を返す型

Discussion

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