【Shopify.dev和訳】Admin API/GraphQL ref/Products & Collections⑤
この記事について
この記事は、AdminAPI/GraphQL reference/ProdCollectionの記事を和訳したものです。
Shopify アプリのご紹介
Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。
Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。
Products and Collections APIs
Products and Collections API はストアのカタログにアクセスし、操作することができます。
MUTATIONS の続きです。
MUTATIONS
productVariantAppendMedia (mutation)
商品のメディアを、その商品のバリエーションに追加します。
例
mutation query の実行例
mutation productVariantAppendMedia($productId: ID!, $variantMedia: [ProductVariantAppendMediaInput!]!) {
productVariantAppendMedia(productId: $productId, variantMedia: $variantMedia) {
product {
id
}
productVariants {
id
}
userErrors {
code
field
message
}
}
}
{
"productId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"variantMedia": [
{
"variantId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"mediaIds": [
"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
]
}
]
}
引数
| 引数 | 説明 |
|---|---|
productId ( ID! ) required
|
メディアに関連する商品を指定します。 |
variantMedia ( [ProductVariantAppendMediaInput!]! ) required
|
バリアントと、そのバリアントに添付するメディアのペアのリスト。 |
ProductVariantAppendMediaInput fields
mediaIds ([ID!]!) required
バリアントに追加するメディアを指定します。
variantId (ID!) required
メディアが付加されるバリアントを指定します。
返却フィールド
product（Product )
バリアントとメディアに関連付けられた商品です。
productVariants ([ProductVariant!])
更新された商品バリアント。
userErrors ([MediaUserError!]!)
mutation を実行した際に発生したエラーのリスト。
productVariantCreate (mutation)
プロダクトバリアントを作成します。
例
mutation query の実行例
mutation productVariantCreate($input: ProductVariantInput!) {
productVariantCreate(input: $input) {
product {
id
}
productVariant {
id
}
userErrors {
field
message
}
}
}
{
"input": {}
}
引数
| 引数 | 説明 |
|---|---|
input ( ProductVariantInput! ) required
|
新しい商品バリアントのプロパティです。 |
ProductVariantInput fields
barcode (String)
商品に関連付けられているバーコードの値です。
compareAtPrice (Money)
バリアントの比較対象価格です。
fulfillmentServiceId (ID)
バリアントに関連付けられたフルフィルメントサービスの ID です。
harmonizedSystemCode (String)
バリアントの Harmonized System Code（または HS Tariff Code）です。
id (ID)
更新する商品バリアントを指定するか、存在しない場合は新しいバリアントを作成します。
imageId (ID)
バリアントに関連付けられているイメージの ID です。
imageSrc (String)
バリアントに関連づける画像の URL。このフィールドは、商品イメージを作成する変異でのみ使用でき、商品に作成される URL の 1 つと一致する必要があります。
inventoryItem (InventoryItemInput)
バリアントに関連付けられたインベントリアイテムで、ユニットコストに使用されます。
inventoryManagement (ProductVariantInventoryManagement)
商品バリアントの在庫アイテムの数を追跡するフルフィルメントサービス。管理者を使って自分で在庫を追跡する場合は、値を shopify に設定してください。有効な値: shopify または在庫管理を有効にしているフルフィルメントサービスのハンドル名。この引数は推奨されません。代わりに inventoryItem の tracked 属性を使用してください。
inventoryPolicy (ProductVariantInventoryPolicy)
在庫がない場合に、顧客が商品バリアントを注文することができるかどうか。
inventoryQuantities ([InventoryLevelInput!])
作成専用フィールド。バリアントが在庫されている各ロケーションでの在庫量です。
mediaSrc ([String!])
バリアントに関連付けるメディアの URL です。このフィールドは、メディアイメージを作成する変異でのみ使用でき、商品に作成される URL の 1 つと一致する必要があります。このフィールドは 1 つの値しか受け付けません。
metafields ([MetafieldInput!])
商品バリアントに関するカスタマイズ可能な追加情報です。
option ([String!])
ショップオーナーが商品バリアントを定義するために使用するカスタムプロパティです。
position ([Int])
商品バリアントのリスト内での商品バリアントの順序を指定します。リストの最初の位置は 1 です。
price (Money)
バリアントの価格です。
privateMetafields ([PrivateMetafieldInput!])
この商品に関連付けるプライベート メタフィールド。
productId (ID)
作成のみのrequiredフィールドです。バリアントを作成する対象となる商品を指定します。
requiresShipping (Boolean)
バリアントが配送を必要とするかどうか。
sku（String )
バリアントの SKU。
taxCode (String)
バリアントに関連する税コード
taxable（Boolean )
バリアントが課税対象かどうか。
title (String)
この引数は非推奨です。Variant title は書き込み可能なフィールドではなく、選択された variant オプションから生成されます。
weight (Float)
バリアントの重量。
weightUnit (WeightUnit)
バリアントを計測するのに使う重量の単位。
返却フィールド
product (Product)
バリアントに関連する商品。
productVariant (ProductVariant)
作成に成功した variant。
userErrors ([UserError!]!)
mutation を実行して発生したエラーのリストです。
productVariantDelete (mutation)
商品バリアントを削除します。
例
mutation query の実行例
mutation productVariantDelete($id: ID!) {
productVariantDelete(id: $id) {
deletedProductVariantId
product {
id
}
userErrors {
field
message
}
}
}
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}
引数
| 引数 | 説明 |
|---|---|
id ( ID! ) required
|
削除する商品バリアントの ID。 |
返却フィールド
deletedProductVariantId (ID)
削除された商品バリアントの ID。
product (Product)
削除された商品バリアントの商品。
userErrors ([UserError!]!)
mutation を実行した際に発生したエラーのリスト。
productVariantDetachMedia (mutation)
商品のバリエーションからメディアを削除します。
例
mutation query の実行例
mutation productVariantDetachMedia($productId: ID!, $variantMedia: [ProductVariantDetachMediaInput!]!) {
productVariantDetachMedia(productId: $productId, variantMedia: $variantMedia) {
product {
id
}
productVariants {
id
}
userErrors {
code
field
message
}
}
}
{
"productId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"variantMedia": [
{
"variantId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"mediaIds": [
"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
]
}
]
}
引数
| 引数 | 説明 |
|---|---|
productId ( ID! ) required
|
バリアントとメディアが関連付けられている商品を指定します。 |
variantMedia ( [ProductVariantDetachMediaInput!]! ) required
|
バリアントから削除するバリアントとメディアのペアのリストです。 |
ProductVariantDetachMediaInput fields
mediaIds ([ID!]!) required
バリアントから切り離すメディアを指定します。
variantId (ID!) required
メディアが切り離されるバリアントを指定します。
返却フィールド
product（Product）
バリアントとメディアに関連付けられた商品です。
productVariants ([ProductVariant!])
更新された商品バリアント。
userErrors ([MediaUserError!]!)
mutation を実行した際に発生したエラーのリスト。
productVariantJoinSellingPlanGroups (mutation)
商品バリエーションに複数の販売計画グループを追加します。
例
mutation query の実行例
mutation productVariantJoinSellingPlanGroups($id: ID!, $sellingPlanGroupIds: [ID!]!) {
productVariantJoinSellingPlanGroups(
id: $id
sellingPlanGroupIds: $sellingPlanGroupIds
) {
productVariant {
id
}
userErrors {
code
field
message
}
}
}
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"sellingPlanGroupIds": [
"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
]
}
引数
| 引数 | 説明 |
|---|---|
id ( ID! ) required
|
プロダクトバリアントの ID です。 |
sellingPlanGroupIds ( [ID!]! ) required
|
追加する販売計画グループの ID です。 |
返却フィールド
productVariant (ProducVariant)
商品バリアントオブジェクト。
userErrors ([SellingPlanGroupUserError!]!)
mutation を実行した際に発生したエラーのリスト。
productVariantLeaveSellingPlanGroups (mutation)
商品バリエーションから複数のグループを削除する。
例
mutation query の実行例
mutation productVariantLeaveSellingPlanGroups($id: ID!, $sellingPlanGroupIds: [ID!]!) {
productVariantLeaveSellingPlanGroups(
id: $id
sellingPlanGroupIds: $sellingPlanGroupIds
) {
productVariant {
id
}
userErrors {
code
field
message
}
}
}
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"sellingPlanGroupIds": [
"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
]
}
引数
| 引数 | 説明 |
|---|---|
id ( ID! ) required
|
プロダクトバリアントの ID です。 |
sellingPlanGroupIds ( [ID!]! ) required
|
離脱する販売計画グループの ID。 |
返却フィールド
productVariant (ProductVariant)
商品バリアントオブジェクト。
userErrors ([SellingPlanGroupUserError!]!)
mutation を実行した際に発生したエラーのリスト。
productVariantsBulkCreate (mutation)
商品のバリエーションを一括して作成することができます。
例
mutation query の実行例
mutation productVariantsBulkCreate($variants: [ProductVariantsBulkInput!]!, $productId: ID!) {
productVariantsBulkCreate(variants: $variants, productId: $productId) {
product {
id
}
productVariants {
id
}
userErrors {
code
field
message
}
}
}
{
"variants": [
{}
],
"productId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}
引数
| 引数 | 説明 |
|---|---|
productId ( ID! ) required
|
variants を作成する商品の ID。 |
variants ( [ProductVariantsBulkInput!]! ) required
|
作成される商品バリアントの配列。 |
ProductVariantsBulkInput fields
barcode (String )
商品バリアントに関連付けられたバーコードの値です。
compareAtPrice (Money)
そのバリアントの比較対象価格。
fulfillmentServiceId (ID)
バリアントに関連付けられたフルフィルメントサービスの ID です。
harmonizedSystemCode (String)
バリアントの Harmonized System Code（または HS Tariff Code）です。
id (ID)
更新または削除する商品バリアントを指定します。
imageId (ID)
バリアントに関連付けられているイメージの ID です。
imageSrc (String)
バリアントに関連づける画像の URL。このフィールドは、商品イメージを作成する変異でのみ使用でき、商品に作成される URL の 1 つと一致する必要があります。
inventoryItem (InventoryItemInput)
バリアントに関連するインベントリアイテムで、単価に使用されます。
inventoryPolicy (ProductVariantInventoryPolicy)
在庫切れの際に顧客がバリアントを注文することを許可するかどうか。
inventoryQuantities ([InventoryLevelInput!])
作成専用フィールド。バリアントが在庫されている各ロケーションの在庫量です。在庫量の配列の要素数は 10 を超えてはならず、プランに指定された量を超えてはならない。
mediaSrc ([String!])
バリアントに関連付けるメディアの URL です。
metafields ([MetafieldInput!])
商品バリアントに関するカスタマイズ可能な追加情報です。
options ([String!])
ショップオーナーが商品バリアントを定義するために使用するカスタムプロパティです。
price (Money)
バリアントの価格です。
privateMetafields ([PrivateMetafieldInput!])
この商品に関連付けるプライベート メタフィールド。
requiresShipping (Boolean)
このバリアントが配送を必要とするかどうか。
sku (String)
このバリアントの SKU。
taxCode (String)
バリアントに関連する税コード
taxable (Boolean
バリアントが課税対象かどうか。
weight (Float)
バリアントの重量。
weightUnit (WeightUnit)
バリアントの測定に使用される重量の単位。
返却フィールド
product (Product)
更新された商品オブジェクト。
productVariants ([ProductVariant!])
新しく作成されたバリアント。
userErrors ([ProductVariantsBulkCreateUserError!]!)
mutation を実行して発生したエラーのリストです。
productVariantsBulkDelete (mutation)
商品のバリエーションを一括で削除します。
例
mutation query の実行例
mutation productVariantsBulkDelete($variantsIds: [ID!]!, $productId: ID!) {
productVariantsBulkDelete(variantsIds: $variantsIds, productId: $productId) {
product {
id
}
userErrors {
code
field
message
}
}
}
{
"variantsIds": [
"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
],
"productId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}
引数
| 引数 | 説明 |
|---|---|
productId ( ID! ) required
|
更新するバリアントを持つ商品の ID。 |
variantsIds ( [ID!]! ) required
|
削除する商品のバリアント ID の配列です。 |
返却フィールド
product (Product)
更新された商品オブジェクト。
userErrors ([ProductVariantsBulkDeleteUserError!]!!)
mutation を実行した際に発生したエラーのリストです。
productVariantsBulkReorder (mutation)
商品バリエーションを一括して再注文することができます。
例
mutation query の実行例
mutation productVariantsBulkReorder($productId: ID!, $positions: [ProductVariantPositionInput!]!) {
productVariantsBulkReorder(productId: $productId, positions: $positions) {
product {
id
}
userErrors {
code
field
message
}
}
}
{
"productId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"positions": [
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"position": 1
}
]
}
引数
| 引数 | 説明 |
|---|---|
positions ( [ProductVariantPositionInput!]! ) required
|
バリアントポジションの配列です。 |
productId ( ID! ) required
|
再注文するバリアントのプロダクト ID。 |
ProductVariantPositionInput fields
id (ID!) required
更新する商品バリアントの ID を指定します。
position (Int!) required
商品バリアントのリストにおける商品バリアントの順序を指定します。リストの最初の位置は 1 です。
返却フィールド
product ( Product )
更新された商品です。
userErrors ([ProductVariantsBulkReorderUserError!]!!)
mutation を実行した際に発生したエラーのリスト。
productVariantsBulkUpdate (mutation)
商品のバリエーションを一括で更新。
例
mutation query の実行例
mutation productVariantsBulkUpdate($variants: [ProductVariantsBulkInput!]!, $productId: ID!) {
productVariantsBulkUpdate(variants: $variants, productId: $productId) {
product {
id
}
productVariants {
id
}
userErrors {
code
field
message
}
}
}
{
"variants": [
{}
],
"productId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}
引数
| 引数 | 説明 |
|---|---|
productId ( ID! ) required
|
更新するバリアントに関連する商品の ID。 |
variants ( [ProductVariantsBulkInput!]! ) required
|
更新する商品バリアントの配列。 |
ProductVariantsBulkInput (mutation)
barcode (String)
商品バリアントに関連付けられたバーコードの値です。
compareAtPrice (Money)
そのバリアントの比較対象価格。
fulfillmentServiceId (ID)
バリアントに関連付けられたフルフィルメントサービスの ID です。
harmonizedSystemCode (String)
バリアントの Harmonized System Code（または HS Tariff Code）です。
id (ID)
更新または削除する商品バリアントを指定します。
imageId (ID)
バリアントに関連付けられているイメージの ID です。
imageSrc (String)
バリアントに関連づける画像の URL。このフィールドは、商品イメージを作成する変異でのみ使用でき、商品に作成される URL の 1 つと一致する必要があります。
inventoryItem (InventoryItemInput)
バリアントに関連するインベントリアイテムで、単価に使用されます。
inventoryPolicy (ProductVariantInventoryPolicy)
在庫切れの際に顧客がバリアントを注文することを許可するかどうか。
inventoryQuantities ([InventoryLevelInput!])
作成専用フィールド。バリアントが在庫されている各ロケーションの在庫量です。在庫量の配列の要素数は 10 を超えてはならず、プランに指定された量を超えてはならない。
mediaSrc ([String!])
バリアントに関連付けるメディアの URL です。
metafields ([MetafieldInput!])
商品バリアントに関するカスタマイズ可能な追加情報です。
options ([String!])
ショップオーナーが商品バリアントを定義するために使用するカスタムプロパティです。
price (Money)
バリアントの価格です。
privateMetafields ([PrivateMetafieldInput!])
この商品に関連付けるプライベート メタフィールド。
requiresShipping (Boolean)
このバリアントが配送を必要とするかどうか。
sku (String)
このバリアントの SKU。
taxCode（String)
バリアントに関連する税コード
taxable（Boolean )
weight（Float )
バリアントの重量。
weightUnit ( WeightUnit )
バリアントの測定に使用される重量の単位。
返却フィールド
product（Product )
更新された商品オブジェクト。
productVariants ([ProductVariant!])
更新されたバリアント。
userErrors ([ProductVariantsBulkUpdateUserError!]!)
mutation を実行して発生したエラーのリストです。
productVariantUpdate (mutation)
プロダクトバリアントを更新します。
例
mutation query の実行例
mutation productVariantUpdate($input: ProductVariantInput!) {
productVariantUpdate(input: $input) {
product {
id
}
productVariant {
id
}
userErrors {
field
message
}
}
}
{
"input": {}
}
引数
| 引数 | 説明 |
|---|---|
input ( ProductVariantInput! ) required
|
プロダクトバリアントの更新されたプロパティです。 |
ProductVariantInput fields
barcode (String)
商品に関連付けられているバーコードの値です。
compareAtPrice (Money)
バリアントの比較対象価格です。
fulfillmentServiceId (ID)
バリアントに関連付けられたフルフィルメントサービスの ID です。
harmonizedSystemCode (String)
バリアントの Harmonized System Code（または HS Tariff Code）です。
id (ID)
更新する商品バリアントを指定するか、存在しない場合は新しいバリアントを作成します。
imageId (ID)
バリアントに関連付けられているイメージの ID です。
imageSrc (String)
バリアントに関連づける画像の URL。このフィールドは、商品イメージを作成する変異でのみ使用でき、商品に作成される URL の 1 つと一致する必要があります。
inventoryItem (InventoryItemInput)
バリアントに関連付けられたインベントリアイテムで、ユニットコストに使用されます。
inventoryManagement (ProductVariantInventoryManagement)
商品バリアントの在庫アイテムの数を追跡するフルフィルメントサービス。管理者を使って自分で在庫を追跡する場合は、値を shopify に設定してください。有効な値: shopify または在庫管理を有効にしているフルフィルメントサービスのハンドル名。この引数は推奨されません。代わりに inventoryItem の tracked 属性を使用してください。
inventoryPolicy (ProductVariantInventoryPolicy)
在庫がない場合に、顧客が商品バリアントを注文することができるかどうか。
inventoryQuantities ([InventoryLevelInput!])
作成専用フィールド。バリアントが在庫されている各ロケーションでの在庫量です。
mediaSrc ([String!])
バリアントに関連付けるメディアの URL です。このフィールドは、メディアイメージを作成する変異でのみ使用でき、商品に作成される URL の 1 つと一致する必要があります。このフィールドは 1 つの値しか受け付けません。
metafields ([MetafieldInput!])
商品バリアントに関するカスタマイズ可能な追加情報です。
option ([String!])
ショップオーナーが商品バリアントを定義するために使用するカスタムプロパティです。
position ([Int])
商品バリアントのリスト内での商品バリアントの順序を指定します。リストの最初の位置は 1 です。
price (Money)
バリアントの価格です。
privateMetafields ([PrivateMetafieldInput!])
この商品に関連付けるプライベート メタフィールド。
productId (ID)
作成のみのrequiredフィールドです。バリアントを作成する対象となる商品を指定します。
requiresShipping (Boolean)
バリアントが配送を必要とするかどうか。
sku（String )
バリアントの SKU。
taxCode (String)
バリアントに関連する税コード
taxable（Boolean )
バリアントが課税対象かどうか。
title (String)
この引数は非推奨です。Variant title は書き込み可能なフィールドではなく、選択された variant オプションから生成されます。
weight (Float)
バリアントの重量。
weightUnit (WeightUnit)
バリアントを計測するのに使う重量の単位。
返却フィールド
product (Product)
バリアントに関連する商品。
productVariant (ProductVariant)
作成に成功した variant。
userErrors ([UserError!]!)
mutation を実行して発生したエラーのリストです。
publishablePublish (mutation)
チャンネルにリソースを公開します。リソースが商品の場合、商品のステータスが active である場合に限り、チャネルで表示されます。サブスクリプションでのみ販売される商品（ requestsSellingPlan: true ）は、オンラインストアでのみ公開できます。
例
mutation query の実行例
mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {
publishablePublish(id: $id, input: $input) {
publishable {
availablePublicationCount
publicationCount
publishedOnCurrentPublication
}
shop {
id
}
userErrors {
field
message
}
}
}
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"input": [
{}
]
}
引数
| 引数 | 説明 |
|---|---|
id ( ID! ) required
|
パブリケーションを作成または更新するリソース。 |
input ( [PublicationInput!]! ) required
|
リソースの発行に必要な入力フィールドを指定する。 |
PublicationInput fields
channelId (ID)
チャネルの ID。この引数は推奨されません。代わりに publicationId を使用してください。
PublicationId (ID)
出版物の ID。
publishDate (DateTime)
リソースが公開された日付と時間。これを未来の日付に設定すると、リソースが公開されるようにスケジュールされます。オンラインストアチャネルのみが将来の発行をサポートしています。
返却フィールド
publishable（Publishable )
公開されているリソース。
shop ( Shop! )
ユーザーのショップ。
userErrors ([UserError!]!)
mutation を実行して発生したエラーのリスト。
publishablePublishToCurrentChannel (mutation)
リソースを現在のチャネルに公開します。リソースが商品の場合、商品のステータスが active である場合にのみ、チャネルで表示されます。サブスクリプションでのみ販売される商品 ( requestsSellingPlan: true ) は、オンラインストアでのみ公開できます。
例
mutation query の実行例
mutation publishablePublishToCurrentChannel($id: ID!) {
publishablePublishToCurrentChannel(id: $id) {
publishable {
availablePublicationCount
publicationCount
publishedOnCurrentPublication
}
shop {
id
}
userErrors {
field
message
}
}
}
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}
引数
| 引数 | 説明 |
|---|---|
id ( ID! ) required
|
パブリケーションを作成または更新するためのリソース。 |
リターンフィールド
publishable（Publishable )
公開されているリソース。
shop ( Shop! )
ユーザーのショップ。
userErrors ( [UserError!]! )
mutation を実行して発生したエラーのリスト。
publishableUnpublish (mutation)
チャンネルからリソースを公開します。リソースが商品である場合、商品のステータスが active である場合に限り、チャネルで表示されます。
例
mutation query の実行例
mutation publishableUnpublish($id: ID!, $input: [PublicationInput!]!) {
publishableUnpublish(id: $id, input: $input) {
publishable {
availablePublicationCount
publicationCount
publishedOnCurrentPublication
}
shop {
id
}
userErrors {
field
message
}
}
}
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"input": [
{}
]
}
引数
| 引数 | 説明 |
|---|---|
id ( ID! ) required
|
刊行物を削除または更新するリソース。 |
input ( [PublicationInput!]! ) required
|
リソースの公開解除に必要な入力フィールドを指定する。 |
PublicationInput fields
channelId (ID)
チャネルの ID。この引数は推奨されません。代わりに publicationId を使用してください。
PublicationId (ID)
出版物の ID。
publishDate (DateTime)
リソースが公開された日付と時間。これを未来の日付に設定すると、リソースが公開されるようにスケジュールされます。オンラインストアチャネルのみが将来の発行をサポートしています。
返却フィールド
publishable（Publishable )
出版されていないリソースです。
shop ( Shop! )
ユーザーのショップです。
userErrors ( [UserError!]! )
mutation を実行した際に発生したエラーのリストです。
publishableUnpublishToCurrentChannel (mutation)
現在のチャネルからリソースをパブリッシュ解除します。リソースが商品である場合、商品のステータスが active である場合にのみ、チャネルに表示されます。
例
mutation query の実行例
mutation publishableUnpublishToCurrentChannel($id: ID!) {
publishableUnpublishToCurrentChannel(id: $id) {
publishable {
availablePublicationCount
publicationCount
publishedOnCurrentPublication
}
shop {
id
}
userErrors {
field
message
}
}
}
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}
引数
| 引数 | 説明 |
|---|---|
id ( ID! ) required
|
刊行物を削除または更新するリソース。 |
返却フィールド
publishable (Publishable)
出版されていないリソースです。
shop ( Shop! )
ユーザーのショップです。
userErrors ([UserError!]!)
mutation を実行した際に発生したエラーのリストです。
sellingPlanGroupAddProducts (mutation)
販売計画グループに複数の商品を追加します。
例
mutation query の実行例
mutation sellingPlanGroupAddProducts($id: ID!, $productIds: [ID!]!) {
sellingPlanGroupAddProducts(id: $id, productIds: $productIds) {
sellingPlanGroup {
id
}
userErrors {
code
field
message
}
}
}
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"productIds": [
"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
]
}
引数
| 引数 | 説明 |
|---|---|
id ( ID! ) required
|
販売計画グループの ID です。 |
productIds ( [ID!]! ) required
|
追加する商品の ID です。 |
返却フィールド
sellingPlanGroup (SellingPlaneGroup)
更新された販売計画グループです。
userErrors ([SellingPlanGroupUserError!]!)
mutation を実行した際に発生したエラーのリスト。
sellingPlanGroupAddProductVariants (mutation)
販売計画グループに複数の商品バリエーションを追加します。
例
mutation query の実行例
mutation sellingPlanGroupAddProductVariants($id: ID!, $productVariantIds: [ID!]!) {
sellingPlanGroupAddProductVariants(
id: $id
productVariantIds: $productVariantIds
) {
sellingPlanGroup {
id
}
userErrors {
code
field
message
}
}
}
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"productVariantIds": [
"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
]
}
引数
| 引数 | 説明 |
|---|---|
id ( ID! ) required
|
販売計画グループの ID です。 |
productVariantIds ( [ID!]! ) required
|
追加する商品バリアントの ID です。 |
返却フィールド
sellingPlanGroup ( SellingPlanGroup )
更新された販売計画グループです。
userErrors ([SellingPlanGroupUserError!]!)
mutation を実行した際に発生したエラーのリスト。
sellingPlanGroupCreate (mutation)
販売計画グループを作成します。
例
mutation query の実行例
mutation sellingPlanGroupCreate($input: SellingPlanGroupInput!) {
sellingPlanGroupCreate(input: $input) {
sellingPlanGroup {
id
}
userErrors {
code
field
message
}
}
}
{
"input": {}
}
引数
| 引数 | 説明 |
|---|---|
input ( SellingPlanGroupInput! ) required
|
新しい Selling Plan Group のプロパティです。 |
resources ( SellingPlanGroupResourceInput ) |
この Selling Plan Group が適用されるべきリソース。 |
SellingPlanGroupInput fields
appId (String)
アプリの識別子。Liquid および商品の JSON で公開されます。
description (String)
販売プラングループのマーチャント側の説明。
merchantCode (String)
販売プラングループのマーチャント向けラベル。
name (String)
売り手側プラングループの買い手側ラベル。
options ([String!])
販売プラングループで利用可能なすべてのオプションの値です。販売プランは、同じアプリで作成され、同じ selling_plan_group.name とselling_plan_group.options の値を持つ場合、Liquid でグループ化されます。
position（Int)
販売計画グループの表示用の相対値です。低い位置が高い位置の前に表示されます。
sellingPlansToCreate ([SellingPlanInput!])
作成する販売計画のリスト。
sellingPlansToDelete ([ID!])
削除する販売計画の ID のリスト。
sellingPlansToUpdate ([SellingPlanInput!])
更新するセールスプランのリスト。
返却フィールド
sellingPlanGroup (SellingPlanGroup)
作成された販売計画グループオブジェクト。
userErrors ([SellingPlanGroupUserError!]!)
mutation を実行した際に発生したエラーのリストです。
sellingPlanGroupDelete (mutation)
販売計画グループの削除
例
mutation query の実行例
mutation sellingPlanGroupDelete($id: ID!) {
sellingPlanGroupDelete(id: $id) {
deletedSellingPlanGroupId
userErrors {
code
field
message
}
}
}
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}
引数
| 引数 | 説明 |
|---|---|
id ( ID! ) required
|
削除する販売計画グループの ID です。 |
返却フィールド
deletedSellingPlanGroupId (ID)
削除された販売計画グループオブジェクトの ID。
userErrors ([SellingPlanGroupUserError!])!)
mutation を実行した際に発生したエラーのリストです。
sellingPlanGroupRemoveProducts (mutation)
販売計画グループから複数の商品を削除します。
例
mutation query の実行例
mutation sellingPlanGroupRemoveProducts($id: ID!, $productIds: [ID!]!) {
sellingPlanGroupRemoveProducts(id: $id, productIds: $productIds) {
removedProductIds
userErrors {
code
field
message
}
}
}
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"productIds": [
"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
]
}
引数
| 引数 | 説明 |
|---|---|
id ( ID! ) required
|
販売計画グループの ID です。 |
productIds ( [ID!]! ) required
|
削除する商品の ID です。 |
返却フィールド
removedProductIds ( [ID!] )
削除された商品の ID。
userErrors ([SellingPlanGroupUserError!])
mutation を実行した際に発生したエラーのリストです。
sellingPlanGroupRemoveProductVariants (mutation)
販売計画グループから複数の商品バリエーションを削除します。
例
mutation query の実行例
mutation sellingPlanGroupRemoveProductVariants($id: ID!, $productVariantIds: [ID!]!) {
sellingPlanGroupRemoveProductVariants(
id: $id
productVariantIds: $productVariantIds
) {
removedProductVariantIds
userErrors {
code
field
message
}
}
}
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
"productVariantIds": [
"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
]
}
引数
| 引数 | 説明 |
|---|---|
id ( ID! ) required
|
販売計画グループの ID です。 |
productIds ( [ID!]! ) required
|
削除する商品バリアントの ID です。 |
返却フィールド
removeProductVariantIds ([ID!])
削除された商品バリアントの ID。
userErrors ([SellingPlanGroupUserError!]!)
mutation を実行した際に発生したエラーのリストです。
sellingPlanGroupUpdate (mutation)
販売計画グループの更新
例
mutation query の実行例
mutation sellingPlanGroupUpdate($id: ID!) {
sellingPlanGroupUpdate(id: $id) {
deletedSellingPlanIds
sellingPlanGroup {
id
}
userErrors {
code
field
message
}
}
}
{
"id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}
引数
| 引数 | 説明 |
|---|---|
id ( ID! ) required
|
更新する販売計画グループ。 |
input ( SellingPlanGroupInput ) |
更新する Selling Plan Group のプロパティ。 |
SellingPlanGroupInput (mutation)fields
appId (String)
アプリの識別子。Liquid および商品の JSON で公開されます。
description (String)
販売プラングループのマーチャント側の説明。
merchantCode (String)
販売プラングループのマーチャント向けラベル。
name (String)
売り手側プラングループの買い手側ラベル。
options ([String!])
販売プラングループで利用可能なすべてのオプションの値です。販売プランは、同じアプリで作成され、同じ selling_plan_group.name と selling_plan_group.options の値を持つ場合、Liquid でグループ化されます。
position（Int)
販売計画グループの表示用の相対値です。低い位置が高い位置の前に表示されます。
sellingPlansToCreate ([SellingPlanInput!])
作成する販売計画のリスト。
sellingPlansToDelete ([ID!])
削除する販売計画の ID のリスト。
sellingPlansToUpdate ([SellingPlanInput!])
更新するセールスプランのリスト。
返却フィールド
deletedSellingPlanIds ([ID!])
削除されたサブスクリプション プランの ID。
sellingPlanGroup ( SellingPlaneGroup )
更新された販売プラングループ。
userErrors ([SellingPlanGroupUserError!]!)
mutation を実行して発生したエラーのリストです。
INTERFACES
OnlineStorePreviewable (interface)
オブジェクトのオンラインストアのプレビュー URL
Fields
onlineStorePreviewUrl (URL)
オンラインストアのプレビュー URL です。
OnlineStorePreviewable を実装するタイプ
Publishable (interface)
チャンネルにパブリッシュ可能なリソースを表します。発行可能なリソースは、商品またはコレクションのいずれかです。
Fields
availablePublicationCount (Int!)
フィードバックエラーなしにリソースが公開された出版物の数。
publicationCount (Int!)
リソースが公開されている出版物の数。
| 引数 | 説明 |
|---|---|
onlyPublished ( Boolean ) |
公開されているリソースのパブリケーションのみを含める。false の場合は、将来の出版物を含む、リソースのすべての出版物を返します。 デフォルト値： true
|
publishedOnCurrentPublication (Boolean!)
呼び出したアプリのパブリケーションにリソースが公開されているかどうかを確認します。
publishedOnPublication (Boolean!)
リソースが指定されたパブリケーションに公開されているかどうかを確認します。
| 引数 | 説明 |
|---|---|
publicationId ( ID! ) required
|
確認する出版物の ID。 |
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
|
Publishableを実装したタイプ
非推奨のフィールド
-
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
|
SellingPlanPricingPolicyBase (interface)
販売プランの価格設定ポリシーの共通フィールドを表す。
Fields
adjustmentType (SelingPricingPolicyAdjustmentType!)
価格調整タイプです。
adjustmentValue (SelingPricingPolicyAdjustmentValue!)
価格の調整値。
SellingPlanPricingPolicyBaseを実装するタイプ
Shopify アプリのご紹介
Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。
Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。
Discussion