Products and Collections APIs

Access and manipulate a store's catalog using product and collection APIs.

In this section

  • Channel — A channel represents an app where you sell a group of products and collections. A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS.

  • Collection — Represents a collection of products.

  • CollectionDeleteInput — Specifies the collection to delete.

  • CollectionInput — Specifies the input fields required to create a collection.

  • CollectionPublication — Represents the publications where a collection is published.

  • CollectionPublicationInput — Specifies the publications to which a collection will be published.

  • CollectionPublishInput — Specifies a collection to publish and the sales channels to publish it to.

  • CollectionRule — Represents at rule that’s used to assign products to a collection.

  • CollectionRuleColumn — Specifies the property of a product being used to populate the smart collection.

  • CollectionRuleConditions — Collections may use rules to automatically include the matching products. This defines restrictions for a type of rule.

  • CollectionRuleInput — Specifies a rule to associate with a collection.

  • CollectionRuleRelation — Specifies the relationship between the column and the condition.

  • CollectionRuleSet — The set of rules that are used to determine which products are included in the collection.

  • CollectionRuleSetInput — Specifies a rule set for the collection.

  • CollectionSortKeys — The set of valid sort keys for the Collection query.

  • CollectionSortOrder — Specifies the sort order for the products in the collection.

  • CollectionUnpublishInput — Specifies the collection to unpublish and the sales channels to remove it from.

  • CreateMediaInput — Specifies the input fields required to create a media object.

  • ExternalVideo — Represents a video hosted outside of Shopify.

  • File — An auto-generated type for paginating through multiple Files.

  • FileContentType — The possible content types for a file object.

  • FileCreateInput — The input fields that are required to create a file object.

  • FileSortKeys — The set of valid sort keys for the File query.

  • FileStatus — The possible statuses for a file object.

  • FileUpdateInput — The input fields that are required to update a file object.

  • GenericFile — A generic file.

  • Media — An auto-generated type for paginating through multiple Media.

  • MediaContentType — The possible content types for a media object.

  • MediaHost — Host for a Media Resource.

  • MediaImage — Represents a Shopify hosted image.

  • MediaPreviewImage — Represents the preview image for a media.

  • MediaPreviewImageStatus — The possible statuses for a media preview image.

  • MediaStatus — The possible statuses for a media object.

  • Model3d — Represents a Shopify hosted 3D model.

  • Model3dSource — Represents a source for a Shopify hosted 3d model.

  • MoveInput — An individual move to perform of an object to a position.

  • OnlineStorePreviewable — Online Store preview URL of the object.

  • PriceList — Represents a price list, including information about related prices and eligibility rules. You can use price lists to specify either fixed prices or adjusted relative prices that override initial product variant prices. Price lists are applied to customers using context rules, which determine price list eligibility. For more information on price lists, refer to Support different pricing models using the price list API.

  • PriceListAdjustment — Represents the type and value of price list adjustments.

  • PriceListAdjustmentInput — Provides the fields and values to use when updating a price list parent adjustment.

  • PriceListAdjustmentType — Represents a percentage price adjustment type.

  • PriceListContext — Represents a set of facts about the customer used to determine price list eligibility. For example, you can specify the country code so that the price list only applies to customers visiting from a specific country.

  • PriceListContextRule — Represents a set of facts about the customer used to determine price list eligibility.

  • PriceListContextRuleInput — The context that the price list applies to.

  • PriceListCreateInput — Provides the fields and values to use when creating a price list.

  • PriceListParent — Represents relative adjustments from one price list to other prices. You can use a PriceListParent to specify an adjusted relative price using a percentage-based adjustment. Adjusted prices work in conjunction with exchange rules and rounding. Adjustment types support both percentage increases and decreases.