Zenn
📈

【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 機能を実現することができます。

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 はストアのカタログにアクセスし、操作することができます。

Products and Collections Overview

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

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

  • CollectionDeleteInput - 削除するコレクションを指定します。

  • CollectionInput - コレクションの作成に必要な入力フィールドを指定します。

  • CollectionPublication - コレクションが公開される publications を表します。

  • CollectionPublicationInput - コレクションが公開される publications を指定します。

  • CollectionPublishInput - 公開するコレクションと公開先の販売チャネルを指定します。

  • CollectionRule - コレクションにプロダクトを割り当てるために使用されるルールを表します。

  • CollectionRuleColumn - スマートコレクションの input に使用される商品のプロパティを指定します。

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

  • CollectionRuleInput - コレクションに関連付けるルールを指定します。

  • CollectionRuleRelation - 「column」と「条件」の関係を指定します。

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

  • CollectionRuleSetInput - コレクションのルールセットを指定します。

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

  • CollectionSortOrder - コレクション内の Products のソート順を指定します。

  • CollectionUnpublishInput - 公開を中止するコレクションと、そのコレクションを削除する販売チャンネルを指定します。

  • CreateMediaInput - メディアオブジェクトの作成に必要な入力フィールドを指定します。

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

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

  • FileContentType - ファイルオブジェクトで使用可能なコンテンツタイプです。

  • FileCreateInput - ファイルオブジェクトの作成に必要な入力フィールドです。

  • FileSortKeys - ファイル クエリの有効なソート キーのセットです。

  • FileStatus - ファイルオブジェクトに設定可能なステータスです。

  • FileUpdateInput - ファイルオブジェクトの更新に必要な入力フィールドです。

  • GenericFile - ファイルオブジェクトの更新に必要な入力フィールドです。

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

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

  • MediaHost - メディアリソースのホスト(ex: Youtube)です。

  • MediaImage - Shopify がホストするイメージを表します。

  • MediaPreviewImage - メディアのプレビューイメージを表します。

  • MediaPreviewImageStatus - メディアのプレビューイメージに設定可能なステータスです。

  • MediaStatus - メディアオブジェクトの状態を表します。

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

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

  • MoveInput - オブジェクトをある位置に移動させるための個々の動作です。

  • OnlineStorePreviewable - オブジェクトのオンラインストアのプレビュー URL です。

  • PriceList - 関連する価格や適格性の規則に関する情報を含む価格リストを表します。価格リストを使用して、固定価格または商品バリアントの初期価格を上書きする調整済みの相対価格を指定することができます。価格リストは、価格リストの適格性を決定するコンテキストルールを使用して顧客に適用されます。プライスリストの詳細については、Support different pricing models using the price list APIを参照してください。

  • PriceListAdjustment - プライスリスト adjustment のタイプと値を表します。

  • PriceListAdjustmentInput - Parent プライスリストの adjustment を更新するときに使用するフィールドと値を提供します。

  • PriceListAdjustmentType - パーセント価格 adjust タイプを表します。

  • PriceListContext - プライスリストの適格性を判断するために使用される、顧客に関するデータのセットを表します。例えば、国コードを指定することで、特定の国から来たお客様にのみ価格表を適用することができます。

  • PriceListContextRule - プライスリストの適格性を判断するために使用される、顧客に関するデータのセットを表します。

  • PriceListContextRuleInput - プライスリストが適用されるコンテキストです。

  • PriceListCreateInput - プライスリストの作成時に使用するフィールドと値を提供します。

  • PriceListParent - 1 つのプライスリストから他のプライスへの相対的な調整を表します。PriceListParentを使用して、パーセンテージベースの調整を使用した調整済みの相対価格を指定できます。調整後の価格は、交換ルールや Rounding と連動します。Adjustment typesはパーセンテージの増加と減少の両方をサポートしています。

  • PriceListParentCreateInput - Parent プライスリストの調整を作成する際に使用するフィールドと値を提供します。

  • PriceListParentUpdateInput - 他の価格に対する相対的な調整です。

  • PriceListPrice - 価格リストに定義されている商品バリアントの価格に関する情報（価格、価格で比較、オリジンタイプなど）を表します。PriceListPriceを使用して、特定の商品バリアントの固定価格を指定することができます。

  • PriceListPriceInput - 固定価格リストの価格を作成または更新する際に使用するフィールドと値を提供します。

  • PriceListPriceOriginType - 価格の Origin を表します。固定価格（価格リストで定義）または相対価格（価格リストの親構成による調整を使用して計算）のいずれかです。

  • PriceListSortKeys - プライスリストクエリの有効なソートキーのセットです。

  • PriceListUpdateInput - プライスリストの更新時に使用するフィールドと値を提供します。

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

  • ProductAppendImagesInput - 追加する商品画像を指定します。

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

  • ProductDeleteInput - 削除する商品を指定します。

  • ProductImageSortKeys - ProductImage クエリで有効なソートキーのセットです。

  • ProductInput - 商品の作成に必要な入力フィールドを指定します。

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

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

  • ProductPriceRange - 商品の価格帯です。

  • ProductPriceRangeV2 - 商品の価格帯です。

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

  • ProductPublishInput - 商品が公開される Publish を指定します。

  • ProductPublishInput - 商品を公開する商品と公開先のチャンネルを指定します。

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

  • ProductStatus - 商品のステータスを指定します。

  • ProductUnpublishInput - チャネルから非公開にする商品と、非公開にする販売チャネルを指定します。

  • ProductVariant - 商品のバリアントを表します。

  • ProductVariantAppendMediaInput - 1 つのバリアントにメディアを追加するために必要な入力フィールドを指定します。

  • ProductVariantDetachMediaInput - 1 つのバリアントからメディアを切り離すために必要な入力フィールドを指定します。

  • ProductVariantInput - 作成または更新する商品バリアントを指定します。

  • ProductVariantInventoryManagement - 商品バリアントの在庫追跡の方法です。

  • ProductVariantInventoryPolicy - 商品バリアントのインベントリポリシーは、在庫切れの際に顧客がそのバリアントを継続して購入できるかどうかを制御します。値が continue の場合、顧客は在庫切れの際にそのバリアントを購入することができます。値が deny の場合、顧客は在庫切れの際にそのバリアントを購入することができません。

  • ProductVariantPositionInput - 商品のバリアントの位置を表します。

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

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

  • ProductVariantsBulkInput - バリアント一括変換の一部として作成する商品バリアントを指定します。

  • PublicationInput - リソースの発行に必要な入力フィールドを指定します。

  • Publishable - チャネルに公開可能なリソースを表します。公開可能なリソースは、商品またはコレクションのいずれかです。

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

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

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

  • SellingPlan - 商品がどのように販売・購入されるかを表します。販売プランと関連するレコード（販売プラングループとポリシー）は、マーチャントがサブスクリプションアプリをアンインストールしてから 48 時間後に削除されます。後で復元する必要がある場合は、これらのレコードをバックアップすることをお勧めします。販売プランの詳細については、Creating and managing selling plansを参照してください。

  • SellingPlanAnchor - 販売プランのポリシーアンカーを表します。

  • SellingPlanAnchorInput - 販売計画アンカーの作成または更新に必要な入力フィールドを指定します。

  • SellingPlanAnchorType - アンカーのタイプを表します。

  • SellingPlanBillingPolicy - 販売計画に関連付けられた請求頻度を表します（例えば、毎週請求、または 3 ヶ月ごとに請求）。販売プランの課金ポリシーと関連レコード（販売プラングループ、販売プラン、価格ポリシー、配送ポリシー）は、マーチャントがサブスクリプションアプリをアンインストールしてから 48 時間後に削除されます。後で復元する必要がある場合は、これらのレコードをバックアップすることをお勧めします。

  • SellingPlanBillingPolicyInput - 配送ポリシータイプの作成または更新に必要な入力フィールドを指定します。

  • SellingPlanDeliveryPolicy - 販売プランに関連付けられた配送頻度を表します（例えば、毎月配送、または隔週で配送）。販売プランの配送ポリシーと関連レコード（販売プラングループ、販売プラン、価格ポリシー、請求ポリシー）は、マーチャントがサブスクリプションアプリをアンインストールしてから 48 時間後に削除されます。後で復元する必要がある場合は、これらのレコードをバックアップすることをお勧めします。

  • SellingPlanDeliveryPolicyInput - 配送ポリシーを作成または更新するための入力フィールドを指定します。

  • SellingPlanFixedPricingPolicy - 固定された販売プランの価格設定ポリシーを表します。

  • SellingPlanFixedPricingPolicyInput - 固定販売プランの価格ポリシーを作成または更新するために必要な入力フィールドを指定します。

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

  • SellingPlanGroupInput - SellingPlanGroup の作成または更新に必要な入力フィールドを指定します。

  • SellingPlanGroupResourceInput - SellingPlanGroup に関連するリソースを指定します。

  • SellingPlanGroupSortKeys - SellingPlanGroup クエリに有効なソートキーのセットです。

  • SellingPlanInput - 販売計画を作成または更新するための入力フィールドを指定します。

  • SellingPlanInterval - 有効な販売計画の間隔を表します。

  • SellingPlanPricingPolicy - 販売プランに関連する価格設定のタイプを表します（例えば、期間限定で設定された 10 ドルまたは 20％の割引、またはサブスクリプションの期間中は固定された割引など）。販売プランの価格設定ポリシーと関連レコード（販売プラングループ、販売プラン、請求ポリシー、配送ポリシー）は、マーチャントがサブスクリプションアプリをアンインストールしてから 48 時間後に削除されます。後で復元する必要がある場合は、これらのレコードをバックアップすることをお勧めします。

  • SellingPlanPricingPolicyAdjustmentType - 販売プランの価格ポリシー調整タイプを表します。

  • SelingPricingPolicyAdjustmentValue - 販売計画の価格設定ポリシーの調整値タイプを表します。

  • SellingPlanPricingPolicyBase - 販売プランの価格設定ポリシーの共通フィールドを表します。

  • SellingPlanPricingPolicyInput - 販売計画の価格設定ポリシーの作成または更新に必要な入力フィールドを指定します。

  • SellingPricingPolicyPercentageValue - 販売プランの価格設定ポリシーのパーセンテージタイプの値を表します。

  • SellingPlanPricingPolicyValueInput - 価格設定ポリシーの調整値の作成または更新に必要な入力フィールドを指定します。

  • SellingPlanRecurringBillingPolicy - 定期的な販売プランの請求ポリシーを表します。

  • SellingPlanRecurringBillingPolicyInput - 定期的な請求ポリシーの作成または更新に必要な入力フィールドを指定します。

  • SellingPlanRecurringDeliveryPolicy - 継続的な販売プランの配送ポリシーを表します。

  • SelingPlanRecurringDeliveryPolicyInput - 定期的な配送ポリシーの作成または更新に必要な入力フィールドを指定します。

  • SelingPlanRecurringDeliveryPolicyIntent - 配送ポリシーの可能な意図を表します。

  • SellingPlanRecurringDeliveryPolicyPreAnchorBehavior - アンカーの前に注文されたときの最初のフルフィルメントの可能なフルフィルメントまたは配送の動作です。

  • SellingPlanRecurringPricingPolicy - 定期的な販売プランの価格設定ポリシーを表します。

  • SellingPlanRecurringPricingPolicyInput - 定期販売プランの価格設定ポリシーの作成または更新に必要な入力フィールドを指定します。

  • StagedMediaUploadTarget - ステージングされたメディアのターゲット情報です。

  • UpdateMediaInput - メディアオブジェクトの更新に必要な入力フィールドを指定します。

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

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

  • Weight - 重さの単位と値を表します。

  • WeightInput - 重量単位と値の入力を指定します。

  • WeightUnit - 重量の測定単位です。

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

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

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

  • collectionPublish - コレクションをチャンネルに公開します。

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

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

  • collectionUnpublish - コレクションを公開します。

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

  • fileCreate - 外部 URL を使用して、またはstagedUploadsCreate mutationを使用して以前にアップロードされたファイルのファイルアセットを作成します。これらのファイルは Shopify admin のFiles pageに追加されます。

  • fileDelete - ファイルアセットを削除します。

  • fileUpdate - ファイルアセットを更新します。

  • priceListCreate - プライスリストを作成します。priceListCreate mutation を使用すると、ある国の新しい価格表を作成することができます。これにより、国際的な価格設定で商品を販売することができます。

  • priceListDelete - プライスリストを削除します。priceListDelete mutation を使ってプライスリストを削除し、その国の商品に適用されないようにすることができます。プライスリストを削除するには、プライスリストの ID を指定する必要があります。

  • priceListFixedPricesAdd - プライスリストに固定価格を作成または更新します。priceListFixedPricesAdd mutation を使用して、特定の商品バリアントに固定価格を設定できます。これにより、国ごとに商品バリアントの価格を変更することができます。これらのバリアントに対する既存の固定価格リストの価格はすべて上書きされます。

  • priceListFixedPricesDelete - 商品バリアント ID を使用して、価格リストから特定の価格を削除します。priceListFixedPricesDelete mutation を使用すると、価格リスト上の価格の部分的なセットを削除することができます。削除後、その価格はその国の商品には適用されなくなります。

  • priceListUpdate - プライスリストの更新を行います。プライスリストを更新して、パーセンテージベースの価格調整に変更を加えることができます。priceListUpdate mutation を使って、ある国の既存のプライスリストを更新することができます。これにより、国ごとに商品の価格を変更することができます。Mutation の一部として、名前、パーセンテージベースの調整、通貨、および国を変更することができます。

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

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

  • productCreate -商品を作成します。

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

  • productDelete - 関連するすべてのバリアントとメディアを含む商品を削除します。

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

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

  • productDuplicate - 商品の複製を作成します。

  • productImageUpdate - 商品のイメージを更新します。

  • productJoinSellingPlanGroups - 複数の販売プラングループを商品に追加します。

  • productLeaveSellingPlanGroups - 商品から複数のグループを削除します。

  • productPublish - 商品を公開します。サブスクリプションでのみ販売されている商品（requiresSellingPlan: true）は、オンラインストアでのみ公開できます。

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

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

  • productUnpublish - 商品の発行を取り消します。

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

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

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

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

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

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

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

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

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

  • productVariantsBulkCreate - 商品のバリアントを一括して作成します。

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

  • productVariantsBulkReorder - 商品バリアントを一括で再注文します。

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

  • publishablePublish - リソースをチャンネルに公開します。リソースが商品の場合、商品のステータスが active である場合にのみ、チャンネルで表示されます。サブスクリプションでのみ販売されている商品 (requiresSellingPlan: true) は、オンラインストアでのみ公開できます。

  • publishablePublishToCurrentChannel - リソースを現在のチャネルに公開します。リソースが商品の場合、商品のステータスが active である場合にのみ、そのチャンネルで表示されます。サブスクリプションでのみ販売されている商品 (requiresSellingPlan: true) は、オンラインストアでのみ公開することができます。

  • publishableUnpublish - チャネルからリソースを非公開にします。リソースが商品の場合、商品のステータスが active である場合にのみ、チャンネル内で表示されます。

  • publishableUnpublishToCurrentChannel - 現在のチャネルからリソースを公開します。リソースが商品の場合、商品のステータスが active である場合にのみ、チャネルで表示されます。

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

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

  • sellingPlanGroupCreate - 販売計画グループを作成します。

  • sellingPlanGroupDelete - 販売計画グループを削除します。

  • sellingPlanGroupRemoveProductVariants - 販売計画グループから複数の商品バリアントを削除します。

  • sellingPlanGroupRemoveProducts - 販売計画グループから複数の商品を削除します。

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

UNIONS

SellingPlanBillingPolicy (union)

販売プランに関連する請求頻度を表します（例えば、毎週請求、または 3 ヶ月ごとに請求）。販売プランの課金ポリシーと関連レコード（販売プラングループ、販売プラン、価格ポリシー、配送ポリシー）は、マーチャントがサブスクリプションアプリをアンインストールしてから 48 時間後に削除されます。後で復元する必要がある場合は、これらのレコードをバックアップすることをお勧めします。

可能なタイプ

SellingPlanDeliveryPolicy (union)

販売プランに関連付けられた配信頻度を表します（例えば、毎月配信、隔週配信など）。販売プランの配信ポリシーと関連するレコード（販売プラングループ、販売プラン、価格ポリシー、請求ポリシー）は、マーチャントが購読アプリをアンインストールしてから 48 時間後に削除されます。後で復元する必要がある場合は、これらのレコードをバックアップすることをお勧めします。

可能なタイプ

SellingPlanPricingPolicy (union)

販売プランに関連する価格設定の種類を表します（例えば、期間限定で設定された 10 ドルまたは 20％の割引や、サブスクリプションの期間中に固定された割引など）。販売プランの価格設定ポリシーと関連するレコード（販売プラングループ、販売プラン、請求ポリシー、配送ポリシー）は、マーチャントがサブスクリプションアプリをアンインストールしてから 48 時間後に削除されます。後で復元する必要がある場合は、これらのレコードをバックアップすることをお勧めします。

可能なタイプ

SellingPlanPricingPolicyAdjustmentValue (union)

販売計画の価格政策の調整値タイプを表します。

可能なタイプ

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

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