Products

Returns a list of products.

Table-Specific Information

Select

The driver uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The driver processes other filters client-side within the driver.

Id supports the '=,IN' comparison operators.
Title supports the '=,!=' comparison operators.
Status supports the '=,!=' comparison operators.
Vendor supports the '=,!=' comparison operators.
TotalInventory supports the '=,!=,<,>,>=,<=' comparison operators.
HasOnlyDefaultVariant supports the '=,!=' comparison operators.
UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
ProductType supports the '=,!=' comparison operators.

For example, the following queries are processed server side:

  SELECT * FROM Products
  SELECT * FROM Products WHERE Id = 'Val1'
  SELECT * FROM Products WHERE Title = 'Val1'
  SELECT * FROM Products WHERE Status = 'Val1'
  SELECT * FROM Products WHERE Vendor = 'Val1'
  SELECT * FROM Products WHERE TotalInventory = 123
  SELECT * FROM Products WHERE HasOnlyDefaultVariant = true
  SELECT * FROM Products WHERE UpdatedAt = '2023-01-01 11:10:00'
  SELECT * FROM Products WHERE CreatedAt = '2023-01-01 11:10:00'
  SELECT * FROM Products WHERE ProductType = 'Val1'

Insert

The following columns can be used to create a new record:

DescriptionHtml, Title, Handle, Tags, Status, Vendor, TemplateSuffix, GiftCardTemplateSuffix, IsGiftCard, ProductType, SeoTitle, SeoDescription, RequiresSellingPlan

The following pseudo-column can be used to create a new record:

Metafields (references Metafields)

Update

The following columns can be updated:

DescriptionHtml, Title, Handle, Tags, Status, Vendor, TemplateSuffix, GiftCardTemplateSuffix, IsGiftCard, ProductType, SeoTitle, SeoDescription, RequiresSellingPlan

The following pseudo-column can be used to update a record:

Metafields (references Metafields)

Delete

You can delete entries by specifying the following column:

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		A globally-unique identifier.
LegacyResourceId	Long	True		The ID of the corresponding resource in the REST Admin API.
Description	String	True		The description of the product, complete with HTML formatting.
DescriptionHtml	String	False		The description of the product, complete with HTML formatting.
Title	String	False		The title of the product.
Handle	String	False		A unique human-friendly string of the product's title.
Tags	String	False		A comma separated list of tags associated with the product. Updating 'tags' overwrites any existing tags that were previously added to the product.
Status	String	False		The product status. This controls visibility across all channels.
Vendor	String	False		The name of the product's vendor.
OnlineStorePreviewUrl	String	True		The online store preview URL.
OnlineStoreUrl	String	True		The online store URL for the product.A value of 'null' indicates that the product is not published to the Online Store sales channel.
TracksInventory	Bool	True		Whether inventory tracking has been enabled for the product.
TotalInventory	Int	True		The quantity of inventory in stock.
HasOnlyDefaultVariant	Bool	True		Whether the product has only a single variant with the default option and value.
HasOutOfStockVariants	Bool	True		Whether the product has out of stock variants.
HasVariantsThatRequiresComponents	Bool	True		Whether at least one of the product variants requires bundle components.
VariantsCount	Int	True		The number of variants that are associated with the product.
VariantsCountPrecision	String	True		The count's precision, or the exactness of the value.
TemplateSuffix	String	False		The theme template used when viewing the product in a store.
GiftCardTemplateSuffix	String	False		The theme template used when viewing the gift card in a store.
IsGiftCard	Bool	False		Whether the product is a gift card.
PublishedAt	Datetime	True		The date and time when the product was published to the Online Store.
UpdatedAt	Datetime	True		The date and time when the product was last modified.A product's 'updatedAt' value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.
CreatedAt	Datetime	True		The date and time when the product was created.
ProductType	String	False		The product type specified by the merchant.
CategoryId	String	True		The globally-unique ID of the TaxonomyCategory.
CategoryName	String	True		The name of the taxonomy category. For example, Dog Beds.
CategoryFullName	String	True		The full name of the taxonomy category. For example, Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds.
SeoTitle	String	False		SEO Title.
SeoDescription	String	False		SEO Description.
RequiresSellingPlan	Bool	False		Whether the product can only be purchased with a selling plan (subscription). Products that are sold on subscription ('requiresSellingPlan: true') can be updated only for online stores. If you update a product to be subscription only, then the product is unpublished from all channels except the online store.
SellingPlanGroupsCount	Int	True		Count of selling plan groups associated with the product.
SellingPlanGroupsCountPrecision	String	True		The count's precision, or the exactness of the value.
PriceRangeMaxVariantPriceAmount	Decimal	True		Decimal money amount.
PriceRangeMaxVariantPriceCurrencyCode	String	True		Currency of the money.
PriceRangeMinVariantPriceAmount	Decimal	True		Decimal money amount.
PriceRangeMinVariantPriceCurrencyCode	String	True		Currency of the money.
CompareAtPriceRangeMaxVariantCompareAtPriceAmount	Decimal	True		Decimal money amount.
CompareAtPriceRangeMaxVariantCompareAtPriceCurrencyCode	String	True		Currency of the money.
CompareAtPriceRangeMinVariantCompareAtPriceAmount	Decimal	True		Decimal money amount.
CompareAtPriceRangeMinVariantCompareAtPriceCurrencyCode	String	True		Currency of the money.
MediaCount	Int	True		Total count of media belonging to a product.
MediaCountPrecision	String	True		The count's precision, or the exactness of the value.
FeaturedMediaId	String	True		A globally-unique ID.
FeaturedMediaAlt	String	True		A word or phrase to share the nature or contents of a media.
FeaturedMediaContentType	String	True		The media content type.
FeaturedMediaStatus	String	True		Current status of the media.
FeaturedMediaPreviewStatus	String	True		Current status of the preview image.
FeaturedMediaPreviewImageId	String	True		The preview image for the media. Returns null until status is READY.
FeaturedMediaPreviewImageAltText	String	True		A word or phrase to share the nature or contents of an image.
FeaturedMediaPreviewImageUrl	String	True		The location of the image as a URL.
FeaturedMediaPreviewImageWidth	Int	True		The original width of the image in pixels. Returns null if the image isn't hosted by Shopify.
FeaturedMediaPreviewImageHeight	Int	True		The original height of the image in pixels. Returns null if the image isn't hosted by Shopify.
AvailablePublicationsCount	Int	True		The number of publications a resource is published to without feedback errors.
AvailablePublicationsCountPrecision	String	True		The count's precision, or the exactness of the value.
PublishedOnCurrentPublication	Bool	True		Whether the resource is published to the app's publication. For example, the resource might be published to the app's online store channel.
ResourcePublicationOnCurrentPublicationAutoPublish	Bool	True		Whether new products are automatically published to this publication.
ResourcePublicationOnCurrentPublicationIsPublished	Bool	True		Whether the resource publication is published. If true, then the resource publication is published to the publication. If false, then the resource publication is staged to be published to the publication.
ResourcePublicationOnCurrentPublicationPublishDate	Datetime	True		The date that the resource publication was or is going to be published to the publication.
ResourcePublicationOnCurrentPublicationPublicationId	String	True		A globally-unique identifier.
ResourcePublicationOnCurrentPublicationPublicationName	String	True		Name of the publication.
ResourcePublicationOnCurrentPublicationPublicationSupportsFuturePublishing	Bool	True		Whether the publication supports future publishing.
ResourcePublicationsCount	Int	True		The number of publications that a resource is published to, without feedback errors.
ResourcePublicationsCountPrecision	String	True		The count's precision, or the exactness of the value.
FeedbackSummary	String	True		Summary of resource feedback pertaining to the resource.
FeedbackDetails	String	True		List of AppFeedback detailing issues regarding a resource.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements, to offer a more granular control over the tuples that are returned from the data source, or as parameters in INSERT statements.


Name	Type	Description
Metafields	String	The additional customizable information about the product variant.

JDBC Driver for Shopify