📈

【Shopify.dev和訳】Admin API/GraphQL ref/Products & Collections③

2021/10/01に公開約77,300字

この記事について

この記事は、AdminAPI/GraphQL reference/ProdCollectionの記事を和訳したものです。

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

Products and Collections APIs

Products and Collections API はストアのカタログにアクセスし、操作することができます。

OBJECTSの続きです。

OBJECTS

Product (object)

Product リソースでは、マーチャントストアの商品を管理できます。ProductVariants を使用して、同じ商品の異なるバージョンを作成または更新することができます。また、商品のメディアを追加または更新することもできます。商品は、コレクションにグループ化して整理することができます。

Connections

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

imagesImageConnection! )
商品に関連する画像。

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

media ( MediaConnection! )
商品に関連するメディア。画像や3Dモデル、動画などが含まれます。

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

metafields ( MetafieldConnection! )
リソースに属するメタフィールドのリスト。

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

privateMetafields ( PrivateMetafieldConnection! )
リソースに属するプライベート・メタフィールドのリスト。

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

resourcePublications ( ResourcePublicationConnection! )
パブリケーションに公開されているリソースのリストです

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
onlyPublished ( Boolean ) 現在公開されているリソースのみを返すかどうか。false の場合は、公開予定のリソースも返します。
デフォルト値:ture
reverse ( Boolean ) 対象となるリストの順序を逆にします。
デフォルト値:false

resourcePublicationsV2 ( ResourcePublicationV2Connection! )
パブりケーションに公開されているか、公開されるようにステージングされているリソースのリストです。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
onlyPublished ( Boolean ) 現在公開されているリソースのみを返すかどうか。false の場合は、公開予定のリソースも返します。
デフォルト値:ture
reverse ( Boolean ) 対象となるリストの順序を逆にします。
デフォルト値:false

unpublishedPublications ( PublicationConnection! )
リソースが公開されていない出版物のリスト。

引数 説明
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( CollectionSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値:POSITION

Fields

availablePublicationCount ( Int! )
フィードバックエラーなしにリソースが公開された出版物の数。

createdAt ( DateTime! )
商品が作成された日付と時間( ISO 8601形式 )。

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

description ( String! )
HTMLタグを削除した1行の商品の説明

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

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

featuredImage ( Image )
商品のイメージです。

featuredMedia ( Media )
商品のメディアです。

feedback ( ResourceFeedback )
リソースフィードバックで提供される商品に関する情報。

giftCardTemplateSuffix ( String )
ストアでギフトカードを表示するときに使われるテーマテンプレート。

handle ( String! )
商品のタイトルのユニークなヒューマンフレンドリーな文字列です。

hasOnlyDefaultVariant ( Boolean! )
商品が、デフォルトのオプションと値を持つ単一のバリアントのみを持つかどうか。

hasOutOfStockVariants ( Boolean! )
商品に在庫切れのバリアントがあるかどうか。

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

inCollection ( Boolean! )
商品が指定されたコレクションに入っているかどうか。

引数 説明
id ( ID! ) required チェックするコレクションのIDです。

isGiftCard ( Boolean! )
商品がギフトカードであるかどうか。

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

mediaCount ( Int! )
商品に属するメディアの総カウント。

metafield ( Metafiled )
リソースに属する、名前空間とキーによるメタフィールドを返します。

引数 説明
key ( String! ) required メタフィールドのキーを指定します。
namespace ( String! ) required メタフィールドのための名前空間。

onlineStorePreviewUrl ( URL )
オンラインストアのプレビューURLです。

onlineStoreUrl ( URL )
商品のオンラインストアのURLです。値がnullの場合は、商品がオンラインストアの販売チャネルに公開されていないことを示します。

options ( [ProductOption!]! )
商品オプションのリストです。制限はShop.resourceLimits.maxProductOptionsで指定されます。

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

priceRangeV2 ( ProductPriceRangeV2! )
価格が小数でフォーマットされた商品の価格帯。

privateMetafield ( PrivateMetafield )
リソースに属する、名前空間とキーによるプライベートメタフィールドを返します。

引数 説明
key ( String! ) required プライベート・メタフィールドのキーを指定します。
namespace ( String required ) プライベートメタフィールドの名前空間。

productType ( String! )
マーチャントが指定した商品タイプ。

publicationCount ( Int! )
リソースが公開されている出版物の数。

引数 説明
onlyPublished ( Boolean ) 公開されているリソースの出版物のみを含める。falseの場合は、将来の出版物を含む、リソースのすべての出版物を返します。
デフォルト値:ture

publishedAt ( DateTime )
商品がオンラインストアに公開された日時( ISO 8601 format )。

publishedOnCurrentPublication ( Boolean! )
リソースが呼び出したアプリのパブリケーションに公開されているかどうかを確認します。

publishedOnPublication ( Boolean! )
リソースが指定されたパブリケーションに公開されているかどうかを確認します。

publishedOnPublication ( Boolean! )
リソースが指定されたパブリケーションに公開されているかどうかを確認します。

引数 説明
publicationId ( ID! ) required チェックする出版物のID。

requiresSellingPlanBoolean! )
商品が販売プラン(サブスクリプション)でしか購入できないかどうかを示します。サブスクリプションで販売されている商品( requestsSellingPlan: ture)は、オンラインストアでのみ更新できます。商品をサブスクリプションのみに更新した場合、その商品はオンラインストア以外のすべてのチャネルから公開されなくなります。

sellingPlanGroupCount ( Int! )
商品に関連する販売計画グループの数。

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

status ( ProductStatus! )
商品のステータス。すべてのチャネルでの可視性をコントロールします。

storefrontId ( StorefrontID! )
商品のストアフロントIDです。

tags ( [String!]! )
商品に関連するタグのコンマ区切りリスト。タグを更新すると、以前に商品に追加された既存のタグはすべて上書きされます。既存のタグを上書きせずに新しいタグを追加するには、tagsAdd mutation を使用します。

templateSuffixString )
ストアで商品を表示するときに使われるテーマテンプレート。

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

totalInventory ( Int! )
在庫の数量。

totalVariants ( Int! )
商品に関連付けられているバリアントの数。

tracksInventory ( Boolean! )
商品に対して在庫追跡が有効になっているかどうか。

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

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

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

vendor ( String! )
商品のベンダーの名前です。

Productを返す型

Productのmutation

productAppendImages
商品に画像を追加します。

productChangeStatus
商品のステータスを変更します。これにより、すべてのチャネルで商品の可用性を設定することができます。

productCreate
商品を作成します。

productCreateMedia
商品のメディアを作成します。

productDelete
商品を削除します。関連するすべてのバリエーションとメディアも削除されます。

productDeleteImages
商品から商品画像を削除します。

productDeleteMedia
商品のメディアを削除します。

productDuplicate
商品を複製します。

productImageUpdate
商品の画像を更新します。

productJoinSellingPlanGroups
商品に複数の販売計画グループを追加します。

productLeaveSellingPlanGroups
商品から複数のグループを削除する。

productReorderImages
指定された商品のイメージセットを非同期的に再注文します。

productReorderMedia
非同期に、商品に添付されているメディアを再注文します。

productUpdate
商品の更新を行います。商品を更新したときに、一部のバリアントだけを更新に含めると、含まれていないバリアントは削除されます。除外されたバリアントを削除するリスクなしにバリアントを安全に管理するには、 productVariantsBulkUpdate を使用してください。単一のバリアントをアップデートしたい場合は、productVariantUpdate を使用してください。

productUpdateMedia
商品のメディアを更新します。

Implements

Deprecated fields

  • bodyHtml ( String ) deprecated
    商品の説明をHTML形式で記述したもの。
  • descriptionPlainSummary ( String )
    商品の説明を、HTMLタグを削除して1行にまとめたもの。60文字に切り詰められています。
引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
reverse ( Boolean ) 対象となるリストの順序を逆にします。
デフォルト値:false
引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
onlyPublished ( Boolean ) 現在公開されているリソースのみを返すかどうか。falseの場合は、公開予定のリソースも返します。
デフォルト値:ture
reverse ( Boolean ) 対象となるリストの順序を逆にします。
デフォルト値:false
  • publishedOnChannel ( Boolean! ) deprecated
    指定されたチャンネルにリソースが公開されているかどうかを確認します。
引数 説明
channelId ( ID! ) required チェックするチャンネルのID。
  • publishedOnCurrentChannel ( Boolean! ) deprecated
    呼び出し側のアプリのチャンネルにリソースが公開されているかどうかを確認します。
  • unpublishedChannels ( ChannelConnection! ) deprecated
    リソースが公開されていないチャンネルのリストです。
引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
reverse ( Boolean ) 対象となるリストの順序を逆にします。
デフォルト値:false

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

FIelds

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

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

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

FIelds

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

node ( Product! )
ProductEdgeの末尾のアイテム。

ProductEdgeを返す型

Samples

query
# 商品のタイトルと説明を取得する
{
  product(id: "gid://shopify/Product/1974208299030") {
    title
    description
  }
}
response
{
  "data": {
    "product": {
      "title": "Rough Snowflake Camisole",
      "description": ""
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 1,
      "actualQueryCost": 1,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 999,
        "restoreRate": 50
      }
    }
  }
}

ProductContextualPricing (object)

与えられた文脈における特定の製品の価格設定。

Fields

maxVariantPricing (ProductVariantContextualPricing)
与えられたコンテキストの中で最も高い価格を持つバリアントの価格設定。

minVariantPricing (ProductVariantContextualPricing)
与えられたコンテキストでの最低価格を持つバリアントの価格設定。

priceRange (ProductPriceRangeV2!)
価格を小数でフォーマットした製品の価格帯。

ProductContextualPricingを返すタイプ

ProductOption (object)

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

Fields

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

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

position ( Int! )
商品オプションの位置。

translations ( [PublishedTranslation!]! )
リソースに関連する翻訳。

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

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

ProductOption を返すタイプ

Implements

Samples

query
# カスタムプロダクトプロパティのIDを取得
{
  product(id:"gid://shopify/Product/1974208299030") {
    options {
      id
      name
      position
      values
    }
  }
}
response
{
  "data": {
    "product": {
      "options": [
        {
          "id": "gid://shopify/ProductOption/2753016856598",
          "name": "Title",
          "position": 1,
          "values": [
            "Default Title"
          ]
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 2,
      "actualQueryCost": 2,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 996,
        "restoreRate": 50
      }
    }
  }
}

ProductPriceRange (object)

商品の価格帯です。

Fields

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

minVariantPrice ( MoneyV2! )
最も低い価格帯。

ProductPriceRangeV2 (object)

商品の価格範囲です。

Fields

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

minVariantPrice ( MoneyV2! )
最も低い価格のバリアント。

ProductPriceRangeV2を返す型

ProductPublication (object)

商品が公開されているチャンネルを表します。

Fields

channel ( Channel! )
商品が公開された、または公開されているチャネル。

isPublishedBoolean )
パブリッシュされているかどうか。

product ( Product! )
チャネルで公開された、または公開される予定の商品。

publishDate ( DateTime )
商品がチャンネルで公開された、または公開される予定の日付。

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

ProductPublicationEdge

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

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

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

Fields

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

node ( ProductPublication! )
ProductPublicationEdgeの末尾の項目。

ProductPublicationEdgeを返す型

ProductVariant (object)

プロダクトバリエーションを表す。

Connections

media ( MediaConnection! )
商品バリアントに関連するメディア

引数 説明
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 ) フィルタリングの対象となるメタフィールドの名前空間です。
reverse ( Boolean ) 対象となるリストの順序を逆にします。
デフォルト値:false

presentmentPrices ( ProductVariantPricePairConnection! )
このショップのプレセント通貨での価格と比較対象価格のリスト。

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

privateMetafields ( PrivateMetafieldConnection! )
リソースに属するプライベート・メタフィールドのリスト。

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

Fields

availableForSale ( Boolean! )
商品のバリエーションが販売可能かどうか。

barcode ( String )
商品に関連するバーコードの値。

compareAtPrice ( Money )
バリアントの比較対象価格。デフォルトはショップ通過。

createdAt ( DateTime! )
バリアントが作成された日付と時間。

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

deliveryProfile ( DeliveryProfile )
バリアントの配信プロファイルです。

displayName ( String! )
Product's title + variant's title に基づく variant の表示名。

fulfillmentService ( FulfillmentService )
商品に関連するフルフィルメントサービス。

fulfillmentServiceEditable ( EditableProperty! )
商品のバリアントに対するフルフィルメントサービスの変更が許可されているかどうか。

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

inventoryItem ( InventoryItem! )
インベントリ情報を照会するためのインベントリアイテムです。

inventoryPolicy ( ProductVariantInventoryPolicy! )
在庫がないときに顧客が商品バリアントに注文を出すことができるかどうか。

inventoryQuantity ( Int )
バリアントの総販売可能数量。

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

metafield ( Metafield )
リソースに属する、名前空間とキーによるメタフィールドを返します。

引数 説明
key ( String! ) required メタフィールドのキーを指定します。
namespace ( String! ) required メタフィールドのための名前空間。

positionInt! )
商品バリアントのリストの中での商品バリアントの順番です。リストの最初の位置は1です。

price ( Money! )
デフォルトのショップ通貨での商品バリアントの価格です。

privateMetafield ( PrivateMetafiled )
リソースに属している名前空間とキーによるプライベートメタフィールドを返します。

引数 説明
key ( String! ) required プライベート・メタフィールドのキーを指定します。
namespace ( String! ) required プライベート・メタフィールドのための名前空間。

product ( Product! )
このバリアントが属する商品です。

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

sellingPlanGroupCount ( Int! )
商品バリアントに関連付けられた販売計画グループの数。

sku ( String )
ショップ内の商品バリアントの識別子。フルフィルメントサービスに接続するために必要です。

storefrontId ( StorefrontID! )
プロダクトバリアントのストアフロントIDです。

taxCode ( String )
プロダクトバリアントのタックスコードです。

taxable ( Boolean! )
商品バリアントが販売されるときに税金が請求されるかどうか。

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

translations ( [PublishedTranslation!]! )
リソースに関連する翻訳。

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

updatedAt ( DateTime! )
商品バリアントが最後に修正された日時(ISO 8601フォーマット)。

weight ( Float )
weight_unit で指定された単位系での商品バリアントの重量。

weightUnit ( WeightUnit! )
商品バリアントの重量に適用される測定単位です。weight_unit に値を指定しない場合は、ショップのデフォルトの単位が適用されます。有効な値: g, kg, oz, lb.

ProductVariantを返す型

ProductVariantのmutation

productVariantAppendMedia
商品のメディアをその商品のバリアントに追加します。

productVariantCreate
商品バリアントを作成します。

productVariantDelete
商品のバリアントを削除します。

productVariantDetachMedia
商品バリアントからメディアを削除します。

productVariantJoinSellingPlanGroups
商品バリアントに複数の販売計画グループを追加します。

productVariantLeaveSellingPlanGroups
商品バリアントから複数のグループを削除します。

productVariantUpdate
商品バリアントを更新します。

productVariantsBulkCreate
商品バリアントを一括で作成します。

productVariantsBulkDelete
商品バリアントを一括して削除します。

productVariantsBulkReorder
商品バリアントを一括で再注文する。

productVariantsBulkUpdate
商品バリアントを一括で更新します。

Implements

Deprecated fields

  • harmonizedSystemCode ( String ) deprecated
    バリアントのハーモナイズドシステムコード(またはHS Tariff Code)です。
  • inventoryManagement ( ProductVariantInventoryManagement! ) deprecate;d
    商品バリアントの在庫アイテム数を追跡するフルフィルメントサービスです。
  • requiresShipping ( Boolean! ) deprecated
    商品バリエーションの注文時に、顧客が配送先住所を提供する必要があるかどうか。

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

Fields

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

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

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

Fields

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

node ( ProductVariant! )
ProductVariantEdgeの末尾にある項目です。

ProductVariantEdgeを返す型

Samples

query
# 最初の10個の商品バリアントのIDを取得する
{
  productVariants(first:10) {
    edges {
      node {
        id
      }
    }
  }
}
response
{
  "data": {
    "productVariants": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/ProductVariant/19523123216406"
          }
        },
        {
          "node": {
            "id": "gid://shopify/ProductVariant/19523123249174"
          }
        },
        {
          "node": {
            "id": "gid://shopify/ProductVariant/19523123281942"
          }
        },
        {
          "node": {
            "id": "gid://shopify/ProductVariant/19523123314710"
          }
        },
        {
          "node": {
            "id": "gid://shopify/ProductVariant/19523123347478"
          }
        },
        {
          "node": {
            "id": "gid://shopify/ProductVariant/19523123380246"
          }
        },
        {
          "node": {
            "id": "gid://shopify/ProductVariant/19523123413014"
          }
        },
        {
          "node": {
            "id": "gid://shopify/ProductVariant/19523123445782"
          }
        },
        {
          "node": {
            "id": "gid://shopify/ProductVariant/19523123478550"
          }
        },
        {
          "node": {
            "id": "gid://shopify/ProductVariant/19523123511318"
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 12,
      "actualQueryCost": 12,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 988,
        "restoreRate": 50
      }
    }
  }
}

ProductVariantContextualPricing (object)

与えられた文脈における特定の製品バリエーションの価格設定。

FIelds

compareAtPrice (MoneyV2)
すべての調整が適用された後の最終的な比較対象価格です。

price (MoneyV2!)
すべての調整が適用された後の最終的な価格。

ProductVariantContextualPricingを返すタイプ

ProductVariantPricePair (object)

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

FIelds

compareAtPrice ( MoneyV2 )
バリアントの比較時の価格と関連する通貨。

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

ProductVariantPricePairを返す型

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

Fields

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

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

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

FIelds

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

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

ProductVariantPricePairEdgeを返す型

ResourcePublication (object)

リソースパブリケーションは、リソースがパブリケーションに公開されたことを表します。

Fields

isPublished ( Boolean! )
リソースパブリケーションが公開されているかどうか。また、リソースパブリケーションの公開が予定されている場合はtrueを返します。falseの場合は、リソースパブリケーションは公開されておらず、公開予定もありません。

publication ( Publication! )
リソースパブリケーションが発行されているパブリケーション。

publishDate ( DateTime! )
リソースパブリケーションがパブリケーションに発行された、または発行される予定の日付。

publishable ( Publishable! )
リソースがパブリケーションにパブリッシュされた状態。

ResourcePublication を返す型

Deprecated fields

  • channel ( Channel! ) deprecated
    リソースパブリケーションが公開されているチャネル。

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

Fields

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

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

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

Fields

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

node ( ResourcePublication! )
ResourcePublicationEdgeの末尾の項目。

ResourcePublicationEdge

ResourcePublicationV2 (object)

リソースパブリケーションは、リソースがパブリケーションに公開されているか、公開される予定であることを表します。

Fields

isPublished ( Boolean! )
リソースパブリケーションが公開されているかどうか。true の場合、リソースパブリケーションはパブリケーションに公開されています。false の場合は、リソースパブリケーションはパブリケーションに発行されるようにステージングされています。

publicationPublication! )
リソースパブリケーションが公開されているパブリケーション。

publishDate ( DateTime )
リソースパブリケーションがパブリケーションにパブリッシュされた、またはパブリッシュされる予定の日付。

publishable ( Publishable! )
リソースがパブリケーションにパブリッシュされた状態。

ResourcePublicationV2を返す型

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

Fields

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

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

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

Fields

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

node ( ResourcePublicationV2! )
ResourcePublicationV2Edgeの末尾の項目。

ResourcePublicationV2Edgeを返す型

SelectedOption (object)

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

FIelds

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

valueString! )
商品オプションの値。

SelectedOptionを返す型

SellingPlan (object)

商品の販売・購入方法を表します。販売プランと関連するレコード(販売プラングループとポリシー)は、マーチャントがサブスクリプションアプリをアンインストールしてから48時間後に削除されます。これらのレコードを後で復元する必要がある場合は、バックアップを取ることをお勧めします。

販売プランの詳細については、「販売プランの作成と管理」を参照してください。

Fields

billingPolicy ( SellingPlanBillingPolicy! )
課金の詳細を説明する販売プランのポリシー。

createdAt ( DateTime! )
販売計画が作成された日付と時間。

deliveryPolicy ( SellingPlanDeliveryPolicy! )
配信の詳細を記述する販売プランのポリシー。

description ( String )
販売プランのコミットメントを説明する買い手向きの文字列。

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

name ( String! )
販売プランの顧客向けの説明です。

ストアが複数の通貨をサポートしている場合は、「毎月購入すると、10$ CADが割引されます」などの国別の価格設定コンテンツを含めないでください。このフィールドは異なる通貨を反映して変換されることはありません。

options ( [String!]! )
販売プランで利用可能なすべてのオプションの値です。販売プランは、同じアプリで作成され、同じ selling_plan_group.nameselling_plan_group.options の値を持っている場合、Liquidでグループ化されます。

position ( Int )
販売プランの相対的な表示位置。低い位置が高い位置の前に表示されます。

pricingPolicies ( [SellingPlanPricingPolicy!]! )
販売プランの価格設定の詳細。

SellingPlanを返す型

Implements

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

Fields

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

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

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

Fields

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

nodeSellingPlan! )
SellingPlanEdge の末尾の項目。

SellingPlanEdgeを返す型

SellingPlanAnchor (object)

セリングプランのポリシーアンカーを表します。

Fields

dayInt! )
アンカーの日にちです。

type がWEEKDAYの場合、値は1~7の間でなければなりません。Shopify は ISO 8601 に基づいて曜日を解釈しており、1 は月曜日です。

type がWEEKDAYでない場合、値は1~31の間でなければなりません。

month ( Int )
アンカーの月を指定します。type が YEARDAY でない場合、このフィールドは null でなければならず、そうでない場合は 1 ~ 12 の値でなければなりません。

type ( SellingPlanAnchorType! )
アンカーのタイプを表し、WEEKDAY、MONTHDAY、YEARDAYのいずれかを指定します。

SellingPlanAnchorを返す型

SellingPlanFixedPricingPolicy (object)

固定されたセリングプランの価格政策を表しています。

adjustmentTypeSellingPlanPricingPolicyAdjustmentType! )
価格調整のタイプです。

adjustmentValue ( SellingPlanPricingPolicyAdjustmentValue! )
価格調整値です。

createdAt ( DateTime! )
固定販売プランの価格ポリシーが作成された日時です。

Implements

SellingPlanGroup (object)

販売方法を表します(例:「Subscribe and save」や「Prepaid」)。販売プラングループと関連レコード(販売プランとポリシー)は、マーチャントがサブスクリプションアプリをアンインストールしてから48時間後に削除されます。後で復元する必要がある場合は、これらのレコードをバックアップすることをお勧めします。

Connections

productVariants ( ProductVariantConnection! )
販売計画グループに関連する商品バリアント

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

productsProductConnection! )
販売計画グループに関連する商品

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

sellingPlans ( SellingPlanConnection! )
販売計画グループに関連する販売計画

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

Fields

appId ( String )
アプリの識別子で、LiquidとProductのJSONで公開されます。

appliesToProduct ( Boolean! )
与えられた商品が、販売プラングループに直接関連しているかどうか。

引数 説明
productId ( ID! ) required 商品のIDです。

appliesToProductVariant ( Boolean! )
与えられた商品バリアントが販売計画グループに直接関連付けられているかどうか。

引数 説明
productVariantId ( ID! ) required 商品のID。

appliesToProductVariants ( Booean! )
与えられた商品の商品バリアントのいずれかが、販売計画グループに関連付けられているかどうか。

引数 説明
productId ( ID! ) required 商品のID。

createdAt ( DateTime! )
販売計画グループが作成された日時。

description ( String )
販売プラングループのマーチャント向けの説明です。

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

merchantCode ( String! )
販売プラン・グループの商人向けラベル。

name ( String! )
販売プラングループの買い手向けのラベル。

options ( [String!]! )
販売プラングループで利用可能なすべてのオプションの値です。販売プランは、同じアプリで作成され、同じ selling_plan_group.nameselling_plan_group.options の値を持っている場合、Liquidにまとめられます。

position ( Int )
販売プラングループの表示用相対位置。

productCount ( Int! )
販売プラングループに関連付けられた商品のカウントです。

productVariantCount ( Int! )
販売プラングループに関連付けられた商品バリアントの数。

引数 説明
productId ( ID ) カウントの対象となる商品のIDを指定します。

summary ( String )
販売プラングループに関連するポリシーの概要です。

SellingPlanGroupを返す型

SellingPlanGroupのmutation

SellingPlanGroupAddProductVariants
複数の商品バリアントをセリングプラングループに追加します。

SellingPlanGroupAddProducts
複数の商品を販売計画グループに追加します。

SellingPlanGroupCreate
セリング プラン グループを作成します。

sellingPlanGroupDelete
Selling Plan Group を削除します。

sellingPlanGroupRemoveProductVariants
セリング プラン グループから複数の商品バリアントを削除します。

sellingPlanGroupRemoveProducts
セリング プラン グループから複数の商品を削除します。

sellingPlanGroupUpdate
販売計画グループを更新します。

Implements

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

Fields

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

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

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

Fields

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

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

SellingPlanGroupEdgeを返す型

SellingPlanPricingPolicyPercentageValue (object)

セリングプラン・プライシングポリシーのパーセンテージタイプの値を表します。

Fields

percentage ( Float! )
パーセンテージの値。

SellingPlanRecurringBillingPolicy (object)

定期的な販売プランの課金ポリシーを表します。

Fields

anchors ( [SellingPlanAnchor!]! )
課金間隔の計算が行われるべき特定のアンカーの日付。

createdAt ( DateTime! )
セリングプランの課金ポリシーが作成された日時。

interval ( SellingPlanInterval! )
課金の頻度は、日、週、月、年のいずれかです。

intervalCount ( Int! )
課金の間隔の数です。

maxCycles ( Int )
課金の反復回数の最大値。

minCycles ( Int )
課金の反復回数の最小値。

SellingPlanRecurringDeliveryPolicy (object)

定期的な販売計画の配信ポリシーを表します。

Fields

anchors ( [SellingPlanAnchor!]! )
配信間隔の計算が行われるべき特定のアンカーの日付。

createdAt ( DateTime! )
セリングプラン・デリバリーポリシーが作成された日時です。

cutoff ( Int )
サイクルに含まれるべきオーダーのバッファ期間。

intentSelingPlanRecringDeliverPolicyIntent! )
配信ポリシーがマーチャント中心かバイヤー中心かを指定します。買い手中心の配送ポリシーでは、買い手が商品を受け取る時間を記載します。マーチャントセントリックデリバリーポリシーは、フルフィルメントを開始すべき時間を指定します。現在は、マーチャント中心の配信ポリシーのみサポートしています。

interval ( SellingPlanInterval! )
配信頻度を指定します。日、週、月、年のいずれかです。

intervalCount ( Int! )
配信の間隔の数。

preAnchorBehavior ( SellingPlanRecurringDeliveryPolicyPreAnchorBehavior! )
アンカーの前に注文があった場合の最初のフルフィルメントのフルフィルメントまたは配送の動作。このフィールドのデフォルト値は「 ASAP 」です。

SellingPlanRecurringPricingPolicy (object)

リカーリング・セリング・プランの価格政策を表しています。

Fields

adjustmentTypeSellingPlanPricingPolicyAdjustmentType! )
価格調整タイプです。

adjustmentValue ( SellingPlanPricingPolicyAdjustmentValue!) )
価格調整値です。

afterCycle ( Int )
この価格設定ポリシーが適用される後のサイクル。

createdAt ( DateTime! )
定期的な販売プランの価格ポリシーが作成された日時。

Implements

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

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