Products
List of products.
View-Specific Information
Select
The adapter uses the Shopify API to process search criteria that refer to the following columns:
- Id
- Title
- ProductType
- Status
- Vendor
- TotalInventory
- HasOnlyDefautlVariant
- UpdatedAt
- CreatedAt
The adapter processes other filters client-side within the adapter.
Note that server-side filter extends to =/!= for Bool/String type columns, and only includes other operators for datetime or number type columns.
For example, the following queries are processed server side:
SELECT * FROM Products WHERE Id = 'gid://shopify/Product/6830135181335'
SELECT * FROM Products WHERE Id IN ('gid://shopify/Product/6830135181335', 'gid://shopify/Product/6830135181336')
SELECT * FROM Products WHERE Title = 'title'
SELECT * FROM Products WHERE Vendor = 'vendor'
SELECT * FROM Products WHERE CreatedAt > '2022-11-02T09:07:53.000-04:00'
Columns
| Name | Type | References | Description |
| Id | String | A globally-unique identifier. | |
| LegacyResourceId | Long | The ID of the corresponding resource in the REST Admin API. | |
| Description | String | The description of the product, complete with HTML formatting. | |
| DescriptionHtml | String | The description of the product, complete with HTML formatting. | |
| Title | String | The title of the product. | |
| Handle | String | A unique human-friendly string of the product's title. | |
| ProductType | String | The product type specified by the merchant. | |
| Tags | String | 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 | The product status. This controls visibility across all channels. | |
| Vendor | String | The name of the product's vendor. | |
| OnlineStorePreviewUrl | String | The online store preview URL. | |
| OnlineStoreUrl | String | The online store URL for the product.A value of 'null' indicates that the product is not published to the Online Store sales channel. | |
| RequiresSellingPlan | Bool | 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. | |
| SellingPlanGroupCount | Int | Count of selling plan groups associated with the product. | |
| TracksInventory | Bool | Whether inventory tracking has been enabled for the product. | |
| TotalInventory | Int | The quantity of inventory in stock. | |
| HasOnlyDefaultVariant | Bool | Whether the product has only a single variant with the default option and value. | |
| HasOutOfStockVariants | Bool | Whether the product has out of stock variants. | |
| TotalVariants | Int | The number of variants that are associated with the product. | |
| TemplateSuffix | String | The theme template used when viewing the product in a store. | |
| GiftCardTemplateSuffix | String | The theme template used when viewing the gift card in a store. | |
| IsGiftCard | Bool | Whether the product is a gift card. | |
| PublishedAt | Datetime | The date and time when the product was published to the Online Store. | |
| UpdatedAt | Datetime | 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 | The date and time when the product was created. | |
| FeedbackSummary | String | Summary of resource feedback pertaining to the resource. | |
| PriceRangeMaxVariantPriceAmount | Decimal | Decimal money amount. | |
| PriceRangeMaxVariantPriceCurrencyCode | String | Currency of the money. | |
| PriceRangeMinVariantPriceAmount | Decimal | Decimal money amount. | |
| PriceRangeMinVariantPriceCurrencyCode | String | Currency of the money. | |
| SeoTitle | String | SEO Title. | |
| SeoDescription | String | SEO Description. | |
| MediaCount | Int | Total count of media belonging to a product. | |
| FeaturedImageId | String | A unique identifier for the image. | |
| FeaturedImageAltText | String | A word or phrase to share the nature or contents of an image. | |
| FeaturedImageHeight | Int | The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| FeaturedImageWidth | Int | The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify. | |
| FeaturedImageUrl | String | The location of the image as a URL. | |
| ResourcePublicationOnCurrentPublicationIsPublished | Bool | 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 | The date that the resource publication was or is going to be published to the publication. | |
| ResourcePublicationOnCurrentPublicationPublicationId | String | A globally-unique identifier. | |
| ResourcePublicationOnCurrentPublicationPublicationName | String | Name of the publication. | |
| ResourcePublicationOnCurrentPublicationPublicationSupportsFuturePublishing | Bool | Whether the publication supports future publishing. |