📈

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

2021/10/01に公開

GraphQL

API

Shopify

tech

この記事について

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

Shopify アプリのご紹介

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

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

Products and Collections APIs

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

OBJECTS

`Channel` (`object`)

チャンネルとは、商品やコレクションのグループを販売するアプリを表します。チャネルには、Facebook や Pinterest などのプラットフォームやマーケットプレイス、オンラインストア、POS などがあります。

Connections

collectionPublicationsV3 ( ResourcePublicationConnection! )
チャネルに公開されているコレクションのリストのコレクション・パブリケーションです。

引数	説明
`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` 個の要素までを返します。
`reverse` ( `Boolean` )	対象となるリストの順序を逆にします。デフォルト値：`false`

productPublicationsV3 ( ResourcePublicationConnection! )
チャネルに公開されている商品リストの商品出版物です。

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

products ( ProductConnection! )
チャネルに公開されている商品のリストです。

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

Fields

app（ App! )
チャネルが使用する基礎となるアプリ。

hasCollection ( Boolean! )
コレクションがチャネルで利用可能かどうか。

引数	説明
`id` ( `ID!` ) `required`	確認するコレクション ID。

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

name ( String! )
チャンネルの名前。

supportsFuturePublishing ( Boolean! )
このチャネルがフューチャーパブリッシングをサポートしているかどうか。

Channelの返す型

ProductPublication.channel Implements

Implements

Node

非推奨 fields

handle ( String! ) deprecated
チャンネルの一意の識別子。

navigationItems ( [NavigationItem!]! ) deprecated
チャンネルのメニューアイテムは、Shopify 管理画面の左のナビゲーションサイドバーのサブメニューアイテムとしても表示されます。

[overviewPath] ( URL ) deprecated
チャンネルのホームページです。

productPublications ( ProductPublicationConnection! ) deprecated
チャネルに公開されている商品のパブリケーションです。

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

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

Fields

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

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

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

`ChannelEdge`について

Fields

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

node ( Channel! )
ChannelEdge の末尾の項目。

#ChannelEdgeの返す型

ChannelConnection.edges

Samples

query

# 特定のチャンネルを `node` フィールドと GraphQL フラグメントを使って取得する
{
  node(id: "gid://shopify/Channel/25728155670") {
    id
    ... on Channel {
      id
      app {
        id
      }
      hasCollection(id: "gid://shopify/Collection/70598819862")
      name
      supportsFuturePublishing
    }
  }
}

response

{
  "data": {
    "node": {
      "id": "gid://shopify/Channel/25728155670",
      "app": {
        "id": "gid://shopify/App/580111"
      },
      "hasCollection": true,
      "name": "Online Store",
      "supportsFuturePublishing": true
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 2,
      "actualQueryCost": 2,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 998,
        "restoreRate": 50
      }
    }
  }
}

`Collection` (`object`)

商品のコレクションを表します。

Connections

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`

products（ ProductConnection! )
コレクションに含まれる商品です。

引数	説明
`after` ( `String` )	指定されたカーソルの後に来る要素を返します。
`before` ( `String` )	指定されたカーソルの前にある要素を返します。
`first` ( `Int` )	リストから最初の `n` 個の要素までを返します。
`last` ( `Int` )	リストから最後の `n` 個の要素までを返します。
`query` (`String` )	このフィールドは、コレクションがスマートな場合にのみ使用されます。コレクションがカスタムの場合は、エラーが返されます。サポートされているフィルターパラメーター: ・`title` ・`product_type` ・`vendor` ・`gift_card` ・`created_at` ・`updated_at` 詳細な`search syntax.`を見る
`reverse` ( `Boolean` )	対象となるリストの順序を逆にします。デフォルト値：`false`
`sortKey` ( `ProductCollectionSortKeys` )	指定されたキーでリストをソートします。デフォルト値: `COLLECTION_DEFAULT`

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

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

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

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

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

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

Fields

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

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

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

descriptionHtml ( HTML! )
HTML 形式のコレクションの説明。

feedback ( ResourceFeedback )
リソースフィードバックを通じて提供されるコレクションに関する情報。

handle ( String! )
コレクションのユニークなヒューマンフレンドリーな文字列。コレクションのタイトルから自動的に生成されます。

hasProduct ( Boolean! )
コレクションに商品が含まれているかどうか。

引数	説明
`id` ( `ID!` ) `required`	チェックする商品の ID。

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

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

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

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

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

引数	説明
`key` ( `String!` ) `required`	メタフィールドのキーです。
`namespace` ( `String!` ) `required`	メタフィールドの名前空間

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

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

productsCount ( Int! )
コレクションに含まれる商品の数。

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

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

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

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

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

ruleSet ( CollectionRuleSet )
商品をコレクションに割り当てるために使用されるルールです。これはスマートコレクションにのみ適用されます。

seo ( SEO! )
コレクションの SEO 情報。

sortOrder ( CollectionSortOrder! )
コレクションの商品を並べ替える順序です。

storefrontId ( StorefrontID! )
コレクションのストアフロント ID。

templateSuffix ( String )
ストアでこのコレクションを表示するときに使われるテーマテンプレート。

title ( String! )
コレクションのタイトルです。

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

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

updatedAt ( DateTime! )
コレクションが最後に修正された日時(ISO 8601 フォーマット)。

`Collection`の返す型

Collection の Mutation

collectionAddProducts
コレクションに商品を追加します。

collectionCreate
コレクションを作成します。

collectionDelete
コレクションを削除します。

collectionRemoveProducts
指定されたコレクションから商品のセットを削除します。実行には長い時間がかかります。コレクションを返すのではなく、ジョブを返すので、ポーリングする必要があります。

collectionReorderProducts
与えられたコレクションから商品のセットを非同期的に再注文します。

collectionUpdate
コレクションを更新します。

Implements

Deprecated fields

publications ( CollectionPublicationConnection! ) deprecated
コレクションが公開されているチャンネル。

引数	説明
`after` ( `String` )	指定されたカーソルの後に来る要素を返します。
`before` ( `String` )	指定されたカーソルの前にある要素を返します。
`first` ( `Int` )	リストから最初の `n` 個の要素までを返します。
`last` ( `Int` )	リストから最後の `n` 個の要素までを返します。
`onlyPublished` ( `Boolean` )	公開されているコレクション・パブリケーションのみを返すかどうか。デフォルト値：`true`
`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 ( [CollectionEdge!]! )
エッジのリスト。

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

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

Fields

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

node ( Collection! )
CollectionEdge の末尾のアイテム。

`CollectionEdge`の返す型

CollectionConnection.edges

Samples

query

# 最初の10コレクションを取得
{
  collections(first: 10) {
    edges {
      node {
        id
      }
    }
  }
}

response

{
  "data": {
    "collections": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/Collection/70598819862"
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 12,
      "actualQueryCost": 3,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 997,
        "restoreRate": 50
      }
    }
  }
}

`CollectionPublication` (`object`)

コレクションが発行されている公開物を表します。

Fields

collection（ Collection! )
パブリケーションに掲載されるコレクションです。

isPublished（ Boolean! ）
出版物が公開されているかどうか。

publication（ Publication! )
コレクションが公開される出版物。

publishDate ( DateTime! )
出版物が発行された、または発行される予定の日付。

Deprecated fields

channel ( Channel! ) deprecated
コレクションが公開されるチャンネルです。

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

Fields

edge ( [CollectionPublicationEdge!]! )
エッジのリスト。

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

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

Fields

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

node（ CollectionPublication! )
CollectionPublicationEdge の末尾の項目。

CollectionPublicationEdge を返す型

CollectionPublicationConnection.edge

`CollectionRule` (`object`)

商品をコレクションに割り当てるために使用されるルールを表します。

Fields

column ( CollectionRuleColumn! )
ルールが注目する属性（例えば、title や product_type）

condition ( String! )
演算子が適用される値（例えば、Hats）

relation ( CollectionRuleRelation! )
ルールが適用される演算子の種類（例えば、equals、contains、not_equals）

`CollectionRule`を返すタイプ

CollectionRuleSet.rules

`CollectionRuleConditions` (`object`)

コレクションでは、ルールを使用して、一致する商品を自動的に含めることができます。これは、ルールの種類に対する制限を定義するものです。

Fields

allowedRelations ( [CollectionRuleRelation!]! )
ルールの許可された関係。

defaultRelation ( CollectionRuleRelation! )
このルールに最もよく使われる関係。

ruleType ( CollectionRuleColumn! )
ルールのタイプ。

`CollectionRuuleConditions`を返すタイプ

QueryRoot.collectionRulesConditions

`CollectionRuleSet` (`object`)

どの商品がコレクションに含まれるかを決定するために使用されるルールのセット。

FIelds

appliedDisjunctively （ Boolean! )
商品がコレクションに含まれるために、ルールのいずれかまたはすべてにマッチしなければならないかどうか。true の場合、コレクションに含まれるためには、商品は 1 つ以上のルールにマッチしなければなりません。false の場合、コレクションに含まれるためには、商品がすべてのルールにマッチする必要があります。

rules ( [CollectionRule!]! )
商品をコレクションに割り当てるために使用されるルールです。

`CollectionRuleSet`を返すタイプ

Collection.ruleSet

`ExternalVideo` (`object`)

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

Fields

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

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

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

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

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

mediaErrors ( [MediaError!]! )
メディアで発生したすべてのエラー。

preview ( MediaPreviewImage )
メディアのプレビュー画像。

status ( MediaStatus! )
メディアの現在のステータス。

Implements

`File` (`object`)

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

Fields

edge ( [FileEdge!]! )
エッジのリスト。

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

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

Fields

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

node ( File! )
FileEdge の末尾の項目。

`FileEdge`を返すタイプ

FileConnection.edges

ファイルインターフェースです。

Fields

alt ( String )
ファイルの内容や機能を説明するための単語やフレーズ。

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

fileErrors ( [FileError!]! )
ファイルに発生したすべてのエラー。

fileStatus ( FileStatus! )
ファイルのステータスです。

preview ( MediaPreviewImage )
メディアのプレビュー画像。

implement File を返すタイプ

`GenericFile` (`object`)

汎用ファイル

Fields

alt ( String )
ファイルの内容や機能を説明するための単語やフレーズ。
createdAt ( DateTime! )
商品が作成された日付と時間（ISO 8601 format）。
fileErrors ([FileError!]!)
ファイルに発生したすべてのエラー。
fileStatus ( FileStatus! )
ファイルのステータスです。
id ( ID! )
グローバルに一意な識別子。
preview ( MediaPreviewImage )
メディアのプレビュー画像。
url ( URL )
ファイルの URL です。

Implements

`Media` (`object`)

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

Fields

edges ( [MediaEdge!]! )
エッジのリスト。
pageInfo ( PageInfo! )
ページネーションを補助するための情報。
自動生成されたタイプで、ページネーションの際に 1 つのメディアとカーソルを保持します。

FIelds

cursor ( String! )
ページネーションで使用するカーソルです。
node（ Media! )
MediaEdgeの末尾の項目。

MediaEdge を返す型

MediaConnection.Edge
メディアインターフェースを表す。

Fields

alt ( String )
メディアの性質やコンテンツを共有するための単語やフレーズ。
mediaContentType ( MediaContentType! )
メディアのコンテンツタイプです。
mediaErrors ( [MediaError!]! )
メディアで発生したすべてのエラー。
preview ( MediaPreviewImage )
メディアのプレビュー画像。
status ( MediaStatus! )
メディアの現在のステータス。

implement Media を返すタイプ

`MediaImage` (`object`)

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

Fields

alt ( String )
メディアの性質やコンテンツを共有するための単語やフレーズ。
createdAt ( DateTime! )
商品が作成された日付と時間（ ISO 8601 format )。
fileErrors ( [FileError!]! )
ファイルに発生したすべてのエラー。
fileStatus ( FileStatus! )
ファイルのステータスです。
id ( ID! )
グローバルに一意な識別子。
image ( Image )
メディアのイメージです。
mediaContentType ( MediaContentType! )
メディアのコンテンツタイプです。
mediaErrors ( [MediaError!]! )
メディアで発生したすべてのエラー。
mimeType ( String )
画像の MIME タイプ。
preview ( MediaPreviewImage )
メディアのプレビュー画像。
status ( MediaStatus! )
メディアの現在のステータス。

Implements

`MediaPreviewImage` (`object`)

メディアのプレビュー画像を表す。

Feilds

image ( Image )
メディアのプレビュー画像です。
status ( MediaPreviewImageStatus! )
プレビュー画像の現在の状態。

MediaPreviewImage を返す型

`Model3d` (`object`)

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

Fields

alt ( String )
メディアの性質や内容を共有するための単語やフレーズです。
filename ( String! )
3D モデルのファイル名です。
id ( ID! )
グローバルに一意な識別子。
mediaContentType ( MediaContentType! )
メディアコンテンツタイプ。
mediaErrors ( [MediaError!]! )
メディアで発生したすべてのエラー。
originalSource ( Model3dSource )
3d モデルのオリジナルソース。
preview ( MediaPreviewImage )
メディアのプレビュー画像
source ( [Model3dSource!]! )
3d モデルのソースです。
status ( MediaStatus! )
メディアの現在のステータス。

Implements

`Model3dSource` (`object`)

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

Fields

filesize ( Int! )
3D モデルのファイルサイズ。
format ( String! )
3d モデルのフォーマット。
mimeType ( String! )
3d モデルの MIME タイプを指定します。
url ( String! )
3d モデルの URL です。

`Model3dSource`を返すタイプ

`PriceList` (`object`)

関連する価格や適格性のルールに関する情報を含む、価格リストを表します。価格リストを使用して、固定価格または商品バリアントの初期価格を上書きする調整済みの相対価格を指定できます。価格リストは、価格リストの適格性を決定するコンテキストルールを使用して顧客に適用されます。
価格表の詳細については、「価格表 API を使用した異なる価格モデルのサポート」を参照してください。

Connections

prices ( PriceListPriceConnection! )
価格表に関連する価格のリスト。

引数	説明
`after` ( `String` )	指定されたカーソルの後に来る要素を返します。
`before` ( `String` )	指定されたカーソルの前にある要素を返します。
`first` ( `Int` )	リストから最初の `n` 個の要素までを返します。
`last` ( `Int` )	リストから最後の `n` 個の要素までを返します。
`originType` ( `PriceListPriceOriginType` )	この価格の起源は、固定（価格表に定義されている）または相対（価格表の親の設定による調整を使用して計算）のいずれかです。
`reverse` ( `Boolean` )	対象となるリストの順序を逆にします。デフォルト値：`false`

Fields

contextRule ( PriceListContextRule )
価格表の適格性を決定するために使用される、顧客に関する事実のセット。
currency ( CurrencyCode! )
この価格表に関連する固定価格の通貨。
id ( ID! )
グローバルに一意な識別子。
name ( String! )
人間が読める識別子として使われる、プライスリストのユニークな名前。
parent ( PriceListParent )
他の価格に対する相対的な調整。

`PriceList`を返すタイプ

PriceList の Mutation

priceListCreate
価格表を作成します。priceListCreate mutation を使用すると、ある国の新しい価格表を作成できます。これにより、国際価格で商品を販売することができます。
priceListDelete
プライスリストを削除します。priceListDelete mutation を使用すると、価格リストを削除して、その国の商品に適用されなくなります。プライスリストを削除するには、プライスリスト ID を指定する必要があります。
priceListFixedPricesAdd
プライスリストに固定価格を作成または更新します。priceListFixedPricesAdd mutation を使用すると、特定の商品バリアントに固定価格を設定できます。これにより、国ごとに商品バリアントの価格を変更することができます。これらのバリアントに対する既存の固定価格リストの価格は、すべて上書きされます。
priceListFixedPricesDelete
商品バリアント ID を使用して、価格リストから特定の価格を削除します。 priceListFixedPricesDelete mutation を使用すると、価格リストの価格の一部のセットを削除できます。削除された価格は、その国の商品には適用されなくなります。
priceListUpdate
価格リストの更新を行います。価格リストを更新して、パーセンテージベースの価格調整に変更を加えることができます。priceListUpdate mutation を使用すると、ある国の既存の価格リストを更新できます。これにより、国ごとに商品価格を変更することができます。変異の一部として、名前、パーセンテージベースの調整、通貨、および国を変更できます。

Implements

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

FIelds

edges ( [PriceListEdge!]! )
エッジのリストです。
pageInfo ( PageInfo! )
ページネーションを補助するための情報。
自動生成されたタイプで、1 つのPriceListとページ処理中のカーソルを保持します。

Fields

cursor ( String! )
ページネーションで使用するためのカーソル。
node（ PriceList! )
PriceListEdge の末尾の項目。

`PriceListEdge`を返すタイプ

PriceListConnection.edges

`PriceListAdjustment` (`object`)

プライスリストの調整の種類と値を表します。

Fields

type ( PriceListAdjustmentType! )
価格調整のタイプ、たとえばパーセンテージの増加や減少などです。
value ( Float! )
価格調整の値。正の数は価格を下げ、負の数は価格を上げます。

`PriceListAdjustment`を返すタイプ

PriceListParent.adjustment

`PriceListContextRule` (`object`)

価格表の適格性を判断するために使用される、お客様に関する一連の事実を表します。

Fields

countries ( [CountryCode!]! )
価格表の適用を決定する 2 文字の国コードのリストです。

`PriceListContextRule`を返すタイプ

PriceList.ContextRule

`PriceListParent` (`object`)

ある価格リストから他の価格への相対的な調整を表します。PriceListParent を使用すると、パーセンテージベースの調整を使用して調整済みの相対価格を指定できます。調整後の価格は、交換ルールや丸め方と連動します。
調整タイプは、パーセンテージによる増加と減少の両方をサポートします。

Fields

adjustment ( PriceListAdjustment! )
価格表の調整です。

PriceListParent を返す型

PriceList.parent

`PriceListPrice` (`object`)

価格リストで定義されている商品バリエーションの価格に関する情報（価格、compare at price、およびオリジンタイプなど）を表します。PriceListPrice を使用すると、特定の商品バリアントの固定価格を指定できます。

Fields

compareAtPrice ( MoneyV2 )
この価格表に掲載されている商品バリアントの比較時価格。
originType ( PriceListPriceOriginType! )
この価格の原点。固定（価格リストに定義されている）または相対（価格リストの親の設定による調整を使用して計算されている）のいずれか。
price ( MoneyV2! )
この価格表の商品バリアントの価格です。
variant ( ProductVariant! )
この価格に関連する商品バリアント。

PriceListPrice を返す型

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

Fields

edges ( [PriceListPriceEdge!]! )
エッジのリスト。
pageInfo ( PageInfo! )
ページネーションを補助するための情報。
ページネーション時に 1 つの PriceListPrice とカーソルを保持する自動生成タイプ。

Fields

cursor ( String! )
ページネーションで使用するカーソルです。
node（ PriceListPrice! )
PriceListPriceEdge の末尾の項目。

`PriceListPriceEdge`を返すタイプ

PriceListPriceConnection.edges

Shopify アプリのご紹介

Discussion

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

この記事について

Shopify アプリのご紹介

Products and Collections APIs

OBJECTS

Channel (object)

Connections

Fields

Implements

非推奨 fields

Fields

ChannelEdgeについて

Fields

Samples

Collection (object)

Connections

Fields

Collectionの返す型

Collection の Mutation

Implements

Deprecated fields

Fields

Fields

CollectionEdgeの返す型

Samples

CollectionPublication (object)

Fields

Deprecated fields

Fields

Fields

CollectionPublicationEdge を返す型

CollectionRule (object)

Fields

CollectionRuleを返すタイプ

CollectionRuleConditions (object)

Fields

CollectionRuuleConditionsを返すタイプ

CollectionRuleSet (object)

FIelds

CollectionRuleSetを返すタイプ

ExternalVideo (object)

Fields

Implements

File (object)

Fields

Fields

FileEdgeを返すタイプ

Fields

implement File を返すタイプ

GenericFile (object)

Fields

Implements

Media (object)

Fields

FIelds

MediaEdge を返す型

Fields

implement Media を返すタイプ

MediaImage (object)

Fields

Implements

MediaPreviewImage (object)

Feilds

MediaPreviewImage を返す型

Model3d (object)

Fields

Implements

Model3dSource (object)

Fields

Model3dSourceを返すタイプ

PriceList (object)

Connections

Fields

PriceListを返すタイプ

PriceList の Mutation

Implements

FIelds

Fields

PriceListEdgeを返すタイプ

PriceListAdjustment (object)

Fields

`Channel` (`object`)

`ChannelEdge`について

`Collection` (`object`)

`Collection`の返す型

`CollectionEdge`の返す型

`CollectionPublication` (`object`)

`CollectionRule` (`object`)

`CollectionRule`を返すタイプ

`CollectionRuleConditions` (`object`)

`CollectionRuuleConditions`を返すタイプ

`CollectionRuleSet` (`object`)

`CollectionRuleSet`を返すタイプ

`ExternalVideo` (`object`)

`File` (`object`)

`FileEdge`を返すタイプ

`GenericFile` (`object`)

`Media` (`object`)

`MediaImage` (`object`)

`MediaPreviewImage` (`object`)

`Model3d` (`object`)

`Model3dSource` (`object`)

`Model3dSource`を返すタイプ

`PriceList` (`object`)

`PriceList`を返すタイプ

`PriceListEdge`を返すタイプ

`PriceListAdjustment` (`object`)

`PriceListAdjustment`を返すタイプ

`PriceListContextRule` (`object`)

`PriceListContextRule`を返すタイプ

`PriceListParent` (`object`)

`PriceListPrice` (`object`)

`PriceListPriceEdge`を返すタイプ